blob: 0b01d22c65603313ce9bd954c4a049b28308f7c5 [file] [log] [blame]
// Copyright 2023 Google LLC
//
// Use of this source code is governed by a BSD-style license that can be
// found in the LICENSE file.
package main
import (
"context"
"os"
"path/filepath"
"testing"
"github.com/stretchr/testify/assert"
"github.com/stretchr/testify/require"
"go.skia.org/infra/go/exec"
exec_testutils "go.skia.org/infra/go/exec/testutils"
"go.skia.org/infra/task_driver/go/lib/os_steps"
"go.skia.org/infra/task_driver/go/td"
"go.skia.org/skia/infra/bots/task_drivers/common"
"go.skia.org/skia/infra/bots/task_drivers/testutils"
)
func TestRun_Success(t *testing.T) {
// Given that we have tests for common.UploadToGold(), it suffices to test a couple of
// "happy" cases here.
test := func(name string, tdArgs taskDriverArgs, goldctlWorkDir, goldctlImgtestInitStepName string, goldctlImgtestInitArgs []string) {
t.Run(name, func(t *testing.T) {
// Create fake archive with undeclared test outputs.
outputsZIP := filepath.Join(tdArgs.checkoutDir, "bazel-testlogs", "some", "test", "target", "test.outputs", "outputs.zip")
require.NoError(t, os.MkdirAll(filepath.Dir(outputsZIP), 0700))
testutils.MakeZIP(t, outputsZIP, map[string]string{
// The contents of PNG files does not matter for this test.
"alfa.png": "fake PNG",
"alfa.json": `{
"md5": "a01a01a01a01a01a01a01a01a01a01a0",
"keys": {
"build_system": "bazel",
"name": "alfa",
"source_type": "gm"
}
}`,
"beta.png": "fake PNG",
"beta.json": `{
"md5": "b02b02b02b02b02b02b02b02b02b02b0",
"keys": {
"build_system": "bazel",
"name": "beta",
"source_type": "gm"
}
}`,
})
// Will be returned by the mocked os_steps.TempDir() when the task driver tries to create a
// directory in which to extract the undeclared outputs ZIP archive.
outputsZIPExtractionDir := t.TempDir()
commandCollector := exec.CommandCollector{}
res := td.RunTestSteps(t, false, func(ctx context.Context) error {
ctx = td.WithExecRunFn(ctx, commandCollector.Run)
var bazelCacheDirPath string
ctx, bazelCacheDirPath = common.WithEnoughSpaceOnBazelCachePartitionTestOnlyContext(ctx)
// We don't need to assert the exact number of times that os_steps.TempDir() is called
// because said function produces a "Creating TempDir" task driver step, and we check the
// exact set of steps produced.
ctx = context.WithValue(ctx, os_steps.TempDirContextKey, testutils.MakeTempDirMockFn(t, outputsZIPExtractionDir, goldctlWorkDir))
err := run(ctx, bazelCacheDirPath, tdArgs)
assert.NoError(t, err)
return err
})
require.Empty(t, res.Errors)
require.Empty(t, res.Exceptions)
testutils.AssertStepNames(t, res,
"Test //some/test:target with config linux_rbe",
"bazelisk test //some/test:target --config=linux_rbe --config=GCE_Debian10_AVX512 --test_output=errors --jobs=100",
"Creating TempDir",
"Extract undeclared outputs archive "+outputsZIP+" into "+outputsZIPExtractionDir,
"Extracting file: alfa.json",
"Extracting file: alfa.png",
"Extracting file: beta.json",
"Extracting file: beta.png",
"Gather JSON and PNG files produced by GMs",
"Gather \"alfa.png\"",
"Gather \"beta.png\"",
"Upload GM outputs to Gold",
"Creating TempDir",
"/path/to/goldctl auth --work-dir "+goldctlWorkDir+" --luci",
goldctlImgtestInitStepName,
"/path/to/goldctl imgtest add --work-dir "+goldctlWorkDir+" --test-name alfa --png-file "+outputsZIPExtractionDir+"/alfa.png --png-digest a01a01a01a01a01a01a01a01a01a01a0 --add-test-key build_system:bazel --add-test-key name:alfa --add-test-key source_type:gm",
"/path/to/goldctl imgtest add --work-dir "+goldctlWorkDir+" --test-name beta --png-file "+outputsZIPExtractionDir+"/beta.png --png-digest b02b02b02b02b02b02b02b02b02b02b0 --add-test-key build_system:bazel --add-test-key name:beta --add-test-key source_type:gm",
"/path/to/goldctl imgtest finalize --work-dir "+goldctlWorkDir,
"Clean Bazel cache if disk space is too low",
"No need to clear the Bazel cache: free space on partition /mnt/pd0 is 20000000000 bytes, which is above the threshold of 15000000000 bytes",
)
// Command "bazelisk test ..." should be called from the checkout directory.
assert.Equal(t, tdArgs.checkoutDir, commandCollector.Commands()[0].Dir)
exec_testutils.AssertCommandsMatch(t,
[][]string{
{
"bazelisk",
"test",
"//some/test:target",
"--config=linux_rbe",
"--config=GCE_Debian10_AVX512",
"--test_output=errors",
"--jobs=100",
},
{
"/path/to/goldctl",
"auth",
"--work-dir", goldctlWorkDir,
"--luci",
},
append([]string{
"/path/to/goldctl",
}, goldctlImgtestInitArgs...),
{
"/path/to/goldctl",
"imgtest",
"add",
"--work-dir", goldctlWorkDir,
"--test-name", "alfa",
"--png-file", outputsZIPExtractionDir + "/alfa.png",
"--png-digest", "a01a01a01a01a01a01a01a01a01a01a0",
"--add-test-key", "build_system:bazel",
"--add-test-key", "name:alfa",
"--add-test-key", "source_type:gm",
},
{
"/path/to/goldctl",
"imgtest",
"add",
"--work-dir", goldctlWorkDir,
"--test-name", "beta",
"--png-file", outputsZIPExtractionDir + "/beta.png",
"--png-digest", "b02b02b02b02b02b02b02b02b02b02b0",
"--add-test-key", "build_system:bazel",
"--add-test-key", "name:beta",
"--add-test-key", "source_type:gm",
},
{
"/path/to/goldctl",
"imgtest",
"finalize",
"--work-dir", goldctlWorkDir,
},
},
commandCollector.Commands(),
)
})
}
checkoutDir := t.TempDir()
goldctlWorkDir := t.TempDir()
test(
"post-submit task",
taskDriverArgs{
UploadToGoldArgs: common.UploadToGoldArgs{
TestOnlyAllowAnyBazelLabel: true,
BazelLabel: "//some/test:target",
DeviceSpecificBazelConfig: "GCE_Debian10_AVX512",
GoldctlPath: "/path/to/goldctl",
GitCommit: "ff99ff99ff99ff99ff99ff99ff99ff99ff99ff99",
},
checkoutDir: checkoutDir,
bazelConfig: "linux_rbe",
},
goldctlWorkDir,
"/path/to/goldctl imgtest init --work-dir "+goldctlWorkDir+" --instance skia --url https://gold.skia.org --bucket skia-infra-gm --git_hash ff99ff99ff99ff99ff99ff99ff99ff99ff99ff99 --key arch:x86_64 --key model:GCE --key os:Debian10",
[]string{
"imgtest",
"init",
"--work-dir", goldctlWorkDir,
"--instance", "skia",
"--url", "https://gold.skia.org",
"--bucket", "skia-infra-gm",
"--git_hash", "ff99ff99ff99ff99ff99ff99ff99ff99ff99ff99",
"--key", "arch:x86_64",
"--key", "model:GCE",
"--key", "os:Debian10",
},
)
goldctlWorkDir = t.TempDir()
test(
"CL task",
taskDriverArgs{
UploadToGoldArgs: common.UploadToGoldArgs{
TestOnlyAllowAnyBazelLabel: true,
BazelLabel: "//some/test:target",
DeviceSpecificBazelConfig: "GCE_Debian10_AVX512",
GoldctlPath: "/path/to/goldctl",
GitCommit: "ff99ff99ff99ff99ff99ff99ff99ff99ff99ff99",
ChangelistID: "changelist-id",
PatchsetOrder: "1",
TryjobID: "tryjob-id",
},
checkoutDir: checkoutDir,
bazelConfig: "linux_rbe",
},
goldctlWorkDir,
"/path/to/goldctl imgtest init --work-dir "+goldctlWorkDir+" --instance skia --url https://gold.skia.org --bucket skia-infra-gm --git_hash ff99ff99ff99ff99ff99ff99ff99ff99ff99ff99 --crs gerrit --cis buildbucket --changelist changelist-id --patchset 1 --jobid tryjob-id --key arch:x86_64 --key model:GCE --key os:Debian10",
[]string{
"imgtest",
"init",
"--work-dir", goldctlWorkDir,
"--instance", "skia",
"--url", "https://gold.skia.org",
"--bucket", "skia-infra-gm",
"--git_hash", "ff99ff99ff99ff99ff99ff99ff99ff99ff99ff99",
"--crs", "gerrit",
"--cis", "buildbucket",
"--changelist", "changelist-id",
"--patchset", "1",
"--jobid", "tryjob-id",
"--key", "arch:x86_64",
"--key", "model:GCE",
"--key", "os:Debian10",
},
)
}