diff --git a/printer/doctype_test.go b/printer/doctype_test.go new file mode 100644 index 0000000..1a339ae --- /dev/null +++ b/printer/doctype_test.go @@ -0,0 +1,41 @@ +package printer + +import ( + "bytes" + "reflect" + "strings" + "testing" + + "golang.org/x/net/html" +) + +func documentTypeAttributes(t *testing.T, text string) []html.Attribute { + t.Helper() + doc, err := html.Parse(strings.NewReader(text)) + if err != nil { + t.Fatal(err) + } + for n := doc.FirstChild; n != nil; n = n.NextSibling { + if n.Type == html.DoctypeNode { + return n.Attr + } + } + t.Fatal("doctype missing") + return nil +} + +func TestPrettyHTMLPreservesDoctypeIdentifiers(t *testing.T) { + for _, source := range []string{ + `

Body

`, + `

Body

`, + `

Body

`, + } { + var output bytes.Buffer + if _, err := PrettyHTML(&output, strings.NewReader(source), false); err != nil { + t.Fatal(err) + } + if !reflect.DeepEqual(documentTypeAttributes(t, source), documentTypeAttributes(t, output.String())) { + t.Fatalf("doctype identifiers lost: %s", output.String()) + } + } +} diff --git a/printer/fragment_detection_test.go b/printer/fragment_detection_test.go new file mode 100644 index 0000000..4c8131d --- /dev/null +++ b/printer/fragment_detection_test.go @@ -0,0 +1,25 @@ +package printer + +import ( + "bytes" + "strings" + "testing" +) + +func TestPrettyHTMLIgnoresTagNamesInCommentsAndRawText(t *testing.T) { + for _, source := range []string{ + `

Fragment

`, + ``, + `Fragment`, + } { + var output bytes.Buffer + if _, err := PrettyHTML(&output, strings.NewReader(source), false); err != nil { + t.Fatal(err) + } + for _, wrapper := range []string{"", "", ""} { + if strings.Contains(output.String(), wrapper) { + t.Fatalf("inserted wrapper %s: %s", wrapper, output.String()) + } + } + } +} diff --git a/printer/html.go b/printer/html.go index 457d870..41fa856 100644 --- a/printer/html.go +++ b/printer/html.go @@ -23,10 +23,26 @@ func PrettyHTML(w io.Writer, r io.Reader, enabled bool) (int64, error) { return 0, err } - contentStr := string(data) - hasHtml := strings.Contains(strings.ToLower(contentStr), "") + var serialized strings.Builder + _ = html.Render(&serialized, n) // strings.Builder cannot fail to write. + return color.Wrap(enabled, color.Bold+color.Magenta, serialized.String()) +} + +func qualifiedAttributeName(attr html.Attribute) string { + if attr.Namespace != "" { + return attr.Namespace + ":" + attr.Key + } + return attr.Key } diff --git a/printer/html_namespace_test.go b/printer/html_namespace_test.go new file mode 100644 index 0000000..e9a3969 --- /dev/null +++ b/printer/html_namespace_test.go @@ -0,0 +1,27 @@ +package printer + +import ( + "bytes" + "golang.org/x/net/html" + "strings" + "testing" +) + +func TestPrettyHTMLPreservesNamespacedAttributes(t *testing.T) { + input := `` + var out bytes.Buffer + if _, err := PrettyHTML(&out, strings.NewReader(input), false); err != nil { + t.Fatal(err) + } + for _, attribute := range []string{`xmlns:xlink="http://www.w3.org/1999/xlink"`, `xlink:href="#shape"`, `xml:lang="en"`} { + if !strings.Contains(out.String(), attribute) { + t.Errorf("missing qualified attribute %s in %s", attribute, out.String()) + } + } +} +func TestRenderVoidTagPreservesAttributeNamespace(t *testing.T) { + node := &html.Node{Type: html.ElementNode, Data: "br", Attr: []html.Attribute{{Namespace: "xml", Key: "lang", Val: "en"}}} + if got := renderVoidTag(node, false); got != `
` { + t.Fatalf("void tag=%q", got) + } +} diff --git a/printer/html_raw_text_test.go b/printer/html_raw_text_test.go new file mode 100644 index 0000000..816f2ba --- /dev/null +++ b/printer/html_raw_text_test.go @@ -0,0 +1,51 @@ +package printer + +import ( + "bytes" + "golang.org/x/net/html" + "strings" + "testing" +) + +func rawTextElements(t *testing.T, input string) []string { + t.Helper() + doc, err := html.Parse(strings.NewReader(input)) + if err != nil { + t.Fatal(err) + } + var values []string + var walk func(*html.Node) + walk = func(n *html.Node) { + if n.Type == html.ElementNode && (n.Data == "script" || n.Data == "style") { + var s strings.Builder + for c := n.FirstChild; c != nil; c = c.NextSibling { + s.WriteString(c.Data) + } + values = append(values, s.String()) + } + for c := n.FirstChild; c != nil; c = c.NextSibling { + walk(c) + } + } + walk(doc) + return values +} +func TestPrettyHTMLPreservesRawText(t *testing.T) { + for _, input := range []string{"", "", `
`} { + t.Run(input, func(t *testing.T) { + var out bytes.Buffer + if _, err := PrettyHTML(&out, strings.NewReader(input), false); err != nil { + t.Fatal(err) + } + want, got := rawTextElements(t, input), rawTextElements(t, out.String()) + if len(want) != len(got) { + t.Fatalf("elements: %v vs %v", got, want) + } + for i := range want { + if got[i] != want[i] { + t.Fatalf("raw text changed: got %q, want %q", got[i], want[i]) + } + } + }) + } +} diff --git a/printer/json.go b/printer/json.go index e73de95..e24fd17 100644 --- a/printer/json.go +++ b/printer/json.go @@ -28,26 +28,31 @@ func getIndent(depth int) []byte { func PrettyJSON(w io.Writer, r io.Reader, enabled bool) (int64, error) { dec := json.NewDecoder(r) dec.UseNumber() - var count int64 - if err := writeJSONValue(w, dec, enabled, 0, &count); err != nil { - return count, err + cw := &countingWriter{w: w} + if err := writeJSONValue(cw, dec, enabled, 0); err != nil { + return cw.count, err } - if _, err := w.Write([]byte("\n")); err != nil { - return count, err + if _, err := dec.Token(); err != io.EOF { + if err != nil { + return cw.count, err + } + return cw.count, fmt.Errorf("unexpected content after JSON value") + } + if _, err := cw.Write([]byte("\n")); err != nil { + return cw.count, err } - count++ - return count, nil + return cw.count, nil } -func writeJSONValue(w io.Writer, dec *json.Decoder, enabled bool, depth int, count *int64) error { +func writeJSONValue(w io.Writer, dec *json.Decoder, enabled bool, depth int) error { tok, err := dec.Token() if err != nil { return err } - return writeJSONToken(w, dec, tok, enabled, depth, count) + return writeJSONToken(w, dec, tok, enabled, depth) } -func writeJSONToken(w io.Writer, dec *json.Decoder, tok json.Token, enabled bool, depth int, count *int64) error { +func writeJSONToken(w io.Writer, dec *json.Decoder, tok json.Token, enabled bool, depth int) error { switch v := tok.(type) { case json.Delim: switch v { @@ -55,21 +60,18 @@ func writeJSONToken(w io.Writer, dec *json.Decoder, tok json.Token, enabled bool if _, err := w.Write([]byte("{\n")); err != nil { return err } - *count += 2 first := true for dec.More() { if !first { if _, err := w.Write([]byte(",\n")); err != nil { return err } - *count += 2 } first = false indent := getIndent(depth + 1) if _, err := w.Write(indent); err != nil { return err } - *count += int64(len(indent)) keyTok, err := dec.Token() if err != nil { return err @@ -79,12 +81,11 @@ func writeJSONToken(w io.Writer, dec *json.Decoder, tok json.Token, enabled bool return fmt.Errorf("invalid json key") } - keyFormatted := color.Key(enabled, `"`+key+`"`) + ": " + keyFormatted := color.Key(enabled, quoteJSONString(key)) + ": " if _, err := io.WriteString(w, keyFormatted); err != nil { return err } - *count += int64(len(key)) - if err := writeJSONValue(w, dec, enabled, depth+1, count); err != nil { + if err := writeJSONValue(w, dec, enabled, depth+1); err != nil { return err } } @@ -95,28 +96,24 @@ func writeJSONToken(w io.Writer, dec *json.Decoder, tok json.Token, enabled bool if _, err := io.WriteString(w, closeStr); err != nil { return err } - *count += int64(len(closeStr)) return nil case '[': if _, err := w.Write([]byte("[\n")); err != nil { return err } - *count += 2 first := true for dec.More() { if !first { if _, err := w.Write([]byte(",\n")); err != nil { return err } - *count += 2 } first = false indent := getIndent(depth + 1) if _, err := w.Write(indent); err != nil { return err } - *count += int64(len(indent)) - if err := writeJSONValue(w, dec, enabled, depth+1, count); err != nil { + if err := writeJSONValue(w, dec, enabled, depth+1); err != nil { return err } } @@ -127,13 +124,12 @@ func writeJSONToken(w io.Writer, dec *json.Decoder, tok json.Token, enabled bool if _, err := io.WriteString(w, closeStr); err != nil { return err } - *count += int64(len(closeStr)) return nil default: return fmt.Errorf("unexpected delimiter %q", v) } case string: - strFormatted := color.String(enabled, `"`+v+`"`) + strFormatted := color.String(enabled, quoteJSONString(v)) if _, err := io.WriteString(w, strFormatted); err != nil { return err } @@ -160,3 +156,9 @@ func writeJSONToken(w io.Writer, dec *json.Decoder, tok json.Token, enabled bool } return nil } + +// Strings decoded from JSON must be escaped again before being printed. +func quoteJSONString(value string) string { + encoded, _ := json.Marshal(value) + return string(encoded) +} diff --git a/printer/json_count_test.go b/printer/json_count_test.go new file mode 100644 index 0000000..af93411 --- /dev/null +++ b/printer/json_count_test.go @@ -0,0 +1,49 @@ +package printer + +import ( + "bytes" + "errors" + "strings" + "testing" +) + +type failingJSONWriter struct { + buffer bytes.Buffer + remaining int + failure error +} + +func (w *failingJSONWriter) Write(p []byte) (int, error) { + if len(p) > w.remaining { + n, _ := w.buffer.Write(p[:w.remaining]) + w.remaining = 0 + return n, w.failure + } + n, _ := w.buffer.Write(p) + w.remaining -= n + return n, nil +} +func TestPrettyJSONReportsActualBytes(t *testing.T) { + t.Setenv("NO_COLOR", "") + for _, enabled := range []bool{false, true} { + var out bytes.Buffer + n, err := PrettyJSON(&out, strings.NewReader(`{"雪":["quoted\"",true,null,42]}`), enabled) + if err != nil { + t.Fatal(err) + } + if n != int64(out.Len()) { + t.Fatalf("color=%v reported %d bytes; wrote %d", enabled, n, out.Len()) + } + } +} +func TestPrettyJSONCountsPartialFailedWrites(t *testing.T) { + failure := errors.New("destination full") + out := &failingJSONWriter{remaining: 7, failure: failure} + n, err := PrettyJSON(out, strings.NewReader(`{"hello":"world"}`), false) + if !errors.Is(err, failure) { + t.Fatalf("error=%v", err) + } + if n != int64(out.buffer.Len()) { + t.Fatalf("reported %d bytes; wrote %d", n, out.buffer.Len()) + } +} diff --git a/printer/json_escape_test.go b/printer/json_escape_test.go new file mode 100644 index 0000000..f12b799 --- /dev/null +++ b/printer/json_escape_test.go @@ -0,0 +1,28 @@ +package printer + +import ( + "bytes" + "encoding/json" + "reflect" + "strings" + "testing" +) + +func TestPrettyJSONEscapesDecodedStrings(t *testing.T) { + for _, input := range []string{`{"a\"b":"line\nnext\t\\end"}`, `["\b\f\r\t","\u0000"]`, `{"雪":"&"}`} { + var out bytes.Buffer + if _, err := PrettyJSON(&out, strings.NewReader(input), false); err != nil { + t.Fatal(err) + } + var want, got interface{} + if err := json.Unmarshal([]byte(input), &want); err != nil { + t.Fatal(err) + } + if err := json.Unmarshal(out.Bytes(), &got); err != nil { + t.Fatalf("formatter produced invalid JSON: %q: %v", out.String(), err) + } + if !reflect.DeepEqual(got, want) { + t.Fatalf("round trip = %#v; want %#v", got, want) + } + } +} diff --git a/printer/json_trailing_test.go b/printer/json_trailing_test.go new file mode 100644 index 0000000..5fc1b3a --- /dev/null +++ b/printer/json_trailing_test.go @@ -0,0 +1,42 @@ +package printer + +import ( + "bytes" + "errors" + "io" + "strings" + "testing" +) + +type jsonTailErrorReader struct { + done bool + failure error +} + +func (r *jsonTailErrorReader) Read(p []byte) (int, error) { + if !r.done { + r.done = true + return copy(p, `{"ok":true}`), nil + } + return 0, r.failure +} +func TestPrettyJSONRejectsTrailingContent(t *testing.T) { + for _, input := range []string{`{} {}`, `[] garbage`, `true false`, `{"a":1}x`} { + var out bytes.Buffer + if _, err := PrettyJSON(&out, strings.NewReader(input), false); err == nil { + t.Fatalf("accepted trailing content: %q", input) + } + } +} +func TestPrettyJSONAcceptsTrailingWhitespace(t *testing.T) { + var out bytes.Buffer + if _, err := PrettyJSON(&out, strings.NewReader("{} \n\r\t"), false); err != nil { + t.Fatal(err) + } +} +func TestPrettyJSONPropagatesTrailingReadError(t *testing.T) { + failure := errors.New("response truncated") + if _, err := PrettyJSON(io.Discard, &jsonTailErrorReader{failure: failure}, false); !errors.Is(err, failure) { + t.Fatalf("error=%v; want %v", err, failure) + } +} diff --git a/printer/media_type_test.go b/printer/media_type_test.go new file mode 100644 index 0000000..bacb1f0 --- /dev/null +++ b/printer/media_type_test.go @@ -0,0 +1,37 @@ +package printer + +import ( + "bytes" + "github.com/kavix/kurl/client" + "io" + "net/http" + "strings" + "testing" +) + +func TestRenderStructuredMediaTypes(t *testing.T) { + for _, tc := range []struct{ media, body, want string }{ + {"application/problem+json", `{"message":"missing"}`, `"message"`}, + {"application/vnd.api+json; charset=utf-8", `{"message":"missing"}`, `"message"`}, + {"application/xhtml+xml", "

hello

", "

hello

"}, + } { + t.Run(tc.media, func(t *testing.T) { + var out bytes.Buffer + r := &client.Result{Response: &http.Response{Header: http.Header{"Content-Type": {tc.media}}, Body: io.NopCloser(strings.NewReader(tc.body))}} + if err := renderBody(&out, r, Options{}); err != nil { + t.Fatal(err) + } + if !strings.Contains(out.String(), tc.want) { + t.Fatalf("body hidden: %q", out.String()) + } + }) + } +} +func TestMediaTypeParametersDoNotSelectFormatter(t *testing.T) { + if isJSON(`text/plain; note="application/json"`, 0) { + t.Fatal("parameter selected JSON formatter") + } + if isHTML(`text/plain; note="text/html"`) { + t.Fatal("parameter selected HTML formatter") + } +} diff --git a/printer/preformatted_test.go b/printer/preformatted_test.go new file mode 100644 index 0000000..c302bd0 --- /dev/null +++ b/printer/preformatted_test.go @@ -0,0 +1,50 @@ +package printer + +import ( + "bytes" + "golang.org/x/net/html" + "strings" + "testing" +) + +func preText(t *testing.T, input string) string { + t.Helper() + doc, err := html.Parse(strings.NewReader(input)) + if err != nil { + t.Fatal(err) + } + var result string + var visit func(*html.Node, bool) + visit = func(n *html.Node, inPre bool) { + inPre = inPre || (n.Type == html.ElementNode && n.Data == "pre") + if inPre && n.Type == html.TextNode { + result += n.Data + } + for c := n.FirstChild; c != nil; c = c.NextSibling { + visit(c, inPre) + } + } + visit(doc, false) + return result +} +func TestPrettyHTMLPreservesPreformattedBlockChildren(t *testing.T) { + input := "
  first\n
  second\n\n third 
  last\n
" + var out bytes.Buffer + if _, err := PrettyHTML(&out, strings.NewReader(input), false); err != nil { + t.Fatal(err) + } + if got, want := preText(t, out.String()), preText(t, input); got != want { + t.Fatalf("pre text changed: got %q want %q", got, want) + } +} + +func TestPrettyHTMLPreservesLeadingPreformattedNewline(t *testing.T) { + input := "
\n\ntext
" + var out bytes.Buffer + if _, err := PrettyHTML(&out, strings.NewReader(input), false); err != nil { + t.Fatal(err) + } + if preText(t, out.String()) != preText(t, input) { + t.Fatalf("leading newline lost: %q", out.String()) + } +} diff --git a/printer/printer.go b/printer/printer.go index 03d41fc..852f83c 100644 --- a/printer/printer.go +++ b/printer/printer.go @@ -4,6 +4,7 @@ import ( "bytes" "fmt" "io" + "mime" "os" "path/filepath" "strings" @@ -257,22 +258,31 @@ func saveBodyToFile(w io.Writer, body io.Reader, outputPath string) error { return err } +func mediaType(contentType string) string { + value, _, err := mime.ParseMediaType(contentType) + if err != nil { + return "" + } + return strings.ToLower(value) +} + func isJSON(contentType string, length int64) bool { - contentType = strings.ToLower(contentType) - return strings.Contains(contentType, "application/json") || strings.Contains(contentType, "+json") + value := mediaType(contentType) + return value == "application/json" || strings.HasSuffix(value, "+json") } func isBinary(contentType string) bool { - contentType = strings.ToLower(contentType) - if contentType == "" { + value := mediaType(contentType) + if value == "" || isJSON(contentType, 0) || isHTML(contentType) || + value == "application/xml" || strings.HasSuffix(value, "+xml") { return false } - return !strings.HasPrefix(contentType, "text/") && !strings.Contains(contentType, "/json") + return !strings.HasPrefix(value, "text/") } func isHTML(contentType string) bool { - contentType = strings.ToLower(contentType) - return strings.Contains(contentType, "text/html") || strings.Contains(contentType, "application/xhtml+xml") + value := mediaType(contentType) + return value == "text/html" || value == "application/xhtml+xml" } // RenderTiming prints the per-phase request timing breakdown. The client diff --git a/printer/xml_response_test.go b/printer/xml_response_test.go new file mode 100644 index 0000000..4cc420a --- /dev/null +++ b/printer/xml_response_test.go @@ -0,0 +1,32 @@ +package printer + +import ( + "bytes" + "io" + "net/http" + "strings" + "testing" + + "github.com/kavix/kurl/client" +) + +func TestRenderXMLMediaTypesAsText(t *testing.T) { + for _, media := range []string{"application/xml", "application/atom+xml; charset=utf-8", "image/svg+xml"} { + t.Run(media, func(t *testing.T) { + body := `hello & goodbye` + result := &client.Result{Response: &http.Response{Header: http.Header{"Content-Type": {media}}, Body: io.NopCloser(strings.NewReader(body))}} + var output bytes.Buffer + if err := renderBody(&output, result, Options{}); err != nil { + t.Fatal(err) + } + if !strings.Contains(output.String(), body) { + t.Fatalf("XML hidden: %s", output.String()) + } + }) + } + for _, media := range []string{"application/pdf", "image/png", "application/octet-stream"} { + if !isBinary(media) { + t.Errorf("binary type %s classified as text", media) + } + } +}