From 562ee29291af9e1ced99130c6c5bbda8b30c2c65 Mon Sep 17 00:00:00 2001 From: Jennifer Shehane <jennifer@cypress.io> Date: Mon, 12 Jul 2021 08:52:37 -0500 Subject: [PATCH 1/3] Add readme's for runner-shared/runner-ct + update codeowners --- .github/CODEOWNERS | 5 +++- packages/runner-ct/README.md | 45 ++++++++++++++++++++++++++++++++ packages/runner-shared/README.md | 20 ++++++++++++++ packages/runner/README.md | 2 +- 4 files changed, 70 insertions(+), 2 deletions(-) create mode 100644 packages/runner-ct/README.md create mode 100644 packages/runner-shared/README.md diff --git a/.github/CODEOWNERS b/.github/CODEOWNERS index 01715637379d..69cb68dc8c64 100644 --- a/.github/CODEOWNERS +++ b/.github/CODEOWNERS @@ -1,6 +1,7 @@ # Each line is a file pattern followed by one or more owners. -# Test Runner team are owners of code within root packages and cli +# Test Runner team are owners of code within root packages concerning e2e, cli, and other utils +/.github/ @cypress-io/test-runner /browser-versions.json @cypress-io/test-runner /cli/ @cypress-io/test-runner /packages/coffee/ @cypress-io/test-runner @@ -19,9 +20,11 @@ /packages/rewriter/ @cypress-io/test-runner /packages/root/ @cypress-io/test-runner /packages/runner/ @cypress-io/test-runner +/packages/runner-shared/ @cypress-io/test-runner /packages/server/ @cypress-io/test-runner /packages/socket/ @cypress-io/test-runner /packages/static/ @cypress-io/test-runner /packages/ts/ @cypress-io/test-runner /packages/ui-components/ @cypress-io/test-runner /packages/web-config/ @cypress-io/test-runner +/scripts/ @cypress-io/test-runner diff --git a/packages/runner-ct/README.md b/packages/runner-ct/README.md new file mode 100644 index 000000000000..8e191c4cd886 --- /dev/null +++ b/packages/runner-ct/README.md @@ -0,0 +1,45 @@ +# Runner CT + +The runner-ct is where the code for the component testing's runner lives and has the following responsibilities: + +- Displaying the component specs list and all states around that in the runner + +## Developing + +### Watching + +This watches and compiles all changes as you make them. + +```bash +yarn workspace @packages/runner-ct watch +``` + +## Building + +### For development + +```bash +yarn workspace @packages/runner-ct build +``` + +### For production + +```bash +yarn workspace @packages/runner-ct build-prod +``` + +## Testing + +### Cypress Tests + +You can run Cypress tests found in [`cypress/component`](./cypress/component): + +```bash +yarn workspace @packages/runner-ct cypress:open +``` + +To watch and reload changes to the runner while testing you'll want to run: + +```bash +yarn workspace @packages/runner-ct watch +``` diff --git a/packages/runner-shared/README.md b/packages/runner-shared/README.md new file mode 100644 index 000000000000..97ec3a134862 --- /dev/null +++ b/packages/runner-shared/README.md @@ -0,0 +1,20 @@ +# Runner Shared + +The runner-shared contains the shared components between the `runner` (use for end-to-end testing) and the `runner-ct` (used for component testing) including: + +- Shared empty states +- Shared error states +- Containers, headers and iframe components +- Selector playground and Cypress Studio + +## Developing + +The components are imported to the [`runner`](../runner/README.md#Developing) and `runner-ct` packages respectively. Please see their instructions for develoment. + +## Testing + +### Unit Tests + +```bash +yarn workspace @packages/runner-shared test +``` diff --git a/packages/runner/README.md b/packages/runner/README.md index 62a73ccbb43b..a75aa761f471 100644 --- a/packages/runner/README.md +++ b/packages/runner/README.md @@ -2,7 +2,7 @@  -The runner is the minimal "chrome" around the user's app and has the following responsibilities: +The runner is the minimal "chrome" around the user's app for end-to-end testing and has the following responsibilities: - Managing communication between the driver, the reporter, the extension, and the server - Managing the viewport size and scale From 282dc7d881960c6bc88b8bbed27fe517ed4217a2 Mon Sep 17 00:00:00 2001 From: Jennifer Shehane <jennifer@cypress.io> Date: Mon, 12 Jul 2021 08:59:39 -0500 Subject: [PATCH 2/3] Update contributing to describe packages --- CONTRIBUTING.md | 4 +++- 1 file changed, 3 insertions(+), 1 deletion(-) diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index 965beb223a27..55275d0d1177 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -282,11 +282,13 @@ Here is a list of the core packages in this repository with a short description, | [reporter](./packages/reporter) | `@packages/reporter` | The reporter shows the running results of the tests (The Command Log UI). | | [root](./packages/root) | `@packages/root` | Dummy package pointing at the root of the repository. | | [runner](./packages/runner) | `@packages/runner` | The runner is the minimal "chrome" around the user's application under test. | + | [runner-ct](./packages/runner-ct) | `@packages/runner-ct` | The runner for component testing | + | [runner-shared](./packages/runner-shared) | `@packages/runner-shared` | The shared components between the `runner` and the `runner-ct` packages | | [server](./packages/server) | `@packages/server` | The <3 of Cypress. This orchestrates everything. The backend node process. | | [socket](./packages/socket) | `@packages/socket` | A wrapper around socket.io to provide common libraries. | | [static](./packages/static) | `@packages/static` | Serves static assets used in the Cypress GUI. | | [ts](./packages/ts) | `@packages/ts` | A centralized version of typescript. | - + Public packages live within the [`npm`](./npm) folder and are standalone modules that get independently published to npm under the `@cypress/` namespace. These packages generally contain extensions, plugins, or other packages that are complementary to, yet independent of, the main Cypress app. Here is a list of the npm packages in this repository: From e58d2fdd882e0b57782bb6694bd04f4ad09bf470 Mon Sep 17 00:00:00 2001 From: Jennifer Shehane <jennifer@cypress.io> Date: Mon, 12 Jul 2021 09:01:29 -0500 Subject: [PATCH 3/3] [skip ci]