Skip to content

TESTS.md

Latest commit

 

History

History
412 lines (333 loc) · 13.2 KB

TESTS.md

File metadata and controls

412 lines (333 loc) · 13.2 KB

Test Plan for SES Dashboard Application

Overview

This document outlines all possible test cases for the Laravel-based SES Dashboard application, covering authentication, authorization, email tracking, webhooks, multi-user/multi-project functionality, and administrative features.

Test Categories

1. Authentication & Authorization Tests

1.1 Login/Logout Tests

  • Login with valid credentials (admin user)
  • Login with valid credentials (regular user)
  • Login with invalid email
  • Login with invalid password
  • Login with empty credentials
  • Login attempt with disabled/deleted user account
  • Logout functionality
  • Session persistence after login
  • Session expiry handling
  • Redirect to intended page after login

1.2 User Role Authorization Tests

  • Admin access to admin-only routes
  • Regular user blocked from admin routes
  • Unauthenticated user redirected to login
  • User accessing their own profile
  • User trying to access another user's data

2. User Management Tests (Admin Only)

2.1 User CRUD Operations

  • Admin can view all users list
  • Admin can create new admin user
  • Admin can create new regular user
  • Admin can edit user details (name, email)
  • Admin can change user password
  • Admin can change user role (admin/user)
  • Admin can delete regular user
  • Admin cannot delete user ID=1 (protected user)
  • Admin cannot change role of user ID=1
  • Regular user cannot access user management

2.2 User Validation Tests

  • Create user with duplicate email fails
  • Create user with invalid email format fails
  • Create user with weak password fails
  • Update user with existing email fails
  • Password confirmation mismatch fails
  • Required fields validation (name, email, role)

2.3 User-Project Assignment Tests

  • Admin can assign projects to regular users
  • Admin users automatically access all projects
  • User deletion removes all project assignments
  • Project assignment sync on user role change

3. Project Management Tests (Admin Only)

3.1 Project CRUD Operations

  • Admin can view all projects
  • Admin can create new project
  • Admin can edit project details
  • Admin can delete project
  • Admin can assign users to projects
  • Admin can remove users from projects
  • Regular user cannot access project management

3.2 Project Security Tests

  • Project tokens are unique and secure
  • Project deletion removes all associated emails
  • Project deletion removes user assignments
  • Webhook URLs are properly generated

3.3 Project Validation Tests

  • Create project with duplicate name
  • Create project with empty name fails
  • Assign non-existent users to project fails

4. Project Access Control Tests

4.1 Dashboard Access Tests

  • Admin sees all projects data
  • Regular user sees only assigned projects data
  • User with no projects sees appropriate message
  • Project dropdown shows only accessible projects
  • API requests validate project access

4.2 Activity Access Tests

  • Admin can view emails from all projects
  • Regular user can view only assigned project emails
  • Project filtering respects user permissions
  • Email details API validates project access

4.3 Export Access Tests

  • Admin can export from all projects
  • Regular user can export only assigned projects
  • Export with invalid project ID returns 403
  • Export respects project filtering

5. Email Tracking & Dashboard Tests

5.1 Dashboard Functionality Tests

  • Dashboard displays correct email counters
  • Chart data reflects actual email events
  • Date range filtering works correctly
  • Project filtering updates dashboard data
  • Timezone handling for chart data

5.2 Dashboard API Tests

  • API returns correct data structure
  • API validates project access
  • API handles invalid date ranges
  • API handles missing parameters gracefully
  • API performance with large datasets

5.3 Dashboard Security Tests

  • API endpoints require authentication
  • API respects project access permissions
  • API prevents data leakage between projects

6. Activity Management Tests

6.1 Activity List Tests

  • Activity page displays email list
  • Pagination works correctly
  • Search functionality (email, subject)
  • Date range filtering
  • Event type filtering
  • Project filtering
  • Sorting by various columns

6.2 Activity API Tests

  • List API returns paginated results
  • List API validates project access
  • Search API handles special characters
  • Filter API handles empty results
  • API performance with large datasets

6.3 Email Details Tests

  • Email details modal shows correct data
  • Details API validates email access
  • Details API returns 404 for non-existent emails
  • Event history displays correctly

7. Export Functionality Tests

7.1 CSV Export Tests

  • CSV export with all projects (admin)
  • CSV export with assigned projects (regular user)
  • CSV export with specific project
  • CSV export with search filters
  • CSV export with date range filters
  • CSV export with event type filters
  • CSV export handles empty results
  • CSV export handles special characters
  • CSV export handles NULL values

7.2 Excel Export Tests

  • Excel export with all projects (admin)
  • Excel export with assigned projects (regular user)
  • Excel export with specific project
  • Excel export with search filters
  • Excel export with date range filters
  • Excel export with event type filters
  • Excel export handles empty results
  • Excel export handles special characters
  • Excel export handles NULL values
  • Excel export handles array data (destinations)

7.3 Export Security Tests

  • Export validates project access
  • Export returns 403 for unauthorized projects
  • Export respects user project assignments

8. Webhook Processing Tests

8.1 SNS Confirmation Tests

  • Webhook handles SNS subscription confirmation
  • Webhook validates SNS message structure
  • Webhook confirms subscription automatically

8.2 SES Event Processing Tests

  • Webhook processes Send events
  • Webhook processes Delivery events
  • Webhook processes Bounce events
  • Webhook processes Complaint events
  • Webhook processes Open events
  • Webhook processes Click events
  • Webhook processes Reject events
  • Webhook processes Rendering Failure events

8.3 Webhook Security Tests

  • Webhook validates project token
  • Webhook rejects invalid tokens
  • Webhook validates project exists
  • Webhook logs debug information

