AnnotationExtractorTest.php

Go to the documentation of this file.

<?php
namespace tests\unit\Magento\FunctionalTestFramework\Test\Util;

use AspectMock\Proxy\Verifier;
use AspectMock\Test as AspectMock;
use Magento\FunctionalTestingFramework\Test\Util\AnnotationExtractor;
use Monolog\Handler\TestHandler;
use Monolog\Logger;
use PHPUnit\Framework\TestCase;
use tests\unit\Util\TestLoggingUtil;

class AnnotationExtractorTest extends TestCase
{
    public function setUp()
    {
        TestLoggingUtil::getInstance()->setMockLoggingUtil();
    }

    public function testExtractAnnotations()
    {
        // Test Data
        $testAnnotations = [
            "nodeName" => "annotations",
            "features" => [
                [
                    "nodeName" => "features",
                    "value" => "TestFeatures"
                ]
            ],
            "stories" => [
                [
                    "nodeName" => "stories",
                    "value" => "TestStories"
                ]
            ],
            "description" => [
                [
                    "nodeName" => "description",
                    "value" => "TestDescription"
                ]
            ],
            "severity" => [
                [
                    "nodeName" => "severity",
                    "value" => "CRITICAL"
                ]
            ],
            "group" => [
                [
                    "nodeName" => "group",
                    "value" => "TestGroup"
                ]
            ],
        ];
        // Perform Test
        $extractor = new AnnotationExtractor();
        $returnedAnnotations = $extractor->extractAnnotations($testAnnotations, "testFileName");

        // Asserts

        $this->assertEquals("TestFeatures", $returnedAnnotations['features'][0]);
        $this->assertEquals("TestStories", $returnedAnnotations['stories'][0]);
        $this->assertEquals("TestDescription", $returnedAnnotations['description'][0]);
        $this->assertEquals("CRITICAL", $returnedAnnotations['severity'][0]);
        $this->assertEquals("TestGroup", $returnedAnnotations['group'][0]);
    }

    public function testMissingAnnotations()
    {
        // Test Data, missing title, description, and severity
        $testAnnotations = [
            "nodeName" => "annotations",
            "features" => [
                [
                    "nodeName" => "features",
                    "value" => "TestFeatures"
                ]
            ],
            "stories" => [
                [
                    "nodeName" => "stories",
                    "value" => "TestStories"
                ]
            ],
            "group" => [
                [
                    "nodeName" => "group",
                    "value" => "TestGroup"
                ]
            ],
        ];
        // Perform Test
        $extractor = new AnnotationExtractor();
        $returnedAnnotations = $extractor->extractAnnotations($testAnnotations, "testFileName");

        // Asserts
        TestLoggingUtil::getInstance()->validateMockLogStatement(
            'warning',
            'DEPRECATION: Test testFileName is missing required annotations.',
            [
                'testName' => 'testFileName',
                'missingAnnotations' => "title, description, severity"
            ]
        );
    }

    public function testTestCaseIdUniqueness()
    {
        // Test Data
        $firstTestAnnotation = [
            "nodeName" => "annotations",
            "features" => [
                [
                    "nodeName" => "features",
                    "value" => "TestFeatures"
                ]
            ],
            "stories" => [
                [
                    "nodeName" => "stories",
                    "value" => "TestStories"
                ]
            ],
            "title" => [
                [
                    "nodeName" => "title",
                    "value" => "TEST TITLE"
                ]
            ],
            "severity" => [
                [
                    "nodeName" => "severity",
                    "value" => "CRITICAL"
                ]
            ],
            "testCaseId" => [
                [
                    "nodeName" => "testCaseId",
                    "value" => "MQE-0001"
                ]
            ],
        ];
        $secondTestannotation = [
            "nodeName" => "annotations",
            "features" => [
                [
                    "nodeName" => "features",
                    "value" => "TestFeatures"
                ]
            ],
            "stories" => [
                [
                    "nodeName" => "stories",
                    "value" => "TestStories"
                ]
            ],
            "title" => [
                [
                    "nodeName" => "title",
                    "value" => "TEST TITLE"
                ]
            ],
            "severity" => [
                [
                    "nodeName" => "severity",
                    "value" => "CRITICAL"
                ]
            ],
            "testCaseId" => [
                [
                    "nodeName" => "testCaseId",
                    "value" => "MQE-0001"
                ]
            ],
        ];
        // Perform Test
        $extractor = new AnnotationExtractor();
        $extractor->extractAnnotations($firstTestAnnotation, "firstTest");
        $extractor->extractAnnotations($secondTestannotation, "secondTest");

        //Expect Exception
        $this->expectException(\Magento\FunctionalTestingFramework\Exceptions\XmlException::class);
        $this->expectExceptionMessage("TestCaseId and Title pairs must be unique:\n\n" .
            "TestCaseId: 'MQE-0001' Title: 'TEST TITLE' in Tests 'firstTest', 'secondTest'");

        //Trigger Exception
        $extractor->validateTestCaseIdTitleUniqueness();
    }

    public static function tearDownAfterClass()
    {
        TestLoggingUtil::getInstance()->clearMockLoggingUtil();
    }
}