summaryrefslogtreecommitdiffstats
path: root/runner/run_test.go
blob: d6c150023c979b2774fb26886ed9cb96dc09fa66 (plain) (blame)
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
package runner_test

import (
	"bytes"
	"context"
	"errors"
	"flag"
	"io"
	"reflect"
	"strings"
	"testing"

	"go.sudomsg.com/kit/runner"
)

func TestCommandSet_Run(t *testing.T) {
	t.Run("Dispatch", func(t *testing.T) {
		t.Parallel()

		ctx := t.Context()

		var called bool
		cs := &runner.CommandSet{
			FlagSet: flag.NewFlagSet("test", flag.ContinueOnError),
		}
		cs.SetOutput(io.Discard)

		cs.AddSubcommand("foo", "foo command", func(ctx context.Context, cs *runner.CommandSet, args []string) error {
			called = true
			if !reflect.DeepEqual(args, []string{"bar", "baz"}) {
				t.Fatalf("callback got args %v, want [bar baz]", args)
			}
			if gotName := cs.Name(); gotName != "foo" {
				t.Fatalf("sub FlagSet name = %q, want %q", gotName, "foo")
			}

			return nil
		})

		err := cs.Run(ctx, []string{"foo", "bar", "baz"})
		if err != nil {
			t.Fatalf("unexpected error: %v", err)
		}
		if !called {
			t.Fatal("expected foo subcommand to be called")
		}
	})

	t.Run("Recursive Dispatch", func(t *testing.T) {
		t.Parallel()

		ctx := t.Context()

		var called bool
		cs := &runner.CommandSet{
			FlagSet: flag.NewFlagSet("test", flag.ContinueOnError),
		}
		cs.SetOutput(io.Discard)

		cs.AddSubcommand("foo", "foo command", func(ctx context.Context, cs *runner.CommandSet, args []string) error {
			cs.AddSubcommand("bar", "bar command", func(ctx context.Context, cs *runner.CommandSet, args []string) error {
				called = true
				if !reflect.DeepEqual(args, []string{"baz"}) {
					t.Fatalf("callback got args %v, want [bar baz]", args)
				}
				if gotName := cs.Name(); gotName != "bar" {
					t.Fatalf("sub FlagSet name = %q, want %q", gotName, "foo")
				}
				return nil
			})
			return cs.Run(ctx, args)
		})

		err := cs.Run(ctx, []string{"foo", "bar", "baz"})
		if err != nil {
			t.Fatalf("unexpected error: %v", err)
		}
		if !called {
			t.Fatal("expected foo subcommand to be called")
		}

	})

	t.Run("No Subcommand", func(t *testing.T) {
		t.Parallel()

		ctx := t.Context()
		var buf bytes.Buffer

		cs := &runner.CommandSet{
			FlagSet: flag.NewFlagSet("test", flag.ContinueOnError),
		}
		cs.SetOutput(&buf)

		err := cs.Run(ctx, []string{})
		if err == nil {
			t.Fatal("expected error, got nil")
		}
		var ue runner.UsageError
		if !errors.As(err, &ue) {
			t.Fatalf("expected UsageError, got %T", err)
		}
		if !strings.Contains(buf.String(), "Missing Subcommand") {
			t.Errorf("expected help output to mention missing subcommand, got %q", buf.String())
		}
	})

	t.Run("Invalid Subcommand", func(t *testing.T) {
		t.Parallel()

		ctx := t.Context()
		var buf bytes.Buffer

		cs := &runner.CommandSet{
			FlagSet: flag.NewFlagSet("test", flag.ContinueOnError),
		}
		cs.SetOutput(&buf)

		cs.AddSubcommand("foo", "bar", func(ctx context.Context, cs *runner.CommandSet, args []string) error {
			t.Fatalf("foo command called")
			return nil
		})

		err := cs.Run(ctx, []string{"nope"})
		if err == nil {
			t.Fatal("expected error, got nil")
		}

		var ue runner.UsageError
		if !errors.As(err, &ue) {
			t.Fatalf("expected UsageError, got %T", err)
		}
		if !strings.Contains(buf.String(), "Invalid Subcommand") {
			t.Errorf("expected help output to mention invalid subcommand, got %q", buf.String())
		}
	})

	t.Run("Invalid Flags", func(t *testing.T) {
		t.Parallel()

		ctx := t.Context()
		var buf bytes.Buffer

		cs := &runner.CommandSet{
			FlagSet: flag.NewFlagSet("test", flag.ContinueOnError),
		}
		cs.SetOutput(&buf)

		cs.AddSubcommand("foo", "foo command", func(ctx context.Context, cs *runner.CommandSet, args []string) error {
			return cs.Run(ctx, args)
		})

		err := cs.Run(ctx, []string{"foo", "-bar"})
		if err == nil {
			t.Fatal("expected error, got nil")
		}

		var ue runner.UsageError
		if !errors.As(err, &ue) {
			t.Fatalf("expected UsageError, got %T", err)
		}
	})
}