Skip to content

Commit

Permalink
e2e-test: update readme (#5892)
Browse files Browse the repository at this point in the history
Updating readme to reflect updated test/e2e infrastructure.

### QA Notes
n/a
  • Loading branch information
midleman authored Jan 7, 2025
1 parent 734bcf9 commit 3512278
Showing 1 changed file with 10 additions and 12 deletions.
22 changes: 10 additions & 12 deletions test/e2e/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -17,16 +17,15 @@ This document provides guidelines and setup instructions for effectively running

### Test Code Location

- `test/e2e/tests`

For instance, the e2e tests for the help pane are at `test/e2e/tests/help/help.test.ts`

### Test Helpers Location

- General helpers dir: `test/automation/src`
- Positron helpers dir: `test/automation/src/positron`

For each area under test, there is typically a companion class that assists with locating and interacting with elements (similar to POM pattern). For instance, the e2e tests for the help pane are at `test/e2e/tests/help/help.test.ts`
All Positron end-to-end (E2E) test code resides in the `test/e2e` directory. For each area under test, there is typically a corresponding Page Object Model (POM) class to assist with locating and interacting with page elements.

```plaintext
test/
└── e2e/
├── infra/ <-- contains the driver, browser, electron, test runner, etc. files
├── pages/ <-- contains all the Positron POMs
└── tests/ <-- contains all the tests, organized by area
```

### Test Template

Expand Down Expand Up @@ -97,10 +96,9 @@ Several tests use [QA Content Examples](https://github.com/posit-dev/qa-example-

### Install

Before compiling the tests, make sure to install dependencies in the following directories:
Before compiling the tests, make sure to install dependencies:

```bash
npm --prefix test/automation install
npm --prefix test/e2e install
```

Expand Down

0 comments on commit 3512278

Please sign in to comment.