33294: Eliminated aspect mock from AllureHelperTest

bohdan-harniuk · bohdan-harniuk · commit 1a71fe7cd558 · 2021-07-20T12:04:35.000+03:00
diff --git a/dev/tests/unit/Magento/FunctionalTestFramework/Allure/AllureHelperTest.php b/dev/tests/unit/Magento/FunctionalTestFramework/Allure/AllureHelperTest.php
@@ -3,11 +3,14 @@
  * Copyright © Magento, Inc. All rights reserved.
  * See COPYING.txt for license details.
  */
+declare(strict_types=1);
+
 namespace tests\unit\Magento\FunctionalTestFramework\Allure;
 
 use Magento\FunctionalTestingFramework\Allure\AllureHelper;
 use Magento\FunctionalTestingFramework\Allure\Event\AddUniqueAttachmentEvent;
 use PHPUnit\Framework\TestCase;
+use ReflectionProperty;
 use Yandex\Allure\Adapter\Allure;
 use Yandex\Allure\Adapter\AllureException;
 use Yandex\Allure\Adapter\Event\StepFinishedEvent;
@@ -16,25 +19,32 @@
 
 class AllureHelperTest extends TestCase
 {
-    const MOCK_FILENAME = 'filename';
+    private const MOCK_FILENAME = 'filename';
 
     /**
-     * Clear Allure Lifecycle
+     * Clear Allure Lifecycle.
+     *
+     * @return void
      */
-    public function tearDown(): void
+    protected function tearDown(): void
     {
         Allure::setDefaultLifecycle();
+        $instanceProperty = new ReflectionProperty(AddUniqueAttachmentEvent::class, 'instance');
+        $instanceProperty->setAccessible(true);
+        $instanceProperty->setValue(null);
     }
 
     /**
-     * AddAttachmentToStep should add an attachment to the current step
+     * The AddAttachmentToStep should add an attachment to the current step.
+     *
+     * @return void
      * @throws AllureException
      */
-    public function testAddAttachmentToStep()
+    public function testAddAttachmentToStep(): void
     {
-        $this->mockAttachmentWriteEvent();
-        $expectedData = "string";
-        $expectedCaption = "caption";
+        $expectedData = 'string';
+        $expectedCaption = 'caption';
+        $this->mockAttachmentWriteEvent($expectedData, $expectedCaption);
 
         //Prepare Allure lifecycle
         Allure::lifecycle()->fire(new StepStartedEvent('firstStep'));
@@ -49,14 +59,16 @@ public function testAddAttachmentToStep()
     }
 
     /**
-     * AddAttachmentToLastStep should add an attachment only to the last step
+     * The AddAttachmentToLastStep should add an attachment only to the last step.
+     *
+     * @return void
      * @throws AllureException
      */
-    public function testAddAttachmentToLastStep()
+    public function testAddAttachmentToLastStep(): void
     {
-        $this->mockAttachmentWriteEvent();
-        $expectedData = "string";
-        $expectedCaption = "caption";
+        $expectedData = 'string';
+        $expectedCaption = 'caption';
+        $this->mockAttachmentWriteEvent($expectedData, $expectedCaption);
 
         //Prepare Allure lifecycle
         Allure::lifecycle()->fire(new StepStartedEvent('firstStep'));
@@ -85,14 +97,15 @@ public function testAddAttachmentToLastStep()
     }
 
     /**
-     * AddAttachment actions should have files with different attachment names
+     * The AddAttachment actions should have files with different attachment names.
+     *
+     * @return void
      * @throws AllureException
      */
-    public function testAddAttachementUniqueName()
+    public function testAddAttachmentUniqueName(): void
     {
-        $expectedData = "string";
-        $expectedCaption = "caption";
-
+        $expectedData = 'string';
+        $expectedCaption = 'caption';
         $this->mockCopyFile($expectedData, $expectedCaption);
 
         //Prepare Allure lifecycle
@@ -110,27 +123,52 @@ public function testAddAttachementUniqueName()
     }
 
     /**
-     * Mock entire attachment writing mechanisms
+     * Mock entire attachment writing mechanisms.
+     *
+     * @param string $filePathOrContents
+     * @param string $caption
+     *
+     * @return void
      */
-    public function mockAttachmentWriteEvent()
+    private function mockAttachmentWriteEvent(string $filePathOrContents, string $caption): void
     {
-        $this->createMock(AddUniqueAttachmentEvent::class)
-            ->expects($this->any())
+        $mockInstance = $this->getMockBuilder(AddUniqueAttachmentEvent::class)
+            ->setConstructorArgs([$filePathOrContents, $caption])
+            ->disallowMockingUnknownTypes()
+            ->onlyMethods(['getAttachmentFileName'])
+            ->getMock();
+
+        $mockInstance
             ->method('getAttachmentFileName')
             ->willReturn(self::MOCK_FILENAME);
+
+        $instanceProperty = new ReflectionProperty(AddUniqueAttachmentEvent::class, 'instance');
+        $instanceProperty->setAccessible(true);
+        $instanceProperty->setValue($mockInstance, $mockInstance);
     }
 
     /**
-     * Mock only file writing mechanism
-     * @throws \ReflectionException
+     * Mock only file writing mechanism.
+     *
+     * @param string $filePathOrContents
+     * @param string $caption
+     *
+     * @return void
      */
-    public function mockCopyFile(string $expectedData, string $expectedCaption)
+    private function mockCopyFile(string $filePathOrContents, string $caption): void
     {
-        $addUniqueAttachmentEvent = new AddUniqueAttachmentEvent($expectedData, $expectedCaption);
-        $reflection = new \ReflectionClass(AddUniqueAttachmentEvent::class);
-        $reflectionMethod = $reflection->getMethod('copyFile');
-        $reflectionMethod->setAccessible(true);
-        $output = $reflectionMethod->invoke($addUniqueAttachmentEvent);
-        $this->assertEquals(true, $output);
+        $mockInstance = $this->getMockBuilder(AddUniqueAttachmentEvent::class)
+            ->setConstructorArgs([$filePathOrContents, $caption])
+            ->disallowMockingUnknownTypes()
+            ->onlyMethods(['copyFile'])
+            ->getMock();
+
+        $mockInstance
+            ->method('copyFile')
+            ->willReturn(true);
+
+        $instanceProperty = new ReflectionProperty(AddUniqueAttachmentEvent::class, 'instance');
+        $instanceProperty->setAccessible(true);
+        $instanceProperty->setValue($mockInstance, $mockInstance);
     }
 }
