Zenstruck\ScheduleBundle\Tests\Command\ScheduleListCommandTest

Complexity

Total Complexity

2

Size/Duplication

Total Lines	128
Duplicated Lines	0 %

Importance

Changes	1
Bugs	0	Features	1

10 Methods

Rating	Name	Duplication	Size	Complexity
A	hp$2 ➔ buildSchedule()	0	9	1
	lists_configured_tasks_and_issues()	0	32	?
	renders_exception_stack_trace_if_verbose()	0	26	?
A	hp$0 ➔ lists_configured_tasks_and_issues()	0	32	1
A	hp$1 ➔ buildSchedule()	0	5	1
A	hp$1 ➔ renders_exception_stack_trace_if_verbose()	0	26	1
A	hp$0 ➔ buildSchedule()	0	8	1
A	hp$2 ➔ lists_configured_tasks_and_issues_in_detail()	0	41	1
A	no_tasks_defined()	0	9	1
	lists_configured_tasks_and_issues_in_detail()	0	41	?

<?php

namespace Zenstruck\ScheduleBundle\Tests\Command;

use PHPUnit\Framework\TestCase;

The type PHPUnit\Framework\TestCase was not found. Maybe you did not declare it correctly or list all dependencies?

use Symfony\Component\Console\Application;
use Symfony\Component\Console\Helper\FormatterHelper;
use Symfony\Component\Console\Helper\HelperSet;
use Symfony\Component\Console\Output\OutputInterface;
use Symfony\Component\Console\Tester\CommandTester;
use Zenstruck\ScheduleBundle\Command\ScheduleListCommand;
use Zenstruck\ScheduleBundle\Schedule;
use Zenstruck\ScheduleBundle\Schedule\Extension\ExtensionHandlerRegistry;
use Zenstruck\ScheduleBundle\Schedule\ScheduleBuilder;
use Zenstruck\ScheduleBundle\Tests\Fixture\MockScheduleBuilder;

/**
 * @author Kevin Bond <kevinbond@gmail.com>
 */
final class ScheduleListCommandTest extends TestCase
{
    /**
     * @test
     */
    public function no_tasks_defined()
    {
        $runner = (new MockScheduleBuilder())->getRunner();
        $commandTester = new CommandTester(new ScheduleListCommand($runner, new ExtensionHandlerRegistry([])));

        $this->expectException(\RuntimeException::class);
        $this->expectExceptionMessage('No scheduled tasks configured.');

        $commandTester->execute([]);
    }

    /**
     * @test
     */
    public function lists_configured_tasks_and_issues()
    {
        $runner = (new MockScheduleBuilder())
            ->addBuilder(new class() implements ScheduleBuilder {
                public function buildSchedule(Schedule $schedule): void
                {
                    $schedule->emailOnFailure('admin@example.com');
                    $schedule->addCommand('my:command')
                        ->mondays()
                        ->at('1:30')
                        ->emailOnFailure('admin@example.com')
                        ->pingOnFailure('https://example.com/my-command-failed')
                    ;
                }
            })
            ->getRunner()
        ;
        $command = new ScheduleListCommand($runner, new ExtensionHandlerRegistry([]));
        $command->setHelperSet(new HelperSet([new FormatterHelper()]));
        $commandTester = new CommandTester($command);

        $commandTester->execute([]);

        $this->assertStringContainsString('[!] CommandTask   my:command   2            Every Monday at 1:30am (30 1 * * 1)', $commandTester->getDisplay());
        $this->assertStringContainsString('[WARNING] 3 task issues:', $commandTester->getDisplay());
        $this->assertStringContainsString('[ERROR] No task runner registered to handle "Zenstruck\ScheduleBundle\Schedule\Task\CommandTask".', $commandTester->getDisplay());
        $this->assertStringContainsString('[ERROR] To use the email extension you must configure a mailer (config path: "zenstruck_schedule.email_handler").', $commandTester->getDisplay());
        $this->assertStringContainsString('[ERROR] No extension handler registered for "Zenstruck\ScheduleBundle\Schedule\Extension\PingExtension: On Task', $commandTester->getDisplay());
        $this->assertStringContainsString('Failure, ping "https://example.com/my-command-failed"".', $commandTester->getDisplay());
        $this->assertStringContainsString('1 Schedule Extension:', $commandTester->getDisplay());
        $this->assertStringContainsString('On Schedule Failure, email output to "admin@example.com"', $commandTester->getDisplay());
        $this->assertStringContainsString('[WARNING] 1 issue with schedule:', $commandTester->getDisplay());
    }

