Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Fixes invalid JSON in crictl info #1486

Merged
merged 1 commit into from
Jul 11, 2024
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
45 changes: 31 additions & 14 deletions cmd/crictl/util.go
Original file line number Diff line number Diff line change
Expand Up @@ -289,37 +289,54 @@ func outputStatusInfo(status, handlers string, info map[string]string, format st
}
sort.Strings(keys)

jsonInfo := "{" + "\"status\":" + status + ","
infoMap := map[string]any{}

if status != "" {
var statusVal map[string]any
err := json.Unmarshal([]byte(status), &statusVal)
if err != nil {
return err
}
infoMap["status"] = statusVal
}

if handlers != "" {
jsonInfo += "\"runtimeHandlers\":" + handlers + ","
var handlersVal []*any
err := json.Unmarshal([]byte(handlers), &handlersVal)
if err != nil {
return err
}
if handlersVal != nil {
infoMap["runtimeHandlers"] = handlersVal
}
}

for _, k := range keys {
var res interface{}
// We attempt to convert key into JSON if possible else use it directly
if err := json.Unmarshal([]byte(info[k]), &res); err != nil {
jsonInfo += "\"" + k + "\"" + ":" + "\"" + info[k] + "\","
} else {
jsonInfo += "\"" + k + "\"" + ":" + info[k] + ","
}
var genericVal map[string]any
json.Unmarshal([]byte(info[k]), &genericVal)
infoMap[k] = genericVal
}

jsonInfo, err := json.Marshal(infoMap)
if err != nil {
return err
}
jsonInfo = jsonInfo[:len(jsonInfo)-1]
jsonInfo += "}"

switch format {
case "yaml":
yamlInfo, err := yaml.JSONToYAML([]byte(jsonInfo))
yamlInfo, err := yaml.JSONToYAML(jsonInfo)
if err != nil {
return err
}
fmt.Println(string(yamlInfo))
case "json":
var output bytes.Buffer
if err := json.Indent(&output, []byte(jsonInfo), "", " "); err != nil {
if err := json.Indent(&output, jsonInfo, "", " "); err != nil {
return err
}
fmt.Println(output.String())
case "go-template":
output, err := tmplExecuteRawJSON(tmplStr, jsonInfo)
output, err := tmplExecuteRawJSON(tmplStr, string(jsonInfo))
if err != nil {
return err
}
Expand Down
129 changes: 129 additions & 0 deletions cmd/crictl/util_test.go
Original file line number Diff line number Diff line change
Expand Up @@ -17,7 +17,12 @@ limitations under the License.
package main

import (
"io"
"os"
"strings"
"testing"

. "github.com/onsi/gomega"
)

func TestNameFilterByRegex(t *testing.T) {
Expand Down Expand Up @@ -64,7 +69,131 @@ func TestNameFilterByRegex(t *testing.T) {
if r != tc.isMatch {
t.Errorf("expected matched to be %v; actual result is %v", tc.isMatch, r)
}
})
}
}

func TestOutputStatusInfo(t *testing.T) {
const (
statusResponse = `{"conditions":[
{
"message": "no network config found in C:\\Program Files",
"reason": "NetworkPluginNotReady",
"status": false,
"type": "NetworkReady"
}
]}`
handlerResponse = `[
{
"features": {
"recursive_read_only_mounts": true
},
"name": "runc"
},
{
"features": {
"recursive_read_only_mounts": true,
"user_namespaces": true
},
"name": "crun"
}
]`
emptyResponse = ""
)
testCases := []struct {
name string
status string
handlers string
info map[string]string
format string
tmplStr string
expectedOut string
}{
{
name: "YAML format",
status: statusResponse,
handlers: handlerResponse,
info: map[string]string{"key1": `{"foo": "bar"}`, "key2": `{"bar": "baz"}`},
format: "yaml",
tmplStr: "",
expectedOut: "key1:\n foo: bar\nkey2:\n bar: baz\nruntimeHandlers:\n- features:\n recursive_read_only_mounts: true\n name: runc\n- features:\n recursive_read_only_mounts: true\n user_namespaces: true\n name: crun\nstatus:\n conditions:\n - message: no network config found in C:\\Program Files\n reason: NetworkPluginNotReady\n status: false\n type: NetworkReady",
},
{
name: "YAML format with empty status response",
status: emptyResponse,
handlers: handlerResponse,
format: "yaml",
tmplStr: "",
expectedOut: "runtimeHandlers:\n- features:\n recursive_read_only_mounts: true\n name: runc\n- features:\n recursive_read_only_mounts: true\n user_namespaces: true\n name: crun",
},
{
name: "YAML format with empty handlers response",
status: statusResponse,
handlers: emptyResponse,
format: "yaml",
tmplStr: "",
expectedOut: "status:\n conditions:\n - message: no network config found in C:\\Program Files\n reason: NetworkPluginNotReady\n status: false\n type: NetworkReady",
},
{
name: "JSON format",
status: statusResponse,
handlers: handlerResponse,
format: "json",
tmplStr: "",
expectedOut: "{\n \"runtimeHandlers\": [\n {\n \"features\": {\n \"recursive_read_only_mounts\": true\n },\n \"name\": \"runc\"\n },\n {\n \"features\": {\n \"recursive_read_only_mounts\": true,\n \"user_namespaces\": true\n },\n \"name\": \"crun\"\n }\n ],\n \"status\": {\n \"conditions\": [\n {\n \"message\": \"no network config found in C:\\\\Program Files\",\n \"reason\": \"NetworkPluginNotReady\",\n \"status\": false,\n \"type\": \"NetworkReady\"\n }\n ]\n }\n}",
},
{
name: "Go template format",
status: statusResponse,
handlers: handlerResponse,
format: "go-template",
tmplStr: `NetworkReady: {{ (index .status.conditions 0).status }}`,
expectedOut: "NetworkReady: false",
},
}

// Run tests
for _, tc := range testCases {
t.Run(tc.name, func(t *testing.T) {
captureOutput := func(f func() error) (string, error) {
var err error
old := os.Stdout

r, w, _ := os.Pipe()
os.Stdout = w
defer func() {
os.Stdout = old
}()

err = f()
if err != nil {
return "", err
}

err = w.Close()
if err != nil {
return "", err
}

out, err := io.ReadAll(r)
return strings.TrimRight(string(out), "\n"), err
}

outStr, err := captureOutput(func() error {
err := outputStatusInfo(tc.status, tc.handlers, tc.info, tc.format, tc.tmplStr)
if err != nil {
t.Errorf("Unexpected error: %v", err)
}
return nil
})

if err != nil {
Expect(err).To(BeNil())
}

if outStr != tc.expectedOut {
t.Errorf("Expected output:\n%s\nGot:\n%s", tc.expectedOut, outStr)
}
})
}
}
Loading