d41bd9aa5b
Add strict checking for toml keys in blueprints. This allows us to error early if there are unknown keys in a toml blueprint and helps our users by spotting e.g. typos early. This is similar to https://github.com/osbuild/bootc-image-builder/pull/549 (thanks Ondrej!).
70 lines
1.5 KiB
Go
70 lines
1.5 KiB
Go
package blueprintload
|
|
|
|
import (
|
|
"encoding/json"
|
|
"fmt"
|
|
"io"
|
|
"os"
|
|
"path/filepath"
|
|
|
|
"github.com/BurntSushi/toml"
|
|
|
|
"github.com/osbuild/images/pkg/blueprint"
|
|
)
|
|
|
|
// XXX: move this helper into images, share with bib
|
|
func decodeToml(r io.Reader, what string) (*blueprint.Blueprint, error) {
|
|
dec := toml.NewDecoder(r)
|
|
|
|
var conf blueprint.Blueprint
|
|
metadata, err := dec.Decode(&conf)
|
|
if err != nil {
|
|
return nil, fmt.Errorf("cannot decode %q: %w", what, err)
|
|
}
|
|
if len(metadata.Undecoded()) > 0 {
|
|
return nil, fmt.Errorf("cannot decode %q: unknown keys found: %v", what, metadata.Undecoded())
|
|
}
|
|
|
|
return &conf, nil
|
|
}
|
|
|
|
func decodeJson(r io.Reader, what string) (*blueprint.Blueprint, error) {
|
|
dec := json.NewDecoder(r)
|
|
dec.DisallowUnknownFields()
|
|
|
|
var conf blueprint.Blueprint
|
|
if err := dec.Decode(&conf); err != nil {
|
|
return nil, fmt.Errorf("cannot decode %q: %w", what, err)
|
|
}
|
|
if dec.More() {
|
|
return nil, fmt.Errorf("multiple configuration objects or extra data found in %q", what)
|
|
}
|
|
return &conf, nil
|
|
}
|
|
|
|
func Load(path string) (*blueprint.Blueprint, error) {
|
|
var fp io.ReadCloser
|
|
var err error
|
|
|
|
switch path {
|
|
case "":
|
|
return &blueprint.Blueprint{}, nil
|
|
case "-":
|
|
fp = os.Stdin
|
|
default:
|
|
fp, err = os.Open(path)
|
|
if err != nil {
|
|
return nil, err
|
|
}
|
|
defer fp.Close()
|
|
}
|
|
|
|
switch {
|
|
case path == "-", filepath.Ext(path) == ".json":
|
|
return decodeJson(fp, path)
|
|
case filepath.Ext(path) == ".toml":
|
|
return decodeToml(fp, path)
|
|
default:
|
|
return nil, fmt.Errorf("unsupported file extension for %q (please use .toml or .json)", path)
|
|
}
|
|
}
|