@genesislcap/foundation-testing 14.202.1-alpha-77ef7ac.0 → 14.203.0

package/README.md

@@ -7,50 +7,50 @@
 
 ## Unit Testing
 
-The `foundation-testing` package combines tools like `UVU` and `Sinon.JS`, offering a comprehensive framework for implementing Unit Tests. This setup is designed to ensure that your Genesis Web Application delivers a seamless user experience by thoroughly covering components, functions and user interactions across various scenarios.
+The foundation-testing package is a comprehensive framework for implementing Unit Tests. Use it to ensure that your Genesis Web Application provides a seamless user experience by testing components, functions and user interactions across various scenarios.
 
 ### **Key Tools and Features:**
 
-- **Customizable Unit Test Suites**: Manage and create detailed test suites within the `tests/unit` folder, focusing on critical components and functions. These test suites are fully customizable by default, allowing for comprehensive coverage of different parts of the application.
-- **Sinon Integration**: Leverage `Sinon.JS` to easily incorporate test spies, stubs and mocks into your Unit Tests if needed.
-- **Very lightweight**: The test framework provided by `foundation-testing` is very lightweight and contains [minimal dependencies](https://npm.anvaka.com/#/view/2d/uvu).
+- **Customizable Unit Test Suites**: Manage and create detailed test suites in the **tests/unit** folder, focusing on critical components and functions. These test suites are fully customizable by default, so you can cover all different parts of the application.
+- **Sinon integration**: Use Sinon.JS to incorporate test spies, stubs and mocks into your Unit Tests.
+- **Very lightweight**: The test framework provided by foundation-testing is very lightweight and contains [minimal dependencies](https://npm.anvaka.com/#/view/2d/uvu).
 - **Extremely performant**: Much faster than competing test runners, see [benchmarks](https://github.com/lukeed/uvu/tree/master#benchmarks).
 - **Individually executable test files**: You can keep your tests suites organized by splitting them into multiple files (optional). 
-- **Browser-compatible**: You can easily run and debug your tests in a browser environment which allows you to leverage browser developer tools.
+- **Browser-compatible**: You can easily run and debug your tests in a browser environment, which allows you to use browser developer tools.
 
 ### **Getting Started with Unit Testing:**
 
-- Define test suites within the `tests/unit` folder, targeting critical components and functions.
-- Utilize UVU for fast and lightweight Unit Testing.
-- Utilize Sinon.JS if you need spies, stubs or mocks.
+- Define test suites in the **tests/unit** folder, targeting critical components and functions.
+- Use UVU for fast and lightweight Unit Testing.
+- Use Sinon.JS if you need spies, stubs or mocks.
 - Execute tests locally or on your CI pipeline, ensuring reliable and consistent outcomes.
 
 ## E2E Testing
 
-The `foundation-testing` package combines tools like Playwright and Lighthouse, offering a comprehensive framework for implementing End-to-End (E2E) testing. This setup is designed to ensure that your Genesis Web Application delivers a seamless user experience by thoroughly covering workflows and user interactions across various scenarios.
+The foundation-testing package is a comprehensive framework for implementing End-to-End (E2E) testing. use it to ensure that your Genesis Web Application provides a seamless user experience by testing workflows and user interactions across various scenarios.
 
 ### **Key Tools and Features:**
 
-- **Customizable E2E Scenarios**: Manage and create detailed test scenarios within the `tests/e2e` folder, focusing on critical user journeys. These scenarios are fully customizable by default, allowing for comprehensive coverage of different user paths and interactions.
-- **Playwright Integration**: Leverage Playwright to automate browser actions, simulate user interactions, and verify that your application behaves as expected across different browsers. Playwright supports cross-browser testing, parallel test execution, and context isolation, allowing for robust and scalable E2E tests. Additionally, Playwright can capture videos, screenshots, and other artifacts when a test fails, aiding in debugging and issue resolution.
-- **Lighthouse Performance Testing**: Integrate Lighthouse to measure and improve the performance, accessibility, SEO, and overall quality of your web applications. Use Lighthouse reports to track key performance metrics such as load time, interactivity, and visual stability, and enforce performance budgets to maintain a high standard for user experience.
-- **Automated Testing Pipeline**: Integrate your E2E tests into a continuous integration (CI) pipeline, ensuring that every change to the codebase is thoroughly tested before deployment. This automation reduces the risk of introducing bugs and ensures consistent test outcomes across different environments.
+- **Customizable E2E scenarios**: Manage and create detailed test scenarios within the **tests/e2e** folder, focusing on critical user journeys. These scenarios are fully customizable by default, allowing for comprehensive coverage of different user paths and interactions.
+- **Playwright integration**: Use Playwright to automate browser actions, simulate user interactions, and verify that your application behaves as expected across different browsers. Playwright supports cross-browser testing, parallel test execution, and context isolation, allowing for robust and scalable E2E tests. Playwright can capture videos, screenshots, and other artifacts when a test fails, aiding in debugging and issue resolution.
+- **Lighthouse performance testing**: Integrate Lighthouse to measure and improve the performance, accessibility, SEO, and overall quality of your web applications. Use Lighthouse reports to track key performance metrics, such as load time, interactivity, and visual stability, and enforce performance budgets to maintain a high standard for user experience.
+- **Automated testing pipeline**: Integrate your E2E tests into a continuous integration (CI) pipeline, ensuring that every change to the codebase is thoroughly tested before deployment. This automation reduces the risk of bugs and ensures consistent test outcomes across different environments.
 
 ### **Getting Started with E2E Testing:**
 
-1. **Creating and Running E2E Tests**:
-   - Define test scenarios within the `tests/e2e` folder, targeting critical user journeys and application functionalities.
-   - Utilize Playwright for browser automation and Lighthouse for performance auditing within the same test suite.
+1. **Creating and running E2E Tests**:
+   - Define test scenarios in the **tests/e2e** folder, targeting critical user journeys and application functionalities.
+   - Use Playwright for browser automation and Lighthouse for performance auditing within the same test suite.
    - Execute tests via your preferred test runner or CI pipeline, ensuring reliable and consistent outcomes.
-2. **Utilizing Playwright**:
-   - Install and configure Playwright as part of your project dependencies. Follow the setup guide provided by the foundation-testing package.
-   - Write and run tests using Playwright’s API, simulating real-world user interactions such as clicking buttons, filling out forms, and navigating between pages.
+2. **Using Playwright**:
+   - Install and configure Playwright as part of your project dependencies. Follow the set-up guide provided by the foundation-testing package.
+   - Write and run tests using the Playwright API to simulate real-world user interactions. These include clicking buttons, filling in forms, and navigating from page to page.
 3. **Incorporating Lighthouse**:
    - Integrate Lighthouse into your E2E tests to run performance audits alongside functional tests.
    - Use the insights from Lighthouse reports to identify and address performance issues, optimizing your application for speed and user experience.
-4. **Advanced Features**:
-   - **Cross-Browser Testing**: Ensure your application works seamlessly across different browsers, including Chrome, Firefox, and WebKit, with Playwright’s cross-browser support.
-   - **Visual Testing**: Utilize Playwright’s screenshot and visual comparison features to validate the consistency of your UI across different devices and resolutions.
+4. **Advanced features**:
+   - **Cross-Browser Testing**: Use the Playwright cross-browser support to ensure your application works seamlessly across different browsers, including Chrome, Firefox, and WebKit.
+   - **Visual Testing**: Use the Playwrights screenshot and visual comparison features to validate the consistency of your UI across different devices and resolutions.
    - **Performance Budgets**: Set performance thresholds using Lighthouse to maintain high performance standards, ensuring metrics like Time to Interactive (TTI) and First Contentful Paint (FCP) stay within acceptable limits.
 
 ## Test Organisation
@@ -283,7 +283,7 @@ To enable this module in your application, follow the steps below.
 
 - **Playwright Documentation**: Explore Playwright’s extensive documentation for more advanced usage and best practices [here](https://playwright.dev/).
 - **Lighthouse Documentation**: Learn more about Lighthouse and its role in enhancing web performance [here](https://developers.google.com/web/tools/lighthouse).
-- **`foundation-testing` Guides**: Review the detailed setup and configuration guides included with the [foundation-testing package](https://github.com/genesislcap/foundation-ui/tree/master/packages/foundation/foundation-testing) to fully leverage its capabilities.
+- **``playwright-bdd``**: Check out the `playwright-bdd` package for behavior-driven testing with Playwright [here](https://www.npmjs.com/package/playwright-bdd).
 
 ## [API Docs](./docs/api/index.md)
 

package/dist/cjs/playwright-bdd/index.js

@@ -1,7 +1,6 @@
 "use strict";
-var _a;
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.Then = exports.When = exports.Given = exports.test = exports.PlaywrightBDD = void 0;
+exports.testConfig = exports.test = exports.PlaywrightBDD = void 0;
 const tslib_1 = require("tslib");
 const test_1 = require("@playwright/test");
 const PlaywrightBDD = tslib_1.__importStar(require("playwright-bdd"));
@@ -11,18 +10,16 @@ const test_2 = require("../playwright/test");
 /**
  * Playwright BDD test
  * @public
- * @remarks
- * This is just an example playwright-bdd test fixture stub. In reality, you will likely create a custom
- * fixture for your e2e tests depending on the needs of your app or micro frontend.
  */
-exports.test = PlaywrightBDD.test.extend({
+exports.test = PlaywrightBDD.test;
+exports.testConfig = {
     config: [test_2.defaultPackageConfig, { option: true, scope: 'worker', timeout: 60000 }],
     port: [
         ({ config }, use) => tslib_1.__awaiter(void 0, void 0, void 0, function* () {
             const port = (0, portfinder_sync_1.getPort)((config === null || config === void 0 ? void 0 : config.PORT) || process.env.PORT || test_2.defaultPackageConfig.PORT);
             yield use(port);
         }),
-        { scope: 'worker' }, // option: true
+        { scope: 'worker' },
     ],
     browser: [
         ({ port }, use) => tslib_1.__awaiter(void 0, void 0, void 0, function* () {
@@ -33,6 +30,5 @@ exports.test = PlaywrightBDD.test.extend({
         }),
         { scope: 'worker' },
     ],
-    audit: [test_2.defaultAuditThresholds, { option: true, scope: 'worker' }], // TODO: These are not being used from other test setups extending this.
-});
-_a = PlaywrightBDD.createBdd(exports.test), exports.Given = _a.Given, exports.When = _a.When, exports.Then = _a.Then;
+    audit: [test_2.defaultAuditThresholds, { option: true, scope: 'worker' }],
+};

package/dist/dts/playwright-bdd/index.d.ts

@@ -1,13 +1,29 @@
 import * as PlaywrightBDD from 'playwright-bdd';
-import { WorkerFixture } from '../playwright/test';
 export { PlaywrightBDD };
 /**
  * Playwright BDD test
  * @public
- * @remarks
- * This is just an example playwright-bdd test fixture stub. In reality, you will likely create a custom
- * fixture for your e2e tests depending on the needs of your app or micro frontend.
  */
-export declare const test: import("@playwright/test").TestType<import("@playwright/test").PlaywrightTestArgs & import("@playwright/test").PlaywrightTestOptions & import("playwright-bdd/dist/run/bddFixtures/test").BddFixturesTest, import("@playwright/test").PlaywrightWorkerArgs & import("@playwright/test").PlaywrightWorkerOptions & import("playwright-bdd/dist/run/bddFixtures/worker").BddFixturesWorker & WorkerFixture>;
-export declare const Given: (pattern: import("playwright-bdd/dist/steps/registry").DefineStepPattern, fn: import("playwright-bdd/dist/steps/playwrightStyle").PlaywrightStyleStepFn<import("@playwright/test").PlaywrightTestArgs & import("@playwright/test").PlaywrightTestOptions & import("playwright-bdd/dist/run/bddFixtures/test").BddFixturesTest, import("@playwright/test").PlaywrightWorkerArgs & import("@playwright/test").PlaywrightWorkerOptions & import("playwright-bdd/dist/run/bddFixtures/worker").BddFixturesWorker & WorkerFixture>) => (fixtures: Partial<import("@playwright/test").PlaywrightTestArgs & import("@playwright/test").PlaywrightTestOptions & import("playwright-bdd/dist/run/bddFixtures/test").BddFixturesTest & import("@playwright/test").PlaywrightWorkerArgs & import("@playwright/test").PlaywrightWorkerOptions & import("playwright-bdd/dist/run/bddFixtures/worker").BddFixturesWorker & WorkerFixture>, ...args: any[]) => unknown, When: (pattern: import("playwright-bdd/dist/steps/registry").DefineStepPattern, fn: import("playwright-bdd/dist/steps/playwrightStyle").PlaywrightStyleStepFn<import("@playwright/test").PlaywrightTestArgs & import("@playwright/test").PlaywrightTestOptions & import("playwright-bdd/dist/run/bddFixtures/test").BddFixturesTest, import("@playwright/test").PlaywrightWorkerArgs & import("@playwright/test").PlaywrightWorkerOptions & import("playwright-bdd/dist/run/bddFixtures/worker").BddFixturesWorker & WorkerFixture>) => (fixtures: Partial<import("@playwright/test").PlaywrightTestArgs & import("@playwright/test").PlaywrightTestOptions & import("playwright-bdd/dist/run/bddFixtures/test").BddFixturesTest & import("@playwright/test").PlaywrightWorkerArgs & import("@playwright/test").PlaywrightWorkerOptions & import("playwright-bdd/dist/run/bddFixtures/worker").BddFixturesWorker & WorkerFixture>, ...args: any[]) => unknown, Then: (pattern: import("playwright-bdd/dist/steps/registry").DefineStepPattern, fn: import("playwright-bdd/dist/steps/playwrightStyle").PlaywrightStyleStepFn<import("@playwright/test").PlaywrightTestArgs & import("@playwright/test").PlaywrightTestOptions & import("playwright-bdd/dist/run/bddFixtures/test").BddFixturesTest, import("@playwright/test").PlaywrightWorkerArgs & import("@playwright/test").PlaywrightWorkerOptions & import("playwright-bdd/dist/run/bddFixtures/worker").BddFixturesWorker & WorkerFixture>) => (fixtures: Partial<import("@playwright/test").PlaywrightTestArgs & import("@playwright/test").PlaywrightTestOptions & import("playwright-bdd/dist/run/bddFixtures/test").BddFixturesTest & import("@playwright/test").PlaywrightWorkerArgs & import("@playwright/test").PlaywrightWorkerOptions & import("playwright-bdd/dist/run/bddFixtures/worker").BddFixturesWorker & WorkerFixture>, ...args: any[]) => unknown;
+export declare const test: import("@playwright/test").TestType<import("@playwright/test").PlaywrightTestArgs & import("@playwright/test").PlaywrightTestOptions & import("playwright-bdd/dist/run/bddFixtures/test").BddFixturesTest, import("@playwright/test").PlaywrightWorkerArgs & import("@playwright/test").PlaywrightWorkerOptions & import("playwright-bdd/dist/run/bddFixtures/worker").BddFixturesWorker>;
+export declare const testConfig: {
+    config: (import("../playwright/test").PackageConfig | {
+        option: boolean;
+        scope: string;
+        timeout: number;
+    })[];
+    port: ((({ config }: {
+        config: any;
+    }, use: any) => Promise<void>) | {
+        scope: string;
+    })[];
+    browser: ((({ port }: {
+        port: any;
+    }, use: any) => Promise<void>) | {
+        scope: string;
+    })[];
+    audit: (import("../playwright/test").AuditThresholds | {
+        option: boolean;
+        scope: string;
+    })[];
+};
 //# sourceMappingURL=index.d.ts.map

package/dist/dts/playwright-bdd/index.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../../src/playwright-bdd/index.ts"],"names":[],"mappings":"AACA,OAAO,KAAK,aAAa,MAAM,gBAAgB,CAAC;AAIhD,OAAO,EAAe,aAAa,EAAE,MAAM,oBAAoB,CAAC;AAEhE,OAAO,EAAE,aAAa,EAAE,CAAC;AAEzB;;;;;;GAMG;AACH,eAAO,MAAM,IAAI,2YAmBf,CAAC;AAEH,eAAO,MAAQ,KAAK,25BAAE,IAAI,25BAAE,IAAI,y5BAAkC,CAAC"}
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../../src/playwright-bdd/index.ts"],"names":[],"mappings":"AACA,OAAO,KAAK,aAAa,MAAM,gBAAgB,CAAC;AAKhD,OAAO,EAAE,aAAa,EAAE,CAAC;AAEzB;;;GAGG;AACH,eAAO,MAAM,IAAI,2XAAqB,CAAC;AAEvC,eAAO,MAAM,UAAU;;;;;;;;;;;;;;;;;;;;CAmBtB,CAAC"}

package/dist/esm/playwright-bdd/index.js

@@ -7,18 +7,16 @@ export { PlaywrightBDD };
 /**
  * Playwright BDD test
  * @public
- * @remarks
- * This is just an example playwright-bdd test fixture stub. In reality, you will likely create a custom
- * fixture for your e2e tests depending on the needs of your app or micro frontend.
  */
-export const test = PlaywrightBDD.test.extend({
+export const test = PlaywrightBDD.test;
+export const testConfig = {
     config: [defaultPackageConfig, { option: true, scope: 'worker', timeout: 60000 }],
     port: [
         ({ config }, use) => __awaiter(void 0, void 0, void 0, function* () {
             const port = getPort((config === null || config === void 0 ? void 0 : config.PORT) || process.env.PORT || defaultPackageConfig.PORT);
             yield use(port);
         }),
-        { scope: 'worker' }, // option: true
+        { scope: 'worker' },
     ],
     browser: [
         ({ port }, use) => __awaiter(void 0, void 0, void 0, function* () {
@@ -29,6 +27,5 @@ export const test = PlaywrightBDD.test.extend({
         }),
         { scope: 'worker' },
     ],
-    audit: [defaultAuditThresholds, { option: true, scope: 'worker' }], // TODO: These are not being used from other test setups extending this.
-});
-export const { Given, When, Then } = PlaywrightBDD.createBdd(test);
+    audit: [defaultAuditThresholds, { option: true, scope: 'worker' }],
+};

package/package.json

@@ -1,7 +1,7 @@
 {
   "name": "@genesislcap/foundation-testing",
   "description": "Genesis Foundation Testing",
-  "version": "14.202.1-alpha-77ef7ac.0",
+  "version": "14.203.0",
   "sideEffects": false,
   "license": "SEE LICENSE IN license.txt",
   "main": "dist/esm/index.js",
@@ -79,7 +79,7 @@
     "typescript": "^4.9.5"
   },
   "dependencies": {
-    "@genesislcap/foundation-logger": "14.202.1-alpha-77ef7ac.0",
+    "@genesislcap/foundation-logger": "14.203.0",
     "@microsoft/fast-element": "^1.12.0",
     "@microsoft/fast-foundation": "^2.49.4",
     "@playwright/test": "^1.18.1",
@@ -101,5 +101,5 @@
   "publishConfig": {
     "access": "public"
   },
-  "gitHead": "5396ccdfe1b0add8cf3e96be9f3c7f63350ace86"
+  "gitHead": "3f779b9e65169135dc8fea0605f21d0d65ce263b"
 }