Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/benconstable/phpspec-laravel
Test your Laravel applications with phpspec
https://github.com/benconstable/phpspec-laravel
laravel php phpspec testing
Last synced: 3 days ago
JSON representation
Test your Laravel applications with phpspec
- Host: GitHub
- URL: https://github.com/benconstable/phpspec-laravel
- Owner: BenConstable
- License: mit
- Created: 2014-03-10T10:22:29.000Z (almost 11 years ago)
- Default Branch: master
- Last Pushed: 2019-06-24T05:08:09.000Z (over 5 years ago)
- Last Synced: 2024-12-26T18:09:39.762Z (10 days ago)
- Topics: laravel, php, phpspec, testing
- Language: PHP
- Homepage:
- Size: 107 KB
- Stars: 145
- Watchers: 12
- Forks: 47
- Open Issues: 4
-
Metadata Files:
- Readme: README.md
- Contributing: CONTRIBUTING.md
- License: LICENSE
Awesome Lists containing this project
README
# phpspec Laravel Extension
> [phpspec](http://www.phpspec.net/) extension for testing [Laravel](http://laravel.com/)
applications.
[](https://travis-ci.org/BenConstable/phpspec-laravel)
[](https://packagist.org/packages/benconstable/phpspec-laravel)
[](https://packagist.org/packages/benconstable/phpspec-laravel)
[](https://packagist.org/packages/benconstable/phpspec-laravel)
## Versions
Depending on the version of Laravel and/or Phpspec you're using, you'll want to make sure that
you're using the version of this package that's right for you. Use the table below to pick
the right one.
| PHP Version | Package Version | Laravel Version | Phpspec Version |
| ----------- | --------------- | --------------- | --------------- |
| `>=5.3.0` | `^v1.2` | `^v4.1` | `^v2.0` |
| `>=5.4.0` | `^v2.0` | `v5.0-v5.3` | `^v2.1` |
| `>=5.6.0` | `^v3.0` | `^v5.1-v5.4` | `^v3.0` |
| `>=7.0.0` | `^v4.0` | `^v5.4` | `^v4.0` |
## Installation
Install the package with composer:
```
composer require --dev "benconstable/phpspec-laravel:~4.0"
```
then add this to your `phpspec.yml`:
```yaml
extensions:
PhpSpec\Laravel\Extension\LaravelExtension: ~
```
You can take a look at [`example.phpspec.yml`](https://github.com/BenConstable/phpspec-laravel/blob/master/example.phpspec.yml)
for a good set of sensible phpspec defaults for a Laravel project.
## Why this extension?
This extension provides you with a bootstrapped Laravel environment when writing
your phpspec tests.
It allows you to make use of some of the nice features that Laravel provides, like
class aliases and helper functions, without being hindered by your testing framework.
This extension **is not** a swap-in replacement for Laravel's built in PHPUnit setup.
If you'd like integration and/or functional tests, please use that,
[Behat](http://behat.org/), or [Codeception](http://codeception.com/).
## Configuration
### Testing environment
By default, the extension bootstraps Laravel in the `testing` environment. You
can change this to production (or whatever you like) by setting:
```yaml
extensions:
PhpSpec\Laravel\Extension\LaravelExtension:
testing_environment: "production"
```
in your `phpspec.yml`.
### App bootstrap path
By default, the extension will bootstrap your app by looking for `bootstrap/app.php`
in the directory above `vendor/`. This is the default location that Laravel
provides.
You can manually specify the path to the bootstrap file if you're using a non-standard
installation, like so:
```yaml
extensions:
PhpSpec\Laravel\Extension\LaravelExtension:
framework_path: "/non/standard/laravel/setup/app.php"
```
You can specify either an absolute path (use leading slash), or a path relative
to the `vendor/` directory.
## Usage
### Testing without Laravel
If you're not using any code specific to the Laravel environment, then you don't
need to do anything differently. Just write your phpspec tests as normal!
### Testing with Laravel
If you want to take advantage of Laravel's aliases, or use some of its
[helper functions](https://laravel.com/docs/5.4/helpers), extend your specs
from `PhpSpec\Laravel\LaravelObjectBehavior`. This will prevent errors when
testing.
**For example, this class uses an alias:**
```php
quoteBackwards()->shouldBeString();
}
}
```
you'll get `Fatal error: Class 'Inspiring' not found...`. But extending from `PhpSpec\Laravel\LaravelObjectBehavior`:
```php
quoteBackwards()->shouldBeString();
}
}
```
you'll get `✔ inspires backwards`.
**and this class uses a helper function:**
```php
encrypt()->shouldBeString();
}
}
```
you'll get `Fatal error: Call to a member function make() on a non-object...`.
But extending from `PhpSpec\Laravel\LaravelObjectBehavior`:
```php
encrypt()->shouldBeString();
}
}
```
you'll get `✔ encrypts a string`.
### Accessing the IoC container
If you need to access the [Service Container](http://laravel.com/docs/5.0/container)
in your specs, just use the `app()` helper!
## Learning more about phpspec and Laravel
[Laracasts](https://laracasts.com/) has some great guides on phpspec and Laravel.
['Laravel, phpspec and refactoring'](https://laracasts.com/lessons/phpspec-laravel-and-refactoring)
is a good starting point; it shows how you should use phpspec with Laravel,
and covers the basics of writing tests (and it's free!).
## Contributing
See [CONTRIBUTING.md](https://github.com/BenConstable/phpspec-laravel/blob/master/CONTRIBUTING.md).
## License
MIT © Ben Constable. See [LICENSE](https://github.com/BenConstable/phpspec-laravel/blob/master/LICENSE) for more info.
## Thanks
Thanks to...
* [@obrignoni](https://github.com/obrignoni) for their great work in getting this extension working with Laravel 5
* [@Sam-Burns](https://github.com/Sam-Burns) for their great work in getting this extension working with Phpspec v3 and v4
* All of the [other contributors](https://github.com/BenConstable/phpspec-laravel/graphs/contributors) and to everyone that's
reported issues and bugs with the project