Skip to content

Update README.md #26

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 1 commit into from
Jan 27, 2025
Merged

Update README.md #26

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
18 changes: 3 additions & 15 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -25,9 +25,7 @@ A simple UI automation framework built with:

### Prerequisites

- Python 3.8 - 3.12
- If you're not using macOS with ARM64 architecture or a Selenium version below 4.24.0, please upload the appropriate driver corresponding to your OS to the `resources` directory.
- secure-test-automation for encrypting sensitive data

### Local Usage

Expand All @@ -39,14 +37,16 @@ A simple UI automation framework built with:
```bash
pip install poetry
poetry shell
poetry env info
copy `Executable: path to virtual env` -> Add Interpreter -> Poetry Environment -> Existing environment -> add Executable -> Apply
poetry install
```
then specify your poetry env
3. Create a `.env` file and add:
```plaintext
DEV_URL = "your-dev-project-url"
STAG_URL = "your-staging-project-url"
```
- Rename the `chromedriver` to `local` if you want to run tests locally.

4. If you prefer not to use environment variables, add your references to the properties file:
```python
Expand All @@ -63,18 +63,6 @@ A simple UI automation framework built with:
- #### [Chrome Drivers](https://googlechromelabs.github.io/chrome-for-testing/#stable)
- #### [Firefox Drivers](https://github.com/mozilla/geckodriver)

### TODO

| Item | Status |
|-------------------------------------------------------------------------------------------------------------|----------------------------------------------------------|
| 1. Drivers factory: local, remote, [Chrome, Firefox] | ![Status](https://img.shields.io/badge/DONE-brightgreen) |
| 2. `pytest.ini` config: addopts, errors, markers | ![Status](https://img.shields.io/badge/DONE-brightgreen) |
| 3. Environments: dev, stag, prod | ![Status](https://img.shields.io/badge/DONE-brightgreen) |
| 4. Secrets | ![Status](https://img.shields.io/badge/DONE-brightgreen) |
| 5. Utilities: YAML reader, logger | ![Status](https://img.shields.io/badge/DONE-brightgreen) |
| 6. BasePage: wait strategy, base actions | ![Status](https://img.shields.io/badge/DONE-brightgreen) |
| 7. Properties: make properties helper | ![Status](https://img.shields.io/badge/DONE-brightgreen) |
| 8. CI: GitHub Actions: run tests, publish reports, take screenshots on failure (check test summary artifacts) | ![Status](https://img.shields.io/badge/DONE-brightgreen) |

### CI: GitHub Actions

Expand Down
Loading