Download the PHP package cleaniquecoders/uat without Composer

User Acceptance Testing

This package automatically generates comprehensive User Acceptance Testing (UAT) documentation for Laravel applications by analyzing your routes, middleware, policies, and authorization rules. It creates structured test scripts that help QA teams and stakeholders understand what needs to be tested and how to test it.

Features

• 📋 Automatic UAT Script Generation: Analyzes your Laravel application and generates detailed testing documentation
• 🔐 Authorization Testing: Identifies middleware, policies, and authorization requirements for each route
• 📊 Multiple Output Formats: Supports Markdown and JSON output formats
• 🎯 Route Analysis: Analyzes all application routes and groups them by modules/controllers
• 👥 User Role Documentation: Generates user role and permission requirements
• ⚙️ Configurable Rules: Customizable middleware and authorization rule mappings
• 🚫 Smart Filtering: Excludes development routes and packages from documentation

What It Generates

The package creates comprehensive UAT documentation including:

1. Project Information: Technical stack, environment details, and configuration
2. User Roles & Permissions: Required user types and their capabilities
3. Available Modules: Organized overview of all testable application modules
4. Module Test Suites: Detailed testing scripts for each module including:
   • Route information and HTTP methods
   • Authentication and authorization requirements
   • Step-by-step testing instructions
   • Expected behaviors and validation criteria
   • Prerequisites and setup requirements

Installation

You can install the package via composer:

Publish the configuration file:

Configuration

The published configuration file (config/uat.php) allows you to customize:

• Output directory for generated documentation
• Middleware and authorization rule mappings
• Policy mappings for controllers
• Excluded route prefixes
• Custom service implementations
• Output format configurations

Example Configuration

Usage

Generate UAT Documentation

Generate UAT scripts using the Artisan command:

Programmatic Usage

You can also generate UAT scripts programmatically:

Using the Facade

Generated Documentation Structure

When you run the command, it creates a directory structure like this:

Sample Generated Content

Project Information:

• Laravel version, PHP version, database configuration
• Environment details and technical stack
• UAT testing guidelines

Module Test Suites:

• Route-by-route testing instructions
• Authentication and authorization requirements
• Step-by-step user actions
• Expected results and validation criteria
• Prerequisites and test data requirements

Extending the Package

The concept is to extend the core features without modifying the core classes. Current status still requirement study.

At the moment, you may customise the existing core services. See following sections for more details.

Custom Data Service

Implement the Data contract to customize data collection:

Custom Presentation Format

Implement the Presentation contract for custom output formats:

Integration with CI/CD

You can integrate UAT generation into your deployment pipeline:

Testing

Changelog

Please see CHANGELOG for more information on what has changed recently.

Contributing

Please see CONTRIBUTING for details.

Security Vulnerabilities

Please review our security policy on how to report security vulnerabilities.

Credits

• Nasrul Hazim Bin Mohamad
• All Contributors

License

The MIT License (MIT). Please see License File for more information.