feat(integration-testing): choose and scaffold a framework

Author: travi

src/prompts/question-names.js

@@ -1,5 +1,6 @@
 export const questionNames = {
   UNIT_TEST_FRAMEWORK: 'unitTestFramework',
+  INTEGRATION_TEST_FRAMEWORK: 'integrationTestFramework',
   NODE_VERSION_CATEGORY: 'nodeVersionCategory',
   PACKAGE_MANAGER: 'packageManager',
   PACKAGE_BUNDLER: 'packageBundler',

src/testing/integration/prompt.js

@@ -0,0 +1,15 @@
+import {prompt} from '@form8ion/overridable-prompts';
+import {questionNames} from '../../prompts/question-names.js';
+
+export default async function gatherUnitTestingInput({frameworks, decisions}) {
+  if (!Object.keys(frameworks).length) return 'Other';
+
+  const answers = await prompt([{
+    name: questionNames.INTEGRATION_TEST_FRAMEWORK,
+    type: 'list',
+    message: 'Which integration testing framework should be used?',
+    choices: [...Object.keys(frameworks), 'Other']
+  }], decisions);
+
+  return answers[questionNames.INTEGRATION_TEST_FRAMEWORK];
+}

src/testing/integration/prompt.test.js

@@ -0,0 +1,33 @@
+import * as prompts from '@form8ion/overridable-prompts';
+
+import any from '@travi/any';
+import {when} from 'vitest-when';
+import {describe, expect, it, vi} from 'vitest';
+
+import {questionNames} from '../../prompts/question-names.js';
+import prompt from './prompt.js';
+
+vi.mock('@form8ion/overridable-prompts');
+
+describe('integration-test framework prompt', () => {
+  it('should preset the choice of integration-test framework', async () => {
+    const chosenType = any.word();
+    const decisions = any.simpleObject();
+    const answers = {...any.simpleObject(), [questionNames.INTEGRATION_TEST_FRAMEWORK]: chosenType};
+    const frameworks = any.simpleObject();
+    when(prompts.prompt)
+      .calledWith([{
+        name: questionNames.INTEGRATION_TEST_FRAMEWORK,
+        type: 'list',
+        message: 'Which integration testing framework should be used?',
+        choices: [...Object.keys(frameworks), 'Other']
+      }], decisions)
+      .thenResolve(answers);
+
+    expect(await prompt({frameworks, decisions})).toEqual(chosenType);
+  });
+
+  it('should skip the prompt and return `Other` when no options are provided', async () => {
+    expect(await prompt({frameworks: {}})).toEqual('Other');
+  });
+});

src/testing/integration/scaffolder.js

@@ -1,3 +1,14 @@
-export default function scaffoldIntegrationTesting() {
-  return {};
+import {scaffoldChoice as scaffoldFrameworkChoice} from '@form8ion/javascript-core';
+
+import chooseFramework from './prompt.js';
+
+export default async function scaffoldIntegrationTesting({
+  projectRoot,
+  frameworks: integrationTestFrameworks,
+  decisions,
+  dialect
+}) {
+  const chosenFramework = await chooseFramework({frameworks: integrationTestFrameworks, decisions});
+
+  return scaffoldFrameworkChoice(integrationTestFrameworks, chosenFramework, {projectRoot, dialect});
 }

src/testing/integration/scaffolder.test.js

@@ -1,9 +1,29 @@
-import {describe, it, expect} from 'vitest';
+import {scaffoldChoice} from '@form8ion/javascript-core';
 
+import {describe, it, expect, vi} from 'vitest';
+import {when} from 'vitest-when';
+import any from '@travi/any';
+
+import prompt from './prompt.js';
 import scaffoldIntegrationTesting from './scaffolder.js';
 
+vi.mock('@form8ion/javascript-core');
+vi.mock('./prompt.js');
+
 describe('integration testing scaffolder', () => {
   it('should scaffold the chosen framework', async () => {
-    expect(scaffoldIntegrationTesting()).toEqual({});
+    const projectRoot = any.string();
+    const decisions = any.simpleObject();
+    const dialect = any.word();
+    const chosenFramework = any.word();
+    const integrationTestFrameworks = any.simpleObject();
+    const integrationTestFrameworkResults = any.simpleObject();
+    when(prompt).calledWith({frameworks: integrationTestFrameworks, decisions}).thenResolve(chosenFramework);
+    when(scaffoldChoice)
+      .calledWith(integrationTestFrameworks, chosenFramework, {projectRoot, dialect})
+      .thenResolve(integrationTestFrameworkResults);
+
+    expect(await scaffoldIntegrationTesting({projectRoot, frameworks: integrationTestFrameworks, decisions, dialect}))
+      .toEqual(integrationTestFrameworkResults);
   });
 });

src/testing/unit/prompt.js

@@ -7,7 +7,7 @@ export default async function gatherUnitTestingInput({frameworks, decisions}) {
   const answers = await prompt([{
     name: questionNames.UNIT_TEST_FRAMEWORK,
     type: 'list',
-    message: 'Which type of unit testing framework should be used?',
+    message: 'Which unit testing framework should be used?',
     choices: [...Object.keys(frameworks), 'Other']
   }], decisions);
 

src/testing/unit/prompt.test.js

@@ -9,8 +9,8 @@ import prompt from './prompt.js';
 
 vi.mock('@form8ion/overridable-prompts');
 
-describe('project-type prompts', () => {
-  it('should preset the choice of application-type', async () => {
+describe('unit-test framework prompts', () => {
+  it('should preset the choice of unit-test framework', async () => {
     const chosenType = any.word();
     const decisions = any.simpleObject();
     const answers = {...any.simpleObject(), [questionNames.UNIT_TEST_FRAMEWORK]: chosenType};
@@ -19,7 +19,7 @@ describe('project-type prompts', () => {
       .calledWith([{
         name: questionNames.UNIT_TEST_FRAMEWORK,
         type: 'list',
-        message: 'Which type of unit testing framework should be used?',
+        message: 'Which unit testing framework should be used?',
         choices: [...Object.keys(frameworks), 'Other']
       }], decisions)
       .thenResolve(answers);