vitest-cucumber-plugin 0.5.0 → 0.5.1

package/README.md

@@ -24,12 +24,19 @@ export default defineConfig({
     test: {
         include : [ '**/*.feature' ],
         cucumber : {
-           tags : "<tags boolean expression>"
+           tags : "<tags boolean expression>", // Use this to filter the test via boolean tags expression
+           log : { 
+              level : "<'fatal', 'error', 'warn', 'info', 'debug', 'trace' or 'silent'>",
+              file : "<log path>", // Write the logs to a file instead of stdio (the default)
+           }
         }
     },
 })
 ```
 
+Setting the log level to 'info' will cause the plugin to generate logs useful for tracking the state through
+the steps.  You can pipe the logs through pino-pretty to make them more human readable.
+
 ### Writing tests
 
 Put feature files into the 'features/' directory and step definitions into the 'features/step_definitions/' directory.

package/RELEASE_NOTES.md

@@ -1,3 +1,4 @@
+* v0.5.1 : Added info level logging for tracing state through steps.  Also added a log file option.
 * v0.5.0 : Implemented Doc Strings.  Plugin is now feature complete.
 * v0.1.8 : Implemented Rule keyword
 * v0.1.7 : Implemented Hooks API

package/package.json

@@ -1,6 +1,6 @@
 {
     "name": "vitest-cucumber-plugin",
-    "version": "0.5.0",
+    "version": "0.5.1",
     "description": "Plugin for Vitest which allows for tests to be written in Cucumber format.",
     "keywords": [
         "vite",

package/src/generate/feature.js

@@ -38,9 +38,9 @@ import {
     applyAfterStepHooks,
 } from 'vitest-cucumber-plugin';
 import { readdir } from 'node:fs/promises';
-import { log, setLogLevel } from 'vitest-cucumber-plugin';
+import { log, logConfig } from 'vitest-cucumber-plugin';
 
-setLogLevel('${config.logLevel}');
+logConfig(${JSON.stringify(config.log)});
 
 const importDirectory = async (directory) => {
     log.debug('importDirectory directory: '+directory);

package/src/hooks.js

@@ -11,6 +11,16 @@ const allHooks = {
     afterStep : [],
 };
 
+const hookNames = {
+    beforeAll : 'BeforeAll',
+    before : 'Before',
+    beforeStep : 'BeforeStep',
+    afterAll : 'AfterAll',
+    after : 'After',
+    afterStep : 'AfterStep',
+}
+    
+
 const applyHooks = async (hooksName,state,tags) => {
     const hooks = allHooks[hooksName];
     log.debug('applyHooks: '+hooksName+' state: '+JSON.stringify(state));
@@ -23,8 +33,10 @@ const applyHooks = async (hooksName,state,tags) => {
         
         log.debug('applyHooks match? '+result+' tags: '+JSON.stringify(tags));
         if (result) {
+            const origState = state;
             state = await hook.f(state);
-            log.debug('applyHooks name: '+hook.name+' new state: '+JSON.stringify(state));
+            log.info(hookNames[hooksName]+'(\''+hook.name+'\') ('+JSON.stringify(origState)+') => '+
+                     JSON.stringify(state));
         }
     }
     return state;

package/src/index.js

@@ -2,7 +2,7 @@ import _ from 'lodash/fp.js';
 import { addStepDefinition, findStepDefinitionMatch } from './steps.js';
 import { parameterizeText } from './parameterize.js';
 import { generateFeature } from './generate/index.js';
-import { log, setLogLevel } from './logger.js';
+import { log, logConfig } from './logger.js';
 import { parse } from './parse.js';
 import { tagsFunction } from './tags.js';
 import {
@@ -35,7 +35,7 @@ export {
     applyAfterStepHooks,
 };
 
-export { setLogLevel, log };
+export { log, logConfig };
 
 export const Given = addStepDefinition;
 export const When = addStepDefinition;
@@ -48,6 +48,9 @@ export const Test = (state,step) => {
     const extraData = step.dataTable ? step.dataTable : (step.docString ? step.docString.text : null );
 
     const newState = stepDefinitionMatch.stepDefinition.f(state,stepDefinitionMatch.parameters,extraData);
+    log.info(step.type.name+'(\''+stepDefinitionMatch.stepDefinition.expression+'\') ('+
+             JSON.stringify(state)+','+JSON.stringify(stepDefinitionMatch.parameters)+','+JSON.stringify(extraData)+
+             ') => '+JSON.stringify(newState));
     log.debug('Test newState: '+JSON.stringify(newState));
 
     return newState;
@@ -66,8 +69,9 @@ export default function vitestCucumberPlugin() {
     return {
         name : 'vitest-cucumber-transform',
         configResolved : (resolvedConfig) => {
-            config = _.defaults({ root : resolvedConfig.root, logLevel : 'warn' },_.get('test.cucumber',resolvedConfig))
-            setLogLevel(config.logLevel);
+            config = _.defaults({ root : resolvedConfig.root, log : { level : 'warn' } },
+                                _.get('test.cucumber',resolvedConfig))
+            logConfig(config.log);
 
             config = _.set('tagsFunction',tagsFunction(_.get('tags',config)),config);
 

package/src/logger.js

@@ -1,7 +1,14 @@
+import _ from 'lodash/fp.js';
 import pino from 'pino';
 
-export const log = pino();
+export var log = pino();
 
 log.level = 'warn';
 
-export const setLogLevel = (logLevel) => { log.level = logLevel };
+export const logConfig = (config) => {
+    if (_.has('file',config)) {
+        log = pino(config,config.file);
+    } else {
+        log = pino(config);
+    }
+};

package/tests/comments/vite.config.js

@@ -4,6 +4,6 @@ import vitestCucumberPlugin from 'vitest-cucumber-plugin';
 export default defineConfig({
     plugins: [vitestCucumberPlugin()],
     test: {
-        include : [ '**/*.feature' ]
+        include : [ '**/*.feature' ],
     },
 })

package/tests/data-tables/vite.config.js

@@ -1,9 +1,13 @@
 import { defineConfig } from 'vitest/config'
 import vitestCucumberPlugin from 'vitest-cucumber-plugin';
 
-export default defineConfig({
-    plugins: [vitestCucumberPlugin()],
-    test: {
-        include : [ '**/*.feature' ]
-    },
-})
+export default defineConfig(({ mode }) => {
+    const level = (mode === 'test-debug') ? 'info' : 'warn';
+    return {
+        plugins: [vitestCucumberPlugin()],
+        test: {
+            include : [ '**/*.feature' ],
+            cucumber : { log : { level } },
+        },
+    }
+});

package/tests/doc-strings/vite.config.js

@@ -1,9 +1,13 @@
 import { defineConfig } from 'vitest/config'
 import vitestCucumberPlugin from 'vitest-cucumber-plugin';
 
-export default defineConfig({
-    plugins: [vitestCucumberPlugin()],
-    test: {
-        include : [ '**/*.feature' ],
-    },
-})
+export default defineConfig(({ mode }) => {
+    const logLevel = (mode === 'test-debug') ? 'info' : 'warn';
+    return {
+        plugins: [vitestCucumberPlugin()],
+        test: {
+            include : [ '**/*.feature' ],
+            cucumber : { logLevel },
+        },
+    }
+});

package/tests/hooks/vite.config.js

@@ -1,9 +1,13 @@
 import { defineConfig } from 'vitest/config'
 import vitestCucumberPlugin from 'vitest-cucumber-plugin';
 
-export default defineConfig({
-    plugins: [vitestCucumberPlugin()],
-    test: {
-        include : [ '**/*.feature' ],
-    },
-})
+export default defineConfig(({ mode }) => {
+    const level = (mode === 'test-debug') ? 'info' : 'warn';
+    return {
+        plugins: [vitestCucumberPlugin()],
+        test: {
+            include : [ '**/*.feature' ],
+            cucumber : { log : { level } },
+        },
+    }
+});

package/tests/is-it-friday/vite.config.js

@@ -1,9 +1,13 @@
 import { defineConfig } from 'vitest/config'
 import vitestCucumberPlugin from 'vitest-cucumber-plugin';
 
-export default defineConfig({
-    plugins: [vitestCucumberPlugin()],
-    test: {
-        include : [ '**/*.feature' ]
-    },
-})
+export default defineConfig(({ mode }) => {
+    const level = (mode === 'test-debug') ? 'info' : 'warn';
+    return {
+        plugins: [vitestCucumberPlugin()],
+        test: {
+            include : [ '**/*.feature' ],
+            cucumber : { log : { level } },
+        },
+    }
+});