Switch to a resource attribute to manage URL generation strategy

Author: antograssiot

.circleci/config.yml

@@ -353,7 +353,7 @@ jobs:
           name: Run Behat tests
           command: |
             mkdir -p build/logs/behat build/coverage
-            for f in $(find features -name '*.feature' -not -path 'features/main/exposed_state.feature' -not -path 'features/elasticsearch/*' -not -path 'features/mongodb/*' -not -path 'features/absolute_url/*' -not -path 'features/network_path/*' | circleci tests split --split-by=timings); do
+            for f in $(find features -name '*.feature' -not -path 'features/main/exposed_state.feature' -not -path 'features/elasticsearch/*' -not -path 'features/mongodb/*' | circleci tests split --split-by=timings); do
               _f=$(echo "$f" | tr / _)
               FEATURE="${_f}" vendor/bin/behat --format=progress --out=std --format=junit --out=build/logs/behat/"${_f}" --profile=default-coverage --no-interaction --colors "$f"
             done

.travis.yml

@@ -244,45 +244,4 @@ jobs:
         - *validate-openapi-v3-json
         - *validate-openapi-v3-yaml
 
-    - php: '7.3'
-      env: APP_ENV=absolute_url
-      before_install:
-        - *enable-mongodb-php-extension
-        - *disable-xdebug-php-extension
-        - *disable-php-memory-limit
-        - *add-composer-bin-dir-to-path
-      install:
-        - *update-project-dependencies
-      before_script:
-        - *clear-test-app-cache
-      script:
-        - *run-phpunit-tests
-        - *clear-test-app-cache
-        - vendor/bin/behat --format=progress --profile=absolute-url --no-interaction
-        - *validate-openapi-v2-json
-        - *validate-openapi-v2-yaml
-        - *validate-openapi-v3-json
-        - *validate-openapi-v3-yaml
-
-
-    - php: '7.3'
-      env: APP_ENV=network_path
-      before_install:
-        - *enable-mongodb-php-extension
-        - *disable-xdebug-php-extension
-        - *disable-php-memory-limit
-        - *add-composer-bin-dir-to-path
-      install:
-        - *update-project-dependencies
-      before_script:
-        - *clear-test-app-cache
-      script:
-        - *run-phpunit-tests
-        - *clear-test-app-cache
-        - vendor/bin/behat --format=progress --profile=network-path --no-interaction
-        - *validate-openapi-v2-json
-        - *validate-openapi-v2-yaml
-        - *validate-openapi-v3-json
-        - *validate-openapi-v3-yaml
-
   fast_finish: true

behat.yml.dist

@@ -20,7 +20,7 @@ default:
         - 'Behat\MinkExtension\Context\MinkContext'
         - 'Behatch\Context\RestContext'
       filters:
-        tags: '~@postgres&&~@mongodb&&~@elasticsearch&&~@absoluteUrl&&~@networkPath'
+        tags: '~@postgres&&~@mongodb&&~@elasticsearch'
   extensions:
     'Behat\Symfony2Extension':
       kernel:
@@ -40,7 +40,7 @@ default-no-legacy:
   suites:
     default:
       filters:
-        tags: '~@postgres&&~@mongodb&&~@elasticsearch&&~@legacy&&~@absoluteUrl&&~@networkPath'
+        tags: '~@postgres&&~@mongodb&&~@elasticsearch&&~@legacy'
 
 postgres:
   suites:
@@ -65,7 +65,7 @@ postgres:
         - 'Behat\MinkExtension\Context\MinkContext'
         - 'Behatch\Context\RestContext'
       filters:
-        tags: '~@sqlite&&~@mongodb&&~@elasticsearch&&~@absoluteUrl&&~@networkPath'
+        tags: '~@sqlite&&~@mongodb&&~@elasticsearch'
 
 postgres-no-legacy:
   suites:
@@ -98,7 +98,7 @@ mongodb:
         - 'Behat\MinkExtension\Context\MinkContext'
         - 'Behatch\Context\RestContext'
       filters:
-        tags: '~@sqlite&&~@elasticsearch&&~@!mongodb&&~@absoluteUrl&&~@networkPath'
+        tags: '~@sqlite&&~@elasticsearch&&~@!mongodb'
 
 mongodb-no-legacy:
   suites:

features/absolute_url/hal/entrypoint.feature

