@genesislcap/foundation-testing 14.201.0 → 14.202.1-alpha-34c59e8.0

package/README.md

@@ -5,44 +5,66 @@
 
 `foundation-testing` provides shared unit and e2e testing functionality.
 
-## Unit testing with UVU
+## Unit Testing
 
-Unit testing is provided by [UVU](https://github.com/lukeed/uvu)
+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.
 
-### UVU Features
+### **Key Tools and Features:**
 
-* Super [lightweight](https://npm.anvaka.com/#/view/2d/uvu)
-* Extremely [performant](https://github.com/lukeed/uvu/tree/master#benchmarks)
-* Individually executable test files
-* Supports `async`/`await` tests
-* Supports native ES Modules
-* Browser-compatible
-* Familiar API
+- **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).
+- **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.
 
-## E2E Testing with Playwright
+### **Getting Started with Unit Testing:**
 
-E2E testing is provided by [Playwright](https://playwright.dev/docs/intro)
+- 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.
+- Execute tests locally or on your CI pipeline, ensuring reliable and consistent outcomes.
 
-### Playwright Features
+## E2E Testing
 
-* Run tests across all browsers.
-* Execute tests in parallel.
-* Enjoy context isolation out of the box.
-* Capture videos, screenshots and other artifacts on failure.
-* Integrate your POMs as extensible fixtures.
+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.
+
+### **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.
+
+### **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.
+   - 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.
+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.
+   - **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
 
 You can unit-test specific logic by adding a test file alongside the source file.
 
-```
+```ts
 logic.ts
 logic.test.ts
 ```
 
 If your test spans more than one file or is more of an end-to-end test, you may wish to add your test to your package's **/test** directory instead. An example structure might be:
 
-```
+```plaintext
 ├── src
 │   └── logic.ts
 │   └── logic.test.ts
@@ -86,7 +108,7 @@ export * from '@genesislcap/foundation-testing/jsdom';
 
 The test-related scripts to add to your package's **package.json** file may include:
 
-```
+```json
 "test": "genx test",
 "test:single": "genx test --match connect.test.ts",
 "test:single:browser": "genx test --browser --match connect.test.ts",
@@ -246,16 +268,23 @@ To enable this module in your application, follow the steps below.
 
 ```json
 {
-  ...
   "dependencies": {
-    ...
     "@genesislcap/foundation-testing": "latest"
-    ...
   },
-  ...
 }
 ```
 
+### **Unit Testing Resources and Further Documentation:**
+
+- [UVU](ttps://github.com/lukeed/uvu)
+- [Sinon.JS](https://sinonjs.org/releases/v18/)
+
+### **E2E Resources and Further Documentation:**
+
+- **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.
+
 ## [API Docs](./docs/api/index.md)
 
 ## License
@@ -263,4 +292,5 @@ To enable this module in your application, follow the steps below.
 Note: this project provides front-end dependencies and uses licensed components listed in the next section; thus, licenses for those components are required during development. Contact [Genesis Global](https://genesis.global/contact-us/) for more details.
 
 ### Licensed components
+
 Genesis low-code platform

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

@@ -0,0 +1,6 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.PlaywrightBDD = void 0;
+const tslib_1 = require("tslib");
+const PlaywrightBDD = tslib_1.__importStar(require("playwright-bdd"));
+exports.PlaywrightBDD = PlaywrightBDD;

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

@@ -0,0 +1,3 @@
+import * as PlaywrightBDD from 'playwright-bdd';
+export { PlaywrightBDD };
+//# sourceMappingURL=index.d.ts.map

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

@@ -0,0 +1 @@
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../../src/playwright-bdd/index.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,aAAa,MAAM,gBAAgB,CAAC;AAEhD,OAAO,EAAE,aAAa,EAAE,CAAC"}

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

@@ -0,0 +1,2 @@
+import * as PlaywrightBDD from 'playwright-bdd';
+export { PlaywrightBDD };

package/package.json

@@ -1,7 +1,7 @@
 {
   "name": "@genesislcap/foundation-testing",
   "description": "Genesis Foundation Testing",
-  "version": "14.201.0",
+  "version": "14.202.1-alpha-34c59e8.0",
   "sideEffects": false,
   "license": "SEE LICENSE IN license.txt",
   "main": "dist/esm/index.js",
@@ -29,6 +29,11 @@
       "require": "./dist/cjs/playwright/setup.js",
       "default": "./dist/esm/playwright/setup.js"
     },
+    "./playwright-bdd": {
+      "types": "./dist/dts/playwright-bdd/index.d.ts",
+      "require": "./dist/cjs/playwright-bdd/index.js",
+      "default": "./dist/esm/playwright-bdd/index.js"
+    },
     "./package.json": "./package.json",
     "./tsm": "./dist/esm/tsm/index.js"
   },
@@ -74,12 +79,13 @@
     "typescript": "^4.9.5"
   },
   "dependencies": {
-    "@genesislcap/foundation-logger": "14.201.0",
+    "@genesislcap/foundation-logger": "14.202.1-alpha-34c59e8.0",
     "@microsoft/fast-element": "^1.12.0",
     "@microsoft/fast-foundation": "^2.49.4",
     "@playwright/test": "^1.18.1",
     "jsdom": "^24.0.0",
     "lighthouse": "^9.6.8",
+    "playwright-bdd": "^7.2.2",
     "playwright-lighthouse": "^2.2.2",
     "portfinder-sync": "^0.0.2",
     "sinon": "^17.0.1",
@@ -95,5 +101,5 @@
   "publishConfig": {
     "access": "public"
   },
-  "gitHead": "d9585bb0f774fe0193ae3b7306e3b73a69e09f56"
+  "gitHead": "f8ccd0ab71ae20e61ce39f02dd1905b2676e2898"
 }