added step timeouts tests

Author: DavertMik

lib/listener/globalTimeout.js

@@ -3,7 +3,7 @@ const output = require('../output')
 const recorder = require('../recorder')
 const Config = require('../config')
 const { timeouts } = require('../store')
-const TIMEOUT_ORDER = require('../step').TIMEOUT_ORDER
+const { TIMEOUT_ORDER } = require('../step/timeout')
 
 module.exports = function () {
   let timeout

lib/step/record.js

@@ -1,6 +1,7 @@
 const event = require('../event')
 const recorder = require('../recorder')
 const StepConfig = require('./config')
+const { debug } = require('../output')
 const store = require('../store')
 const { TIMEOUT_ORDER } = require('./timeout')
 const retryStep = require('./retry')
@@ -11,13 +12,17 @@ function recordStep(step, args) {
   const lastArg = args[args.length - 1]
   if (lastArg instanceof StepConfig) {
     const stepConfig = args.pop()
-    const { options, timeout, retry } = stepConfig.getConfig()
+    const { opts, timeout, retry } = stepConfig.getConfig()
 
-    if (options) {
-      store.stepOptions = options
-      step.opts = options
+    if (opts) {
+      debug(`Step ${step.name}: options applied ${JSON.stringify(opts)}`)
+      store.stepOptions = opts
+      step.opts = opts
+    }
+    if (timeout) {
+      debug(`Step ${step.name} timeout ${timeout}s`)
+      step.setTimeout(timeout * 1000, TIMEOUT_ORDER.codeLimitTime)
     }
-    if (timeout) step.setTimeout(timeout, TIMEOUT_ORDER.codeLimitTime)
     if (retry) retryStep(retry)
   }
 

runok.js

@@ -546,6 +546,73 @@ ${changelog}`
       process.exit(1)
     }
   },
+
+  async runnerCreateTests(featureName) {
+    // create runner tests for feature
+    const fs = require('fs').promises
+    const path = require('path')
+
+    // Create directories
+    const configDir = path.join('test/data/sandbox/configs', featureName)
+    await fs.mkdir(configDir, { recursive: true })
+
+    // Create codecept config file
+    const configContent = `exports.config = {
+    tests: './*_test.js',
+    output: './output',
+    helpers: {
+      FileSystem: {},
+    },
+    include: {},
+    bootstrap: false,
+    mocha: {},
+    name: '${featureName} tests'
+  }
+  `
+    await fs.writeFile(path.join(configDir, `codecept.conf.js`), configContent)
+
+    // Create feature test file
+    const testContent = `Feature('${featureName}');
+
+Scenario('test ${featureName}', ({ I }) => {
+  // Add test steps here
+});
+`
+    await fs.writeFile(path.join(configDir, `${featureName}_test.js`), testContent)
+
+    // Create runner test file
+    const runnerTestContent = `const { expect } = require('expect')
+const exec = require('child_process').exec
+const { codecept_dir, codecept_run } = require('./consts')
+const debug = require('debug')('codeceptjs:tests')
+
+const config_run_config = (config, grep, verbose = false) => 
+  \`\${codecept_run} \${verbose ? '--verbose' : ''} --config \${codecept_dir}/configs/${featureName}/\${config} \${grep ? \`--grep "\${grep}"\` : ''}\`
+
+describe('CodeceptJS ${featureName}', function () {
+  this.timeout(10000)
+
+  it('should run ${featureName} test', done => {
+    exec(config_run_config('codecept.conf.js'), (err, stdout) => {
+      debug(stdout)
+      expect(stdout).toContain('OK')
+      expect(err).toBeFalsy()
+      done()
+    })
+  })
+})
+`
+    await fs.writeFile(path.join('test/runner', `${featureName}_test.js`), runnerTestContent)
+
+    console.log(`Created test files for feature: ${featureName}`)
+
+    console.log('Run codecept tests with:')
+    console.log(`./bin/codecept.js run --config ${configDir}/codecept.${featureName}.conf.js`)
+
+    console.log('')
+    console.log('Run tests with:')
+    console.log(`npx mocha test/runner --grep ${featureName}`)
+  },
 }
 
 async function processChangelog() {

test/data/sandbox/configs/step-enhancements/codecept.conf.js

@@ -0,0 +1,14 @@
+exports.config = {
+  tests: './*_test.js',
+  output: './output',
+  helpers: {
+    FileSystem: {},
+    CustomHelper: {
+      require: './custom_helper.js',
+    },
+  },
+  include: {},
+  bootstrap: false,
+  mocha: {},
+  name: 'step-enhancements tests',
+}

test/data/sandbox/configs/step-enhancements/custom_helper.js

@@ -0,0 +1,24 @@
+const { store } = require('codeceptjs')
+
+let retryCount = 0
+
+class MyHelper {
+  retryFewTimesAndPass(num) {
+    if (retryCount < num) {
+      retryCount++
+      throw new Error('Failed on try ' + retryCount)
+    }
+  }
+
+  wait(timeout) {
+    return new Promise(resolve => setTimeout(resolve, timeout))
+  }
+
+  printOption() {
+    if (store.currentStep?.opts) {
+      console.log('Option:', store.currentStep?.opts?.text)
+    }
+  }
+}
+
+module.exports = MyHelper

test/data/sandbox/configs/step-enhancements/step-enhancements_test.js

@@ -0,0 +1,14 @@
+const step = require('codeceptjs/steps')
+Feature('step-enhancements')
+
+Scenario('test step opts', ({ I }) => {
+  I.printOption(step.opts({ text: 'Hello' }))
+})
+
+Scenario('test step timeouts', ({ I }) => {
+  I.wait(1000, step.timeout(0.1))
+})
+
+Scenario('test step retry', ({ I }) => {
+  I.retryFewTimesAndPass(3, step.retry(4))
+})

test/data/sandbox/configs/timeouts/suite_test.js

@@ -1,14 +1,21 @@
-Feature('no timeout');
+const step = require('codeceptjs/steps')
+
+Feature('no timeout')
 
 Scenario('no timeout test #first', ({ I }) => {
-  I.waitForSleep(1000);
-});
+  I.waitForSleep(1000)
+})
 
 Scenario('timeout test in 0.5 #second', { timeout: 0.5 }, ({ I }) => {
-  I.waitForSleep(1000);
-});
+  I.waitForSleep(1000)
+})
 
 Scenario('timeout step in 0.5', ({ I }) => {
-  I.limitTime(0.2).waitForSleep(100);
-  I.limitTime(0.1).waitForSleep(3000);
-});
+  I.limitTime(0.2).waitForSleep(100)
+  I.limitTime(0.1).waitForSleep(3000)
+})
+
+Scenario('timeout step in 0.5 new syntax', ({ I }) => {
+  I.waitForSleep(100, step.timeout(0.2))
+  I.waitForSleep(3000, step.timeout(0.1))
+})

