silverstripe / silverstripe-staticpublishqueue

tests/php/UrlBundleServiceTest.php

<?php

namespace SilverStripe\StaticPublishQueue\Test;

use ReflectionMethod;
use SilverStripe\Core\Config\Config;
use SilverStripe\Dev\SapphireTest;
use SilverStripe\StaticPublishQueue\Job;
use SilverStripe\StaticPublishQueue\Job\DeleteStaticCacheJob;
use SilverStripe\StaticPublishQueue\Job\GenerateStaticCacheJob;
use SilverStripe\StaticPublishQueue\Service\UrlBundleService;

class UrlBundleServiceTest extends SapphireTest
{
    /**
     * @param string $jobClass
     * @dataProvider jobClasses
     */
    public function testJobsFromDataDefault(string $jobClass): void
    {
        $urls = [
            'http://some-locale/some-page/',
            'http://some-locale/some-other-page/',
        ];
        $message = 'Test message';

        $service = UrlBundleService::create();
        $service->addUrls($urls);
        $jobs = $service->getJobsForUrls($jobClass, $message);

        $this->assertCount(1, $jobs);

        /** @var Job $job */
        $job = array_shift($jobs);

It seems like $jobs can also be of type Countable and Traversable; however, parameter $array of array_shift() does only seem to accept array, maybe add an additional type check?

        $this->assertEquals([
            'http://some-locale/some-page/' => 0,
            'http://some-locale/some-other-page/' => 1,

        ], $job->URLsToProcess);

        $messages = $job->getJobData()->messages;
        $this->assertCount(1, $messages);

        $messageData = array_shift($messages);
        $this->assertContains($message, $messageData);
    }

    /**
     * @param string $jobClass
     * @dataProvider jobClasses
     */
    public function testJobsFromDataExplicitUrlsPerJob(string $jobClass): void
    {
        Config::modify()->set($jobClass, 'urls_per_job', 1);
        $urls = [
            'http://some-locale/some-page/',
            'http://some-locale/some-other-page/',
        ];

        $service = UrlBundleService::singleton();
        $service->addUrls($urls);
        $jobs = $service->getJobsForUrls($jobClass);

        $this->assertCount(2, $jobs);
    }

    /**
     * @param string $jobClass
     * @param int $urlsPerJob
     * @dataProvider urlsPerJobCases
     */
    public function testUrlsPerJob(string $jobClass, int $urlsPerJob): void
    {
        Config::modify()->set($jobClass, 'urls_per_job', $urlsPerJob);

        /** @var Job $job */
        $job = singleton($jobClass);

        $method = new ReflectionMethod(Job::class, 'getUrlsPerJob');
        $method->setAccessible(true);
        $this->assertEquals($urlsPerJob, $method->invoke($job));
    }

    /**
     * @param string $jobClass
     * @param int $chunkSize
     * @dataProvider chunkCases
     */
    public function testChunkSize(string $jobClass, int $chunkSize): void
    {
        Config::modify()->set($jobClass, 'chunk_size', $chunkSize);

        /** @var Job $job */
        $job = singleton($jobClass);

        $method = new ReflectionMethod(Job::class, 'getChunkSize');
        $method->setAccessible(true);
        $this->assertEquals($chunkSize, $method->invoke($job));
    }

    /**
     * @return array
     */
    public function jobClasses(): array
    {
        return [
            [GenerateStaticCacheJob::class],
            [DeleteStaticCacheJob::class],
        ];
    }

    /**
     * @return array
     */
    public function urlsPerJobCases(): array
    {
        return [
            [
                GenerateStaticCacheJob::class,
                8,
            ],
            [
                DeleteStaticCacheJob::class,
                9,
            ],
        ];
    }

    /**
     * @return array
     */
    public function chunkCases(): array
    {
        return [
            [
                GenerateStaticCacheJob::class,
                10,
            ],
            [
                DeleteStaticCacheJob::class,
                15,
            ],
        ];
    }
}