Skip to content

Commit

Permalink
Documentation review for cypress container tests (#3779)
Browse files Browse the repository at this point in the history
  • Loading branch information
smahati authored Jun 13, 2024
1 parent b6e09c0 commit f3ed68c
Show file tree
Hide file tree
Showing 8 changed files with 28 additions and 27 deletions.
2 changes: 1 addition & 1 deletion container/cypress/e2e/examples/README.md
Original file line number Diff line number Diff line change
@@ -1,3 +1,3 @@
### Test Suite: `/examples`

This test suite is used to add tests for our **/container/examples** application, to make sure that our provided simple examples are working and up to date.
Tests to validate and verify our simple examples in the **/container/examples** application.
4 changes: 2 additions & 2 deletions container/cypress/e2e/test-app/iframe/README.md
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
### Test Suite: `test-app/iframe`

This test suite is used to add tests for all scenarios built and served from **container/test-app/iframe** application. This involves iframe based Luigi Container scenarios.
This is the test suite of the **container/test-app/iframe** application. The test suite is for the iframe based Luigi Container scenarios.

Please add all iframe based **Luigi Container** related tests here.

Categorize tests into separate files if needed, so that it is easy to read.
Categorize tests into separate files if needed, so that it is easy to read.
2 changes: 1 addition & 1 deletion container/cypress/e2e/test-app/wc/README.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
### Test Suite: `test-app/wc`

This test suite is used to add tests for all scenarios built and served from **container/test-app/wc** application. This involves Web Component based Luigi Container scenarios.
This is the test suite of the **container/test-app/wc** application. The test suite is for the Web Component based Luigi Container scenarios.

Please add all web component based **Luigi Container** related tests here.

Expand Down
17 changes: 9 additions & 8 deletions container/test-app/README.md
Original file line number Diff line number Diff line change
@@ -1,14 +1,13 @@
# Container Test App

This folder contains the a composition of several different HTML files which serve the purpose of testing out our Luigi Container package features.
The several HTML files in this folder test the Luigi Container package features.


The app is split up in several different parts with simple examples for all the Container features:
The app is split up into different parts with simple examples for all the Container features:

- **compound** : Luigi Compound Container features
- **clientAPI** : LuigiClient API features
- **nested** : nested compound component feature
- **selfRegistered** : for testing selfRegistered feature
- **selfRegistered** : selfRegistered feature

- **iframe** -> iframe based Luigi Container

Expand All @@ -18,14 +17,16 @@ The app is split up in several different parts with simple examples for all the
The above features are tested with e2e Cypress tests (`container/cypress/e2e`).

To run the test suite:
Go to `container` folder:

1. Start the app:
1. Go to `container` folder:

2. Start the app:
- `npm run start`

2. Start the cypress tests with User Interface:
3. Start the cypress tests with User Interface:
- `npm run cypress-browser`

or in headless mode

- `npm run cypress-headless` (For this you also need to run the `examples` app : `npm run start-examples-test` on another Terminal)
- Make sure that `examples` app is running: `npm run start-examples-test`
- then, in another terminal run `npm run cypress-headless`
8 changes: 4 additions & 4 deletions container/test-app/compound/README.md
Original file line number Diff line number Diff line change
@@ -1,8 +1,8 @@
# luigi-compound-container based e2e test app
# luigi-compound-container Based e2e Test App

This folder contains simple html files which apply **luigi-compound-container** in different scenarios.
This folder contains simple HTML files that use **luigi-compound-container** in different scenarios.

The purpose of it, is to serve as a testing environment for our Cypress tests which reside on container/cypress/e2e folder
They serve as a testing environment for our Cypress tests, which reside in the `container/cypress/e2e` folder.

We try to keep our examples here simple and apply separation of concerns. We use plain JS and HTML files to avoid maintaining yet another framework example.
We try to keep the examples simple and apply separation of concerns. We use plain JS and HTML files to avoid maintaining yet another framework example.

8 changes: 4 additions & 4 deletions container/test-app/iframe/README.md
Original file line number Diff line number Diff line change
@@ -1,8 +1,8 @@
# iframe based luigi container e2e test app
# Iframe Based Luigi Container e2e Test App

This folder contains simple html files which apply **iframe** based luigi-container in different scenarios.
This folder contains simple HTML files that use **iframe** based luigi-container in different scenarios.

The purpose of it, is to serve as a testing environment for our Cypress tests which reside on container/cypress/e2e folder
They serve as a testing environment for our Cypress tests, which reside in the container/cypress/e2e folder.

We try to keep our examples here simple and apply separation of concerns. We use plain JS and HTML files to avoid maintaining yet another framework example.
We try to keep our examples simple and apply separation of concerns. We use plain JS and HTML files to avoid maintaining yet another framework example.

8 changes: 4 additions & 4 deletions container/test-app/wc/README.md
Original file line number Diff line number Diff line change
@@ -1,8 +1,8 @@
# Web Component based luigi-container e2e test app
# Web Component Based luigi-container e2e Test App

This folder contains simple html files which apply **Web Component** based luigi-container in different scenarios.
This folder contains simple HTML files that use **Web Component** based luigi-container in different scenarios.

The purpose of it, is to serve as a testing environment for our Cypress tests which reside on container/cypress/e2e folder
They serve as a testing environment for our Cypress tests, which reside in the container/cypress/e2e folder.

We try to keep our examples here simple and apply separation of concerns. We use plain JS and HTML files to avoid maintaining yet another framework example.
We try to keep our examples simple and apply separation of concerns. We use plain JS and HTML files to avoid maintaining yet another framework example.

6 changes: 3 additions & 3 deletions container/test/README.md
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
# Luigi Container Unit-Tests

This file contains unit test for the Luigi Container package.
These are the unit tests for the Luigi Container package.

All files that are tested here are from **container/src** folder.
All these files are from the **container/src** folder.

Please try to maintain test coverage when adding new files/functionality
Please try to maintain test coverage when adding new files/functionality.

0 comments on commit f3ed68c

Please sign in to comment.