Skip to content

Commit

Permalink
First commit
Browse files Browse the repository at this point in the history
  • Loading branch information
canvural committed Feb 11, 2020
0 parents commit b3b56dd
Show file tree
Hide file tree
Showing 29 changed files with 6,694 additions and 0 deletions.
18 changes: 18 additions & 0 deletions .editorconfig
Original file line number Diff line number Diff line change
@@ -0,0 +1,18 @@
; This file is for unifying the coding style for different editors and IDEs.
; More information at https://editorconfig.org

root = true

[*]
charset = utf-8
indent_size = 4
indent_style = space
end_of_line = lf
insert_final_newline = true
trim_trailing_whitespace = true

[*.md]
trim_trailing_whitespace = false

[*.yml]
indent_size = 2
11 changes: 11 additions & 0 deletions .gitattributes
Original file line number Diff line number Diff line change
@@ -0,0 +1,11 @@
# Path-based git attributes
# https://www.kernel.org/pub/software/scm/git/docs/gitattributes.html

# Ignore all test and documentation with "export-ignore".
/.gitattributes export-ignore
/.gitignore export-ignore
/.travis.yml export-ignore
/phpunit.xml.dist export-ignore
/.scrutinizer.yml export-ignore
/tests export-ignore
/.editorconfig export-ignore
45 changes: 45 additions & 0 deletions .github/workflows/run-tests.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,45 @@
name: Run tests

on:
push:
schedule:
- cron: '0 0 * * *'

jobs:
php-tests:
runs-on: ${{ matrix.os }}

strategy:
matrix:
php: [7.4, 7.3, 7.2]
laravel: [6.*, 7.*]
os: [ubuntu-latest]
include:
- laravel: 6.*
testbench: 4.*
- laravel: 7.*
testbench: 5.*

name: P${{ matrix.php }} - L${{ matrix.laravel }} - ${{ matrix.os }}

steps:
- name: Checkout code
uses: actions/checkout@v1

- name: Setup PHP
uses: shivammathur/setup-php@v1
with:
php-version: ${{ matrix.php }}
extension: pdo, sqlite, pdo_sqlite
coverage: none

- name: Install dependencies
run: |
composer require "laravel/framework:${{ matrix.laravel }}" "orchestra/testbench:${{ matrix.testbench }}" --no-interaction --no-update
composer update --prefer-dist --prefer-dist --no-interaction --no-suggest
- name: Info
run: composer show

