mirror of
https://github.com/caddyserver/caddy.git
synced 2024-12-16 21:56:40 -05:00
c8557dc00b
* caddyfile: Introduce basic linting and fmt check This will help encourage people to keep their Caddyfiles tidy. * Remove unrelated tests I am not sure that testing the output of warnings here is quite the right idea; these tests are just for syntax and parsing success.
98 lines
2.9 KiB
Go
98 lines
2.9 KiB
Go
// 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"
|
|
"encoding/json"
|
|
"fmt"
|
|
|
|
"github.com/caddyserver/caddy/v2"
|
|
"github.com/caddyserver/caddy/v2/caddyconfig"
|
|
)
|
|
|
|
// Adapter adapts Caddyfile to Caddy JSON.
|
|
type Adapter struct {
|
|
ServerType ServerType
|
|
}
|
|
|
|
// Adapt converts the Caddyfile config in body to Caddy JSON.
|
|
func (a Adapter) Adapt(body []byte, options map[string]interface{}) ([]byte, []caddyconfig.Warning, error) {
|
|
if a.ServerType == nil {
|
|
return nil, nil, fmt.Errorf("no server type")
|
|
}
|
|
if options == nil {
|
|
options = make(map[string]interface{})
|
|
}
|
|
|
|
filename, _ := options["filename"].(string)
|
|
if filename == "" {
|
|
filename = "Caddyfile"
|
|
}
|
|
|
|
serverBlocks, err := Parse(filename, body)
|
|
if err != nil {
|
|
return nil, nil, err
|
|
}
|
|
|
|
cfg, warnings, err := a.ServerType.Setup(serverBlocks, options)
|
|
if err != nil {
|
|
return nil, warnings, err
|
|
}
|
|
|
|
// lint check: see if input was properly formatted; sometimes messy files files parse
|
|
// successfully but result in logical errors because the Caddyfile is a bad format
|
|
// TODO: also perform this check on imported files
|
|
if !bytes.Equal(Format(body), body) {
|
|
warnings = append(warnings, caddyconfig.Warning{
|
|
File: filename,
|
|
Message: "file is not formatted with 'caddy fmt'",
|
|
})
|
|
}
|
|
|
|
result, err := json.Marshal(cfg)
|
|
|
|
return result, warnings, err
|
|
}
|
|
|
|
// Unmarshaler is a type that can unmarshal
|
|
// Caddyfile tokens to set itself up for a
|
|
// JSON encoding. The goal of an unmarshaler
|
|
// is not to set itself up for actual use,
|
|
// but to set itself up for being marshaled
|
|
// into JSON. Caddyfile-unmarshaled values
|
|
// will not be used directly; they will be
|
|
// encoded as JSON and then used from that.
|
|
// Implementations must be able to support
|
|
// multiple segments (instances of their
|
|
// directive or batch of tokens); typically
|
|
// this means wrapping all token logic in
|
|
// a loop: `for d.Next() { ... }`.
|
|
type Unmarshaler interface {
|
|
UnmarshalCaddyfile(d *Dispenser) error
|
|
}
|
|
|
|
// ServerType is a type that can evaluate a Caddyfile and set up a caddy config.
|
|
type ServerType interface {
|
|
// Setup takes the server blocks which
|
|
// contain tokens, as well as options
|
|
// (e.g. CLI flags) and creates a Caddy
|
|
// config, along with any warnings or
|
|
// an error.
|
|
Setup([]ServerBlock, map[string]interface{}) (*caddy.Config, []caddyconfig.Warning, error)
|
|
}
|
|
|
|
// Interface guard
|
|
var _ caddyconfig.Adapter = (*Adapter)(nil)
|