pkg/test/helpers/name.go

136 lines
3.9 KiB
Go

/*
Copyright 2019 The Knative Authors
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 helpers
import (
"math/rand"
"strings"
"time"
"unicode"
)
const (
letterBytes = "abcdefghijklmnopqrstuvwxyz"
randSuffixLen = 8
nameLengthLimit = 50
sep = '-'
sepS = "-"
testNamePrefix = "Test"
)
func init() {
// Properly seed the random number generator so RandomString() is actually random.
// Otherwise, rerunning tests will generate the same names for the test resources, causing conflicts with
// already existing resources.
seed := time.Now().UTC().UnixNano()
rand.Seed(seed)
}
type named interface {
Name() string
}
// ObjectPrefixForTest returns the name prefix for this test's random names.
func ObjectPrefixForTest(t named) string {
return MakeK8sNamePrefix(strings.TrimPrefix(t.Name(), testNamePrefix))
}
// ObjectNameForTest generates a random object name based on the test name.
func ObjectNameForTest(t named) string {
prefix := ObjectPrefixForTest(t)
suffix := string(sep) + RandomString()
limit := nameLengthLimit - len(suffix)
if len(prefix) < limit {
limit = len(prefix)
}
return prefix[:limit] + suffix
}
// AppendRandomString will generate a random string that begins with prefix.
// This is useful if you want to make sure that your tests can run at the same
// time against the same environment without conflicting.
// This method will use "-" as the separator between the prefix and
// the random suffix.
func AppendRandomString(prefix string) string {
return prefix + sepS + RandomString()
}
// RandomString will generate a random string.
func RandomString() string {
suffix := make([]byte, randSuffixLen)
for i := range suffix {
suffix[i] = letterBytes[rand.Intn(len(letterBytes))]
}
return string(suffix)
}
// For the same prefix more specific should come first.
// Note: we expect GRPC vs gRPC.
var knownNames = []string{"GRPC", "H2C", "HTTPS", "HTTP2", "HTTP", "REST", "TLS", "WS"}
// MakeK8sNamePrefix converts each chunk of non-alphanumeric character into a single dash
// and also convert camelcase tokens into dash-delimited lowercase tokens.
// The function will try to catch some well known abbreviations, so that we don't separate them.
func MakeK8sNamePrefix(s string) string {
var sb strings.Builder
sb.Grow(len(s)) // At least as many chars will be in the output.
newToken := false
outer:
for i := 0; i < len(s); i++ {
c := rune(s[i])
if !(unicode.IsLetter(c) || unicode.IsNumber(c)) {
newToken = true
continue
}
isUpper := unicode.IsUpper(c)
// We could've done it only for uppercase letters,
if isUpper {
for _, n := range knownNames {
if strings.HasPrefix(s[i:], n) {
sub := s[i : i+len(n)]
if sb.Len() > 0 {
sb.WriteRune(sep)
}
sb.WriteString(strings.ToLower(sub))
i += len(n) - 1
continue outer
}
}
}
// Just a random uppercase word.
if sb.Len() > 0 && (newToken || isUpper) {
sb.WriteRune(sep)
}
sb.WriteRune(unicode.ToLower(c))
newToken = false
}
return sb.String()
}
// GetBaseFuncName returns the baseFuncName parsed from the fullFuncName.
// eg. test/e2e.TestMain will return TestMain.
func GetBaseFuncName(fullFuncName string) string {
name := fullFuncName
// Possibly there is no parent package, so only remove it from the name if '/' exists
if strings.ContainsRune(name, '/') {
name = name[strings.LastIndex(name, "/")+1:]
}
name = name[strings.LastIndex(name, ".")+1:]
return name
}