feat(integration-testing): enable providing framework plugins

Author: travi

src/options/validator.js

@@ -32,6 +32,7 @@ export function validate(options) {
     }).default({registries: {}}),
     plugins: {
       unitTestFrameworks: pluginsSchema,
+      integrationTestFrameworks: pluginsSchema,
       packageBundlers: pluginsSchema,
       applicationTypes: pluginsSchema,
       packageTypes: pluginsSchema,

src/options/validator.test.js

@@ -62,6 +62,7 @@ describe('options validator', () => {
         configs,
         plugins: {
           unitTestFrameworks: pluginsSchema,
+          integrationTestFrameworks: pluginsSchema,
           packageBundlers: pluginsSchema,
           applicationTypes: pluginsSchema,
           packageTypes: pluginsSchema,

src/scaffolder.js

@@ -37,6 +37,7 @@ export default async function scaffoldJavascript(options) {
       monorepoTypes,
       packageBundlers,
       unitTestFrameworks,
+      integrationTestFrameworks,
       hosts,
       ciServices
     }
@@ -94,6 +95,7 @@ export default async function scaffoldJavascript(options) {
     registries: configs.registries,
     tests,
     unitTestFrameworks,
+    integrationTestFrameworks,
     decisions,
     pathWithinParent
   });

src/scaffolder.test.js

@@ -82,6 +82,7 @@ describe('javascript project scaffolder', () => {
     const monorepoTypes = any.simpleObject();
     const packageBundlers = any.simpleObject();
     const unitTestFrameworks = any.simpleObject();
+    const integrationTestFrameworks = any.simpleObject();
     const testFilenamePattern = any.string();
     const buildDirectory = any.string();
     const packageResults = {...any.simpleObject(), packageName};
@@ -108,7 +109,16 @@ describe('javascript project scaffolder', () => {
         visibility,
         license,
         decisions,
-        plugins: {ciServices, hosts, applicationTypes, packageTypes, monorepoTypes, packageBundlers, unitTestFrameworks}
+        plugins: {
+          ciServices,
+          hosts,
+          applicationTypes,
+          packageTypes,
+          monorepoTypes,
+          packageBundlers,
+          unitTestFrameworks,
+          integrationTestFrameworks
+        }
       });
     when(prompt)
       .calledWith(ciServices, hosts, visibility, vcs, decisions, configs, pathWithinParent)
@@ -161,7 +171,8 @@ describe('javascript project scaffolder', () => {
         tests,
         decisions,
         pathWithinParent,
-        unitTestFrameworks
+        unitTestFrameworks,
+        integrationTestFrameworks
       })
       .thenResolve(verificationResults);
     when(scaffoldNodeVersion).calledWith({projectRoot, nodeVersionCategory}).thenResolve(nodeVersionResults);

src/testing/integration/index.js

@@ -0,0 +1 @@
+export {default as scaffold} from './scaffolder.js';

src/testing/integration/scaffolder.js

@@ -0,0 +1,3 @@
+export default function scaffoldIntegrationTesting() {
+  return {};
+}

src/testing/integration/scaffolder.test.js

@@ -0,0 +1,9 @@
+import {describe, it, expect} from 'vitest';
+
+import scaffoldIntegrationTesting from './scaffolder.js';
+
+describe('integration testing scaffolder', () => {
+  it('should scaffold the chosen framework', async () => {
+    expect(scaffoldIntegrationTesting()).toEqual({});
+  });
+});

src/testing/scaffolder.js

@@ -1,20 +1,26 @@
 import deepmerge from 'deepmerge';
 
 import {scaffold as scaffoldUnitTesting} from './unit/index.js';
+import {scaffold as scaffoldIntegrationTesting} from './integration/index.js';
 
 export default async function scaffoldTesting({
   projectRoot,
   tests: {unit, integration},
   unitTestFrameworks,
+  integrationTestFrameworks,
   decisions,
   dialect
 }) {
-  const unitResults = unit
-    ? await scaffoldUnitTesting({projectRoot, frameworks: unitTestFrameworks, decisions, dialect})
-    : {};
+  const [unitResults, integrationResults] = await Promise.all([
+    unit ? scaffoldUnitTesting({projectRoot, frameworks: unitTestFrameworks, decisions, dialect}) : {},
+    integration
+      ? scaffoldIntegrationTesting({projectRoot, frameworks: integrationTestFrameworks, decisions, dialect})
+      : {}
+  ]);
 
-  return deepmerge(
+  return deepmerge.all([
     {dependencies: {javascript: {development: [...(unit || integration) ? ['@travi/any'] : []]}}, eslint: {}},
-    unitResults
-  );
+    unitResults,
+    integrationResults
+  ]);
 }

src/testing/scaffolder.test.js

@@ -1,57 +1,99 @@
+import deepmerge from 'deepmerge';
+
 import any from '@travi/any';
 import {it, expect, describe, vi, beforeEach} from 'vitest';
 import {when} from 'vitest-when';
 
 import {scaffold as scaffoldUnitTesting} from './unit/index.js';
+import {scaffold as scaffoldIntegrationTesting} from './integration/index.js';
 import scaffoldTesting from './scaffolder.js';
 
+vi.mock('deepmerge');
 vi.mock('./unit/index.js');
+vi.mock('./integration/index.js');
 
 describe('testing scaffolder', () => {
   const projectRoot = any.string();
   const dialect = any.word();
-  const unitTestingDevDependencies = any.listOf(any.string);
-  const unitTestNextSteps = any.listOf(any.simpleObject);
-  const unitTestScripts = any.simpleObject();
-  const unitTestFilesToIgnoreFromVcs = any.listOf(any.string);
-  const unitTestDirectoriesToIgnoreFromVcs = any.listOf(any.string);
   const unitTestFrameworks = any.simpleObject();
+  const integrationTestFrameworks = any.simpleObject();
   const decisions = any.simpleObject();
+  const unitTestScaffoldResults = any.simpleObject();
+  const integrationTestScaffoldResults = any.simpleObject();
+  const mergedResults = any.simpleObject();
 
   beforeEach(() => {
     when(scaffoldUnitTesting)
       .calledWith({projectRoot, frameworks: unitTestFrameworks, decisions, dialect})
-      .thenResolve({
-        dependencies: {javascript: {development: unitTestingDevDependencies}},
-        scripts: unitTestScripts,
-        vcsIgnore: {files: unitTestFilesToIgnoreFromVcs, directories: unitTestDirectoriesToIgnoreFromVcs},
-        nextSteps: unitTestNextSteps
-      });
+      .thenResolve(unitTestScaffoldResults);
+    when(scaffoldIntegrationTesting)
+      .calledWith({projectRoot, frameworks: integrationTestFrameworks, decisions, dialect})
+      .thenResolve(integrationTestScaffoldResults);
   });
 
   it('should scaffold unit testing if the project will be unit test', async () => {
+    when(deepmerge.all)
+      .calledWith([
+        {dependencies: {javascript: {development: ['@travi/any']}}, eslint: {}},
+        unitTestScaffoldResults,
+        {}
+      ])
+      .thenReturn(mergedResults);
+
     expect(await scaffoldTesting({
       projectRoot,
-      tests: {unit: true},
+      tests: {unit: true, integration: false},
       unitTestFrameworks,
+      integrationTestFrameworks,
       decisions,
       dialect
-    })).toEqual({
-      dependencies: {javascript: {development: ['@travi/any', ...unitTestingDevDependencies]}},
-      scripts: unitTestScripts,
-      vcsIgnore: {files: unitTestFilesToIgnoreFromVcs, directories: unitTestDirectoriesToIgnoreFromVcs},
-      eslint: {},
-      nextSteps: unitTestNextSteps
-    });
+    })).toEqual(mergedResults);
   });
 
-  it('should not scaffold unit testing if the project will not be unit tested', async () => {
-    expect(await scaffoldTesting({projectRoot, tests: {unit: false, integration: true}}))
-      .toEqual({dependencies: {javascript: {development: ['@travi/any']}}, eslint: {}});
+  it('should scaffold integration testing if the project will be integration tested', async () => {
+    when(deepmerge.all)
+      .calledWith([
+        {dependencies: {javascript: {development: ['@travi/any']}}, eslint: {}},
+        {},
+        integrationTestScaffoldResults
+      ])
+      .thenReturn(mergedResults);
+
+    expect(await scaffoldTesting({
+      projectRoot,
+      tests: {unit: false, integration: true},
+      unitTestFrameworks,
+      integrationTestFrameworks,
+      decisions,
+      dialect
+    })).toEqual(mergedResults);
+  });
+
+  it('should scaffold both unit testing and integration testing if both layers are planned', async () => {
+    when(deepmerge.all)
+      .calledWith([
+        {dependencies: {javascript: {development: ['@travi/any']}}, eslint: {}},
+        unitTestScaffoldResults,
+        integrationTestScaffoldResults
+      ])
+      .thenReturn(mergedResults);
+
+    expect(await scaffoldTesting({
+      projectRoot,
+      tests: {unit: true, integration: true},
+      unitTestFrameworks,
+      integrationTestFrameworks,
+      decisions,
+      dialect
+    })).toEqual(mergedResults);
   });
 
   it('should not scaffold testing if the project will not be tested', async () => {
+    when(deepmerge.all)
+      .calledWith([{dependencies: {javascript: {development: []}}, eslint: {}}, {}, {}])
+      .thenReturn(mergedResults);
+
     expect(await scaffoldTesting({projectRoot, tests: {unit: false, integration: false}}))
-      .toEqual({dependencies: {javascript: {development: []}}, eslint: {}});
+      .toEqual(mergedResults);
   });
 });

src/verification/scaffolder.js

@@ -12,11 +12,12 @@ export async function scaffoldVerification({
   registries,
   tests,
   unitTestFrameworks,
+  integrationTestFrameworks,
   decisions,
   pathWithinParent
 }) {
   const [testingResults, lintingResults, huskyResults] = await Promise.all([
-    scaffoldTesting({projectRoot, tests, unitTestFrameworks, decisions, dialect}),
+    scaffoldTesting({projectRoot, tests, unitTestFrameworks, integrationTestFrameworks, decisions, dialect}),
     scaffoldLinting({projectRoot, packageManager, registries, vcs, pathWithinParent}),
     scaffoldHusky({projectRoot, packageManager, pathWithinParent})
   ]);