summaryrefslogtreecommitdiff
path: root/caddyconfig/caddyfile
diff options
context:
space:
mode:
Diffstat (limited to 'caddyconfig/caddyfile')
-rw-r--r--caddyconfig/caddyfile/formatter.go140
-rw-r--r--caddyconfig/caddyfile/formatter_test.go195
-rwxr-xr-xcaddyconfig/caddyfile/parse.go2
-rwxr-xr-xcaddyconfig/caddyfile/parse_test.go4
4 files changed, 338 insertions, 3 deletions
diff --git a/caddyconfig/caddyfile/formatter.go b/caddyconfig/caddyfile/formatter.go
new file mode 100644
index 0000000..e937208
--- /dev/null
+++ b/caddyconfig/caddyfile/formatter.go
@@ -0,0 +1,140 @@
+// Copyright 2015 Matthew Holt and The Caddy Authors
+//
+// Licensed under the Apache License, Version 2.0 (the "License");
+// you may not use this file except in compliance with the License.
+// You may obtain a copy of the License at
+//
+// http://www.apache.org/licenses/LICENSE-2.0
+//
+// Unless required by applicable law or agreed to in writing, software
+// distributed under the License is distributed on an "AS IS" BASIS,
+// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+// See the License for the specific language governing permissions and
+// limitations under the License.
+
+package caddyfile
+
+import (
+ "bytes"
+ "io"
+ "unicode"
+)
+
+// Format formats a Caddyfile to conventional standards.
+func Format(body []byte) []byte {
+ reader := bytes.NewReader(body)
+ result := new(bytes.Buffer)
+
+ var (
+ commented,
+ quoted,
+ escaped,
+ environ,
+ lineBegin bool
+
+ firstIteration = true
+
+ indentation = 0
+
+ prev,
+ curr,
+ next rune
+
+ err error
+ )
+
+ for {
+ prev = curr
+ curr = next
+
+ if curr < 0 {
+ break
+ }
+
+ next, _, err = reader.ReadRune()
+ if err != nil {
+ if err == io.EOF {
+ next = -1
+ } else {
+ panic(err)
+ }
+ }
+
+ if firstIteration {
+ firstIteration = false
+ lineBegin = true
+ continue
+ }
+
+ if quoted {
+ if escaped {
+ escaped = false
+ } else {
+ if curr == '\\' {
+ escaped = true
+ }
+ if curr == '"' {
+ quoted = false
+ }
+ }
+ if curr == '\n' {
+ quoted = false
+ }
+ } else if commented {
+ if curr == '\n' {
+ commented = false
+ }
+ } else {
+ if curr == '"' {
+ quoted = true
+ }
+ if curr == '#' {
+ commented = true
+ }
+ if curr == '}' {
+ if environ {
+ environ = false
+ } else if indentation > 0 {
+ indentation--
+ }
+ }
+ if curr == '{' {
+ if unicode.IsSpace(next) {
+ indentation++
+
+ if !unicode.IsSpace(prev) {
+ result.WriteRune(' ')
+ }
+ } else {
+ environ = true
+ }
+ }
+ if lineBegin {
+ if curr == ' ' || curr == '\t' {
+ continue
+ } else {
+ lineBegin = false
+ if indentation > 0 {
+ for tabs := indentation; tabs > 0; tabs-- {
+ result.WriteRune('\t')
+ }
+ }
+ }
+ } else {
+ if prev == '{' &&
+ (curr == ' ' || curr == '\t') &&
+ (next != '\n' && next != '\r') {
+ curr = '\n'
+ }
+ }
+ }
+
+ if curr == '\n' {
+ lineBegin = true
+ }
+
+ result.WriteRune(curr)
+ }
+
+ return result.Bytes()
+}
diff --git a/caddyconfig/caddyfile/formatter_test.go b/caddyconfig/caddyfile/formatter_test.go
new file mode 100644
index 0000000..76eca00
--- /dev/null
+++ b/caddyconfig/caddyfile/formatter_test.go
@@ -0,0 +1,195 @@
+// Copyright 2015 Matthew Holt and The Caddy Authors
+//
+// Licensed under the Apache License, Version 2.0 (the "License");
+// you may not use this file except in compliance with the License.
+// You may obtain a copy of the License at
+//
+// http://www.apache.org/licenses/LICENSE-2.0
+//
+// Unless required by applicable law or agreed to in writing, software
+// distributed under the License is distributed on an "AS IS" BASIS,
+// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+// See the License for the specific language governing permissions and
+// limitations under the License.
+
+package caddyfile
+
+import (
+ "testing"
+)
+
+func TestFormatBasicIndentation(t *testing.T) {
+ input := []byte(`
+ a
+b
+
+ c {
+ d
+}
+
+e { f
+}
+
+g {
+h {
+i
+}
+}
+
+j { k {
+l
+}
+}
+
+m {
+ n { o
+ }
+}
+`)
+ expected := []byte(`
+a
+b
+
+c {
+ d
+}
+
+e {
+ f
+}
+
+g {
+ h {
+ i
+ }
+}
+
+j {
+ k {
+ l
+ }
+}
+
+m {
+ n {
+ o
+ }
+}
+`)
+ testFormat(t, input, expected)
+}
+
+func TestFormatBasicSpacing(t *testing.T) {
+ input := []byte(`
+a{
+ b
+}
+
+c{ d
+}
+`)
+ expected := []byte(`
+a {
+ b
+}
+
+c {
+ d
+}
+`)
+ testFormat(t, input, expected)
+}
+
+func TestFormatEnvironmentVariable(t *testing.T) {
+ input := []byte(`
+{$A}
+
+b {
+{$C}
+}
+
+d { {$E}
+}
+`)
+ expected := []byte(`
+{$A}
+
+b {
+ {$C}
+}
+
+d {
+ {$E}
+}
+`)
+ testFormat(t, input, expected)
+}
+
+func TestFormatComments(t *testing.T) {
+ input := []byte(`
+# a "\n"
+
+# b {
+ c
+}
+
+d {
+e # f
+# g
+}
+
+h { # i
+}
+`)
+ expected := []byte(`
+# a "\n"
+
+# b {
+c
+}
+
+d {
+ e # f
+ # g
+}
+
+h {
+ # i
+}
+`)
+ testFormat(t, input, expected)
+}
+
+func TestFormatQuotesAndEscapes(t *testing.T) {
+ input := []byte(`
+"a \"b\" #c
+ d
+
+e {
+"f"
+}
+
+g { "h"
+}
+`)
+ expected := []byte(`
+"a \"b\" #c
+d
+
+e {
+ "f"
+}
+
+g {
+ "h"
+}
+`)
+ testFormat(t, input, expected)
+}
+
+func testFormat(t *testing.T, input, expected []byte) {
+ output := Format(input)
+ if string(output) != string(expected) {
+ t.Errorf("Expected:\n%s\ngot:\n%s", string(output), string(expected))
+ }
+}
diff --git a/caddyconfig/caddyfile/parse.go b/caddyconfig/caddyfile/parse.go
index f376033..cdcac26 100755
--- a/caddyconfig/caddyfile/parse.go
+++ b/caddyconfig/caddyfile/parse.go
@@ -64,7 +64,7 @@ func replaceEnvVars(input []byte) ([]byte, error) {
}
// get the value of the environment variable
- envVarValue := []byte(os.Getenv(string(envVarName)))
+ envVarValue := []byte(os.ExpandEnv(os.Getenv(string(envVarName))))
// splice in the value
input = append(input[:begin],
diff --git a/caddyconfig/caddyfile/parse_test.go b/caddyconfig/caddyfile/parse_test.go
index 62a3998..e6d0501 100755
--- a/caddyconfig/caddyfile/parse_test.go
+++ b/caddyconfig/caddyfile/parse_test.go
@@ -256,7 +256,7 @@ func TestRecursiveImport(t *testing.T) {
return false
}
if len(got.Segments[0]) != 1 || len(got.Segments[1]) != 2 {
- t.Errorf("got unexpect tokens: %v", got.Segments)
+ t.Errorf("got unexpected tokens: %v", got.Segments)
return false
}
return true
@@ -351,7 +351,7 @@ func TestDirectiveImport(t *testing.T) {
return false
}
if len(got.Segments[0]) != 1 || len(got.Segments[1]) != 8 {
- t.Errorf("got unexpect tokens: %v", got.Segments)
+ t.Errorf("got unexpected tokens: %v", got.Segments)
return false
}
return true