codeceptjs 4.0.0-beta.2 → 4.0.0-beta.3

package/typings/promiseBasedTypes.d.ts

@@ -1184,6 +1184,10 @@ declare namespace CodeceptJS {
     // @ts-ignore
     // @ts-ignore
     // @ts-ignore
+    // @ts-ignore
+    // @ts-ignore
+    // @ts-ignore
+    // @ts-ignore
     class ExpectHelper {
         expectEqual(actualValue: any, expectedValue: any, customErrorMsg?: any): Promise<any>;
         expectNotEqual(actualValue: any, expectedValue: any, customErrorMsg?: any): Promise<any>;
@@ -1299,6 +1303,10 @@ declare namespace CodeceptJS {
     // @ts-ignore
     // @ts-ignore
     // @ts-ignore
+    // @ts-ignore
+    // @ts-ignore
+    // @ts-ignore
+    // @ts-ignore
     class ExpectHelper {
         expectEqual(actualValue: any, expectedValue: any, customErrorMsg?: any): Promise<any>;
         expectNotEqual(actualValue: any, expectedValue: any, customErrorMsg?: any): Promise<any>;
@@ -1974,6 +1982,10 @@ declare namespace CodeceptJS {
     // @ts-ignore
     // @ts-ignore
     // @ts-ignore
+    // @ts-ignore
+    // @ts-ignore
+    // @ts-ignore
+    // @ts-ignore
     type MockServerConfig = {
         port?: number;
         host?: string;
@@ -2102,6 +2114,10 @@ declare namespace CodeceptJS {
     // @ts-ignore
     // @ts-ignore
     // @ts-ignore
+    // @ts-ignore
+    // @ts-ignore
+    // @ts-ignore
+    // @ts-ignore
     class MockServer {
         /**
          * Start the mock server
@@ -3179,6 +3195,10 @@ declare namespace CodeceptJS {
     // @ts-ignore
     // @ts-ignore
     // @ts-ignore
+    // @ts-ignore
+    // @ts-ignore
+    // @ts-ignore
+    // @ts-ignore
     type PlaywrightConfig = {
         url?: string;
         browser?: 'chromium' | 'firefox' | 'webkit' | 'electron';
@@ -6559,6 +6579,10 @@ declare namespace CodeceptJS {
     // @ts-ignore
     // @ts-ignore
     // @ts-ignore
+    // @ts-ignore
+    // @ts-ignore
+    // @ts-ignore
+    // @ts-ignore
     type PuppeteerConfig = {
         url: string;
         basicAuth?: any;
@@ -8369,6 +8393,10 @@ declare namespace CodeceptJS {
     // @ts-ignore
     // @ts-ignore
     // @ts-ignore
+    // @ts-ignore
+    // @ts-ignore
+    // @ts-ignore
+    // @ts-ignore
     type RESTConfig = {
         endpoint?: string;
         prettyPrintJson?: boolean;
@@ -9751,6 +9779,10 @@ declare namespace CodeceptJS {
     // @ts-ignore
     // @ts-ignore
     // @ts-ignore
+    // @ts-ignore
+    // @ts-ignore
+    // @ts-ignore
+    // @ts-ignore
     type WebDriverConfig = {
         url: string;
         browser: string;

package/typings/types.d.ts

@@ -1208,6 +1208,10 @@ declare namespace CodeceptJS {
     // @ts-ignore
     // @ts-ignore
     // @ts-ignore
+    // @ts-ignore
+    // @ts-ignore
+    // @ts-ignore
+    // @ts-ignore
     class ExpectHelper {
         expectEqual(actualValue: any, expectedValue: any, customErrorMsg?: any): void;
         expectNotEqual(actualValue: any, expectedValue: any, customErrorMsg?: any): void;
@@ -1323,6 +1327,10 @@ declare namespace CodeceptJS {
     // @ts-ignore
     // @ts-ignore
     // @ts-ignore
+    // @ts-ignore
+    // @ts-ignore
+    // @ts-ignore
+    // @ts-ignore
     class ExpectHelper {
         expectEqual(actualValue: any, expectedValue: any, customErrorMsg?: any): void;
         expectNotEqual(actualValue: any, expectedValue: any, customErrorMsg?: any): void;
@@ -2001,6 +2009,10 @@ declare namespace CodeceptJS {
     // @ts-ignore
     // @ts-ignore
     // @ts-ignore
+    // @ts-ignore
+    // @ts-ignore
+    // @ts-ignore
+    // @ts-ignore
     type MockServerConfig = {
         port?: number;
         host?: string;
@@ -2129,6 +2141,10 @@ declare namespace CodeceptJS {
     // @ts-ignore
     // @ts-ignore
     // @ts-ignore
+    // @ts-ignore
+    // @ts-ignore
+    // @ts-ignore
+    // @ts-ignore
     class MockServer {
         /**
          * Start the mock server
@@ -3272,6 +3288,10 @@ declare namespace CodeceptJS {
     // @ts-ignore
     // @ts-ignore
     // @ts-ignore
+    // @ts-ignore
+    // @ts-ignore
+    // @ts-ignore
+    // @ts-ignore
     type PlaywrightConfig = {
         url?: string;
         browser?: 'chromium' | 'firefox' | 'webkit' | 'electron';
@@ -6803,6 +6823,10 @@ declare namespace CodeceptJS {
     // @ts-ignore
     // @ts-ignore
     // @ts-ignore
+    // @ts-ignore
+    // @ts-ignore
+    // @ts-ignore
+    // @ts-ignore
     type PuppeteerConfig = {
         url: string;
         basicAuth?: any;
@@ -8749,6 +8773,10 @@ declare namespace CodeceptJS {
     // @ts-ignore
     // @ts-ignore
     // @ts-ignore
+    // @ts-ignore
+    // @ts-ignore
+    // @ts-ignore
+    // @ts-ignore
     type RESTConfig = {
         endpoint?: string;
         prettyPrintJson?: boolean;
@@ -10191,6 +10219,10 @@ declare namespace CodeceptJS {
     // @ts-ignore
     // @ts-ignore
     // @ts-ignore
+    // @ts-ignore
+    // @ts-ignore
+    // @ts-ignore
+    // @ts-ignore
     type WebDriverConfig = {
         url: string;
         browser: string;

package/lib/dirname.js

@@ -1,5 +0,0 @@
-import { fileURLToPath } from 'url';
-import { dirname } from 'path';
-
-const __filename = fileURLToPath(import.meta.url);
-export const __dirname = dirname(__filename);

package/lib/helper/Expect.js

@@ -1,425 +0,0 @@
-import * as chai from 'chai';
-import chai_json_schema from 'chai-json-schema';
-import chai_match_pattern from 'chai-match-pattern';
-import chai_exclude from 'chai-exclude';
-import chai_string from 'chai-string';
-import * as output from '../output.js';
-
-chai.use(chai_string);
-// @ts-ignore
-chai.use(chai_exclude);
-chai.use(chai_match_pattern);
-chai.use(chai_json_schema);
-
-/**
- * This helper allows performing assertions based on Chai.
- *
- * ### Examples
- *
- * Zero-configuration when paired with other helpers like REST, Playwright:
- *
- * ```js
- * // inside codecept.conf.js
- *{
- *   helpers: {
- *     Playwright: {...},
- *     Expect: {},
- *   }
- *}
- * ```
- *
- * ## Methods
- */
-class ExpectHelper {
-  /**
-     *
-     * @param {*} actualValue
-     * @param {*} expectedValue
-     * @param {*} [customErrorMsg]
-     */
-  expectEqual(actualValue, expectedValue, customErrorMsg = '') {
-    // @ts-ignore
-    output.output.step(`I expect "${JSON.stringify(actualValue)}" to equal "${JSON.stringify(expectedValue)}"`);
-    return chai.expect(actualValue, customErrorMsg).to.equal(expectedValue);
-  }
-
-  /**
-     *
-     * @param {*} actualValue
-     * @param {*} expectedValue
-     * @param {*} [customErrorMsg]
-     */
-  expectNotEqual(actualValue, expectedValue, customErrorMsg = '') {
-    // @ts-ignore
-    output.output.step(`I expect "${JSON.stringify(actualValue)}" to not equal "${JSON.stringify(expectedValue)}"`);
-    return chai.expect(actualValue, customErrorMsg).not.to.equal(expectedValue);
-  }
-
-  /**
-     *
-     * @param {*} actualValue
-     * @param {*} expectedValue
-     * @param {*} [customErrorMsg]
-
-     */
-  expectDeepEqual(actualValue, expectedValue, customErrorMsg = '') {
-    // @ts-ignore
-    output.output.step(`I expect "${JSON.stringify(actualValue)}" to deep equal "${JSON.stringify(expectedValue)}"`);
-    return chai.expect(actualValue, customErrorMsg).to.deep.equal(expectedValue);
-  }
-
-  /**
-     *
-     * @param {*} actualValue
-     * @param {*} expectedValue
-     * @param {*} [customErrorMsg]
-     */
-  expectNotDeepEqual(actualValue, expectedValue, customErrorMsg = '') {
-    // @ts-ignore
-    output.output.step(`I expect "${JSON.stringify(actualValue)}" to not deep equal "${JSON.stringify(expectedValue)}"`);
-    return chai.expect(actualValue, customErrorMsg).to.not.deep.equal(expectedValue);
-  }
-
-  /**
-     *
-     * @param {*} actualValue
-     * @param {*} expectedValueToContain
-     * @param {*} [customErrorMsg]
-     */
-  expectContain(actualValue, expectedValueToContain, customErrorMsg = '') {
-    // @ts-ignore
-    output.output.step(`I expect "${JSON.stringify(actualValue)}" to contain "${JSON.stringify(expectedValueToContain)}"`);
-    return chai.expect(actualValue, customErrorMsg).to.contain(
-      expectedValueToContain,
-    );
-  }
-
-  /**
-     *
-     * @param {*} actualValue
-     * @param {*} expectedValueToNotContain
-     * @param {*} [customErrorMsg]
-     */
-  expectNotContain(
-    actualValue,
-    expectedValueToNotContain,
-    customErrorMsg = '',
-  ) {
-    // @ts-ignore
-    output.output.step(`I expect "${JSON.stringify(actualValue)}" to not contain "${JSON.stringify(expectedValueToNotContain)}"`);
-    return chai.expect(actualValue, customErrorMsg).not.to.contain(
-      expectedValueToNotContain,
-    );
-  }
-
-  /**
-     *
-     * @param {*} actualValue
-     * @param {*} expectedValueToStartWith
-     * @param {*} [customErrorMsg]
-     */
-  expectStartsWith(actualValue, expectedValueToStartWith, customErrorMsg = '') {
-    // @ts-ignore
-    output.output.step(`I expect "${JSON.stringify(actualValue)}" to start with "${JSON.stringify(expectedValueToStartWith)}"`);
-    return chai.expect(actualValue, customErrorMsg).to.startsWith(
-      expectedValueToStartWith,
-    );
-  }
-
-  /**
-     *
-     * @param {*} actualValue
-     * @param {*} expectedValueToNotStartWith
-     * @param {*} [customErrorMsg]
-     */
-  expectNotStartsWith(
-    actualValue,
-    expectedValueToNotStartWith,
-    customErrorMsg = '',
-  ) {
-    // @ts-ignore
-    output.output.step(`I expect "${JSON.stringify(actualValue)}" to not start with "${JSON.stringify(expectedValueToNotStartWith)}"`);
-    return chai.expect(actualValue, customErrorMsg).not.to.startsWith(
-      expectedValueToNotStartWith,
-    );
-  }
-
-  /**
-     * @param {*} actualValue
-     * @param {*} expectedValueToEndWith
-     * @param {*} [customErrorMsg]
-     */
-  expectEndsWith(actualValue, expectedValueToEndWith, customErrorMsg = '') {
-    // @ts-ignore
-    output.output.step(`I expect "${JSON.stringify(actualValue)}" to end with "${JSON.stringify(expectedValueToEndWith)}"`);
-    return chai.expect(actualValue, customErrorMsg).to.endsWith(
-      expectedValueToEndWith,
-    );
-  }
-
-  /**
-     * @param {*} actualValue
-     * @param {*} expectedValueToNotEndWith
-     * @param {*} [customErrorMsg]
-     */
-  expectNotEndsWith(
-    actualValue,
-    expectedValueToNotEndWith,
-    customErrorMsg = '',
-  ) {
-    // @ts-ignore
-    output.output.step(`I expect "${JSON.stringify(actualValue)}" to not end with "${JSON.stringify(expectedValueToNotEndWith)}"`);
-    return chai.expect(actualValue, customErrorMsg).not.to.endsWith(
-      expectedValueToNotEndWith,
-    );
-  }
-
-  /**
-     * @param {*} targetData
-     * @param {*} jsonSchema
-     * @param {*} [customErrorMsg]
-     */
-  expectJsonSchema(targetData, jsonSchema, customErrorMsg = '') {
-    // @ts-ignore
-    output.output.step(`I expect "${JSON.stringify(targetData)}" to match this JSON schema "${JSON.stringify(jsonSchema)}"`);
-
-    return chai.expect(targetData, customErrorMsg).to.be.jsonSchema(jsonSchema);
-  }
-
-  /**
-     * @param {*} targetData
-     * @param {*} jsonSchema
-     * @param {*} [customErrorMsg]
-     * @param {*} [ajvOptions] Pass AJV options
-     */
-  expectJsonSchemaUsingAJV(
-    targetData,
-    jsonSchema,
-    customErrorMsg = '',
-    ajvOptions = { allErrors: true },
-  ) {
-    // @ts-ignore
-    output.output.step(`I expect "${JSON.stringify(targetData)}" to match this JSON schema using AJV "${JSON.stringify(jsonSchema)}"`);
-    chai.use(require('chai-json-schema-ajv').create(ajvOptions));
-    return chai.expect(targetData, customErrorMsg).to.be.jsonSchema(jsonSchema);
-  }
-
-  /**
-     * @param {*} targetData
-     * @param {*} propertyName
-     * @param {*} [customErrorMsg]
-     */
-  expectHasProperty(targetData, propertyName, customErrorMsg = '') {
-    // @ts-ignore
-    output.output.step(`I expect "${JSON.stringify(targetData)}" to have property: "${JSON.stringify(propertyName)}"`);
-    return chai.expect(targetData, customErrorMsg).to.have.property(propertyName);
-  }
-
-  /**
-     * @param {*} targetData
-     * @param {*} propertyName
-     * @param {*} [customErrorMsg]
-     */
-  expectHasAProperty(targetData, propertyName, customErrorMsg = '') {
-    // @ts-ignore
-    output.output.step(`I expect "${JSON.stringify(targetData)}" to have a property: "${JSON.stringify(propertyName)}"`);
-    return chai.expect(targetData, customErrorMsg).to.have.a.property(propertyName);
-  }
-
-  /**
-     * @param {*} targetData
-     * @param {*} type
-     * @param {*} [customErrorMsg]
-     */
-  expectToBeA(targetData, type, customErrorMsg = '') {
-    // @ts-ignore
-    output.output.step(`I expect "${JSON.stringify(targetData)}" to be a "${JSON.stringify(type)}"`);
-    return chai.expect(targetData, customErrorMsg).to.be.a(type);
-  }
-
-  /**
-     * @param {*} targetData
-     * @param {*} type
-     * @param {*} [customErrorMsg]
-     */
-  expectToBeAn(targetData, type, customErrorMsg = '') {
-    // @ts-ignore
-    output.output.step(`I expect "${JSON.stringify(targetData)}" to be an "${JSON.stringify(type)}"`);
-    return chai.expect(targetData, customErrorMsg).to.be.an(type);
-  }
-
-  /**
-     * @param {*} targetData
-     * @param {*} regex
-     * @param {*} [customErrorMsg]
-     */
-  expectMatchRegex(targetData, regex, customErrorMsg = '') {
-    // @ts-ignore
-    output.output.step(`I expect "${JSON.stringify(targetData)}" to match the regex "${JSON.stringify(regex)}"`);
-    return chai.expect(targetData, customErrorMsg).to.match(regex);
-  }
-
-  /**
-     * @param {*} targetData
-     * @param {*} length
-     * @param {*} [customErrorMsg]
-     */
-  expectLengthOf(targetData, length, customErrorMsg = '') {
-    // @ts-ignore
-    output.output.step(`I expect "${JSON.stringify(targetData)}" to have length of "${JSON.stringify(length)}"`);
-    return chai.expect(targetData, customErrorMsg).to.have.lengthOf(length);
-  }
-
-  /**
-     * @param {*} targetData
-     * @param {*} [customErrorMsg]
-     */
-  expectEmpty(targetData, customErrorMsg = '') {
-    // @ts-ignore
-    output.output.step(`I expect "${JSON.stringify(targetData)}" to be empty`);
-    return chai.expect(targetData, customErrorMsg).to.be.empty;
-  }
-
-  /**
-     * @param {*} targetData
-     * @param {*} [customErrorMsg]
-     */
-  expectTrue(targetData, customErrorMsg = '') {
-    // @ts-ignore
-    output.output.step(`I expect "${JSON.stringify(targetData)}" to be true`);
-    return chai.expect(targetData, customErrorMsg).to.be.true;
-  }
-
-  /**
-     * @param {*} targetData
-     * @param {*} [customErrorMsg]
-     */
-  expectFalse(targetData, customErrorMsg = '') {
-    // @ts-ignore
-    output.output.step(`I expect "${JSON.stringify(targetData)}" to be false`);
-    return chai.expect(targetData, customErrorMsg).to.be.false;
-  }
-
-  /**
-     * @param {*} targetData
-     * @param {*} aboveThan
-     * @param {*} [customErrorMsg]
-     */
-  expectAbove(targetData, aboveThan, customErrorMsg = '') {
-    // @ts-ignore
-    output.output.step(`I expect "${JSON.stringify(targetData)}" to be above ${JSON.stringify(aboveThan)}`);
-    return chai.expect(targetData, customErrorMsg).to.be.above(aboveThan);
-  }
-
-  /**
-     * @param {*} targetData
-     * @param {*} belowThan
-     * @param {*} [customErrorMsg]
-     */
-  expectBelow(targetData, belowThan, customErrorMsg = '') {
-    // @ts-ignore
-    output.output.step(`I expect "${JSON.stringify(targetData)}" to be below ${JSON.stringify(belowThan)}`);
-    return chai.expect(targetData, customErrorMsg).to.be.below(belowThan);
-  }
-
-  /**
-     * @param {*} targetData
-     * @param {*} lengthAboveThan
-     * @param {*} [customErrorMsg]
-     */
-  expectLengthAboveThan(targetData, lengthAboveThan, customErrorMsg = '') {
-    // @ts-ignore
-    output.output.step(`I expect "${JSON.stringify(targetData)}" to have length of above ${JSON.stringify(lengthAboveThan)}`);
-    return chai.expect(targetData, customErrorMsg).to.have.lengthOf.above(
-      lengthAboveThan,
-    );
-  }
-
-  /**
-     * @param {*} targetData
-     * @param {*} lengthBelowThan
-     * @param {*} [customErrorMsg]
-     */
-  expectLengthBelowThan(targetData, lengthBelowThan, customErrorMsg = '') {
-    // @ts-ignore
-    output.output.step(`I expect "${JSON.stringify(targetData)}" to have length of below ${JSON.stringify(lengthBelowThan)}`);
-    return chai.expect(targetData, customErrorMsg).to.have.lengthOf.below(
-      lengthBelowThan,
-    );
-  }
-
-  /**
-     * @param {*} actualValue
-     * @param {*} expectedValue
-     * @param {*} [customErrorMsg]
-     */
-  expectEqualIgnoreCase(actualValue, expectedValue, customErrorMsg = '') {
-    // @ts-ignore
-    output.output.step(`I expect and ingore case "${JSON.stringify(actualValue)}" to equal "${JSON.stringify(expectedValue)}"`);
-    return chai.expect(actualValue, customErrorMsg).to.equalIgnoreCase(
-      expectedValue,
-    );
-  }
-
-  /**
-     * expects members of two arrays are deeply equal
-     * @param {*} actualValue
-     * @param {*} expectedValue
-     * @param {*} [customErrorMsg]
-     */
-  expectDeepMembers(actualValue, expectedValue, customErrorMsg = '') {
-    // @ts-ignore
-    output.output.step(`I expect members of "${JSON.stringify(actualValue)}" and "${JSON.stringify(expectedValue)}" arrays are deeply equal`);
-    return chai.expect(actualValue, customErrorMsg).to.have.deep.members(
-      expectedValue,
-    );
-  }
-
-  /**
-     * expects an array to be a superset of another array
-     * @param {*} superset
-     * @param {*} set
-     * @param {*} [customErrorMsg]
-     */
-  expectDeepIncludeMembers(superset, set, customErrorMsg = '') {
-    // @ts-ignore
-    output.output.step(`I expect "${JSON.stringify(superset)}" array to be a superset of "${JSON.stringify(set)}" array`);
-    return chai.expect(superset, customErrorMsg).to.deep.include.members(
-      set,
-    );
-  }
-
-  /**
-     * expects members of two JSON objects are deeply equal excluding some properties
-     * @param {*} actualValue
-     * @param {*} expectedValue
-     * @param {*} fieldsToExclude
-     * @param {*} [customErrorMsg]
-     */
-  expectDeepEqualExcluding(
-    actualValue,
-    expectedValue,
-    fieldsToExclude,
-    customErrorMsg = '',
-  ) {
-    // @ts-ignore
-    output.output.step(`I expect members of "${JSON.stringify(actualValue)}" and "${JSON.stringify(expectedValue)}" JSON objects are deeply equal excluding properties: ${JSON.stringify(fieldsToExclude)}`);
-    return chai.expect(actualValue, customErrorMsg)
-      .excludingEvery(fieldsToExclude)
-      .to.deep.equal(expectedValue);
-  }
-
-  /**
-     * expects a JSON object matches a provided pattern
-     * @param {*} actualValue
-     * @param {*} expectedPattern
-     * @param {*} [customErrorMsg]
-     */
-  expectMatchesPattern(actualValue, expectedPattern, customErrorMsg = '') {
-    // @ts-ignore
-    output.output.step(`I expect "${JSON.stringify(actualValue)}" to match the ${JSON.stringify(expectedPattern)} pattern`);
-    return chai.expect(actualValue, customErrorMsg).to.matchPattern(expectedPattern);
-  }
-}
-
-export default ExpectHelper;