feat: endpoint to post xunit test data

packages/api/lib/testrun.js

@@ -15,16 +15,15 @@
 const firebaseEncode = require('./firebase-encode');
 
 class TestCaseRun {
-  constructor (okMessage, number, name) {
+  constructor (okMessage, name) {
     this.successful = (okMessage === 'ok');
-    this.number = number;
     this.name = name;
     this.encodedName = firebaseEncode(this.name);
     this.failureMessage = 'Successful';
   }
 
   display () {
-    return this.number + ', ' + this.name + ', ' + this.time + ', ' + (this.successful ? '1' : '0') + ', ' + this.failureMessage;
+    return this.name + ', ' + this.time + ', ' + (this.successful ? '1' : '0') + ', ' + this.failureMessage;
   }
 }
 

packages/api/lib/xunit-parser.js

@@ -0,0 +1,114 @@
+// Copyright 2020 Google LLC
+//
+// 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.
+
+const xmljs = require('xml-js');
+const TestCaseRun = require('../lib/testrun');
+
+class Parser {
+  /**
+  Parse the xunit test results, converting them to an array of testrun objects.
+  Each of these testrun objects contains whether the test passed, its name, and
+  its failure message (if failed).
+  @param xmlString - The complete xunit string of test results sent to the endpoint
+  */
+  parse (xmlString) {
+    const obj = xmljs.xml2js(xmlString, { compact: true });
+    const tests = [];
+    // Python doesn't always have a top-level testsuites element.
+    let testsuites = obj.testsuite;
+    if (testsuites === undefined) {
+      testsuites = obj.testsuites.testsuite;
+    }
+    if (testsuites === undefined) {
+      return tests;
+    }
+    // If there is only one test suite, put it into an array to make it iterable.
+    if (!Array.isArray(testsuites)) {
+      testsuites = [testsuites];
+    }
+    for (const suite of testsuites) {
+      // Ruby doesn't always have _attributes.
+      let testsuiteName = suite._attributes ? suite._attributes.name : undefined;
+
+      // Get rid of github.com/orgName/repoName/
+      testsuiteName = this.trim(testsuiteName);
+
+      let testcases = suite.testcase;
+      // If there were no tests in the package, continue.
+      if (testcases === undefined) {
+        continue;
+      }
+      // If there is only one test case, put it into an array to make it iterable.
+      if (!Array.isArray(testcases)) {
+        testcases = [testcases];
+      }
+
+      for (const testcase of testcases) {
+      // Ignore skipped tests. They didn't pass and they didn't fail.
+        if (testcase.skipped !== undefined) {
+          continue;
+        }
+
+        const failure = testcase.failure;
+        const error = testcase.error;
+
+        const okayMessage = (failure === undefined && error === undefined) ? 'ok' : 'not ok';
+        let name = testcase._attributes.name;
+
+        if (testsuiteName.length > 0) {
+          name = testsuiteName + '/' + name;
+        }
+
+        const testCaseRun = new TestCaseRun(okayMessage, name);
+
+        if (!testCaseRun.successful) {
+          // Here we must have a failure or an error.
+          let log = (failure === undefined) ? error._text : failure._text;
+          // Java puts its test logs in a CDATA element.
+          if (log === undefined) {
+            log = failure._cdata;
+          }
+
+          testCaseRun.failureMessage = log;
+        }
+
+        tests.push(testCaseRun);
+      }
+    }
+    return tests;
+  }
+
+  /**
+  The url contains 'github.com/:org/:repo', optionally followed by a path.
+  This method trims the url down to only the string following `repo`, which may be empty.
+  @param url - the Github url of where a test came from
+  */
+  trim (url) {
+    const updated = url.replace(/(.)*github.com\/[a-zA-Z-]*\/[a-zA-Z-]*/g, '');
+    if (updated.length > 1) return updated.substring(1); // Get rid of starting `/`
+    return updated;
+  }
+
+  // IMPORTANT: All values that will be used as keys in Firestore must be escaped with the firestoreEncode function
+  /**
+  Parse the build data and convert it into a JSON format that can easily be read and stored.
+  @param metadata - contains all data sent to the endpoint besides the actual test results.
+  */
+  cleanXunitBuildInfo (metadata) {
+    return {};
+  }
+}
+
+const parserHandler = new Parser();
+module.exports = parserHandler;

packages/api/package.json

@@ -33,7 +33,8 @@
     "express-session": "^1.17.1",
     "moment": "^2.27.0",
     "tap-parser": "^10.0.1",
-    "uuid": "^8.2.0"
+    "uuid": "^8.2.0",
+    "xml-js": "^1.6.11"
   },
   "devDependencies": {
     "c8": "^7.1.2",

packages/api/src/add-build.js

@@ -278,4 +278,4 @@ async function updateRepoDoc (buildInfo, computedData, mostRecent, dbRepo) {
   // db read operation to fix this. This would only be visible when ordering by priority on org page.
 }
 
-module.exports = addBuild;
+module.exports = { addBuild };

packages/api/src/post-build.js

@@ -16,9 +16,10 @@
 
 // NOTE: relies on global.headCollection to be the high level repository
 
-const addBuild = require('../src/add-build');
+const AddBuildHandler = require('../src/add-build');
 const TestCaseRun = require('../lib/testrun');
-var Parser = require('tap-parser');
+const TapParser = require('tap-parser');
+const xunitParser = require('../lib/xunit-parser');
 const Readable = require('stream').Readable;
 const firebaseEncode = require('../lib/firebase-encode');
 const { InvalidParameterError, UnauthorizedError, handleError } = require('../lib/errors');
@@ -96,7 +97,7 @@ class PostBuildHandler {
       if (typeof x.ok !== 'boolean' || !x.id || !x.name) {
         throw new InvalidParameterError('Missing All Test Case Info');
       }
-      const testcase = new TestCaseRun(x.ok ? 'ok' : 'not ok', x.id, x.name);
+      const testcase = new TestCaseRun(x.ok ? 'ok' : 'not ok', x.name);
 
       // wrap failure message generation in try so still works if ids arent sequential
       try {
@@ -121,7 +122,7 @@ class PostBuildHandler {
     switch (fileType) {
       case 'TAP': {
         var data = [];
-        var p = new Parser();
+        var p = new TapParser();
 
         p.on('result', function (assert) {
           data.push(assert);
@@ -169,7 +170,7 @@ class PostBuildHandler {
   }
 
   // IMPORTANT: All values that will be used as keys in Firestore must be escaped with the firestoreEncode function
-  static cleanBuildInfo (metadata) {
+  static cleanTapBuildInfo (metadata) {
     const timestampNumb = Date.parse(metadata.timestamp);
     const timestamp = isNaN(timestampNumb) ? new Date() : new Date(timestampNumb);
 
@@ -232,7 +233,7 @@ class PostBuildHandler {
           throw new UnauthorizedError('Flaky does not store tests for private repos');
         }
 
-        await addBuild(PostBuildHandler.removeDuplicateTestCases(testCases), buildInfo, this.client, global.headCollection);
+        await AddBuildHandler.addBuild(PostBuildHandler.removeDuplicateTestCases(testCases), buildInfo, this.client, global.headCollection);
         res.send({ message: 'successfully added build' });
       } catch (err) {
         handleError(res, err);
@@ -247,7 +248,7 @@ class PostBuildHandler {
           throw new UnauthorizedError('Flaky does not store tests for private repos');
         }
 
-        const buildInfo = PostBuildHandler.cleanBuildInfo(req.body.metadata); // Different line. The metadata object is the same as addbuild, already validated
+        const buildInfo = PostBuildHandler.cleanTapBuildInfo(req.body.metadata); // Different line. The metadata object is the same as addbuild, already validated
 
         req.body.data = await PostBuildHandler.flattenTap(req.body.data);
         const parsedRaw = await PostBuildHandler.parseRawOutput(req.body.data, req.body.type);
@@ -258,7 +259,25 @@ class PostBuildHandler {
           throw new UnauthorizedError('Must have valid Github Token to post build');
         }
 
-        await addBuild(PostBuildHandler.removeDuplicateTestCases(testCases), buildInfo, this.client, global.headCollection);
+        await AddBuildHandler.addBuild(PostBuildHandler.removeDuplicateTestCases(testCases), buildInfo, this.client, global.headCollection);
+        res.send({ message: 'successfully added build' });
+      } catch (err) {
+        handleError(res, err);
+      }
+    });
+
+    // endpoint expects the the required buildinfo to be in req.body.metadata to already exist and be properly formatted.
+    // required keys in the req.body.metadata are the inputs for addBuild in src/add-build.js
+    this.app.post('/api/build/xml', async (req, res, next) => {
+      try {
+        if (req.headers.authorization !== process.env.PRIVATE_POSTING_TOKEN) {
+          throw new UnauthorizedError('Invalid Secret. Only Google Employees may use this endpoint.');
+        }
+
+        const testCases = xunitParser.parse(req.body.data);
+        const buildInfo = xunitParser.cleanXunitBuildInfo(req.body.metadata);
+
+        await AddBuildHandler.addBuild(PostBuildHandler.removeDuplicateTestCases(testCases), buildInfo, this.client, global.headCollection);
         res.send({ message: 'successfully added build' });
       } catch (err) {
         handleError(res, err);

packages/api/test/addbuild-getbuild.js

@@ -19,7 +19,7 @@ const client = require('../src/firestore.js');
 const firebaseEncode = require('../lib/firebase-encode');
 
 const TestCaseRun = require('../lib/testrun');
-const addBuild = require('../src/add-build');
+const { addBuild } = require('../src/add-build');
 const { deleteTest, deleteRepo } = require('../lib/deleter');
 
 const fetch = require('node-fetch');
@@ -47,10 +47,10 @@ const buildInfo = [
     },
     timestamp: new Date('01/01/2000'),
     testCases: [
-      new TestCaseRun('ok', 1, 'a/1'),
-      new TestCaseRun('not ok', 2, 'a/2'),
-      new TestCaseRun('ok', 3, 'a/3'),
-      new TestCaseRun('not ok', 4, 'a/4')
+      new TestCaseRun('ok', 'a/1'),
+      new TestCaseRun('not ok', 'a/2'),
+      new TestCaseRun('ok', 'a/3'),
+      new TestCaseRun('not ok', 'a/4')
     ],
     description: 'nodejs repository',
     buildmessage: 'Workflow - 1'
@@ -70,8 +70,8 @@ const buildInfo = [
     },
     timestamp: new Date('01/01/2001'),
     testCases: [
-      new TestCaseRun('ok', 1, 'a/1'),
-      new TestCaseRun('ok', 2, 'a/2') // this test is now passing
+      new TestCaseRun('ok', 'a/1'),
+      new TestCaseRun('ok', 'a/2') // this test is now passing
     ],
     description: 'nodejs repository',
     buildmessage: 'Workflow - 2'
@@ -91,8 +91,8 @@ const buildInfo = [
     },
     timestamp: new Date('01/01/2002'),
     testCases: [
-      new TestCaseRun('not ok', 1, 'a/5'),
-      new TestCaseRun('not ok', 2, 'a/2') // this test is now failing
+      new TestCaseRun('not ok', 'a/5'),
+      new TestCaseRun('not ok', 'a/2') // this test is now failing
     ],
     description: 'None',
     buildmessage: 'Workflow - 1'
@@ -102,7 +102,7 @@ const buildInfo = [
 buildInfo[2].testCases[0].failureMessage = 'Error message';
 buildInfo[2].testCases[1].failureMessage = 'Error message';
 
-describe.only('Add-Build', () => {
+describe('Add-Build', () => {
   before(async () => {
     global.headCollection = 'testing/' + TESTING_COLLECTION_BASE + uuidv4() + '/repos'; // random collection name for concurrent testing
   });
@@ -434,8 +434,8 @@ describe.only('Add-Build', () => {
         },
         timestamp: new Date('01/01/2004'),
         testCases: [
-          new TestCaseRun('not ok', 1, 'a/5'),
-          new TestCaseRun('not ok', 2, 'a/2') // this test is now passing
+          new TestCaseRun('not ok', 'a/5'),
+          new TestCaseRun('not ok', 'a/2') // this test is now passing
         ],
         description: 'nodejs repository',
         buildmessage: 'Workflow - 42'

packages/api/test/analytics-test.js

@@ -18,7 +18,7 @@ const { v4: uuidv4 } = require('uuid');
 const client = require('../src/firestore.js');
 
 const TestCaseRun = require('../lib/testrun');
-const addBuild = require('../src/add-build');
+const { addBuild } = require('../src/add-build');
 const { deleteRepo } = require('../lib/deleter');
 
 const buildInfo = {

packages/api/test/fixtures/empty_results.xml

@@ -0,0 +1,2 @@
+<?xml version="1.0" encoding="UTF-8"?>
+<testsuites></testsuites>

packages/api/test/fixtures/go_failure_group.xml

@@ -0,0 +1,29 @@
+<?xml version="1.0" encoding="UTF-8"?>
+<testsuites>
+	<testsuite tests="18" failures="18" time="4.364" name="github.com/GoogleCloudPlatform/golang-samples/bigquery/snippets/querying">
+		<properties>
+			<property name="go.version" value="go1.13.1"></property>
+		</properties>
+		<testcase classname="querying" name="TestQueries" time="0.000">
+			<failure message="Failed" type=""></failure>
+		</testcase>
+		<testcase classname="querying" name="TestQueries/group" time="0.000">
+			<failure message="Failed" type=""></failure>
+		</testcase>
+		<testcase classname="querying" name="TestQueries/group/queryBasic" time="0.000">
+			<failure message="Failed" type=""></failure>
+		</testcase>
+		<testcase classname="querying" name="TestQueries/group/queryBatch" time="0.000">
+			<failure message="Failed" type="">panic: runtime error: invalid memory address or nil pointer dereference&#xA;/usr/local/go/src/testing/testing.go:874 +0x3a3&#xA;/usr/local/go/src/runtime/panic.go:679 +0x1b2&#xA;/go/pkg/mod/cloud.google.com/go/bigquery@v1.3.0/iterator.go:106 +0x37&#xA;/tmpfs/src/github/golang-samples/bigquery/snippets/querying/bigquery_query_legacy_large_results.go:59 +0x419&#xA;/tmpfs/src/github/golang-samples/bigquery/snippets/querying/integration_test.go:90 +0xa5&#xA;/usr/local/go/src/testing/testing.go:909 +0xc9&#xA;/usr/local/go/src/testing/testing.go:960 +0x350</failure>
+		</testcase>
+		<testcase classname="querying" name="TestQueries/group/queryDisableCache" time="0.000">
+			<failure message="Failed" type=""></failure>
+		</testcase>
+		<testcase classname="querying" name="TestQueries/group/queryDryRun" time="0.000">
+			<failure message="Failed" type=""></failure>
+		</testcase>
+		<testcase classname="querying" name="TestQueries/group/queryLegacy" time="0.000">
+			<failure message="Failed" type=""></failure>
+		</testcase>
+	</testsuite>
+</testsuites>

packages/api/test/fixtures/go_skip.xml

@@ -0,0 +1,17 @@
+<?xml version="1.0" encoding="UTF-8"?>
+<testsuites>
+	<testsuite tests="3" failures="0" time="27.297" name="github.com/GoogleCloudPlatform/golang-samples">
+		<properties>
+			<property name="go.version" value="go1.11.13"></property>
+		</properties>
+		<testcase classname="golang-samples" name="TestLicense" time="0.120"></testcase>
+	</testsuite>
+	<testsuite tests="2" failures="0" time="0.526" name="github.com/GoogleCloudPlatform/golang-samples/securitycenter/notifications">
+		<testcase classname="notifications" name="TestGetNotificationConfig" time="0.000">
+			<skipped message="notifications_test.go:162: https://github.com/GoogleCloudPlatform/golang-samples/issues/1354"></skipped>
+		</testcase>
+		<testcase classname="notifications" name="TestListNotificationConfigs" time="0.000">
+			<skipped message="notifications_test.go:186: https://github.com/GoogleCloudPlatform/golang-samples/issues/1355"></skipped>
+		</testcase>
+	</testsuite>
+</testsuites>