d4911ad6f6
This change adds support for serializing snapshots in MuGL, per the design document in docs/design/mugl.md. At the moment, it is only exposed from the `mu plan` command, which allows you to specify an output location using `mu plan --output=file.json` (or `-o=file.json` for short). This serializes the snapshot with monikers, resources, and so on. Deserialization is not yet supported; that comes next.
88 lines
2.2 KiB
Go
88 lines
2.2 KiB
Go
// Copyright 2016 Marapongo, Inc. All rights reserved.
|
|
|
|
package encoding
|
|
|
|
import (
|
|
"encoding/json"
|
|
"path/filepath"
|
|
|
|
"github.com/ghodss/yaml"
|
|
)
|
|
|
|
var JSONExt = ".json"
|
|
var YAMLExt = ".yaml"
|
|
|
|
// Exts contains a list of all the valid marshalable extension types.
|
|
var Exts = []string{
|
|
JSONExt,
|
|
YAMLExt,
|
|
// Although ".yml" is not a sanctioned YAML extension, it is used quite broadly; so we will support it.
|
|
".yml",
|
|
}
|
|
|
|
// Detect auto-detects a marshaler for the given path.
|
|
func Detect(path string) (Marshaler, string) {
|
|
ext := filepath.Ext(path)
|
|
if ext == "" {
|
|
ext = Exts[0] // default to the first (preferred) marshaler.
|
|
}
|
|
return Marshalers[ext], ext
|
|
}
|
|
|
|
// Marshalers is a map of extension to a Marshaler object for that extension.
|
|
var Marshalers map[string]Marshaler
|
|
|
|
// Marshaler is a type that knows how to marshal and unmarshal data in one format.
|
|
type Marshaler interface {
|
|
IsJSONLike() bool
|
|
IsYAMLLike() bool
|
|
Marshal(v interface{}) ([]byte, error)
|
|
Unmarshal(data []byte, v interface{}) error
|
|
}
|
|
|
|
var JSON Marshaler = &jsonMarshaler{}
|
|
|
|
type jsonMarshaler struct {
|
|
}
|
|
|
|
func (m *jsonMarshaler) IsJSONLike() bool {
|
|
return true
|
|
}
|
|
|
|
func (m *jsonMarshaler) IsYAMLLike() bool {
|
|
return false
|
|
}
|
|
|
|
func (m *jsonMarshaler) Marshal(v interface{}) ([]byte, error) {
|
|
return json.MarshalIndent(v, "", " ")
|
|
}
|
|
|
|
func (m *jsonMarshaler) Unmarshal(data []byte, v interface{}) error {
|
|
// TODO: use a "strict" marshaler, so that we can warn on unrecognized keys (avoiding silly mistakes). We should
|
|
// set aside an officially sanctioned area in the metadata for extensibility by 3rd parties.
|
|
return json.Unmarshal(data, v)
|
|
}
|
|
|
|
var YAML Marshaler = &yamlMarshaler{}
|
|
|
|
type yamlMarshaler struct {
|
|
}
|
|
|
|
func (m *yamlMarshaler) IsJSONLike() bool {
|
|
return false
|
|
}
|
|
|
|
func (m *yamlMarshaler) IsYAMLLike() bool {
|
|
return true
|
|
}
|
|
|
|
func (m *yamlMarshaler) Marshal(v interface{}) ([]byte, error) {
|
|
return yaml.Marshal(v)
|
|
}
|
|
|
|
func (m *yamlMarshaler) Unmarshal(data []byte, v interface{}) error {
|
|
// TODO: use a "strict" marshaler, so that we can warn on unrecognized keys (avoiding silly mistakes). We should
|
|
// set aside an officially sanctioned area in the metadata for extensibility by 3rd parties.
|
|
return yaml.Unmarshal(data, v)
|
|
}
|