extern/hishtory
1
0
Fork 0
mirror of https://github.com/ddworken/hishtory.git synced 2025-02-11 08:00:18 +01:00
Code Issues Packages Projects Releases Wiki Activity

Move sharding functions to testutils and add some comments

Browse Source
This commit is contained in:
David Dworken 2024-02-10 23:07:52 -08:00
parent 102a3b54ac
commit 43a65066ee
No known key found for this signature in database
2 changed files with 56 additions and 48 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

48
client/client_test.go
View File

@ -9,7 +9,6 @@ import (
"path"
"regexp"
"runtime"
"strconv"
"strings"
"sync"
"testing"
@ -58,53 +57,6 @@ func TestMain(m *testing.M) {
var shellTesters []shellTester = []shellTester{bashTester{}, zshTester{}}
func numTestShards() int {
numTestShardsStr := os.Getenv("NUM_TEST_SHARDS")
if numTestShardsStr == "" {
return -1
}
numTestShards, err := strconv.Atoi(numTestShardsStr)
if err != nil {
panic(fmt.Errorf("failed to parse NUM_TEST_SHARDS: %v", err))
}
return numTestShards
}
func currentShardNumber() int {
currentShardNumberStr := os.Getenv("CURRENT_SHARD_NUM")
if currentShardNumberStr == "" {
return -1
}
currentShardNumber, err := strconv.Atoi(currentShardNumberStr)
if err != nil {
panic(fmt.Errorf("failed to parse CURRENT_SHARD_NUM: %v", err))
}
return currentShardNumber
}
func isShardedTestRun() bool {
return numTestShards() != -1 && currentShardNumber() != -1
}
func markTestForSharding(t *testing.T, testShardNumber int) {
if isShardedTestRun() {
if testShardNumber%numTestShards() != currentShardNumber() {
t.Skip("Skipping sharded test")
}
}
}
var shardNumberAllocator int = 0
func wrapTestForSharding(test func(t *testing.T)) func(t *testing.T) {
shardNumberAllocator += 1
return func(t *testing.T) {
testShardNumber := shardNumberAllocator
markTestForSharding(t, testShardNumber)
test(t)
}
}
func TestParam(t *testing.T) {
if skipSlowTests() {
shellTesters = shellTesters[:1]

56
client/testutils.go
View File

@ -366,3 +366,59 @@ func stripRequiredPrefix(t *testing.T, out, prefix string) string {
func stripTuiCommandPrefix(t *testing.T, out string) string {
return stripRequiredPrefix(t, out, "hishtory tquery")
}
// Wrap the given test so that it can be run on Github Actions with sharding. This
// makes it possible to run only 1/N tests on each of N github action jobs, speeding
// up test execution through parallelization. This is necessary since the wrapped
// integration tests rely on OS-level globals (the shell history) that can't otherwise
// be parallelized.
func wrapTestForSharding(test func(t *testing.T)) func(t *testing.T) {
shardNumberAllocator += 1
return func(t *testing.T) {
testShardNumber := shardNumberAllocator
markTestForSharding(t, testShardNumber)
test(t)
}
}
var shardNumberAllocator int = 0
// Returns whether this is a sharded test run. false during all normal non-github action operations.
func isShardedTestRun() bool {
return numTestShards() != -1 && currentShardNumber() != -1
}
// Get the total number of test shards
func numTestShards() int {
numTestShardsStr := os.Getenv("NUM_TEST_SHARDS")
if numTestShardsStr == "" {
return -1
}
numTestShards, err := strconv.Atoi(numTestShardsStr)
if err != nil {
panic(fmt.Errorf("failed to parse NUM_TEST_SHARDS: %v", err))
}
return numTestShards
}
// Get the current shard number
func currentShardNumber() int {
currentShardNumberStr := os.Getenv("CURRENT_SHARD_NUM")
if currentShardNumberStr == "" {
return -1
}
currentShardNumber, err := strconv.Atoi(currentShardNumberStr)
if err != nil {
panic(fmt.Errorf("failed to parse CURRENT_SHARD_NUM: %v", err))
}
return currentShardNumber
}
// Mark the given test for sharding with the given test ID number.
func markTestForSharding(t *testing.T, testShardNumber int) {
if isShardedTestRun() {
if testShardNumber%numTestShards() != currentShardNumber() {
t.Skip("Skipping sharded test")
}
}
}