vitest-cucumber-plugin 0.5.3 → 0.5.5

package/RELEASE_NOTES.md

@@ -1,3 +1,5 @@
+* v0.5.5 : Changed dynamic import statements to static ones so that Vitest watch works correctly
+* v0.5.4 : Added vue test
 * v0.5.3 : Provide code snippets when a step definition is not found
 * v0.5.2 : Throw an error if a step file import fails instead of logging it
 * v0.5.1 : Added info level logging for tracing state through steps.  Also added a log file option.

package/package.json

@@ -1,6 +1,6 @@
 {
     "name": "vitest-cucumber-plugin",
-    "version": "0.5.3",
+    "version": "0.5.5",
     "description": "Plugin for Vitest which allows for tests to be written in Cucumber format.",
     "keywords": [
         "vite",
@@ -20,6 +20,7 @@
     },
     "dependencies": {
         "@cucumber/cucumber-expressions": "^16.1.2",
+        "glob": "^10.2.2",
         "lodash": "^4.17.21",
         "moo": "^0.5.2",
         "nearley": "^2.20.1",

package/src/generate/feature.js

@@ -2,8 +2,11 @@ import _ from 'lodash/fp.js';
 import { log } from '../logger.js';
 import { generateExample, generateScenarioOutline, generateRule } from './index.js';
 import { escape, shouldSkip } from './util.js';
+import { glob } from 'glob';
 
-export const generateFeature = (config,feature) => {
+const findJsFiles = async () => glob('features/**/*.js');
+
+export const generateFeature = async (config,feature) => {
     const name = feature.name;
     const statements = feature.statements;
 
@@ -27,6 +30,14 @@ export const generateFeature = (config,feature) => {
     const configStr = JSON.stringify(config);
     const tagsStr = JSON.stringify(feature.tags);
 
+    const jsFilesImportReducer = (imports,file) => {
+        file = file.slice('features/'.length);
+        return imports+`
+import './${file}';`;
+    };
+    const jsFiles = await findJsFiles();
+    const jsFilesImport = _.reduce(jsFilesImportReducer,'',jsFiles);
+
     const code = `import { expect, test, describe, beforeAll, afterAll, beforeEach, afterEach } from 'vitest';
 import {
     Test,
@@ -38,36 +49,10 @@ import {
     applyAfterStepHooks,
 } from 'vitest-cucumber-plugin';
 import { readdir } from 'node:fs/promises';
-import { log, logConfig } from 'vitest-cucumber-plugin';
+import { log, logConfig } from 'vitest-cucumber-plugin';${jsFilesImport}
 
 logConfig(${JSON.stringify(config.log)});
 
-const importDirectory = async (directory) => {
-    log.debug('importDirectory directory: '+directory);
-    try {
-        const files = await readdir(directory);
-
-        for (const file of files) {
-            const filename = directory+'/'+file;
-            log.debug('importDirectory import: '+filename);
-            await import(filename);
-        }
-    } catch (e) {
-        if (e.code === "ENOENT") {
-            return;
-        }
-        throw e;
-    }
-};
-
-const importSupportFiles = async (config) => importDirectory(config.root+'/features/support');
-
-await importSupportFiles(${configStr});
-
-const importStepDefinitions = async (config) => importDirectory(config.root+'/features/step_definitions');
-
-await importStepDefinitions(${configStr});
-
 var state = {};
 
 beforeAll(async () => {

package/src/index.js

@@ -16,10 +16,10 @@ import {
 
 const featureRegex = /\.feature$/;
 
-const compileFeatureToJS = (config,featureSrc) => {
+const compileFeatureToJS = async (config,featureSrc) => {
     const feature = parse(featureSrc);
 
-    const code = generateFeature(config,feature);
+    const code = await generateFeature(config,feature);
 
     return code;
 }
@@ -79,7 +79,7 @@ export default function vitestCucumberPlugin() {
         },
         transform : async (src,id) => {
             if (featureRegex.test(id)) {
-                const code = compileFeatureToJS(config,src);
+                const code = await compileFeatureToJS(config,src);
 
                 log.debug('transform '+id+' -> '+code);
 

package/tests/vue/features/step_definitions/test.js

@@ -0,0 +1,25 @@
+import { Given, When, Then } from 'vitest-cucumber-plugin';
+import Test from '../../src/test.vue';
+import { mount, get } from '../support/components.js';
+import { expect } from 'vitest';
+import _ from 'lodash/fp.js';
+
+Given('I have a test component', (state,params,data) => {
+    return _.set('test',mount(Test),state);
+});
+
+When('I do nothing', (state,params,data) => state);
+
+Then('the test component text is {string}', (state,[ text ],data) => {
+    const testComponent = get(state.test);
+    const textElement = testComponent.get('.text');
+    expect(textElement.text()).toBe(text);
+    return state;
+});
+
+When('I push the button', (state,params,data) => {
+    const testComponent = get(state.test);
+    const buttonElement = testComponent.get('button');
+    buttonElement.trigger('click');
+    return state;
+});

package/tests/vue/features/support/components.js

@@ -0,0 +1,19 @@
+import * as testUtils from '@vue/test-utils';
+import { v4 as uuid } from 'uuid';
+import _ from 'lodash/fp.js';
+
+const components = {};
+
+const mount = (vue,options) => {
+    const id = uuid();
+    const mountOptions = {};
+    components[id] = testUtils.mount(vue,mountOptions);
+    return { id, options };
+};
+
+const get = (component) => components[component.id];
+
+export {
+    mount,
+    get,
+};

package/tests/vue/features/test.feature

@@ -0,0 +1,10 @@
+Feature: Vue component tests example
+  Scenario: Initial state
+    Given I have a test component
+    When I do nothing
+    Then the test component text is "Hello World!"
+
+  Scenario: Button pressed
+    Given I have a test component
+    When I push the button
+    Then the test component text is "Button pressed!"