src/chromiumos/tast/local/gtest/report.go

// Copyright 2019 The Chromium OS 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 gtest

import (
	"encoding/xml"
	"fmt"
	"io/ioutil"

	"chromiumos/tast/errors"
)

// Report is a parsed gtest output report.
// See https://github.com/google/googletest/blob/master/googletest/docs/advanced.md#generating-an-xml-report for details.
// Note: at the moment, only a subset of the report is parsed. More can be
// added upon requirements.
// TODO(crbug.com/940320): Consider switching to use JSON, which is supported
// gtest 1.8.1 or later.
type Report struct {
	Suites []*TestSuite `xml:"testsuite"`
}

// TestSuite represents a testsuite run in Report.
type TestSuite struct {
	Name  string      `xml:"name,attr"`
	Cases []*TestCase `xml:"testcase"`
}

// TestCase represents a testcase run in TestSuite.
type TestCase struct {
	Name     string    `xml:"name,attr"`
	Failures []Failure `xml:"failure"`
}

// Failure represents a test validation failure in TestCase.
type Failure struct {
	Message string `xml:"message,attr"`
}

// FailedTestNames returns an array of failed test names, in the
// "TestSuite.TestCase" format. If no error is found, returns nil.
// This walks through whole the report.
func (r *Report) FailedTestNames() []string {
	var ret []string
	for _, s := range r.Suites {
		for _, c := range s.Cases {
			if len(c.Failures) > 0 {
				ret = append(ret, fmt.Sprintf("%s.%s", s.Name, c.Name))
			}
		}
	}
	return ret
}

// ParseReport parses the XML gtest output report at path.
func ParseReport(path string) (*Report, error) {
	b, err := ioutil.ReadFile(path)
	if err != nil {
		return nil, errors.Wrap(err, "failed to read")
	}
	return parseReportInternal(b)
}

func parseReportInternal(b []byte) (*Report, error) {
	ret := &Report{}
	if err := xml.Unmarshal(b, ret); err != nil {
		return nil, errors.Wrap(err, "failed to parse gtest XML report")
	}
	return ret, nil
}