-
Notifications
You must be signed in to change notification settings - Fork 1.1k
/
marshal.go
177 lines (151 loc) 路 4.46 KB
/
marshal.go
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
// Copyright 2016-2022, Pulumi Corporation.
//
// 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{}
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{}
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}
}