fix: add map directive parameters to parse payload without parsing

The parameters inside the map block were being treated as directives,
thus not getting added to the parsed payload because they aren't in the allow list.
This solves this issue by skipping further parsing or validating.

Author: valyria257

build_test.go

@@ -356,7 +356,7 @@ var compareFixtures = []compareFixture{
 	{"empty-value-map", ParseOptions{}},
 	{"russian-text", ParseOptions{}},
 	{"quoted-right-brace", ParseOptions{}},
-	{"directive-with-space", ParseOptions{}},
+	{"directive-with-space", ParseOptions{ErrorOnUnknownDirectives: true}},
 	{"empty-config", ParseOptions{}},
 }
 

parse.go

@@ -260,6 +260,23 @@ func (p *parser) parse(parsing *Config, tokens <-chan NgxToken, ctx blockCtx, co
 			}
 		}
 
+		// if inside map block - add contents to payload, but do not parse further
+		if len(ctx) > 0 && (ctx[len(ctx)-1] == "map" || ctx[len(ctx)-1] == "charset_map") {
+			mapErr := analyzeMapContents(parsing.File, stmt, t.Value)
+			if mapErr != nil && p.options.StopParsingOnError {
+				return nil, mapErr
+			} else if mapErr != nil {
+				p.handleError(parsing, mapErr)
+				// consume invalid block
+				if t.Value == "{" && !t.IsQuoted {
+					_, _ = p.parse(parsing, tokens, nil, true)
+				}
+				continue
+			}
+			parsed = append(parsed, stmt)
+			continue
+		}
+
 		// consume the directive if it is ignored and move on
 		if contains(p.options.IgnoreDirectives, stmt.Directive) {
 			// if this directive was a block consume it too
@@ -417,3 +434,21 @@ func (p *parser) isAcyclic() bool {
 	}
 	return fileCount != len(p.includeInDegree)
 }
+
+func analyzeMapContents(fname string, stmt *Directive, term string) error {
+	if term != ";" {
+		return &ParseError{
+			What: fmt.Sprintf(`unexpected "%s"`, term),
+			File: &fname,
+			Line: &stmt.Line,
+		}
+	}
+	if len(stmt.Args) != 1 {
+		return &ParseError{
+			What: "invalid number of the map parameters",
+			File: &fname,
+			Line: &stmt.Line,
+		}
+	}
+	return nil
+}

parse_test.go

@@ -907,6 +907,178 @@ var parseFixtures = []parseFixture{
 			},
 		},
 	}},
+	{"directive-with-space", "", ParseOptions{ErrorOnUnknownDirectives: true}, Payload{
+		Status: "ok",
+		Config: []Config{
+			{
+				File:   getTestConfigPath("directive-with-space", "nginx.conf"),
+				Status: "ok",
+				Parsed: Directives{
+					{
+						Directive: "events",
+						Args:      []string{},
+						Line:      1,
+						Block:     Directives{},
+					},
+					{
+						Directive: "http",
+						Args:      []string{},
+						Line:      3,
+						Block: Directives{
+							{
+								Directive: "map",
+								Args:      []string{"$http_user_agent", "$mobile"},
+								Line:      4,
+								Block: Directives{
+									{
+										Directive: "default",
+										Args:      []string{"0"},
+										Line:      5,
+										Block:     Directives{},
+									},
+									{
+										Directive: "~Opera Mini",
+										Args:      []string{"1"},
+										Line:      6,
+										Block:     Directives{},
+									},
+								},
+							},
+							{
+								Directive: "charset_map",
+								Args:      []string{"koi8-r", "utf-8"},
+								Line:      9,
+								Block: Directives{
+									{
+										Directive: "C0",
+										Args:      []string{"D18E"},
+										Line:      10,
+										Block:     Directives{},
+									},
+									{
+										Directive: "C1",
+										Args:      []string{"D0B0"},
+										Line:      11,
+										Block:     Directives{},
+									},
+								},
+							},
+						},
+					},
+				},
+			},
+		},
+	}},
+	{"invalid-map", "", ParseOptions{ErrorOnUnknownDirectives: true}, Payload{
+		Status: "failed",
+		Errors: []PayloadError{
+			{
+				File: getTestConfigPath("invalid-map", "nginx.conf"),
+				Error: &ParseError{
+					`unexpected "{"`,
+					pStr(getTestConfigPath("invalid-map", "nginx.conf")),
+					pInt(7),
+					nil,
+				},
+				Line: pInt(7),
+			},
+			{
+				File: getTestConfigPath("invalid-map", "nginx.conf"),
+				Error: &ParseError{
+					`invalid number of the map parameters`,
+					pStr(getTestConfigPath("invalid-map", "nginx.conf")),
+					pInt(10),
+					nil,
+				},
+				Line: pInt(10),
+			},
+			{
+				File: getTestConfigPath("invalid-map", "nginx.conf"),
+				Error: &ParseError{
+					`invalid number of the map parameters`,
+					pStr(getTestConfigPath("invalid-map", "nginx.conf")),
+					pInt(14),
+					nil,
+				},
+				Line: pInt(14),
+			},
+		},
+		Config: []Config{
+			{
+				File:   getTestConfigPath("invalid-map", "nginx.conf"),
+				Status: "failed",
+				Errors: []ConfigError{
+					{
+						Error: &ParseError{
+							`unexpected "{"`,
+							pStr(getTestConfigPath("invalid-map", "nginx.conf")),
+							pInt(7),
+							nil,
+						},
+						Line: pInt(7),
+					},
+					{
+						Error: &ParseError{
+							`invalid number of the map parameters`,
+							pStr(getTestConfigPath("invalid-map", "nginx.conf")),
+							pInt(10),
+							nil,
+						},
+						Line: pInt(10),
+					},
+					{
+						Error: &ParseError{
+							`invalid number of the map parameters`,
+							pStr(getTestConfigPath("invalid-map", "nginx.conf")),
+							pInt(14),
+							nil,
+						},
+						Line: pInt(14),
+					},
+				},
+				Parsed: Directives{
+					{
+						Directive: "events",
+						Args:      []string{},
+						Line:      1,
+						Block:     Directives{},
+					},
+					{
+						Directive: "http",
+						Args:      []string{},
+						Line:      3,
+						Block: Directives{
+							{
+								Directive: "map",
+								Args:      []string{"$http_user_agent", "$mobile"},
+								Line:      4,
+								Block: Directives{
+									{
+										Directive: "default",
+										Args:      []string{"0"},
+										Line:      5,
+										Block:     Directives{},
+									},
+									{
+										Directive: "~Opera Mini",
+										Args:      []string{"1"},
+										Line:      6,
+										Block:     Directives{},
+									},
+								},
+							},
+							{
+								Directive: "charset_map",
+								Args:      []string{"koi8-r", "utf-8"},
+								Line:      13,
+								Block:     Directives{},
+							},
+						},
+					},
+				},
+			},
+		},
+	}},
 }
 
 func TestParse(t *testing.T) {

testdata/configs/directive-with-space/nginx.conf

@@ -5,4 +5,9 @@ http {
         default       0;
         '~Opera Mini' 1;
     }
+
+    charset_map koi8-r utf-8 {
+        C0 D18E;
+        C1 D0B0;
+    }
 }

testdata/configs/invalid-map/nginx.conf

@@ -0,0 +1,16 @@
+events {
+}
+http {
+    map $http_user_agent $mobile {
+        default       0;
+        '~Opera Mini' 1;
+        i_am_lost {
+            return 500;
+        }
+        too many params;
+    }
+
+    charset_map koi8-r utf-8 {
+        C0;
+    }
+}