codeceptjs 3.7.6-beta.4 → 4.0.0-beta.10.esm-aria

package/lib/helper/Appium.js

@@ -1,15 +1,16 @@
-let webdriverio
-
-const fs = require('fs')
-const axios = require('axios').default
-const { v4: uuidv4 } = require('uuid')
-
-const Webdriver = require('./WebDriver')
-const AssertionFailedError = require('../assert/error')
-const { truth } = require('../assert/truth')
-const recorder = require('../recorder')
-const Locator = require('../locator')
-const ConnectionRefused = require('./errors/ConnectionRefused')
+import * as webdriverio from 'webdriverio'
+import fs from 'fs'
+import axios from 'axios'
+import { v4 as uuidv4 } from 'uuid'
+
+import Webdriver from './WebDriver.js'
+import AssertionFailedError from '../assert/error.js'
+import { truth } from '../assert/truth.js'
+import recorder from '../recorder.js'
+import Locator from '../locator.js'
+import ConnectionRefused from './errors/ConnectionRefused.js'
+import ElementNotFound from './errors/ElementNotFound.js'
+import { dontSeeElementError } from './errors/ElementAssertion.js'
 
 const mobileRoot = '//*'
 const webRoot = 'body'
@@ -181,7 +182,6 @@ class Appium extends Webdriver {
     this.appiumV2 = config.appiumV2 || true
     this.axios = axios.create()
 
-    webdriverio = require('webdriverio')
     if (!config.appiumV2) {
       console.log('The Appium core team does not maintain Appium 1.x anymore since the 1st of January 2022. Appium 2.x is used by default.')
       console.log('More info: https://bit.ly/appium-v2-migration')
@@ -1549,11 +1549,9 @@ class Appium extends Webdriver {
     // For mobile native apps, use safe isDisplayed wrapper
     const parsedLocator = parseLocator.call(this, locator)
     const res = await this._locate(parsedLocator, false)
-    const { truth } = require('../assert/truth')
-    const Locator = require('../locator')
 
     if (!res || res.length === 0) {
-      return truth(`elements of ${new Locator(parsedLocator)}`, 'to be seen').negate(false)
+      return truth(`elements of ${Locator.build(parsedLocator)}`, 'to be seen').negate(false)
     }
 
     const selected = []
@@ -1563,7 +1561,7 @@ class Appium extends Webdriver {
     }
 
     try {
-      return truth(`elements of ${new Locator(parsedLocator)}`, 'to be seen').negate(selected)
+      return truth(`elements of ${Locator.build(parsedLocator)}`, 'to be seen').negate(selected)
     } catch (err) {
       throw err
     }
@@ -1714,10 +1712,6 @@ class Appium extends Webdriver {
     // For mobile native apps, use safe isDisplayed wrapper
     const parsedLocator = parseLocator.call(this, locator)
     const res = await this._locate(parsedLocator, true)
-    const ElementNotFound = require('./errors/ElementNotFound')
-    const { truth } = require('../assert/truth')
-    const { dontSeeElementError } = require('./errors/ElementAssertion')
-    const Locator = require('../locator')
 
     if (!res || res.length === 0) {
       throw new ElementNotFound(parsedLocator)
@@ -1730,7 +1724,7 @@ class Appium extends Webdriver {
     }
 
     try {
-      return truth(`elements of ${new Locator(parsedLocator)}`, 'to be seen').assert(selected)
+      return truth(`elements of ${Locator.build(parsedLocator)}`, 'to be seen').assert(selected)
     } catch (e) {
       dontSeeElementError(parsedLocator)
     }
@@ -1784,7 +1778,6 @@ class Appium extends Webdriver {
     // For mobile native apps, use safe isDisplayed wrapper
     const parsedLocator = parseLocator.call(this, locator)
     const aSec = sec || this.options.waitForTimeoutInSeconds
-    const Locator = require('../locator')
 
     return this.browser.waitUntil(
       async () => {
@@ -1801,7 +1794,7 @@ class Appium extends Webdriver {
       },
       {
         timeout: aSec * 1000,
-        timeoutMsg: `element (${new Locator(parsedLocator)}) still not visible after ${aSec} sec`,
+        timeoutMsg: `element (${Locator.build(parsedLocator)}) still not visible after ${aSec} sec`,
       },
     )
   }
@@ -1816,7 +1809,6 @@ class Appium extends Webdriver {
     // For mobile native apps, use safe isDisplayed wrapper
     const parsedLocator = parseLocator.call(this, locator)
     const aSec = sec || this.options.waitForTimeoutInSeconds
-    const Locator = require('../locator')
 
     return this.browser.waitUntil(
       async () => {
@@ -1831,7 +1823,7 @@ class Appium extends Webdriver {
 
         return selected.length === 0
       },
-      { timeout: aSec * 1000, timeoutMsg: `element (${new Locator(parsedLocator)}) still visible after ${aSec} sec` },
+      { timeout: aSec * 1000, timeoutMsg: `element (${Locator.build(parsedLocator)}) still visible after ${aSec} sec` },
     )
   }
 
@@ -1908,4 +1900,4 @@ function onlyForApps(expectedPlatform) {
   }
 }
 
-module.exports = Appium
+export default Appium

package/lib/helper/FileSystem.js

@@ -1,11 +1,11 @@
-const assert = require('assert')
-const path = require('path')
-const fs = require('fs')
+import assert from 'assert'
+import path from 'path'
+import fs from 'fs'
 
-const Helper = require('@codeceptjs/helper')
-const { fileExists } = require('../utils')
-const { fileIncludes } = require('../assert/include')
-const { fileEquals } = require('../assert/equal')
+import Helper from '@codeceptjs/helper'
+import { fileExists } from '../utils.js'
+import { fileIncludes } from '../assert/include.js'
+import { fileEquals } from '../assert/equal.js'
 
 /**
  * Helper for testing filesystem.
@@ -38,7 +38,12 @@ class FileSystem extends Helper {
   }
 
   _before() {
-    this.debugSection('Dir', this.dir)
+    try {
+      this.debugSection('Dir', this.dir)
+    } catch (e) {
+      // Fallback debug for ESM transition
+      console.log(`[Dir] ${this.dir}`)
+    }
   }
 
   /**
@@ -48,7 +53,12 @@ class FileSystem extends Helper {
    */
   amInPath(openPath) {
     this.dir = path.join(global.codecept_dir, openPath)
-    this.debugSection('Dir', this.dir)
+    try {
+      this.debugSection('Dir', this.dir)
+    } catch (e) {
+      // Fallback debug for ESM transition
+      console.log(`[Dir] ${this.dir}`)
+    }
   }
 
   /**
@@ -66,7 +76,12 @@ class FileSystem extends Helper {
    */
   seeFile(name) {
     this.file = path.join(this.dir, name)
-    this.debugSection('File', this.file)
+    try {
+      this.debugSection('File', this.file)
+    } catch (e) {
+      // Fallback debug for ESM transition
+      console.log(`[File] ${this.file}`)
+    }
     assert.ok(fileExists(this.file), `File ${name} not found in ${this.dir}`)
   }
 
@@ -86,7 +101,12 @@ class FileSystem extends Helper {
     if (sec === 0) assert.fail('Use `seeFile` instead of waiting 0 seconds!')
     const waitTimeout = sec * 1000
     this.file = path.join(this.dir, name)
-    this.debugSection('File', this.file)
+    try {
+      this.debugSection('File', this.file)
+    } catch (e) {
+      // Fallback debug for ESM transition
+      console.log(`[File] ${this.file}`)
+    }
     return isFileExists(this.file, waitTimeout).catch(() => {
       throw new Error(`file (${name}) still not present in directory ${this.dir} after ${waitTimeout / 1000} sec`)
     })
@@ -179,7 +199,7 @@ class FileSystem extends Helper {
   }
 }
 
-module.exports = FileSystem
+export { FileSystem as default }
 
 /**
  * @param {string} file

package/lib/helper/GraphQL.js

@@ -1,5 +1,5 @@
-const axios = require('axios').default
-const Helper = require('@codeceptjs/helper')
+import axios from 'axios'
+import HelperModule from '@codeceptjs/helper'
 
 /**
  * GraphQL helper allows to send additional requests to a GraphQl endpoint during acceptance tests.
@@ -227,4 +227,4 @@ class GraphQL extends Helper {
     this.haveRequestHeaders({ Authorization: `Bearer ${accessToken}` })
   }
 }
-module.exports = GraphQL
+export default GraphQL

package/lib/helper/GraphQLDataFactory.js

@@ -1,7 +1,7 @@
-const path = require('path')
+import path from 'path'
 
-const Helper = require('@codeceptjs/helper')
-const GraphQL = require('./GraphQL')
+import HelperModule from '@codeceptjs/helper'
+import GraphQL from './GraphQL.js'
 
 /**
  * Helper for managing remote data using GraphQL queries.
@@ -305,4 +305,4 @@ class GraphQLDataFactory extends Helper {
   }
 }
 
-module.exports = GraphQLDataFactory
+export default GraphQLDataFactory

package/lib/helper/JSONResponse.js

@@ -1,6 +1,6 @@
-const Helper = require('@codeceptjs/helper')
-const assert = require('assert')
-const joi = require('joi')
+import Helper from '@codeceptjs/helper'
+import assert from 'assert'
+import { z } from 'zod'
 
 /**
  * This helper allows performing assertions on JSON responses paired with following helpers:
@@ -83,14 +83,7 @@ class JSONResponse extends Helper {
     this.response = null
   }
 
-  static _checkRequirements() {
-    try {
-      require('joi')
-    } catch (e) {
-      return ['joi']
-    }
-  }
-
+  
   /**
    * Checks that response code is equal to the provided one
    *
@@ -302,28 +295,28 @@ class JSONResponse extends Helper {
   }
 
   /**
-   * Validates JSON structure of response using [joi library](https://joi.dev).
-   * See [joi API](https://joi.dev/api/) for complete reference on usage.
+   * Validates JSON structure of response using [Zod library](https://zod.dev).
+   * See [Zod API](https://zod.dev/) for complete reference on usage.
    *
-   * Use pre-initialized joi instance by passing function callback:
+   * Use pre-initialized Zod instance by passing function callback:
    *
    * ```js
    * // response.data is { name: 'jon', id: 1 }
    *
-   * I.seeResponseMatchesJsonSchema(joi => {
-   *   return joi.object({
-   *     name: joi.string(),
-   *     id: joi.number()
+   * I.seeResponseMatchesJsonSchema(z => {
+   *   return z.object({
+   *     name: z.string(),
+   *     id: z.number()
    *   })
    * });
    *
    * // or pass a valid schema
-   * const joi = require('joi');
+   * import { z } from 'zod';
    *
-   * I.seeResponseMatchesJsonSchema(joi.object({
-   *   name: joi.string(),
-   *   id: joi.number();
-   * });
+   * I.seeResponseMatchesJsonSchema(z.object({
+   *   name: z.string(),
+   *   id: z.number()
+   * }));
    * ```
    *
    * @param {any} fnOrSchema
@@ -332,14 +325,17 @@ class JSONResponse extends Helper {
     this._checkResponseReady()
     let schema = fnOrSchema
     if (typeof fnOrSchema === 'function') {
-      schema = fnOrSchema(joi)
+      schema = fnOrSchema(z)
       const body = fnOrSchema.toString()
       fnOrSchema.toString = () => `${body.split('\n')[1]}...`
     }
-    if (!schema) throw new Error('Empty Joi schema provided, see https://joi.dev/ for details')
-    if (!joi.isSchema(schema)) throw new Error('Invalid Joi schema provided, see https://joi.dev/ for details')
-    schema.toString = () => schema.describe()
-    joi.assert(this.response.data, schema)
+    if (!schema) throw new Error('Empty Zod schema provided, see https://zod.dev/ for details')
+    if (!(schema instanceof z.ZodType)) throw new Error('Invalid Zod schema provided, see https://zod.dev/ for details')
+    schema.toString = () => schema._def.description || JSON.stringify(schema._def)
+    const result = schema.parse(this.response.data)
+    if (!result) {
+      throw new Error('Schema validation failed')
+    }
   }
 
   _checkResponseReady() {
@@ -376,4 +372,4 @@ class JSONResponse extends Helper {
   }
 }
 
-module.exports = JSONResponse
+export { JSONResponse as default }

package/lib/helper/Mochawesome.js

@@ -1,9 +1,10 @@
 let currentTest
 let currentSuite
 
-const Helper = require('@codeceptjs/helper')
-const { clearString } = require('../utils')
-const { testToFileName } = require('../mocha/test')
+import Helper from '@codeceptjs/helper'
+import { createRequire } from 'module'
+import { clearString } from '../utils.js'
+import { testToFileName } from '../mocha/test.js'
 
 class Mochawesome extends Helper {
   constructor(config) {
@@ -15,6 +16,8 @@ class Mochawesome extends Helper {
       disableScreenshots: false,
     }
 
+    // ESM-compatible require for CommonJS module
+    const require = createRequire(import.meta.url)
     this._addContext = require('mochawesome/addContext')
 
     this._createConfig(config)
@@ -90,4 +93,4 @@ class Mochawesome extends Helper {
   }
 }
 
-module.exports = Mochawesome
+export default Mochawesome