@toptal/davinci-qa 12.0.2-alpha-fx-2996-add-error-message-for-missing-engine.12 → 12.0.2

package/CHANGELOG.md

@@ -1,5 +1,14 @@
 # Change Log
 
+## 12.0.2
+
+### Patch Changes
+
+- [#1541](https://github.com/toptal/davinci/pull/1541) [`397a53c9`](https://github.com/toptal/davinci/commit/397a53c9add9f7e8d485648b51cd22676d97c78f) Thanks [@TomasSlama](https://github.com/TomasSlama)! - ---
+  - Update documentation about prefering individual davinci packages usage
+- Updated dependencies [[`397a53c9`](https://github.com/toptal/davinci/commit/397a53c9add9f7e8d485648b51cd22676d97c78f)]:
+  - @toptal/davinci-engine@7.4.6
+
 ## 12.0.1
 
 ### Patch Changes

package/README.md

@@ -4,7 +4,7 @@ Run tests in your projects with almost 0 configuration.
 
 ## Installation
 
-Use it by installing `yarn add @toptal/davinci` in your project.
+Use it by installing `yarn add @toptal/davinci-qa` in your project.
 
 ## Usage
 
@@ -17,8 +17,8 @@ Use it by installing `yarn add @toptal/davinci` in your project.
 ### Alias
 
 You can use davinci qa both as a standalone command `davinci-qa [...args]`
-or as a sub-command of the davinci command: `davinci qa [args...]`.
-Recommended way is to use davinci by parts, i.e. `davinci-qa unit`.
+or as a sub-command of the davinci command: `davinci qa [args...]`, in this case @toptal/davinci package is required.
+Recommended way is to use individual davinci packages, i.e. `davinci-qa unit`.
 
 
 ### IDE Tooling

package/dist-package/package.json

@@ -0,0 +1,68 @@
+{
+  "name": "@toptal/davinci-qa",
+  "version": "12.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.18.0",
+    "@babel/preset-env": "^7.18.0",
+    "@babel/preset-react": "^7.17.12",
+    "@babel/preset-typescript": "^7.17.12",
+    "@cypress/code-coverage": "^3.10.0",
+    "@cypress/webpack-preprocessor": "^5.12.0",
+    "@testing-library/jest-dom": "^5.16.4",
+    "@testing-library/react": "^12.1.2",
+    "@toptal/davinci-cli-shared": "1.6.0",
+    "@types/jest": "^27.5.1",
+    "babel-jest": "^28.1.3",
+    "cypress": "^10.0.3",
+    "enhanced-resolve": "^5.9.2",
+    "fs-extra": "^10.0.0",
+    "glob": "^8.0.3",
+    "happo-cypress": "^3.0.1",
+    "happo-e2e": "^1.2.0",
+    "happo-plugin-storybook": "^3.0.0",
+    "happo.io": "^7.2.1",
+    "jest": "^28.1.0",
+    "jest-environment-jsdom": "^28.1.0",
+    "jest-html-reporters": "^3.0.10",
+    "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": {
+    "json5": "^2.2.1",
+    "mocha": "^10.0.0"
+  },
+  "peerDependencies": {
+    "@toptal/davinci-engine": "7.4.6"
+  }
+}

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@toptal/davinci-qa",
-  "version": "12.0.2-alpha-fx-2996-add-error-message-for-missing-engine.12+227d5ea7",
+  "version": "12.0.2",
   "description": "QA package to test your application",
   "publishConfig": {
     "access": "public"
@@ -37,7 +37,7 @@
     "@cypress/webpack-preprocessor": "^5.12.0",
     "@testing-library/jest-dom": "^5.16.4",
     "@testing-library/react": "^12.1.2",
-    "@toptal/davinci-cli-shared": "1.6.1-alpha-fx-2996-add-error-message-for-missing-engine.21+227d5ea7",
+    "@toptal/davinci-cli-shared": "1.6.0",
     "@types/jest": "^27.5.1",
     "babel-jest": "^28.1.3",
     "cypress": "^10.0.3",
@@ -63,7 +63,6 @@
     "mocha": "^10.0.0"
   },
   "peerDependencies": {
-    "@toptal/davinci-engine": "3 - 7"
-  },
-  "gitHead": "227d5ea750c2b2ce9f4abd1ff33bbe1838ae9d28"
+    "@toptal/davinci-engine": "7.4.6"
+  }
 }

package/src/commands/integration-open.js

@@ -2,7 +2,6 @@ const {
   runSync,
   print,
   convertToCLIParameters,
-  packageUtils,
 } = require('@toptal/davinci-cli-shared')
 
 const getCypressConfigPath = require('../utils/get-cypress-config-path')
@@ -11,17 +10,6 @@ const integrationOpenCommand = ({
   options: { baseUrl, ...cypressOptions } = {},
   files: testFiles = [],
 }) => {
-  const prerequirementsError = packageUtils.checkPrerequirement({
-    dependencies:
-      packageUtils.getPackagePackageJson(__dirname).peerDependencies,
-    packageName: '@toptal/davinci-engine',
-  })
-
-  if (prerequirementsError) {
-    print.red(prerequirementsError)
-    process.exit(1)
-  }
-
   print.green('Running integration tests...')
 
   const configPath = getCypressConfigPath()

package/src/commands/integration-run.js

@@ -3,7 +3,6 @@ const {
   print,
   convertToCLIParameters,
   files,
-  packageUtils,
 } = require('@toptal/davinci-cli-shared')
 
 const getCypressConfigPath = require('../utils/get-cypress-config-path')
@@ -12,17 +11,6 @@ const integrationRunCommand = ({
   options: { baseUrl, anvilTag, ...cypressOptions } = {},
   files: testFiles = [],
 }) => {
-  const prerequirementsError = packageUtils.checkPrerequirement({
-    dependencies:
-      packageUtils.getPackagePackageJson(__dirname).peerDependencies,
-    packageName: '@toptal/davinci-engine',
-  })
-
-  if (prerequirementsError) {
-    print.red(prerequirementsError)
-    process.exit(1)
-  }
-
   print.green('Running integration tests...')
 
   const configPath = getCypressConfigPath()

package/src/commands/integration-run.test.js

@@ -0,0 +1,115 @@
+/* eslint-disable import/order -- changing the order messes up with jest mocking */
+const fs = require('fs')
+
+const originalExistsSync = fs.existsSync
+
+const getPackageFilePathMock = jest.fn()
+const getProjectRootFilePathMock = jest.fn(path => `mock:${path}`)
+const fsExistsSyncSpy = jest.spyOn(fs, 'existsSync')
+
+jest.mock('@toptal/davinci-cli-shared', () => ({
+  ...jest.requireActual('@toptal/davinci-cli-shared'),
+  runSync: jest.fn(),
+  print: {
+    red: jest.fn(),
+    green: jest.fn(),
+  },
+  files: {
+    getPackageFilePath: getPackageFilePathMock,
+    getProjectRootFilePath: getProjectRootFilePathMock,
+  },
+}))
+
+const { runSync } = require('@toptal/davinci-cli-shared')
+
+const { action } = require('./integration-run')
+
+describe('integrationRunCommand', () => {
+  beforeEach(() => {
+    jest.clearAllMocks()
+  })
+
+  it('runs cypress with default options', () => {
+    const localConfig = 'mock:cypress.config.js'
+    const davinciConfig = 'packages/qa/src/configs/cypress.config.js'
+
+    getPackageFilePathMock.mockReturnValueOnce(davinciConfig)
+
+    // fs.existsSync is used in a lot of places, even internally by jest
+    // we want to only mock when asking for our files
+    fsExistsSyncSpy.mockImplementation((path, ...rest) =>
+      path === localConfig ? false : originalExistsSync(path, ...rest)
+    )
+
+    action({ options: {} })
+
+    expect(runSync).toHaveBeenCalledWith('yarn', [
+      'cypress',
+      'run',
+      '--config-file',
+      davinciConfig,
+    ])
+
+    expect(getPackageFilePathMock).toHaveBeenCalledWith(
+      '@toptal/davinci-qa',
+      'src/configs/cypress.config.js'
+    )
+  })
+
+  it('run cypress with local config, if present', () => {
+    const localConfig = 'mock:cypress.config.js'
+    const davinciConfig = 'packages/qa/src/configs/cypress.config.js'
+
+    getPackageFilePathMock.mockReturnValueOnce(davinciConfig)
+
+    // fs.existsSync is used in a lot of places, even internally by jest
+    // we want to only mock when asking for our files
+    fsExistsSyncSpy.mockImplementation((path, ...rest) =>
+      path === localConfig ? true : originalExistsSync(path, ...rest)
+    )
+
+    action({ options: {} })
+
+    expect(runSync).toHaveBeenCalledWith('yarn', [
+      'cypress',
+      'run',
+      '--config-file',
+      localConfig,
+    ])
+
+    expect(getPackageFilePathMock).not.toHaveBeenCalledWith(
+      '@toptal/davinci-qa',
+      'src/configs/cypress.config.js'
+    )
+  })
+
+  it('runs cypress with custom options', () => {
+    const localConfig = 'mock:cypress.config.js'
+    const davinciConfig = 'packages/qa/src/configs/cypress.config.js'
+    const spec = 'cypress/integration/activation_flow.spec.ts'
+
+    getPackageFilePathMock.mockReturnValueOnce(davinciConfig)
+
+    // fs.existsSync is used in a lot of places, even internally by jest
+    // we want to only mock when asking for our files
+    fsExistsSyncSpy.mockImplementation((path, ...rest) =>
+      path === localConfig ? false : originalExistsSync(path, ...rest)
+    )
+
+    action({ options: { spec } })
+
+    expect(runSync).toHaveBeenCalledWith('yarn', [
+      'cypress',
+      'run',
+      '--config-file',
+      davinciConfig,
+      '--spec',
+      spec,
+    ])
+
+    expect(getPackageFilePathMock).toHaveBeenCalledWith(
+      '@toptal/davinci-qa',
+      'src/configs/cypress.config.js'
+    )
+  })
+})

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

@@ -0,0 +1,213 @@
+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
+
+describe('unitTestsCommand', () => {
+  beforeEach(() => {
+    jest.clearAllMocks()
+  })
+
+  afterEach(() => {
+    process.env = originalEnv
+  })
+
+  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).toHaveBeenCalledWith(
+        { 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).toHaveBeenCalledWith(
+        expect.objectContaining({
+          reporters: [
+            [
+              'jest-silent-reporter',
+              {
+                useDots: true,
+                showPaths: true,
+                showWarnings: true,
+              },
+            ],
+            [
+              'jest-junit',
+              {
+                outputDirectory: 'reports',
+              },
+            ],
+            [
+              'jest-html-reporters',
+              {
+                publicPath: './reports',
+              },
+            ],
+          ],
+        }),
+        expect.anything()
+      )
+    })
+
+    it('returns the anvil reporter when anvilTag is set', async () => {
+      const davinciJestConfigPath = 'packages/qa/src/configs/jest.config.js'
+
+      getPackageFilePathMock.mockReturnValueOnce(davinciJestConfigPath)
+
+      await action({ options: { anvilTag: 'platform' } })
+
+      expect(jestRunCLIMock).toHaveBeenCalledWith(
+        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: 'platform',
+              },
+            ],
+          ],
+        }),
+        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).toHaveBeenCalledWith(
+        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).toHaveBeenCalledWith(
+        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).toHaveBeenCalledWith(
+        expect.objectContaining({
+          reporters: [customCLIReporter],
+        }),
+        expect.anything()
+      )
+    })
+  })
+})

