plugin/template (#1298)

* Add a template plugin The template plugin matches the incoming query by class, type and regex and templates a response with go templates. * Fix go style errors * Fix template README example * Fix corefile example in plugin/template * Clarify plugin/template/README.md Add more details and external links where needed. * Fix code issues in plugin/template * Add template metrics * Add section and template to template plugin metrics * Fix style / remove extra newline on go imports * Fix typo in plugin/template/README.md * Update README.md I've change the format a bit in a PR that I merged yesterday. * Add authority section to plugin/template * Fix naming of incoming query name in plugin/template/README.md * Fix doc syntax in plugin/template/README.md * Add authority section to plugin/template/README.md config overview * Add metric labels to plugin/template/README.md metrics section * Use request.Request to pass state to the template matcher
2018-01-08 11:52:25 +01:00 · 2018-01-08 11:52:25 +01:00 · a322d90f6f
commit a322d90f6f
parent c59f5f6e86
7 changed files with 965 additions and 0 deletions
--- a/plugin/template/setup_test.go
+++ b/plugin/template/setup_test.go
@ -0,0 +1,141 @@
+package template
+
+import (
+	"testing"
+
+	"github.com/mholt/caddy"
+)
+
+func TestSetup(t *testing.T) {
+	c := caddy.NewTestController("dns", `template ANY ANY {
+		rcode
+	}`)
+	err := setupTemplate(c)
+	if err == nil {
+		t.Errorf("Expected setupTemplate to fail on broken template, got no error")
+	}
+	c = caddy.NewTestController("dns", `template ANY ANY {
+		rcode NXDOMAIN
+	}`)
+	err = setupTemplate(c)
+	if err != nil {
+		t.Errorf("Expected no errors, got: %v", err)
+	}
+}
+
+func TestSetupParse(t *testing.T) {
+
+	serverBlockKeys := []string{"domain.com.:8053", "dynamic.domain.com.:8053"}
+
+	tests := []struct {
+		inputFileRules string
+		shouldErr      bool
+	}{
+		// parse errors
+		{`template`, true},
+		{`template X`, true},
+		{`template ANY`, true},
+		{`template ANY X`, true},
+		{`template ANY ANY (?P<x>`, true},
+		{
+			`template ANY ANY {
+
+			}`,
+			true,
+		},
+		{
+			`template ANY ANY .* {
+				notavailable
+			}`,
+			true,
+		},
+		{
+			`template ANY ANY {
+				answer
+			}`,
+			true,
+		},
+		{
+			`template ANY ANY {
+				additional
+			}`,
+			true,
+		},
+		{
+			`template ANY ANY {
+				rcode
+			}`,
+			true,
+		},
+		{
+			`template ANY ANY {
+				rcode UNDEFINED
+			}`,
+			true,
+		},
+		{
+			`template ANY ANY {
+				answer	"{{"
+			}`,
+			true,
+		},
+		{
+			`template ANY ANY {
+				additional "{{"
+			}`,
+			true,
+		},
+		{
+			`template ANY ANY {
+				authority "{{"
+			}`,
+			true,
+		},
+		// examples
+		{
+			`template ANY A ip-(?P<a>[0-9]*)-(?P<b>[0-9]*)-(?P<c>[0-9]*)-(?P<d>[0-9]*)[.]example[.]com {
+				answer "{{ .Name }} A {{ .Group.a }}.{{ .Group.b }}.{{ .Group.c }}.{{ .Grup.d }}."
+			}`,
+			false,
+		},
+		{
+			`template IN ANY "[.](example[.]com[.]dc1[.]example[.]com[.])$" {
+				rcode NXDOMAIN
+				answer "{{ index .Match 1 }} 60 IN SOA a.{{ index .Match 1 }} b.{{ index .Match 1 }} (1 60 60 60 60)"
+			}`,
+			false,
+		},
+		{
+			`template IN A ^ip-10-(?P<b>[0-9]*)-(?P<c>[0-9]*)-(?P<d>[0-9]*)[.]example[.]$ {
+				answer "{{ .Name }} 60 IN A 10.{{ .Group.b }}.{{ .Group.c }}.{{ .Group.d }}"
+			}
+			template IN MX ^ip-10-(?P<b>[0-9]*)-(?P<c>[0-9]*)-(?P<d>[0-9]*)[.]example[.]$ {
+				answer "{{ .Name }} 60 IN MX 10 {{ .Name }}"
+				additional "{{ .Name }} 60 IN A 10.{{ .Group.b }}.{{ .Group.c }}.{{ .Group.d }}"
+			}`,
+			false,
+		},
+		{
+			`template IN MX ^ip-10-(?P<b>[0-9]*)-(?P<c>[0-9]*)-(?P<d>[0-9]*)[.]example[.]$ {
+					answer "{{ .Name }} 60 IN MX 10 {{ .Name }}"
+					additional "{{ .Name }} 60 IN A 10.{{ .Group.b }}.{{ .Group.c }}.{{ .Group.d }}"
+					authority  "example. 60 IN NS ns0.example."
+					authority  "example. 60 IN NS ns1.example."
+					additional "ns0.example. 60 IN A 203.0.113.8"
+					additional "ns1.example. 60 IN A 198.51.100.8"
+				}`,
+			false,
+		},
+	}
+	for i, test := range tests {
+		c := caddy.NewTestController("dns", test.inputFileRules)
+		c.ServerBlockKeys = serverBlockKeys
+		templates, err := templateParse(c)
+
+		if err == nil && test.shouldErr {
+			t.Fatalf("Test %d expected errors, but got no error\n---\n%s\n---\n%v", i, test.inputFileRules, templates)
+		} else if err != nil && !test.shouldErr {
+			t.Fatalf("Test %d expected no errors, but got '%v'", i, err)
+		}
+	}
+}