feat(canary): remove when other test files exist

Author: travi

package-lock.json

@@ -59,7 +59,8 @@
   "dependencies": {
     "@form8ion/config-file": "^1.0.1",
     "@form8ion/core": "^4.0.0",
-    "filedirname": "^3.0.0"
+    "filedirname": "^3.0.0",
+    "tinyglobby": "^0.2.11"
   },
   "devDependencies": {
     "@cucumber/cucumber": "11.2.0",

package.json

@@ -1,3 +1,4 @@
 export {default as scaffold} from './scaffolder.js';
 export {default as test} from './tester.js';
+export {default as lift} from './lifter.js';
 export {default as remove} from './remover.js';

src/canary/index.js

@@ -0,0 +1,48 @@
+import * as td from 'testdouble';
+import any from '@travi/any';
+
+suite('canary lifter', () => {
+  let lift, removeCanary, canaryExists, glob;
+
+  setup(async () => {
+    ({glob} = await td.replaceEsm('tinyglobby'));
+    ({default: removeCanary} = await td.replaceEsm('./remover.js'));
+    ({default: canaryExists} = await td.replaceEsm('./tester.js'));
+
+    ({default: lift} = (await import('./lifter.js')));
+  });
+
+  teardown(() => td.reset());
+
+  test('that the canary file is removed when other test files exist', async () => {
+    const projectRoot = any.string();
+    td.when(canaryExists({projectRoot})).thenResolve(true);
+    td.when(glob(['src/**/*-test.js', '!src/canary-test.js'], {cwd: projectRoot})).thenResolve(['other-test.js']);
+
+    await lift({projectRoot});
+
+    td.verify(removeCanary({projectRoot}));
+  });
+
+  test(
+    'that removing the canary file is not attempted when other test files exist but the canary is already removed',
+    async () => {
+      const projectRoot = any.string();
+      td.when(canaryExists({projectRoot})).thenResolve(false);
+
+      await lift({projectRoot});
+
+      td.verify(removeCanary({projectRoot}), {times: 0});
+    }
+  );
+
+  test('that the removing the canary file is not attempted when other test files do not exist', async () => {
+    const projectRoot = any.string();
+    td.when(canaryExists({projectRoot})).thenResolve(true);
+    td.when(glob(['src/**/*-test.js', '!src/canary-test.js'], {cwd: projectRoot})).thenResolve([]);
+
+    await lift({projectRoot});
+
+    td.verify(removeCanary({projectRoot}), {times: 0});
+  });
+});

src/canary/lifter-test.js

@@ -0,0 +1,16 @@
+import {glob} from 'tinyglobby';
+
+import canaryExists from './tester.js';
+import removeCanary from './remover.js';
+
+async function otherTestFilesExist(projectRoot) {
+  const otherTestFiles = await glob(['src/**/*-test.js', '!src/canary-test.js'], {cwd: projectRoot});
+
+  return 0 < otherTestFiles.length;
+}
+
+export default async function ({projectRoot}) {
+  if (await canaryExists({projectRoot}) && await otherTestFilesExist(projectRoot)) {
+    await removeCanary({projectRoot});
+  }
+}

src/canary/lifter.js

@@ -1,3 +1,4 @@
 export {default as scaffold} from './scaffolder.js';
+export {default as lift} from './lifter.js';
 export {default as test} from './tester.js';
 export {default as remove} from './remover.js';

src/index.js

@@ -0,0 +1,22 @@
+import any from '@travi/any';
+import * as td from 'testdouble';
+
+suite('lifter', () => {
+  let lift, liftCanary;
+
+  setup(async () => {
+    ({lift: liftCanary} = await td.replaceEsm('./canary/index.js'));
+
+    ({default: lift} = (await import('./lifter.js')));
+  });
+
+  teardown(() => td.reset());
+
+  test('that the mocha details are lifted', async () => {
+    const projectRoot = any.string();
+
+    await lift({projectRoot});
+
+    td.verify(liftCanary({projectRoot}));
+  });
+});

src/lifter-test.js

@@ -0,0 +1,5 @@
+import {lift as liftCanary} from './canary/index.js';
+
+export default async function ({projectRoot}) {
+  await liftCanary({projectRoot});
+}

src/lifter.js

@@ -0,0 +1,20 @@
+Feature: Lift Mocha
+
+  Scenario: canary test without other tests yet
+    Given a mocharc file exists
+    And the canary test still exists
+    When the project is lifted
+    Then the canary test is not removed
+
+  Scenario: other mocha tests exist, but canary test still exists
+    Given a mocharc file exists
+    And other mocha tests exist
+    And the canary test still exists
+    When the project is lifted
+    Then the canary test is removed
+
+  Scenario: other mocha tests exist, but canary test no longer exists
+    Given a mocharc file exists
+    And other mocha tests exist
+    When the project is lifted
+    Then the canary test is removed

test/integration/features/lift.feature

@@ -4,4 +4,5 @@ Feature: scaffold
     When the project is scaffolded
     Then the testing framework is configured
     And dependencies are defined
+    And the filename pattern is reported
     And a canary test exists to ensure the framework configuration works