TaskTest::frequencyProvider() - Code Metrics - zenstruck/schedule-bundle - Measure and Improve Code Quality continuously with Scrutinizer

TaskTest::frequencyProvider() A
last analyzed 2022-02-21 22:53 UTC

↳ Parent: TaskTest

Complexity

Conditions	1
Paths	1

Size

Total Lines	59
Code Lines	54

Duplication

Lines	0
Ratio	0 %

Importance

Changes	5
Bugs	0	Features	1

Metric	Value
c	5
b	0
f	1
dl	0
loc	59
rs	9.0036
eloc	54
cc	1
nc	1
nop	0

How to fix Long Method

<?php

namespace Zenstruck\ScheduleBundle\Tests\Schedule;

use PHPUnit\Framework\TestCase;
filter:
    dependency_paths: ["lib/*"]
use Symfony\Component\Mime\Email;
use Zenstruck\ScheduleBundle\Schedule\Extension\SingleServerExtension;
use Zenstruck\ScheduleBundle\Schedule\Task;
use Zenstruck\ScheduleBundle\Tests\Fixture\MockTask;

/**
 * @author Kevin Bond <[email protected]>
 */
final class TaskTest extends TestCase
{
    /**
     * @test
     */
    public function can_set_description()
    {
        $task = self::task()->description('my description');

        $this->assertSame('my description', $task->getDescription());
    }

    /**
     * @test
     */
    public function can_cast_to_string()
    {
        $task = new MockTask('my description');

        $this->assertSame('MockTask: my description', (string) $task);
    }

    /**
     * @test
     */
    public function can_set_timezone()
    {
        $task = self::task();

        $this->assertNull($task->getTimezone());

        $task->timezone('UTC');

        $this->assertSame('UTC', $task->getTimezone()->getName());

        $task->timezone(new \DateTimeZone('America/Los_Angeles'));

        $this->assertSame('America/Los_Angeles', $task->getTimezone()->getName());
    }

    /**
     * @test
     */
    public function can_get_next_run()
    {
        $this->assertSame(
            (new \DateTime('1st Jan next year'))->getTimestamp(),
            self::task()->yearly()->getNextRun()->getTimestamp()
        );
    }

    /**
     * @test
     */
    public function can_determine_if_due()
    {
        $this->assertTrue(self::task()->everyMinute()->isDue(new \DateTime()));
    }

    /**
     * @test
     * @dataProvider frequencyProvider
     */
    public function can_fluently_create_frequency(callable $createTask, string $expectedExpression)
    {
        $task = $createTask();

        $this->assertSame($expectedExpression, (string) $task->getExpression());
        $this->assertInstanceOf(\DateTimeInterface::class, $task->getNextRun());
    }

