support windows

Author: kobenguyent

.github/workflows/test.yml

@@ -53,6 +53,27 @@ jobs:
       - name: Stop mock server
         run: npm run mock-server:stop
 
+  unit-tests-windows:
+    name: Unit tests
+    runs-on: windows-latest
+    timeout-minutes: 15
+
+    strategy:
+      matrix:
+        node-version: [ 20.x ]
+
+    steps:
+      - uses: actions/checkout@v6
+      - name: Use Node.js ${{ matrix.node-version }}
+        uses: actions/setup-node@v6
+        with:
+          node-version: ${{ matrix.node-version }}
+      - run: npm i
+        env:
+          PLAYWRIGHT_SKIP_BROWSER_DOWNLOAD: true
+          PUPPETEER_SKIP_CHROMIUM_DOWNLOAD: true
+      - run: npm run test:unit
+
   runner-tests:
     name: Runner tests
     runs-on: ubuntu-22.04

bin/codecept.js

@@ -5,6 +5,8 @@ import Codecept from '../lib/codecept.js'
 import output from '../lib/output.js'
 const { print, error } = output
 import { printError } from '../lib/command/utils.js'
+import { isWindows } from '../lib/utils.js'
+import { pathToFileURL } from 'url'
 
 const commandFlags = {
   ai: {
@@ -45,7 +47,7 @@ const errorHandler =
   }
 
 const dynamicImport = async modulePath => {
-  const module = await import(modulePath)
+  const module = isWindows() ? await import(pathToFileURL(modulePath).href) : await import(modulePath)
   return module.default || module
 }
 

lib/ai.js

@@ -4,9 +4,9 @@ import output from './output.js'
 import event from './event.js'
 import { removeNonInteractiveElements, minifyHtml, splitByChunks } from './html.js'
 import { generateText } from 'ai'
-import { fileURLToPath } from 'url'
+import { fileURLToPath, pathToFileURL } from 'url'
 import path from 'path'
-import { fileExists } from './utils.js'
+import { fileExists, isWindows } from './utils.js'
 import store from './store.js'
 
 const __dirname = path.dirname(fileURLToPath(import.meta.url))
@@ -34,7 +34,7 @@ async function loadPrompts() {
     }
 
     try {
-      const module = await import(promptPath)
+      const module = isWindows() ?  await import(pathToFileURL(promptPath).href) : await import(promptPath)
       prompts[name] = module.default || module
       debug(`Loaded prompt ${name} from ${promptPath}`)
     } catch (err) {

lib/codecept.js

@@ -17,7 +17,7 @@ import event from './event.js'
 import runHook from './hooks.js'
 import ActorFactory from './actor.js'
 import output from './output.js'
-import { emptyFolder } from './utils.js'
+import { emptyFolder, isWindows } from './utils.js'
 import { initCodeceptGlobals } from './globals.js'
 import { validateTypeScriptSetup, getTSNodeESMWarning } from './utils/loaderCheck.js'
 import recorder from './recorder.js'
@@ -73,7 +73,7 @@ class Codecept {
           // For npm packages, resolve from the user's directory
           // This ensures packages like tsx are found in user's node_modules
           const userDir = store.codeceptDir || process.cwd()
-          
+
           try {
             // Use createRequire to resolve from user's directory
             const userRequire = createRequire(pathToFileURL(resolve(userDir, 'package.json')).href)
@@ -86,7 +86,7 @@ class Codecept {
           }
         }
         // Use dynamic import for ESM
-        await import(modulePath)
+        isWindows() ? await import(pathToFileURL(modulePath).href) : await import(modulePath)
       }
     }
   }
@@ -137,7 +137,7 @@ class Codecept {
       ]
 
       for (const modulePath of listenerModules) {
-        const module = await import(modulePath)
+        const module = isWindows() ? await import(pathToFileURL(modulePath).href) : await import(modulePath)
         runHook(module.default || module)
       }
     }

lib/config.js

