phpunit json assertions Download – phpunit json assertions Quellcode herunterladen

phpunit json assertions

Python

v4.0.0

Herunterladen

phpunit-json-assertions

JSON-Assertionen für PHPUnit umfassen Merkmale/Methoden, die Ihnen bei der Validierung Ihrer JSON-Daten durch verschiedene Methoden helfen.

Merkmale

Validieren Sie Ihre JSON-Daten über das JSON-Schema
- beschreibt Ihr bestehendes Datenformat
- klare, menschen- und maschinenlesbare Dokumentation
- vollständige Strukturvalidierung, nützlich für
  - automatisiertes Testen
  - Validierung der vom Kunden übermittelten Daten
- Weitere Details finden Sie hier
Greifen Sie über Ausdrücke auf JSON-Daten zu (z. B. foo.bar[3] ).
- Weitere Details finden Sie hier

Installieren

 $ composer require estahn/phpunit-json-assertions --dev

oder in Ihrer composer.json :

{
    "require-dev" : {
        "estahn/phpunit-json-assertions" : " @stable "
    }
}

Behauptet

Behaupten	Beschreibung	Verfügbar in
behauptenJsonMatchesSchema	Bestätigt, dass der JSON-Inhalt gemäß der bereitgestellten Schemadatei gültig ist	Alle
behauptenJsonMatchesSchemaString	Bestätigt, dass der JSON-Inhalt gemäß der bereitgestellten Schemazeichenfolge gültig ist	Alle
behauptenJsonValueEquals	Stellt fest, ob der mit dem Ausdruck abgerufene Wert dem erwarteten Wert entspricht	Alle
behauptenJsonValueEquals	Stellt fest, ob der mit dem Ausdruck abgerufene Wert dem erwarteten Wert entspricht	Alle
behauptenJsonResponse	Bestätigt, dass eine Antwort erfolgreich ist und vom Typ JSON ist	Symfony

Verwendung

Sie können entweder die trait oder class verwenden.

Eigenschaft

 <?php

namespace EnricoStahn  JsonAssert  Tests ;

use EnricoStahn  JsonAssert  Assert as JsonAssert ;

class MyTestCase extends PHPUnit_Framework_TestCase
{
    use JsonAssert;

    public function testJsonDocumentIsValid ()
    {
        // my-schema.json
        //
        // {
        //   "type" : "object",
        //   "properties" : {
        //     "foo" : {
        //       "type" : "integer"
        //     }
        //   },
        //   "required" : [ "foo" ]
        // }

        $ json = json_decode ( ' {"foo":1} ' );

        $ this -> assertJsonMatchesSchema ( $ json , ' ./my-schema.json ' );
        $ this -> assertJsonValueEquals ( 1 , ' * | [0] ' , $ json );
    }
}

Klasse

Falls Sie das trait nicht verwenden möchten, können Sie die bereitgestellte Klasse verwenden, die von PHPUnit_Framework_TestCase ausgeht. Sie können entweder Ihren Testfall erweitern oder die statischen Methoden wie unten verwenden.

 <?php

namespace EnricoStahn  JsonAssert  Tests ;

use EnricoStahn  JsonAssert  AssertClass as JsonAssert ;

class MyTestCase extends PHPUnit_Framework_TestCase
{
    public function testJsonDocumentIsValid ()
    {
        // my-schema.json
        //
        // {
        //   "type" : "object",
        //   "properties" : {
        //     "foo" : {
        //       "type" : "integer"
        //     }
        //   },
        //   "required" : [ "foo" ]
        // }

        $ json = json_decode ( ' {"foo":1} ' );

        JsonAssert:: assertJsonMatchesSchema ( $ json , ' ./my-schema.json ' );
        JsonAssert:: assertJsonValueEquals ( 1 , ' * | [0] ' , $ json );
    }
}

Schemaspeicher

Der Schemaspeicher von justinrainbow/json-schema ermöglicht die Registrierung von Schemata, die den tatsächlichen Schemaspeicherort effektiv überschreiben.

Beispiel:

{ "$ref" : " https://iglu.foobar.com/myschema.json#/definitions/positiveInteger " }

Der Resolver ruft das Schema von diesem Endpunkt ab und gleicht das JSON-Dokument damit ab. Mithilfe des Schemaspeichers können Sie dieses Verhalten außer Kraft setzen.

 $ schemastorage -> addSchema ( ' https://iglu.foobar.com/myschema.json ' , ( object )[ ' type ' => ' string ' ]);

Wenn dies vorhanden ist, übernimmt der Resolver das bereits vorhandene Schema, ohne es erneut herunterzuladen.

 <?php

namespace EnricoStahn  JsonAssert  Tests ;

use EnricoStahn  JsonAssert  AssertClass as JsonAssert ;

class MyTestCase extends PHPUnit_Framework_TestCase
{
    public function setUp ()
    {
        self :: $ schemaStorage = new SchemaStorage ();
        
        self :: $ schemaStorage -> addSchema ( ' <id> ' , obj);
        . . .
    }
    
    public function testJsonDocumentIsValid ()
    {
        // my-schema.json
        //
        // {
        //   "type" : "object",
        //   "properties" : {
        //     "foo" : {
        //       "type" : "integer"
        //     }
        //   },
        //   "required" : [ "foo" ]
        // }

        $ json = json_decode ( ' {"foo":1} ' );

        JsonAssert:: assertJsonMatchesSchema ( $ json , ' ./my-schema.json ' );
        JsonAssert:: assertJsonValueEquals ( 1 , ' * | [0] ' , $ json );
    }
}

Erweiterungen

phpunit-json-assertions bietet Erweiterungen für eine einfachere Handhabung in verschiedenen Anwendungsfällen.

Symfony HttpFoundation-Komponente

Die Erweiterung EnricoStahnJsonAssertExtensionSymfony ermöglicht die Übergabe des eigentlichen vom Symfony-Framework generierten Antwortobjekts und übernimmt den Dekodierungsteil.

VOR:

 use EnricoStahn  JsonAssert  Assert as JsonAssert ;

// ...

$ content = $ response -> getContent ();
$ json = json_decode ( $ content );
JsonAssert:: assertJsonMatchesSchemaString ( ' ./my-schema.json ' , $ json );

NACH:

 use EnricoStahn  JsonAssert  Extension  Symfony as JsonAssert ;

// ...

JsonAssert:: assertJsonMatchesSchemaString ( ' ./my-schema.json ' , $ response );