    public static function frequencyProvider(): array
    {
        return [
            [function() { return self::task(); }, '* * * * *'],
            [function() { return self::task()->minutes(37)->cron('0 0,12 1 */2 *'); }, '0 0,12 1 */2 *'],
            [function() { return self::task()->weekly()->everyMinute(); }, '* * * * *'],
            [function() { return self::task()->weekly()->everyFiveMinutes(); }, '*/5 * * * *'],
            [function() { return self::task()->weekly()->everyTenMinutes(); }, '*/10 * * * *'],
            [function() { return self::task()->weekly()->everyFifteenMinutes(); }, '*/15 * * * *'],
            [function() { return self::task()->weekly()->everyTwentyMinutes(); }, '*/20 * * * *'],
            [function() { return self::task()->weekly()->everyThirtyMinutes(); }, '0,30 * * * *'],
            [function() { return self::task()->minutes(37)->hourly(); }, '0 * * * *'],
            [function() { return self::task()->minutes(37)->hourlyAt(2); }, '2 * * * *'],
            [function() { return self::task()->minutes(37)->hourlyAt(2, 3, '4-5'); }, '2,3,4-5 * * * *'],
            [function() { return self::task()->minutes(37)->daily(); }, '0 0 * * *'],
            [function() { return self::task()->minutes(37)->dailyOn(2, 3, '4-5'); }, '0 2,3,4-5 * * *'],
            [function() { return self::task()->minutes(37)->dailyBetween(9, 17); }, '0 9-17 * * *'],
            [function() { return self::task()->minutes(37)->twiceDaily(); }, '0 1,13 * * *'],
            [function() { return self::task()->minutes(37)->twiceDaily(2, 14); }, '0 2,14 * * *'],
            [function() { return self::task()->minutes(37)->dailyAt(2); }, '0 2 * * *'],
            [function() { return self::task()->minutes(37)->dailyAt('1:34'); }, '34 1 * * *'],
            [function() { return self::task()->minutes(37)->weekly(); }, '0 0 * * 0'],
            [function() { return self::task()->minutes(37)->weeklyOn(2, 3, '4-5'); }, '0 0 * * 2,3,4-5'],
            [function() { return self::task()->minutes(37)->monthly(); }, '0 0 1 * *'],
            [function() { return self::task()->minutes(37)->monthlyOn(2, 3, '4-5'); }, '0 0 2,3,4-5 * *'],
            [function() { return self::task()->minutes(37)->twiceMonthly(); }, '0 0 1,16 * *'],
            [function() { return self::task()->minutes(37)->twiceMonthly(3, 17); }, '0 0 3,17 * *'],
            [function() { return self::task()->minutes(37)->quarterly(); }, '0 0 1 */3 *'],
            [function() { return self::task()->minutes(37)->yearly(); }, '0 0 1 1 *'],
            [function() { return self::task()->weekly()->minutes(2, 3, '4-5'); }, '2,3,4-5 0 * * 0'],
            [function() { return self::task()->weekly()->hours(2, 3, '4-5'); }, '0 2,3,4-5 * * 0'],
            [function() { return self::task()->weekly()->daysOfMonth(2, 3, '4-5'); }, '0 0 2,3,4-5 * 0'],
            [function() { return self::task()->weekly()->months(2, 3, '4-5'); }, '0 0 * 2,3,4-5 0'],
            [function() { return self::task()->monthly()->daysOfWeek(2, 3, '4-5'); }, '0 0 1 * 2,3,4-5'],
            [function() { return self::task()->minutes(37)->weekdays(); }, '37 * * * 1-5'],
            [function() { return self::task()->minutes(37)->weekends(); }, '37 * * * 0,6'],
            [function() { return self::task()->minutes(37)->mondays(); }, '37 * * * 1'],
            [function() { return self::task()->minutes(37)->tuesdays(); }, '37 * * * 2'],
            [function() { return self::task()->minutes(37)->wednesdays(); }, '37 * * * 3'],
            [function() { return self::task()->minutes(37)->thursdays(); }, '37 * * * 4'],
            [function() { return self::task()->minutes(37)->fridays(); }, '37 * * * 5'],
            [function() { return self::task()->minutes(37)->saturdays(); }, '37 * * * 6'],
            [function() { return self::task()->minutes(37)->sundays(); }, '37 * * * 0'],
            [function() { return self::task()->weekly()->at(1); }, '0 1 * * 0'],
            [function() { return self::task()->weekly()->at('2:45'); }, '45 2 * * 0'],

            [function() { return self::task()->cron('invalid...')->mondays(); }, '* * * * 1'],

            [function() { return self::task()->cron('@hourly'); }, '@hourly'],
            [function() { return self::task()->cron('@daily'); }, '@daily'],
            [function() { return self::task()->cron('@weekly'); }, '@weekly'],
            [function() { return self::task()->cron('@monthly'); }, '@monthly'],
            [function() { return self::task()->cron('@yearly'); }, '@yearly'],
            [function() { return self::task()->cron('@annually'); }, '@annually'],

            [function() { return self::task('my task')->cron('# 0 * * *'); }, '56 0 * * *'],
            [function() { return self::task('my task')->cron('#daily'); }, '56 20 * * *'],
            [function() { return self::task('my task')->cron('#midnight'); }, '56 2 * * *'],
            [function() { return self::task('my task')->cron('#midnight')->daily(); }, '0 0 * * *'],
        ];
    }

    /**
     * @test
     */
    public function has_unique_id_based_on_description_and_frequency()
    {
        $this->assertSame(self::task()->getId(), self::task()->getId());
        $this->assertNotSame(self::task()->daily()->getId(), self::task()->getId());
        $this->assertNotSame(self::task('task1')->getId(), self::task('task2')->getId());
        $this->assertNotSame((new class('task') extends Task {
        })->getId(), self::task('task')->getId());
    }

