Laravel Async Testing
this package can help you to test race condition in Laravel Feature Test
Requirements
- Laravel versions 5.7, 6.x, 7.x and 8.x
- PHP 7.0 or greater
Installation
Install the package with composer:
composer require recca0120/async-testing --dev
Usage
- set a real database in phpunit.xml
<phpunit>
<php>
<!-- DB_CONNECTION can't be %memory% -->
<server name="DB_CONNECTION" value="sqlite"/>
<server name="DB_DATABASE" value="database/database.sqlite"/>
</php>
</phpunit>
- make a product migration
<?php
use Illuminate\Database\Migrations\Migration;
use Illuminate\Database\Schema\Blueprint;
use Illuminate\Support\Facades\Schema;
class CreateProductsTable extends Migration
{
/**
* Run the migrations.
*
* @return void
*/
public function up()
{
Schema::create('products', function (Blueprint $table) {
$table->id();
$table->string('name');
$table->integer('quantity')->default(0);
$table->timestamps();
});
}
/**
* Reverse the migrations.
*
* @return void
*/
public function down()
{
Schema::dropIfExists('products');
}
}
- define product model
App\Models\Product
<?php
namespace App\Models;
use Illuminate\Database\Eloquent\Builder;
use Illuminate\Database\Eloquent\Factories\HasFactory;
use Illuminate\Database\Eloquent\Model;
/**
* Class Product.
* @property int id
* @property string name
* @property int quantity
* @package App\Models
* @mixin Builder
*/
class Product extends Model
{
use HasFactory;
protected $fillable = ['name', 'quantity'];
protected $casts = ['quantity' => 'int'];
}
- define router in
routes/web.php
<?php
use App\Models\Product;
use Illuminate\Support\Facades\Route;
Route::get('/product/{productId}', function ($productId) {
return Product::findOrFail($productId);
});
Route::post('/product/{productId}', function ($productId) {
$product = Product::findOrFail($productId);
if ($product->quantity > 0) {
// wrong, it will make test fail
// $product->fill(['quantity' => $product->quantity - 1])->save();
// correct
$product->where('id', $product->id)
->where('quantity', '>', 0)
->update(['quantity' => DB::raw('quantity - 1')]);
}
return $product->fresh();
});
- testing
<?php
namespace Tests\Feature;
use App\Models\Product;
use Illuminate\Foundation\Testing\DatabaseMigrations;
use Recca0120\AsyncTesting\AsyncRequest;
use Tests\TestCase;
class RaceConditionTest extends TestCase
{
use DatabaseMigrations;
private $product;
private $quantity = 10;
public function setUp(): void
{
parent::setUp();
$this->product = Product::create(['name' => 'test', 'quantity' => $this->quantity]);
}
public function test_race_condition()
{
$asyncRequest = $this->app->make(AsyncRequest::class);
$promises = collect();
for ($i = 0; $i < $this->quantity; $i++) {
// you will get \GuzzleHttp\Promise\PromiseInterface
$promise = $asyncRequest->post('/product/'.$this->product->id);
$promises->add($promise);
}
// you need wait response
$promises->map->wait()->each->assertOk();
$this->get('/product/'.$this->product->id)
->assertOk()
->assertJsonPath('quantity', 0);
}
public function test_use_times_to_test_race_condition()
{
$asyncRequest = $this->app->make(AsyncRequest::class);
$promises = collect($asyncRequest->times(10)->post('/product/'.$this->product->id));
// you need wait response
$promises->map->wait()->each->assertOk();
$this->get('/product/'.$this->product->id)
->assertOk()
->assertJsonPath('quantity', 0);
}
}
License
The MIT License (MIT). Please see License File for more information.