README

A package that creates PEST tests specifically tailored for your Filament components.

Early development

This package is still in early development. Some features may not be available yet or may not work as expected. If you encounter any issues, please create an issue on this repository.

🔴 This package is not production-ready yet, use it at your own risk. ⚠️

Installation

You can install the package via composer:

composer require codewithdennis/filament-tests --dev

You can publish the config file with:

php artisan vendor:publish --tag="filament-tests-config"

This is the contents of the published config file:

return [
    /**
     * The directory where the tests will be generated in.
     */
    'directory_name' => env('FILAMENT_TESTS_DIRECTORY_NAME', 'tests/Feature'),

    /**
     * Whether to separate the tests into folders based on the resource name.
     */
    'separate_tests_into_folders' => env('FILAMENT_TESTS_SEPARATE_TESTS_INTO_FOLDERS', false),
];

Requirements

This package requires Filament v3 or later to run.

This package generates PestPHP tests, make sure you have it installed in your project. You can install it by running the following command:

composer require pestphp/pest --dev --with-all-dependencies

Make sure you have the following packages installed as well:

composer require pestphp/pest-plugin-livewire --dev

composer require pestphp/pest-plugin-laravel --dev

Usage

You can create a new test for a resource by running the following command:

The following name formats are supported: blog, Blog, BlogResource

php artisan make:filament-test BlogResource

You can also pass a comma-separated list of resource names to create tests for multiple resources at once:

php artisan make:filament-test "BlogResource, PostResource"

If you don't specify a resource name, you will be prompted to choose one or more resources to create tests for interactively.

php artisan make:filament-test

Options

Option	Description
`--all` `-a`	Create tests for all Filament resources
`--directory` `-d`	The output directory for the test
`--except` `-e`	Create tests for all Filament resources except the specified resources
`--force` `-f`	Overwrite existing tests
`--only` `-o`	Create tests for the specified resources

Tests

Tests are generated on demand and are tailored to the component that you're generating tests for. For example, if the resource component doesn't have any sortable columns, then the tests for sorting won't be generated.

Available Tests

List of available tests (46) ✔️

it can render the registration page
it can render the password reset page
it can render the login page
it can render the create page
it has create form
has a disabled field on create form
it has a field on create form
it has a hidden field on create form
it can render the edit page
it can render the relation manager on the edit page
it has the correct table heading on the relation manager on the edit page
it has the correct table description on the relation manager on the edit page
it can render column on the relation manager on the edit page
it cannot render column on the relation manager on the edit page
it has the correct descriptions above on the relation manager on the edit page
it has the correct descriptions below on the relation manager on the edit page
it has a field on edit form
it has a hidden field on edit form
it has column on the relation manager on the edit page
it has extra attributes on the relation manager on the edit page
it can search column on the relation manger on the edit page
it can (individually) search column on the relation manger on the edit page
it has select column with correct options on the relation manager on the edit page
it can sort column on the relation manager on the edit page
it can list records on the index page on the relation manager on the edit page
it can list records on the index page on the relation manager on the edit page with pagination
it can render the view page
it can render the relation manager on the view page
it has the correct table heading on the relation manager on the view page
it has the correct table description on the relation manager on the view page
it can render column on the relation manager on the view page
it cannot render column on the relation manager on the view page
it has the correct descriptions above on the relation manager on the view page
it has the correct descriptions below on the relation manager on the view page
it has a field on view form
it has a hidden field on view form
it has column on the relation manager on the view page
it has extra attributes on the relation manager on the view page
it can search column on the relation manger on the view page
it can (individually) search column on the relation manger on the view page
it has select column with correct options on the relation manager on the view page
it can sort column on the relation manager on the view page
it can list records on the index page on the relation manager on the view page
it can list records on the index page on the relation manager on the view page with pagination
it has edit form
it has header actions on the index page
it cannot render header actions on the index page
it can render header actions on the index page
it can list records on the index page
it can list records on the index page with pagination
it can render the index page
it cannot display trashed records by default
it has the correct table description
it has the correct table heading
it can delete records
it can force delete records
it can soft delete records
it has table action
it can replicate records
it can restore records
it has the correct URL for table action
it has the correct URL and opens in a new tab for table action
it can bulk delete records
it can bulk force delete records
it can bulk delete records
it has table bulk action
it can bulk restore records
it can bulk soft delete records
it cannot render column
it has the correct descriptions above
it has the correct descriptions below
it has column
it has extra attributes
it can render column
it can search column
it can individually search by column
it has the correct options
it can sort column
it can reset table filters
it can render the view page

Publishing Stubs

You can customize the stubs by publishing them to your project:

php artisan vendor:publish --tag="filament-tests-stubs"

Running the package tests

You can run your tests normally by running the following command:

vendor/bin/pest

You can choose to only run the tests for this package by running the following command:

vendor/bin/pest --group=filament-tests

You can also run all your tests except the ones for this package by running the following command:

vendor/bin/pest --exclude-group=filament-tests

Additional grouping options

Name	Includes
`filters`	Runs the tests for the filters
`page`	Runs the tests for the pages
`render`	Runs the tests that check if the page renders correctly
`table`	Runs the tests for the table
`table-actions`	Runs the tests for table actions
`table-bulk-actions`	Runs the tests for table bulk actions

You can add any of those above groups to either --exclude-group or --group to include or exclude them from the test run. You can comma-separate multiple groups.

Credits

License

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

codewithdennis / filament-tests

Maintainers

Details