diff --git a/src/Magento/FunctionalTestingFramework/Allure/AllureHelper.php b/src/Magento/FunctionalTestingFramework/Allure/AllureHelper.php
@@ -3,34 +3,40 @@
  * Copyright © Magento, Inc. All rights reserved.
  * See COPYING.txt for license details.
  */
+declare(strict_types=1);
+
 namespace Magento\FunctionalTestingFramework\Allure;
 
 use Magento\FunctionalTestingFramework\Allure\Event\AddUniqueAttachmentEvent;
 use Yandex\Allure\Adapter\Allure;
-use Yandex\Allure\Adapter\Event\AddAttachmentEvent;
+use Yandex\Allure\Adapter\AllureException;
 
 class AllureHelper
 {
     /**
-     * Adds attachment to the current step
+     * Adds attachment to the current step.
+     *
      * @param mixed  $data
      * @param string $caption
-     * @throws \Yandex\Allure\Adapter\AllureException
+     *
      * @return void
+     * @throws AllureException
      */
-    public static function addAttachmentToCurrentStep($data, $caption)
+    public static function addAttachmentToCurrentStep($data, $caption): void
     {
-        Allure::lifecycle()->fire(new AddUniqueAttachmentEvent($data, $caption));
+        Allure::lifecycle()->fire(AddUniqueAttachmentEvent::getInstance($data, $caption));
     }
 
     /**
      * Adds Attachment to the last executed step.
      * Use this when adding attachments outside of an $I->doSomething() step/context.
+     *
      * @param mixed  $data
      * @param string $caption
+     *
      * @return void
      */
-    public static function addAttachmentToLastStep($data, $caption)
+    public static function addAttachmentToLastStep($data, $caption): void
     {
         $rootStep = Allure::lifecycle()->getStepStorage()->getLast();
         $trueLastStep = array_last($rootStep->getSteps());
@@ -40,7 +46,7 @@ public static function addAttachmentToLastStep($data, $caption)
             return;
         }
         
-        $attachmentEvent = new AddUniqueAttachmentEvent($data, $caption);
+        $attachmentEvent = AddUniqueAttachmentEvent::getInstance($data, $caption);
         $attachmentEvent->process($trueLastStep);
     }
 }
diff --git a/src/Magento/FunctionalTestingFramework/Allure/Event/AddUniqueAttachmentEvent.php b/src/Magento/FunctionalTestingFramework/Allure/Event/AddUniqueAttachmentEvent.php
@@ -1,35 +1,63 @@
 <?php