package/src/configs/cypress/plugins/parallelization.test.js

@@ -0,0 +1,112 @@
+const glob = require('glob')
+const fs = require('fs')
+
+const parallelization = require('./parallelization')
+
+const mockedConfig = {
+  specPattern: '**.test.js',
+}
+const mockedTestFiles = [
+  'test1.test.js',
+  'test2.test.js',
+  'test3.test.js',
+  'test4.test.js',
+]
+const mockedSizes = {
+  'test1.test.js': 128,
+  'test2.test.js': 256,
+  'test3.test.js': 512,
+  'test4.test.js': 1024,
+}
+
+jest.mock('test-project/test1.test.js', () => {}, {
+  virtual: true,
+})
+jest.mock('test-project/test2.test.js', () => {}, {
+  virtual: true,
+})
+jest.mock('test-project/test3.test.js', () => {}, {
+  virtual: true,
+})
+jest.mock('test-project/test4.test.js', () => {}, {
+  virtual: true,
+})
+
+describe('Cypress CI parallelization', () => {
+  const env = process.env
+  let config = mockedConfig
+  let globSyncMock
+
+  beforeEach(() => {
+    process.env = { ...env }
+    config = { ...mockedConfig }
+
+    globSyncMock = jest.spyOn(glob, 'sync')
+    jest.spyOn(fs, 'statSync').mockImplementation(fileName => ({
+      size: mockedSizes[fileName],
+    }))
+  })
+
+  afterEach(() => {
+    jest.restoreAllMocks()
+  })
+
+  describe('Sort files by size and split in two parallel groups', () => {
+    it('returns first half', () => {
+      process.env.GROUP_INDEX = 0
+      process.env.PARALLEL_GROUPS = 2
+
+      globSyncMock.mockImplementation(() => mockedTestFiles.slice(0))
+
+      parallelization(config)
+
+      expect(config.specPattern).toEqual(['test4.test.js', 'test2.test.js'])
+    })
+
+    it('returns second half', () => {
+      process.env.GROUP_INDEX = 1
+      process.env.PARALLEL_GROUPS = 2
+
+      globSyncMock.mockImplementation(() => mockedTestFiles.slice(0))
+
+      parallelization(config)
+
+      expect(config.specPattern).toEqual(['test3.test.js', 'test1.test.js'])
+    })
+  })
+
+  describe('When there is only 1 parallel group', () => {
+    it('returns spec pattern', () => {
+      process.env.GROUP_INDEX = 0
+      process.env.PARALLEL_GROUPS = 1
+
+      parallelization(config)
+
+      expect(config.specPattern).toBe('**.test.js')
+    })
+  })
+
+  describe('When group index is lower than 0', () => {
+    it('returns spec pattern', () => {
+      process.env.GROUP_INDEX = -1
+      process.env.PARALLEL_GROUPS = 3
+
+      parallelization(config)
+
+      expect(config.specPattern).toBe('**.test.js')
+    })
+  })
+
+  describe('When there are less test files than testing groups', () => {
+    it('returns empty array for a group', () => {
+      process.env.GROUP_INDEX = 1
+      process.env.PARALLEL_GROUPS = 2
+
+      globSyncMock.mockImplementation(() => mockedTestFiles.slice(0, 1))
+
+      parallelization(config)
+
+      expect(config.specPattern).toEqual([])
+    })
+  })
+})