MQE-1633: Add API Request To Output for MFTF API Actions

- Added AllureHelper + Unit tests
- Added attachment event to curlHandler classes

Author: KevinBKozan

dev/tests/unit/Magento/FunctionalTestFramework/Allure/AllureHelperTest.php

@@ -0,0 +1,97 @@
+<?php
+/**
+ * Copyright © Magento, Inc. All rights reserved.
+ * See COPYING.txt for license details.
+ */
+namespace Tests\unit\Magento\FunctionalTestingFramework\Allure;
+
+use Magento\FunctionalTestingFramework\Allure\AllureHelper;
+use Yandex\Allure\Adapter\Allure;
+use Yandex\Allure\Adapter\Event\AddAttachmentEvent;
+use Yandex\Allure\Adapter\Event\StepFinishedEvent;
+use Yandex\Allure\Adapter\Event\StepStartedEvent;
+use Yandex\Allure\Adapter\Model\Attachment;
+use AspectMock\Test as AspectMock;
+use PHPUnit\Framework\TestCase;
+
+class AllureHelperTest extends TestCase
+{
+    const MOCK_FILENAME = 'filename';
+
+    /**
+     * Clear Allure Lifecycle
+     */
+    public function tearDown()
+    {
+        Allure::setDefaultLifecycle();
+    }
+
+    /**
+     * AddAtachmentToStep should add an attachment to the current step
+     * @throws \Yandex\Allure\Adapter\AllureException
+     */
+    public function testAddAttachmentToStep()
+    {
+        $this->mockAttachmentWriteEvent();
+        $expectedData = "string";
+        $expectedCaption = "caption";
+
+        //Prepare Allure lifecycle
+        Allure::lifecycle()->fire(new StepStartedEvent('firstStep'));
+
+        //Call function
+        AllureHelper::addAttachmentToCurrentStep($expectedData, $expectedCaption);
+
+        // Assert Attachment is created as expected
+        $step = Allure::lifecycle()->getStepStorage()->pollLast();
+        $expectedAttachment = new Attachment($expectedCaption, self::MOCK_FILENAME, null);
+        $this->assertEquals($step->getAttachments()[0], $expectedAttachment);
+    }
+
+    /**
+     * AddAttachmentToLastStep should add an attachment only to the last step
+     * @throws \Yandex\Allure\Adapter\AllureException
+     */
+    public function testAddAttachmentToLastStep()
+    {
+        $this->mockAttachmentWriteEvent();
+        $expectedData = "string";
+        $expectedCaption = "caption";
+
+        //Prepare Allure lifecycle
+        Allure::lifecycle()->fire(new StepStartedEvent('firstStep'));
+        Allure::lifecycle()->fire(new StepFinishedEvent('firstStep'));
+        Allure::lifecycle()->fire(new StepStartedEvent('secondStep'));
+        Allure::lifecycle()->fire(new StepFinishedEvent('secondStep'));
+
+        //Call function
+        AllureHelper::addAttachmentToLastStep($expectedData, $expectedCaption);
+
+        //Continue Allure lifecycle
+        Allure::lifecycle()->fire(new StepStartedEvent('thirdStep'));
+        Allure::lifecycle()->fire(new StepFinishedEvent('thirdStep'));
+
+        // Assert Attachment is created as expected on the right step
+        $rootStep = Allure::lifecycle()->getStepStorage()->pollLast();
+
+        $firstStep = $rootStep->getSteps()[0];
+        $secondStep = $rootStep->getSteps()[1];
+        $thirdStep = $rootStep->getSteps()[2];
+
+        $expectedAttachment = new Attachment($expectedCaption, self::MOCK_FILENAME, null);
+        $this->assertEmpty($firstStep->getAttachments());
+        $this->assertEquals($secondStep->getAttachments()[0], $expectedAttachment);
+        $this->assertEmpty($thirdStep->getAttachments());
+    }
+
+    /**
+     * Mock file system manipulation function
+     * @throws \Exception
+     */
+    public function mockAttachmentWriteEvent()
+    {
+        AspectMock::double(AddAttachmentEvent::class, [
+            "getAttachmentFileName" => self::MOCK_FILENAME
+        ]);
+    }
+}

src/Magento/FunctionalTestingFramework/Allure/AllureHelper.php

@@ -0,0 +1,39 @@
+<?php
+/**
+ * Copyright © Magento, Inc. All rights reserved.
+ * See COPYING.txt for license details.
+ */
+namespace Magento\FunctionalTestingFramework\Allure;
+
+use Yandex\Allure\Adapter\Allure;
+use Yandex\Allure\Adapter\Event\AddAttachmentEvent;
+
+class AllureHelper
+{
+    /**
+     * Adds attachment to the current step
+     * @param mixed  $data
+     * @param string $caption
+     * @throws \Yandex\Allure\Adapter\AllureException
+     * @return void
+     */
+    public static function addAttachmentToCurrentStep($data, $caption)
+    {
+        Allure::lifecycle()->fire(new AddAttachmentEvent($data, $caption));
+    }
+
+    /**
+     * Adds Attachment to the last executed step. Required due to Allure root-step behavior
+     * @param mixed  $data
+     * @param string $caption
+     * @return void
+     */
+    public static function addAttachmentToLastStep($data, $caption)
+    {
+        $rootStep = Allure::lifecycle()->getStepStorage()->getLast();
+        $trueLastStep = array_last($rootStep->getSteps());
+
+        $attachmentEvent = new AddAttachmentEvent($data, $caption);
+        $attachmentEvent->process($trueLastStep);
+    }
+}

src/Magento/FunctionalTestingFramework/DataGenerator/Persist/CurlHandler.php

@@ -5,6 +5,7 @@
  */
 namespace Magento\FunctionalTestingFramework\DataGenerator\Persist;
 
+use Magento\FunctionalTestingFramework\Allure\AllureHelper;
 use Magento\FunctionalTestingFramework\DataGenerator\Persist\Curl\AdminExecutor;
 use Magento\FunctionalTestingFramework\DataGenerator\Persist\Curl\FrontendExecutor;
 use Magento\FunctionalTestingFramework\DataGenerator\Persist\Curl\WebapiExecutor;
@@ -166,6 +167,14 @@ public function executeRequest($dependentEntities)
         $response = $executor->read($successRegex, $returnRegex, $returnIndex);
         $executor->close();
 
+        AllureHelper::addAttachmentToLastStep($apiUrl, 'API Endpoint');
+        AllureHelper::addAttachmentToLastStep(json_encode($headers, JSON_PRETTY_PRINT), 'Request Headers');
+        AllureHelper::addAttachmentToLastStep(json_encode($this->requestData, JSON_PRETTY_PRINT), 'Request Body');
+        AllureHelper::addAttachmentToLastStep(
+            json_encode(json_decode($response, true), JSON_PRETTY_PRINT+JSON_UNESCAPED_UNICODE+JSON_UNESCAPED_SLASHES),
+            'Response Data'
+        );
+
         return $response;
     }