@toptal/davinci-qa 6.0.2 → 7.0.1-alpha-chore-add-parallelization-to-unit-tests.7

package/CHANGELOG.md

@@ -1,5 +1,17 @@
 # Change Log
 
+## 7.0.0
+
+### Major Changes
+
+- [#1224](https://github.com/toptal/davinci/pull/1224) [`caf0ee02`](https://github.com/toptal/davinci/commit/caf0ee027107be2acf0315deed33ef89d34f6b69) Thanks [@rafael-anachoreta](https://github.com/rafael-anachoreta)! - ---
+
+  ### Anvil reporter
+
+  - Add Anvil test mapper
+  - Add Anvil reporter to Cypress
+  - Update Jest Anvil reporter to use new mapper
+
 ## 6.0.2
 
 ### Patch Changes

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@toptal/davinci-qa",
-  "version": "6.0.2",
+  "version": "7.0.1-alpha-chore-add-parallelization-to-unit-tests.7+62642e12",
   "description": "QA package to test your application",
   "publishConfig": {
     "access": "public"
@@ -37,10 +37,11 @@
     "@cypress/webpack-preprocessor": "^5.7.0",
     "@testing-library/jest-dom": "^5.14.1",
     "@testing-library/react": "^12.1.2",
-    "@toptal/davinci-cli-shared": "1.5.1",
+    "@toptal/davinci-cli-shared": "1.5.2-alpha-chore-add-parallelization-to-unit-tests.58+62642e12",
     "@types/jest": "^27.4.1",
     "babel-jest": "^27.5.1",
     "cypress": "^9.4.1",
+    "enhanced-resolve": "^5.9.2",
     "fs-extra": "^10.0.0",
     "glob": "^7.2.0",
     "jest": "^27.5.1",
@@ -50,7 +51,10 @@
     "jest-styled-components": "^7.0.8",
     "jsdom": "^19.0.0",
     "matchmedia-polyfill": "^0.3.2",
-    "semver": "^7.3.2",
-    "enhanced-resolve": "^5.9.2"
-  }
+    "semver": "^7.3.2"
+  },
+  "devDependencies": {
+    "mocha": "^9.2.2"
+  },
+  "gitHead": "62642e124f62c12a3d5c6c967b7ad66e4836d8e1"
 }

package/src/commands/end-to-end-tests.js

@@ -6,11 +6,7 @@ const {
 } = require('@toptal/davinci-cli-shared')
 
 const endToEndTestCommand = ({
-  options: {
-    open = false,
-    baseUrl,
-    ...cypressOptions
-  } = {},
+  options: { open = false, baseUrl, anvilTag, ...cypressOptions } = {},
   files: testFiles = []
 }) => {
   print.green('Running end to end tests...')
@@ -19,6 +15,10 @@ const endToEndTestCommand = ({
     '@toptal/davinci-qa',
     'src/configs/cypress.config.json'
   )
+  const cypressReporterPath = files.getPackageFilePath(
+    '@toptal/davinci-qa',
+    'src/reporters/cypress-anvil-reporter.js'
+  )
 
   const mode = open ? 'open' : 'run'
 
@@ -29,6 +29,14 @@ const endToEndTestCommand = ({
     configPath,
     ...testFiles,
     ...(baseUrl ? ['--config', `baseUrl=${baseUrl}`] : []),
+    ...(!open && anvilTag
+      ? [
+          '--reporter',
+          cypressReporterPath,
+          '--reporter-options',
+          `anvilTag=${anvilTag}`
+        ]
+      : []),
     ...convertToCLIParameters(cypressOptions)
   ])
 }
@@ -45,8 +53,13 @@ const endToEndCommandCreator = {
       name: '--open'
     },
     {
-      label: 'opens the Cypress Test Runner',
+      label: "URL used as prefix for cy.visit() or cy.request() command's URL",
       name: '--baseUrl <baseUrl>'
+    },
+    {
+      label:
+        "the project name matching Anvil's expected tag to generate Anvil Reports",
+      name: '--anvilTag <anvilTag>'
     }
   ]
 }

package/src/commands/unit-tests.js

