blob: 3bb8b2baddd3e5729da9701d2cd3342bce08e119 [file] [log] [blame]
// Copyright 2018 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 runtests contains specifics related to the runtests command.
package runtests
import (
// TODO(olivernewman): Move the contents of this file into a separate library as
// it's no longer specific to runtests - in fact, runtests only implements a
// subset of the types and fields defined here.
const (
// TestSummaryFilename is the summary file name expected by the fuchsia
// recipe module.
TestSummaryFilename = "summary.json"
// TestOutputFilename is the default output file name for a test.
TestOutputFilename = "stdout-and-stderr.txt"
// TestResult is the exit result of a test.
type TestResult string
// Possible test statuses, names chosen for consistency with ResultDB:
const (
// TestSuccess represents a passed test.
TestSuccess TestResult = "PASS"
// TestFailure represents a failed test.
TestFailure TestResult = "FAIL"
// TestAborted represents an aborted test (likely a timeout).
TestAborted TestResult = "ABORT"
// TestSkipped represents a skipped test.
TestSkipped TestResult = "SKIP"
// TestSummary is a summary of a suite of test runs. It represents the output
// file format of a runtests invocation.
type TestSummary struct {
// Tests is a list of the details of the test runs.
Tests []TestDetails `json:"tests"`
// Outputs gives the suite-wide outputs, mapping canonical name of the
// output to its path.
Outputs map[string]string `json:"outputs,omitempty"`
// DataSink is a data sink exported by the test.
type DataSink struct {
// Name is the name of the sink.
Name string `json:"name"`
// File is the file containing the sink data.
File string `json:"file"`
// DataSinkMap is mapping from a data sink name to a list of the corresponding
// data sink files.
type DataSinkMap map[string][]DataSink
// TestDetails contains the details of a test run.
type TestDetails struct {
// Name is the name of the test.
Name string `json:"name"`
// GNLabel is label of the test target (with toolchain).
GNLabel string `json:"gn_label"`
// OutputFiles are paths to the test's output files.
OutputFiles []string `json:"output_files"`
// Result is the result of the test.
Result TestResult `json:"result"`
// Cases is individual test case results.
Cases []TestCaseResult `json:"cases"`
// DataSinks gives the data sinks attached to a test.
DataSinks DataSinkMap `json:"data_sinks,omitempty"`
// StartTime is the UTC time when the test was started.
StartTime time.Time `json:"start_time"`
// Duration is how long the test execution took.
DurationMillis int64 `json:"duration_milliseconds"`
// IsTestingFailureMode is true iff this test was produced by tefmocheck.
IsTestingFailureMode bool `json:"is_testing_failure_mode"`
// Affected indicates whether the test is affected by the change under test.
// It will only be set for tests running within tryjobs.
Affected bool `json:"affected"`
// Tags contain test metadata.
Tags []build.TestTag `json:"tags"`
// TestCaseResult contains the details of a single test case, nested within a
// top-level TestDetails.
type TestCaseResult struct {
DisplayName string `json:"display_name"`
SuiteName string `json:"suite_name"`
CaseName string `json:"case_name"`
Status TestResult `json:"status"`
Duration time.Duration `json:"duration_nanos"`
// Format is the test runner used to execute the test.
Format string `json:"format"`
// FailReason is a concise and distinctive error message captured from stdout when the test case fails.
// The message is used to group similar failures and shouldn't contain stacktrace or line numbers.
FailReason string `json:"fail_reason"`
OutputFiles []string `json:"output_files,omitempty"`
// The directory where the OutputFiles live if given as relative paths.
OutputDir string `json:"output_dir,omitempty"`