Skip to content

Commit ac1d60c

Browse files
Abseil TeamAndy Soffer
Abseil Team
authored and
Andy Soffer
committed
Googletest export
gtest: Output a canned test suite for environment failures in XML/JSON This surfaces useful information about the environment failure in a structured form. As we can see from the updated test, previously unsurfaced information is now present. PiperOrigin-RevId: 362292322
1 parent 3bd41ab commit ac1d60c

File tree

3 files changed

+177
-19
lines changed

3 files changed

+177
-19
lines changed

‎googletest/src/gtest.cc

+104
Original file line numberDiff line numberDiff line change
@@ -3928,6 +3928,12 @@ class XmlUnitTestResultPrinter : public EmptyTestEventListener {
39283928
// Streams an XML CDATA section, escaping invalid CDATA sequences as needed.
39293929
static void OutputXmlCDataSection(::std::ostream* stream, const char* data);
39303930

3931+
// Streams a test suite XML stanza containing the given test result.
3932+
//
3933+
// Requires: result.Failed()
3934+
static void OutputXmlTestSuiteForTestResult(::std::ostream* stream,
3935+
const TestResult& result);
3936+
39313937
// Streams an XML representation of a TestResult object.
39323938
static void OutputXmlTestResult(::std::ostream* stream,
39333939
const TestResult& result);
@@ -4147,6 +4153,43 @@ void XmlUnitTestResultPrinter::OutputXmlAttribute(
41474153
*stream << " " << name << "=\"" << EscapeXmlAttribute(value) << "\"";
41484154
}
41494155

4156+
// Streams a test suite XML stanza containing the given test result.
4157+
void XmlUnitTestResultPrinter::OutputXmlTestSuiteForTestResult(
4158+
::std::ostream* stream, const TestResult& result) {
4159+
// Output the boilerplate for a minimal test suite with one test.
4160+
*stream << " <testsuite";
4161+
OutputXmlAttribute(stream, "testsuite", "name", "NonTestSuiteFailure");
4162+
OutputXmlAttribute(stream, "testsuite", "tests", "1");
4163+
OutputXmlAttribute(stream, "testsuite", "failures", "1");
4164+
OutputXmlAttribute(stream, "testsuite", "disabled", "0");
4165+
OutputXmlAttribute(stream, "testsuite", "skipped", "0");
4166+
OutputXmlAttribute(stream, "testsuite", "errors", "0");
4167+
OutputXmlAttribute(stream, "testsuite", "time",
4168+
FormatTimeInMillisAsSeconds(result.elapsed_time()));
4169+
OutputXmlAttribute(
4170+
stream, "testsuite", "timestamp",
4171+
FormatEpochTimeInMillisAsIso8601(result.start_timestamp()));
4172+
*stream << ">";
4173+
4174+
// Output the boilerplate for a minimal test case with a single test.
4175+
*stream << " <testcase";
4176+
OutputXmlAttribute(stream, "testcase", "name", "");
4177+
OutputXmlAttribute(stream, "testcase", "status", "run");
4178+
OutputXmlAttribute(stream, "testcase", "result", "completed");
4179+
OutputXmlAttribute(stream, "testcase", "classname", "");
4180+
OutputXmlAttribute(stream, "testcase", "time",
4181+
FormatTimeInMillisAsSeconds(result.elapsed_time()));
4182+
OutputXmlAttribute(
4183+
stream, "testcase", "timestamp",
4184+
FormatEpochTimeInMillisAsIso8601(result.start_timestamp()));
4185+
4186+
// Output the actual test result.
4187+
OutputXmlTestResult(stream, result);
4188+
4189+
// Complete the test suite.
4190+
*stream << " </testsuite>\n";
4191+
}
4192+
41504193
// Prints an XML representation of a TestInfo object.
41514194
void XmlUnitTestResultPrinter::OutputXmlTestInfo(::std::ostream* stream,
41524195
const char* test_suite_name,
@@ -4309,6 +4352,13 @@ void XmlUnitTestResultPrinter::PrintXmlUnitTest(std::ostream* stream,
43094352
if (unit_test.GetTestSuite(i)->reportable_test_count() > 0)
43104353
PrintXmlTestSuite(stream, *unit_test.GetTestSuite(i));
43114354
}
4355+
4356+
// If there was a test failure outside of one of the test suites (like in a
4357+
// test environment) include that in the output.
4358+
if (unit_test.ad_hoc_test_result().Failed()) {
4359+
OutputXmlTestSuiteForTestResult(stream, unit_test.ad_hoc_test_result());
4360+
}
4361+
43124362
*stream << "</" << kTestsuites << ">\n";
43134363
}
43144364

@@ -4399,6 +4449,12 @@ class JsonUnitTestResultPrinter : public EmptyTestEventListener {
43994449
const std::string& indent,
44004450
bool comma = true);
44014451

4452+
// Streams a test suite JSON stanza containing the given test result.
4453+
//
4454+
// Requires: result.Failed()
4455+
static void OutputJsonTestSuiteForTestResult(::std::ostream* stream,
4456+
const TestResult& result);
4457+
44024458
// Streams a JSON representation of a TestResult object.
44034459
static void OutputJsonTestResult(::std::ostream* stream,
44044460
const TestResult& result);
@@ -4553,6 +4609,48 @@ void JsonUnitTestResultPrinter::OutputJsonKey(
45534609
*stream << ",\n";
45544610
}
45554611

4612+
// Streams a test suite JSON stanza containing the given test result.
4613+
void JsonUnitTestResultPrinter::OutputJsonTestSuiteForTestResult(
4614+
::std::ostream* stream, const TestResult& result) {
4615+
// Output the boilerplate for a new test suite.
4616+
*stream << Indent(4) << "{\n";
4617+
OutputJsonKey(stream, "testsuite", "name", "NonTestSuiteFailure", Indent(6));
4618+
OutputJsonKey(stream, "testsuite", "tests", 1, Indent(6));
4619+
if (!GTEST_FLAG(list_tests)) {
4620+
OutputJsonKey(stream, "testsuite", "failures", 1, Indent(6));
4621+
OutputJsonKey(stream, "testsuite", "disabled", 0, Indent(6));
4622+
OutputJsonKey(stream, "testsuite", "skipped", 0, Indent(6));
4623+
OutputJsonKey(stream, "testsuite", "errors", 0, Indent(6));
4624+
OutputJsonKey(stream, "testsuite", "time",
4625+
FormatTimeInMillisAsDuration(result.elapsed_time()),
4626+
Indent(6));
4627+
OutputJsonKey(stream, "testsuite", "timestamp",
4628+
FormatEpochTimeInMillisAsRFC3339(result.start_timestamp()),
4629+
Indent(6));
4630+
}
4631+
*stream << Indent(6) << "\"testsuite\": [\n";
4632+
4633+
// Output the boilerplate for a new test case.
4634+
*stream << Indent(8) << "{\n";
4635+
OutputJsonKey(stream, "testcase", "name", "", Indent(10));
4636+
OutputJsonKey(stream, "testcase", "status", "RUN", Indent(10));
4637+
OutputJsonKey(stream, "testcase", "result", "COMPLETED", Indent(10));
4638+
OutputJsonKey(stream, "testcase", "timestamp",
4639+
FormatEpochTimeInMillisAsRFC3339(result.start_timestamp()),
4640+
Indent(10));
4641+
OutputJsonKey(stream, "testcase", "time",
4642+
FormatTimeInMillisAsDuration(result.elapsed_time()),
4643+
Indent(10));
4644+
OutputJsonKey(stream, "testcase", "classname", "", Indent(10), false);
4645+
*stream << TestPropertiesAsJson(result, Indent(10));
4646+
4647+
// Output the actual test result.
4648+
OutputJsonTestResult(stream, result);
4649+
4650+
// Finish the test suite.
4651+
*stream << "\n" << Indent(6) << "]\n" << Indent(4) << "}";
4652+
}
4653+
45564654
// Prints a JSON representation of a TestInfo object.
45574655
void JsonUnitTestResultPrinter::OutputJsonTestInfo(::std::ostream* stream,
45584656
const char* test_suite_name,
@@ -4712,6 +4810,12 @@ void JsonUnitTestResultPrinter::PrintJsonUnitTest(std::ostream* stream,
47124810
}
47134811
}
47144812

4813+
// If there was a test failure outside of one of the test suites (like in a
4814+
// test environment) include that in the output.
4815+
if (unit_test.ad_hoc_test_result().Failed()) {
4816+
OutputJsonTestSuiteForTestResult(stream, unit_test.ad_hoc_test_result());
4817+
}
4818+
47154819
*stream << "\n" << kIndent << "]\n" << "}\n";
47164820
}
47174821