@@ -9,37 +9,44 @@ const getRootProjectPath = relativePath => path.join(__dirname, relativePath)
 
 const defaultCIJestReporters = anvilTag => [
   [
-    'jest-silent-reporter', {
-      'useDots': true,
-      'showPaths': true,
-      'showWarnings': true
+    'jest-silent-reporter',
+    {
+      useDots: true,
+      showPaths: true,
+      showWarnings: true
     }
   ],
   [
-    'jest-junit', {
-      'outputDirectory': 'reports'
+    'jest-junit',
+    {
+      outputDirectory: 'reports'
     }
   ],
   [
-    'jest-html-reporters', {
-      'publicPath': './reports',
+    'jest-html-reporters',
+    {
+      publicPath: './reports'
     }
   ],
   [
-    getRootProjectPath('../reporters/jest-anvil-reporter.js'), {
-      'anvilTag': anvilTag
+    getRootProjectPath('../reporters/jest-anvil-reporter.js'),
+    {
+      anvilTag: anvilTag
     }
   ]
 ]
 
 const unitTestsCommand = ({
-  options: { inspect = false, anvilTag, ...jestOptions } = {},
+  options: { anvilTag, ...jestOptions } = {},
   files: testPathPattern = []
 }) => {
   print.green('Running unit tests...')
 
   const currentRunningDir = process.cwd()
-  const jestConfigPath = files.getPackageFilePath('@toptal/davinci-qa', 'src/configs/jest.config.js')
+  const jestConfigPath = files.getPackageFilePath(
+    '@toptal/davinci-qa',
+    'src/configs/jest.config.js'
+  )
   const packageJson = files.getProjectRootFileContent('./package.json')
 
   try {
@@ -56,8 +63,10 @@ const unitTestsCommand = ({
 
   if (isCi) {
     const hasCustomConfig = Boolean(jestOptions.config)
-    const jestProjectConfig = hasCustomConfig && files.getProjectRootFileContent(jestOptions.config)
-    const isConfigFileHasCollectCoverageFrom = hasCustomConfig && jestProjectConfig.collectCoverageFrom
+    const jestProjectConfig =
+      hasCustomConfig && files.getProjectRootFileContent(jestOptions.config)
+    const isConfigFileHasCollectCoverageFrom =
+      hasCustomConfig && jestProjectConfig.collectCoverageFrom
 
     defaultOptions.coverage = true
     defaultOptions.coverageDirectory = 'coverage'
@@ -75,13 +84,17 @@ const unitTestsCommand = ({
     // Override order: CLI options -> reporters on jest.config -> Davinci defaults
     if (jestOptions.reporters) {
       defaultOptions.reporters = jestOptions.reporters
-    } 
-    else if (jestProjectConfig?.reporters) {
+    } else if (jestProjectConfig?.reporters) {
       defaultOptions.reporters = jestProjectConfig.reporters
     } else {
       defaultOptions.testLocationInResults = true // allows reporters to return test line number
       defaultOptions.reporters = defaultCIJestReporters(anvilTag)
     }
+
+    defaultOptions.maxWorkers = 1
+    defaultOptions.runInBand = false
+    defaultOptions.testSequencer =
+      './node_modules/@toptal/davinci-qa/src/configs/jest/parallel-ci-sequencer.js'
   }
 
   const options = {
@@ -91,14 +104,15 @@ const unitTestsCommand = ({
 
   print.grey('Jest arguments:', options)
 
-  return jest.runCLI(options, [currentRunningDir])
-    .then(jestResult => {
-      if (jestResult.results.success) {
-        return
-      }
+  return jest.runCLI(options, [currentRunningDir]).then(jestResult => {
+    if (jestResult.results.success) {
+      return
+    }
 
-      process.exit(1)
-    })
+    process.exit(1)
+
+    return
+  })
 }
 
 const unitTestsCommandCreator = {
@@ -113,13 +127,8 @@ const unitTestsCommandCreator = {
     },
     {
       label:
-      'the project name matching Anvil\'s expected tag. Used to generate Anvil-compatible test reports.',
+        "the project name matching Anvil's expected tag. Used to generate Anvil-compatible test reports.",
       name: '--anvilTag <anvilTag>'
-    },
-    {
-      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/configs/jest/parallel-ci-sequencer.js

@@ -0,0 +1,36 @@
+// eslint-disable-next-line import/no-extraneous-dependencies
+const Sequencer = require('@jest/test-sequencer').default
+
+const sortByPath = (test1, test2) => {
+  return test1.path - test2.path
+}
+
+class ParallelCISequencer extends Sequencer {
+  constructor() {
+    super()
+    this.ciNodeIndex = Number(process.env.GROUP_INDEX || '1')
+    this.ciNodeTotal = Number(process.env.GROUP_TOTAL || '1')
+  }
+
+  sort(tests) {
+    const sortedTests = [...tests].sort(sortByPath)
+    const testsForThisRunner = this.distributeAcrossCINodes(sortedTests)
+
+    console.log(`CI_NODE_INDEX: ${this.ciNodeIndex}`)
+    console.log(`CI_NODE_TOTAL: ${this.ciNodeTotal}`)
+    console.log(`Total number of tests: ${tests.length}`)
+    console.log(
+      `Total number of tests for this runner: ${testsForThisRunner.length}`
+    )
+
+    return testsForThisRunner
+  }
+
+  distributeAcrossCINodes(tests) {
+    return tests.filter((test, index) => {
+      return index % this.ciNodeTotal === this.ciNodeIndex - 1
+    })
+  }
+}
+
+module.exports = ParallelCISequencer

package/src/reporters/anvil-results-helper.js

@@ -0,0 +1,46 @@
+const { print } = require('@toptal/davinci-cli-shared')
+const fs = require('fs-extra')
+
+const anvilMapper = ({
+  fileName,
+  lineNumber,
+  status,
+  durationInSeconds,
+  scenarioName,
+  description,
+  error,
+  backtrace,
+  testType,
+  pendingMessage,
+  tag
+}) => ({
+  file_name: fileName,
+  line_number: lineNumber,
+  status: status === 'todo' ? 'pending' : status,
+  duration: durationInSeconds,
+  scenario_name: scenarioName,
+  description,
+  error,
+  backtrace,
+  test_type: testType,
+  pending_message: pendingMessage,
+  tag
+})
+
+const generateAnvilResults = (fileName, testResults) => {
+  const reportPath = './reports'
+
+  try {
+    fs.ensureDirSync(reportPath)
+    fs.writeJsonSync(`${reportPath}/${fileName}`, testResults)
+    print.green('[anvil-reporter] Anvil reports generated successfully!')
+  } catch (err) {
+    print.red('[anvil-reporter] Failed to create Anvil test results!', err)
+    throw err
+  }
+}
+
+module.exports = {
+  anvilMapper,
+  generateAnvilResults
+}

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

@@ -0,0 +1,121 @@
+const { print } = require('@toptal/davinci-cli-shared')
+const { Runner, reporters } = require('mocha')
+
+const { anvilMapper, generateAnvilResults } = require('./anvil-results-helper')
+
+const { Spec, Base } = reporters
+const {
+  EVENT_RUN_END,
+  EVENT_TEST_FAIL,
+  EVENT_TEST_PASS,
+  EVENT_TEST_PENDING,
+  EVENT_TEST_RETRY
+} = Runner.constants
+
+class CypressAnvilReporter extends Base {
+  constructor(runner, options) {
+    super(runner, options)
+    const tests = []
+    const joinParentTitles = obj =>
+      obj?.parent?.title
+        ? `${joinParentTitles(obj.parent)}/${obj.title}`
+        : obj.title
+
+    // Spec is Cypress's default reporter, but it misses retries
+    this._specReporter = new Spec(
+      runner.on(EVENT_TEST_RETRY, test => {
+        print.yellow(
+          `(Attempt ${test?.currentRetry + 1} of ${test?.retries}) ${
+            test?.title
+          }`
+        )
+      }),
+      options
+    )
+
+    const anvilTag = options?.reporterOptions?.anvilTag
+
+    if (!anvilTag) {
+      print.yellow(
+        "[anvil-reporter] --anvilTag option is missing! anvil_cypress_test_results.json won't be generated."
+      )
+    } else {
+      runner
+        .on(EVENT_TEST_PASS, test => {
+          tests.push(
+            anvilMapper({
+              fileName: test?.invocationDetails?.absoluteFile,
+              lineNumber: test?.invocationDetails?.line,
+              status: test?.state,
+              durationInSeconds: test?.duration / 1000,
+              scenarioName: joinParentTitles(test),
+              description: test?.title,
+              error: test?.err?.message || null,
+              backtrace: test?.err?.stack || null,
+              testType: 'integration',
+              pendingMessage: null,
+              tag: anvilTag
+            })
+          )
+        })
+        .on(EVENT_TEST_FAIL, test => {
+          tests.push(
+            anvilMapper({
+              fileName: test?.invocationDetails?.absoluteFile,
+              lineNumber: test?.invocationDetails?.line,
+              status: test?.state,
+              durationInSeconds: test?.duration / 1000,
+              scenarioName: joinParentTitles(test),
+              description: test?.title,
+              error: test?.err?.message || null,
+              backtrace: test?.err?.stack || null,
+              testType: 'integration',
+              pendingMessage: null,
+              tag: anvilTag
+            })
+          )
+        })
+        .on(EVENT_TEST_PENDING, test => {
+          tests.push(
+            anvilMapper({
+              fileName: test?.invocationDetails?.absoluteFile,
+              lineNumber: test?.invocationDetails?.line,
+              status: test?.state,
+              durationInSeconds: 0,
+              scenarioName: joinParentTitles(test),
+              description: test?.title,
+              error: test?.err?.message || null,
+              backtrace: test?.err?.stack || null,
+              testType: 'integration',
+              pendingMessage: null,
+              tag: anvilTag
+            })
+          )
+        })
+        .on(EVENT_TEST_RETRY, test => {
+          tests.push(
+            anvilMapper({
+              fileName: test?.invocationDetails?.absoluteFile,
+              lineNumber: test?.invocationDetails?.line,
+              status: 'retried',
+              durationInSeconds: test?.duration / 1000,
+              scenarioName: joinParentTitles(test),
+              description: test?.title,
+              error: test?.err?.message || null,
+              backtrace: test?.err?.stack || null,
+              testType: 'integration',
+              pendingMessage: null,
+              tag: anvilTag
+            })
+          )
+        })
+        .once(EVENT_RUN_END, () => {
+          generateAnvilResults('anvil_cypress_test_results.json', {
+            test_results: tests
+          })
+        })
+    }
+  }
+}
+
+module.exports = CypressAnvilReporter

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

@@ -1,52 +1,61 @@
 const { print } = require('@toptal/davinci-cli-shared')
-const fs = require('fs')
+
+const { anvilMapper, generateAnvilResults } = require('./anvil-results-helper')
 
 class JestAnvilReporter {
-    constructor(globalConfig, options) {
-      this._globalConfig = globalConfig
-      this._options = options
-    }
+  constructor(globalConfig, options) {
+    this._globalConfig = globalConfig
+    this._options = options
+  }
+
+  onRunComplete(contexts, results) {
+    print.grey('Starting Anvil reporter 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 }))
+    })
 
-    onRunComplete(contexts, results) {
-        print.grey('Starting Anvil reporter 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 anvilResults = {
-                file_name: testResult.fileName,
-                line_number: testResult.location && testResult.location.line,
-                status: testResult.status === 'todo' ? 'pending' : 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.map(failure => failure.stack) : null,
-                test_type: 'unit',
-                pending_message: null
-            }
-            if (this._options && this._options.anvilTag) {
-                anvilResults['tag'] = this._options.anvilTag
-            }
-            return anvilResults
-        })
-        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')
+    if (!this?._options?.anvilTag) {
+      print.yellow(
+        'Missing --anvilTag value! Anvil test results will be skipped.'
+      )
+
+      return
+    }
+    const anvilTestResults = individualTestResults.map(testResult => {
+      return anvilMapper({
+        fileName: testResult.fileName,
+        lineNumber: testResult.location && testResult.location.line,
+        status: testResult.status,
+        durationInSeconds: testResult.duration / 1000,
+        scenarioName: 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.map(failure => failure.stack)
+            : null,
+        testType: 'unit',
+        pendingMessage: null,
+        tag: this._options.anvilTag
+      })
+    })
+    const anvilPayload = {
+      test_results: [...anvilTestResults]
     }
+
+    generateAnvilResults('anvil_jest_test_results.json', anvilPayload)
+    console.timeEnd('Anvil reporter run')
+  }
 }
-  
+
 module.exports = JestAnvilReporter

package/dist-package/package.json

@@ -1,56 +0,0 @@
-{
-  "name": "@toptal/davinci-qa",
-  "version": "6.0.2",
-  "description": "QA package to test your application",
-  "publishConfig": {
-    "access": "public"
-  },
-  "keywords": [
-    "qa",
-    "testing"
-  ],
-  "author": "Toptal",
-  "homepage": "https://github.com/toptal/davinci/tree/master/packages/qa#readme",
-  "license": "ISC",
-  "bin": {
-    "davinci-qa": "./bin/davinci-qa.js"
-  },
-  "main": "./src/index.js",
-  "repository": {
-    "type": "git",
-    "url": "git+https://github.com/toptal/davinci.git"
-  },
-  "scripts": {
-    "build:package": "../../bin/build-package.js",
-    "prepublishOnly": "../../bin/prepublish.js",
-    "test": "echo \"Error: run tests from root\" && exit 1"
-  },
-  "bugs": {
-    "url": "https://github.com/toptal/davinci/issues"
-  },
-  "dependencies": {
-    "@babel/core": "^7.14.8",
-    "@babel/preset-env": "^7.16.4",
-    "@babel/preset-react": "^7.10.4",
-    "@babel/preset-typescript": "^7.10.4",
-    "@cypress/code-coverage": "^3.9.12",
-    "@cypress/webpack-preprocessor": "^5.7.0",
-    "@testing-library/jest-dom": "^5.14.1",
-    "@testing-library/react": "^12.1.2",
-    "@toptal/davinci-cli-shared": "1.5.1",
-    "@types/jest": "^27.4.1",
-    "babel-jest": "^27.5.1",
-    "cypress": "^9.4.1",
-    "fs-extra": "^10.0.0",
-    "glob": "^7.2.0",
-    "jest": "^27.5.1",
-    "jest-html-reporters": "^3.0.6",
-    "jest-junit": "^13.1.0",
-    "jest-silent-reporter": "^0.5.0",
-    "jest-styled-components": "^7.0.8",
-    "jsdom": "^19.0.0",
-    "matchmedia-polyfill": "^0.3.2",
-    "semver": "^7.3.2",
-    "enhanced-resolve": "^5.9.2"
-  }
-}

package/src/commands/end-to-end-tests.test.js

@@ -1,65 +0,0 @@
-const convertToCLIParametersMock = jest.fn()
-const getPackageFilePathMock = jest.fn()
-
-jest.mock('@toptal/davinci-cli-shared', () => ({
-  runSync: jest.fn(),
-  print: {
-    green: jest.fn()
-  },
-  convertToCLIParameters: convertToCLIParametersMock,
-  files: {
-    getPackageFilePath: getPackageFilePathMock
-  }
-}))
-
-const { runSync } = require('@toptal/davinci-cli-shared')
-
-const { action } = require('./end-to-end-tests')
-
-describe('endToEndTestCommand', () => {
-  it('runs cypress with default options', () => {
-    convertToCLIParametersMock.mockReturnValueOnce([])
-    getPackageFilePathMock.mockReturnValueOnce('packages/qa/src/configs/cypress.config.json')
-
-    action({ options: {} })
-
-    expect(runSync).toHaveBeenCalledWith('yarn', [
-      'cypress',
-      'run',
-      '--config-file',
-      'packages/qa/src/configs/cypress.config.json'
-    ])
-
-    expect(convertToCLIParametersMock).toHaveBeenCalledWith({})
-    expect(getPackageFilePathMock).toHaveBeenCalledWith(
-      '@toptal/davinci-qa',
-      'src/configs/cypress.config.json'
-    )
-  })
-
-  it('runs cypress with custom options', () => {
-    const spec = 'cypress/integration/activation_flow.spec.ts'
-
-    convertToCLIParametersMock.mockReturnValueOnce(['--spec', spec])
-    getPackageFilePathMock.mockReturnValueOnce('packages/qa/src/configs/cypress.config.json')
-
-    action({ options: { spec } })
-
-    expect(runSync).toHaveBeenCalledWith('yarn', [
-      'cypress',
-      'run',
-      '--config-file',
-      'packages/qa/src/configs/cypress.config.json',
-      '--spec',
-      spec
-    ])
-
-    expect(convertToCLIParametersMock).toHaveBeenCalledWith({
-      spec
-    })
-    expect(getPackageFilePathMock).toHaveBeenCalledWith(
-      '@toptal/davinci-qa',
-      'src/configs/cypress.config.json'
-    )
-  })
-})

package/src/commands/unit-tests.test.js

@@ -1,164 +0,0 @@
-const jestRunCLIMock =jest.fn().mockResolvedValue({ results: {success: true}})
-const getPackageFilePathMock = jest.fn()
-const getProjectRootFilePathMock = jest.fn()
-const getProjectRootFileContentMock = jest.fn().mockReturnValue({
-  devDependencies: {}, dependencies: {}, 
-})
-
-jest.mock('@toptal/davinci-cli-shared', () => ({
-  runSync: jest.fn(),
-  print: {
-    green: jest.fn(),
-    grey: jest.fn(),
-    red: jest.fn(),
-  },
-  files: {
-    getPackageFilePath: getPackageFilePathMock,
-    getProjectRootFileContent: getProjectRootFileContentMock,
-    getProjectRootFilePath: getProjectRootFilePathMock
-  }
-}))
-
-jest.mock('jest', () => ({
-  runCLI: jestRunCLIMock
-}))
-
-const { action } = require('./unit-tests')
-const originalEnv = process.env
-
-beforeEach(() => {
-  jest.clearAllMocks()
-})
-
-afterEach(() => {
-  process.env = originalEnv
-})
-
-describe('unitTestsCommand', () => {
-  describe('when running locally', () => {
-    beforeEach(() => {
-      delete process.env.CI
-    })
-
-    it('calls the jest CLI without additional reporters', async () => {
-      const davinciJestConfigPath = 'packages/qa/src/configs/jest.config.js'
-      getPackageFilePathMock.mockReturnValueOnce(davinciJestConfigPath)
-  
-      await action({})
-      
-      expect(jestRunCLIMock).toBeCalledWith(
-        {"config": davinciJestConfigPath, "testPathPattern": []},
-        expect.anything()
-      )
-    })
-  
-  })
-
-  describe('when running on CI', () => {
-    beforeEach(() => {
-      process.env.CI = true
-    })
-
-    it('calls the jest CLI with default Davinci reporters', async () => {
-      const davinciJestConfigPath = 'packages/qa/src/configs/jest.config.js'
-      getPackageFilePathMock.mockReturnValueOnce(davinciJestConfigPath)
-  
-      await action({})
-      
-      expect(jestRunCLIMock).toBeCalledWith(
-        expect.objectContaining({
-          reporters: [
-            [
-              "jest-silent-reporter",
-              {
-                useDots: true,
-                showPaths: true,
-                showWarnings: true,
-              },
-            ],
-            [
-              "jest-junit",
-              {
-                outputDirectory: "reports",
-              },
-            ],
-            [
-              "jest-html-reporters",
-              {
-                publicPath: "./reports",
-              },
-            ],
-            [
-              expect.stringContaining("davinci/packages/qa/src/reporters/jest-anvil-reporter.js"),
-              {
-                anvilTag: undefined,
-              },
-            ],
-          ],
-        }),
-        expect.anything()
-      )
-    })
-  
-    it('allows overriding of the default Davinci reporters via custom configuration', async () => {
-      const davinciJestConfigPath = 'packages/qa/src/configs/jest.config.js'
-      getPackageFilePathMock.mockReturnValueOnce(davinciJestConfigPath)
-      const customCLIReporter = 'My-CLI-Reporter'
-  
-      await action({ 
-        options: { 
-          anvilTag: 'MyTag',
-          reporters: customCLIReporter
-        }
-      })
-      
-      expect(jestRunCLIMock).toBeCalledWith(
-        expect.objectContaining({
-          reporters: [customCLIReporter],
-        }),
-        expect.anything()
-      )
-    })
-  
-    it('allows overriding the default Davinci reporters via custom jest config', async () => {
-      const davinciJestConfigPath = 'packages/qa/src/configs/jest.config.js'
-      getPackageFilePathMock.mockReturnValueOnce(davinciJestConfigPath)
-      const customJestConfigReporter = 'My-Jest-Config-Reporter'
-  
-      getProjectRootFileContentMock.mockReturnValue({reporters: customJestConfigReporter})
-
-      await action({ options: { config: {}}})
-      
-      expect(jestRunCLIMock).toBeCalledWith(
-        expect.objectContaining({
-          reporters: [customJestConfigReporter],
-        }),
-        expect.anything()
-      )
-    })
-  
-    it('prioritizes the CLI reporters over the custom jest config or the default Davinci reporters', async () => {
-      const davinciJestConfigPath = 'packages/qa/src/configs/jest.config.js'
-      getPackageFilePathMock.mockReturnValueOnce(davinciJestConfigPath)
-      const customCLIReporter = 'My-CLI-Reporter'
-      const customJestConfigReporter = 'My-Jest-Config-Reporter'
-  
-      getProjectRootFileContentMock.mockReturnValue({ reporters: customJestConfigReporter })
-      
-      await action({ 
-        options: { 
-          anvilTag: 'MyTag',
-          reporters: customCLIReporter,
-          config: {}
-        }
-      })
-      
-      expect(jestRunCLIMock).toBeCalledWith(
-        expect.objectContaining({
-          reporters: [customCLIReporter],
-        }),
-        expect.anything()
-      )
-    })
-  })
-})

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

@@ -1,145 +0,0 @@
-const JestAnvilReporter = require('./jest-anvil-reporter.js')
-const fs = require('fs')
-const {
-  passedTestResults,
-  failedTestResults,
-  skippedTestResults,
-  combinedTestResults,
-  toDoTestResults
-} = require('./test-result-mocks')
-
-describe('Jest Anvil reporter', () => {
-  const expectedPassedTestResults = {
-    test_results: [
-      {
-        file_name: "/davinci/packages/qa/src/reporters/jest-anvil-reporter-mocker.test.js",
-        line_number: 2,
-        status: "passed",
-        duration: 3,
-        scenario_name: "Example test suite/1 + 1 returns 2",
-        description: "1 + 1 returns 2",
-        error: null,
-        backtrace: null,
-        test_type: "unit",
-        pending_message: null,
-        tag: "platform"
-      }
-    ]
-  }
-  
-  const expectedFailedTestResults = {
-    test_results: [
-      {
-        file_name: "/davinci/packages/qa/src/reporters/jest-anvil-reporter-mocker.test.js",
-        line_number: 2,
-        status: "failed",
-        duration: 6,
-        scenario_name: "Example test suite/1 + 1 returns 3",
-        description: "1 + 1 returns 3",
-        error: "Error: \u001b[2mexpect(\u001b[22m\u001b[31mreceived\u001b[39m\u001b[2m).\u001b[22mtoBe\u001b[2m(\u001b[22m\u001b[32mexpected\u001b[39m\u001b[2m) // Object.is equality\u001b[22m\n\nExpected: \u001b[32m3\u001b[39m\nReceived: \u001b[31m2\u001b[39m",
-        backtrace: ["Error: \u001b[2mexpect(\u001b[22m\u001b[31mreceived\u001b[39m\u001b[2m).\u001b[22mtoBe\u001b[2m(\u001b[22m\u001b[32mexpected\u001b[39m\u001b[2m) // Object.is equality\u001b[22m\n\nExpected: \u001b[32m3\u001b[39m\nReceived: \u001b[31m2\u001b[39m\n    at Object.<anonymous> (/davinci/packages/qa/src/reporters/jest-anvil-reporter-mocker.test.js:3:17)\n    at Object.asyncJestTest (/davinci/node_modules/jest-jasmine2/build/jasmineAsyncInstall.js:106:37)\n    at /davinci/node_modules/jest-jasmine2/build/queueRunner.js:45:12\n    at new Promise (<anonymous>)\n    at mapper (/davinci/node_modules/jest-jasmine2/build/queueRunner.js:28:19)\n    at /davinci/node_modules/jest-jasmine2/build/queueRunner.js:75:41"],
-        test_type: "unit",
-        pending_message: null,
-        tag: "platform"
-      }
-    ]
-  }
-
-  const expectedSkippedTestResults = {
-    test_results: [
-      {
-        file_name: "/davinci/packages/qa/src/reporters/jest-anvil-reporter-mocker.test.js",
-        line_number: 2,
-        status: "pending",
-        duration: 0,
-        scenario_name: "Example test suite/1 + 1 returns 2",
-        description: "1 + 1 returns 2",
-        error: null,
-        backtrace: null,
-        test_type: "unit",
-        pending_message: null,
-        tag: "platform"
-      }
-    ]
-  }
-
-  const expectedToDoTestResults = {
-    test_results: [
-      {
-        file_name: "/davinci/packages/qa/src/reporters/jest-anvil-reporter-mocker.test.js",
-        line_number: null,
-        status: "pending",
-        duration: 0,
-        scenario_name: "Example test suite/1+1 returns 2",
-        description: "1+1 returns 2",
-        error: null,
-        backtrace: null,
-        test_type: "unit",
-        pending_message: null,
-        tag: "platform"
-      }
-    ]
-  }
-
-  const expectedCombinedTestResults = {
-    test_results: [
-      {
-        file_name: "/davinci/packages/qa/src/reporters/jest-anvil-reporter-mocker.test.js",
-        line_number: 2,
-        status: "passed",
-        duration: 5,
-        scenario_name: "Example test suite/1 + 1 returns 2 (passed)",
-        description: "1 + 1 returns 2 (passed)",
-        error: null,
-        backtrace: null,
-        test_type: "unit",
-        pending_message: null,
-        tag: "platform"
-      },
-      {
-        file_name: "/davinci/packages/qa/src/reporters/jest-anvil-reporter-mocker.test.js",
-        line_number: 6,
-        status: "failed",
-        duration: 7,
-        scenario_name: "Example test suite/1 + 1 returns 3 (failed)",
-        description: "1 + 1 returns 3 (failed)",
-        error: "Error: \u001b[2mexpect(\u001b[22m\u001b[31mreceived\u001b[39m\u001b[2m).\u001b[22mtoBe\u001b[2m(\u001b[22m\u001b[32mexpected\u001b[39m\u001b[2m) // Object.is equality\u001b[22m\n\nExpected: \u001b[32m3\u001b[39m\nReceived: \u001b[31m2\u001b[39m",
-        backtrace: ["Error: \u001b[2mexpect(\u001b[22m\u001b[31mreceived\u001b[39m\u001b[2m).\u001b[22mtoBe\u001b[2m(\u001b[22m\u001b[32mexpected\u001b[39m\u001b[2m) // Object.is equality\u001b[22m\n\nExpected: \u001b[32m3\u001b[39m\nReceived: \u001b[31m2\u001b[39m\n    at Object.<anonymous> (/davinci/packages/qa/src/reporters/jest-anvil-reporter-mocker.test.js:7:17)\n    at Object.asyncJestTest (/davinci/node_modules/jest-jasmine2/build/jasmineAsyncInstall.js:106:37)\n    at /davinci/node_modules/jest-jasmine2/build/queueRunner.js:45:12\n    at new Promise (<anonymous>)\n    at mapper (/davinci/node_modules/jest-jasmine2/build/queueRunner.js:28:19)\n    at /davinci/node_modules/jest-jasmine2/build/queueRunner.js:75:41"],
-        test_type: "unit",
-        pending_message: null,
-        tag: "platform"
-      },
-      {
-        file_name: "/davinci/packages/qa/src/reporters/jest-anvil-reporter-mocker.test.js",
-        line_number: 10,
-        status: "pending",
-        duration: 0,
-        scenario_name: "Example test suite/1 + 1 returns 2 (skipped)",
-        description: "1 + 1 returns 2 (skipped)",
-        error: null,
-        backtrace: null,
-        test_type: "unit",
-        pending_message: null,
-        tag: "platform"
-      }
-    ]
-  }
-
-  beforeEach(() => {
-    jest.clearAllMocks();
-  });
-
-  test.each`
-    input                   | expectedOutput                  | testType
-    ${passedTestResults}    | ${expectedPassedTestResults}    | ${"passing tests"}
-    ${failedTestResults}    | ${expectedFailedTestResults}    | ${"failing tests"}
-    ${skippedTestResults}   | ${expectedSkippedTestResults}   | ${"skipped tests"}
-    ${toDoTestResults}      | ${expectedToDoTestResults}      | ${"todo tests"}
-    ${combinedTestResults}  | ${expectedCombinedTestResults}  | ${"a combination of test results"}
-  `('returns a payload matching Anvil for $testType', ({ input, expectedOutput, testType }) => {
-    const spy = jest.spyOn(fs, 'writeFileSync')
-    const jestAnvilReporter = new JestAnvilReporter(undefined, { anvilTag: 'platform' })
-    jestAnvilReporter.onRunComplete(undefined, input)
-    expect(spy).toBeCalledWith("./anvil_test_results.json", JSON.stringify(expectedOutput, undefined, 2), expect.anything())
-  })
-})

package/src/utils/jest-args-to-cli-converters.test.js

@@ -1,59 +0,0 @@
-const getPackageFileContentMock = jest.fn()
-
-jest.mock('@toptal/davinci-cli-shared', () => ({
-  files: {
-    getPackageFileContent: getPackageFileContentMock
-  }
-}))
-
-const jestArgsToCLIRules = require('./jest-args-to-cli-converters')
-
-describe('jestArgsToCLIRules "reporters"', () => {
-  const reportersRule = jestArgsToCLIRules['reporters']
-
-  it('converts correctly arrays', () => {
-    expect(
-      reportersRule(['reporter1', 'reporter2'])
-    ).toEqual(['reporter1', 'reporter2'])
-  })
-
-  it('converts correctly string', () => {
-    expect(
-      reportersRule('reporter1')
-    ).toEqual(['reporter1'])
-  })
-})
-
-describe('jestArgsToCLIRules "setupFilesAfterEnv"', () => {
-  const setupFilesAfterEnvRule = jestArgsToCLIRules['setupFilesAfterEnv']
-
-  it('takes default values from the davinci jest.config.js file', () => {
-    getPackageFileContentMock.mockReturnValueOnce({
-      setupFilesAfterEnv: ['davinci-setup-files']
-    })
-
-    expect(
-      setupFilesAfterEnvRule()
-    ).toEqual(['davinci-setup-files'])
-  })
-
-  it('merges default values with passed setup files', () => {
-    getPackageFileContentMock.mockReturnValueOnce({
-      setupFilesAfterEnv: ['davinci-setup-files']
-    })
-
-    expect(
-      setupFilesAfterEnvRule(['file1', 'file2'])
-    ).toEqual(['davinci-setup-files', 'file1', 'file2'])
-  })
-
-  it('merges default values with single passed setup file', () => {
-    getPackageFileContentMock.mockReturnValueOnce({
-      setupFilesAfterEnv: ['davinci-setup-files']
-    })
-
-    expect(
-      setupFilesAfterEnvRule('file1')
-    ).toEqual(['davinci-setup-files', 'file1'])
-  })
-})

package/src/utils/styled-components-version-check.test.js

@@ -1,78 +0,0 @@
-const styledComponentsVersionCheck = require('./styled-components-version-check')
-
-const successTest = (styledComponentsVersion, dependenciesKeys) => {
-  const packageJson = {}
-
-  dependenciesKeys.forEach(dependenciesKey => {
-    packageJson[dependenciesKey] = {
-      'styled-components': styledComponentsVersion
-    }
-  })
-
-  let error = null
-  try {
-    styledComponentsVersionCheck(packageJson)
-  } catch (e) {
-    error = e
-  }
-
-  expect(error).toBeNull()
-}
-
-const errorTest = (styledComponentsVersion, dependenciesKeys) => {
-  const packageJson = {}
-
-  dependenciesKeys.forEach(dependenciesKey => {
-    packageJson[dependenciesKey] = {
-      'styled-components': styledComponentsVersion
-    }
-  })
-
-  let error = null
-  try {
-    styledComponentsVersionCheck(packageJson)
-  } catch (e) {
-    error = e
-  }
-
-  expect(error).not.toBeNull()
-  expect(error.message).toContain(styledComponentsVersion)
-}
-
-describe('styled-components version check', () => {
-  describe('has wrong (^4.4.1) SC version in dependencies', () => {
-    test('should throw an error', () => {
-      errorTest('^4.4.1', ['dependencies'])
-    })
-  })
-
-  describe('has correct (^5.0.1) SC version in dependencies', () => {
-    test('should NOT throw an error', () => {
-      successTest('^5.0.1', ['dependencies'])
-    })
-  })
-
-  describe('has wrong (^4.4.1) SC version in devDependencies and peerDependencies', () => {
-    test('should throw an error', () => {
-      errorTest('^4.4.1', ['devDependencies', 'peerDependencies'])
-    })
-  })
-
-  describe('has correct (^5.0.1) SC version in devDependencies and peerDependencies', () => {
-    test('should NOT throw an error', () => {
-      successTest('^5.0.1', ['devDependencies', 'peerDependencies'])
-    })
-  })
-
-  describe('has wrong (^4.4.1) SC version in devDependencies', () => {
-    test('should throw an error', () => {
-      errorTest('^4.4.1', ['devDependencies'])
-    })
-  })
-
-  describe('has correct (^5.0.1) SC version in devDependencies', () => {
-    test('should NOT throw an error', () => {
-      successTest('^5.0.1', ['devDependencies'])
-    })
-  })
-})

package/src/utils/to-jest-cli-arguments.test.js

@@ -1,32 +0,0 @@
-const toJestCLIArguments = require('./to-jest-cli-arguments')
-
-const EXAMPLE_REPORTER = 'some-jest-reporter'
-const ARGS_TO_CLI_RESULT = [EXAMPLE_REPORTER]
-
-jest.mock('./jest-args-to-cli-converters.js', () => ({
-  'reporters': () => ARGS_TO_CLI_RESULT
-}))
-
-describe('toJestCLIArguments', () => {
-  it('converts boolean strings to booleans correctly', () => {
-    expect(
-      toJestCLIArguments({
-        cache: 'false',
-        ci: 'true'
-      })
-    ).toEqual({
-      cache: false,
-      ci: true
-    })
-  })
-
-  it('converts some rules by using args-to-cli rules', () => {
-    expect(
-      toJestCLIArguments({
-        'reporters': EXAMPLE_REPORTER
-      })
-    ).toEqual({
-        'reporters': ARGS_TO_CLI_RESULT
-    })
-  })
-})