@toptal/davinci-qa 5.0.2-alpha-fx-2156-improve-build-performance.1302 → 5.0.2-alpha-tph-1237-github-test-results.1304

package/README.md

@@ -17,6 +17,8 @@ To run jest tests with your config file just go to the root directory of your pr
 Options:
 
 - `--setupFilesAfterEnv` - a list of paths to global configuration files for jest tests
+- `--inspect` - start test run in inspect mode, allowing the dev tools to be attached to the test runner process. Read more at [Profiling Unit Tests](https://toptal-core.atlassian.net/wiki/spaces/FE/pages/1446379739/Profiling+Unit+Tests).
+- `--tag <project-tag>` - the project name matching [Anvil's expected tag](https://github.com/toptal/anvil/blob/2ea49649db605fc06492fcf346bdb0c56fff0769/app/models/test_result.rb#L10). Used to generate Anvil Reports.
 - Any other jest option (ex. `--runInBand`)
 
 [Jest CLI docs](https://jestjs.io/docs/en/cli)

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@toptal/davinci-qa",
-  "version": "5.0.2-alpha-fx-2156-improve-build-performance.1302+4dbc440",
+  "version": "5.0.2-alpha-tph-1237-github-test-results.1304+6d6284a",
   "description": "QA package to test your application",
   "publishConfig": {
     "access": "public"
@@ -36,7 +36,7 @@
     "@cypress/webpack-preprocessor": "^5.7.0",
     "@testing-library/jest-dom": "^5.14.1",
     "@testing-library/react": "^12.0.0",
-    "@toptal/davinci-cli-shared": "1.4.2-alpha-fx-2156-improve-build-performance.1302+4dbc440",
+    "@toptal/davinci-cli-shared": "1.4.2-alpha-tph-1237-github-test-results.1304+6d6284a",
     "@types/jest": "^26.0.15",
     "babel-jest": "^26.3.0",
     "cypress": "^8.6.0",
@@ -50,5 +50,5 @@
     "matchmedia-polyfill": "^0.3.2",
     "semver": "^7.3.2"
   },
-  "gitHead": "4dbc440ef664502a9b5c91a33fe52a5602bd8a97"
+  "gitHead": "6d6284a28181286e0dab3ed19369710f62a8b7eb"
 }

package/src/commands/unit-tests.js

@@ -1,11 +1,13 @@
 const { print, files } = require('@toptal/davinci-cli-shared')
 const jest = require('jest')
+const path = require('path')
 
 const excludedFilesFromCoverage = require('../configs/excludeFilesFromCoverage')
 const styledComponentsVersionCheck = require('../utils/styled-components-version-check')
 const toJestCLIArguments = require('../utils/to-jest-cli-arguments')
+const getAbsolutePath = relativePath => path.join(__dirname, relativePath)
 
-const defaultCIJestReporters = [
+const defaultCIJestReporters = (tag) => [
   [
     'jest-silent-reporter', {
       'useDots': true,
@@ -21,11 +23,16 @@ const defaultCIJestReporters = [
     'jest-html-reporters', {
       'publicPath': './reports',
     }
+  ],
+  [
+    getAbsolutePath('../reporters/jest-anvil-reporter.js'), {
+      'tag': tag
+    }
   ]
 ]
 
 const unitTestsCommand = ({
-  options: { inspect = false, ...jestOptions } = {},
+  options: { inspect = false, tag, ...jestOptions } = {},
   files: testPathPattern = []
 }) => {
   print.green('Running unit tests...')
@@ -62,9 +69,12 @@ const unitTestsCommand = ({
 
     // to show smaller log of tests running on CI
     // and a nicer html report
-    defaultOptions.reporters = jestOptions.reporters
-      ? jestOptions.reporters
-      : defaultCIJestReporters
+    if (jestOptions.reporters) {
+      defaultOptions.reporters = jestOptions.reporters
+    } else {
+      defaultOptions.testLocationInResults = true // allows reporters to return test line number
+      defaultOptions.reporters = defaultCIJestReporters(tag)
+    }
   }
 
   const options = {
@@ -96,7 +106,12 @@ const unitTestsCommandCreator = {
     },
     {
       label:
-        'Start in the inspect mode allowing dev tools to be attached to the test runner process. Read more at https://toptal-core.atlassian.net/wiki/spaces/FE/pages/1446379739/Profiling+Unit+Tests.',
+      'the project name matching Anvil\'s expected tag. Used to generate Anvil-compatible test reports.',
+      name: '--tag <tag>'
+    },
+    {
+      label:
+      'start the test run in inspect mode, allowing dev tools to be attached to the test runner process. Read more at https://toptal-core.atlassian.net/wiki/spaces/FE/pages/1446379739/Profiling+Unit+Tests.',
       name: '--inspect'
     }
   ]

package/src/reporters/jest-anvil-reporter.js

@@ -0,0 +1,50 @@
+const { print } = require('@toptal/davinci-cli-shared')
+const fs = require('fs')
+
+class JestAnvilReporter {
+    constructor(globalConfig, options) {
+      this._globalConfig = globalConfig
+      this._options = options
+    }
+
+    onRunComplete(contexts, results) {
+        print.grey('Starting Anvil processing...')
+        console.time('Anvil reporter run')
+        const fileTestResults = results.testResults
+        const runPath = process.cwd()
+        const individualTestResults = fileTestResults.flatMap(fileTestResult => {
+            const fileName = fileTestResult.testFilePath.replace(runPath, '.')
+            return fileTestResult.testResults.map(res => ({ ...res, fileName }))
+        })
+        const anvilTestResults = individualTestResults.map(testResult => {
+            const results = {
+                file_name: testResult.fileName,
+                line_number: testResult.location.line,
+                status: testResult.status,
+                duration: testResult.duration,
+                scenario_name: testResult.ancestorTitles.concat(testResult.title).join('/'),
+                description: testResult.title,
+                error: testResult.failureDetails.length > 0 ? testResult.failureDetails[0].message : null,
+                backtrace: testResult.failureDetails.length > 0 ? testResult.failureDetails[0].stack : null,
+            }
+            if (this._options.tag) {
+                results['tag'] = this._options.tag
+            }
+            return results
+        })
+        const anvilPayload = {
+            "test_results": [
+                anvilTestResults
+            ]
+        }
+        fs.writeFileSync('./anvil_test_results.json', JSON.stringify(anvilPayload, undefined, 2), err => {
+            if (err) {
+                print.red('Failed to create anvil test results', err)
+                throw err
+            }
+        })
+        console.timeEnd('Anvil reporter run')
+    }
+}
+  
+module.exports = JestAnvilReporter

package/src/reporters/mocks.js

@@ -0,0 +1,111 @@
+SUCCESS = {
+    numFailedTestSuites: 0,
+    numFailedTests: 0,
+    numPassedTestSuites: 3,
+    numPassedTests: 13,
+    numPendingTestSuites: 0,
+    numPendingTests: 0,
+    numRuntimeErrorTestSuites: 0,
+    numTodoTests: 0,
+    numTotalTestSuites: 3,
+    numTotalTests: 13,
+    openHandles: [
+    ],
+    snapshot: {
+      added: 0,
+      didUpdate: false,
+      failure: false,
+      filesAdded: 0,
+      filesRemoved: 0,
+      filesRemovedList: [
+      ],
+      filesUnmatched: 0,
+      filesUpdated: 0,
+      matched: 0,
+      total: 0,
+      unchecked: 0,
+      uncheckedKeysByFile: [
+      ],
+      unmatched: 0,
+      updated: 0,
+    },
+    startTime: 1635357418106,
+    success: false,
+    testResults: [
+      {
+        leaks: false,
+        numFailingTests: 0,
+        numPassingTests: 6,
+        numPendingTests: 0,
+        numTodoTests: 0,
+        openHandles: [
+        ],
+        perfStats: {
+          end: 1635357420742,
+          runtime: 1193,
+          slow: false,
+          start: 1635357419549,
+        },
+        skipped: false,
+        snapshot: {
+          added: 0,
+          fileDeleted: false,
+          matched: 0,
+          unchecked: 0,
+          unmatched: 0,
+          updated: 0,
+          uncheckedKeys: [
+          ],
+        },
+        testFilePath: "./packages/qa/src/utils/styled-components-version-check.test.js",
+        testResults: [
+          {
+            ancestorTitles: [
+              "styled-components version check",
+              "has wrong (^4.4.1) SC version in dependencies",
+            ],
+            duration: 7,
+            failureDetails: [
+            ],
+            failureMessages: [
+            ],
+            fullName: "styled-components version check has wrong (^4.4.1) SC version in dependencies should throw an error",
+            location: {
+              column: 4,
+              line: 44,
+            },
+            numPassingAsserts: 0,
+            status: "passed",
+            title: "should throw an error",
+          },
+          {
+            ancestorTitles: [
+              "styled-components version check",
+              "has correct (^5.0.1) SC version in dependencies",
+            ],
+            duration: 1,
+            failureDetails: [
+            ],
+            failureMessages: [
+            ],
+            fullName: "styled-components version check has correct (^5.0.1) SC version in dependencies should NOT throw an error",
+            location: {
+              column: 4,
+              line: 50,
+            },
+            numPassingAsserts: 0,
+            status: "passed",
+            title: "should NOT throw an error",
+          },
+        ],
+        console: undefined,
+        failureMessage: null,
+        displayName: undefined,
+        sourceMaps: undefined,
+        coverage: undefined,
+      }
+    ],
+    wasInterrupted: false,
+}
+
+module.exports = SUCCESS