feat(cmd): apply env vars consistently across cmd

CHANGELOG.md

@@ -3,6 +3,7 @@
 ### Features
 
 ### Bug Fixes
+1. [16225](https://github.com/influxdata/influxdb/pull/16225): Ensures env vars are applied consistently across cmd, and fixes issue where INFLUX_ env var prefix was not set globally.
 
 ### UI Improvements
 

cmd/influx/authorization.go

@@ -8,6 +8,7 @@ import (
 	"github.com/influxdata/influxdb/cmd/influx/internal"
 	"github.com/influxdata/influxdb/http"
 	"github.com/spf13/cobra"
+	"github.com/spf13/viper"
 )
 
 // AuthorizationCreateFlags are command line args used when creating a authorization
@@ -77,6 +78,10 @@ func authCreateCmd() *cobra.Command {
 
 	cmd.Flags().StringVarP(&authCreateFlags.org, "org", "o", "", "The organization name (required)")
 	cmd.MarkFlagRequired("org")
+	viper.BindEnv("ORG")
+	if h := viper.GetString("ORG"); h != "" {
+		authCreateFlags.org = h
+	}
 
 	cmd.Flags().StringVarP(&authCreateFlags.user, "user", "u", "", "The user name")
 
@@ -297,7 +302,16 @@ func authFindCmd() *cobra.Command {
 	cmd.Flags().StringVarP(&authorizationFindFlags.user, "user", "u", "", "The user")
 	cmd.Flags().StringVarP(&authorizationFindFlags.userID, "user-id", "", "", "The user ID")
 	cmd.Flags().StringVarP(&authorizationFindFlags.org, "org", "o", "", "The org")
+	viper.BindEnv("ORG")
+	if h := viper.GetString("ORG"); h != "" {
+		authorizationFindFlags.org = h
+	}
+
 	cmd.Flags().StringVarP(&authorizationFindFlags.orgID, "org-id", "", "", "The org ID")
+	viper.BindEnv("ORG_ID")
+	if h := viper.GetString("ORG_ID"); h != "" {
+		authorizationFindFlags.orgID = h
+	}
 	cmd.Flags().StringVarP(&authorizationFindFlags.id, "id", "i", "", "The authorization ID")
 
 	return cmd

cmd/influx/bucket.go

@@ -10,6 +10,7 @@ import (
 	"github.com/influxdata/influxdb/cmd/influx/internal"
 	"github.com/influxdata/influxdb/http"
 	"github.com/spf13/cobra"
+	"github.com/spf13/viper"
 )
 
 // Bucket Command
@@ -25,9 +26,8 @@ func bucketF(cmd *cobra.Command, args []string) {
 
 // BucketCreateFlags define the Create Command
 type BucketCreateFlags struct {
-	name      string
-	orgID     string
-	org       string
+	name string
+	organization
 	retention time.Duration
 }
 
@@ -42,9 +42,8 @@ func init() {
 
 	bucketCreateCmd.Flags().StringVarP(&bucketCreateFlags.name, "name", "n", "", "Name of bucket that will be created")
 	bucketCreateCmd.Flags().DurationVarP(&bucketCreateFlags.retention, "retention", "r", 0, "Duration in nanoseconds data will live in bucket")
-	bucketCreateCmd.Flags().StringVarP(&bucketCreateFlags.orgID, "org-id", "", "", "The ID of the organization that owns the bucket")
-	bucketCreateCmd.Flags().StringVarP(&bucketCreateFlags.org, "org", "o", "", "The org name")
 	bucketCreateCmd.MarkFlagRequired("name")
+	bucketCreateFlags.organization.register(bucketCreateCmd)
 
 	bucketCmd.AddCommand(bucketCreateCmd)
 }
@@ -65,9 +64,9 @@ func newBucketService(f Flags) (platform.BucketService, error) {
 }
 
 func bucketCreateF(cmd *cobra.Command, args []string) error {
-	if bucketCreateFlags.orgID == "" && bucketCreateFlags.org == "" {
+	if bucketCreateFlags.organization.id == "" && bucketCreateFlags.organization.name == "" {
 		return fmt.Errorf("must specify org-id, or org name")
-	} else if bucketCreateFlags.orgID != "" && bucketCreateFlags.org != "" {
+	} else if bucketCreateFlags.organization.id != "" && bucketCreateFlags.organization.name != "" {
 		return fmt.Errorf("must specify org-id, or org name not both")
 	}
 
@@ -86,7 +85,7 @@ func bucketCreateF(cmd *cobra.Command, args []string) error {
 		return nil
 	}
 
-	b.OrgID, err = getOrgID(orgSvc, bucketCreateFlags.orgID, bucketCreateFlags.org)
+	b.OrgID, err = bucketCreateFlags.organization.getID(orgSvc)
 	if err != nil {
 		return err
 	}
@@ -117,9 +116,8 @@ func bucketCreateF(cmd *cobra.Command, args []string) error {
 type BucketFindFlags struct {
 	name    string
 	id      string
-	org     string
-	orgID   string
 	headers bool
+	organization
 }
 
 var bucketFindFlags BucketFindFlags
@@ -132,10 +130,13 @@ func init() {
 	}
 
 	bucketFindCmd.Flags().StringVarP(&bucketFindFlags.name, "name", "n", "", "The bucket name")
+	viper.BindEnv("BUCKET_NAME")
+	if h := viper.GetString("BUCKET_NAME"); h != "" {
+		bucketFindFlags.name = h
+	}
 	bucketFindCmd.Flags().StringVarP(&bucketFindFlags.id, "id", "i", "", "The bucket ID")
-	bucketFindCmd.Flags().StringVarP(&bucketFindFlags.orgID, "org-id", "", "", "The bucket organization ID")
-	bucketFindCmd.Flags().StringVarP(&bucketFindFlags.org, "org", "o", "", "The bucket organization name")
 	bucketFindCmd.Flags().BoolVar(&bucketFindFlags.headers, "headers", true, "To print the table headers; defaults true")
+	bucketFindFlags.organization.register(bucketFindCmd)
 
 	bucketCmd.AddCommand(bucketFindCmd)
 }
@@ -159,20 +160,20 @@ func bucketFindF(cmd *cobra.Command, args []string) error {
 		filter.ID = id
 	}
 
-	if bucketFindFlags.orgID != "" && bucketFindFlags.org != "" {
-		return fmt.Errorf("must specify at exactly one of org and org-id")
+	if err := bucketFindFlags.organization.validOrgFlags(); err != nil {
+		return err
 	}
 
-	if bucketFindFlags.orgID != "" {
-		orgID, err := platform.IDFromString(bucketFindFlags.orgID)
+	if bucketFindFlags.organization.id != "" {
+		orgID, err := platform.IDFromString(bucketFindFlags.organization.id)
 		if err != nil {
-			return fmt.Errorf("failed to decode org id %q: %v", bucketFindFlags.orgID, err)
+			return fmt.Errorf("failed to decode org id %q: %v", bucketFindFlags.organization.id, err)
 		}
 		filter.OrganizationID = orgID
 	}
 
-	if bucketFindFlags.org != "" {
-		filter.Org = &bucketFindFlags.org
+	if bucketFindFlags.organization.name != "" {
+		filter.Org = &bucketFindFlags.organization.name
 	}
 
 	buckets, _, err := s.FindBuckets(context.Background(), filter)
@@ -219,6 +220,11 @@ func init() {
 
 	bucketUpdateCmd.Flags().StringVarP(&bucketUpdateFlags.id, "id", "i", "", "The bucket ID (required)")
 	bucketUpdateCmd.Flags().StringVarP(&bucketUpdateFlags.name, "name", "n", "", "New bucket name")
+	viper.BindEnv("BUCKET_NAME")
+	if h := viper.GetString("BUCKET_NAME"); h != "" {
+		bucketFindFlags.name = h
+	}
+
 	bucketUpdateCmd.Flags().DurationVarP(&bucketUpdateFlags.retention, "retention", "r", 0, "New duration data will live in bucket")
 	bucketUpdateCmd.MarkFlagRequired("id")
 

cmd/influx/inspect.go

@@ -17,9 +17,9 @@ type InspectReportTSMFlags struct {
 	pattern  string
 	exact    bool
 	detailed bool
-
-	orgID, org, bucketID string
-	dataDir              string
+	organization
+	bucketID string
+	dataDir  string
 }
 
 var inspectReportTSMFlags InspectReportTSMFlags
@@ -62,8 +62,7 @@ in the following ways:
 	inspectReportTSMCommand.Flags().BoolVarP(&inspectReportTSMFlags.exact, "exact", "", false, "calculate and exact cardinality count. Warning, may use significant memory...")
 	inspectReportTSMCommand.Flags().BoolVarP(&inspectReportTSMFlags.detailed, "detailed", "", false, "emit series cardinality segmented by measurements, tag keys and fields. Warning, may take a while.")
 
-	inspectReportTSMCommand.Flags().StringVarP(&inspectReportTSMFlags.orgID, "org-id", "", "", "process only data belonging to organization ID.")
-	inspectReportTSMCommand.Flags().StringVarP(&inspectReportTSMFlags.org, "org", "o", "", "process only data belonging to organization name.")
+	inspectReportTSMFlags.organization.register(inspectReportTSMCommand)
 	inspectReportTSMCommand.Flags().StringVarP(&inspectReportTSMFlags.bucketID, "bucket-id", "", "", "process only data belonging to bucket ID. Requires org flag to be set.")
 
 	dir, err := fs.InfluxDir()
@@ -76,10 +75,8 @@ in the following ways:
 
 // inspectReportTSMF runs the report-tsm tool.
 func inspectReportTSMF(cmd *cobra.Command, args []string) error {
-	if inspectReportTSMFlags.orgID == "" && inspectReportTSMFlags.org == "" {
-		return fmt.Errorf("must specify org-id, or org name")
-	} else if inspectReportTSMFlags.orgID != "" && inspectReportTSMFlags.org != "" {
-		return fmt.Errorf("must specify org-id, or org name not both")
+	if err := inspectReportTSMFlags.organization.validOrgFlags(); err != nil {
+		return err
 	}
 	report := &tsm1.Report{
 		Stderr:   os.Stderr,
@@ -90,15 +87,15 @@ func inspectReportTSMF(cmd *cobra.Command, args []string) error {
 		Exact:    inspectReportTSMFlags.exact,
 	}
 
-	if (inspectReportTSMFlags.org == "" || inspectReportTSMFlags.orgID == "") && inspectReportTSMFlags.bucketID != "" {
+	if (inspectReportTSMFlags.organization.name == "" || inspectReportTSMFlags.organization.id == "") && inspectReportTSMFlags.bucketID != "" {
 		return errors.New("org-id must be set for non-empty bucket-id")
 	}
 
 	orgSvc, err := newOrganizationService()
 	if err != nil {
 		return nil
 	}
-	id, err := getOrgID(orgSvc, bucketCreateFlags.orgID, bucketCreateFlags.org)
+	id, err := inspectReportTSMFlags.organization.getID(orgSvc)
 	if err != nil {
 		return nil
 	}

cmd/influx/main.go

@@ -83,6 +83,9 @@ func influxCmd() *cobra.Command {
 			cmd.Usage()
 		},
 	}
+
+	viper.SetEnvPrefix("INFLUX")
+
 	cmd.AddCommand(
 		authCmd(),
 		bucketCmd,
@@ -99,8 +102,6 @@ func influxCmd() *cobra.Command {
 		writeCmd,
 	)
 
-	viper.SetEnvPrefix("INFLUX")
-
 	cmd.PersistentFlags().StringVarP(&flags.token, "token", "t", "", "API token to be used throughout client calls")
 	viper.BindEnv("TOKEN")
 	if h := viper.GetString("TOKEN"); h != "" {
@@ -230,22 +231,47 @@ func newLocalKVService() (*kv.Service, error) {
 	return kv.NewService(zap.NewNop(), store), nil
 }
 
-func getOrgID(orgSVC influxdb.OrganizationService, id string, name string) (influxdb.ID, error) {
-	if id != "" {
-		influxOrgID, err := influxdb.IDFromString(id)
+type organization struct {
+	id, name string
+}
+
+func (org *organization) register(cmd *cobra.Command) {
+	cmd.Flags().StringVarP(&org.id, "org-id", "", "", "The ID of the organization that owns the bucket")
+	viper.BindEnv("ORG_ID")
+	if h := viper.GetString("ORG_ID"); h != "" {
+		org.id = h
+	}
+	cmd.Flags().StringVarP(&org.name, "org", "o", "", "The name of the organization that owns the bucket")
+	viper.BindEnv("ORG")
+	if h := viper.GetString("ORG"); h != "" {
+		org.name = h
+	}
+}
+
+func (org *organization) getID(orgSVC influxdb.OrganizationService) (influxdb.ID, error) {
+	if org.id != "" {
+		influxOrgID, err := influxdb.IDFromString(org.id)
 		if err != nil {
 			return 0, fmt.Errorf("invalid org ID provided: %s", err.Error())
 		}
 		return *influxOrgID, nil
-	} else if name != "" {
+	} else if org.name != "" {
 		org, err := orgSVC.FindOrganization(context.Background(), influxdb.OrganizationFilter{
-			Name: &name,
+			Name: &org.name,
 		})
 		if err != nil {
 			return 0, fmt.Errorf("%v", err)
 		}
 		return org.ID, nil
 	}
+	return 0, fmt.Errorf("failed to locate an organization id")
+}
 
-	return 0, fmt.Errorf("")
+func (org *organization) validOrgFlags() error {
+	if org.id == "" && org.name == "" {
+		return fmt.Errorf("must specify org-id, or org name")
+	} else if org.id != "" && org.name != "" {
+		return fmt.Errorf("must specify org-id, or org name not both")
+	}
+	return nil
 }

cmd/influx/organization.go

@@ -9,6 +9,7 @@ import (
 	"github.com/influxdata/influxdb/cmd/influx/internal"
 	"github.com/influxdata/influxdb/http"
 	"github.com/spf13/cobra"
+	"github.com/spf13/viper"
 )
 
 func organizationCmd() *cobra.Command {
@@ -113,7 +114,15 @@ func orgFindCmd() *cobra.Command {
 	}
 
 	cmd.Flags().StringVarP(&organizationFindFlags.name, "name", "n", "", "The organization name")
+	viper.BindEnv("ORG")
+	if h := viper.GetString("ORG"); h != "" {
+		organizationFindFlags.name = h
+	}
 	cmd.Flags().StringVarP(&organizationFindFlags.id, "id", "i", "", "The organization ID")
+	viper.BindEnv("ORG_ID")
+	if h := viper.GetString("ORG_ID"); h != "" {
+		organizationFindFlags.id = h
+	}
 
 	return cmd
 }
@@ -174,8 +183,17 @@ func orgUpdateCmd() *cobra.Command {
 	}
 
 	cmd.Flags().StringVarP(&organizationUpdateFlags.id, "id", "i", "", "The organization ID (required)")
-	cmd.Flags().StringVarP(&organizationUpdateFlags.name, "name", "n", "", "The organization name")
 	cmd.MarkFlagRequired("id")
+	viper.BindEnv("ORG_ID")
+	if h := viper.GetString("ORG_ID"); h != "" {
+		organizationUpdateFlags.id = h
+	}
+
+	cmd.Flags().StringVarP(&organizationUpdateFlags.name, "name", "n", "", "The organization name")
+	viper.BindEnv("ORG")
+	if h := viper.GetString("ORG"); h != "" {
+		organizationUpdateFlags.name = h
+	}
 
 	return cmd
 }
@@ -268,6 +286,10 @@ func orgDeleteCmd() *cobra.Command {
 
 	cmd.Flags().StringVarP(&organizationDeleteFlags.id, "id", "i", "", "The organization ID (required)")
 	cmd.MarkFlagRequired("id")
+	viper.BindEnv("ORG_ID")
+	if h := viper.GetString("ORG_ID"); h != "" {
+		organizationUpdateFlags.id = h
+	}
 
 	return cmd
 }
@@ -340,7 +362,15 @@ func orgMembersListCmd() *cobra.Command {
 	}
 
 	cmd.Flags().StringVarP(&organizationMembersListFlags.id, "id", "i", "", "The organization ID")
+	viper.BindEnv("ORG_ID")
+	if h := viper.GetString("ORG_ID"); h != "" {
+		organizationMembersListFlags.id = h
+	}
 	cmd.Flags().StringVarP(&organizationMembersListFlags.name, "name", "n", "", "The organization name")
+	viper.BindEnv("ORG")
+	if h := viper.GetString("ORG"); h != "" {
+		organizationMembersListFlags.name = h
+	}
 
 	return cmd
 }
@@ -411,7 +441,16 @@ func orgMembersAddCmd() *cobra.Command {
 	}
 
 	cmd.Flags().StringVarP(&organizationMembersAddFlags.id, "id", "i", "", "The organization ID")
+	viper.BindEnv("ORG_ID")
+	if h := viper.GetString("ORG_ID"); h != "" {
+		organizationMembersAddFlags.id = h
+	}
 	cmd.Flags().StringVarP(&organizationMembersAddFlags.name, "name", "n", "", "The organization name")
+	viper.BindEnv("ORG")
+	if h := viper.GetString("ORG"); h != "" {
+		organizationMembersAddFlags.name = h
+	}
+
 	cmd.Flags().StringVarP(&organizationMembersAddFlags.memberID, "member", "o", "", "The member ID")
 	cmd.MarkFlagRequired("member")
 
@@ -478,7 +517,15 @@ func orgMembersRemoveCmd() *cobra.Command {
 	}
 
 	cmd.Flags().StringVarP(&organizationMembersRemoveFlags.id, "id", "i", "", "The organization ID")
+	viper.BindEnv("ORG_ID")
+	if h := viper.GetString("ORG_ID"); h != "" {
+		organizationMembersAddFlags.id = h
+	}
 	cmd.Flags().StringVarP(&organizationMembersRemoveFlags.name, "name", "n", "", "The organization name")
+	viper.BindEnv("ORG")
+	if h := viper.GetString("ORG"); h != "" {
+		organizationMembersRemoveFlags.name = h
+	}
 	cmd.Flags().StringVarP(&organizationMembersRemoveFlags.memberID, "member", "o", "", "The member ID")
 	cmd.MarkFlagRequired("member")