8.4 Webhook Data Handling Tests

  • Webhook creates Email records correctly
  • Webhook creates EmailEvent records correctly
  • Webhook handles duplicate events
  • Webhook handles malformed JSON
  • Webhook handles missing required fields
  • Webhook updates email counters (opens, clicks)

9. Email Sending Tests

9.1 Test Email Functionality

  • Send test email with valid data
  • Send test email with invalid recipient
  • Send test email with empty subject
  • Send test email with empty message
  • Send test email with configuration set
  • Test email validation rules

9.2 SesMail Integration Tests

  • Mail sent through SES successfully
  • Mail headers include tracking data
  • Mail uses correct configuration set
  • Mail sender validation

10. Database & Model Tests

10.1 Model Relationship Tests

  • User-Project many-to-many relationship
  • Project-Email one-to-many relationship
  • Email-EmailEvent one-to-many relationship
  • User role constants and methods
  • Project token generation

10.2 Database Constraint Tests

  • Foreign key constraints work correctly
  • Unique constraints prevent duplicates
  • Required field constraints
  • Data type constraints

10.3 Model Accessor/Mutator Tests

  • Email destination JSON handling
  • Timestamp formatting
  • Role validation

11. Service Layer Tests

11.1 ProjectAccessService Tests

  • getAccessibleProjects() returns correct projects for admin
  • getAccessibleProjects() returns assigned projects for user
  • getAccessibleProjectIds() returns correct IDs
  • hasAccessToProjectId() validates access correctly
  • Service handles users with no projects

11.2 WriterFormatFactory Tests

  • Factory creates CSV writer correctly
  • Factory creates Excel writer correctly
  • Factory handles invalid format gracefully

12. Middleware Tests

12.1 AdminMiddleware Tests

  • Admin users pass through middleware
  • Regular users are blocked
  • Unauthenticated users are redirected
  • Middleware preserves intended URL

13. Policy Tests

13.1 ProjectPolicy Tests

  • Admin can perform all project actions
  • Regular user cannot perform project actions
  • Policy validation for each CRUD operation

13.2 UserPolicy Tests

  • Admin can manage all users except user ID=1 deletion
  • Regular user cannot manage users
  • User ID=1 protection in delete policy

14. Validation & Error Handling Tests

14.1 Form Validation Tests

  • User creation validation
  • User update validation
  • Project creation validation
  • Email sending validation
  • Search and filter validation

14.2 Error Response Tests

  • 404 errors for non-existent resources
  • 403 errors for unauthorized access
  • 422 errors for validation failures
  • 500 errors handled gracefully

15. Security Tests

15.1 CSRF Protection Tests

  • Forms include CSRF tokens
  • API endpoints validate CSRF tokens
  • Invalid CSRF tokens rejected

15.2 SQL Injection Tests

  • Search parameters sanitized
  • Filter parameters sanitized
  • User input properly escaped

15.3 XSS Prevention Tests

  • User input properly escaped in views
  • JSON responses properly encoded
  • File download headers secure

16. Performance Tests

16.1 Database Performance Tests

  • Large dataset query performance
  • Pagination performance
  • Export performance with large datasets
  • Dashboard API performance

16.2 Memory Usage Tests

  • Export memory usage with large datasets
  • Streaming response efficiency
  • Database query optimization

17. Integration Tests

17.1 Full Workflow Tests

  • Complete user registration and project assignment flow
  • End-to-end email tracking workflow
  • Complete webhook processing workflow
  • Multi-user project collaboration workflow

17.2 Cross-Feature Tests

  • User deletion impact on projects and emails
  • Project deletion impact on users and emails
  • Role changes impact on permissions

18. Browser/Frontend Integration Tests

18.1 JavaScript Integration Tests

  • Dashboard project selector updates data
  • Activity project selector updates data
  • Export button respects project selection
  • Real-time UI updates

18.2 AJAX API Tests

  • Dashboard API integration
  • Activity list API integration
  • Email details API integration

19. Configuration & Environment Tests

19.1 Environment Configuration Tests

  • Database connection handling
  • AWS SES configuration validation
  • Mail driver configuration
  • Cache configuration

19.2 Error Configuration Tests

  • Debug mode behavior
  • Logging configuration
  • Error page rendering

20. Backup & Recovery Tests

20.1 Data Integrity Tests

  • Database transaction handling
  • Data consistency after operations
  • Rollback functionality

Test Implementation Priority

High Priority (Core Functionality)

  1. Authentication & Authorization Tests
  2. Project Access Control Tests
  3. Webhook Processing Tests
  4. User & Project Management Tests

Medium Priority (Features)

  1. Email Tracking & Dashboard Tests
  2. Activity Management Tests
  3. Export Functionality Tests
  4. Security Tests

Low Priority (Edge Cases & Performance)

  1. Performance Tests
  2. Integration Tests
  3. Configuration Tests
  4. Error Handling Tests

Test Data Requirements

Sample Data Needed

  • Multiple user accounts (admin and regular users)
  • Multiple projects with different user assignments
  • Sample email records with various statuses
  • Sample email events for each event type
  • Large datasets for performance testing
  • Edge case data (NULL values, special characters)

Test Environment Setup

  • Isolated test database
  • Mock AWS SES integration
  • Test webhook endpoints
  • Sample configuration files

Notes for Test Implementation

  1. Use Laravel's built-in testing features (TestCase, DatabaseTransactions, etc.)
  2. Create factories for all models to generate test data
  3. Use feature tests for HTTP endpoints and unit tests for individual methods
  4. Mock external services (AWS SES) for reliable testing
  5. Implement continuous integration to run tests automatically
  6. Create separate test suites for different test categories
  7. Use database transactions to keep tests isolated
  8. Test with realistic data volumes to catch performance issues