    /**
     * @test
     */
    public function renders_exception_stack_trace_if_verbose()
    {
        $runner = (new MockScheduleBuilder())
            ->addBuilder(new class() implements ScheduleBuilder {
                public function buildSchedule(Schedule $schedule): void
                {
                    $schedule->addCommand('my:command')
                        ->mondays()
                        ->at('1:30')
                    ;
                }
            })
            ->getRunner()
        ;
        $command = new ScheduleListCommand($runner, new ExtensionHandlerRegistry([]));
        $command->setHelperSet(new HelperSet([new FormatterHelper()]));
        $command->setApplication(new Application());
        $commandTester = new CommandTester($command);

        $commandTester->execute([], ['verbosity' => OutputInterface::VERBOSITY_VERBOSE]);

        $this->assertStringContainsString('[WARNING] 1 task issue:', $commandTester->getDisplay());
        $this->assertStringContainsString('In ScheduleRunner.php line', $commandTester->getDisplay());
        $this->assertStringContainsString('[LogicException]', $commandTester->getDisplay());
        $this->assertStringContainsString('No task runner registered to handle "Zenstruck\ScheduleBundle\Schedule\Task\CommandTask".', $commandTester->getDisplay());
        $this->assertStringContainsString('Exception trace:', $commandTester->getDisplay());
    }

    /**
     * @test
     */
    public function lists_configured_tasks_and_issues_in_detail()
    {
        $runner = (new MockScheduleBuilder())
            ->addBuilder(new class() implements ScheduleBuilder {
                public function buildSchedule(Schedule $schedule): void
                {
                    $schedule->emailOnFailure('admin@example.com');
                    $schedule->addCommand('my:command')
                        ->arguments('arg1', '--option1')
                        ->mondays()
                        ->at('1:30')
                        ->emailOnFailure('admin@example.com')
                        ->pingOnFailure('https://example.com/my-command-failed')
                    ;
                }
            })
            ->getRunner()
        ;
        $command = new ScheduleListCommand($runner, new ExtensionHandlerRegistry([]));
        $command->setHelperSet(new HelperSet([new FormatterHelper()]));
        $command->setApplication(new Application());
        $commandTester = new CommandTester($command);

        $commandTester->execute(['--detail' => null]);

        $this->assertStringContainsString('1 Scheduled Tasks Configured', $commandTester->getDisplay());
        $this->assertStringContainsString('(1/1) CommandTask: my:command', $commandTester->getDisplay());
        $this->assertStringContainsString('Frequency   Every Monday at 1:30am (30 1 * * 1)', $commandTester->getDisplay());
        $this->assertStringContainsString('Next Run    Mon,', $commandTester->getDisplay());
        $this->assertStringContainsString('Arguments: arg1 --option1', $commandTester->getDisplay());
        $this->assertStringContainsString('2 Task Extensions:', $commandTester->getDisplay());
        $this->assertStringContainsString('On Task Failure, email output to "admin@example.com"', $commandTester->getDisplay());
        $this->assertStringContainsString('On Task Failure, ping "https://example.com/my-command-failed"', $commandTester->getDisplay());
        $this->assertStringContainsString('[WARNING] 3 issues with this task:', $commandTester->getDisplay());
        $this->assertStringContainsString('[ERROR] No task runner registered to handle "Zenstruck\ScheduleBundle\Schedule\Task\CommandTask".', $commandTester->getDisplay());
        $this->assertStringContainsString('[ERROR] To use the email extension you must configure a mailer (config path: "zenstruck_schedule.email_handler").', $commandTester->getDisplay());
        $this->assertStringContainsString('[ERROR] No extension handler registered for "Zenstruck\ScheduleBundle\Schedule\Extension\PingExtension: On Task', $commandTester->getDisplay());
        $this->assertStringContainsString('Failure, ping "https://example.com/my-command-failed"".', $commandTester->getDisplay());
        $this->assertStringContainsString('1 Schedule Extension:', $commandTester->getDisplay());
        $this->assertStringContainsString('On Schedule Failure, email output to "admin@example.com"', $commandTester->getDisplay());
        $this->assertStringContainsString('[WARNING] 1 issue with schedule:', $commandTester->getDisplay());
    }
}