hal collection links should have a href property (#1775)

* hal collection links should have a href property

* flesh out hal collection feature

* validate hal responses against the hal+json schema

* fix schema validation

Author: bendavies

behat.yml.dist

@@ -9,6 +9,7 @@ default:
         - 'SwaggerContext'
         - 'HttpCacheContext'
         - 'JsonApiContext': { doctrine: '@doctrine', jsonApiSchemaFile: 'tests/Fixtures/JsonSchema/jsonapi.json' }
+        - 'JsonHalContext': { schemaFile: 'tests/Fixtures/JsonHal/jsonhal.json' }
         - 'Behat\MinkExtension\Context\MinkContext'
         - 'Behatch\Context\RestContext'
       filters:
@@ -22,6 +23,7 @@ default:
         - 'SwaggerContext'
         - 'HttpCacheContext'
         - 'JsonApiContext': { doctrine: '@doctrine', jsonApiSchemaFile: 'tests/Fixtures/JsonSchema/jsonapi.json' }
+        - 'JsonHalContext': { schemaFile: 'tests/Fixtures/JsonHal/jsonhal.json' }
         - 'Behat\MinkExtension\Context\MinkContext'
         - 'Behatch\Context\RestContext'
       filters:
@@ -51,6 +53,7 @@ coverage:
         - 'SwaggerContext'
         - 'HttpCacheContext'
         - 'JsonApiContext': { doctrine: '@doctrine', jsonApiSchemaFile: 'tests/Fixtures/JsonSchema/jsonapi.json' }
+        - 'JsonHalContext': { schemaFile: 'tests/Fixtures/JsonHal/jsonhal.json' }
         - 'CoverageContext'
         - 'Behat\MinkExtension\Context\MinkContext'
         - 'Behatch\Context\RestContext'

features/bootstrap/JsonApiContext.php

@@ -61,8 +61,12 @@ public function gatherContexts(BeforeScenarioScope $scope)
      */
     public function theJsonShouldBeValidAccordingToTheJsonApiSchema()
     {
-        $json = $this->getJson();
+        $json = $this->getJson()->getContent();
         $this->validator->validate($json, (object) ['$ref' => 'file://'.__DIR__.'/../../'.$this->jsonApiSchemaFile]);
+
+        if (!$this->validator->isValid()) {
+            throw new ExpectationFailedException(sprintf('The JSON is not valid according to the JSON API schema.'));
+        }
     }
 
     /**

features/bootstrap/JsonHalContext.php

@@ -0,0 +1,75 @@
+<?php
+
+/*
+ * This file is part of the API Platform project.
+ *
+ * (c) Kévin Dunglas <[email protected]>
+ *
+ * For the full copyright and license information, please view the LICENSE
+ * file that was distributed with this source code.
+ */
+
+declare(strict_types=1);
+
+use Behat\Behat\Context\Context;
+use Behat\Behat\Context\Environment\InitializedContextEnvironment;
+use Behat\Behat\Hook\Scope\BeforeScenarioScope;
+use Behatch\Context\RestContext;
+use Behatch\Json\Json;
+use JsonSchema\Validator;
+use PHPUnit\Framework\ExpectationFailedException;
+
+final class JsonHalContext implements Context
+{
+    /**
+     * @var RestContext
+     */
+    private $restContext;
+    private $validator;
+    private $schemaFile;
+
+    public function __construct(string $schemaFile)
+    {
+        if (!is_file($schemaFile)) {
+            throw new \InvalidArgumentException('The JSON HAL schema doesn\'t exist.');
+        }
+
+        $this->validator = new Validator();
+        $this->schemaFile = $schemaFile;
+    }
+
+    /**
+     * Gives access to the Behatch context.
+     *
+     * @BeforeScenario
+     */
+    public function gatherContexts(BeforeScenarioScope $scope)
+    {
+        /** @var InitializedContextEnvironment $environment */
+        $environment = $scope->getEnvironment();
+        $this->restContext = $environment->getContext(RestContext::class);
+    }
+
+    /**
+     * @Then the JSON should be valid according to the JSON HAL schema
+     */
+    public function theJsonShouldBeValidAccordingToTheJsonHALSchema()
+    {
+        $json = $this->getJson()->getContent();
+        $this->validator->validate($json, (object) ['$ref' => 'file://'.__DIR__.'/../../'.$this->schemaFile]);
+
+        if (!$this->validator->isValid()) {
+            throw new ExpectationFailedException(sprintf('The JSON is not valid according to the HAL+JSON schema.'));
+        }
+    }
+
+    private function getJson()
+    {
+        return new Json($this->getContent());
+    }
+
+    private function getContent()
+    {
+        return $this->restContext->getMink()->getSession()->getDriver()->getContent();
+    }
+}