@@ -51,6 +51,8 @@
 use ApiPlatform\Core\Tests\Fixtures\TestBundle\Document\FourthLevel as FourthLevelDocument;
 use ApiPlatform\Core\Tests\Fixtures\TestBundle\Document\Greeting as GreetingDocument;
 use ApiPlatform\Core\Tests\Fixtures\TestBundle\Document\MaxDepthDummy as MaxDepthDummyDocument;
+use ApiPlatform\Core\Tests\Fixtures\TestBundle\Document\NetworkPathDummy as NetworkPathDummyDocument;
+use ApiPlatform\Core\Tests\Fixtures\TestBundle\Document\NetworkPathRelationDummy as NetworkPathRelationDummyDocument;
 use ApiPlatform\Core\Tests\Fixtures\TestBundle\Document\Order as OrderDocument;
 use ApiPlatform\Core\Tests\Fixtures\TestBundle\Document\Person as PersonDocument;
 use ApiPlatform\Core\Tests\Fixtures\TestBundle\Document\PersonToPet as PersonToPetDocument;
@@ -111,6 +113,8 @@
 use ApiPlatform\Core\Tests\Fixtures\TestBundle\Entity\Greeting;
 use ApiPlatform\Core\Tests\Fixtures\TestBundle\Entity\InternalUser;
 use ApiPlatform\Core\Tests\Fixtures\TestBundle\Entity\MaxDepthDummy;
+use ApiPlatform\Core\Tests\Fixtures\TestBundle\Entity\NetworkPathDummy;
+use ApiPlatform\Core\Tests\Fixtures\TestBundle\Entity\NetworkPathRelationDummy;
 use ApiPlatform\Core\Tests\Fixtures\TestBundle\Entity\Node;
 use ApiPlatform\Core\Tests\Fixtures\TestBundle\Entity\Order;
 use ApiPlatform\Core\Tests\Fixtures\TestBundle\Entity\Person;
@@ -1523,6 +1527,23 @@ public function thereAreAbsoluteUrlDummies(int $nb)
         $this->manager->flush();
     }
 
+    /**
+     * @Given there are :nb networkPathDummy objects with a related networkPathRelationDummy
+     */
+    public function thereArenetworkPathDummies(int $nb)
+    {
+        for ($i = 1; $i <= $nb; ++$i) {
+            $networkPathRelationDummy = $this->buildNetworkPathRelationDummy();
+            $networkPathDummy = $this->buildNetworkPathDummy();
+            $networkPathDummy->networkPathRelationDummy = $networkPathRelationDummy;
+
+            $this->manager->persist($networkPathRelationDummy);
+            $this->manager->persist($networkPathDummy);
+        }
+
+        $this->manager->flush();
+    }
+
     private function isOrm(): bool
     {
         return null !== $this->schemaTool;
@@ -1916,4 +1937,20 @@ private function buildAbsoluteUrlRelationDummy()
     {
         return $this->isOrm() ? new AbsoluteUrlRelationDummy() : new AbsoluteUrlRelationDummyDocument();
     }
+
+    /**
+     * @return NetworkPathDummyDocument|NetworkPathDummy
+     */
+    private function buildNetworkPathDummy()
+    {
+        return $this->isOrm() ? new NetworkPathDummy() : new NetworkPathDummyDocument();
+    }
+
+    /**
+     * @return NetworkPathRelationDummyDocument|NetworkPathRelationDummy
+     */
+    private function buildNetworkPathRelationDummy()
+    {
+        return $this->isOrm() ? new NetworkPathRelationDummy() : new NetworkPathRelationDummyDocument();
+    }
 }

features/absolute_url/jsonapi/entrypoint.feature

@@ -1,4 +1,3 @@
-@absoluteUrl
 Feature: IRI should contain Absolute URL
   In order to add detail to IRIs
   Include the absolute url

features/absolute_url/jsonld/entrypoint.feature

@@ -1,23 +1,22 @@
-@networkPath
 Feature: IRI should contain network path
   In order to add detail to IRIs
   Include the network path
 
   @createSchema
   Scenario: I should be able to GET a collection of objects with network paths
-    Given there are 1 absoluteUrlDummy objects with a related absoluteUrlRelationDummy
+    Given there are 1 networkPathDummy objects with a related networkPathRelationDummy
     And I add "Accept" header equal to "application/hal+json"
