Skip to content

Commit

Permalink
update readme
Browse files Browse the repository at this point in the history
  • Loading branch information
yorkxin committed Apr 30, 2024
1 parent f24f47e commit 374a520
Showing 1 changed file with 8 additions and 6 deletions.
14 changes: 8 additions & 6 deletions e2e/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,13 +2,14 @@

This folder contains E2E test cases of Copy as Markdown extension.

It uses [Selenium](https://www.selenium.dev/) to automate the browsers and assert the contents of the clipboard.
It uses [Selenium](https://www.selenium.dev/) and [java.awt.Robot](https://docs.oracle.com/javase%2F7%2Fdocs%2Fapi%2F%2F/java/awt/Robot.html) to automate the browsers and assert the contents of the clipboard.

## System Requirements

* Java
* Maven
* Google Chrome
* Firefox

## Development

Expand All @@ -22,7 +23,7 @@ It uses [Selenium](https://www.selenium.dev/) to automate the browsers and asser

## Setup

### macOS Assistive Control
### macOS Accessibility Warnings

When you first run the test cases in the terminal, you will be prompted about
the permissions of Assistive Control.
Expand All @@ -41,17 +42,18 @@ Please hold back and don't touch mouse / keyboard while the tests are running.

### JetBrains Aqua

Just right-click on the test folder and choose "Run Tests".
- Right-click on `testng.xml` and choose "Run Tests".
- To run test cases for a particular browser, select `testng-<browser>.xml`.

## Architecture

* `src/test` contains all the test scripts.
* `support/e2e-test-extension` is a Web Extension used to control tabs in ways that Selenium can't do,
* `support/e2e-test-extension*` are Web Extensions used to control tabs in ways that Selenium can't do,
such as tab grouping, tab highlighting etc.
* `support/pages` contains static fixture pages used in test cases. When test suite starts, it will run a static server
listening at `localhost:5566`. The E2E Test Extension will open those pages.

## TODO

* Test on Firefox
* Test on Linux
* Test Edge
* Test on Linux & Windows

0 comments on commit 374a520

Please sign in to comment.