savvywombat / laravel-assert-selector-contains
Targeted content assertions using CSS selector expressions
Installs: 8 382
Dependents: 0
Suggesters: 0
Security: 0
Stars: 4
Watchers: 1
Forks: 3
Open Issues: 0
Requires
- php: ^8.1
- ext-dom: *
- ext-libxml: *
- illuminate/support: ^9.29.0|^10.0
- symfony/css-selector: ^6.1.0
Requires (Dev)
- friendsofphp/php-cs-fixer: ^3.14.0
- orchestra/testbench: ^7.7.0|^8.0
- phpunit/phpunit: ^9.5.0|^10.0
- squizlabs/php_codesniffer: ^3.7.0
README
Targeted content assertions using CSS selector expressions.
Laravel's built-in assertSee
is useful, but has some limitations:
- It makes a string match against the whole document, and could produce false positives.
- It is hard to assert if specific items have been correctly set (page titles, input labels, etc)
- When the assertion fails, it outputs the whole HTML document to the console.
This package provides a collection of additional assertions available on Laravel's TestResponse
to help target specific elements/attributes and improve message on failure.
assertSelectorExists($selector)
assertSelectorDoesNotExist($selector)
assertSelectorContains($selector, $value)
assertSelectorDoesNotContain($selector, $value)
assertSelectorAttributeExists($selector, $attribute)
assertSelectorAttributeDoesNotExist($selector, $attribute)
assertSelectorAttributeEquals($selector, $attribute, $value)
assertSelectorAttributeDoesNotEqual($selector, $attribute, $value)
assertSelectorAttributeContains($selector, $attribute, $value)
assertSelectorAttributeDoesNotContain($selector, $attribute, $value)
So, if you want to make sure that you are correctly setting the document title:
$response->assertSelectorContains('title', 'Welcome');
If you want to assert that a label has been set for a specific form input:
$response->assertSelectorExists('label[for=input-id]');
Or if a specific input has been set with the correct initial value:
$response->assertSelectorAttributeEquals('input[name=display_name]', 'value', 'SavvyWombat');
Installation
This package is available using Composer.
composer require --dev savvywombat/laravel-assert-selector-contains
Usage
namespace Tests\Feature; use SavvyWombat\LaravelAssertSelectorContains\AssertsWithSelectors; use Tests\TestCase; class ExampleTest extends TestCase { use AssertsWithSelectors; public function testDocumentTitleIsCorrect(): void { $response = $this->get('/'); $response->assertSelectorContains('title', 'Welcome'); } }
Credit
This package was inspired by a blog post from Liam Hammett:
Laravel Testing CSS Selector Assertion Macros
Support
Please report issues using the GitHub issue tracker. You are also welcome to fork the repository and submit a pull request.
Licence
This package is licensed under The MIT License (MIT).