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
|
// Copyright 2019 The Hugo Authors. All rights reserved.
//
// Licensed under the Apache License, Version 2.0 (the "License");
// you may not use this file except in compliance with the License.
// You may obtain a copy of the License at
// http://www.apache.org/licenses/LICENSE-2.0
//
// Unless required by applicable law or agreed to in writing, software
// distributed under the License is distributed on an "AS IS" BASIS,
// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
// See the License for the specific language governing permissions and
// limitations under the License.
package htesting
import (
"math/rand"
"os"
"regexp"
"runtime"
"strconv"
"strings"
"testing"
"time"
qt "github.com/frankban/quicktest"
"github.com/spf13/afero"
)
// IsTest reports whether we're running as a test.
var IsTest bool
func init() {
for _, arg := range os.Args {
if strings.HasPrefix(arg, "-test.") {
IsTest = true
break
}
}
}
// CreateTempDir creates a temp dir in the given filesystem and
// returns the dirname and a func that removes it when done.
func CreateTempDir(fs afero.Fs, prefix string) (string, func(), error) {
tempDir, err := afero.TempDir(fs, "", prefix)
if err != nil {
return "", nil, err
}
_, isOsFs := fs.(*afero.OsFs)
if isOsFs && runtime.GOOS == "darwin" && !strings.HasPrefix(tempDir, "/private") {
// To get the entry folder in line with the rest. This its a little bit
// mysterious, but so be it.
tempDir = "/private" + tempDir
}
return tempDir, func() { fs.RemoveAll(tempDir) }, nil
}
// BailOut panics with a stack trace after the given duration. Useful for
// hanging tests.
func BailOut(after time.Duration) {
time.AfterFunc(after, func() {
buf := make([]byte, 1<<16)
runtime.Stack(buf, true)
panic(string(buf))
})
}
// Rnd is used only for testing.
var Rnd = rand.New(rand.NewSource(time.Now().UnixNano()))
func RandBool() bool {
return Rnd.Intn(2) != 0
}
// DiffStringSlices returns the difference between two string slices.
// Useful in tests.
// See:
// http://stackoverflow.com/questions/19374219/how-to-find-the-difference-between-two-slices-of-strings-in-golang
func DiffStringSlices(slice1 []string, slice2 []string) []string {
diffStr := []string{}
m := map[string]int{}
for _, s1Val := range slice1 {
m[s1Val] = 1
}
for _, s2Val := range slice2 {
m[s2Val] = m[s2Val] + 1
}
for mKey, mVal := range m {
if mVal == 1 {
diffStr = append(diffStr, mKey)
}
}
return diffStr
}
// DiffStrings splits the strings into fields and runs it into DiffStringSlices.
// Useful for tests.
func DiffStrings(s1, s2 string) []string {
return DiffStringSlices(strings.Fields(s1), strings.Fields(s2))
}
// SkipSlowTestUnlessCI skips the test unless we're running in a CI server.
// Note that you can set CI_LOCAL=1 to run slow tests locally in a CI-like setup.
func SkipSlowTestUnlessCI(t testing.TB) {
if !IsCI() {
t.Skip("skipping slow test in CI")
}
}
// IsCI reports whether we're running in a CI server.
func IsCI() bool {
return (os.Getenv("CI") != "" || os.Getenv("CI_LOCAL") != "") && os.Getenv("CIRCLE_BRANCH") == ""
}
// IsRealCI reports whether we're running in a CI server, but not in a local CI setup.
func IsRealCI() bool {
return IsCI() && os.Getenv("CI_LOCAL") == ""
}
// IsGitHubAction reports whether we're running in a GitHub Action.
func IsGitHubAction() bool {
return os.Getenv("GITHUB_ACTION") != ""
}
// SupportsAll reports whether the running system supports all Hugo features,
// e.g. AsciiDoc, Pandoc etc.
func SupportsAll() bool {
return IsGitHubAction() || os.Getenv("CI_LOCAL") != ""
}
// GoMinorVersion returns the minor version of the current Go version,
// e.g. 16 for Go 1.16.
func GoMinorVersion() int {
return extractMinorVersionFromGoTag(runtime.Version())
}
// IsWindows reports whether this runs on Windows.
func IsWindows() bool {
return runtime.GOOS == "windows"
}
var goMinorVersionRe = regexp.MustCompile(`go1.(\d*)`)
func extractMinorVersionFromGoTag(tag string) int {
// The tag may be on the form go1.17, go1.17.5 go1.17rc2 -- or just a commit hash.
match := goMinorVersionRe.FindStringSubmatch(tag)
if len(match) == 2 {
i, err := strconv.Atoi(match[1])
if err != nil {
return -1
}
return i
}
// a commit hash, not useful.
return -1
}
// NewPinnedRunner creates a new runner that will only Run tests matching the given regexp.
// This is added mostly to use in combination with https://marketplace.visualstudio.com/items?itemName=windmilleng.vscode-go-autotest
func NewPinnedRunner(t testing.TB, pinnedTestRe string) *PinnedRunner {
if pinnedTestRe == "" {
pinnedTestRe = ".*"
}
pinnedTestRe = strings.ReplaceAll(pinnedTestRe, "_", " ")
re := regexp.MustCompile("(?i)" + pinnedTestRe)
return &PinnedRunner{
c: qt.New(t),
re: re,
}
}
type PinnedRunner struct {
c *qt.C
re *regexp.Regexp
}
func (r *PinnedRunner) Run(name string, f func(c *qt.C)) bool {
if !r.re.MatchString(name) {
if IsGitHubAction() {
r.c.Fatal("found pinned test when running in CI")
}
return true
}
return r.c.Run(name, f)
}
|