JobTest::testJobsFromDataMessage() - Code Metrics - Inspection of "Configuration / extensibility improvements." - silverstripe/silverstripe-staticpublishqueue - Measure and Improve Code Quality continuously with Scrutinizer

Completed

Pull Request — master (#104)

unknown

created 2020-02-24 23:34 UTC

JobTest::testJobsFromDataMessage() A

↳ Parent: JobTest

Complexity

Conditions	1
Paths	1

Size

Total Lines	21
Code Lines	12

Duplication

Lines	0
Ratio	0 %

Importance

Changes	1
Bugs	0	Features	0

Metric	Value
cc	1
eloc	12
nc	1
nop	0
dl	0
loc	21
rs	9.8666
c	1
b	0
f	0

<?php

namespace SilverStripe\StaticPublishQueue\Test;

use ReflectionException;
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 Symbiote\QueuedJobs\DataObjects\QueuedJobDescriptor;

/**
 * Class JobTest
 *
 * @package SilverStripe\StaticPublishQueue\Test
 */
class JobTest extends SapphireTest
{
    /**
     * @var bool
     */
    protected $usesDatabase = true;

    public function testJobsFromDataDefault()
    {
        $urls = [
            'http://some-locale/some-page/',
            'http://some-locale/some-other-page/',
        ];

        GenerateStaticCacheJob::singleton()->queueJobsFromData($urls);

        $jobs = QueuedJobDescriptor::get()->filter(['Implementation' => GenerateStaticCacheJob::class]);
        $this->assertCount(1, $jobs);

        /** @var QueuedJobDescriptor $jobDescriptor */
        $jobDescriptor = $jobs->first();
        $savedJobData = unserialize($jobDescriptor->SavedJobData);

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

        ], $savedJobData->URLsToProcess);
    }

    /**
     * @dataProvider jobClasses
     */
    public function testJobsFromDataJobClass($jobClass)
    {
        $urls = [
            'http://some-locale/some-page/',
            'http://some-locale/some-other-page/',
        ];

        GenerateStaticCacheJob::singleton()->queueJobsFromData($urls, '', null, $jobClass);

        $jobs = QueuedJobDescriptor::get()->filter(['Implementation' => $jobClass]);
        $this->assertCount(1, $jobs);
    }

    public function testJobsFromDataMessage()
    {
        $urls = [
            'http://some-locale/some-page/',
            'http://some-locale/some-other-page/',
        ];

        $message = 'test message';

        GenerateStaticCacheJob::singleton()->queueJobsFromData($urls, $message);

        $jobs = QueuedJobDescriptor::get()->filter(['Implementation' => GenerateStaticCacheJob::class]);
        $this->assertCount(1, $jobs);

        /** @var QueuedJobDescriptor $jobDescriptor */
        $jobDescriptor = $jobs->first();
        $savedJobMessages = unserialize($jobDescriptor->SavedJobMessages);
        $this->assertCount(1, $savedJobMessages);

        $messageData = array_shift($savedJobMessages);
        $messageData = array_shift(/** @scrutinizer ignore-type */ $savedJobMessages);
        $this->assertContains($message, $messageData);
    }

    public function testJobsFromDataExplicitUrlsPerJob()
    {
        $urls = [
            'http://some-locale/some-page/',
            'http://some-locale/some-other-page/',
        ];

        GenerateStaticCacheJob::singleton()->queueJobsFromData($urls, '', 1);

        $jobs = QueuedJobDescriptor::get()->filter(['Implementation' => GenerateStaticCacheJob::class]);
        $this->assertCount(2, $jobs);
    }

    public function testJobsFromDataImplicitUrlsPerJob()
    {
        Config::modify()->set(GenerateStaticCacheJob::class, 'urls_per_job', 1);
        $urls = [
            'http://some-locale/some-page/',
            'http://some-locale/some-other-page/',
        ];

        GenerateStaticCacheJob::singleton()->queueJobsFromData($urls);

        $jobs = QueuedJobDescriptor::get()->filter(['Implementation' => GenerateStaticCacheJob::class]);
        $this->assertCount(2, $jobs);
    }

    public function testJobsFromDataQueueCallback()
    {
        $urls = [
            'http://some-locale/some-page/',
            'http://some-locale/some-other-page/',
        ];

        $jobs = GenerateStaticCacheJob::singleton()->createJobsFromData($urls);

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

        $job = array_shift($jobs);
        $job = array_shift(/** @scrutinizer ignore-type */ $jobs);
        $this->assertInstanceOf(GenerateStaticCacheJob::class, $job);

        $this->assertCount(
            0,
            QueuedJobDescriptor::get()->filter(['Implementation' => GenerateStaticCacheJob::class])
        );
    }

    /**
     * @dataProvider urlsPerJobCases
     * @param $jobClass
     * @param $urlsPerJob
     * @throws ReflectionException
     */
    public function testUrlsPerJob($jobClass, $urlsPerJob)
    {
        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));
    }

    /**
     * @dataProvider chunkCases
     * @param $jobClass
     * @param $chunkSize
     * @throws ReflectionException
     */
    public function testChunkSize($jobClass, $chunkSize)
    {
        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()
    {
        return [
            [GenerateStaticCacheJob::class],
            [DeleteStaticCacheJob::class],
        ];
    }

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

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


silverstripe / silverstripe-staticpublishqueue

Pull Request — master (#104)

JobTest::testJobsFromDataMessage() A

Complexity

Size

Duplication

Importance

Duplication Side-by-Side

Filter issues like