Merge pull request #106 from dengsh12/NLB5207

Provide `-filter` and `-override` with command line generator

Author: dengsh12

README.md

@@ -74,7 +74,9 @@ func main() {
 ```
 
 # Generate support for third-party modules
-This is an example that takes the path of a third-party module source code to generate support for it. Assume the source code path of that module is `./src`. You can call `go run cmd/generate/main.go ./src`. The stdout will be like
+This is a simple example that takes the path of a third-party module source code to generate support for it. For detailed usage of the tool, please run
+`go run ./cmd/generate/ --help`
+Assuming the source code path of that module is `./src`, you can call `go run ./cmd/generate/ --src-path=./src`. The output will be similar to:
 
 ```go
 /**

cmd/generate/cmd_util.go

@@ -0,0 +1,99 @@
+/**
+ * Copyright (c) F5, Inc.
+ *
+ * This source code is licensed under the Apache License, Version 2.0 license found in the
+ * LICENSE file in the root directory of this source tree.
+ */
+
+package main
+
+import (
+	"errors"
+	"fmt"
+	"strings"
+
+	"github.com/nginxinc/nginx-go-crossplane/internal/generator"
+)
+
+type filterFlag struct {
+	filter map[string]struct{}
+}
+
+func (f *filterFlag) Set(value string) error {
+	if f.filter == nil {
+		f.filter = make(map[string]struct{})
+	}
+	f.filter[value] = struct{}{}
+	return nil
+}
+
+func (f *filterFlag) String() string {
+	return fmt.Sprintf("%v", *f)
+}
+
+type overrideItem struct {
+	directive string
+	masks     []generator.Mask
+}
+
+func (item *overrideItem) UnmarshalText(text []byte) error {
+	rawOverride := string(text)
+
+	// rawStr should follow the format: directive:bitmask00|bitmask01|...,bitmask10|bitmask11|...
+	directive, definition, found := strings.Cut(rawOverride, ":")
+	if !found {
+		return errors.New("colon not found")
+	}
+	directive = strings.TrimSpace(directive)
+
+	item.directive = directive
+	if directive == "" {
+		return errors.New("directive name is empty")
+	}
+
+	definition = strings.TrimSpace(definition)
+	if definition == "" {
+		return errors.New("directive definition is empty")
+	}
+
+	for _, varNamesStr := range strings.Split(definition, ",") {
+		varNamesList := strings.Split(varNamesStr, "|")
+		varNamesNum := len(varNamesList)
+		directiveMask := make(generator.Mask, varNamesNum)
+
+		for idx, varName := range varNamesList {
+			trimmedName := strings.TrimSpace(varName)
+			if trimmedName == "" {
+				return errors.New("one directive bitmask is empty, check if there are unnecessary |")
+			}
+
+			directiveMask[idx] = trimmedName
+		}
+		item.masks = append(item.masks, directiveMask)
+	}
+
+	return nil
+}
+
+type override map[string][]generator.Mask
+
+func (ov *override) String() string {
+	if ov == nil {
+		return "nil"
+	}
+	return fmt.Sprintf("%v", *ov)
+}
+
+func (ov *override) Set(value string) error {
+	if *ov == nil {
+		*ov = override{}
+	}
+	var item overrideItem
+	err := item.UnmarshalText([]byte(value))
+	if err != nil {
+		return fmt.Errorf("invalid override %s:%w", value, err)
+	}
+
+	(*ov)[item.directive] = item.masks
+	return nil
+}

cmd/generate/cmd_util_test.go

@@ -0,0 +1,95 @@
+/**
+ * Copyright (c) F5, Inc.
+ *
+ * This source code is licensed under the Apache License, Version 2.0 license found in the
+ * LICENSE file in the root directory of this source tree.
+ */
+
+package main
+
+import (
+	"testing"
+
+	"github.com/nginxinc/nginx-go-crossplane/internal/generator"
+	"github.com/stretchr/testify/require"
+)
+
+//nolint:funlen
+func TestOverrideParser(t *testing.T) {
+	t.Parallel()
+	tests := []struct {
+		name     string
+		input    string
+		expected overrideItem
+		wantErr  bool
+	}{
+		{
+			name:  "normalFormat_pass",
+			input: "location:ngxHTTPMainConf|ngxConfTake12,ngxStreamMainConf",
+
+			expected: overrideItem{
+				directive: "location",
+				masks: []generator.Mask{
+					{"ngxHTTPMainConf", "ngxConfTake12"},
+					{"ngxStreamMainConf"},
+				},
+			},
+			wantErr: false,
+		},
+		{
+			name:  "withSpaces_pass",
+			input: "hash:ngxHTTPUpsConf | ngxConfTake12, ngxStreamUpsConf | ngxConfTake12",
+			expected: overrideItem{
+				directive: "hash",
+				masks: []generator.Mask{
+					{"ngxHTTPUpsConf", "ngxConfTake12"},
+					{"ngxStreamUpsConf", "ngxConfTake12"},
+				},
+			},
+			wantErr: false,
+		},
+		{
+			name:    "withoutColon_fail",
+			input:   "hashngxHTTPUpsConf | ngxConfTake12,ngxStreamUpsConf | ngxConfTake12",
+			wantErr: true,
+		},
+		{
+			name:    "colonLeftsideEmpty_fail",
+			input:   " :ngxHTTPUpsConf | ngxConfTake12,ngxStreamUpsConf | ngxConfTake12",
+			wantErr: true,
+		},
+		{
+			name:    "colonRightsideEmpty_fail",
+			input:   "hash:  ",
+			wantErr: true,
+		},
+		{
+			name:    "emptyBitmask_fail",
+			input:   "hash: ngxHTTPUpsConf| ",
+			wantErr: true,
+		},
+	}
+
+	for _, tc := range tests {
+		tc := tc
+		t.Run(tc.name, func(t *testing.T) {
+			t.Parallel()
+			var got overrideItem
+			err := got.UnmarshalText([]byte(tc.input))
+
+			if tc.wantErr {
+				require.Error(t, err)
+			} else {
+				require.NoError(t, err)
+			}
+
+			// If the testcase wants an error and there is an error, skip the output file validation.
+			// Output makes no sense when there is an error.
+			if err != nil {
+				return
+			}
+
+			require.Equal(t, tc.expected, got)
+		})
+	}
+}

cmd/generate/main.go

@@ -18,10 +18,22 @@ import (
 func main() {
 	var (
 		sourceCodePath = flag.String("src-path", "",
-			"the path of source code your want to generate support from, it can be either a file or a directory. (required)")
+			"The path of source code your want to generate support from, it can be either a file or a directory. (required)")
+		filterflags       filterFlag
+		directiveOverride override
 	)
+	flag.Var(&filterflags, "filter",
+		"A list of strings specifying the directives to exclude from the output. "+
+			"An example is: -filter directive1 -filter directive2...(optional)")
+	flag.Var(&directiveOverride, "override",
+		"A list of strings, used to override the output. "+
+			"It should follow the format:{directive:bitmask00|bitmask01...,bitmask10|bitmask11...}"+"\n"+
+			"An example is -override=log_format:ngxHTTPMainConf|ngxConf2More,ngxStreamMainConf|ngxConf2More"+"\n"+
+			`To use | and , in command line, you may need to enclose your input in quotes, i.e. -override="directive:mask1,mask2,...". (optional)`)
+
 	flag.Parse()
-	err := generator.Generate(*sourceCodePath, os.Stdout)
+
+	err := generator.Generate(*sourceCodePath, os.Stdout, filterflags.filter, directiveOverride)
 	if err != nil {
 		log.Fatal(err)
 	}

internal/generator/generator.go

@@ -15,6 +15,6 @@ import (
 // extract all the directives definitions from the .c and .cpp files in
 // sourcePath and its subdirectories, then output the corresponding directive
 // masks map named "directives" and matchFunc named "Match" via writer.
-func Generate(sourcePath string, writer io.Writer) error {
-	return genFromSrcCode(sourcePath, "directives", "Match", writer)
+func Generate(sourcePath string, writer io.Writer, filter map[string]struct{}, override map[string][]Mask) error {
+	return genFromSrcCode(sourcePath, "directives", "Match", writer, filter, override)
 }

internal/generator/generator_util.go

@@ -20,14 +20,14 @@ import (
 	"strings"
 )
 
-// A mask is a list of string, includes several variable names,
+// A Mask is a list of string, includes several variable names,
 // which specify a behavior of a directive.
 // An example is []string{"ngxHTTPMainConf", "ngxConfFlag",}.
 // A directive can have several masks.
-type mask []string
+type Mask []string
 
 type supportFileTmplStruct struct {
-	Directive2Masks map[string][]mask
+	Directive2Masks map[string][]Mask
 	MapVariableName string
 	MatchFnName     string
 }
@@ -99,8 +99,8 @@ var ngxVarNameToGo = map[string]string{
 }
 
 //nolint:nonamedreturns
-func masksFromFile(path string) (directive2Masks map[string][]mask, err error) {
-	directive2Masks = make(map[string][]mask, 0)
+func masksFromFile(path string) (directive2Masks map[string][]Mask, err error) {
+	directive2Masks = make(map[string][]Mask, 0)
 	byteContent, err := os.ReadFile(path)
 	if err != nil {
 		return nil, err
@@ -143,8 +143,8 @@ func masksFromFile(path string) (directive2Masks map[string][]mask, err error) {
 }
 
 //nolint:nonamedreturns
-func getMasksFromPath(path string) (directive2Masks map[string][]mask, err error) {
-	directive2Masks = make(map[string][]mask, 0)
+func getMasksFromPath(path string) (directive2Masks map[string][]Mask, err error) {
+	directive2Masks = make(map[string][]Mask, 0)
 
 	err = filepath.WalkDir(path, func(path string, d fs.DirEntry, err error) error {
 		if err != nil {
@@ -184,12 +184,29 @@ func getMasksFromPath(path string) (directive2Masks map[string][]mask, err error
 	return directive2Masks, nil
 }
 
-func genFromSrcCode(codePath string, mapVariableName string, matchFnName string, writer io.Writer) error {
+func genFromSrcCode(codePath string, mapVariableName string, matchFnName string, writer io.Writer,
+	filter map[string]struct{}, override map[string][]Mask) error {
 	directive2Masks, err := getMasksFromPath(codePath)
 	if err != nil {
 		return err
 	}
 
+	if len(filter) > 0 {
+		for d := range directive2Masks {
+			if _, found := filter[d]; found {
+				delete(directive2Masks, d)
+			}
+		}
+	}
+
+	if override != nil {
+		for d := range directive2Masks {
+			if newMasks, found := override[d]; found {
+				directive2Masks[d] = newMasks
+			}
+		}
+	}
+
 	err = supportFileTmpl.Execute(writer, supportFileTmplStruct{
 		Directive2Masks: directive2Masks,
 		MapVariableName: mapVariableName,