-
 /**
  * Copyright © Magento, Inc. All rights reserved.
  * See COPYING.txt for license details.
  */
+declare(strict_types=1);
+
 namespace Magento\FunctionalTestingFramework\Allure\Event;
 
 use Symfony\Component\Mime\MimeTypes;
 use Yandex\Allure\Adapter\AllureException;
 use Yandex\Allure\Adapter\Event\AddAttachmentEvent;
 
-const DEFAULT_FILE_EXTENSION = 'txt';
-const DEFAULT_MIME_TYPE = 'text/plain';
-
 class AddUniqueAttachmentEvent extends AddAttachmentEvent
 {
+    private const DEFAULT_FILE_EXTENSION = 'txt';
+    private const DEFAULT_MIME_TYPE = 'text/plain';
+
     /**
-     * @var string
+     * @var AddUniqueAttachmentEvent|null
      */
-    private $type;
+    private static $instance;
 
     /**
-     * Near copy of parent function, added uniqid call for filename to prevent buggy allure behavior
-     * @param string $filePathOrContents
+     * An alternative way to instantiate an instance of this class. Used to mock this class object in unit tests.
+     *
+     * @param mixed       $filePathOrContents
+     * @param string      $caption
+     * @param string|null $type
+     *
+     * @return AddUniqueAttachmentEvent
+     */
+    public static function getInstance(
+        $filePathOrContents,
+        string $caption,
+        ?string $type = null
+    ): AddUniqueAttachmentEvent {
+        if (!self::$instance) {
+            self::$instance = new AddUniqueAttachmentEvent(
+                $filePathOrContents,
+                $caption,
+                $type
+            );
+        }
+        return self::$instance;
+    }
+
+    /**
+     * Near copy of parent function, added uniqid call for filename to prevent buggy allure behavior.
+     *
+     * @param mixed  $filePathOrContents
      * @param string $type
+     *
      * @return string
      * @throws AllureException
      */
-    public function getAttachmentFileName($filePathOrContents, $type)
+    public function getAttachmentFileName($filePathOrContents, $type): string
     {
         $filePath = $filePathOrContents;
+
         if (!file_exists($filePath) || !is_file($filePath)) {
             //Save contents to temporary file
             $filePath = tempnam(sys_get_temp_dir(), 'allure-attachment');
@@ -40,13 +68,11 @@ public function getAttachmentFileName($filePathOrContents, $type)
 
         if (!isset($type)) {
             $type = $this->guessFileMimeType($filePath);
-            $this->type = $type;
         }
-
         $fileExtension = $this->guessFileExtension($type);
-
         $fileSha1 = uniqid(sha1_file($filePath));
         $outputPath = parent::getOutputPath($fileSha1, $fileExtension);
+
         if (!$this->copyFile($filePath, $outputPath)) {
             throw new AllureException("Failed to copy attachment from $filePath to $outputPath.");
         }
@@ -56,51 +82,48 @@ public function getAttachmentFileName($filePathOrContents, $type)
 
     /**
      * Copies file from one path to another. Wrapper for mocking in unit test.
+     *
      * @param string $filePath
      * @param string $outputPath
+     *
      * @return boolean
      */
-    private function copyFile($filePath, $outputPath)
+    public function copyFile(string $filePath, string $outputPath): bool
     {
         return copy($filePath, $outputPath);
     }
 
     /**
-     * Copy of parent private function
+     * Copy of parent private function.
+     *
      * @param string $filePath
+     *
      * @return string
      */
-    private function guessFileMimeType($filePath)
+    private function guessFileMimeType(string $filePath): string
     {
         $type = MimeTypes::getDefault()->guessMimeType($filePath);
+
         if (!isset($type)) {
-            return DEFAULT_MIME_TYPE;
+            return self::DEFAULT_MIME_TYPE;
         }
         return $type;
     }
 
     /**
-     * Copy of parent private function
+     * Copy of parent private function.
+     *
      * @param string $mimeType
+     *
      * @return string
      */
-    private function guessFileExtension($mimeType)
+    private function guessFileExtension(string $mimeType): string
     {
         $candidate = MimeTypes::getDefault()->getExtensions($mimeType);
+
         if (empty($candidate)) {
-            return DEFAULT_FILE_EXTENSION;
+            return self::DEFAULT_FILE_EXTENSION;
         }
         return reset($candidate);
     }
-
-    /**
-     * Copy of parent private function
-     * @param string $sha1
-     * @param string $extension
-     * @return string
-     */
-    public function getOutputFileName($sha1, $extension)
-    {
-        return $sha1 . '-attachment.' . $extension;
-    }
 }
