@toptal/davinci-qa 15.1.0 → 15.1.1

package/CHANGELOG.md

@@ -1,5 +1,12 @@
 # Change Log
 
+## 15.1.1
+
+### Patch Changes
+
+- Updated dependencies [[`d2b25141`](https://github.com/toptal/davinci/commit/d2b25141b5c25f4cefa35f5d7df289401566eb03)]:
+  - @toptal/davinci-cli-shared@2.2.0
+
 ## 15.1.0
 
 ### Minor Changes

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@toptal/davinci-qa",
-  "version": "15.1.0",
+  "version": "15.1.1",
   "description": "QA package to test your application",
   "publishConfig": {
     "access": "public"
@@ -52,7 +52,7 @@
     "@cypress/webpack-preprocessor": "^5.12.0",
     "@testing-library/jest-dom": "^5.16.4",
     "@testing-library/react": "^13.3.0",
-    "@toptal/davinci-cli-shared": "2.1.1",
+    "@toptal/davinci-cli-shared": "2.2.0",
     "@types/jest": "^27.5.1",
     "babel-jest": "^28.1.3",
     "fs-extra": "^10.0.0",
@@ -72,7 +72,7 @@
     "semver": "^7.3.2"
   },
   "devDependencies": {
-    "@jest/globals": "28.1.0",
+    "@jest/globals": "^29.4.2",
     "cypress": "^12.5.1",
     "json5": "^2.2.3",
     "mocha": "^10.0.0"

package/src/commands/__snapshots__/code-metrics.test.js.snap

@@ -5,5 +5,23 @@ exports[`codeMetricsCommandCreator has the correct command structure 1`] = `
   "action": [Function],
   "allowUnknownOptions": true,
   "command": "code-metrics",
+  "options": [
+    {
+      "label": "Package Name",
+      "name": "-n, --name <packageName>",
+    },
+    {
+      "label": "Package Version",
+      "name": "-v, --version <version>",
+    },
+    {
+      "label": "Custom sonarqube url",
+      "name": "-u, --url <url>",
+    },
+    {
+      "label": "sonarqube login",
+      "name": "--login <login>",
+    },
+  ],
 }
 `;

package/src/commands/code-metrics.js

@@ -2,7 +2,7 @@ import fs from 'fs-extra'
 import path from 'path'
 import { runSync, print } from '@toptal/davinci-cli-shared'
 
-const codeMetricsCommand = async ({ options = [] }) => {
+const codeMetricsCommand = async options => {
   const projectPackageJsonPath = path.join(process.cwd(), 'package.json')
 
   print.green('Running code metrics ...')
@@ -43,9 +43,25 @@ const codeMetricsCommand = async ({ options = [] }) => {
 }
 
 const codeMetricsCommandCreator = {
-  action: ({ options }) => {
-    return codeMetricsCommand({ options })
-  },
+  action: codeMetricsCommand,
+  options: [
+    {
+      name: '-n, --name <packageName>',
+      label: 'Package Name',
+    },
+    {
+      name: '-v, --version <version>',
+      label: 'Package Version',
+    },
+    {
+      name: '-u, --url <url>',
+      label: 'Custom sonarqube url',
+    },
+    {
+      name: '--login <login>',
+      label: 'sonarqube login',
+    },
+  ],
   allowUnknownOptions: true,
   command: 'code-metrics',
 }

package/src/commands/integration-open.js

@@ -11,10 +11,10 @@ import getCypressConfigPath from '../utils/get-cypress-config-path.js'
 
 const __dirname = path.dirname(fileURLToPath(import.meta.url))
 
-const integrationOpenCommand = ({
-  options: { baseUrl, ...cypressOptions } = {},
-  files: testFiles = [],
-}) => {
+export const integrationOpenCommand = (
+  testFiles,
+  { baseUrl, ...cypressOptions }
+) => {
   const prerequirementsError = packageUtils.checkPrerequirement({
     dependencies:
       packageUtils.getPackagePackageJson(__dirname).peerDependencies,
@@ -41,22 +41,15 @@ const integrationOpenCommand = ({
   ])
 }
 
-const integrationOpenCommandCreator = {
-  action: ({ options, files: filesArg }) => {
-    return integrationOpenCommand({
-      files: filesArg,
-      options,
-    })
-  },
-  allowUnknownOptions: true,
-  command: 'integration open [files...]',
-  description: 'Open the Cypress Test Runner app',
-  options: [
-    {
-      label: "URL used as prefix for cy.visit() or cy.request() command's URL",
-      name: '--baseUrl <baseUrl>',
-    },
-  ],
+export const createIntegrationOpenCommand = program => {
+  return program
+    .createCommand('open')
+    .allowUnknownOption()
+    .description('Open the Cypress Test Runner app')
+    .argument('[files...]', 'List of test path patterns', [])
+    .option(
+      '--baseUrl <baseUrl>',
+      "URL used as prefix for cy.visit() or cy.request() command's URL"
+    )
+    .action(integrationOpenCommand)
 }
-
-export default integrationOpenCommandCreator

package/src/commands/integration-run.js

@@ -10,10 +10,10 @@ import getCypressConfigPath from '../utils/get-cypress-config-path.js'
 
 const __dirname = path.dirname(fileURLToPath(import.meta.url))
 
-export const integrationRunCommandAction = ({
-  options: { baseUrl, anvilTag, ...cypressOptions } = {},
-  files: testFiles = [],
-}) => {
+export const integrationRunCommand = (
+  testFiles,
+  { baseUrl, anvilTag, ...cypressOptions }
+) => {
   const { convertToCLIParameters } = cliShared
 
   const preRequirementsError = packageUtils.checkPrerequirement({
@@ -54,22 +54,19 @@ export const integrationRunCommandAction = ({
   ])
 }
 
-const integrationRunCommandCreator = {
-  action: integrationRunCommandAction,
-  allowUnknownOptions: true,
-  command: 'integration run [files...]',
-  description: 'Run Cypress tests',
-  options: [
-    {
-      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>',
-    },
-  ],
+export const createIntegrationRunCommand = program => {
+  return program
+    .createCommand('run')
+    .allowUnknownOption()
+    .description('Run Cypress tests')
+    .argument('[files...]', 'List of test path patterns', [])
+    .option(
+      '--baseUrl <baseUrl>',
+      "URL used as prefix for cy.visit() or cy.request() command's URL"
+    )
+    .option(
+      '--anvilTag <anvilTag>',
+      "the project name matching Anvil's expected tag to generate Anvil Reports"
+    )
+    .action(integrationRunCommand)
 }
-
-export default integrationRunCommandCreator

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

@@ -2,7 +2,7 @@ import fs from 'fs'
 import { jest } from '@jest/globals'
 import davinciCliShared from '@toptal/davinci-cli-shared'
 
-import { integrationRunCommandAction } from './integration-run.js'
+import { integrationRunCommand } from './integration-run.js'
 
 const { existsSync } = fs
 
@@ -22,7 +22,7 @@ const runSync = jest
   .spyOn(davinciCliShared, 'runSync')
   .mockImplementation(() => {})
 
-const action = integrationRunCommandAction
+const action = integrationRunCommand
 
 describe('integrationRunCommand', () => {
   beforeEach(() => {
@@ -42,7 +42,7 @@ describe('integrationRunCommand', () => {
       path === localConfig ? false : existsSync(path, ...rest)
     )
 
-    action({ options: {} })
+    action([], {})
 
     expect(runSync).toHaveBeenCalledWith('yarn', [
       'cypress',
@@ -69,7 +69,7 @@ describe('integrationRunCommand', () => {
       path === localConfig ? true : existsSync(path, ...rest)
     )
 
-    action({ options: {} })
+    action([], {})
 
     expect(runSync).toHaveBeenCalledWith('yarn', [
       'cypress',
@@ -87,7 +87,7 @@ describe('integrationRunCommand', () => {
   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'
+    const baseUrl = 'http://something.com'
 
     getPackageFilePathMock.mockReturnValueOnce(davinciConfig)
 
@@ -97,15 +97,15 @@ describe('integrationRunCommand', () => {
       path === localConfig ? false : existsSync(path, ...rest)
     )
 
-    action({ options: { spec } })
+    action([], { baseUrl })
 
     expect(runSync).toHaveBeenCalledWith('yarn', [
       'cypress',
       'run',
       '--config-file',
       davinciConfig,
-      '--spec',
-      spec,
+      '--config',
+      'baseUrl=http://something.com',
     ])
 
     expect(getPackageFilePathMock).toHaveBeenCalledWith(

package/src/commands/unit-tests.js

@@ -9,10 +9,7 @@ import { getCIDefaultOptions } from '../utils/jest/ci-options.js'
 
 export const createUnitTestCommandAction =
   jest =>
-  async ({
-    options: { anvilTag, ...jestOptions } = {},
-    files: testPathPattern = [],
-  }) => {
+  async (testPathPattern = [], { anvilTag, ...jestOptions }) => {
     print.green('Running unit tests...')
 
     const currentRunningDir = process.cwd()
@@ -61,22 +58,73 @@ export const createUnitTestCommandAction =
     })
   }
 
-const unitTestsCommandCreator = {
-  action: createUnitTestCommandAction(defaultJest),
-  allowUnknownOptions: true,
-  command: 'unit [files...]',
-  options: [
-    {
-      label:
-        'a list of paths to modules that run some code to configure or set up the testing framework before each test file in the suite is executed',
-      name: '--setupFilesAfterEnv <setupFilesAfterEnv>',
-    },
-    {
-      label:
-        "the project name matching Anvil's expected tag. Used to generate Anvil-compatible test reports.",
-      name: '--anvilTag <anvilTag>',
-    },
-  ],
+export const createLintCodeCommand = program => {
+  return program
+    .createCommand('unit')
+    .description('Run Jest tests')
+    .allowUnknownOption()
+    .argument('[files...]', 'List of test path patterns', [])
+    .option(
+      '--anvilTag <anvilTag>',
+      "the project name matching Anvil's expected tag. Used to generate Anvil-compatible test reports."
+    )
+    .option(
+      '--setupFilesAfterEnv <setupFilesAfterEnv>',
+      'a list of paths to modules that run some code to configure or set up the testing framework before each test file in the suite is executed'
+    )
+    .option('-c, --config <path>', 'the path to a Jest config file')
+    .option(
+      '-w, --maxWorkers <num>',
+      'specifies the maximum number of workers the worker-pool will spawn for running tests'
+    )
+    .option(
+      '--ci',
+      'when this option is provided, Jest will assume it is running in a CI environment'
+    )
+    .option(
+      '--testTimeout <number>',
+      'default timeout of a test in milliseconds'
+    )
+    .option(
+      '--silent',
+      'prevent tests from printing messages through the console'
+    )
+    .option(
+      '--watch',
+      'watch files for changes and rerun tests related to changed files'
+    )
+    .option(
+      '-i, --runInBand [value]',
+      'run all tests serially in the current process',
+      program.parseBoolean
+    )
+    .option(
+      '--passWithNoTests',
+      'allows the test suite to pass when no files are found'
+    )
+    .option('--json', 'prints the test results in JSON')
+    .option(
+      '-b, --bail [n]',
+      'exit the test suite immediately upon n number of failing test suite'
+    )
+    .option('--reporters <reporters...>', 'run tests with specified reporters')
+    .option('--collect-coverage')
+    .option(
+      '--coverage [value]',
+      'indicates that test coverage information should be collected and reported in the output',
+      program.parseBoolean
+    )
+    .option('--coverageDirectory <directory>')
+    .option('--collectCoverageFrom <from>')
+    .option('--testLocationInResults')
+    .option(
+      '--outputFile <filename>',
+      'write test results to a file when the --json option is also specified'
+    )
+    .option(
+      '--verbose [value]',
+      'display individual test results with the test suite hierarchy',
+      program.parseBoolean
+    )
+    .action(createUnitTestCommandAction(defaultJest))
 }
-
-export default unitTestsCommandCreator

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

@@ -57,7 +57,7 @@ describe('unitTestsCommand', () => {
 
       getPackageFilePathMock.mockReturnValueOnce(davinciJestConfigPath)
 
-      await unitTestCommand({})
+      await unitTestCommand([], {})
 
       expect(jestRunCLIMock).toHaveBeenCalledWith(
         { config: davinciJestConfigPath, testPathPattern: [] },
@@ -76,7 +76,7 @@ describe('unitTestsCommand', () => {
 
       getPackageFilePathMock.mockReturnValueOnce(davinciJestConfigPath)
 
-      await unitTestCommand({})
+      await unitTestCommand([], {})
 
       expect(jestRunCLIMock).toHaveBeenCalledWith(
         expect.objectContaining({
@@ -114,7 +114,7 @@ describe('unitTestsCommand', () => {
 
       getPackageFilePathMock.mockReturnValueOnce(davinciJestConfigPath)
 
-      await unitTestCommand({ options: { anvilTag: 'platform' } })
+      await unitTestCommand([], { anvilTag: 'platform' })
 
       expect(jestRunCLIMock).toHaveBeenCalledWith(
         expect.objectContaining({
@@ -161,11 +161,9 @@ describe('unitTestsCommand', () => {
       getPackageFilePathMock.mockReturnValueOnce(davinciJestConfigPath)
       const customCLIReporter = 'My-CLI-Reporter'
 
-      await unitTestCommand({
-        options: {
-          anvilTag: 'MyTag',
-          reporters: customCLIReporter,
-        },
+      await unitTestCommand([], {
+        anvilTag: 'MyTag',
+        reporters: customCLIReporter,
       })
 
       expect(jestRunCLIMock).toHaveBeenCalledWith(
@@ -186,7 +184,7 @@ describe('unitTestsCommand', () => {
         reporters: customJestConfigReporter,
       })
 
-      await unitTestCommand({ options: { config: {} } })
+      await unitTestCommand([], { config: {} })
 
       expect(jestRunCLIMock).toHaveBeenCalledWith(
         expect.objectContaining({
@@ -207,12 +205,10 @@ describe('unitTestsCommand', () => {
         reporters: customJestConfigReporter,
       })
 
-      await unitTestCommand({
-        options: {
-          anvilTag: 'MyTag',
-          reporters: customCLIReporter,
-          config: {},
-        },
+      await unitTestCommand([], {
+        anvilTag: 'MyTag',
+        reporters: customCLIReporter,
+        config: {},
       })
 
       expect(jestRunCLIMock).toHaveBeenCalledWith(

package/src/index.js

@@ -1,13 +1,16 @@
-import unitTestsCommandCreator from './commands/unit-tests.js'
-import integrationOpenCommandCreator from './commands/integration-open.js'
-import integrationRunCommandCreator from './commands/integration-run.js'
+import { createLintCodeCommand } from './commands/unit-tests.js'
 import codeMetricsCommandCreator from './commands/code-metrics.js'
 import happoConfig from './configs/happo.cjs'
+import { createIntegrationRunCommand } from './commands/integration-run.js'
+import { createIntegrationOpenCommand } from './commands/integration-open.js'
 
 export const commands = [
-  unitTestsCommandCreator,
-  integrationOpenCommandCreator,
-  integrationRunCommandCreator,
+  createLintCodeCommand,
+  program =>
+    program
+      .createCommand('integration')
+      .addCommand(createIntegrationRunCommand(program))
+      .addCommand(createIntegrationOpenCommand(program)),
   codeMetricsCommandCreator,
 ]