Merge pull request #77 from qonto/mdemolin-extended-regex

Add support for extended regexp in grep rule

config/config.go

@@ -55,12 +55,13 @@ type FileRule struct {
 }
 
 type GrepRule struct {
-	Path         string `validate:"required"`
-	Pattern      string `validate:"required"`
-	Include      string
-	Recursive    bool
-	Match        bool
-	SkipNotFound bool `yaml:"skip-not-found"`
+	Path           string `validate:"required"`
+	Pattern        string `validate:"required"`
+	Include        string
+	ExtendedRegexp bool `yaml:"extended-regexp"`
+	Recursive      bool
+	Match          bool
+	SkipNotFound   bool `yaml:"skip-not-found"`
 }
 
 type ProjectRule struct {

doc/rules/grep.md

@@ -19,5 +19,6 @@ Available options are:
 
 - `path`: the file or directory to check (mandatory)
 - `pattern`: the string pattern to search for (mandatory)
-- `recursive`: recursively search subdirectories listed (grep `-r`option)
-- `match`: if set to true, the module will be successful if the pattern is found. Default to false, where the module will be successful if the pattern is **not** found.
+- `recursive`: recursively search subdirectories listed (grep `-r` option)
+- `match`: if set to true, the module will be successful if the pattern is found. Default to false, where the module will be successful if the pattern is **not** found
+- `extended-regexp`: if set to true, the pattern is treated as an extended regular expression (grep `-E` option)

pkg/ruler/rules/grep.go

@@ -14,22 +14,24 @@ import (
 )
 
 type GrepRule struct {
-	Path         string
-	Include      string
-	Pattern      string
-	Recursive    bool
-	Match        bool
-	SkipNotFound bool
+	Path           string
+	Include        string
+	Pattern        string
+	ExtendedRegexp bool
+	Recursive      bool
+	Match          bool
+	SkipNotFound   bool
 }
 
 func NewGrepRule(config config.GrepRule) *GrepRule {
 	return &GrepRule{
-		Path:         config.Path,
-		Recursive:    config.Recursive,
-		Pattern:      config.Pattern,
-		Include:      config.Include,
-		Match:        config.Match,
-		SkipNotFound: config.SkipNotFound,
+		Path:           config.Path,
+		Recursive:      config.Recursive,
+		Pattern:        config.Pattern,
+		ExtendedRegexp: config.ExtendedRegexp,
+		Include:        config.Include,
+		Match:          config.Match,
+		SkipNotFound:   config.SkipNotFound,
 	}
 }
 
@@ -47,6 +49,9 @@ func (rule *GrepRule) Do(ctx context.Context, project project.Project) error {
 	if rule.Include != "" {
 		arguments = append(arguments, "--include", rule.Include)
 	}
+	if rule.ExtendedRegexp {
+		arguments = append(arguments, "--extended-regexp")
+	}
 	arguments = append(arguments, rule.Pattern, path)
 
 	cmd := exec.CommandContext(ctx, "grep", arguments...) //nolint

pkg/ruler/rules/grep_test.go

@@ -81,6 +81,27 @@ func TestGrepRule(t *testing.T) {
 				Match:     true,
 			},
 		},
+		{
+			rule: rules.GrepRule{
+				Path:           "_testdata",
+				Recursive:      true,
+				Include:        "file1",
+				Pattern:        "abc?defg",
+				ExtendedRegexp: false,
+				Match:          true,
+			},
+			error: "no match for pattern",
+		},
+		{
+			rule: rules.GrepRule{
+				Path:           "_testdata",
+				Recursive:      true,
+				Include:        "file1",
+				Pattern:        "abc?defg",
+				ExtendedRegexp: true,
+				Match:          true,
+			},
+		},
 		{
 			rule: rules.GrepRule{
 				Path:      "_testdata",