- name: Execute tests
run: composer test
8 changes: 8 additions & 0 deletions .gitignore
Original file line number Diff line number Diff line change
@@ -0,0 +1,8 @@
build
docs
vendor
coverage
/.phpunit.result.cache
.idea
/coverage.clover
/.phpcs-cache
19 changes: 19 additions & 0 deletions .scrutinizer.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,19 @@
filter:
excluded_paths: [tests/*]

checks:
php:
remove_extra_empty_lines: true
remove_php_closing_tag: true
remove_trailing_whitespace: true
fix_use_statements:
remove_unused: true
preserve_multiple: false
preserve_blanklines: true
order_alphabetically: true
fix_php_opening_tag: true
fix_linefeed: true
fix_line_ending: true
fix_identation_4spaces: true
fix_doc_comments: true

5 changes: 5 additions & 0 deletions .styleci.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,5 @@
preset: laravel

disabled:
- single_class_element_per_statement
- self_accessor
7 changes: 7 additions & 0 deletions CHANGELOG.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,7 @@
# Changelog

All notable changes to `laravel-e2e-routes` will be documented in this file

## 1.0.0 - 2020-02-11

- initial release
55 changes: 55 additions & 0 deletions CONTRIBUTING.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,55 @@
# Contributing

Contributions are **welcome** and will be fully **credited**.

Please read and understand the contribution guide before creating an issue or pull request.

## Etiquette

This project is open source, and as such, the maintainers give their free time to build and maintain the source code
held within. They make the code freely available in the hope that it will be of use to other developers. It would be
extremely unfair for them to suffer abuse or anger for their hard work.

Please be considerate towards maintainers when raising issues or presenting pull requests. Let's show the
world that developers are civilized and selfless people.

It's the duty of the maintainer to ensure that all submissions to the project are of sufficient
quality to benefit the project. Many developers have different skillsets, strengths, and weaknesses. Respect the maintainer's decision, and do not be upset or abusive if your submission is not used.

## Viability

When requesting or submitting new features, first consider whether it might be useful to others. Open
source projects are used by many developers, who may have entirely different needs to your own. Think about
whether or not your feature is likely to be used by other users of the project.

## Procedure

Before filing an issue:

- Attempt to replicate the problem, to ensure that it wasn't a coincidental incident.
- Check to make sure your feature suggestion isn't already present within the project.
- Check the pull requests tab to ensure that the bug doesn't have a fix in progress.
- Check the pull requests tab to ensure that the feature isn't already in progress.

Before submitting a pull request:

- Check the codebase to ensure that your feature doesn't already exist.
- Check the pull requests to ensure that another person hasn't already submitted the feature or fix.

## Requirements

If the project maintainer has any additional requirements, you will find them listed here.

- **[PSR-2 Coding Standard](https://github.com/php-fig/fig-standards/blob/master/accepted/PSR-2-coding-style-guide.md)** - The easiest way to apply the conventions is to install [PHP Code Sniffer](https://pear.php.net/package/PHP_CodeSniffer).

- **Add tests!** - Your patch won't be accepted if it doesn't have tests.

- **Document any change in behaviour** - Make sure the `README.md` and any other relevant documentation are kept up-to-date.

- **Consider our release cycle** - We try to follow [SemVer v2.0.0](https://semver.org/). Randomly breaking public APIs is not an option.

- **One pull request per feature** - If you want to do more than one thing, send multiple pull requests.

- **Send coherent history** - Make sure each individual commit in your pull request is meaningful. If you had to make multiple intermediate commits while developing, please [squash them](https://www.git-scm.com/book/en/v2/Git-Tools-Rewriting-History#Changing-Multiple-Commit-Messages) before submitting.

**Happy coding**!
21 changes: 21 additions & 0 deletions LICENSE.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,21 @@
MIT License

Copyright (c) 2020 Can Vural

Permission is hereby granted, free of charge, to any person obtaining a copy
of this software and associated documentation files (the "Software"), to deal
in the Software without restriction, including without limitation the rights
to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
copies of the Software, and to permit persons to whom the Software is
furnished to do so, subject to the following conditions:

The above copyright notice and this permission notice shall be included in all
copies or substantial portions of the Software.

THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
SOFTWARE.
119 changes: 119 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,119 @@
# Set of routes to manage your data in E2E tests

[![Latest Version on Packagist](https://img.shields.io/packagist/v/canvural/laravel-e2e-routes.svg?style=flat-square)](https://packagist.org/packages/canvural/laravel-e2e-routes)
![Run tests](https://github.com/canvural/laravel-e2e-routes/workflows/Run%20tests/badge.svg?branch=master)
[![Total Downloads](https://img.shields.io/packagist/dt/canvural/laravel-e2e-routes.svg?style=flat-square)](https://packagist.org/packages/canvural/laravel-e2e-routes)


This package provides a set of rules to help you manage your database state when running your E2E tests using Eloquent model factories.
## Installation

You can install the package via composer:

```bash
composer require canvural/laravel-e2e-routes
```

If you wish to customize some options, you may publish the config file with

```bash
php artisan vendor:publish --provider="Vural\E2ERoutes\E2ERoutesServiceProvider"
```

This is the published config files contents. Here you can customize the route prefix which will be added to all the provided routes.Route names, and the namespace that all your models live in.
```php
<?php

return [
'prefix' => 'e2e',
'name' => 'e2e-routes',
'modelNamespace' => 'App\\',
];

```

## Usage

For obvious reasons this package does not exposes the routes in the `production` environment. In other environments you can use the routes.

#### Reset database (GET `e2e/reset`)

You can use the `http://localhost/e2e/reset` route to reset your database. Under the hood this route makes a call to `migrate:refresh` Artisan command. Also if you wish to `seed` your database after migrating, you may call the route with `seed` query string attached. `http://localhost/e2e/reset?seed`

#### Creating models (POST `e2e/{modelName}`)

This package uses your Eloquent model factories to create the data.

So, for example if you have a model called `User` and the associated `UserFactory` you can make a POST request to the `http://localhost/e2e/user` endpoint to create a `User` in your database. Also, newly created model will be returned as a response from the endpoint.

You can substitute `user` in the above example with any model you want. If the given model is not found, a `404` response will be returned. Also, if the model exists but a factory for that model does not exists a `404` response will be returned.

#### Overwriting attributes

Like the `factory` method, this package also provides you an ability to overwrite models attributes. Simply add a body to your request like so:

```php
[
'attributes' => [ 'name' => 'John Doe' ]
]
```
This will overwrite the `name` attribute.

#### Creating many models

You can specify how many model you want to create with
```php
[
'times' => 3
]
```
This will return an array containing 3 models.

#### Using states
If you defined some states for your factories, you can use them when you are making the request.

```php
[
'states' => ['withAddress']
]
```
This will create your model with the `withAddress` state. If the given state is not endpoint will return a `404` response.

#### All together
```php
[
'attributes' => [
'name' => 'John Doe',
],
'states' => ['withAddress'],
'times' => 2
]
```
You can also combine the options like this.

### Testing

``` bash
composer test
```

### Changelog

Please see [CHANGELOG](CHANGELOG.md) for more information on what has changed recently.

## Contributing

Please see [CONTRIBUTING](CONTRIBUTING.md) for details.

### Security

If you discover any security related issues, please email [email protected] instead of using the issue tracker.

## Credits

- [Can Vural](https://github.com/CanVural)
- [All Contributors](../../contributors)

## License

The MIT License (MIT). Please see [License File](LICENSE.md) for more information.
68 changes: 68 additions & 0 deletions composer.json
Original file line number Diff line number Diff line change
@@ -0,0 +1,68 @@
{
"name": "canvural/laravel-e2e-routes",
"description": "Set of routes for you to use in E2E tests.",
"keywords": [
"laravel",
"e2e",
"routes",
"testing"
],
"homepage": "https://github.com/canvural/laravel-e2e-routes",
"license": "MIT",
"authors": [
{
"name": "Can Vural",
"email": "[email protected]",
"role": "Developer"
}
],
"require": {
"php": "^7.2",
"illuminate/database": "^6.0 || ^7.0"
},
"require-dev": {
"doctrine/coding-standard": "6.0",
"nunomaduro/larastan": "^0.5",
"orchestra/testbench": "^4.0 || ^5.0",
"phpstan/extension-installer": "^1.0",
"phpstan/phpstan-mockery": "^0.12",
"phpstan/phpstan-phpunit": "^0.12",
"phpunit/phpunit": "^8",
"roave/security-advisories": "dev-master"
},
"minimum-stability": "dev",
"prefer-stable": true,
"autoload": {
"psr-4": {
"Vural\\E2ERoutes\\": "src"
}
},
"autoload-dev": {
"psr-4": {
"Vural\\E2ERoutes\\Tests\\": "tests/",
"App\\" : "tests/Models"
}
},
"scripts": {
"test:types": "vendor/bin/phpstan analyse --ansi",
"test:unit": "vendor/bin/phpunit --colors=always",
"test:style": "vendor/bin/phpcs",
"test:unit-coverage": "vendor/bin/phpunit --coverage-html coverage",
"test": [
"@test:style",
"@test:types",
"@test:unit"
]

},
"config": {
"sort-packages": true
},
"extra": {
"laravel": {
"providers": [
"Vural\\E2ERoutes\\E2ERoutesServiceProvider"
]
}
}
}
Loading

0 comments on commit b3b56dd

Please sign in to comment.