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 2020 Marc-Antoine Ruel. All rights reserved.
// Use of this source code is governed under the Apache License, Version 2.0
// that can be found in the LICENSE file.
package internaltest
import (
"errors"
"fmt"
"os"
"os/exec"
"path/filepath"
"runtime"
"strconv"
"strings"
"sync"
)
// PanicwebOutput returns the output of panicweb with inlining disabled.
//
// The function panics if any internal error occurs.
func PanicwebOutput() []byte {
panicwebOnce.Do(func() {
p := build("panicweb", false)
if p == "" {
panic("building panicweb failed")
}
defer func() {
if err := os.Remove(p); err != nil {
panic(err)
}
}()
panicwebOutput = execRun(p)
})
out := make([]byte, len(panicwebOutput))
copy(out, panicwebOutput)
return out
}
// PanicOutputs returns a map of the output of every subcommands.
//
// panic is built with inlining disabled.
//
// The subcommand "race" is built with the race detector. Others are built
// without. In particular "asleep" doesn't work with the race detector.
//
// The function panics if any internal error occurs.
func PanicOutputs() map[string][]byte {
panicOutputsOnce.Do(func() {
// Extracts the subcommands, then run each of them individually.
pplain := build("panic", false)
if pplain == "" {
// The odd of this failing is close to nil.
panic("building panic failed")
}
defer func() {
if err := os.Remove(pplain); err != nil {
panic(err)
}
}()
prace := build("panic", true)
if prace == "" {
// Race detector is not supported on this platform.
} else {
defer func() {
if err := os.Remove(prace); err != nil {
panic(err)
}
}()
}
// Collect the subcommands.
cmds := strings.Split(strings.TrimSpace(string(execRun(pplain, "dump_commands"))), "\n")
if len(cmds) == 0 {
panic("no command retrieved")
}
// Collect the output of each subcommand.
panicOutputs = map[string][]byte{}
for _, cmd := range cmds {
cmd = strings.TrimSpace(cmd)
p := pplain
if cmd == "race" {
if prace == "" {
// Race detector is not supported.
continue
}
p = prace
}
if panicOutputs[cmd] = execRun(p, cmd); len(panicOutputs[cmd]) == 0 {
panic(fmt.Sprintf("no output for %s", cmd))
}
}
})
out := make(map[string][]byte, len(panicOutputs))
for k, v := range panicOutputs {
w := make([]byte, len(v))
copy(w, v)
out[k] = w
}
return out
}
// StaticPanicwebOutput returns a constant version of panicweb output for use
// in benchmarks.
func StaticPanicwebOutput() []byte {
return []byte(staticPanicweb)
}
// StaticPanicRaceOutput returns a constant version of 'panic race' output.
func StaticPanicRaceOutput() []byte {
return []byte(staticPanicRace)
}
// IsUsingModules is best guess to know if go module are enabled.
//
// Panics if an internal error occurs.
//
// It reads the current value of GO111MODULES.
func IsUsingModules() bool {
// Calculate the default. We assume developer builds are recent (go1.14 and
// later).
ver := GetGoMinorVersion()
if ver > 0 && ver < 11 {
// go1.9.7+ and go1.10.3+ were fixed to tolerate semantic versioning import
// but they do not support the environment variable.
return false
}
def := (ver == 0 || ver >= 14)
s := os.Getenv("GO111MODULE")
return (def && (s == "auto" || s == "")) || s == "on"
}
//
var (
panicwebOnce sync.Once
panicwebOutput []byte
panicOutputsOnce sync.Once
panicOutputs map[string][]byte
)
// GetGoMinorVersion returns the Go1 minor version.
//
// Returns 0 for a developer build, panics if can't parse the version.
//
// Ignores the revision (go1.<minor>.<revision>).
func GetGoMinorVersion() int {
ver := runtime.Version()
if strings.HasPrefix(ver, "devel ") {
return 0
}
if !strings.HasPrefix(ver, "go1.") {
// This will break on go2. Please submit a PR to fix this once Go2 is
// released.
panic(fmt.Sprintf("unexpected go version %q", ver))
}
v := ver[4:]
if i := strings.IndexByte(v, '.'); i != -1 {
v = v[:i]
} else if i := strings.Index(v, "beta"); i != -1 {
v = v[:i]
} else if i := strings.Index(v, "rc"); i != -1 {
v = v[:i]
}
m, err := strconv.Atoi(v)
if err != nil {
panic(fmt.Sprintf("failed to parse %q: %v", ver, err))
}
return m
}
// build creates a temporary file and returns the path to it.
func build(tool string, race bool) string {
p := filepath.Join(os.TempDir(), tool)
if race {
p += "_race"
}
// Starting with go1.11, ioutil.TempFile() supports specifying a suffix. This
// is necessary to set the ".exe" suffix on Windows. Until we drop support
// for go1.10 and earlier, do the equivalent ourselves in an lousy way.
p += fmt.Sprintf("_%d", os.Getpid())
if runtime.GOOS == "windows" {
p += ".exe"
}
path := "github.com/maruel/panicparse/v2/cmd/"
if IsUsingModules() {
path = "github.com/maruel/panicparse/v2/cmd/"
}
if err := Compile(path+tool, p, "", true, race); err != nil {
_, _ = os.Stderr.WriteString(err.Error())
return ""
}
return p
}
var errNoRace = errors.New("platform does not support -race")
// Compile compiles sources into an executable.
func Compile(in, exe, cwd string, disableInlining, race bool) error {
// Disable optimization (-N) and inlining (-l) otherwise the inlining varies
// between local execution and remote execution. This can be observed as
// Elided being true without any argument.
args := []string{"build", "-o", exe}
if disableInlining {
args = append(args, "-gcflags", "-N -l")
}
if race {
args = append(args, "-race")
}
/* #nosec G204 */
c := exec.Command("go", append(args, in)...)
c.Dir = cwd
if out, err := c.CombinedOutput(); err != nil {
if race {
s := string(out)
const e1 = "go test: -race is only supported on "
const e2 = "go build: -race is only supported on "
if strings.HasPrefix(s, e1) || strings.HasPrefix(s, e2) {
return errNoRace
}
}
return fmt.Errorf("compile failure: %w\n%s", err, out)
}
return nil
}
// execRun runs a command and returns the combined output.
//
// It ignores the exit code, since it's meant to run panic, which crashes by
// design.
func execRun(cmd ...string) []byte {
/* #nosec G204 */
c := exec.Command(cmd[0], cmd[1:]...)
c.Env = append(os.Environ(), "GOTRACEBACK=all")
out, _ := c.CombinedOutput()
return out
}
|