pulumi/sdk/go/common/encoding/marshal.go

178 lines
4.5 KiB
Go
Raw Normal View History

// Copyright 2016-2022, Pulumi Corporation.
2018-05-22 19:43:36 +00:00
//
// 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 encoding
import (
"bytes"
"compress/gzip"
"encoding/json"
"fmt"
"io"
"path/filepath"
"github.com/pulumi/pulumi/sdk/v3/go/common/util/yamlutil"
yaml "gopkg.in/yaml.v3"
)
var (
JSONExt = ".json"
YAMLExt = ".yaml"
GZIPExt = ".gz"
)
// 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 = DefaultExt() // 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
// Default returns the default marshaler object.
func Default() Marshaler {
return Marshalers[DefaultExt()]
}
// DefaultExt returns the default extension to use.
func DefaultExt() string {
return Exts[0]
}
// Marshaler is a type that knows how to marshal and unmarshal data in one format.
type Marshaler interface {
Marshal(v interface{}) ([]byte, error)
Unmarshal(data []byte, v interface{}) error
}
// JSON is a Marshaler that marshals and unmarshals JSON with indented printing.
var JSON Marshaler = &jsonMarshaler{}
all: Reformat with gofumpt Per team discussion, switching to gofumpt. [gofumpt][1] is an alternative, stricter alternative to gofmt. It addresses other stylistic concerns that gofmt doesn't yet cover. [1]: https://github.com/mvdan/gofumpt See the full list of [Added rules][2], but it includes: - Dropping empty lines around function bodies - Dropping unnecessary variable grouping when there's only one variable - Ensuring an empty line between multi-line functions - simplification (`-s` in gofmt) is always enabled - Ensuring multi-line function signatures end with `) {` on a separate line. [2]: https://github.com/mvdan/gofumpt#Added-rules gofumpt is stricter, but there's no lock-in. All gofumpt output is valid gofmt output, so if we decide we don't like it, it's easy to switch back without any code changes. gofumpt support is built into the tooling we use for development so this won't change development workflows. - golangci-lint includes a gofumpt check (enabled in this PR) - gopls, the LSP for Go, includes a gofumpt option (see [installation instrutions][3]) [3]: https://github.com/mvdan/gofumpt#installation This change was generated by running: ```bash gofumpt -w $(rg --files -g '*.go' | rg -v testdata | rg -v compilation_error) ``` The following files were manually tweaked afterwards: - pkg/cmd/pulumi/stack_change_secrets_provider.go: one of the lines overflowed and had comments in an inconvenient place - pkg/cmd/pulumi/destroy.go: `var x T = y` where `T` wasn't necessary - pkg/cmd/pulumi/policy_new.go: long line because of error message - pkg/backend/snapshot_test.go: long line trying to assign three variables in the same assignment I have included mention of gofumpt in the CONTRIBUTING.md.
2023-03-03 16:36:39 +00:00
type jsonMarshaler struct{}
func (m *jsonMarshaler) Marshal(v interface{}) ([]byte, error) {
var buf bytes.Buffer
enc := json.NewEncoder(&buf)
enc.SetEscapeHTML(false)
enc.SetIndent("", " ")
err := enc.Encode(v)
if err != nil {
return nil, err
}
return buf.Bytes(), nil
}
func (m *jsonMarshaler) Unmarshal(data []byte, v interface{}) error {
// IDEA: 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{}
all: Reformat with gofumpt Per team discussion, switching to gofumpt. [gofumpt][1] is an alternative, stricter alternative to gofmt. It addresses other stylistic concerns that gofmt doesn't yet cover. [1]: https://github.com/mvdan/gofumpt See the full list of [Added rules][2], but it includes: - Dropping empty lines around function bodies - Dropping unnecessary variable grouping when there's only one variable - Ensuring an empty line between multi-line functions - simplification (`-s` in gofmt) is always enabled - Ensuring multi-line function signatures end with `) {` on a separate line. [2]: https://github.com/mvdan/gofumpt#Added-rules gofumpt is stricter, but there's no lock-in. All gofumpt output is valid gofmt output, so if we decide we don't like it, it's easy to switch back without any code changes. gofumpt support is built into the tooling we use for development so this won't change development workflows. - golangci-lint includes a gofumpt check (enabled in this PR) - gopls, the LSP for Go, includes a gofumpt option (see [installation instrutions][3]) [3]: https://github.com/mvdan/gofumpt#installation This change was generated by running: ```bash gofumpt -w $(rg --files -g '*.go' | rg -v testdata | rg -v compilation_error) ``` The following files were manually tweaked afterwards: - pkg/cmd/pulumi/stack_change_secrets_provider.go: one of the lines overflowed and had comments in an inconvenient place - pkg/cmd/pulumi/destroy.go: `var x T = y` where `T` wasn't necessary - pkg/cmd/pulumi/policy_new.go: long line because of error message - pkg/backend/snapshot_test.go: long line trying to assign three variables in the same assignment I have included mention of gofumpt in the CONTRIBUTING.md.
2023-03-03 16:36:39 +00:00
type yamlMarshaler struct{}
func (m *yamlMarshaler) Marshal(v interface{}) ([]byte, error) {
if r, ok := v.(yamlutil.HasRawValue); ok {
if len(r.RawValue()) > 0 {
// Attempt a comment preserving edit:
return yamlutil.Edit(r.RawValue(), v)
}
}
return yamlutil.YamlEncode(v)
}
func (m *yamlMarshaler) Unmarshal(data []byte, v interface{}) error {
// IDEA: 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.
err := yaml.Unmarshal(data, v)
if err != nil {
// Return type errors directly
if _, ok := err.(*yaml.TypeError); ok {
return err
}
// Other errors will be parse errors due to invalid syntax
return fmt.Errorf("invalid YAML file: %w", err)
}
return nil
}
type gzipMarshaller struct {
inner Marshaler
}
func (m *gzipMarshaller) Marshal(v interface{}) ([]byte, error) {
b, err := m.inner.Marshal(v)
if err != nil {
return nil, err
}
var buf bytes.Buffer
writer := gzip.NewWriter(&buf)
defer writer.Close()
_, err = writer.Write(b)
if err != nil {
return nil, err
}
if err := writer.Close(); err != nil {
return nil, err
}
return buf.Bytes(), nil
}
func (m *gzipMarshaller) Unmarshal(data []byte, v interface{}) error {
buf := bytes.NewBuffer(data)
reader, err := gzip.NewReader(buf)
if err != nil {
return err
}
defer reader.Close()
inflated, err := io.ReadAll(reader)
if err != nil {
return err
}
if err := reader.Close(); err != nil {
return err
}
return m.inner.Unmarshal(inflated, v)
}
// IsCompressed returns if data is zip compressed.
func IsCompressed(buf []byte) bool {
// Taken from compress/gzip/gunzip.go
return len(buf) >= 3 && buf[0] == 31 && buf[1] == 139 && buf[2] == 8
}
func Gzip(m Marshaler) Marshaler {
_, alreadyGZIP := m.(*gzipMarshaller)
if alreadyGZIP {
return m
}
return &gzipMarshaller{m}
}