feat(testing): enabled integration testing with cucumber

Author: travi

.eslintrc.yml

@@ -2,3 +2,8 @@ extends:
   - '@form8ion'
   - '@form8ion/mocha'
   - '@form8ion/cucumber'
+
+overrides:
+  - files: example.js
+    rules:
+      import/no-extraneous-dependencies: off

README.md

@@ -38,7 +38,7 @@ $ npm install @form8ion/remark-plugin-scaffolder --save-prod
 ```javascript
 import {scaffold} from '@form8ion/remark-plugin-scaffolder';
 
-scaffold();
+scaffold({projectRoot: process.cwd(), tests: {integration: true}});
 ```
 
 ## Contributing

example.js

@@ -1,3 +1,14 @@
+// #### Import
+// remark-usage-ignore-next
+import stubbedFs from 'mock-fs';
 import {scaffold} from './lib/index.cjs';
 
-scaffold();
+// remark-usage-ignore-next
+stubbedFs();
+
+// #### Execute
+
+scaffold({projectRoot: process.cwd(), tests: {integration: true}});
+
+// remark-usage-ignore-next
+stubbedFs.restore();

package-lock.json

@@ -63,6 +63,7 @@
     "husky": "4.2.5",
     "lockfile-lint": "4.2.2",
     "mocha": "7.1.1",
+    "mock-fs": "^4.11.0",
     "npm-run-all": "4.1.5",
     "nyc": "15.0.1",
     "remark-cli": "8.0.0",
@@ -73,5 +74,8 @@
     "rollup-plugin-auto-external": "2.0.0",
     "sinon": "9.0.2",
     "travis-lint": "1.0.0"
+  },
+  "dependencies": {
+    "@form8ion/cucumber-scaffolder": "^1.1.0"
   }
 }

package.json

@@ -1,7 +1,26 @@
+import any from '@travi/any';
+import {assert} from 'chai';
+import sinon from 'sinon';
+import * as scaffoldTesting from './testing';
 import scaffold from './scaffold';
 
 suite('scaffold', () => {
+  let sandbox;
+
+  setup(() => {
+    sandbox = sinon.createSandbox();
+
+    sandbox.stub(scaffoldTesting, 'default');
+  });
+
+  teardown(() => sandbox.restore());
+
   test('that the plugin is initialized', async () => {
-    await scaffold();
+    const projectRoot = any.string();
+    const tests = any.simpleObject();
+    const testingResults = any.simpleObject();
+    scaffoldTesting.default.withArgs({projectRoot, tests}).resolves(testingResults);
+
+    assert.deepEqual(await scaffold({projectRoot, tests}), testingResults);
   });
 });

src/scaffold-test.js

@@ -1,3 +1,5 @@
-export default function () {
+import scaffoldTesting from './testing';
 
+export default function ({projectRoot, tests}) {
+  return scaffoldTesting({projectRoot, tests});
 }

src/scaffold.js

@@ -0,0 +1,32 @@
+import * as cucumberScaffolder from '@form8ion/cucumber-scaffolder';
+import sinon from 'sinon';
+import {assert} from 'chai';
+import any from '@travi/any';
+import scaffoldTesting from './testing';
+
+suite('testing', () => {
+  let sandbox;
+  const projectRoot = any.string();
+
+  setup(() => {
+    sandbox = sinon.createSandbox();
+
+    sandbox.stub(cucumberScaffolder, 'scaffold');
+  });
+
+  teardown(() => sandbox.restore());
+
+  test('that a canary cucumber test is created when the project will be integration tested', async () => {
+    const cucumberResults = any.simpleObject();
+    cucumberScaffolder.scaffold
+      .withArgs({projectRoot})
+      .returns(cucumberResults);
+
+    assert.deepEqual(await scaffoldTesting({projectRoot, tests: {integration: true}}), cucumberResults);
+  });
+
+  test('that no canary test is created when the project will not be integration tested', async () => {
+    assert.deepEqual(await scaffoldTesting({projectRoot, tests: {integration: false}}), {});
+    assert.notCalled(cucumberScaffolder.scaffold);
+  });
+});

src/testing-test.js

@@ -0,0 +1,9 @@
+import {scaffold as scaffoldCucumber} from '@form8ion/cucumber-scaffolder';
+
+export default async function ({projectRoot, tests}) {
+  if (tests.integration) {
+    return scaffoldCucumber({projectRoot});
+  }
+
+  return {};
+}