Merge pull request #378 from Art4/behat

Migrate E2E tests to BDD with Behat

Author: Art4

CHANGELOG.md

@@ -7,6 +7,10 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
 
 ## [Unreleased](https://github.com/kbsali/php-redmine-api/compare/v2.5.0...v2.x)
 
+### Added
+
+- New method `Redmine\Api\...::getLastResponse()` to get the last response made by the API class.
+
 ### Fixed
 
 - Parameter types for IDs were fixed in API for attachments, groups, issues, project, users and versions.

composer.json

@@ -29,11 +29,12 @@
         "psr/http-factory": "^1.0"
     },
     "require-dev": {
+        "behat/behat": "^3.14",
         "friendsofphp/php-cs-fixer": "^3.45",
-        "phpunit/phpunit": "^9 || ^10.5",
         "guzzlehttp/psr7": "^2",
         "php-mock/php-mock-phpunit": "^2.6",
-        "phpstan/phpstan": "^1.10"
+        "phpstan/phpstan": "^1.10",
+        "phpunit/phpunit": "^9 || ^10.5"
     },
     "autoload": {
         "psr-4": {
@@ -45,10 +46,13 @@
             "Redmine\\Tests\\": "tests/"
         }
     },
+    "config": {
+        "sort-packages": true
+    },
     "scripts": {
+        "behat": "behat --config tests/Behat/behat.yml",
         "codestyle": "php-cs-fixer fix",
         "coverage": "phpunit --coverage-html=\".phpunit.cache/code-coverage\"",
-        "end2end": "phpunit --configuration=\"phpunit-end2end.xml\"",
         "phpstan": "phpstan analyze --memory-limit 512M --configuration .phpstan.neon",
         "phpunit": "phpunit",
         "test": [

docker-compose.yml

@@ -14,6 +14,7 @@ services:
 
     redmine-dev:
         image: redmine:5.1.1
+        user: "1000:1000"
         ports:
             - "3000:3000"
         environment:
@@ -27,6 +28,7 @@ services:
 
     redmine-50101:
         image: redmine:5.1.1
+        user: "1000:1000"
         ports:
             - "5101:3000"
         environment:
@@ -38,6 +40,7 @@ services:
 
     redmine-50007:
         image: redmine:5.0.7
+        user: "1000:1000"
         ports:
             - "5007:3000"
         environment:

phpunit-end2end.xml

@@ -72,7 +72,7 @@ final protected function getHttpClient(): HttpClient
         return $this->httpClient;
     }
 
-    final protected function getLastResponse(): Response
+    final public function getLastResponse(): Response
     {
         return $this->lastResponse !== null ? $this->lastResponse : HttpFactory::makeResponse(0, '', '');
     }

src/Redmine/Api/AbstractApi.php

@@ -347,7 +347,7 @@ protected function prepareParamsXml($params)
     {
         @trigger_error('`' . __METHOD__ . '()` is deprecated since v2.3.0, use `\Redmine\Serializer\XmlSerializer::createFromArray()` instead.', E_USER_DEPRECATED);
 
-        return new \SimpleXMLElement(
+        return new SimpleXMLElement(
             XmlSerializer::createFromArray(['project' => $params])->getEncoded()
         );
     }

src/Redmine/Api/Project.php

@@ -9,8 +9,6 @@
  *
  * The method signatures are defined with the intention that an implementing class
  * can implment this interface and also the PSR-7 `\Psr\Http\Message\ResponseInterface`
- *
- * @internal
  */
 interface Response
 {

src/Redmine/Http/Response.php

@@ -0,0 +1,48 @@
+<?php
+
+declare(strict_types=1);
+
+namespace Redmine\Tests\Behat\Bootstrap;
+
+use Behat\Behat\Tester\Exception\PendingException;
+use Behat\Gherkin\Node\TableNode;
+use Redmine\Api\Attachment;
+
+trait AttachmentContextTrait
+{
+    /**
+     * @When I upload the content of the file :filepath with the following data
+     */
+    public function iUploadTheContentOfTheFileWithTheFollowingData(string $filepath, TableNode $table)
+    {
+        $data = [];
+
+        foreach ($table as $row) {
+            $data[$row['property']] = $row['value'];
+        }
+
+        $filepath = str_replace('%tests_dir%', dirname(__FILE__, 3), $filepath);
+
+        /** @var Attachment */
+        $api = $this->getNativeCurlClient()->getApi('attachment');
+
+        $this->registerClientResponse(
+            $api->upload(file_get_contents($filepath), $data),
+            $api->getLastResponse()
+        );
+    }
+
+    /**
+     * @When I show the attachment with the id :attachmentId
+     */
+    public function iShowTheAttachmentWithTheId(int $attachmentId)
+    {
+        /** @var Attachment */
+        $api = $this->getNativeCurlClient()->getApi('attachment');
+
+        $this->registerClientResponse(
+            $api->show($attachmentId),
+            $api->getLastResponse()
+        );
+    }
+}