@@ -1,8 +1,9 @@
 import fs from 'fs'
 import path from 'path'
 import { createRequire } from 'module'
-import { fileExists, isFile, deepMerge, deepClone } from './utils.js'
+import { fileExists, isFile, deepMerge, deepClone, isWindows } from './utils.js'
 import { transpileTypeScript, cleanupTempFiles, fixErrorStack } from './utils/typescript.js'
+import { pathToFileURL } from 'url'
 
 const defaultConfig = {
   output: './_output',
@@ -96,7 +97,7 @@ class Config {
       // Try different extensions if the file doesn't exist
       const extensions = ['.ts', '.cjs', '.mjs']
       let found = false
-      
+
       for (const ext of extensions) {
         const altConfig = configFile.replace(/\.js$/, ext)
         if (fileExists(altConfig)) {
@@ -105,7 +106,7 @@ class Config {
           break
         }
       }
-      
+
       if (!found) {
         throw new Error(`Config file ${configFile} does not exist. Execute 'codeceptjs init' to create config`)
       }
@@ -242,7 +243,7 @@ async function loadConfigFile(configFile) {
           allTempFiles = result.allTempFiles
           fileMapping = result.fileMapping
 
-          configModule = await import(tempFile)
+          configModule = isWindows() ? await import(pathToFileURL(tempFile).href) : await import(tempFile)
           cleanupTempFiles(allTempFiles)
         } catch (err) {
           transpileError = err

lib/container.js

@@ -5,7 +5,15 @@ import { isMainThread } from 'worker_threads'
 import debugModule from 'debug'
 const debug = debugModule('codeceptjs:container')
 import { MetaStep } from './step.js'
-import { methodsOfObject, fileExists, isFunction, isAsyncFunction, installedLocally, deepMerge } from './utils.js'
+import {
+  methodsOfObject,
+  fileExists,
+  isFunction,
+  isAsyncFunction,
+  installedLocally,
+  deepMerge,
+  isWindows,
+} from './utils.js'
 import { transpileTypeScript, cleanupTempFiles, fixErrorStack } from './utils/typescript.js'
 import Translation from './translation.js'
 import MochaFactory from './mocha/factory.js'
@@ -17,6 +25,7 @@ import Result from './result.js'
 import ai from './ai.js'
 import actorFactory from './actor.js'
 import Config from './config.js'
+import { pathToFileURL } from 'url'
 
 let asyncHelperPromise
 
@@ -434,7 +443,7 @@ async function requireHelperFromModule(helperName, config, HelperClass) {
     try {
       // For built-in helpers, use direct relative import with .js extension
       const helperPath = `${moduleName}.js`
-      const mod = await import(helperPath)
+      const mod = isWindows() ? await import(pathToFileURL(helperPath).href) : await import(helperPath)
       HelperClass = mod.default || mod
     } catch (err) {
       throw err
@@ -472,7 +481,7 @@ async function requireHelperFromModule(helperName, config, HelperClass) {
     // check if the new syntax export default HelperName is used and loads the Helper, otherwise loads the module that used old syntax export = HelperName.
     try {
       // Try dynamic import for both CommonJS and ESM modules
-      const mod = await import(importPath)
+      const mod = isWindows() ? await import(pathToFileURL(importPath).href) : await import(importPath)
       if (!mod && !mod.default) {
         throw new Error(`Helper module '${moduleName}' was not found. Make sure you have installed the package correctly.`)
       }
@@ -488,7 +497,7 @@ async function requireHelperFromModule(helperName, config, HelperClass) {
       if (fileMapping) {
         fixErrorStack(err, fileMapping)
       }
-      
+
       // Clean up temp files before rethrowing
       if (tempJsFile) {
         const filesToClean = Array.isArray(tempJsFile) ? tempJsFile : [tempJsFile]
@@ -683,7 +692,7 @@ async function loadPluginAsync(modulePath, config) {
   let pluginMod
   try {
     // Try dynamic import first (works for both ESM and CJS)
-    pluginMod = await import(modulePath)
+    pluginMod = isWindows() ? await import(pathToFileURL(modulePath).href) : await import(modulePath)
   } catch (err) {
     throw new Error(`Could not load plugin from '${modulePath}': ${err.message}`)
   }
@@ -896,7 +905,7 @@ async function loadSupportObject(modulePath, supportObjectName) {
       if (fileMapping) {
         fixErrorStack(importError, fileMapping)
       }
-      
+
       // Clean up temp files if created before rethrowing
       if (tempJsFile) {
         const filesToClean = Array.isArray(tempJsFile) ? tempJsFile : [tempJsFile]

lib/helper/ApiDataFactory.js

@@ -2,6 +2,8 @@ import path from 'path'
 import Helper from '@codeceptjs/helper'
 import REST from './REST.js'
 import store from '../store.js'
+import { isWindows } from '../utils.js'
+import { pathToFileURL } from 'url'
 
 /**
  * Helper for managing remote data using REST API.
@@ -328,7 +330,7 @@ class ApiDataFactory extends Helper {
         modulePath = path.join(store.codeceptDir, modulePath)
       }
       // check if the new syntax `export default new Factory()` is used and loads the builder, otherwise loads the module that used old syntax `module.exports = new Factory()`.
-      const module = await import(modulePath)
+      const module = isWindows() ? await import(pathToFileURL(modulePath).href) : await import(modulePath)
       const builder = module.default || module
       return builder.build(data, options)
     } catch (err) {

lib/rerun.js

@@ -5,6 +5,8 @@ import event from './event.js'
 import BaseCodecept from './codecept.js'
 import output from './output.js'
 import { createRequire } from 'module'
+import { isWindows } from './utils.js'
+import { pathToFileURL } from 'url'
 
 const require = createRequire(import.meta.url)
 
@@ -51,7 +53,7 @@ class CodeceptRerunner extends BaseCodecept {
 
             // Force reload the module by using a cache-busting query parameter
             const fileUrl = `${fsPath.resolve(file)}?t=${Date.now()}`
-            await import(fileUrl)
+            isWindows() ? await import(pathToFileURL(fileUrl).href) : await import(fileUrl)
           } catch (e) {
             console.error(`Error loading test file ${file}:`, e)
           }

lib/utils.js

@@ -229,7 +229,7 @@ export const test = {
           // Use Node.js child_process.spawnSync with platform-specific sleep commands
           // This avoids busy waiting and allows other processes to run
           try {
-            if (os.platform() === 'win32') {
+            if (isWindows()) {
               // Windows: use ping with precise timing (ping waits exactly the specified ms)
               spawnSync('ping', ['-n', '1', '-w', pollInterval.toString(), '127.0.0.1'], { stdio: 'ignore' })
             } else {
@@ -735,3 +735,7 @@ export const markdownToAnsi = function (markdown) {
       })
   )
 }
+
+export function isWindows() {
+  return os.platform() === 'win32'
+}

test/unit/utils_test.js

@@ -6,6 +6,7 @@ import sinon from 'sinon'
 import * as utils from '../../lib/utils.js'
 import store from '../../lib/store.js'
 import playwright from 'playwright'
+import { isWindows } from '../../lib/utils.js'
 
 const __filename = fileURLToPath(import.meta.url)
 const __dirname = path.dirname(__filename)
@@ -326,7 +327,7 @@ describe('utils', () => {
 
     it('returns the given filename for absolute one', () => {
       const _path = utils.screenshotOutputFolder('/Users/someuser/workbase/project1/test_output/screenshot1.failed.png'.replace(/\//g, path.sep))
-      if (os.platform() === 'win32') {
+      if (isWindows()) {
         expect(_path).eql(path.resolve(store.codeceptDir, '/Users/someuser/workbase/project1/test_output/screenshot1.failed.png'))
       } else {
         expect(_path).eql('/Users/someuser/workbase/project1/test_output/screenshot1.failed.png')