‎googletest/test/googletest-json-output-unittest.py

+57-13
Original file line numberDiff line numberDiff line change
@@ -612,15 +612,59 @@
612612
}],
613613
}
614614

615-
EXPECTED_EMPTY = {
616-
u'tests': 0,
617-
u'failures': 0,
618-
u'disabled': 0,
619-
u'errors': 0,
620-
u'time': u'*',
621-
u'timestamp': u'*',
622-
u'name': u'AllTests',
623-
u'testsuites': [],
615+
EXPECTED_NO_TEST = {
616+
u'tests':
617+
0,
618+
u'failures':
619+
0,
620+
u'disabled':
621+
0,
622+
u'errors':
623+
0,
624+
u'time':
625+
u'*',
626+
u'timestamp':
627+
u'*',
628+
u'name':
629+
u'AllTests',
630+
u'testsuites': [{
631+
u'name':
632+
u'NonTestSuiteFailure',
633+
u'tests':
634+
1,
635+
u'failures':
636+
1,
637+
u'disabled':
638+
0,
639+
u'skipped':
640+
0,
641+
u'errors':
642+
0,
643+
u'time':
644+
u'*',
645+
u'timestamp':
646+
u'*',
647+
u'testsuite': [{
648+
u'name':
649+
u'',
650+
u'status':
651+
u'RUN',
652+
u'result':
653+
u'COMPLETED',
654+
u'time':
655+
u'*',
656+
u'timestamp':
657+
u'*',
658+
u'classname':
659+
u'',
660+
u'failures': [{
661+
u'failure': u'gtest_no_test_unittest.cc:*\n'
662+
u'Expected equality of these values:\n'
663+
u' 1\n 2' + STACK_TRACE_TEMPLATE,
664+
u'type': u'',
665+
}]
666+
}]
667+
}],
624668
}
625669

626670
GTEST_PROGRAM_PATH = gtest_test_utils.GetTestExecutablePath(GTEST_PROGRAM_NAME)
@@ -645,14 +689,14 @@ def testNonEmptyJsonOutput(self):
645689
"""
646690
self._TestJsonOutput(GTEST_PROGRAM_NAME, EXPECTED_NON_EMPTY, 1)
647691

648-
def testEmptyJsonOutput(self):
692+
def testNoTestJsonOutput(self):
649693
"""Verifies JSON output for a Google Test binary without actual tests.
650694
651-
Runs a test program that generates an empty JSON output, and
652-
tests that the JSON output is expected.
695+
Runs a test program that generates an JSON output for a binary with no
696+
tests, and tests that the JSON output is expected.
653697
"""
654698

655-
self._TestJsonOutput('gtest_no_test_unittest', EXPECTED_EMPTY, 0)
699+
self._TestJsonOutput('gtest_no_test_unittest', EXPECTED_NO_TEST, 0)
656700

657701
def testTimestampValue(self):
658702
"""Checks whether the timestamp attribute in the JSON output is valid.

‎googletest/test/gtest_xml_output_unittest.py

+16-6
Original file line numberDiff line numberDiff line change
@@ -216,10 +216,20 @@
216216
</testsuite>
217217
</testsuites>"""
218218

219-
EXPECTED_EMPTY_XML = """<?xml version="1.0" encoding="UTF-8"?>
219+
EXPECTED_NO_TEST_XML = """<?xml version="1.0" encoding="UTF-8"?>
220220
<testsuites tests="0" failures="0" disabled="0" errors="0" time="*"
221221
timestamp="*" name="AllTests">
222-
</testsuites>"""
222+
<testsuite name="NonTestSuiteFailure" tests="1" failures="1" disabled="0" skipped="0" errors="0" time="*" timestamp="*">
223+
<testcase name="" status="run" result="completed" time="*" timestamp="*" classname="">
224+
<failure message="gtest_no_test_unittest.cc:*&#x0A;Expected equality of these values:&#x0A; 1&#x0A; 2" type=""><![CDATA[gtest_no_test_unittest.cc:*
225+
Expected equality of these values:
226+
1
227+
2%(stack)s]]></failure>
228+
</testcase>
229+
</testsuite>
230+
</testsuites>""" % {
231+
'stack': STACK_TRACE_TEMPLATE
232+
}
223233

224234
GTEST_PROGRAM_PATH = gtest_test_utils.GetTestExecutablePath(GTEST_PROGRAM_NAME)
225235

@@ -242,14 +252,14 @@ def testNonEmptyXmlOutput(self):
242252
"""
243253
self._TestXmlOutput(GTEST_PROGRAM_NAME, EXPECTED_NON_EMPTY_XML, 1)
244254

245-
def testEmptyXmlOutput(self):
255+
def testNoTestXmlOutput(self):
246256
"""Verifies XML output for a Google Test binary without actual tests.
247257
248-
Runs a test program that generates an empty XML output, and
249-
tests that the XML output is expected.
258+
Runs a test program that generates an XML output for a binary without tests,
259+
and tests that the XML output is expected.
250260
"""
251261

252-
self._TestXmlOutput('gtest_no_test_unittest', EXPECTED_EMPTY_XML, 0)
262+
self._TestXmlOutput('gtest_no_test_unittest', EXPECTED_NO_TEST_XML, 0)
253263

254264
def testTimestampValue(self):
255265
"""Checks whether the timestamp attribute in the XML output is valid.

0 commit comments

Comments
 (0)