WIP tests

Author: limenet

CHANGELOG.md

@@ -2,6 +2,11 @@
 
 All notable changes to `laravel-elastica-bridge` will be documented in this file.
 
+## 1.1.0 - UNRELEASED
+
+- provide default implementation for `Limenet\LaravelElasticaBridge\Model\ElasticsearchableInterface\toElasticsearch`
+- added tests
+
 ## 1.0.0 - 2021-05-09
 
 - initial release

composer.json

@@ -37,13 +37,16 @@
     },
     "autoload-dev": {
         "psr-4": {
-            "Limenet\\LaravelElasticaBridge\\Tests\\": "tests"
+            "Limenet\\LaravelElasticaBridge\\Tests\\": "tests",
+            "Limenet\\LaravelElasticaBridge\\Tests\\Database\\Factories\\": "tests/database/factories",
+            "Limenet\\LaravelElasticaBridge\\Tests\\Database\\Seeders\\": "tests/database/seeders"
         }
     },
     "scripts": {
         "psalm": "vendor/bin/psalm",
         "test": "./vendor/bin/testbench package:test --parallel --no-coverage",
-        "test-coverage": "vendor/bin/phpunit --coverage-html coverage"
+        "test-coverage": "XDEBUG_MODE=coverage vendor/bin/phpunit --coverage-html coverage",
+        "code-swift": "docker exec -it --user=laradock -w /var/www/$(git rev-parse --show-toplevel | xargs basename | cat) $(docker ps -q --filter name=laradock_workspace-8.0_) zsh"
     },
     "config": {
         "sort-packages": true

phpunit.xml.dist

@@ -23,7 +23,11 @@
             <directory>tests</directory>
         </testsuite>
     </testsuites>
-    <coverage>
+    <coverage
+        includeUncoveredFiles="true"
+        processUncoveredFiles="true"
+        pathCoverage="true"
+    >
         <include>
             <directory suffix=".php">./src</directory>
         </include>

tests/App/Elasticsearch/CustomerIndex.php

@@ -0,0 +1,27 @@
+<?php
+
+
+namespace Limenet\LaravelElasticaBridge\Tests\App\Elasticsearch;
+
+use Limenet\LaravelElasticaBridge\Index\AbstractIndex;
+use Limenet\LaravelElasticaBridge\Tests\App\Models\Customer;
+
+class CustomerIndex extends AbstractIndex {
+
+    public function getName(): string { return 'testing_customer'; }
+
+    public function getAllowedDocuments(): array {
+        return [Customer::class];
+     }
+
+     public function getMapping(): array
+     {
+         return [
+             'properties' => [
+                'group' => [
+                    'type' => 'keyword',
+                ],
+             ]
+                ];
+            }
+}

tests/App/Models/Customer.php

@@ -0,0 +1,24 @@
+<?php
+
+namespace Limenet\LaravelElasticaBridge\Tests\App\Models;
+
+use Illuminate\Database\Eloquent\Factories\Factory;
+use Illuminate\Database\Eloquent\Factories\HasFactory;
+use Illuminate\Database\Eloquent\Model;
+use Limenet\LaravelElasticaBridge\Index\IndexInterface;
+use Limenet\LaravelElasticaBridge\Model\ElasticsearchableInterface;
+use Limenet\LaravelElasticaBridge\Model\ElasticsearchableTrait;
+use Limenet\LaravelElasticaBridge\Tests\Database\Factories\CustomerFactory;
+
+class Customer extends Model implements ElasticsearchableInterface{
+use HasFactory;
+use ElasticsearchableTrait;
+
+public function toElasticsearch(IndexInterface $indexConfig): array { return $this->toArray(); }
+
+public function shouldIndex(IndexInterface $indexConfig): bool { return true;}
+protected static function newFactory():Factory
+{
+    return CustomerFactory::new();
+}
+}

tests/ExampleTest.php

@@ -0,0 +1,27 @@
+<?php
+
+namespace Limenet\LaravelElasticaBridge\Tests;
+
+use Elastica\Document;
+use Limenet\LaravelElasticaBridge\Tests\App\Elasticsearch\CustomerIndex;
+use Limenet\LaravelElasticaBridge\Tests\App\Models\Customer;
+
+class IndexTest extends TestCase
+{
+    protected  CustomerIndex $customerIndex;
+
+    public function setUp():void {
+
+        parent::setUp();
+
+        $this->customerIndex = $this->app->make(CustomerIndex::class);
+    }
+    /** @test */
+    public function index_settings()
+    {
+        $settings=$this->customerIndex->getCreateArguments();
+        if($this->customerIndex->hasMapping()){
+        $this->assertArrayHasKey('mappings',$settings);
+        }
+    }
+}

tests/IndexTest.php

@@ -0,0 +1,30 @@
+<?php
+
+namespace Limenet\LaravelElasticaBridge\Tests;
+
+use Elastica\Document;
+use Limenet\LaravelElasticaBridge\Tests\App\Elasticsearch\CustomerIndex;
+use Limenet\LaravelElasticaBridge\Tests\App\Models\Customer;
+
+class ModelTest extends TestCase
+{
+    protected  CustomerIndex $customerIndex;
+
+    public function setUp():void {
+
+        parent::setUp();
+
+        $this->customerIndex = $this->app->make(CustomerIndex::class);
+    }
+    /** @test */
+    public function convert_to_elastica_document()
+    {
+        /** @var Customer $customer */
+        $customer=Customer::first();
+        $document = $customer->toElasticaDocument($this->customerIndex);
+        $this->assertInstanceOf(Document::class, $document);
+
+        $this->assertSame($customer->name,$document->get('name'));
+        $this->assertSame($customer->email,$document->get('email'));
+    }
+}

tests/ModelTest.php

@@ -3,17 +3,21 @@
 namespace Limenet\LaravelElasticaBridge\Tests;
 
 use Illuminate\Database\Eloquent\Factories\Factory;
+use Illuminate\Foundation\Testing\RefreshDatabase;
 use Limenet\LaravelElasticaBridge\LaravelElasticaBridgeServiceProvider;
+use Limenet\LaravelElasticaBridge\Tests\Database\Seeders\DatabaseSeeder;
 use Orchestra\Testbench\TestCase as Orchestra;
+use SetupTables;
 
 class TestCase extends Orchestra
 {
+   // use RefreshDatabase;
     public function setUp(): void
     {
         parent::setUp();
 
         Factory::guessFactoryNamesUsing(
-            fn (string $modelName) => 'Spatie\\LaravelElasticaBridge\\Database\\Factories\\'.class_basename($modelName).'Factory'
+            fn (string $modelName) => 'Limenet\\LaravelElasticaBridge\\Tests\\Database\\Factories\\'.class_basename($modelName).'Factory'
         );
     }
 
@@ -27,10 +31,11 @@ protected function getPackageProviders($app)
     public function getEnvironmentSetUp($app)
     {
         config()->set('database.default', 'testing');
-
-        /*
-        include_once __DIR__.'/../database/migrations/create_laravel-elastica-bridge_table.php.stub';
-        (new \CreatePackageTable())->up();
-        */
+    }
+    protected function defineDatabaseMigrations():void
+    {
+        include_once __DIR__.'/database/migrations/SetupTables.php';
+        (new SetupTables())->up();
+        $this->artisan('db:seed', ['--class' => DatabaseSeeder::class])->run();
     }
 }

tests/TestCase.php

@@ -0,0 +1,32 @@
+<?php
+
+namespace Limenet\LaravelElasticaBridge\Tests\Database\Factories;
+
+use App\Models\User;
+use Illuminate\Database\Eloquent\Factories\Factory;
+use Illuminate\Support\Str;
+use Limenet\LaravelElasticaBridge\Tests\App\Models\Customer;
+
+class CustomerFactory extends Factory
+{
+    /**
+     * The name of the factory's corresponding model.
+     *
+     * @var string
+     */
+    protected $model = Customer::class;
+
+    /**
+     * Define the model's default state.
+     *
+     * @return array
+     */
+    public function definition()
+    {
+        return [
+            'name' => $this->faker->name(),
+            'email' => $this->faker->unique()->safeEmail(),
+            'type'=>$this->faker->randomElement(['small','medium','big'])
+        ];
+    }
+}