test/runner/step-enhancements_test.js

@@ -0,0 +1,42 @@
+const { expect } = require('expect')
+const exec = require('child_process').exec
+const { codecept_dir, codecept_run } = require('./consts')
+const debug = require('debug')('codeceptjs:tests')
+
+const config_run_config = (config, grep, verbose = false) => `${codecept_run} ${verbose ? '--verbose' : ''} --config ${codecept_dir}/configs/step-enhancements/${config} ${grep ? `--grep "${grep}"` : ''}`
+
+describe('CodeceptJS step-enhancements', function () {
+  this.timeout(10000)
+
+  it('should apply step options', done => {
+    exec(config_run_config('codecept.conf.js', 'opts', true), (err, stdout) => {
+      debug(stdout)
+      expect(stdout).toContain('Option: Hello')
+      expect(stdout).toContain('options applied {"text":"Hello"}')
+      expect(stdout).toContain('print option')
+      expect(stdout).not.toContain('print option {"text":"Hello"}')
+      expect(stdout).toContain('OK')
+      expect(err).toBeFalsy()
+      done()
+    })
+  })
+
+  it('should apply step timeouts', done => {
+    exec(config_run_config('codecept.conf.js', 'timeouts', true), (err, stdout) => {
+      debug(stdout)
+      expect(err).toBeTruthy()
+      expect(stdout).not.toContain('OK')
+      expect(stdout).toContain('was interrupted on step timeout 100ms')
+      done()
+    })
+  })
+
+  it('should apply step retry', done => {
+    exec(config_run_config('codecept.conf.js', 'retry', true), (err, stdout) => {
+      debug(stdout)
+      expect(stdout).toContain('OK')
+      expect(err).toBeFalsy()
+      done()
+    })
+  })
+})