Add endpoint option to all relevant commands

In case of ambiguity when using the name of a repo, org or enterprise,
an --endpoint flag can be used to uniquely identify an entity against
an endpoint.

Signed-off-by: Gabriel Adrian Samfira <gsamfira@cloudbasesolutions.com>

Author: gabriel-samfira

cmd/garm-cli/cmd/enterprise.go

@@ -113,7 +113,7 @@ var enterpriseShowCmd = &cobra.Command{
 			return fmt.Errorf("too many arguments")
 		}
 
-		enterpriseID, err := resolveEnterprise(args[0])
+		enterpriseID, err := resolveEnterprise(args[0], enterpriseEndpoint)
 		if err != nil {
 			return err
 		}
@@ -146,7 +146,7 @@ var enterpriseDeleteCmd = &cobra.Command{
 			return fmt.Errorf("too many arguments")
 		}
 
-		enterpriseID, err := resolveEnterprise(args[0])
+		enterpriseID, err := resolveEnterprise(args[0], enterpriseEndpoint)
 		if err != nil {
 			return err
 		}
@@ -177,7 +177,7 @@ var enterpriseUpdateCmd = &cobra.Command{
 		if len(args) > 1 {
 			return fmt.Errorf("too many arguments")
 		}
-		enterpriseID, err := resolveEnterprise(args[0])
+		enterpriseID, err := resolveEnterprise(args[0], enterpriseEndpoint)
 		if err != nil {
 			return err
 		}
@@ -213,6 +213,10 @@ func init() {
 	enterpriseUpdateCmd.Flags().StringVar(&enterpriseWebhookSecret, "webhook-secret", "", "The webhook secret for this enterprise")
 	enterpriseUpdateCmd.Flags().StringVar(&enterpriseCreds, "credentials", "", "Credentials name. See credentials list.")
 	enterpriseUpdateCmd.Flags().StringVar(&poolBalancerType, "pool-balancer-type", "", "The balancing strategy to use when creating runners in pools matching requested labels.")
+	enterpriseUpdateCmd.Flags().StringVar(&enterpriseEndpoint, "endpoint", "", "When using the name of the enterprise, the endpoint must be specified when multiple enterprises with the same name exist.")
+
+	enterpriseDeleteCmd.Flags().StringVar(&enterpriseEndpoint, "endpoint", "", "When using the name of the enterprise, the endpoint must be specified when multiple enterprises with the same name exist.")
+	enterpriseShowCmd.Flags().StringVar(&enterpriseEndpoint, "endpoint", "", "When using the name of the enterprise, the endpoint must be specified when multiple enterprises with the same name exist.")
 
 	enterpriseCmd.AddCommand(
 		enterpriseListCmd,

cmd/garm-cli/cmd/organization.go

@@ -76,7 +76,7 @@ var orgWebhookInstallCmd = &cobra.Command{
 			return fmt.Errorf("too many arguments")
 		}
 
-		orgID, err := resolveOrganization(args[0])
+		orgID, err := resolveOrganization(args[0], orgEndpoint)
 		if err != nil {
 			return err
 		}
@@ -110,7 +110,7 @@ var orgHookInfoShowCmd = &cobra.Command{
 		if len(args) > 1 {
 			return fmt.Errorf("too many arguments")
 		}
-		orgID, err := resolveOrganization(args[0])
+		orgID, err := resolveOrganization(args[0], orgEndpoint)
 		if err != nil {
 			return err
 		}
@@ -142,7 +142,7 @@ var orgWebhookUninstallCmd = &cobra.Command{
 			return fmt.Errorf("too many arguments")
 		}
 
-		orgID, err := resolveOrganization(args[0])
+		orgID, err := resolveOrganization(args[0], orgEndpoint)
 		if err != nil {
 			return err
 		}
@@ -230,7 +230,7 @@ var orgUpdateCmd = &cobra.Command{
 			return fmt.Errorf("too many arguments")
 		}
 
-		orgID, err := resolveOrganization(args[0])
+		orgID, err := resolveOrganization(args[0], orgEndpoint)
 		if err != nil {
 			return err
 		}
@@ -290,7 +290,7 @@ var orgShowCmd = &cobra.Command{
 			return fmt.Errorf("too many arguments")
 		}
 
-		orgID, err := resolveOrganization(args[0])
+		orgID, err := resolveOrganization(args[0], orgEndpoint)
 		if err != nil {
 			return err
 		}
@@ -323,7 +323,7 @@ var orgDeleteCmd = &cobra.Command{
 			return fmt.Errorf("too many arguments")
 		}
 
-		orgID, err := resolveOrganization(args[0])
+		orgID, err := resolveOrganization(args[0], orgEndpoint)
 		if err != nil {
 			return err
 		}
@@ -351,18 +351,28 @@ func init() {
 
 	orgListCmd.Flags().BoolVarP(&long, "long", "l", false, "Include additional info.")
 	orgListCmd.Flags().StringVarP(&orgName, "name", "n", "", "Exact org name to filter by.")
-	orgListCmd.Flags().StringVarP(&orgEndpoint, "endpoint", "e", "", "Exact endpoint name to filter by.")
+	orgListCmd.Flags().StringVar(&orgEndpoint, "endpoint", "", "Exact endpoint name to filter by.")
 
 	orgAddCmd.MarkFlagRequired("credentials") //nolint
 	orgAddCmd.MarkFlagRequired("name")        //nolint
 
 	orgDeleteCmd.Flags().BoolVar(&keepOrgWebhook, "keep-webhook", false, "Do not delete any existing webhook when removing the organization from GARM.")
+	orgDeleteCmd.Flags().StringVar(&orgEndpoint, "endpoint", "", "When using the name of the org, the endpoint must be specified when multiple organizations with the same name exist.")
+
+	orgShowCmd.Flags().StringVar(&orgEndpoint, "endpoint", "", "When using the name of the org, the endpoint must be specified when multiple organizations with the same name exist.")
 
 	orgUpdateCmd.Flags().StringVar(&orgWebhookSecret, "webhook-secret", "", "The webhook secret for this organization")
 	orgUpdateCmd.Flags().StringVar(&orgCreds, "credentials", "", "Credentials name. See credentials list.")
 	orgUpdateCmd.Flags().StringVar(&poolBalancerType, "pool-balancer-type", "", "The balancing strategy to use when creating runners in pools matching requested labels.")
+	orgUpdateCmd.Flags().StringVar(&orgEndpoint, "endpoint", "", "When using the name of the org, the endpoint must be specified when multiple organizations with the same name exist.")
 
 	orgWebhookInstallCmd.Flags().BoolVar(&insecureOrgWebhook, "insecure", false, "Ignore self signed certificate errors.")
+	orgWebhookInstallCmd.Flags().StringVar(&orgEndpoint, "endpoint", "", "When using the name of the org, the endpoint must be specified when multiple organizations with the same name exist.")
+
+	orgWebhookUninstallCmd.Flags().StringVar(&orgEndpoint, "endpoint", "", "When using the name of the org, the endpoint must be specified when multiple organizations with the same name exist.")
+
+	orgHookInfoShowCmd.Flags().StringVar(&orgEndpoint, "endpoint", "", "When using the name of the org, the endpoint must be specified when multiple organizations with the same name exist.")
+
 	orgWebhookCmd.AddCommand(
 		orgWebhookInstallCmd,
 		orgWebhookUninstallCmd,

cmd/garm-cli/cmd/pool.go

@@ -105,23 +105,23 @@ Example:
 		switch len(args) {
 		case 0:
 			if cmd.Flags().Changed("repo") {
-				poolRepository, err = resolveRepository(poolRepository)
+				poolRepository, err = resolveRepository(poolRepository, endpointName)
 				if err != nil {
 					return err
 				}
 				listRepoPoolsReq := apiClientRepos.NewListRepoPoolsParams()
 				listRepoPoolsReq.RepoID = poolRepository
 				response, err = apiCli.Repositories.ListRepoPools(listRepoPoolsReq, authToken)
 			} else if cmd.Flags().Changed("org") {
-				poolOrganization, err = resolveOrganization(poolOrganization)
+				poolOrganization, err = resolveOrganization(poolOrganization, endpointName)
 				if err != nil {
 					return err
 				}
 				listOrgPoolsReq := apiClientOrgs.NewListOrgPoolsParams()
 				listOrgPoolsReq.OrgID = poolOrganization
 				response, err = apiCli.Organizations.ListOrgPools(listOrgPoolsReq, authToken)
 			} else if cmd.Flags().Changed("enterprise") {
-				poolEnterprise, err = resolveEnterprise(poolEnterprise)
+				poolEnterprise, err = resolveEnterprise(poolEnterprise, endpointName)
 				if err != nil {
 					return err
 				}
@@ -262,7 +262,7 @@ var poolAddCmd = &cobra.Command{
 		var err error
 		var response poolPayloadGetter
 		if cmd.Flags().Changed("repo") {
-			poolRepository, err = resolveRepository(poolRepository)
+			poolRepository, err = resolveRepository(poolRepository, endpointName)
 			if err != nil {
 				return err
 			}
@@ -271,7 +271,7 @@ var poolAddCmd = &cobra.Command{
 			newRepoPoolReq.Body = newPoolParams
 			response, err = apiCli.Repositories.CreateRepoPool(newRepoPoolReq, authToken)
 		} else if cmd.Flags().Changed("org") {
-			poolOrganization, err = resolveOrganization(poolOrganization)
+			poolOrganization, err = resolveOrganization(poolOrganization, endpointName)
 			if err != nil {
 				return err
 			}
@@ -280,7 +280,7 @@ var poolAddCmd = &cobra.Command{
 			newOrgPoolReq.Body = newPoolParams
 			response, err = apiCli.Organizations.CreateOrgPool(newOrgPoolReq, authToken)
 		} else if cmd.Flags().Changed("enterprise") {
-			poolEnterprise, err = resolveEnterprise(poolEnterprise)
+			poolEnterprise, err = resolveEnterprise(poolEnterprise, endpointName)
 			if err != nil {
 				return err
 			}
@@ -411,6 +411,8 @@ func init() {
 	poolListCmd.Flags().StringVarP(&poolEnterprise, "enterprise", "e", "", "List all pools within this enterprise.")
 	poolListCmd.Flags().BoolVarP(&poolAll, "all", "a", false, "List all pools, regardless of org or repo.")
 	poolListCmd.Flags().BoolVarP(&long, "long", "l", false, "Include additional info.")
+	poolListCmd.Flags().StringVar(&endpointName, "endpoint", "", "When using the name of an entity, the endpoint must be specified when multiple entities with the same name exist.")
+
 	poolListCmd.MarkFlagsMutuallyExclusive("repo", "org", "all", "enterprise")
 
 	poolUpdateCmd.Flags().StringVar(&poolImage, "image", "", "The provider-specific image name to use for runners in this pool.")
@@ -444,6 +446,8 @@ func init() {
 	poolAddCmd.Flags().UintVar(&poolRunnerBootstrapTimeout, "runner-bootstrap-timeout", 20, "Duration in minutes after which a runner is considered failed if it does not join Github.")
 	poolAddCmd.Flags().UintVar(&poolMinIdleRunners, "min-idle-runners", 1, "Attempt to maintain a minimum of idle self-hosted runners of this type.")
 	poolAddCmd.Flags().BoolVar(&poolEnabled, "enabled", false, "Enable this pool.")
+	poolAddCmd.Flags().StringVar(&endpointName, "endpoint", "", "When using the name of an entity, the endpoint must be specified when multiple entities with the same name exist.")
+
 	poolAddCmd.MarkFlagRequired("provider-name") //nolint
 	poolAddCmd.MarkFlagRequired("image")         //nolint
 	poolAddCmd.MarkFlagRequired("flavor")        //nolint

cmd/garm-cli/cmd/repository.go

@@ -78,7 +78,7 @@ var repoWebhookInstallCmd = &cobra.Command{
 			return fmt.Errorf("too many arguments")
 		}
 
-		repoID, err := resolveRepository(args[0])
+		repoID, err := resolveRepository(args[0], repoEndpoint)
 		if err != nil {
 			return err
 		}
@@ -113,7 +113,7 @@ var repoHookInfoShowCmd = &cobra.Command{
 			return fmt.Errorf("too many arguments")
 		}
 
-		repoID, err := resolveRepository(args[0])
+		repoID, err := resolveRepository(args[0], repoEndpoint)
 		if err != nil {
 			return err
 		}
@@ -146,7 +146,7 @@ var repoWebhookUninstallCmd = &cobra.Command{
 			return fmt.Errorf("too many arguments")
 		}
 
-		repoID, err := resolveRepository(args[0])
+		repoID, err := resolveRepository(args[0], repoEndpoint)
 		if err != nil {
 			return err
 		}
@@ -259,7 +259,7 @@ var repoUpdateCmd = &cobra.Command{
 			return fmt.Errorf("too many arguments")
 		}
 
-		repoID, err := resolveRepository(args[0])
+		repoID, err := resolveRepository(args[0], repoEndpoint)
 		if err != nil {
 			return err
 		}
@@ -297,7 +297,7 @@ var repoShowCmd = &cobra.Command{
 			return fmt.Errorf("too many arguments")
 		}
 
-		repoID, err := resolveRepository(args[0])
+		repoID, err := resolveRepository(args[0], repoEndpoint)
 		if err != nil {
 			return err
 		}
@@ -330,7 +330,7 @@ var repoDeleteCmd = &cobra.Command{
 			return fmt.Errorf("too many arguments")
 		}
 
-		repoID, err := resolveRepository(args[0])
+		repoID, err := resolveRepository(args[0], repoEndpoint)
 		if err != nil {
 			return err
 		}
@@ -360,19 +360,28 @@ func init() {
 	repoListCmd.Flags().BoolVarP(&long, "long", "l", false, "Include additional info.")
 	repoListCmd.Flags().StringVarP(&repoName, "name", "n", "", "Exact repo name to filter by.")
 	repoListCmd.Flags().StringVarP(&repoOwner, "owner", "o", "", "Exact repo owner to filter by.")
-	repoListCmd.Flags().StringVarP(&repoEndpoint, "endpoint", "e", "", "Exact endpoint name to filter by.")
+	repoListCmd.Flags().StringVar(&repoEndpoint, "endpoint", "", "Exact endpoint name to filter by.")
 
 	repoAddCmd.MarkFlagRequired("credentials") //nolint
 	repoAddCmd.MarkFlagRequired("owner")       //nolint
 	repoAddCmd.MarkFlagRequired("name")        //nolint
 
 	repoDeleteCmd.Flags().BoolVar(&keepRepoWebhook, "keep-webhook", false, "Do not delete any existing webhook when removing the repo from GARM.")
+	repoDeleteCmd.Flags().StringVar(&repoEndpoint, "endpoint", "", "When using the name of the repo, the endpoint must be specified when multiple repositories with the same name exist.")
+
+	repoShowCmd.Flags().StringVar(&repoEndpoint, "endpoint", "", "When using the name of the repo, the endpoint must be specified when multiple repositories with the same name exist.")
 
 	repoUpdateCmd.Flags().StringVar(&repoWebhookSecret, "webhook-secret", "", "The webhook secret for this repository. If you update this secret, you will have to manually update the secret in GitHub as well.")
 	repoUpdateCmd.Flags().StringVar(&repoCreds, "credentials", "", "Credentials name. See credentials list.")
 	repoUpdateCmd.Flags().StringVar(&poolBalancerType, "pool-balancer-type", "", "The balancing strategy to use when creating runners in pools matching requested labels.")
+	repoUpdateCmd.Flags().StringVar(&repoEndpoint, "endpoint", "", "When using the name of the repo, the endpoint must be specified when multiple repositories with the same name exist.")
 
 	repoWebhookInstallCmd.Flags().BoolVar(&insecureRepoWebhook, "insecure", false, "Ignore self signed certificate errors.")
+	repoWebhookInstallCmd.Flags().StringVar(&repoEndpoint, "endpoint", "", "When using the name of the repo, the endpoint must be specified when multiple repositories with the same name exist.")
+
+	repoWebhookUninstallCmd.Flags().StringVar(&repoEndpoint, "endpoint", "", "When using the name of the repo, the endpoint must be specified when multiple repositories with the same name exist.")
+
+	repoHookInfoShowCmd.Flags().StringVar(&repoEndpoint, "endpoint", "", "When using the name of the repo, the endpoint must be specified when multiple repositories with the same name exist.")
 
 	repoWebhookCmd.AddCommand(
 		repoWebhookInstallCmd,

cmd/garm-cli/cmd/scalesets.go

@@ -105,23 +105,23 @@ Example:
 		switch len(args) {
 		case 0:
 			if cmd.Flags().Changed("repo") {
-				scalesetRepository, err = resolveRepository(scalesetRepository)
+				scalesetRepository, err = resolveRepository(scalesetRepository, endpointName)
 				if err != nil {
 					return err
 				}
 				listRepoScaleSetsReq := apiClientRepos.NewListRepoScaleSetsParams()
 				listRepoScaleSetsReq.RepoID = scalesetRepository
 				response, err = apiCli.Repositories.ListRepoScaleSets(listRepoScaleSetsReq, authToken)
 			} else if cmd.Flags().Changed("org") {
-				scalesetOrganization, err = resolveOrganization(scalesetOrganization)
+				scalesetOrganization, err = resolveOrganization(scalesetOrganization, endpointName)
 				if err != nil {
 					return err
 				}
 				listOrgScaleSetsReq := apiClientOrgs.NewListOrgScaleSetsParams()
 				listOrgScaleSetsReq.OrgID = scalesetOrganization
 				response, err = apiCli.Organizations.ListOrgScaleSets(listOrgScaleSetsReq, authToken)
 			} else if cmd.Flags().Changed("enterprise") {
-				scalesetEnterprise, err = resolveEnterprise(scalesetEnterprise)
+				scalesetEnterprise, err = resolveEnterprise(scalesetEnterprise, endpointName)
 				if err != nil {
 					return err
 				}
@@ -256,7 +256,7 @@ var scaleSetAddCmd = &cobra.Command{
 		var err error
 		var response scalesetPayloadGetter
 		if cmd.Flags().Changed("repo") {
-			scalesetRepository, err = resolveRepository(scalesetRepository)
+			scalesetRepository, err = resolveRepository(scalesetRepository, endpointName)
 			if err != nil {
 				return err
 			}
@@ -265,7 +265,7 @@ var scaleSetAddCmd = &cobra.Command{
 			newRepoScaleSetReq.Body = newScaleSetParams
 			response, err = apiCli.Repositories.CreateRepoScaleSet(newRepoScaleSetReq, authToken)
 		} else if cmd.Flags().Changed("org") {
-			scalesetOrganization, err = resolveOrganization(scalesetOrganization)
+			scalesetOrganization, err = resolveOrganization(scalesetOrganization, endpointName)
 			if err != nil {
 				return err
 			}
@@ -274,7 +274,7 @@ var scaleSetAddCmd = &cobra.Command{
 			newOrgScaleSetReq.Body = newScaleSetParams
 			response, err = apiCli.Organizations.CreateOrgScaleSet(newOrgScaleSetReq, authToken)
 		} else if cmd.Flags().Changed("enterprise") {
-			scalesetEnterprise, err = resolveEnterprise(scalesetEnterprise)
+			scalesetEnterprise, err = resolveEnterprise(scalesetEnterprise, endpointName)
 			if err != nil {
 				return err
 			}
@@ -402,6 +402,7 @@ func init() {
 	scalesetListCmd.Flags().StringVarP(&scalesetEnterprise, "enterprise", "e", "", "List all scale sets within this enterprise.")
 	scalesetListCmd.Flags().BoolVarP(&scalesetAll, "all", "a", false, "List all scale sets, regardless of org or repo.")
 	scalesetListCmd.MarkFlagsMutuallyExclusive("repo", "org", "all", "enterprise")
+	scalesetListCmd.Flags().StringVar(&endpointName, "endpoint", "", "When using the name of an entity, the endpoint must be specified when multiple entities with the same name exist.")
 
 	scaleSetUpdateCmd.Flags().StringVar(&scalesetImage, "image", "", "The provider-specific image name to use for runners in this scale set.")
 	scaleSetUpdateCmd.Flags().StringVar(&scalesetFlavor, "flavor", "", "The flavor to use for the runners in this scale set.")
@@ -432,6 +433,7 @@ func init() {
 	scaleSetAddCmd.Flags().UintVar(&scalesetRunnerBootstrapTimeout, "runner-bootstrap-timeout", 20, "Duration in minutes after which a runner is considered failed if it does not join Github.")
 	scaleSetAddCmd.Flags().UintVar(&scalesetMinIdleRunners, "min-idle-runners", 1, "Attempt to maintain a minimum of idle self-hosted runners of this type.")
 	scaleSetAddCmd.Flags().BoolVar(&scalesetEnabled, "enabled", false, "Enable this scale set.")
+	scaleSetAddCmd.Flags().StringVar(&endpointName, "endpoint", "", "When using the name of an entity, the endpoint must be specified when multiple entities with the same name exist.")
 	scaleSetAddCmd.MarkFlagRequired("provider-name") //nolint
 	scaleSetAddCmd.MarkFlagRequired("name")          //nolint
 	scaleSetAddCmd.MarkFlagRequired("image")         //nolint