    /**
     * @test
     * @dataProvider emailAfterMethodProvider
     */
    public function can_add_email_after_extension($method)
    {
        $task = self::task();
        $task->{$method}('[email protected]', 'my subject', function(Email $email) {
            $email->cc('[email protected]');
        });

        $this->assertTrue($task->getExtensions()[0]->isHook(Task::AFTER));
        $this->assertSame('[email protected]', $task->getExtensions()[0]->getEmail()->getTo()[0]->toString());
        $this->assertSame('[email protected]', $task->getExtensions()[0]->getEmail()->getCc()[0]->toString());
        $this->assertSame('my subject', $task->getExtensions()[0]->getEmail()->getSubject());
    }

    public static function emailAfterMethodProvider()
    {
        return [
            ['emailAfter'],
            ['thenEmail'],
        ];
    }

    /**
     * @test
     */
    public function can_add_email_on_failure_extension()
    {
        $task = self::task();
        $task->emailOnFailure('[email protected]', 'my subject', function(Email $email) {
            $email->cc('[email protected]');
        });

        $this->assertTrue($task->getExtensions()[0]->isHook(Task::FAILURE));
        $this->assertSame('[email protected]', $task->getExtensions()[0]->getEmail()->getTo()[0]->toString());
        $this->assertSame('[email protected]', $task->getExtensions()[0]->getEmail()->getCc()[0]->toString());
        $this->assertSame('my subject', $task->getExtensions()[0]->getEmail()->getSubject());
    }

    /**
     * @test
     */
    public function can_add_single_server_extension()
    {
        $task = self::task()->onSingleServer();

        $this->assertInstanceOf(SingleServerExtension::class, $task->getExtensions()[0]);
    }

    private static function task(string $description = 'task description'): Task
    {
        return new MockTask($description);
    }
}


1			<?php
2
3			namespace Zenstruck\ScheduleBundle\Tests\Schedule;
4
5			use PHPUnit\Framework\TestCase;
			0 ignored issues – show Bug introduced 2020-01-10 15:33 UTC by Report Bug Copy Issue Report The type `PHPUnit\Framework\TestCase` was not found. Maybe you did not declare it correctly or list all dependencies? The issue could also be caused by a filter entry in the build configuration. If the path has been excluded in your configuration, e.g. `excluded_paths: ["lib/"]`, you can move it to the dependency path list as follows: filter: dependency_paths: ["lib/"] For further information see https://scrutinizer-ci.com/docs/tools/php/php-scrutinizer/#list-dependency-paths Loading history...