-    And I send a "GET" request to "/absolute_url_dummies"
+    And I send a "GET" request to "/network_path_dummies"
     And the JSON should be equal to:
     """
     {
       "_links": {
         "self": {
-          "href": "\/\/example.com\/absolute_url_dummies"
+          "href": "\/\/example.com\/network_path_dummies"
         },
         "item": [
           {
-            "href": "\/\/example.com\/absolute_url_dummies\/1"
+            "href": "\/\/example.com\/network_path_dummies\/1"
           }
         ]
       },
@@ -28,10 +27,10 @@ Feature: IRI should contain network path
           {
             "_links": {
               "self": {
-                "href": "\/\/example.com\/absolute_url_dummies\/1"
+                "href": "\/\/example.com\/network_path_dummies\/1"
               },
-              "absoluteUrlRelationDummy": {
-                "href": "\/\/example.com\/absolute_url_relation_dummies\/1"
+              "networkPathRelationDummy": {
+                "href": "\/\/example.com\/network_path_relation_dummies\/1"
               }
             },
             "id": 1
@@ -44,10 +43,10 @@ Feature: IRI should contain network path
   Scenario: I should be able to POST an object using a network path
     Given I add "Accept" header equal to "application/hal+json"
     And I add "Content-Type" header equal to "application/json"
-    And I send a "POST" request to "/absolute_url_relation_dummies" with body:
+    And I send a "POST" request to "/network_path_relation_dummies" with body:
     """
     {
-      "absolute_url_dummies": "//example.com/absolute_url_dummies/1"
+      "network_path_dummies": "//example.com/network_path_dummies/1"
     }
     """
     Then the response status code should be 201
@@ -56,7 +55,7 @@ Feature: IRI should contain network path
     {
       "_links": {
         "self": {
-          "href": "\/\/example.com\/absolute_url_relation_dummies\/2"
+          "href": "\/\/example.com\/network_path_relation_dummies\/2"
         }
       },
       "id": 2
@@ -65,16 +64,16 @@ Feature: IRI should contain network path
 
   Scenario: I should be able to GET an Item with network paths
     Given I add "Accept" header equal to "application/hal+json"
-    And I send a "GET" request to "/absolute_url_dummies/1"
+    And I send a "GET" request to "/network_path_dummies/1"
     And the JSON should be equal to:
     """
     {
       "_links": {
         "self": {
-          "href": "\/\/example.com\/absolute_url_dummies\/1"
+          "href": "\/\/example.com\/network_path_dummies\/1"
         },
-        "absoluteUrlRelationDummy": {
-          "href": "\/\/example.com\/absolute_url_relation_dummies\/1"
+        "networkPathRelationDummy": {
+          "href": "\/\/example.com\/network_path_relation_dummies\/1"
         }
       },
       "id": 1
@@ -83,17 +82,17 @@ Feature: IRI should contain network path
 
   Scenario: I should be able to GET subresources with network paths
     Given I add "Accept" header equal to "application/hal+json"
-    And I send a "GET" request to "/absolute_url_relation_dummies/1/absolute_url_dummies"
+    And I send a "GET" request to "/network_path_relation_dummies/1/network_path_dummies"
     And the JSON should be equal to:
     """
     {
       "_links": {
         "self": {
-          "href": "\/\/example.com\/absolute_url_relation_dummies\/1\/absolute_url_dummies"
+          "href": "\/\/example.com\/network_path_relation_dummies\/1\/network_path_dummies"
         },
         "item": [
           {
-            "href": "\/\/example.com\/absolute_url_dummies\/1"
+            "href": "\/\/example.com\/network_path_dummies\/1"
           }
         ]
       },
@@ -104,10 +103,10 @@ Feature: IRI should contain network path
           {
             "_links": {
               "self": {
-                "href": "\/\/example.com\/absolute_url_dummies\/1"
+                "href": "\/\/example.com\/network_path_dummies\/1"
               },
-              "absoluteUrlRelationDummy": {
-                "href": "\/\/example.com\/absolute_url_relation_dummies\/1"
+              "networkPathRelationDummy": {
+                "href": "\/\/example.com\/network_path_relation_dummies\/1"
               }
             },
             "id": 1

features/absolute_url/jsonld/errors.feature

@@ -1,4 +1,3 @@
-@absoluteUrl
 Feature: IRI should contain Absolute URL
   In order to add detail to IRIs
   Include the absolute url