Skip to content

Commit

Permalink
chore: add README
Browse files Browse the repository at this point in the history
  • Loading branch information
bukowa committed Jun 28, 2024
1 parent 2bfaf48 commit e2bf28a
Showing 1 changed file with 49 additions and 0 deletions.
49 changes: 49 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,49 @@
# tauri-e2e v2
This project demonstrates how to perform end-to-end testing with `Tauri v2` using `Selenium`.<br>

# Goals
In order of priority:

- `Single Cross-Platform Command`: Implement a single command (just test-e2e) to execute end-to-end tests locally on any supported platform.

- `GitHub Actions Integration`: Enable a single cross-platform command (just test-e2e) to run end-to-end tests within GitHub Actions.

- `Scheduled Testing`: Configure GitHub Actions to run these tests on a scheduled basis to detect regressions early in new versions.

- `Minimize Dependencies and Simplify Code`: Aim to streamline the testing setup by reducing reliance on external frameworks and libraries wherever feasible. Simplifying the codebase helps maintain clarity, efficiency, and reduces potential points of failure, ensuring a more robust testing environment.

# State
- [x] `Windows` support
- [ ] headless support
- [x] `Linux` support
- [x] headless support
- [ ] `Mac` support
- [ ] headless support


## Note on Headless Execution
In this setup, when we refer to running tests "headlessly," it means executing them without a graphical user interface (GUI) environment. This is achieved by leveraging servers like X11, which provide a virtual display for graphical applications, even in environments where no physical display is available or required.

## Note on Windows Environment
On Windows, the testing setup utilizes Bash and tools provided by [Git for Windows](https://git-scm.com/download/win). This includes Git Bash, which provides a Unix-like command-line environment on Windows, enabling seamless execution of commands and scripts similar to those used in Linux environments.

# Prerequisites
Before getting started, ensure you have the following:

- `Rust`
- `Node.js`
- `just`: Install just from [here](https://github.com/casey/just) to simplify command execution.

## Note on just:
The just tool, utilized in this setup for streamlined command execution, is noteworthy for its lightweight nature and cross-platform compatibility. Written in Rust, just is designed to be efficient and versatile across different operating systems. The entire installation typically occupies only about 4MB of disk space, making it an excellent choice for managing tasks and commands within your development environment without significant overhead. If you prefer not to use just, feel free to contribute shell script alternatives via pull requests.


# Run
```bash
just test-e2e
```

# Goals
1. `one (just 1) cross-platform command to run e2e tests for tauri application on local computer`<br>
2. `one (just 1) cross-platform command to run e2e tests for tauri application in github actions`
3. `run these tests on scheduled basis in github actions to early catch any regressions in new versions`

0 comments on commit e2bf28a

Please sign in to comment.