majidalaeinia/refresh-elastic

Refresh Elasticsearch indices for your tests (delete the indices and index them again based on their mappings if available).

1.0.0 2022-02-28 02:51 UTC

Requires

• php: ~8
• illuminate/support: ~7.4|~8

Requires (Dev)

• orchestra/testbench: ~5|~6
• phpunit/phpunit: ~9.0

MIT

• Majid Alaeinia

• test
• elasticsearch
• laravel
• RefreshElastic

README

You can use this package to refresh elastic indices (delete the index and make the index again with its corresponding mapping).
Inspired by Laravel RefreshDatabase.

Installation

Via Composer

$ composer require majidalaeinia/refresh-elastic --dev

Usage

First you need to publish the config file.

php artisan vendor:publish --tag=majidalaeinia-refresh-elastic.config

Fill the config file with appropriate values.

Then, use the RefreshElastic trait on your test.

<?php

namespace Tests\Feature\FancyTests;

use MajidAlaeinia\RefreshElastic\Traits\RefreshElastic;
use Illuminate\Foundation\Testing\RefreshDatabase;
use Tests\TestCase;

class YourFancyTest extends TestCase
{
    use RefreshDatabase, RefreshElastic;
    
}

Important NOTE: Make sure you are using this package on the development mode, because this trait deletes your elastic indices and re-indexes them.

Change log

Please see the changelog for more information on what has changed recently.

Testing

$ composer test

Contributing

Please see contributing.md for details and a todolist.

Security

If you discover any security related issues, please email alaeinia.majid@.com instead of using the issue tracker.

Credits

• Majid Alaeinia

TODO

• Add tests

License

MIT. Please see the license file for more information.