ElasticSearchIndexInitTest.php

<?php

namespace Tests\Jobs\CirrusSearch;

use App\Http\Curl\CurlRequest;
use App\Http\Curl\HttpRequest;
use App\Jobs\CirrusSearch\ElasticSearchIndexInit;
use App\User;
use App\Wiki;
use App\WikiDb;
use App\WikiManager;
use App\WikiSetting;
use Illuminate\Contracts\Queue\Job;
use Illuminate\Foundation\Bus\DispatchesJobs;
use Illuminate\Foundation\Testing\DatabaseTransactions;
use Tests\TestCase;

class ElasticSearchIndexInitTest extends TestCase {
    use DatabaseTransactions;
    use DispatchesJobs;

    private $wiki;

    private $wikiDb;

    private $user;

    protected function setUp(): void {
        parent::setUp();

        $this->user = User::factory()->create(['verified' => true]);
        $this->wiki = Wiki::factory()->create();
        WikiManager::factory()->create(['wiki_id' => $this->wiki->id, 'user_id' => $this->user->id]);
        WikiSetting::factory()->create(
            [
                'wiki_id' => $this->wiki->id,
                'name' => WikiSetting::wwExtEnableElasticSearch,
                'value' => true,
            ]
        );

        $this->wikiDb = WikiDb::factory()->create([
            'wiki_id' => $this->wiki->id,
        ]);
    }

    public function testDispatching() {
        $mockJob = $this->createMock(Job::class);
        $job = new ElasticSearchIndexInit($this->wiki->id);
        $job->setJob($mockJob);
        $mockJob->expects($this->once())
            ->method('fail');
        $job->handle(new CurlRequest);
    }

    public function testSuccess() {
        $mockResponse = [
            'warnings' => [],
            'wbstackElasticSearchInit' => [
                'return' => 0,
                'output' => [
                    "\tCreating index...ok", // successfully created some index
                ],
            ],
        ];
        $request = $this->createMock(HttpRequest::class);
        $request->method('execute')->willReturn(json_encode($mockResponse));

        putenv('CURLOPT_TIMEOUT_ELASTICSEARCH_INIT=1234');

        $request->expects($this->once())
            ->method('setOptions')
            ->with([
                CURLOPT_URL => getenv('PLATFORM_MW_BACKEND_HOST') . '/w/api.php?action=wbstackElasticSearchInit&format=json&cluster=all',
                CURLOPT_RETURNTRANSFER => true,
                CURLOPT_ENCODING => '',
                CURLOPT_TIMEOUT => 1234,
                CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
                CURLOPT_CUSTOMREQUEST => 'POST',
                CURLOPT_HTTPHEADER => [
                    'content-type: application/x-www-form-urlencoded',
                    'host: ' . $this->wiki->domain,
                ],
            ]);

        $mockJob = $this->createMock(Job::class);
        $mockJob->expects($this->never())
            ->method('fail')
            ->withAnyParameters();

        $job = new ElasticSearchIndexInit($this->wiki->id);
        $job->setJob($mockJob);
        $job->handle($request);

        // feature should get enabled
        $this->assertSame(
            1,
            WikiSetting::where(['wiki_id' => $this->wiki->id, 'name' => WikiSetting::wwExtEnableElasticSearch, 'value' => true])->count()
        );
    }

    public function testUpdate() {
        $mockResponse = [
            'warnings' => [],
            'wbstackElasticSearchInit' => [
                'return' => 0,
                'output' => [
                    "\t\tValidating {$this->wikiDb->name}_general alias...ok",
                ],
            ],
        ];
        $request = $this->createMock(HttpRequest::class);
        $request->method('execute')->willReturn(json_encode($mockResponse));

        $mockJob = $this->createMock(Job::class);
        $mockJob->expects($this->never())
            ->method('fail')
            ->withAnyParameters();

        $job = new ElasticSearchIndexInit($this->wiki->id);
        $job->setJob($mockJob);
        $job->handle($request);

        // feature should get enabled
        $this->assertSame(
            1,
            WikiSetting::where(['wiki_id' => $this->wiki->id, 'name' => WikiSetting::wwExtEnableElasticSearch, 'value' => true])->count()
        );
    }

    public function testJobTriggeredButNoSetting() {
        WikiSetting::where(['wiki_id' => $this->wiki->id, 'name' => WikiSetting::wwExtEnableElasticSearch])->first()->delete();
        $request = $this->createMock(HttpRequest::class);
        $request->expects($this->never())->method('execute');

        $job = new ElasticSearchIndexInit($this->wiki->id);
        $job->handle($request);
    }

    /**
     * @dataProvider failureProvider
     *
     * @expectedException RuntimeException
     */
    public function testFailure(string $expectedFailure, $mockResponse) {
        $request = $this->createMock(HttpRequest::class);
        $mockJob = $this->createMock(Job::class);
        $mockJob->expects($this->once())
            ->method('fail');

        $request->method('execute')->willReturn(json_encode($mockResponse));

        $job = new ElasticSearchIndexInit($this->wiki->id);
        $job->setJob($mockJob);
        $job->handle($request);

        $this->assertSame(
            1,
            WikiSetting::where(['wiki_id' => $this->wiki->id, 'name' => WikiSetting::wwExtEnableElasticSearch, 'value' => true])->count()
        );
    }

    public function testCurlFailure() {
        $expectedFailure = 'wbstackElasticSearchInit curl error for <WIKI_ID>: Scary Error!';
        $mockResponse = [];

        $request = $this->createMock(HttpRequest::class);
        $request->method('error')->willReturn('Scary Error!');
        $mockJob = $this->createMock(Job::class);
        $mockJob->expects($this->once())
            ->method('fail');

        $request->method('execute')->willReturn(json_encode($mockResponse));

        $job = new ElasticSearchIndexInit($this->wiki->id);
        $job->setJob($mockJob);
        $job->handle($request);

        $this->assertSame(
            1,
            WikiSetting::where(['wiki_id' => $this->wiki->id, 'name' => WikiSetting::wwExtEnableElasticSearch, 'value' => true])->count()
        );
    }

    public static function failureProvider() {

        $mockResponse = [];
        yield [
            'wbstackElasticSearchInit call for <WIKI_ID>. No wbstackElasticSearchInit key in response: []',
            $mockResponse,
        ];

        $mockResponse = [
            'warnings' => [],
            'wbstackElasticSearchInit' => [
                'return' => 0,
                'output' => [],
            ],
        ];

        yield [
            'wbstackElasticSearchInit call for <WIKI_ID> was not successful:{"warnings":[],"wbstackElasticSearchInit":{"return":0,"output":[]}}',
            $mockResponse,
        ];

        $mockResponse['wbstackElasticSearchInit']['return'] = 1;
        yield [
            'wbstackElasticSearchInit call for <WIKI_ID> was not successful:{"warnings":[],"wbstackElasticSearchInit":{"return":1,"output":[]}}',
            $mockResponse,
        ];
    }
}