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

feat(pkg/printer): add yaml and raw printers #133

Merged
merged 4 commits into from
Feb 8, 2019
Merged
Show file tree
Hide file tree
Changes from 1 commit
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Jump to
Jump to file
Failed to load files.
Diff view
Diff view
4 changes: 3 additions & 1 deletion pkg/printer/printer.go
Original file line number Diff line number Diff line change
Expand Up @@ -7,12 +7,14 @@ type Format string
const (
FormatJson Format = "json"
FormatTable Format = "table"
FormatYaml Format = "yaml"
FormatRaw Format = "raw"
)

func ParseFormat(v string) (Format, error) {
format := Format(v)
switch format {
case FormatTable, FormatJson:
case FormatTable, FormatJson, FormatYaml, FormatRaw:
return format, nil
default:
return "", errors.Errorf("invalid format: %s", v)
Expand Down
12 changes: 12 additions & 0 deletions pkg/printer/raw.go
Original file line number Diff line number Diff line change
@@ -0,0 +1,12 @@
package printer

import (
"fmt"
"io"
)

// PrintRaw is a printer that prints the provided value as is
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

So raw is really a dump of the go structure? Let me know if I don't have that right.

What's the use case for this format? json and yaml I see people using that in scripts. If they are chaining the output of this new raw format into a Go program I want to make sure that maybe there isn't an easier way (like making it so that they can use our libraries and functions directly from their code). Or at least making sure that it's a consumable format (e.g. maybe we should be using %#v instead).

Also once we have hammered out the use case, let's pick a name that describes the format more clearly, e.g. "go" or something along those lines.

Copy link
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Updated to change to FormatPlaintext per getporter/helm2-mixin#12 (comment)

func PrintRaw(out io.Writer, v interface{}) error {
fmt.Fprintln(out, v)
return nil
}
24 changes: 24 additions & 0 deletions pkg/printer/raw_test.go
Original file line number Diff line number Diff line change
@@ -0,0 +1,24 @@
package printer

import (
"bytes"
"testing"

"github.com/stretchr/testify/require"
)

func TestPrintRaw(t *testing.T) {
v := struct {
A bool
B string
}{
A: false,
B: "waltz",
}

b := &bytes.Buffer{}
err := PrintRaw(b, v)

require.Nil(t, err)
require.Equal(t, "{false waltz}\n", b.String())
}
20 changes: 20 additions & 0 deletions pkg/printer/yaml.go
Original file line number Diff line number Diff line change
@@ -0,0 +1,20 @@
package printer

import (
"fmt"
"io"

"gopkg.in/yaml.v2"

"github.com/pkg/errors"
)

// PrintYaml is a printer that prints the provided value in yaml
func PrintYaml(out io.Writer, v interface{}) error {
b, err := yaml.Marshal(v)
if err != nil {
return errors.Wrap(err, "could not marshal value to yaml")
}
fmt.Fprintln(out, string(b))
return nil
}
24 changes: 24 additions & 0 deletions pkg/printer/yaml_test.go
Original file line number Diff line number Diff line change
@@ -0,0 +1,24 @@
package printer

import (
"bytes"
"testing"

"github.com/stretchr/testify/require"
)

func TestPrintYaml(t *testing.T) {
v := struct {
A string
B bool
}{
A: "foo",
B: true,
}

b := &bytes.Buffer{}
err := PrintYaml(b, v)

require.Nil(t, err)
require.Equal(t, "a: foo\nb: true\n\n", b.String())
}