Maison  >  Article  >  cadre php  >  Comment tester les tâches planifiées dans Laravel

Comment tester les tâches planifiées dans Laravel

PHPz
PHPzoriginal
2023-04-23 09:17:58798parcourir

Laravel est un framework PHP populaire largement utilisé dans le développement d'applications Web. Dans Laravel, les tâches planifiées sont appelées planification de tâches, ce qui nous permet d'automatiser l'exécution de tâches, comme l'exécution d'une tâche à une heure fixe chaque jour. Mais, dans les applications pratiques, comment tester les tâches planifiées ? Cet article vous expliquera comment tester les tâches planifiées dans Laravel.

Qu'est-ce qu'une tâche planifiée ?

Une tâche planifiée fait référence à une tâche qui est automatiquement déclenchée à une heure ou à un état de programme spécifique. Cela peut nous aider à réaliser de nombreuses opérations automatisées, comme l'envoi régulier d'e-mails chaque jour, la sauvegarde de bases de données, la mise à jour des caches, etc. La planification de tâches dans Laravel nécessite le démarrage d'un processus. Laravel fournit l'outil de ligne de commande Artisan pour gérer ces processus.

Planification des tâches dans Laravel

Le planificateur de tâches dans Laravel nous permet de définir facilement des tâches planifiées et d'exécuter automatiquement des tâches. Il suffit de définir le temps d'exécution, la fréquence d'exécution et la commande à exécuter de la tâche. Laravel fournit une fonction de planification de tâches très pratique. En appelant la méthode ->cron(), vous pouvez planifier des tâches chaque minute, chaque heure, chaque jour et chaque semaine. L'exemple de code est le suivant. : ->cron()方法可以实现每分钟、每小时、每天以及每周的任务调度,示例代码如下:

$schedule->command('send:remindemail')
         ->daily()
         ->timezone('Asia/Shanghai')
         ->description('send remind email to user');

以上代码表示,每天在上海时间的0点执行 send:remindemail 命令,并在任务描述中添加了说明文字。

Laravel中的任务调度测试

Laravel中提供了一种自动化的任务调度测试方法,我们可以使用Mockery模拟任务的执行,然后通过Laravel自带的测试工具PHPUnit来实现测试。实现步骤如下:

步骤1:设置测试环境

我们需要在测试前先设置测试环境,因为测试环境需要模拟生产环境的定时任务。在 .env 文件中设置 APP_ENVtesting ,表示当前是测试环境:

APP_ENV=testing

步骤2:创建测试类

我们需要创建一个测试类来测试任务调度器的工作。测试类可以扩展 IlluminateFoundationTestingTestCase 类,示例代码如下:

namespace Tests;

use Illuminate\Foundation\Testing\TestCase as BaseTestCase;

abstract class TestCase extends BaseTestCase
{
    use CreatesApplication;
}

步骤3:定义测试方法

我们可以在测试类中定义测试方法,先使用 Mockery 模拟要执行的命令,然后执行任务调度器的定义任务。在任务执行完毕后,可以使用 PHPUnit 提供的一系列断言方法来判断任务是否被正确执行。示例代码如下:

namespace Tests\Feature;

use App\Console\Commands\SendRemindEmail;
use Tests\TestCase;
use Mockery;
use Illuminate\Support\Facades\Artisan;

class TaskSchedulerTest extends TestCase
{
    public function testTaskScheduler()
    {
        // Arrange
        $remindEmailCommandMock = Mockery::mock(SendRemindEmail::class);
        $remindEmailCommandMock->shouldReceive('handle')->once();
        $this->app->instance(SendRemindEmail::class, $remindEmailCommandMock);

        // Act
        Artisan::call('schedule:run');

        // Assert
        // add your assertions here
    }
}

在上述示例代码中,我们首先模拟了 SendRemindEmail 命令,并设置该命令比如会被执行一次。然后,我们通过 Artisan

./vendor/bin/phpunit
Ci-dessus Le code indique que la commande send:remindemail est exécutée tous les jours à 0h00, heure de Shanghai, et un texte explicatif est ajouté à la description de la tâche.

Test de planification de tâches dans Laravel

Laravel fournit une méthode de test de planification de tâches automatisée. Nous pouvons utiliser Mockery pour simuler l'exécution de tâches, puis implémenter le test via le propre outil de test de Laravel, PHPUnit. Les étapes de mise en œuvre sont les suivantes :

Étape 1 : Configurer l'environnement de test

Nous devons configurer l'environnement de test avant le test, car l'environnement de test doit simuler les tâches planifiées de l'environnement de production. Définissez APP_ENV sur testing dans le fichier .env, indiquant qu'il s'agit actuellement d'un environnement de test :

rrreee

Étape 2 : Créer une classe de test 🎜🎜Nous avons besoin de créer une classe de test pour tester le fonctionnement du planificateur de tâches. La classe de test peut étendre la classe IlluminateFoundationTestingTestCase. L'exemple de code est le suivant : 🎜rrreee🎜Étape 3 : Définir la méthode de test🎜🎜Nous pouvons définir la méthode de test dans la classe de test, utilisez d'abord Moquerie à simuler La commande à exécuter exécute ensuite les tâches définies par le planificateur de tâches. Une fois la tâche exécutée, vous pouvez utiliser une série de méthodes d'assertion fournies par PHPUnit pour déterminer si la tâche a été exécutée correctement. L'exemple de code est le suivant : 🎜rrreee🎜Dans l'exemple de code ci-dessus, nous avons d'abord simulé la commande <code>SendRemindEmail et défini la commande pour qu'elle soit exécutée une fois. Ensuite, nous appelons le planificateur de tâches via le programme Artisan et attendons la fin de l'exécution de la tâche. Enfin, nous pouvons utiliser les différentes méthodes d'assertion fournies par PHPUnit pour déterminer si l'exécution de la commande a réussi. 🎜🎜Étape 4 : Exécuter le test🎜🎜Après avoir fini de définir le scénario de test, nous pouvons utiliser la commande PHPUnit pour exécuter le test : 🎜rrreee🎜Pendant le processus de test, nous pouvons intercepter le processus du planificateur de tâches exécutant la tâche et passez Assert pour déterminer si la tâche est exécutée normalement. 🎜🎜Résumé🎜🎜Dans cet article, nous avons brièvement présenté le planificateur de tâches dans Laravel et comment tester unitairement le planificateur de tâches. Les tâches planifiées peuvent nous aider à réaliser de nombreuses opérations automatisées et à rendre nos applications plus efficaces et plus pratiques. Dans le même temps, de bons tests peuvent également nous permettre d'utiliser les tâches planifiées avec plus de confiance et de garantir que les tâches peuvent être exécutées normalement. 🎜

Ce qui précède est le contenu détaillé de. pour plus d'informations, suivez d'autres articles connexes sur le site Web de PHP en chinois!

Déclaration:
Le contenu de cet article est volontairement contribué par les internautes et les droits d'auteur appartiennent à l'auteur original. Ce site n'assume aucune responsabilité légale correspondante. Si vous trouvez un contenu suspecté de plagiat ou de contrefaçon, veuillez contacter admin@php.cn