Comment tester les colonnes JSON égales dans les modèles Laravel

Tester l'égalité entre les colonnes JSON dans Laravel nécessite une attention particulière puisque les données JSON sont stockées sous forme de chaînes dans la base de données. Les différences dans la façon dont JSON est codé peuvent entraîner des échecs de test inattendus lors de la comparaison des colonnes JSON. Cet article vous guidera pour comparer efficacement les colonnes JSON dans les tests de votre application Laravel.

Comprendre le défi

Lorsque les données JSON sont stockées dans la base de données, elles sont enregistrées sous forme de chaîne. Des différences mineures dans le codage JSON, telles que l'espacement ou l'ordre des clés, peuvent entraîner l'échec des comparaisons directes de chaînes. Cela signifie que même si le contenu est logiquement équivalent, les tests utilisant $this->assertDatabaseHas() peuvent échouer.

Exemple de modèle

Tout d'abord, considérons le modèle PriceSchedule, qui inclut des colonnes JSON :

final class PriceSchedule extends Model
{
    protected $fillable = [
        'user_id',
        'price_supplier_id',
        'weekday',
        'hour',
        'is_active'
    ];

    protected $casts = [
        'weekday' => 'array',
        'hour' => 'array',
    ];
}

Les attributs du jour de la semaine et de l'heure sont convertis en tableaux, permettant une manipulation facile dans votre application.

Écrire le test

Voici un exemple de test de mise à jour d'un PriceSchedule :

final class PriceExportScheduleTest extends TestCase
{
    public function test_price_export_schedule_update(): void
    {
        $user = UserFactory::new()->create();
        $this->actingAsFrontendUser($user);

        $priceSchedule = PriceScheduleFactory::new()->make();

        $updatedData = [
            'weekday' => $this->faker->randomElements(DayOfWeek::values(), 3),
            'hour' => $priceSchedule->hour,
            'is_active' => true,
        ];

        $response = $this->putJson(route('api-v2:price-export.suppliers.schedules.update'), $updatedData);

        $response->assertNoContent();

        $this->assertDatabaseHas(PriceSchedule::class, [
            'user_id' => $user->id,
            'is_active' => $updatedData['is_active'],
            'weekday' => $updatedData['weekday'],
            'hour' => $updatedData['hour'],
        ]);
    }
}

Problème courant avec les comparaisons JSON

Lorsque vous utilisez $this->assertDatabaseHas() pour comparer des valeurs de type JSON telles que le jour de la semaine et l'heure, les comparaisons directes peuvent échouer en raison de différences dans l'encodage JSON. Par exemple :

• JSON stocké dans la base de données : {"key":"value"}
• JSON généré par PHP : { "clé": "valeur" }

Même si les données sont logiquement identiques, le test peut échouer car les chaînes diffèrent.

Solution : utilisez $this->castAsJson()

Pour garantir des comparaisons cohérentes, utilisez $this->castAsJson() lors de l'affirmation de colonnes JSON :

$this->assertDatabaseHas(PriceSchedule::class, [
    'user_id' => $user->id,
    'is_active' => $updatedData['is_active'],
    'weekday' => $this->castAsJson($updatedData['weekday']),
    'hour' => $this->castAsJson($updatedData['hour']),
]);

Cette méthode garantit que les données de test et les données de la base de données sont converties dans un format JSON commun avant la comparaison.

Sortie de test

L'exécution du test produit le résultat suivant :

Price Export Schedule (PriceExportSchedule)
✔ Price export schedule update
OK (1 test, 3 assertions)

En utilisant $this->castAsJson(), vous pouvez éviter les problèmes d'encodage JSON et vous assurer que vos tests sont à la fois fiables et
précis.

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!