Add all 16 *_by_lua_block and 9 *_by_lua directives to crossplane

analyze.go

@@ -2588,54 +2588,129 @@ var LuaDirectives = map[string][]uint{
 	"lua_package_cpath": {
 		ngxHTTPMainConf | ngxConfTake1,
 	},
+	"init_by_lua": {
+		ngxHTTPMainConf | ngxConfTake1,
+	},
+	"init_by_lua_block": {
+		ngxHTTPMainConf | ngxConfTake1,
+	},
 	"init_by_lua_file": {
 		ngxHTTPMainConf | ngxConfTake1,
 	},
+	"init_worker_by_lua": {
+		ngxHTTPMainConf | ngxConfTake1,
+	},
+	"init_worker_by_lua_block": {
+		ngxHTTPMainConf | ngxConfTake1,
+	},
 	"init_worker_by_lua_file": {
 		ngxHTTPMainConf | ngxConfTake1,
 	},
+	"exit_worker_by_lua_block": {
+		ngxHTTPMainConf | ngxConfTake1,
+	},
 	"exit_worker_by_lua_file": {
 		ngxHTTPMainConf | ngxConfTake1,
 	},
+	"set_by_lua": {
+		ngxHTTPSrvConf | ngxHTTPSifConf | ngxHTTPLocConf | ngxHTTPLifConf | ngxConf2More,
+	},
+	"set_by_lua_block": {
+		ngxHTTPSrvConf | ngxHTTPSifConf | ngxHTTPLocConf | ngxHTTPLifConf | ngxConfTake2,
+	},
 	"set_by_lua_file": {
 		ngxHTTPSrvConf | ngxHTTPSifConf | ngxHTTPLocConf | ngxHTTPLifConf | ngxConf2More,
 	},
+	"content_by_lua": {
+		ngxHTTPLocConf | ngxHTTPLifConf | ngxConfTake1,
+	},
+	"content_by_lua_block": {
+		ngxHTTPLocConf | ngxHTTPLifConf | ngxConfTake1,
+	},
 	"content_by_lua_file": {
 		ngxHTTPLocConf | ngxHTTPLifConf | ngxConfTake1,
 	},
+	"server_rewrite_by_lua_block": {
+		ngxHTTPMainConf | ngxHTTPSrvConf | ngxConfTake1,
+	},
 	"server_rewrite_by_lua_file": {
 		ngxHTTPMainConf | ngxHTTPSrvConf | ngxConfTake1,
 	},
+	"rewrite_by_lua": {
+		ngxHTTPMainConf | ngxHTTPSrvConf | ngxHTTPLocConf | ngxHTTPLifConf | ngxConfTake1,
+	},
+	"rewrite_by_lua_block": {
+		ngxHTTPMainConf | ngxHTTPSrvConf | ngxHTTPLocConf | ngxHTTPLifConf | ngxConfTake1,
+	},
 	"rewrite_by_lua_file": {
 		ngxHTTPMainConf | ngxHTTPSrvConf | ngxHTTPLocConf | ngxHTTPLifConf | ngxConfTake1,
 	},
+	"access_by_lua": {
+		ngxHTTPMainConf | ngxHTTPSrvConf | ngxHTTPLocConf | ngxHTTPLifConf | ngxConfTake1,
+	},
+	"access_by_lua_block": {
+		ngxHTTPMainConf | ngxHTTPSrvConf | ngxHTTPLocConf | ngxHTTPLifConf | ngxConfTake1,
+	},
 	"access_by_lua_file": {
 		ngxHTTPMainConf | ngxHTTPSrvConf | ngxHTTPLocConf | ngxHTTPLifConf | ngxConfTake1,
 	},
+	"header_filter_by_lua": {
+		ngxHTTPMainConf | ngxHTTPSrvConf | ngxHTTPLocConf | ngxHTTPLifConf | ngxConfTake1,
+	},
+	"header_filter_by_lua_block": {
+		ngxHTTPMainConf | ngxHTTPSrvConf | ngxHTTPLocConf | ngxHTTPLifConf | ngxConfTake1,
+	},
 	"header_filter_by_lua_file": {
 		ngxHTTPMainConf | ngxHTTPSrvConf | ngxHTTPLocConf | ngxHTTPLifConf | ngxConfTake1,
 	},
+	"body_filter_by_lua": {
+		ngxHTTPMainConf | ngxHTTPSrvConf | ngxHTTPLocConf | ngxHTTPLifConf | ngxConfTake1,
+	},
+	"body_filter_by_lua_block": {
+		ngxHTTPMainConf | ngxHTTPSrvConf | ngxHTTPLocConf | ngxHTTPLifConf | ngxConfTake1,
+	},
 	"body_filter_by_lua_file": {
 		ngxHTTPMainConf | ngxHTTPSrvConf | ngxHTTPLocConf | ngxHTTPLifConf | ngxConfTake1,
 	},
+	"log_by_lua": {
+		ngxHTTPMainConf | ngxHTTPSrvConf | ngxHTTPLocConf | ngxHTTPLifConf | ngxConfTake1,
+	},
+	"log_by_lua_block": {
+		ngxHTTPMainConf | ngxHTTPSrvConf | ngxHTTPLocConf | ngxHTTPLifConf | ngxConfTake1,
+	},
 	"log_by_lua_file": {
 		ngxHTTPMainConf | ngxHTTPSrvConf | ngxHTTPLocConf | ngxHTTPLifConf | ngxConfTake1,
 	},
+	"balancer_by_lua_block": {
+		ngxHTTPUpsConf | ngxConfTake1,
+	},
 	"balancer_by_lua_file": {
 		ngxHTTPUpsConf | ngxConfTake1,
 	},
 	"lua_need_request_body": {
 		ngxHTTPMainConf | ngxHTTPSrvConf | ngxHTTPLocConf | ngxHTTPLifConf | ngxConfFlag,
 	},
+	"ssl_client_hello_by_lua_block": {
+		ngxHTTPMainConf | ngxHTTPSrvConf | ngxConfTake1,
+	},
 	"ssl_client_hello_by_lua_file": {
 		ngxHTTPMainConf | ngxHTTPSrvConf | ngxConfTake1,
 	},
+	"ssl_certificate_by_lua_block": {
+		ngxHTTPMainConf | ngxHTTPSrvConf | ngxConfTake1,
+	},
 	"ssl_certificate_by_lua_file": {
 		ngxHTTPMainConf | ngxHTTPSrvConf | ngxConfTake1,
 	},
+	"ssl_session_fetch_by_lua_block": {
+		ngxHTTPMainConf | ngxConfTake1,
+	},
 	"ssl_session_fetch_by_lua_file": {
 		ngxHTTPMainConf | ngxConfTake1,
 	},
+	"ssl_session_store_by_lua_block": {
+		ngxHTTPMainConf | ngxConfTake1,
+	},
 	"ssl_session_store_by_lua_file": {
 		ngxHTTPMainConf | ngxConfTake1,
 	},

analyze_test.go

@@ -1984,13 +1984,13 @@ func TestAnalyze_lua(t *testing.T) {
 			blockCtx{"http", "location", "location if"},
 			false,
 		},
-		"content_by_lua_file nor ok": {
+		"content_by_lua_file not ok": {
 			&Directive{
 				Directive: "content_by_lua_file",
 				Args:      []string{"foo/bar.lua"},
 				Line:      5,
 			},
-			blockCtx{"server"},
+			blockCtx{"http", "location"},
 			false,
 		},
 		"lua_shared_dict ok": {
@@ -2029,6 +2029,78 @@ func TestAnalyze_lua(t *testing.T) {
 			blockCtx{"http"},
 			true,
 		},
+		"set_by_lua ok": {
+			&Directive{
+				Directive: "set_by_lua",
+				Args:      []string{"$res", "' return 32 + math.cos(32) '"},
+				Line:      5,
+			},
+			blockCtx{"http", "server"},
+			false,
+		},
+		"set_by_lua not ok no return value": {
+			&Directive{
+				Directive: "set_by_lua",
+				Args:      []string{"' return 32 + math.cos(32) '"},
+				Line:      5,
+			},
+			blockCtx{"http", "server"},
+			true,
+		},
+		"set_by_lua_block ok": {
+			&Directive{
+				Directive: "set_by_lua_block",
+				Args:      []string{"$res", "return tonumber(ngx.var.foo) + 1"},
+				Line:      5,
+			},
+			blockCtx{"http", "server"},
+			false,
+		},
+		"set_by_lua_block not ok no return value": {
+			&Directive{
+				Directive: "set_by_lua_block",
+				Args:      []string{"return tonumber(ngx.var.foo) + 1"},
+				Line:      5,
+			},
+			blockCtx{"http", "server"},
+			true,
+		},
+		"content_by_lua ok": {
+			&Directive{
+				Directive: "content_by_lua",
+				Args:      []string{"'ngx.say('I need no extra escaping here, for example: \r\nblah')'"},
+				Line:      5,
+			},
+			blockCtx{"http", "location"},
+			false,
+		},
+		"content_by_lua not ok stream": {
+			&Directive{
+				Directive: "content_by_lua",
+				Args:      []string{"'ngx.say('I need no extra escaping here, for example: \r\nblah')'"},
+				Line:      5,
+			},
+			blockCtx{"stream"},
+			true,
+		},
+		"content_by_lua_block ok": {
+			&Directive{
+				Directive: "content_by_lua_block",
+				Args:      []string{"ngx.say('I need no extra escaping here, for example: \r\nblah')"},
+				Line:      5,
+			},
+			blockCtx{"http", "location", "if"},
+			false,
+		},
+		"content_by_lua_block not ok extra argument": {
+			&Directive{
+				Directive: "content_by_lua_block",
+				Args:      []string{"1", "ngx.say('I need no extra escaping here, for example: \r\nblah')"},
+				Line:      5,
+			},
+			blockCtx{"http", "location", "if"},
+			true,
+		},
 	}
 
 	for name, tc := range testcases {
@@ -2037,6 +2109,9 @@ func TestAnalyze_lua(t *testing.T) {
 			t.Parallel()
 			err := analyze("nginx.conf", tc.stmt, ";", tc.ctx, &ParseOptions{
 				MatchFuncs: []MatchFunc{MatchLua},
+				LexOptions: LexOptions{
+					Lexers: []RegisterLexer{lua.RegisterLexer()},
+				},
 			})
 
 			if !tc.wantErr && err != nil {

build.go

@@ -18,9 +18,46 @@ import (
 )
 
 type BuildOptions struct {
-	Indent int
-	Tabs   bool
-	Header bool
+	Indent      int
+	Tabs        bool
+	Header      bool
+	Builders    []RegisterBuilder // handle specific directives
+	extBuilders map[string]Builder
+}
+
+// RegisterBuilder is an option that can be used to add a builder to build NGINX configuration for custom directives.
+type RegisterBuilder interface {
+	applyBuildOptions(options *BuildOptions)
+}
+
+type registerBuilder struct {
+	b          Builder
+	directives []string
+}
+
+func (rb registerBuilder) applyBuildOptions(o *BuildOptions) {
+	if o.extBuilders == nil {
+		o.extBuilders = make(map[string]Builder)
+	}
+
+	for _, s := range rb.directives {
+		o.extBuilders[s] = rb.b
+	}
+}
+
+// BuildWithBuilder registers a builder to build the NGINX configuration for the given directives.
+func BuildWithBuilder(b Builder, directives ...string) RegisterBuilder { //nolint:ireturn
+	return registerBuilder{b: b, directives: directives}
+}
+
+// Builder is the interface implemented by types that can render a Directive
+// as it appears in NGINX configuration files.
+//
+// Build writes the strings that represent the Directive and it's Block to the
+// io.StringWriter returning any error encountered that caused the write to stop
+// early. Build must not modify the Directive.
+type Builder interface {
+	Build(stmt *Directive) string
 }
 
 const MaxIndent = 100
@@ -48,6 +85,10 @@ func BuildFiles(payload Payload, dir string, options *BuildOptions) error {
 		dir = cwd
 	}
 
+	for _, o := range options.Builders {
+		o.applyBuildOptions(options)
+	}
+
 	for _, config := range payload.Config {
 		path := config.File
 		if !filepath.IsAbs(path) {
@@ -96,6 +137,12 @@ func Build(w io.Writer, config Config, options *BuildOptions) error {
 		}
 	}
 
+	if options.extBuilders == nil { // might be set if using BuildFiles
+		for _, o := range options.Builders {
+			o.applyBuildOptions(options)
+		}
+	}
+
 	body := strings.Builder{}
 	buildBlock(&body, nil, config.Parsed, 0, 0, options)
 
@@ -110,6 +157,7 @@ func Build(w io.Writer, config Config, options *BuildOptions) error {
 
 func buildBlock(sb io.StringWriter, parent *Directive, block Directives, depth int, lastLine int, options *BuildOptions) {
 	for i, stmt := range block {
+		directive := Enquote(stmt.Directive)
 		// if the this statement is a comment on the same line as the preview, do not emit EOL for this stmt
 		if stmt.Line == lastLine && stmt.IsComment() {
 			_, _ = sb.WriteString(" #")
@@ -127,8 +175,11 @@ func buildBlock(sb io.StringWriter, parent *Directive, block Directives, depth i
 		if stmt.IsComment() {
 			_, _ = sb.WriteString("#")
 			_, _ = sb.WriteString(*stmt.Comment)
+		} else if options.extBuilders != nil {
+			if ext, ok := options.extBuilders[directive]; ok {
+				_, _ = sb.WriteString(ext.Build(stmt))
+			}
 		} else {
-			directive := Enquote(stmt.Directive)
 			_, _ = sb.WriteString(directive)
 
 			// special handling for if statements
@@ -159,9 +210,11 @@ func buildBlock(sb io.StringWriter, parent *Directive, block Directives, depth i
 				_, _ = sb.WriteString("}")
 			}
 		}
+
 		lastLine = stmt.Line
 	}
 }
+
 func margin(options *BuildOptions, depth int) string {
 	indent := depth * options.Indent
 	if indent < MaxIndent {

build_test.go

@@ -258,6 +258,44 @@ var buildFixtures = []buildFixture{
 		},
 		expected: "#comment1\nuser root; #comment2 #comment3",
 	},
+	{
+		name:    "lua block",
+		options: BuildOptions{Builders: []RegisterBuilder{lua.RegisterBuilder()}},
+		parsed: Directives{
+			{
+				Directive: "content_by_lua_block",
+				Line:      1,
+				Args:      []string{"\n                ngx.say(\"I need no extra escaping here, for example: \\r\\nblah\")\n            "},
+			},
+		},
+
+		expected: "content_by_lua_block {\n                ngx.say(\"I need no extra escaping here, for example: \\r\\nblah\")\n            }",
+	},
+	{
+		name:    "set_by_lua_block",
+		options: BuildOptions{Builders: []RegisterBuilder{lua.RegisterBuilder()}},
+		parsed: Directives{
+			{
+				Directive: "set_by_lua_block",
+				Line:      1,
+				Args: []string{"$res", " -- irregular lua block directive" +
+					"\n            local a = 32" +
+					"\n            local b = 56" +
+					"\n" +
+					"\n            ngx.var.diff = a - b;  -- write to $diff directly" +
+					"\n            return a + b;          -- return the $sum value normally" +
+					"\n        "},
+			},
+		},
+
+		expected: "set_by_lua_block $res { -- irregular lua block directive" +
+			"\n            local a = 32" +
+			"\n            local b = 56" +
+			"\n" +
+			"\n            ngx.var.diff = a - b;  -- write to $diff directly" +
+			"\n            return a + b;          -- return the $sum value normally" +
+			"\n        }",
+	},
 }
 
 func TestBuild(t *testing.T) {