6			use Symfony\Component\Mime\Email;
7			use Zenstruck\ScheduleBundle\Schedule\Extension\SingleServerExtension;
8			use Zenstruck\ScheduleBundle\Schedule\Task;
9			use Zenstruck\ScheduleBundle\Tests\Fixture\MockTask;
10
11			/**
12			* @author Kevin Bond <[email protected]>
13			*/
14			final class TaskTest extends TestCase
15			{
16			/**
17			* @test
18			*/
19			public function can_set_description()
20			{
21			$task = self::task()->description('my description');
22
23			$this->assertSame('my description', $task->getDescription());
24			}
25
26			/**
27			* @test
28			*/
29			public function can_cast_to_string()
30			{
31			$task = new MockTask('my description');
32
33			$this->assertSame('MockTask: my description', (string) $task);
34			}
35
36			/**
37			* @test
38			*/
39			public function can_set_timezone()
40			{
41			$task = self::task();
42
43			$this->assertNull($task->getTimezone());
44
45			$task->timezone('UTC');
46
47			$this->assertSame('UTC', $task->getTimezone()->getName());
48
49			$task->timezone(new \DateTimeZone('America/Los_Angeles'));
50
51			$this->assertSame('America/Los_Angeles', $task->getTimezone()->getName());
52			}
53
54			/**
55			* @test
56			*/
57			public function can_get_next_run()
58			{
59			$this->assertSame(
60			(new \DateTime('1st Jan next year'))->getTimestamp(),
61			self::task()->yearly()->getNextRun()->getTimestamp()
62			);
63			}
64
65			/**
66			* @test
67			*/
68			public function can_determine_if_due()
69			{
70			$this->assertTrue(self::task()->everyMinute()->isDue(new \DateTime()));
71			}
72
73			/**
74			* @test
75			* @dataProvider frequencyProvider
76			*/
77			public function can_fluently_create_frequency(callable $createTask, string $expectedExpression)
78			{
79			$task = $createTask();
80
81			$this->assertSame($expectedExpression, (string) $task->getExpression());
82			$this->assertInstanceOf(\DateTimeInterface::class, $task->getNextRun());
83			}
84
85			public static function frequencyProvider(): array
86			{
87			return [
88			[function() { return self::task(); }, '* * * * *'],
89			[function() { return self::task()->minutes(37)->cron('0 0,12 1 /2 '); }, '0 0,12 1 /2 '],
90			[function() { return self::task()->weekly()->everyMinute(); }, '* * * * *'],
91			[function() { return self::task()->weekly()->everyFiveMinutes(); }, '/5 * * *'],
92			[function() { return self::task()->weekly()->everyTenMinutes(); }, '/10 * * *'],
93			[function() { return self::task()->weekly()->everyFifteenMinutes(); }, '/15 * * *'],
94			[function() { return self::task()->weekly()->everyTwentyMinutes(); }, '/20 * * *'],
95			[function() { return self::task()->weekly()->everyThirtyMinutes(); }, '0,30 * * * *'],
96			[function() { return self::task()->minutes(37)->hourly(); }, '0 * * * *'],
97			[function() { return self::task()->minutes(37)->hourlyAt(2); }, '2 * * * *'],
98			[function() { return self::task()->minutes(37)->hourlyAt(2, 3, '4-5'); }, '2,3,4-5 * * * *'],
99			[function() { return self::task()->minutes(37)->daily(); }, '0 0 * * *'],
100			[function() { return self::task()->minutes(37)->dailyOn(2, 3, '4-5'); }, '0 2,3,4-5 * * *'],
101			[function() { return self::task()->minutes(37)->dailyBetween(9, 17); }, '0 9-17 * * *'],
102			[function() { return self::task()->minutes(37)->twiceDaily(); }, '0 1,13 * * *'],
103			[function() { return self::task()->minutes(37)->twiceDaily(2, 14); }, '0 2,14 * * *'],
104			[function() { return self::task()->minutes(37)->dailyAt(2); }, '0 2 * * *'],
105			[function() { return self::task()->minutes(37)->dailyAt('1:34'); }, '34 1 * * *'],
106			[function() { return self::task()->minutes(37)->weekly(); }, '0 0 * * 0'],
107			[function() { return self::task()->minutes(37)->weeklyOn(2, 3, '4-5'); }, '0 0 * * 2,3,4-5'],
108			[function() { return self::task()->minutes(37)->monthly(); }, '0 0 1 * *'],
109			[function() { return self::task()->minutes(37)->monthlyOn(2, 3, '4-5'); }, '0 0 2,3,4-5 * *'],
110			[function() { return self::task()->minutes(37)->twiceMonthly(); }, '0 0 1,16 * *'],
111			[function() { return self::task()->minutes(37)->twiceMonthly(3, 17); }, '0 0 3,17 * *'],
112			[function() { return self::task()->minutes(37)->quarterly(); }, '0 0 1 /3 '],
113			[function() { return self::task()->minutes(37)->yearly(); }, '0 0 1 1 *'],
114			[function() { return self::task()->weekly()->minutes(2, 3, '4-5'); }, '2,3,4-5 0 * * 0'],
115			[function() { return self::task()->weekly()->hours(2, 3, '4-5'); }, '0 2,3,4-5 * * 0'],
116			[function() { return self::task()->weekly()->daysOfMonth(2, 3, '4-5'); }, '0 0 2,3,4-5 * 0'],
117			[function() { return self::task()->weekly()->months(2, 3, '4-5'); }, '0 0 * 2,3,4-5 0'],
118			[function() { return self::task()->monthly()->daysOfWeek(2, 3, '4-5'); }, '0 0 1 * 2,3,4-5'],
119			[function() { return self::task()->minutes(37)->weekdays(); }, '37 * * * 1-5'],
120			[function() { return self::task()->minutes(37)->weekends(); }, '37 * * * 0,6'],
121			[function() { return self::task()->minutes(37)->mondays(); }, '37 * * * 1'],
122			[function() { return self::task()->minutes(37)->tuesdays(); }, '37 * * * 2'],
123			[function() { return self::task()->minutes(37)->wednesdays(); }, '37 * * * 3'],
124			[function() { return self::task()->minutes(37)->thursdays(); }, '37 * * * 4'],
125			[function() { return self::task()->minutes(37)->fridays(); }, '37 * * * 5'],
126			[function() { return self::task()->minutes(37)->saturdays(); }, '37 * * * 6'],
127			[function() { return self::task()->minutes(37)->sundays(); }, '37 * * * 0'],
128			[function() { return self::task()->weekly()->at(1); }, '0 1 * * 0'],
129			[function() { return self::task()->weekly()->at('2:45'); }, '45 2 * * 0'],
130
131			[function() { return self::task()->cron('invalid...')->mondays(); }, '* * * * 1'],
132
133			[function() { return self::task()->cron('@hourly'); }, '@hourly'],
134			[function() { return self::task()->cron('@daily'); }, '@daily'],
135			[function() { return self::task()->cron('@weekly'); }, '@weekly'],
136			[function() { return self::task()->cron('@monthly'); }, '@monthly'],
137			[function() { return self::task()->cron('@yearly'); }, '@yearly'],
138			[function() { return self::task()->cron('@annually'); }, '@annually'],
139
140			[function() { return self::task('my task')->cron('# 0 * * '); }, '56 0 * *'],
141			[function() { return self::task('my task')->cron('#daily'); }, '56 20 * * *'],
142			[function() { return self::task('my task')->cron('#midnight'); }, '56 2 * * *'],
143			[function() { return self::task('my task')->cron('#midnight')->daily(); }, '0 0 * * *'],
144			];
145			}
146
147			/**
148			* @test
149			*/
150			public function has_unique_id_based_on_description_and_frequency()
151			{
152			$this->assertSame(self::task()->getId(), self::task()->getId());
153			$this->assertNotSame(self::task()->daily()->getId(), self::task()->getId());
154			$this->assertNotSame(self::task('task1')->getId(), self::task('task2')->getId());
155			$this->assertNotSame((new class('task') extends Task {
156			})->getId(), self::task('task')->getId());
157			}
158
159			/**
160			* @test
161			* @dataProvider emailAfterMethodProvider
162			*/
163			public function can_add_email_after_extension($method)
164			{
165			$task = self::task();
166			$task->{$method}('[email protected]', 'my subject', function(Email $email) {
167			$email->cc('[email protected]');
168			});
169
170			$this->assertTrue($task->getExtensions()[0]->isHook(Task::AFTER));
171			$this->assertSame('[email protected]', $task->getExtensions()[0]->getEmail()->getTo()[0]->toString());
172			$this->assertSame('[email protected]', $task->getExtensions()[0]->getEmail()->getCc()[0]->toString());
173			$this->assertSame('my subject', $task->getExtensions()[0]->getEmail()->getSubject());
174			}
175
176			public static function emailAfterMethodProvider()
177			{
178			return [
179			['emailAfter'],
180			['thenEmail'],
181			];
182			}
183
184			/**
185			* @test
186			*/
187			public function can_add_email_on_failure_extension()
188			{
189			$task = self::task();
190			$task->emailOnFailure('[email protected]', 'my subject', function(Email $email) {
191			$email->cc('[email protected]');
192			});
193
194			$this->assertTrue($task->getExtensions()[0]->isHook(Task::FAILURE));
195			$this->assertSame('[email protected]', $task->getExtensions()[0]->getEmail()->getTo()[0]->toString());
196			$this->assertSame('[email protected]', $task->getExtensions()[0]->getEmail()->getCc()[0]->toString());
197			$this->assertSame('my subject', $task->getExtensions()[0]->getEmail()->getSubject());
198			}
199
200			/**
201			* @test
202			*/
203			public function can_add_single_server_extension()
204			{
205			$task = self::task()->onSingleServer();
206
207			$this->assertInstanceOf(SingleServerExtension::class, $task->getExtensions()[0]);
208			}
209
210			private static function task(string $description = 'task description'): Task
211			{
212			return new MockTask($description);
213			}
214			}
215

zenstruck / schedule-bundle

TaskTest::frequencyProvider() A last analyzed 2022-02-21 22:53 UTC

Complexity

Size

Duplication

Importance

How to fix Long Method

Long Method

Duplication Side-by-Side

Filter issues like

TaskTest::frequencyProvider() A
last analyzed 2022-02-21 22:53 UTC