forked from rsc/script
-
Notifications
You must be signed in to change notification settings - Fork 0
Expand file tree
/
Copy pathscripttest.go
More file actions
240 lines (212 loc) · 6.15 KB
/
scripttest.go
File metadata and controls
240 lines (212 loc) · 6.15 KB
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
237
238
239
240
// Copyright 2022 The Go Authors. All rights reserved.
// Use of this source code is governed by a BSD-style
// license that can be found in the LICENSE file.
// Package scripttest adapts the script engine for use in tests.
package scripttest
import (
"bufio"
"bytes"
"context"
"errors"
"io"
"os"
"os/exec"
"path/filepath"
"runtime"
"strings"
"testing"
"time"
"golang.org/x/tools/txtar"
"rsc.io/script"
)
// DefaultCmds returns a set of broadly useful script commands.
//
// This set includes all of the commands in script.DefaultCmds,
// as well as a "skip" command that halts the script and causes the
// testing.TB passed to Run to be skipped.
func DefaultCmds() map[string]script.Cmd {
cmds := script.DefaultCmds()
cmds["skip"] = Skip()
return cmds
}
// DefaultConds returns a set of broadly useful script conditions.
//
// This set includes all of the conditions in script.DefaultConds,
// as well as:
//
// - Conditions of the form "exec:foo" are active when the executable "foo" is
// found in the test process's PATH, and inactive when the executable is
// not found.
//
// - "short" is active when testing.Short() is true.
//
// - "verbose" is active when testing.Verbose() is true.
func DefaultConds() map[string]script.Cond {
conds := script.DefaultConds()
conds["exec"] = CachedExec()
conds["short"] = script.BoolCondition("testing.Short()", testing.Short())
conds["verbose"] = script.BoolCondition("testing.Verbose()", testing.Verbose())
return conds
}
// Run runs the script from the given filename starting at the given initial state.
// When the script completes, Run closes the state.
func Run(t testing.TB, e *script.Engine, s *script.State, filename string, testScript io.Reader) {
t.Helper()
err := func() (err error) {
log := new(strings.Builder)
log.WriteString("\n") // Start output on a new line for consistent indentation.
// Defer writing to the test log in case the script engine panics during execution,
// but write the log before we write the final "skip" or "FAIL" line.
t.Helper()
defer func() {
t.Helper()
if closeErr := s.CloseAndWait(log); err == nil {
err = closeErr
}
if log.Len() > 0 {
t.Log(strings.TrimSuffix(log.String(), "\n"))
}
}()
if testing.Verbose() {
// Add the environment to the start of the script log.
wait, err := script.Env().Run(s)
if err != nil {
t.Fatal(err)
}
if wait != nil {
stdout, stderr, err := wait(s)
if err != nil {
t.Fatalf("env: %v\n%s", err, stderr)
}
if len(stdout) > 0 {
s.Logf("%s\n", stdout)
}
}
}
return e.Execute(s, filename, bufio.NewReader(testScript), log)
}()
if skip := (skipError{}); errors.As(err, &skip) {
if skip.msg == "" {
t.Skip("SKIP")
} else {
t.Skipf("SKIP: %v", skip.msg)
}
}
if err != nil {
t.Errorf("FAIL: %v", err)
}
}
// Skip returns a sentinel error that causes Run to mark the test as skipped.
func Skip() script.Cmd {
return script.Command(
script.CmdUsage{
Summary: "skip the current test",
Args: "[msg]",
},
func(_ *script.State, args ...string) (script.WaitFunc, error) {
if len(args) > 1 {
return nil, script.ErrUsage
}
if len(args) == 0 {
return nil, skipError{""}
}
return nil, skipError{args[0]}
})
}
type skipError struct {
msg string
}
func (s skipError) Error() string {
if s.msg == "" {
return "skip"
}
return s.msg
}
// CachedExec returns a Condition that reports whether the PATH of the test
// binary itself (not the script's current environment) contains the named
// executable.
func CachedExec() script.Cond {
return script.CachedCondition(
"<suffix> names an executable in the test binary's PATH",
func(name string) (bool, error) {
_, err := exec.LookPath(name)
return err == nil, nil
})
}
func Test(t *testing.T, ctx context.Context, engine *script.Engine, env []string, pattern string) {
gracePeriod := 100 * time.Millisecond
if deadline, ok := t.Deadline(); ok {
timeout := time.Until(deadline)
// If time allows, increase the termination grace period to 5% of the
// remaining time.
if gp := timeout / 20; gp > gracePeriod {
gracePeriod = gp
}
// When we run commands that execute subprocesses, we want to reserve two
// grace periods to clean up. We will send the first termination signal when
// the context expires, then wait one grace period for the process to
// produce whatever useful output it can (such as a stack trace). After the
// first grace period expires, we'll escalate to os.Kill, leaving the second
// grace period for the test function to record its output before the test
// process itself terminates.
timeout -= 2 * gracePeriod
var cancel context.CancelFunc
ctx, cancel = context.WithTimeout(ctx, timeout)
t.Cleanup(cancel)
}
files, _ := filepath.Glob(pattern)
if len(files) == 0 {
t.Fatal("no testdata")
}
for _, file := range files {
file := file
name := strings.TrimSuffix(filepath.Base(file), ".txt")
t.Run(name, func(t *testing.T) {
t.Parallel()
workdir := t.TempDir()
s, err := script.NewState(ctx, workdir, env)
if err != nil {
t.Fatal(err)
}
// Unpack archive.
a, err := txtar.ParseFile(file)
if err != nil {
t.Fatal(err)
}
initScriptDirs(t, s)
if err := s.ExtractFiles(a); err != nil {
t.Fatal(err)
}
t.Log(time.Now().UTC().Format(time.RFC3339))
work, _ := s.LookupEnv("WORK")
t.Logf("$WORK=%s", work)
// Note: Do not use filepath.Base(file) here:
// editors that can jump to file:line references in the output
// will work better seeing the full path relative to cmd/go
// (where the "go test" command is usually run).
Run(t, engine, s, file, bytes.NewReader(a.Comment))
})
}
}
func initScriptDirs(t testing.TB, s *script.State) {
must := func(err error) {
if err != nil {
t.Helper()
t.Fatal(err)
}
}
work := s.Getwd()
must(s.Setenv("WORK", work))
must(os.MkdirAll(filepath.Join(work, "tmp"), 0777))
must(s.Setenv(tempEnvName(), filepath.Join(work, "tmp")))
}
func tempEnvName() string {
switch runtime.GOOS {
case "windows":
return "TMP"
case "plan9":
return "TMPDIR" // actually plan 9 doesn't have one at all but this is fine
default:
return "TMPDIR"
}
}