usage: skip structs marked as hidden in usage help output (grafana#5655)

ortuman · web-flow · commit 3ec0ea236e7c · 2023-08-02T11:28:12.000+02:00
Signed-off-by: Miguel Ángel Ortuño &lt;ortuman@gmail.com&gt;
diff --git a/cmd/mimir/main_test.go b/cmd/mimir/main_test.go
@@ -443,6 +443,10 @@ func TestFieldCategoryOverridesNotStale(t *testing.T) {
 
 	fs := flag.NewFlagSet("test", flag.PanicOnError)
 
+	// Add ignored flags.
+	flagext.IgnoredFlag(fs, configFileOption, "Configuration file to load.")
+	_ = fs.Bool(configExpandEnv, false, "Expands ${var} or $var in config according to the values of the environment variables.")
+
 	var (
 		cfg mimir.Config
 		mf  mainFlags
diff --git a/pkg/util/fieldcategory/overrides.go b/pkg/util/fieldcategory/overrides.go
@@ -68,6 +68,10 @@ var overrides = map[string]Category{
 	"server.path-prefix":                                Advanced,
 	"server.register-instrumentation":                   Advanced,
 	"server.log-request-at-info-level-enabled":          Advanced,
+
+	// main.go global flags
+	"config.file":       Basic,
+	"config.expand-env": Basic,
 }
 
 func AddOverrides(o map[string]Category) {
diff --git a/pkg/util/usage/usage.go b/pkg/util/usage/usage.go
@@ -59,6 +59,9 @@ func Usage(printAll bool, configs ...interface{}) error {
 			case "deprecated":
 				fieldCat = fieldcategory.Deprecated
 			}
+		} else {
+			// The field is neither an override nor has been parsed, so we'll skip it.
+			return
 		}
 
 		if fieldCat != fieldcategory.Basic && !printAll {
@@ -149,7 +152,7 @@ func parseStructure(structure interface{}, fields map[uintptr]reflect.StructFiel
 		fields[fieldValue.Addr().Pointer()] = field
 
 		// Recurse if a struct
-		if field.Type.Kind() != reflect.Struct || ignoreStructType(field.Type) || !field.IsExported() {
+		if field.Type.Kind() != reflect.Struct || isFieldHidden(field) || ignoreStructType(field.Type) || !field.IsExported() {
 			continue
 		}
 

Original file line number	Diff line number	Diff line change
`@@ -59,6 +59,9 @@ func Usage(printAll bool, configs ...interface{}) error {`
`59`	`59`	`case "deprecated":`
`60`	`60`	`fieldCat = fieldcategory.Deprecated`
`61`	`61`	`}`
	`62`	`+ } else {`
	`63`	`+ // The field is neither an override nor has been parsed, so we'll skip it.`
	`64`	`+ return`
`62`	`65`	`}`
`63`	`66`
`64`	`67`	`if fieldCat != fieldcategory.Basic && !printAll {`
`@@ -149,7 +152,7 @@ func parseStructure(structure interface{}, fields map[uintptr]reflect.StructFiel`
`149`	`152`	`fields[fieldValue.Addr().Pointer()] = field`
`150`	`153`
`151`	`154`	`// Recurse if a struct`
`152`		`- if field.Type.Kind() != reflect.Struct \|\| ignoreStructType(field.Type) \|\| !field.IsExported() {`
	`155`	`+ if field.Type.Kind() != reflect.Struct \|\| isFieldHidden(field) \|\| ignoreStructType(field.Type) \|\| !field.IsExported() {`
`153`	`156`	`continue`
`154`	`157`	`}`
`155`	`158`