Skip to content

PROJECT_OVERVIEW.md

Latest commit

 

History

History
307 lines (242 loc) · 7.96 KB

PROJECT_OVERVIEW.md

File metadata and controls

307 lines (242 loc) · 7.96 KB

Playwright Testing Project Overview

Angular .NET Tutorial - E2E & API Testing

🎯 Project Goals

Implement comprehensive automated testing for the AngularNetTutorial full-stack application using Playwright, covering:

  1. End-to-End Testing - Complete user workflows through the browser
  2. API Integration Testing - Direct API endpoint validation
  3. Authentication Testing - OIDC/OAuth 2.0 flows
  4. Role-Based Access Control - Permission testing for all roles
  5. Cross-Browser Testing - Chrome, Firefox, Safari compatibility

📊 Application Under Test

Architecture: CAT Pattern (Client, API Resource, Token Service)

Frontend

  • Technology: Angular 20 + Material Design
  • Location: C:\apps\AngularNetTutotial\Clients\TalentManagement-Angular-Material
  • URL: http://localhost:4200

Backend API

  • Technology: .NET 10 Web API (Clean Architecture)
  • Location: C:\apps\AngularNetTutotial\ApiResources\TalentManagement-API
  • URL: https://localhost:44378

Identity Server

  • Technology: Duende IdentityServer 7.0
  • Location: C:\apps\AngularNetTutotial\TokenService\Duende-IdentityServer
  • URL: https://sts.skoruba.local

👥 User Roles

Employee

  • Permissions: Read-only access
  • Can: View employees, departments, positions, salary ranges
  • Cannot: Create, edit, or delete records

Manager

  • Permissions: Create and manage employees/departments
  • Can: All Employee permissions + create/edit employees and departments
  • Cannot: Access positions or salary ranges

HRAdmin

  • Permissions: Full administrative access
  • Can: All Manager permissions + manage positions and salary ranges
  • Cannot: Nothing (full access)

Test Credentials

{
  "employee": {
    "username": "employee1",
    "password": "Pa$$word123"
  },
  "manager": {
    "username": "ashtyn1",
    "password": "Pa$$word123"
  },
  "hradmin": {
    "username": "admin1",
    "password": "Pa$$word123"
  }
}

🧪 Testing Strategy

Test Pyramid

       E2E Tests (10%)
      ─────────────────
     Integration (30%)
    ─────────────────────
      Unit Tests (60%)

Coverage Areas

1. Authentication & Authorization (15 tests)

  • OIDC login flow
  • Token management
  • Role-based access control
  • Session handling

2. Employee Management (25 tests)

  • List, create, edit, delete
  • Search and filtering
  • Pagination
  • Form validation

3. Department Management (15 tests)

  • Full CRUD operations
  • Validation
  • Relationships

4. Position Management (12 tests)

  • HRAdmin-only access
  • CRUD operations
  • Authorization tests

5. Salary Ranges (12 tests)

  • HRAdmin-only access
  • Min/max validation
  • Relationships

6. Dashboard (8 tests)

  • Metrics display
  • Charts
  • Navigation

7. API Integration (20 tests)

  • Direct API calls
  • Authentication
  • Error handling
  • Performance

8. Workflows (10 tests)

  • Multi-step scenarios
  • Real-world usage patterns

9. Error Handling (15 tests)

  • Network errors
  • Validation errors
  • Edge cases

10. Visual & Accessibility (10 tests)

  • Visual regression
  • Keyboard navigation
  • ARIA compliance
  • Responsive design

Total: ~142 tests planned

📁 Project Structure

C:\apps\playwright\
├── docs/
│   ├── PROJECT_OVERVIEW.md          # This file
│   ├── IMPLEMENTATION_PLAN.md       # Detailed task breakdown
│   └── QUICK_START.md               # Getting started guide
│
├── tests/
│   ├── auth/                        # Authentication tests
│   ├── employee-management/         # Employee CRUD tests
│   ├── department-management/       # Department tests
│   ├── position-management/         # Position tests
│   ├── salary-ranges/               # Salary range tests
│   ├── dashboard/                   # Dashboard tests
│   ├── api/                         # API integration tests
│   ├── workflows/                   # End-to-end workflows
│   ├── error-handling/              # Error scenarios
│   ├── visual/                      # Visual regression
│   └── accessibility/               # Accessibility tests
│
├── fixtures/
│   ├── auth.fixtures.ts             # Login helpers
│   ├── data.fixtures.ts             # Test data factories
│   ├── api.fixtures.ts              # API helpers
│   └── user-roles.fixtures.ts       # Role management
│
├── page-objects/
│   ├── auth/                        # Login pages
│   ├── dashboard.page.ts            # Dashboard POM
│   ├── employee-list.page.ts        # Employee list POM
│   ├── employee-form.page.ts        # Employee form POM
│   └── navigation.page.ts           # Navigation POM
│
├── utils/
│   ├── token-manager.ts             # JWT utilities
│   ├── test-data-generator.ts       # Data generation
│   └── api-helpers.ts               # API utilities
│
├── config/
│   ├── test-users.json              # Test accounts
│   └── environments.json            # Environment URLs
│
├── playwright.config.ts             # Playwright configuration
├── package.json                     # Dependencies
└── README.md                        # Setup instructions

🚀 Implementation Timeline

Phase 1: Foundation (Weeks 1-2)

  • Project setup
  • Directory structure
  • Authentication fixtures
  • Critical path tests
  • CI/CD integration

Phase 2: Core Features (Weeks 3-4)

  • Employee management tests
  • Department management tests
  • API integration tests
  • Page Object Models

Phase 3: Advanced Features (Weeks 5-6)

  • Position & salary range tests
  • Dashboard tests
  • Role-based access tests
  • End-to-end workflows

Phase 4: Polish & Edge Cases (Weeks 7-8)

  • Error handling
  • Performance tests
  • Visual regression
  • Accessibility tests
  • Cross-browser validation

Total Duration: 8 weeks

📈 Success Metrics

Coverage

  • ✅ 100% of critical user paths tested
  • ✅ All CRUD operations verified
  • ✅ All 3 roles tested
  • ✅ Authentication flows covered
  • ✅ API endpoints validated

Quality

  • ✅ Test execution time < 10 minutes
  • ✅ Flaky test rate < 5%
  • ✅ Pass rate > 95% on main branch
  • ✅ Zero P0 bugs in production

Process

  • ✅ Tests run on every PR
  • ✅ Automated test reports
  • ✅ Test coverage visible
  • ✅ Fast feedback loop

🛠️ Technology Stack

Testing Framework

  • Playwright 1.58.2 - E2E testing
  • TypeScript - Type safety
  • Node.js - Runtime

Reporting

  • HTML Reporter (built-in)
  • JUnit Reporter (CI/CD)
  • JSON Reporter (custom parsing)

CI/CD

  • GitHub Actions (or Azure DevOps)
  • Automated test execution
  • Artifact storage

📚 Key Documentation

For Developers

For QA Engineers

For DevOps

🔗 Related Links

📞 Contact & Support

Project Owner: [Your Name] QA Lead: [QA Lead Name] Questions: [Contact Email/Slack]

Last Updated: [Current Date] Version: 1.0