blob: c1f9f10c3033e659b4bc13c7a3c7fe367bb5a2b4 [file] [log] [blame]
// Copyright 2019 The Fuchsia Authors. All rights reserved.
// Use of this source code is governed by a BSD-style license that can be
// found in the LICENSE file.
package build
import "strings"
const (
componentV2Suffix = ".cm"
// TestSpec is the specification for a single test and the environments it
// should be executed in.
type TestSpec struct {
// Test is the test that this specification is for.
Test `json:"test"`
// Envs is a set of environments that the test should be executed in.
Envs []Environment `json:"environments"`
// Test encapsulates details about a particular test.
type Test struct {
// Name is a human-readable identifier for this test. It should be unique
// within any given TestSpec.
Name string `json:"name"`
// PackageURL is the fuchsia package URL for this test. It is only set for
// tests targeting Fuchsia.
PackageURL string `json:"package_url,omitempty"`
// PackageLabel is the full GN label with toolchain of the fuchsia package
// for this test.
PackageLabel string `json:"package_label,omitempty"`
// PackageManifests is a list of paths to manifests describing the
// packages needed by the test. They are all relative to the build
// directory.
PackageManifests []string `json:"package_manifests,omitempty"`
// Path is the path to the test on the target OS.
Path string `json:"path"`
// Label is the full GN label with toolchain for the test target.
// E.g.: //src/foo/tests:foo_tests(//build/toolchain/fuchsia:x64)
Label string `json:"label"`
// OS is the operating system in which this test must be executed.
OS string `json:"os"`
// CPU architecture on which this test can execute.
CPU string `json:"cpu"`
// Settings of log produced by this test
LogSettings LogSettings `json:"log_settings,omitempty"`
// Number of test cases to run in parallel. This only works with v2 tests.
Parallel uint16 `json:"parallel,omitempty"`
// RuntimeDepsFile is a relative path within the build directory to a file
// containing a JSON list of the test's runtime dependencies, Currently this
// field only makes sense for Linux and Mac tests.
RuntimeDepsFile string `json:"runtime_deps,omitempty"`
// Isolated specifies whether the test should run in its own shard.
Isolated bool `json:"isolated,omitempty"`
// TimeoutSecs is the timeout for the test.
TimeoutSecs int `json:"timeout_secs,omitempty"`
// IsComponentV2 returns whether the test is a component v2 test.
func (t *Test) IsComponentV2() bool {
return strings.HasSuffix(t.PackageURL, componentV2Suffix)
type LogSettings struct {
// Max severity of logs produced by the test.
MaxSeverity string `json:"max_severity,omitempty"`
// Environment describes the full environment a test requires.
// The GN environments specified by test authors in the Fuchsia source
// correspond directly to the Environment struct defined here.
type Environment struct {
// Dimensions gives the Swarming dimensions a test wishes to target.
Dimensions DimensionSet `json:"dimensions"`
// Tags are keys given to an environment on which the testsharder may filter.
Tags []string `json:"tags,omitempty"`
// ServiceAccount gives a service account to attach to Swarming task.
ServiceAccount string `json:"service_account,omitempty"`
// Netboot tells whether to "netboot" instead of paving before running the tests.
Netboot bool `json:"netboot,omitempty"`
// IsEmu is true if this environment targets an emulator, false otherwise.
IsEmu bool `json:"is_emu,omitempty"`
// ExtraEnvNameKeys are keys to further distinguish a unique environment by.
ExtraEnvNameKeys []string `json:"extra_env_name_keys,omitempty"`
// ImageOverrides is a map of the images to override the default values in
// images.json used to boot a target. The key should be an ImageOverrideType
// and the value should be the name of the image to override with as defined
// in images.json.
ImageOverrides ImageOverrides `json:"image_overrides,omitempty"`
// ImageOverrides is a map of image type to image name as defined in images.json.
type ImageOverrides map[ImageOverrideType]string
// ImageOverrideType represents image types supported for overriding.
type ImageOverrideType string
const (
ZbiImage ImageOverrideType = "zbi_image"
VbmetaImage ImageOverrideType = "vbmeta_image"
QemuKernel ImageOverrideType = "qemu_kernel"
// DimensionSet encapsulates the Swarming dimensions a test wishes to target.
type DimensionSet struct {
// DeviceType represents the class of device the test should run on.
// This is a required field.
DeviceType string `json:"device_type,omitempty"`
// The OS to run the test on (e.g., "Linux" or "Mac"). Used for host-side testing.
OS string `json:"os,omitempty"`
// The CPU type that the test is meant to run on.
CPU string `json:"cpu,omitempty"`
// Testbed denotes a physical test device configuration to run a test on (e.g., multi-device set-ups or devices inside chambers for connectivity testing).
Testbed string `json:"testbed,omitempty"`
// Pool denotes the swarming pool to run a test in.
Pool string `json:"pool,omitempty"`