FilesExpand file tree

main

/

formatter_test.go

Copy path

Blame

More file actions

Blame

More file actions

Latest commit

 

History

History

History

236 lines (203 loc) · 5.47 KB

main

/

formatter_test.go

Copy path

Top

File metadata and controls

• Code
• Blame

236 lines (203 loc) · 5.47 KB

Raw

Copy raw file

Download raw file

Open symbols panel

Edit and raw actions

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

164

165

166

167

168

169

170

171

172

173

174

175

176

177

178

179

180

181

182

183

184

185

186

187

188

189

190

191

192

193

194

195

196

197

198

199

200

201

202

203

204

205

206

207

208

209

210

211

212

213

214

215

216

217

218

219

220

221

222

223

224

225

226

227

228

229

230

231

232

233

234

235

236

package task_test

import (

"bytes"

"path/filepath"

"testing"

"github.com/sebdah/goldie/v2"

"github.com/stretchr/testify/require"

"github.com/go-task/task/v3"

"github.com/go-task/task/v3/experiments"

"github.com/go-task/task/v3/taskfile/ast"

)

type (

// A FormatterTestOption is a function that configures an [FormatterTest].

FormatterTestOption interface {

applyToFormatterTest(*FormatterTest)

}

// A FormatterTest is a test wrapper around a [task.Executor] to make it

// easy to write tests for the task formatter. See [NewFormatterTest] for

// information on creating and running FormatterTests. These tests use

// fixture files to assert whether the result of the output is correct. If

// Task's behavior has been changed, the fixture files can be updated by

// running `task gen:fixtures`.

FormatterTest struct {

TaskTest

task string

vars map[string]any

executorOpts []task.ExecutorOption

listOptions task.ListOptions

wantSetupError bool

wantListError bool

}

)

// NewFormatterTest sets up a new [task.Executor] with the given options and

// runs a task with the given [FormatterTestOption]s. The output of the task is

// written to a set of fixture files depending on the configuration of the test.

func NewFormatterTest(t *testing.T, opts ...FormatterTestOption) {

t.Helper()

tt := &FormatterTest{

task: "default",

vars: map[string]any{},

TaskTest: TaskTest{

experiments: map[*experiments.Experiment]int{},

fixtureTemplateData: map[string]any{},

},

}

// Apply the functional options

for _, opt := range opts {

opt.applyToFormatterTest(tt)

}

// Enable any experiments that have been set

for x, v := range tt.experiments {

prev := *x

*x = experiments.Experiment{

Name: prev.Name,

AllowedValues: []int{v},

Value: v,

}

t.Cleanup(func() {

*x = prev

})

}

tt.run(t)

}

// Functional options

// WithListOptions sets the list options for the formatter.

func WithListOptions(opts task.ListOptions) FormatterTestOption {

return &listOptionsTestOption{opts}

}

type listOptionsTestOption struct {

listOptions task.ListOptions

}

func (opt *listOptionsTestOption) applyToFormatterTest(t *FormatterTest) {

t.listOptions = opt.listOptions

}

// WithListError tells the test to expect an error when running the formatter.

// A fixture will be created with the output of any errors.

func WithListError() FormatterTestOption {

return &listErrorTestOption{}

}

type listErrorTestOption struct{}

func (opt *listErrorTestOption) applyToFormatterTest(t *FormatterTest) {

t.wantListError = true

}

// Helpers

// writeFixtureErrList is a wrapper for writing the output of an error when

// running the formatter to a fixture file.

func (tt *FormatterTest) writeFixtureErrList(

t *testing.T,

g *goldie.Goldie,

err error,

) {

t.Helper()

tt.writeFixture(t, g, "err-list", []byte(err.Error()))

}

// run is the main function for running the test. It sets up the task executor,

// runs the task, and writes the output to a fixture file.

func (tt *FormatterTest) run(t *testing.T) {

t.Helper()

f := func(t *testing.T) {

t.Helper()

var buf bytes.Buffer

opts := append(

tt.executorOpts,

task.WithStdout(&buf),

task.WithStderr(&buf),

)

// Set up the task executor

e := task.NewExecutor(opts...)

// Create a golden fixture file for the output

g := goldie.New(t,

goldie.WithFixtureDir(filepath.Join(e.Dir, "testdata")),

goldie.WithEqualFn(NormalizedEqual),

)

// Call setup and check for errors

if err := e.Setup(); tt.wantSetupError {

require.Error(t, err)

tt.writeFixtureErrSetup(t, g, err)

tt.writeFixtureBuffer(t, g, buf)

return

} else {

require.NoError(t, err)

}

// Create the task call

vars := ast.NewVars()

for key, value := range tt.vars {

vars.Set(key, ast.Var{Value: value})

}

// Run the formatter and check for errors

if _, err := e.ListTasks(tt.listOptions); tt.wantListError {

require.Error(t, err)

tt.writeFixtureErrList(t, g, err)

tt.writeFixtureBuffer(t, g, buf)

return

} else {

require.NoError(t, err)

}

tt.writeFixtureBuffer(t, g, buf)

}

// Run the test (with a name if it has one)

if tt.name != "" {

t.Run(tt.name, f)

} else {

f(t)

}

}

func TestNoLabelInList(t *testing.T) {

t.Parallel()

NewFormatterTest(t,

WithExecutorOptions(

task.WithDir("testdata/label_list"),

),

WithListOptions(task.ListOptions{

ListOnlyTasksWithDescriptions: true,

}),

)

}

// task -al case 1: listAll list all tasks

func TestListAllShowsNoDesc(t *testing.T) {

t.Parallel()

NewFormatterTest(t,

WithExecutorOptions(

task.WithDir("testdata/list_mixed_desc"),

),

WithListOptions(task.ListOptions{

ListAllTasks: true,

}),

)

}

// task -al case 2: !listAll list some tasks (only those with desc)

func TestListCanListDescOnly(t *testing.T) {

t.Parallel()

NewFormatterTest(t,

WithExecutorOptions(

task.WithDir("testdata/list_mixed_desc"),

),

WithListOptions(task.ListOptions{

ListOnlyTasksWithDescriptions: true,

}),

)

}

func TestListDescInterpolation(t *testing.T) {

t.Parallel()

NewFormatterTest(t,

WithExecutorOptions(

task.WithDir("testdata/list_desc_interpolation"),

),

WithListOptions(task.ListOptions{

ListOnlyTasksWithDescriptions: true,

}),

)

}

func TestJsonListFormat(t *testing.T) {

t.Parallel()

NewFormatterTest(t,

WithExecutorOptions(

task.WithDir("testdata/json_list_format"),

),

WithListOptions(task.ListOptions{

FormatTaskListAsJSON: true,

}),

WithFixtureTemplating(),

)

}