mirror of
https://github.com/caddyserver/caddy.git
synced 2024-12-16 21:56:40 -05:00
2a127ac3d1
This change is aimed at enhancing the logging module within the Caddyfile directive to allow users to configure logs other than the HTTP access log stream, which is the current capability of the Caddyfile [1]. The intent here is to leverage the same syntax as the server log directive at a global level, so that similar customizations can be added without needing to resort to a JSON-based configuration. Discussion for this approach happened in the referenced issue. Closes https://github.com/caddyserver/caddy/issues/3958 [1] https://caddyserver.com/docs/caddyfile/directives/log
201 lines
3.8 KiB
Go
201 lines
3.8 KiB
Go
package httpcaddyfile
|
|
|
|
import (
|
|
"testing"
|
|
|
|
"github.com/caddyserver/caddy/v2/caddyconfig/caddyfile"
|
|
_ "github.com/caddyserver/caddy/v2/modules/logging"
|
|
)
|
|
|
|
func TestLogDirectiveSyntax(t *testing.T) {
|
|
for i, tc := range []struct {
|
|
input string
|
|
output string
|
|
expectError bool
|
|
}{
|
|
{
|
|
input: `:8080 {
|
|
log
|
|
}
|
|
`,
|
|
output: `{"apps":{"http":{"servers":{"srv0":{"listen":[":8080"],"logs":{}}}}}}`,
|
|
expectError: false,
|
|
},
|
|
{
|
|
input: `:8080 {
|
|
log {
|
|
output file foo.log
|
|
}
|
|
}
|
|
`,
|
|
output: `{"logging":{"logs":{"default":{"exclude":["http.log.access.log0"]},"log0":{"writer":{"filename":"foo.log","output":"file"},"include":["http.log.access.log0"]}}},"apps":{"http":{"servers":{"srv0":{"listen":[":8080"],"logs":{"default_logger_name":"log0"}}}}}}`,
|
|
expectError: false,
|
|
},
|
|
{
|
|
input: `:8080 {
|
|
log {
|
|
format filter {
|
|
wrap console
|
|
fields {
|
|
common_log delete
|
|
request>remote_addr ip_mask {
|
|
ipv4 24
|
|
ipv6 32
|
|
}
|
|
}
|
|
}
|
|
}
|
|
}
|
|
`,
|
|
output: `{"logging":{"logs":{"default":{"exclude":["http.log.access.log0"]},"log0":{"encoder":{"fields":{"common_log":{"filter":"delete"},"request\u003eremote_addr":{"filter":"ip_mask","ipv4_cidr":24,"ipv6_cidr":32}},"format":"filter","wrap":{"format":"console"}},"include":["http.log.access.log0"]}}},"apps":{"http":{"servers":{"srv0":{"listen":[":8080"],"logs":{"default_logger_name":"log0"}}}}}}`,
|
|
expectError: false,
|
|
},
|
|
{
|
|
input: `:8080 {
|
|
log invalid {
|
|
output file foo.log
|
|
}
|
|
}
|
|
`,
|
|
expectError: true,
|
|
},
|
|
} {
|
|
|
|
adapter := caddyfile.Adapter{
|
|
ServerType: ServerType{},
|
|
}
|
|
|
|
out, _, err := adapter.Adapt([]byte(tc.input), nil)
|
|
|
|
if err != nil != tc.expectError {
|
|
t.Errorf("Test %d error expectation failed Expected: %v, got %s", i, tc.expectError, err)
|
|
continue
|
|
}
|
|
|
|
if string(out) != tc.output {
|
|
t.Errorf("Test %d error output mismatch Expected: %s, got %s", i, tc.output, out)
|
|
}
|
|
}
|
|
}
|
|
|
|
func TestRedirDirectiveSyntax(t *testing.T) {
|
|
for i, tc := range []struct {
|
|
input string
|
|
expectError bool
|
|
}{
|
|
{
|
|
input: `:8080 {
|
|
redir :8081
|
|
}`,
|
|
expectError: false,
|
|
},
|
|
{
|
|
input: `:8080 {
|
|
redir * :8081
|
|
}`,
|
|
expectError: false,
|
|
},
|
|
{
|
|
input: `:8080 {
|
|
redir /api/* :8081 300
|
|
}`,
|
|
expectError: false,
|
|
},
|
|
{
|
|
input: `:8080 {
|
|
redir :8081 300
|
|
}`,
|
|
expectError: false,
|
|
},
|
|
{
|
|
input: `:8080 {
|
|
redir /api/* :8081 399
|
|
}`,
|
|
expectError: false,
|
|
},
|
|
{
|
|
input: `:8080 {
|
|
redir :8081 399
|
|
}`,
|
|
expectError: false,
|
|
},
|
|
{
|
|
input: `:8080 {
|
|
redir /old.html /new.html
|
|
}`,
|
|
expectError: false,
|
|
},
|
|
{
|
|
input: `:8080 {
|
|
redir /old.html /new.html temporary
|
|
}`,
|
|
expectError: false,
|
|
},
|
|
{
|
|
input: `:8080 {
|
|
redir https://example.com{uri} permanent
|
|
}`,
|
|
expectError: false,
|
|
},
|
|
{
|
|
input: `:8080 {
|
|
redir /old.html /new.html permanent
|
|
}`,
|
|
expectError: false,
|
|
},
|
|
{
|
|
input: `:8080 {
|
|
redir /old.html /new.html html
|
|
}`,
|
|
expectError: false,
|
|
},
|
|
{
|
|
input: `:8080 {
|
|
redir /old.html /new.html htlm
|
|
}`,
|
|
expectError: true,
|
|
},
|
|
{
|
|
input: `:8080 {
|
|
redir * :8081 200
|
|
}`,
|
|
expectError: true,
|
|
},
|
|
{
|
|
input: `:8080 {
|
|
redir * :8081 400
|
|
}`,
|
|
expectError: true,
|
|
},
|
|
{
|
|
input: `:8080 {
|
|
redir * :8081 temp
|
|
}`,
|
|
expectError: true,
|
|
},
|
|
{
|
|
input: `:8080 {
|
|
redir * :8081 perm
|
|
}`,
|
|
expectError: true,
|
|
},
|
|
{
|
|
input: `:8080 {
|
|
redir * :8081 php
|
|
}`,
|
|
expectError: true,
|
|
},
|
|
} {
|
|
|
|
adapter := caddyfile.Adapter{
|
|
ServerType: ServerType{},
|
|
}
|
|
|
|
_, _, err := adapter.Adapt([]byte(tc.input), nil)
|
|
|
|
if err != nil != tc.expectError {
|
|
t.Errorf("Test %d error expectation failed Expected: %v, got %s", i, tc.expectError, err)
|
|
continue
|
|
}
|
|
}
|
|
}
|