@toptal/davinci-qa 6.0.1-alpha-pro-2952-allow-to-disable-type-checking-for-davinci-engine-build-command.22 → 7.0.0

package/CHANGELOG.md

@@ -1,5 +1,23 @@
 # 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
+
+- [#1252](https://github.com/toptal/davinci/pull/1252) [`a99253c4`](https://github.com/toptal/davinci/commit/a99253c41eb80f5a31d66766d0efd986d1710bd1) Thanks [@aesqe](https://github.com/aesqe)! - Adds babel-plugin-styled-components to the QA package's Jest config so that the forwardedAs prop is properly working in Jest tests. It also adds the forwardedAs prop to the Skeleton package's react module type.
+
 ## 6.0.1
 
 ### Patch Changes

package/dist-package/package.json

@@ -0,0 +1,59 @@
+{
+  "name": "@toptal/davinci-qa",
+  "version": "7.0.0",
+  "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",
+    "enhanced-resolve": "^5.9.2",
+    "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"
+  },
+  "devDependencies": {
+    "mocha": "^9.2.2"
+  }
+}

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@toptal/davinci-qa",
-  "version": "6.0.1-alpha-pro-2952-allow-to-disable-type-checking-for-davinci-engine-build-command.22+cc36cfc5",
+  "version": "7.0.0",
   "description": "QA package to test your application",
   "publishConfig": {
     "access": "public"
@@ -37,7 +37,7 @@
     "@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.2-alpha-pro-2952-allow-to-disable-type-checking-for-davinci-engine-build-command.44+cc36cfc5",
+    "@toptal/davinci-cli-shared": "1.5.1",
     "@types/jest": "^27.4.1",
     "babel-jest": "^27.5.1",
     "cypress": "^9.4.1",
@@ -53,5 +53,7 @@
     "matchmedia-polyfill": "^0.3.2",
     "semver": "^7.3.2"
   },
-  "gitHead": "cc36cfc59a2ad73402f1d49fc3a029900f4c69e0"
+  "devDependencies": {
+    "mocha": "^9.2.2"
+  }
 }

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/end-to-end-tests.test.js

@@ -0,0 +1,65 @@
+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

@@ -0,0 +1,164 @@
+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/configs/jest/babel-preprocessor.js

@@ -10,6 +10,9 @@ const babelOptions = {
     ],
     '@babel/preset-typescript',
     '@babel/preset-react'
+  ],
+  plugins: [
+    'babel-plugin-styled-components'
   ]
 }
 

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/anvil-results-helper.test.js

@@ -0,0 +1,87 @@
+const fs = require('fs-extra')
+const { print } = require('@toptal/davinci-cli-shared')
+
+const { anvilMapper, generateAnvilResults } = require('./anvil-results-helper')
+
+describe('Anvil results helper', () => {
+  beforeEach(() => {
+    jest.resetModules()
+    jest.resetAllMocks()
+  })
+
+  describe('anvilMapper', () => {
+    it('outputs an Anvil-compatible object', () => {
+      const mappedValue = anvilMapper({
+        fileName:
+          '/davinci/packages/qa/src/reporters/jest-anvil-reporter-mocker.test.js',
+        backtrace: null,
+        description: '1 + 1 returns 2',
+        durationInSeconds: 0.003,
+        error: null,
+        lineNumber: 2,
+        pendingMessage: null,
+        scenarioName: 'Example test suite/1 + 1 returns 2',
+        status: 'passed',
+        tag: 'platform',
+        testType: 'unit'
+      })
+
+      expect(mappedValue).toEqual({
+        file_name:
+          '/davinci/packages/qa/src/reporters/jest-anvil-reporter-mocker.test.js',
+        line_number: 2,
+        status: 'passed',
+        duration: 0.003,
+        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'
+      })
+    })
+
+    it('converts "todo" status to pending', () => {
+      const mappedValue = anvilMapper({ status: 'todo' })
+
+      expect(mappedValue.status).toBe('pending')
+    })
+  })
+
+  describe('generateAnvilResults', () => {
+    it('creates a report with the data passed in', () => {
+      const writeJsonMock = jest.spyOn(fs, 'writeJsonSync')
+      const printMock = jest.spyOn(print, 'green')
+
+      generateAnvilResults('anvil_cypress_test_results.json', { test: 123 })
+
+      expect(writeJsonMock).toHaveBeenCalledWith(
+        './reports/anvil_cypress_test_results.json',
+        { test: 123 }
+      )
+      expect(printMock).toHaveBeenCalledWith(
+        '[anvil-reporter] Anvil reports generated successfully!'
+      )
+    })
+
+    it('throws an error when unable to create report', () => {
+      const mockError = new Error('My error!')
+
+      jest.spyOn(fs, 'ensureDirSync').mockImplementation(() => {
+        throw mockError
+      })
+      const printMock = jest.spyOn(print, 'red')
+
+      expect(() =>
+        generateAnvilResults('anvil_cypress_test_results.json', { test: 123 })
+      ).toThrow()
+
+      expect(printMock).toHaveBeenCalledTimes(1)
+      expect(printMock).toHaveBeenCalledWith(
+        '[anvil-reporter] Failed to create Anvil test results!',
+        mockError
+      )
+    })
+  })
+})

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