utils/cobrautil: FlagsDescriber change field ShowNotChanged to ShowCh…

…angedOnly Enable displaying hidden flags that are set.
saucelabs · Jul 23, 2024 · 3795c1e · 3795c1e
1 parent cddae59
commit 3795c1e
Show file tree

Hide file tree

Showing 6 changed files with 49 additions and 40 deletions.
diff --git a/command/pac/server/server.go b/command/pac/server/server.go
@@ -57,17 +57,21 @@ func (c *command) runE(cmd *cobra.Command, _ []string) (cmdErr error) {
 			err error
 		)
 
-		d := cobrautil.FlagsDescriber{
-			Format: cobrautil.Plain,
-		}
-		cfg, err = d.DescribeFlags(cmd.Flags())
+		cfg, err = cobrautil.FlagsDescriber{
+			Format:          cobrautil.Plain,
+			ShowChangedOnly: true,
+			ShowHidden:      true,
+		}.DescribeFlags(cmd.Flags())
 		if err != nil {
 			return err
 		}
 		logger.Infof("configuration\n%s", cfg)
 
-		d.ShowNotChanged = true
-		cfg, err = d.DescribeFlags(cmd.Flags())
+		cfg, err = cobrautil.FlagsDescriber{
+			Format:          cobrautil.Plain,
+			ShowChangedOnly: false,
+			ShowHidden:      true,
+		}.DescribeFlags(cmd.Flags())
 		if err != nil {
 			return err
 		}

diff --git a/command/run/run.go b/command/run/run.go
@@ -93,10 +93,11 @@ func (c *command) runE(cmd *cobra.Command, _ []string) (cmdErr error) {
 			err error
 		)
 
-		d := cobrautil.FlagsDescriber{
-			Format: cobrautil.Plain,
-		}
-		cfg, err = d.DescribeFlags(cmd.Flags())
+		cfg, err = cobrautil.FlagsDescriber{
+			Format:          cobrautil.Plain,
+			ShowChangedOnly: true,
+			ShowHidden:      true,
+		}.DescribeFlags(cmd.Flags())
 		if err != nil {
 			return err
 		}
@@ -106,8 +107,11 @@ func (c *command) runE(cmd *cobra.Command, _ []string) (cmdErr error) {
 			logger.Infof("using default configuration")
 		}
 
-		d.ShowNotChanged = true
-		cfg, err = d.DescribeFlags(cmd.Flags())
+		cfg, err = cobrautil.FlagsDescriber{
+			Format:          cobrautil.Plain,
+			ShowChangedOnly: false,
+			ShowHidden:      true,
+		}.DescribeFlags(cmd.Flags())
 		if err != nil {
 			return err
 		}

diff --git a/command/test/grpc/grpc.go b/command/test/grpc/grpc.go
@@ -58,17 +58,21 @@ func (c *command) runE(cmd *cobra.Command, _ []string) (cmdErr error) {
 			err error
 		)
 
-		d := cobrautil.FlagsDescriber{
-			Format: cobrautil.Plain,
-		}
-		cfg, err = d.DescribeFlags(cmd.Flags())
+		cfg, err = cobrautil.FlagsDescriber{
+			Format:          cobrautil.Plain,
+			ShowChangedOnly: true,
+			ShowHidden:      true,
+		}.DescribeFlags(cmd.Flags())
 		if err != nil {
 			return err
 		}
 		logger.Infof("configuration\n%s", cfg)
 
-		d.ShowNotChanged = true
-		cfg, err = d.DescribeFlags(cmd.Flags())
+		cfg, err = cobrautil.FlagsDescriber{
+			Format:          cobrautil.Plain,
+			ShowChangedOnly: false,
+			ShowHidden:      true,
+		}.DescribeFlags(cmd.Flags())
 		if err != nil {
 			return err
 		}

diff --git a/command/test/httpbin/httpbin.go b/command/test/httpbin/httpbin.go
@@ -53,17 +53,21 @@ func (c *command) runE(cmd *cobra.Command, _ []string) (cmdErr error) {
 			err error
 		)
 
-		d := cobrautil.FlagsDescriber{
-			Format: cobrautil.Plain,
-		}
-		cfg, err = d.DescribeFlags(cmd.Flags())
+		cfg, err = cobrautil.FlagsDescriber{
+			Format:          cobrautil.Plain,
+			ShowChangedOnly: true,
+			ShowHidden:      true,
+		}.DescribeFlags(cmd.Flags())
 		if err != nil {
 			return err
 		}
 		logger.Infof("configuration\n%s", cfg)
 
-		d.ShowNotChanged = true
-		cfg, err = d.DescribeFlags(cmd.Flags())
+		cfg, err = cobrautil.FlagsDescriber{
+			Format:          cobrautil.Plain,
+			ShowChangedOnly: false,
+			ShowHidden:      true,
+		}.DescribeFlags(cmd.Flags())
 		if err != nil {
 			return err
 		}

diff --git a/utils/cobrautil/describe.go b/utils/cobrautil/describe.go
@@ -27,18 +27,11 @@ const (
 	YAML
 )
 
-func DescribeFlags(fs *pflag.FlagSet, format DescribeFormat) ([]byte, error) {
-	return FlagsDescriber{
-		Format:         format,
-		ShowNotChanged: true,
-	}.DescribeFlags(fs)
-}
-
 type FlagsDescriber struct {
-	Format         DescribeFormat
-	Unredacted     bool
-	ShowNotChanged bool
-	ShowHidden     bool
+	Format          DescribeFormat
+	Unredacted      bool
+	ShowChangedOnly bool
+	ShowHidden      bool
 }
 
 func (d FlagsDescriber) DescribeFlags(fs *pflag.FlagSet) ([]byte, error) {
@@ -48,10 +41,10 @@ func (d FlagsDescriber) DescribeFlags(fs *pflag.FlagSet) ([]byte, error) {
 		if f.Name == "help" {
 			return
 		}
-		if !d.ShowNotChanged && !f.Changed {
+		if !f.Changed && d.ShowChangedOnly {
 			return
 		}
-		if !d.ShowHidden && f.Hidden {
+		if f.Hidden && !d.ShowHidden {
 			return
 		}
 

diff --git a/utils/cobrautil/describe_test.go b/utils/cobrautil/describe_test.go
@@ -148,7 +148,7 @@ func testDescribeFlags(t *testing.T, f DescribeFormat, expected []string) { //no
 				return fs
 			},
 			decorate: func(d *FlagsDescriber) {
-				d.ShowNotChanged = false
+				d.ShowChangedOnly = true
 			},
 		},
 		{
@@ -186,8 +186,8 @@ func testDescribeFlags(t *testing.T, f DescribeFormat, expected []string) { //no
 		tc := tests[i]
 		t.Run(tc.name, func(t *testing.T) {
 			d := FlagsDescriber{
-				Format:         f,
-				ShowNotChanged: true,
+				Format:          f,
+				ShowChangedOnly: false,
 			}
 			if tc.decorate != nil {
 				tc.decorate(&d)