-
-
Notifications
You must be signed in to change notification settings - Fork 109
/
printing.go
328 lines (282 loc) · 7.9 KB
/
printing.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
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
// Copyright © 2023 Ory Corp
// SPDX-License-Identifier: Apache-2.0
package cmdx
import (
"encoding/json"
"errors"
"fmt"
"io"
"os"
"strings"
"text/tabwriter"
"github.com/go-openapi/jsonpointer"
"github.com/goccy/go-yaml"
"github.com/spf13/cobra"
"github.com/spf13/pflag"
"github.com/tidwall/gjson"
)
type (
TableHeader interface {
Header() []string
}
TableRow interface {
TableHeader
Columns() []string
Interface() interface{}
}
Table interface {
TableHeader
Table() [][]string
Interface() interface{}
Len() int
}
Nil struct{}
format string
)
const (
FormatQuiet format = "quiet"
FormatTable format = "table"
FormatJSON format = "json"
FormatJSONPath format = "jsonpath"
FormatJSONPointer format = "jsonpointer"
FormatJSONPretty format = "json-pretty"
FormatYAML format = "yaml"
FormatDefault format = "default"
FlagFormat = "format"
None = "<none>"
)
func (Nil) String() string {
return "null"
}
func (Nil) Interface() interface{} {
return nil
}
func PrintErrors(cmd *cobra.Command, errs map[string]error) {
for src, err := range errs {
_, _ = fmt.Fprintf(cmd.ErrOrStderr(), "%s: %s\n", src, err.Error())
}
}
func PrintRow(cmd *cobra.Command, row TableRow) {
f := getFormat(cmd)
switch f {
case FormatQuiet:
if idAble, ok := row.(interface{ ID() string }); ok {
_, _ = fmt.Fprintln(cmd.OutOrStdout(), idAble.ID())
break
}
_, _ = fmt.Fprintln(cmd.OutOrStdout(), row.Columns()[0])
case FormatJSON:
printJSON(cmd.OutOrStdout(), row.Interface(), false, "")
case FormatYAML:
printYAML(cmd.OutOrStdout(), row.Interface())
case FormatJSONPretty:
printJSON(cmd.OutOrStdout(), row.Interface(), true, "")
case FormatJSONPath:
printJSON(cmd.OutOrStdout(), row.Interface(), true, getPath(cmd))
case FormatJSONPointer:
printJSON(cmd.OutOrStdout(), filterJSONPointer(cmd, row.Interface()), true, "")
case FormatTable, FormatDefault:
w := tabwriter.NewWriter(cmd.OutOrStdout(), 0, 8, 1, '\t', 0)
fields := row.Columns()
for i, h := range row.Header() {
_, _ = fmt.Fprintf(w, "%s\t%s\t\n", h, fields[i])
}
_ = w.Flush()
}
}
func filterJSONPointer(cmd *cobra.Command, data any) any {
f, err := cmd.Flags().GetString(FlagFormat)
// unexpected error
Must(err, "flag access error: %s", err)
_, jsonptr, found := strings.Cut(f, "=")
if !found {
_, _ = fmt.Fprintf(os.Stderr,
"Format %s is missing a JSON pointer, e.g., --%s=%s=<jsonpointer>. The path syntax is described at https://datatracker.ietf.org/doc/html/draft-ietf-appsawg-json-pointer-07.",
f, FlagFormat, f)
os.Exit(1)
}
ptr, err := jsonpointer.New(jsonptr)
Must(err, "invalid JSON pointer: %s", err)
result, _, err := ptr.Get(data)
Must(err, "failed to apply JSON pointer: %s", err)
return result
}
func PrintTable(cmd *cobra.Command, table Table) {
f := getFormat(cmd)
switch f {
case FormatQuiet:
if table.Len() == 0 {
fmt.Fprintln(cmd.OutOrStdout())
}
if idAble, ok := table.(interface{ IDs() []string }); ok {
for _, row := range idAble.IDs() {
fmt.Fprintln(cmd.OutOrStdout(), row)
}
break
}
for _, row := range table.Table() {
fmt.Fprintln(cmd.OutOrStdout(), row[0])
}
case FormatJSON:
printJSON(cmd.OutOrStdout(), table.Interface(), false, "")
case FormatJSONPretty:
printJSON(cmd.OutOrStdout(), table.Interface(), true, "")
case FormatJSONPath:
printJSON(cmd.OutOrStdout(), table.Interface(), true, getPath(cmd))
case FormatJSONPointer:
printJSON(cmd.OutOrStdout(), filterJSONPointer(cmd, table.Interface()), true, "")
case FormatYAML:
printYAML(cmd.OutOrStdout(), table.Interface())
default:
w := tabwriter.NewWriter(cmd.OutOrStdout(), 0, 8, 1, '\t', 0)
for _, h := range table.Header() {
fmt.Fprintf(w, "%s\t", h)
}
fmt.Fprintln(w)
for _, row := range table.Table() {
fmt.Fprintln(w, strings.Join(row, "\t")+"\t")
}
_ = w.Flush()
}
}
type interfacer interface{ Interface() interface{} }
func PrintJSONAble(cmd *cobra.Command, d interface{ String() string }) {
var path string
if d == nil {
d = Nil{}
}
switch getFormat(cmd) {
default:
_, _ = fmt.Fprint(cmd.OutOrStdout(), d.String())
case FormatJSON:
var v interface{} = d
if i, ok := d.(interfacer); ok {
v = i
}
printJSON(cmd.OutOrStdout(), v, false, "")
case FormatJSONPath:
path = getPath(cmd)
fallthrough
case FormatJSONPretty:
var v interface{} = d
if i, ok := d.(interfacer); ok {
v = i
}
printJSON(cmd.OutOrStdout(), v, true, path)
case FormatJSONPointer:
var v interface{} = d
if i, ok := d.(interfacer); ok {
v = i
}
printJSON(cmd.OutOrStdout(), filterJSONPointer(cmd, v), true, "")
case FormatYAML:
var v interface{} = d
if i, ok := d.(interfacer); ok {
v = i
}
printYAML(cmd.OutOrStdout(), v)
}
}
func getQuiet(cmd *cobra.Command) bool {
q, err := cmd.Flags().GetBool(FlagQuiet)
// ignore the error here as we use this function also when the flag might not be registered
if err != nil {
return false
}
return q
}
func getFormat(cmd *cobra.Command) format {
q := getQuiet(cmd)
if q {
return FormatQuiet
}
f, err := cmd.Flags().GetString(FlagFormat)
// unexpected error
Must(err, "flag access error: %s", err)
switch {
case f == string(FormatTable):
return FormatTable
case f == string(FormatJSON):
return FormatJSON
case strings.HasPrefix(f, string(FormatJSONPath)):
return FormatJSONPath
case strings.HasPrefix(f, string(FormatJSONPointer)):
return FormatJSONPointer
case f == string(FormatJSONPretty):
return FormatJSONPretty
case f == string(FormatYAML):
return FormatYAML
default:
return FormatDefault
}
}
func getPath(cmd *cobra.Command) string {
f, err := cmd.Flags().GetString(FlagFormat)
// unexpected error
Must(err, "flag access error: %s", err)
_, path, found := strings.Cut(f, "=")
if !found {
_, _ = fmt.Fprintf(os.Stderr,
"Format %s is missing a path, e.g., --%s=%s=<path>. The path syntax is described at https://github.com/tidwall/gjson/blob/master/SYNTAX.md",
f, FlagFormat, f)
os.Exit(1)
}
return path
}
func printJSON(w io.Writer, v interface{}, pretty bool, path string) {
if path != "" {
temp, err := json.Marshal(v)
Must(err, "Error encoding JSON: %s", err)
v = gjson.GetBytes(temp, path).Value()
}
e := json.NewEncoder(w)
if pretty {
e.SetIndent("", " ")
}
err := e.Encode(v)
// unexpected error
Must(err, "Error encoding JSON: %s", err)
}
func printYAML(w io.Writer, v interface{}) {
j, err := json.Marshal(v)
Must(err, "Error encoding JSON: %s", err)
e, err := yaml.JSONToYAML(j)
Must(err, "Error encoding YAML: %s", err)
_, _ = w.Write(e)
}
func RegisterJSONFormatFlags(flags *pflag.FlagSet) {
flags.String(FlagFormat, string(FormatDefault), fmt.Sprintf("Set the output format. One of %s, %s, %s, %s, %s and %s.", FormatDefault, FormatJSON, FormatYAML, FormatJSONPretty, FormatJSONPath, FormatJSONPointer))
}
func RegisterFormatFlags(flags *pflag.FlagSet) {
RegisterNoiseFlags(flags)
flags.String(FlagFormat, string(FormatDefault), fmt.Sprintf("Set the output format. One of %s, %s, %s, %s, %s and %s.", FormatTable, FormatJSON, FormatYAML, FormatJSONPretty, FormatJSONPath, FormatJSONPointer))
}
type bodyer interface {
Body() []byte
}
func PrintOpenAPIError(cmd *cobra.Command, err error) error {
if err == nil {
return nil
}
var be bodyer
if !errors.As(err, &be) {
return err
}
var didPrettyPrint bool
if message := gjson.GetBytes(be.Body(), "error.message"); message.Exists() {
_, _ = fmt.Fprintf(cmd.ErrOrStderr(), "%s\n", message.String())
didPrettyPrint = true
}
if reason := gjson.GetBytes(be.Body(), "error.reason"); reason.Exists() {
_, _ = fmt.Fprintf(cmd.ErrOrStderr(), "%s\n", reason.String())
didPrettyPrint = true
}
if didPrettyPrint {
return FailSilently(cmd)
}
if body, err := json.MarshalIndent(json.RawMessage(be.Body()), "", " "); err == nil {
_, _ = fmt.Fprintf(cmd.ErrOrStderr(), "%s\nFailed to execute API request, see error above.\n", body)
return FailSilently(cmd)
}
return err
}