配置和测试Laravel任务调度

Question

Environment

• Laravel版本：5.1.45（LTS）
• PHP版本：5.6.1

---

Description

我正在尝试使用Laravel Task Scheduling每1分钟运行一次命令。

---

Attempt

我已将此行添加到我的cron选项卡文件中

* * * * * php artisan schedule:run >> /dev/null 2>&1

这是我的/app/Console/Kernel.php

<?php

namespace App\Console;

use Illuminate\Console\Scheduling\Schedule;
use Illuminate\Foundation\Console\Kernel as ConsoleKernel;

class Kernel extends ConsoleKernel
{
    /**
     * The Artisan commands provided by your application.
     *
     * @var array
     */
    protected $commands = [
        \App\Console\Commands\Inspire::class,
    ];

    /**
     * Define the application's command schedule.
     *
     * @param  \Illuminate\Console\Scheduling\Schedule  $schedule
     * @return void
     */
    protected function schedule(Schedule $schedule)
    {
        $schedule->command('inspire')->hourly();
        $schedule->command('echo "Happy New Year!" ')->everyMinute(); //<---- ADD HERE        }
}

我添加了这行$schedule->command('echo "Happy New Year!" ')->everyMinute();

---

Question

我该如何测试？

如何触发显示的回声？

我怎么知道我做的是不是错了？

---

我现在正在接受任何建议。

任何提示/建议/帮助将非常感谢！

Answer 1

command()经营着一个工匠指挥。您正在尝试实现的目标 - 向操作系统发出命令 - 由exec('echo "Happy New Year!"')完成

测试取决于您要测试的内容：

• 调度程序（每分钟）是否正常工作？

在这种情况下，您不必。它在原始框架代码中进行测试。

• 命令是否成功？

好吧，你可以手动运行php artisan schedule:run并查看输出。

调度程序在默认情况下不会产生任何输出（>> /dev/null 2>&1）。但是，您可以通过链接writeOutputTo()或appendOutputTo()（https://laravel.com/docs/5.1/scheduling#task-output）将已运行脚本的输出重定向到任何文件。

---

对于更复杂的逻辑，编写一个控制台命令（https://laravel.com/docs/5.1/artisan#writing-commands）并使用command() - 这样你就可以编写漂亮的，可测试的代码。

Answer 2

如果要对事件的计划进行单元测试，可以使用此示例。它基于默认的inspire命令：

public function testIsAvailableInTheScheduler()
{
    /** @var \Illuminate\Console\Scheduling\Schedule $schedule */
    $schedule = app()->make(\Illuminate\Console\Scheduling\Schedule::class);

    $events = collect($schedule->events())->filter(function (\Illuminate\Console\Scheduling\Event $event) {
        return stripos($event->command, 'YourCommandHere');
    });

    if ($events->count() == 0) {
        $this->fail('No events found');
    }

    $events->each(function (\Illuminate\Console\Scheduling\Event $event) {
        // This example is for hourly commands.
        $this->assertEquals('0 * * * * *', $event->expression);
    });
}

Answer 3

基于Michiel的回答，我使用Illuminate\Console\Scheduling\Event中包含的方法来测试事件是否应该在给定日期运行。

我使用Carbon::setTestNow()模拟当前日期，以便when()和skip()过滤器中的任何基于日期的逻辑将按预期运行。

use Tests\TestCase;
use Illuminate\Console\Scheduling\Schedule;
use Illuminate\Console\Scheduling\Event;

use Cron\CronExpression;
use Carbon\Carbon;


class ScheduleTest extends TestCase {


    public function testCompanyFeedbackSchedule()
    {
        $event = $this->getCommandEvent('your-command-signature');

        $test_date = Carbon::now()->startOfDay()->addHours(8);

        for ($i=0; $i < 356; $i++) { 
            $test_date->addDay();
            Carbon::setTestNow($test_date);

            // Run the when() & skip() filters
            $filters_pass = $event->filtersPass($this->app);
            // Test that the Cron expression passes
            $date_passes = $this->isEventDue($event);
            $will_run = $filters_pass && $date_passes;

            // Should only run on first friday of month
            if ($test_date->format('l') === 'Friday' && $test_date->weekOfMonth === 1) {
                $this->assertTrue($will_run, 'Task should run on '. $test_date->toDateTimeString());
            } else {
                $this->assertFalse($will_run, 'Task should not run on '. $test_date->toDateTimeString());
            }
        }
    }


    /**
     * Get the event matching the given command signature from the scheduler
     * 
     * @param  string  $command_signature
     * 
     * @return Illuminate\Console\Scheduling\Event
     */
    private function getCommandEvent($command_signature)
    {
        $schedule = app()->make(Schedule::class);

        $event = collect($schedule->events())->first(function (Event $event) use ($command_signature) {
            return stripos($event->command, $command_signature);
        });

        if (!$event) {
            $this->fail('Event for '. $command_signature .' not found');
        }

        return $event;
    }


    /**
     * Determine if the Cron expression passes.
     * 
     * Copied from the protected method Illuminate\Console\Scheduling\Event@isEventDue
     * 
     * @return bool
     */
    private function isEventDue(Event $event)
    {
        $date = Carbon::now();

        if ($event->timezone) {
            $date->setTimezone($event->timezone);
        }

        return CronExpression::factory($event->expression)->isDue($date->toDateTimeString());
    }
}