blessing-skin-server/tests/UpdateControllerTest.php

<?php

namespace Tests;

use Cache;
use Exception;
use ZipArchive;
use Carbon\Carbon;
use GuzzleHttp\Psr7\Request;
use GuzzleHttp\Psr7\Response;
use Illuminate\Support\Facades\File;
use Tests\Concerns\MocksGuzzleClient;
use Illuminate\Support\Facades\Storage;
use GuzzleHttp\Exception\RequestException;
use Illuminate\Foundation\Testing\DatabaseTransactions;

class UpdateControllerTest extends TestCase
{
    use DatabaseTransactions;
    use MocksGuzzleClient;

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

        $this->actAs('superAdmin');
    }

    public function testShowUpdatePage()
    {
        $this->setupGuzzleClientMock();

        // Can't connect to update source
        $this->appendToGuzzleQueue([
            new RequestException('Connection Error', new Request('GET', 'whatever')),
            new RequestException('Connection Error', new Request('GET', 'whatever')),
        ]);
        $this->get('/admin/update')->assertSee(config('app.version'));

        // New version available
        $time = time();
        $this->appendToGuzzleQueue(200, [], $this->generateFakeUpdateInfo('8.9.3', false, $time));
        $this->get('/admin/update')
            ->assertSee(config('app.version'))
            ->assertSee('8.9.3')
            ->assertSee('test')
            ->assertSee(Carbon::createFromTimestamp($time)->toDateTimeString());

        // Now using pre-release version
        $this->appendToGuzzleQueue(200, [], $this->generateFakeUpdateInfo('0.0.1', false, $time));
        $this->get('/admin/update');
    }

    public function testCheckUpdates()
    {
        $this->setupGuzzleClientMock();

        // Update source is unavailable
        $this->appendToGuzzleQueue([
            new RequestException('Connection Error', new Request('GET', 'whatever')),
            new RequestException('Connection Error', new Request('GET', 'whatever')),
        ]);
        $this->getJson('/admin/update/check')
            ->assertJson([
                'latest' => null,
                'available' => false,
            ]);

        // New version available
        $this->appendToGuzzleQueue(200, [], $this->generateFakeUpdateInfo('8.9.3', false, time()));
        $this->getJson('/admin/update/check')
            ->assertJson([
                'latest' => '8.9.3',
                'available' => true,
            ]);
    }

    public function testDownload()
    {
        $this->setupGuzzleClientMock();

        // Already up-to-date
        $this->getJson('/admin/update/download')
            ->assertDontSee(trans('general.illegal-parameters'));

        // Lack write permission
        $this->appendToGuzzleQueue(200, [], $this->generateFakeUpdateInfo('8.9.3'));
        File::deleteDirectory(storage_path('update_cache'));
        Storage::shouldReceive('disk')
            ->with('root')
            ->once()
            ->andReturnSelf();
        Storage::shouldReceive('makeDirectory')
            ->with('storage/update_cache')
            ->once()
            ->andReturn(false);
        $this->withNewVersionAvailable()
            ->getJson('/admin/update/download?action=prepare-download')
            ->assertJson([
                'errno' => 1,
                'msg' => trans('admin.update.errors.write-permission'),
            ]);

        // Prepare for downloading
        mkdir(storage_path('update_cache'));
        $this->appendToGuzzleQueue([
            new Response(200, [], $this->generateFakeUpdateInfo('8.9.3')),
            new Response(200, [], $this->generateFakeUpdateInfo('8.9.3')),
        ]);
        $this->withNewVersionAvailable()
            ->getJson('/admin/update/download?action=prepare-download')
            ->assertJsonStructure(['release_url', 'tmp_path']);
        $this->assertTrue(Cache::has('tmp_path'));
        $this->assertFalse(Cache::has('download-progress'));

        // Start downloading
        Cache::flush();
        $this->withNewVersionAvailable()
            ->getJson('/admin/update/download?action=start-download')
            ->assertJson([
                'errno' => 1,
                'msg' => 'No temp path available, please try again.',
            ]);

        // Can't download update package
        $this->appendToGuzzleQueue([
            new Response(200, [], $this->generateFakeUpdateInfo('8.9.3')),
            new RequestException('Connection Error', new Request('GET', 'whatever')),
        ]);
        Cache::put('tmp_path', storage_path('update_cache/update.zip'));
        $this->getJson('/admin/update/download?action=start-download');

        // Download update package
        $fakeUpdatePackage = $this->generateFakeUpdateFile();
        $this->appendToGuzzleQueue([
            new Response(200, [], $this->generateFakeUpdateInfo('8.9.3')),
            new Response(200, [], fopen($fakeUpdatePackage, 'r')),
        ]);
        Cache::put('tmp_path', storage_path('update_cache/update.zip'));
        $this->getJson('/admin/update/download?action=start-download')
            ->assertJson([
                'tmp_path' => storage_path('update_cache/update.zip'),
            ]);
        $this->assertFileExists(storage_path('update_cache/update.zip'));

        // No download progress available
        Cache::flush();
        $this->withNewVersionAvailable()
            ->getJson('/admin/update/download?action=get-progress')
            ->assertJson([]);

        // Get download progress
        Cache::put('download-progress', ['total' => 514, 'downloaded' => 114]);
        $this->withNewVersionAvailable()
            ->getJson('/admin/update/download?action=get-progress')
            ->assertJson([
                'total' => 514,
                'downloaded' => 114,
            ]);

        // No such zip archive
        Cache::put('tmp_path', storage_path('update_cache/nope.zip'));
        $this->withNewVersionAvailable()
            ->getJson('/admin/update/download?action=extract')
            ->assertJson([
                'errno' => 1,
                'msg' => 'No file available',
            ]);

        // Can't extract zip archive
        file_put_contents(storage_path('update_cache/update.zip'), 'text');
        Cache::put('tmp_path', storage_path('update_cache/update.zip'));
        $this->withNewVersionAvailable()
            ->getJson('/admin/update/download?action=extract')
            ->assertJson([
                'errno' => 1,
                'msg' => trans('admin.update.errors.unzip').'19',
            ]);

        // Extract
        copy(storage_path('testing/update.zip'), storage_path('update_cache/update.zip'));
        $this->withNewVersionAvailable()
            ->getJson('/admin/update/download?action=extract')
            ->assertJson([
                'errno' => 0,
                'msg' => trans('admin.update.complete'),
            ]);

        // Can't overwrite vendor directory, skip
        mkdir(storage_path('update_cache'));
        copy(storage_path('testing/update.zip'), storage_path('update_cache/update.zip'));
        File::shouldReceive('copyDirectory')
            ->with(storage_path('update_cache/8.9.3/vendor'), base_path('vendor'))
            ->andThrow(new Exception);
        File::shouldReceive('deleteDirectory')
            ->with(storage_path('update_cache/8.9.3/vendor'));
        $this->withNewVersionAvailable()
            ->getJson('/admin/update/download?action=extract');

        // Can't apply update package
        File::shouldReceive('copyDirectory')
            ->with(storage_path('update_cache/8.9.3'), base_path())
            ->andThrow(new Exception);
        File::shouldReceive('deleteDirectory')
            ->with(storage_path('update_cache'));
        File::shouldReceive('deleteDirectory')
            ->with(storage_path('update_cache'));
        $this->withNewVersionAvailable()
            ->getJson('/admin/update/download?action=extract')
            ->assertJson([
                'errno' => 1,
                'msg' => trans('admin.update.errors.overwrite'),
            ]);

        // Invalid action
        $this->withNewVersionAvailable()
            ->getJson('/admin/update/download?action=no')
            ->assertJson([
                'errno' => 1,
                'msg' => trans('general.illegal-parameters'),
            ]);
    }

    protected function withNewVersionAvailable()
    {
        $this->appendToGuzzleQueue(200, [], $this->generateFakeUpdateInfo('8.9.3'));

        return $this;
    }

    protected function generateFakeUpdateInfo($version, $preview = false, $time = null)
    {
        $time = $time ?: time();

        return json_encode([
            'app_name' => 'blessing-skin-server',
            'latest_version' => $version,
            'update_time' => $time,
            'releases' => [
                $version => [
                    'version' => $version,
                    'pre_release' => $preview,
                    'release_time' => $time,
                    'release_note' => 'test',
                    'release_url' => "https://whatever.test/$version/update.zip",
                ],
            ],
        ]);
    }

    protected function generateFakeUpdateFile()
    {
        $zipPath = storage_path('testing/update.zip');

        if (file_exists($zipPath)) {
            unlink($zipPath);
        }

        $zip = new ZipArchive();
        $zip->open($zipPath, ZipArchive::CREATE);
        $zip->addEmptyDir('coverage');
        $zip->close();

        return $zipPath;
    }
}