mirror of
https://github.com/coder/coder.git
synced 2026-06-02 20:48:20 +00:00
Zach
81e2be69e9
Use typed atomics (atomic.Int64, atomic.Int32, etc.) in test files to prevent mixing atomic and non-atomic access on the same value, guarantee 64-bit alignment on 32-bit platforms, and provide a cleaner API.
139 lines
2.9 KiB
Go
139 lines
2.9 KiB
Go
package cliui_test
|
|
|
|
import (
|
|
"context"
|
|
"encoding/json"
|
|
"sync/atomic"
|
|
"testing"
|
|
|
|
"github.com/stretchr/testify/require"
|
|
|
|
"github.com/coder/coder/v2/cli/cliui"
|
|
"github.com/coder/serpent"
|
|
)
|
|
|
|
type format struct {
|
|
id string
|
|
attachOptionsFn func(opts *serpent.OptionSet)
|
|
formatFn func(ctx context.Context, data any) (string, error)
|
|
}
|
|
|
|
var _ cliui.OutputFormat = &format{}
|
|
|
|
func (f *format) ID() string {
|
|
return f.id
|
|
}
|
|
|
|
func (f *format) AttachOptions(opts *serpent.OptionSet) {
|
|
if f.attachOptionsFn != nil {
|
|
f.attachOptionsFn(opts)
|
|
}
|
|
}
|
|
|
|
func (f *format) Format(ctx context.Context, data any) (string, error) {
|
|
if f.formatFn != nil {
|
|
return f.formatFn(ctx, data)
|
|
}
|
|
|
|
return "", nil
|
|
}
|
|
|
|
func Test_OutputFormatter(t *testing.T) {
|
|
t.Parallel()
|
|
|
|
t.Run("RequiresTwoFormatters", func(t *testing.T) {
|
|
t.Parallel()
|
|
|
|
require.Panics(t, func() {
|
|
cliui.NewOutputFormatter()
|
|
})
|
|
require.Panics(t, func() {
|
|
cliui.NewOutputFormatter(cliui.JSONFormat())
|
|
})
|
|
require.NotPanics(t, func() {
|
|
cliui.NewOutputFormatter(cliui.JSONFormat(), cliui.TextFormat())
|
|
})
|
|
})
|
|
|
|
t.Run("NoMissingFormatID", func(t *testing.T) {
|
|
t.Parallel()
|
|
|
|
require.Panics(t, func() {
|
|
cliui.NewOutputFormatter(
|
|
cliui.JSONFormat(),
|
|
&format{id: ""},
|
|
)
|
|
})
|
|
})
|
|
|
|
t.Run("NoDuplicateFormats", func(t *testing.T) {
|
|
t.Parallel()
|
|
|
|
require.Panics(t, func() {
|
|
cliui.NewOutputFormatter(
|
|
cliui.JSONFormat(),
|
|
cliui.JSONFormat(),
|
|
)
|
|
})
|
|
})
|
|
|
|
t.Run("OK", func(t *testing.T) {
|
|
t.Parallel()
|
|
|
|
var called atomic.Int64
|
|
f := cliui.NewOutputFormatter(
|
|
cliui.JSONFormat(),
|
|
&format{
|
|
id: "foo",
|
|
attachOptionsFn: func(opts *serpent.OptionSet) {
|
|
opts.Add(serpent.Option{
|
|
Name: "foo",
|
|
Flag: "foo",
|
|
FlagShorthand: "f",
|
|
Value: serpent.DiscardValue,
|
|
Description: "foo flag 1234",
|
|
})
|
|
},
|
|
formatFn: func(_ context.Context, _ any) (string, error) {
|
|
called.Add(1)
|
|
return "foo", nil
|
|
},
|
|
},
|
|
)
|
|
|
|
cmd := &serpent.Command{}
|
|
f.AttachOptions(&cmd.Options)
|
|
|
|
fs := cmd.Options.FlagSet()
|
|
|
|
selected := cmd.Options.ByFlag("output")
|
|
require.NotNil(t, selected)
|
|
require.Equal(t, "json", selected.Value.String())
|
|
usage := fs.FlagUsages()
|
|
require.Contains(t, usage, "Output format.")
|
|
require.Contains(t, usage, "foo flag 1234")
|
|
|
|
ctx := context.Background()
|
|
data := []string{"hi", "dean", "was", "here"}
|
|
out, err := f.Format(ctx, data)
|
|
require.NoError(t, err)
|
|
|
|
var got []string
|
|
require.NoError(t, json.Unmarshal([]byte(out), &got))
|
|
require.Equal(t, data, got)
|
|
require.EqualValues(t, 0, called.Load())
|
|
|
|
require.NoError(t, fs.Set("output", "foo"))
|
|
out, err = f.Format(ctx, data)
|
|
require.NoError(t, err)
|
|
require.Equal(t, "foo", out)
|
|
require.EqualValues(t, 1, called.Load())
|
|
|
|
require.Error(t, fs.Set("output", "bar"))
|
|
out, err = f.Format(ctx, data)
|
|
require.NoError(t, err)
|
|
require.Equal(t, "foo", out)
|
|
require.EqualValues(t, 2, called.Load())
|
|
})
|
|
}
|