@toptal/davinci-qa 5.5.1-alpha-fix-integration-tests-jenkins.6 → 5.6.0

package/CHANGELOG.md

@@ -1,5 +1,11 @@
 # Change Log
 
+## 5.6.0
+
+### Minor Changes
+
+- [#1208](https://github.com/toptal/davinci/pull/1208) [`893b5be1`](https://github.com/toptal/davinci/commit/893b5be12f1da8ccc5614e17cd705c348800d20d) Thanks [@rafael-anachoreta](https://github.com/rafael-anachoreta)! - Allow jest config reporters to override defaults
+
 ## 5.5.0
 
 ### Minor Changes

package/dist-package/package.json

@@ -0,0 +1,55 @@
+{
+  "name": "@toptal/davinci-qa",
+  "version": "5.6.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.0.3",
+    "babel-jest": "^26.3.0",
+    "cypress": "^9.4.1",
+    "fs-extra": "^10.0.0",
+    "glob": "^7.2.0",
+    "jest": "^26.6.3",
+    "jest-html-reporters": "^2.1.6",
+    "jest-junit": "^13.0.0",
+    "jest-silent-reporter": "^0.5.0",
+    "jest-styled-components": "^7.0.3",
+    "jsdom": "^16.5.2",
+    "matchmedia-polyfill": "^0.3.2",
+    "semver": "^7.3.2"
+  }
+}

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@toptal/davinci-qa",
-  "version": "5.5.1-alpha-fix-integration-tests-jenkins.6+8ba2e836",
+  "version": "5.6.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-fix-integration-tests-jenkins.8+8ba2e836",
+    "@toptal/davinci-cli-shared": "1.5.1",
     "@types/jest": "^27.0.3",
     "babel-jest": "^26.3.0",
     "cypress": "^9.4.1",
@@ -51,6 +51,5 @@
     "jsdom": "^16.5.2",
     "matchmedia-polyfill": "^0.3.2",
     "semver": "^7.3.2"
-  },
-  "gitHead": "8ba2e83627d7d4aa0615c59cf1a694777d4e9047"
+  }
 }

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.js

@@ -55,7 +55,9 @@ const unitTestsCommand = ({
   }
 
   if (isCi) {
-    const isConfigFileHasCollectCoverageFrom = jestOptions.config && files.getProjectRootFileContent(jestOptions.config).collectCoverageFrom
+    const hasCustomConfig = Boolean(jestOptions.config)
+    const jestProjectConfig = hasCustomConfig && files.getProjectRootFileContent(jestOptions.config)
+    const isConfigFileHasCollectCoverageFrom = hasCustomConfig && jestProjectConfig.collectCoverageFrom
 
     defaultOptions.coverage = true
     defaultOptions.coverageDirectory = 'coverage'
@@ -70,8 +72,12 @@ const unitTestsCommand = ({
 
     // to show smaller log of tests running on CI
     // and a nicer html report
+    // Override order: CLI options -> reporters on jest.config -> Davinci defaults
     if (jestOptions.reporters) {
       defaultOptions.reporters = jestOptions.reporters
+    } 
+    else if (jestProjectConfig?.reporters) {
+      defaultOptions.reporters = jestProjectConfig.reporters
     } else {
       defaultOptions.testLocationInResults = true // allows reporters to return test line number
       defaultOptions.reporters = defaultCIJestReporters(anvilTag)

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/reporters/jest-anvil-reporter.test.js

@@ -0,0 +1,123 @@
+const JestAnvilReporter = require('./jest-anvil-reporter.js')
+const fs = require('fs')
+const { passedTestResults, failedTestResults, skippedTestResults, combinedTestResults } = 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",
+          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",
+          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",
+          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",
+          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",
+          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",
+          tag: "platform"
+        }
+      ]
+    ]
+  }
+  
+  beforeEach(() => {
+    jest.clearAllMocks();
+  });
+
+  test.each`
+    input                   | expectedOutput                  | testType
+    ${passedTestResults}    | ${expectedPassedTestResults}    | ${"passing tests"}
+    ${failedTestResults}    | ${expectedFailedTestResults}    | ${"failing tests"}
+    ${skippedTestResults}   | ${expectedSkippedTestResults}   | ${"skipped 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

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

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

@@ -0,0 +1,32 @@
+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
+    })
+  })
+})