File: main.go

package info (click to toggle)
golang-github-rogpeppe-go-internal 1.14.1-1
  • links: PTS, VCS
  • area: main
  • in suites: forky, sid
  • size: 1,188 kB
  • sloc: makefile: 6
file content (232 lines) | stat: -rw-r--r-- 5,258 bytes parent folder | download
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
// Copyright 2018 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 main

import (
	"errors"
	"flag"
	"fmt"
	"io"
	"os"
	"os/exec"
	"path/filepath"
	"strings"
	"sync/atomic"

	"github.com/rogpeppe/go-internal/goproxytest"
	"github.com/rogpeppe/go-internal/gotooltest"
	"github.com/rogpeppe/go-internal/testscript"
)

const (
	// goModProxyDir is the special subdirectory in a txtar script's supporting files
	// within which we expect to find github.com/rogpeppe/go-internal/goproxytest
	// directories.
	goModProxyDir = ".gomodproxy"
)

type envVarsFlag struct {
	vals []string
}

func (e *envVarsFlag) String() string {
	return fmt.Sprintf("%v", e.vals)
}

func (e *envVarsFlag) Set(v string) error {
	e.vals = append(e.vals, v)
	return nil
}

func main() {
	switch err := mainerr(); err {
	case nil:
	default:
		fmt.Fprintln(os.Stderr, err)
		os.Exit(1)
	}
}

func mainerr() (retErr error) {
	flag.Usage = func() {
		mainUsage(os.Stderr)
		os.Exit(2)
	}
	var envVars envVarsFlag
	fUpdate := flag.Bool("u", false, "update archive file if a cmp fails")
	fWork := flag.Bool("work", false, "print temporary work directory and do not remove when done")
	fContinue := flag.Bool("continue", false, "continue running the script if an error occurs")
	fVerbose := flag.Bool("v", false, "run tests verbosely")
	flag.Var(&envVars, "e", "pass through environment variable to script (can appear multiple times)")
	flag.Parse()

	files := flag.Args()
	if len(files) == 0 {
		files = []string{"-"}
	}

	// If we are only reading from stdin, -u cannot be specified. It seems a bit
	// bizarre to invoke testscript with '-' and a regular file, but hey. In
	// that case the -u flag will only apply to the regular file and we assume
	// the user knows it.
	onlyReadFromStdin := true
	for _, f := range files {
		if f != "-" {
			onlyReadFromStdin = false
		}
	}
	if onlyReadFromStdin && *fUpdate {
		return fmt.Errorf("cannot use -u when reading from stdin")
	}
	var stdinTempFile string
	for i, f := range files {
		if f != "-" {
			continue
		}
		if stdinTempFile != "" {
			return fmt.Errorf("cannot read stdin twice")
		}
		data, err := io.ReadAll(os.Stdin)
		if err != nil {
			return fmt.Errorf("error reading stdin: %v", err)
		}
		f, err := os.CreateTemp("", "stdin*.txtar")
		if err != nil {
			return err
		}
		if _, err := f.Write(data); err != nil {
			return err
		}
		if err := f.Close(); err != nil {
			return err
		}
		stdinTempFile = f.Name()
		files[i] = stdinTempFile
		defer os.Remove(stdinTempFile)
	}

	p := testscript.Params{
		Setup:           func(*testscript.Env) error { return nil },
		Files:           files,
		UpdateScripts:   *fUpdate,
		ContinueOnError: *fContinue,
		TestWork:        *fWork,
	}

	if _, err := exec.LookPath("go"); err == nil {
		if err := gotooltest.Setup(&p); err != nil {
			return fmt.Errorf("failed to setup go tool: %v", err)
		}
	}
	origSetup := p.Setup
	p.Setup = func(env *testscript.Env) error {
		if err := origSetup(env); err != nil {
			return err
		}
		if *fWork {
			env.T().Log("temporary work directory: ", env.WorkDir)
		}
		proxyDir := filepath.Join(env.WorkDir, goModProxyDir)
		if info, err := os.Stat(proxyDir); err == nil && info.IsDir() {
			srv, err := goproxytest.NewServer(proxyDir, "")
			if err != nil {
				return fmt.Errorf("cannot start Go proxy: %v", err)
			}
			env.Defer(srv.Close)

			// Add GOPROXY after calling the original setup
			// so that it overrides any GOPROXY set there.
			env.Vars = append(env.Vars,
				"GOPROXY="+srv.URL,
				"GONOSUMDB=*",
			)
		}
		for _, v := range envVars.vals {
			varName, _, ok := strings.Cut(v, "=")
			if !ok {
				v += "=" + os.Getenv(v)
			}
			switch varName {
			case "":
				return fmt.Errorf("invalid variable name %q", varName)
			case "WORK":
				return fmt.Errorf("cannot override WORK variable")
			}
			env.Vars = append(env.Vars, v)
		}
		return nil
	}

	r := &runT{
		verbose:       *fVerbose,
		stdinTempFile: stdinTempFile,
	}
	r.Run("", func(t testscript.T) {
		testscript.RunT(t, p)
	})
	if r.failed.Load() {
		return failedRun
	}
	return nil
}

var (
	failedRun = errors.New("failed run")
	skipRun   = errors.New("skip")
)

// runT implements testscript.T and is used in the call to testscript.Run
type runT struct {
	verbose       bool
	stdinTempFile string
	failed        atomic.Bool
}

func (r *runT) Skip(is ...any) {
	panic(skipRun)
}

func (r *runT) Fatal(is ...any) {
	r.Log(is...)
	r.FailNow()
}

func (r *runT) Parallel() {
	// TODO run tests in parallel.
}

func (r *runT) Log(is ...any) {
	msg := fmt.Sprint(is...)
	if r.stdinTempFile != "" {
		msg = strings.ReplaceAll(msg, r.stdinTempFile, "<stdin>")
	}
	if !strings.HasSuffix(msg, "\n") {
		msg += "\n"
	}
	fmt.Print(msg)
}

func (r *runT) FailNow() {
	panic(failedRun)
}

func (r *runT) Run(name string, f func(t testscript.T)) {
	// TODO: perhaps log the test name when there's more
	// than one test file?
	defer func() {
		switch err := recover(); err {
		case nil, skipRun:
		case failedRun:
			r.failed.Store(true)
		default:
			panic(fmt.Errorf("unexpected panic: %v [%T]", err, err))
		}
	}()
	f(r)
}

func (r *runT) Verbose() bool {
	return r.verbose
}