Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/sharma-it/saucedemo-e2e-tests
An end-to-end test suite for the Saucedemo website using Playwright and TypeScript
https://github.com/sharma-it/saucedemo-e2e-tests
playwright playwright-typescript saucedemo typescript
Last synced: about 2 months ago
JSON representation
An end-to-end test suite for the Saucedemo website using Playwright and TypeScript
- Host: GitHub
- URL: https://github.com/sharma-it/saucedemo-e2e-tests
- Owner: Sharma-IT
- Created: 2024-12-12T01:55:45.000Z (about 2 months ago)
- Default Branch: main
- Last Pushed: 2024-12-19T13:34:22.000Z (about 2 months ago)
- Last Synced: 2024-12-19T14:38:58.821Z (about 2 months ago)
- Topics: playwright, playwright-typescript, saucedemo, typescript
- Language: TypeScript
- Homepage: https://github.com/Sharma-IT
- Size: 35.2 KB
- Stars: 0
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
# Saucedemo E2E Tests
End-to-end test suite for the Saucedemo website using Playwright and TypeScript.
## Features
- Page Object Model (POM) architecture for better maintainability
- Cross-browser testing support (Chrome, Firefox, Safari)
- Mobile device testing support (Pixel 5, iPhone 12)
- Comprehensive test reporting (HTML, List, JUnit)
- CI/CD ready configuration
- Automatic retries for flaky tests
- Screenshot and video capture on test failure
- Trace viewer support for debugging
- State management with authentication persistence
- Parallel test execution with sharding
## Project Structure
```
saucedemo-e2e-tests/
├── tests/ # Test files
│ └── purchase-flow.spec.ts # E2E tests for purchase flow
├── page_objects/ # Page Object Models
│ ├── cart.page.ts # Cart page interactions
│ ├── login.page.ts # Login page interactions
│ ├── inventory.page.ts # Inventory page interactions
│ ├── header.ts # Header element interactions
│ ├── sidebar.ts # Sidebar element interactions
│ └── checkout.page.ts # Checkout page interactions
├── fixtures/ # Test fixtures and data
│ ├── test-base.ts # Base test configuration and fixtures
│ └── test-data.ts # Test data constants
├── config/ # Configuration files
│ ├── global-setup.ts # Global test setup
│ └── global-teardown.ts # Global test teardown
├── playwright.config.ts # Playwright configuration
├── README.md # Project documentation
└── docs/ # Documentation files
└── license.md # Project license information
```
## Getting Started
1. Clone this repository:
```bash
git clone https://github.com/Sharma-IT/saucedemo-e2e-tests.git
```
2. Change into this repository's directory:
```bash
cd saucedemo-e2e-tests
```
3. Install dependencies:
```bash
npm install
```
4. Install browsers:
```bash
npm prepare
```
5. Run tests:
```bash
# Run all tests
npm test
# Run tests with UI
npm run test:ui
# View test report
npm run test:report
```
## Test Coverage
- Login functionality
- Standard user login
- Locked out user error handling
- Product purchase flow
- Adding products to cart
- Checkout process
- Order confirmation
- Cart functionality
- Adding/removing items
- Cart badge updates
## Test Users and Environment Variables
This project demonstrates environment variable usage for test credentials, although for this demo site (saucedemo.com), the credentials are publicly available:
```
Standard User:
- Username: standard_user
- Password: secret_sauce
Locked Out User:
- Username: locked_out_user
- Password: secret_sauce
```
The project uses `.env` files and GitHub Secrets to showcase best practices for credential management:
1. Local Development:
- Copy `.env.example` to `.env`
- Add the above credentials to your `.env` file
- `.env` is gitignored to demonstrate secure credential handling
2. CI/CD:
- GitHub Secrets are used to demonstrate secure credential storage
- Secrets are injected as environment variables during test runs
Note: While I'm using environment variables and secrets in this project, it's purely for demonstration purposes since these are public test credentials. In a real project, you would use this same pattern to secure actual sensitive credentials.
## Configuration
The test suite is configured with:
- Base URL: https://www.saucedemo.com
- Browser support:
- Desktop: Chrome, Firefox, Safari
- Mobile: Pixel 5, iPhone 12
- Test retries: 2 attempts
- Timeouts:
- Global: 30 seconds
- Action: 15 seconds
- Navigation: 15 seconds
- Test artifacts:
- Screenshots on failure
- Videos on failure
- Trace viewer support
- Authentication state persistence
- Parallel execution with test sharding
## CI/CD Integration
The test suite is configured for CI/CD environments with:
- Runs on Node.js 20 on Ubuntu latest
- Parallel test execution:
- 3-way sharding for optimal distribution
- Fail-fast disabled for complete test visibility
- Test reporting per shard:
- JUnit XML reports with passed test inclusion
- Individual shard test reports
- Development safeguards:
- No focus mode in CI (forbidOnly)
- Automatic retries (2 attempts)
- Performance optimisations:
- npm dependency caching
- Playwright browser caching
## License
This project is licensed under the MIT License - see the [LICENSE](LICENSE) file for details.