@toptal/davinci-qa 12.0.2 → 12.0.4-alpha-update-cypress.2

package/CHANGELOG.md

@@ -1,5 +1,15 @@
 # Change Log
 
+## 12.0.3
+
+### Patch Changes
+
+- [#1543](https://github.com/toptal/davinci/pull/1543) [`9b67beb3`](https://github.com/toptal/davinci/commit/9b67beb3aaf0e24193b2deaba3126c41e3ec9280) Thanks [@denieler](https://github.com/denieler)! - ---
+  - `integration-open` command now throws a human readable message when necessary `davinci-engine` dependency is not installed or installed a wrong version
+  - `integration-run` command now throws a human readable message when necessary `davinci-engine` dependency is not installed or installed a wrong version
+- Updated dependencies [[`9b67beb3`](https://github.com/toptal/davinci/commit/9b67beb3aaf0e24193b2deaba3126c41e3ec9280), [`04fe7ffa`](https://github.com/toptal/davinci/commit/04fe7ffa161027d081c6ae870716bb06a2fcf73f)]:
+  - @toptal/davinci-cli-shared@1.7.0
+
 ## 12.0.2
 
 ### Patch Changes

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@toptal/davinci-qa",
-  "version": "12.0.2",
+  "version": "12.0.4-alpha-update-cypress.2+14a7c055",
   "description": "QA package to test your application",
   "publishConfig": {
     "access": "public"
@@ -37,10 +37,10 @@
     "@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",
+    "@toptal/davinci-cli-shared": "1.7.1-alpha-update-cypress.2+14a7c055",
     "@types/jest": "^27.5.1",
     "babel-jest": "^28.1.3",
-    "cypress": "^10.0.3",
+    "cypress": "^10.6.0",
     "enhanced-resolve": "^5.9.2",
     "fs-extra": "^10.0.0",
     "glob": "^8.0.3",
@@ -63,6 +63,7 @@
     "mocha": "^10.0.0"
   },
   "peerDependencies": {
-    "@toptal/davinci-engine": "7.4.6"
-  }
+    "@toptal/davinci-engine": "3 - 7"
+  },
+  "gitHead": "14a7c05537b0c44bd97d9f795d6618b145d46f35"
 }

package/src/commands/integration-open.js

@@ -2,6 +2,7 @@ const {
   runSync,
   print,
   convertToCLIParameters,
+  packageUtils,
 } = require('@toptal/davinci-cli-shared')
 
 const getCypressConfigPath = require('../utils/get-cypress-config-path')
@@ -10,6 +11,17 @@ 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,6 +3,7 @@ const {
   print,
   convertToCLIParameters,
   files,
+  packageUtils,
 } = require('@toptal/davinci-cli-shared')
 
 const getCypressConfigPath = require('../utils/get-cypress-config-path')
@@ -11,6 +12,17 @@ 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/configs/cypress.config.js

@@ -20,6 +20,7 @@ module.exports = defineConfig({
   video: false,
 
   component: {
+    experimentalSingleTabRunMode: true,
     viewportWidth: 1280,
     viewportHeight: 1024,
     slowTestThreshold: 250,

package/dist-package/package.json

@@ -1,68 +0,0 @@
-{
-  "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/src/commands/integration-run.test.js

@@ -1,115 +0,0 @@
-/* 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

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

@@ -1,112 +0,0 @@
-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([])
-    })
-  })
-})