blob: d3de578c760b90e673cb6c0c2dc7182b60ff3ba8 [file] [log] [blame] [edit]
// Copyright 2018 The BoringSSL 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
//
// https://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.
// testresult is an implementation of Chromium's JSON test result format. See
// https://chromium.googlesource.com/chromium/src/+/main/docs/testing/json_test_results_format.md
package testresult
import (
"encoding/json"
"fmt"
"os"
"time"
)
// Results stores the top-level test results.
type Results struct {
Version int `json:"version"`
Interrupted bool `json:"interrupted"`
PathDelimiter string `json:"path_delimiter"`
SecondsSinceEpoch float64 `json:"seconds_since_epoch"`
NumFailuresByType map[string]int `json:"num_failures_by_type"`
Tests map[string]Result `json:"tests"`
}
func NewResults() *Results {
return &Results{
Version: 3,
PathDelimiter: ".",
SecondsSinceEpoch: float64(time.Now().UnixNano()) / float64(time.Second/time.Nanosecond),
NumFailuresByType: make(map[string]int),
Tests: make(map[string]Result),
}
}
func (t *Results) addResult(name, result, expected string, err error) {
if _, found := t.Tests[name]; found {
panic(fmt.Sprintf("duplicate test name %q", name))
}
r := Result{
Actual: result,
Expected: expected,
IsUnexpected: result != expected,
}
if err != nil {
r.Error = err.Error()
}
t.Tests[name] = r
t.NumFailuresByType[result]++
}
// AddResult records a test result with the given result string. The test is a
// failure if the result is not "PASS".
func (t *Results) AddResult(name, result string, err error) {
t.addResult(name, result, "PASS", err)
}
// AddSkip marks a test as being skipped. It is not considered a failure.
func (t *Results) AddSkip(name string) {
t.addResult(name, "SKIP", "SKIP", nil)
}
func (t *Results) HasUnexpectedResults() bool {
for _, r := range t.Tests {
if r.IsUnexpected {
return false
}
}
return true
}
func (t *Results) WriteToFile(name string) error {
file, err := os.Create(name)
if err != nil {
return err
}
defer file.Close()
out, err := json.MarshalIndent(t, "", " ")
if err != nil {
return err
}
_, err = file.Write(out)
return err
}
type Result struct {
Actual string `json:"actual"`
Expected string `json:"expected"`
IsUnexpected bool `json:"is_unexpected"`
// Error is not part of the Chromium test results schema, but is useful for
// BoGo output.
Error string `json:"error,omitempty"`
}