Merge pull request #41 from magento-l3/ACP2E-932

ACP2E-932: [Infra] Integrate EAT and Jenkins SVC

Author: sidolov

dev/tests/Unit/Reporter/HtmlTargetDecoratorTest.php

@@ -0,0 +1,73 @@
+<?php
+
+namespace Magento\SemanticVersionChecker\Reporter;
+
+use PHPUnit\Framework\TestCase;
+use Symfony\Component\Console\Input\InputInterface;
+
+class HtmlTargetDecoratorTest extends TestCase
+{
+    /**
+     * @dataProvider dataProviderTestUrl
+     */
+    public function testUrl(bool $hasOption, string $target, string $context, string $urlJson, string $expected): void
+    {
+        $input = $this->getMockBuilder(InputInterface::class)->getMockForAbstractClass();
+        $input->expects($this->once())->method('hasOption')->with('report-html-target-url')->willReturn($hasOption);
+        if ($hasOption) {
+            $input->expects($this->once())->method('getOption')->with('report-html-target-url')->willReturn($urlJson);
+        } else {
+            $input->expects($this->never())->method('getOption');
+        }
+        $result = HtmlTargetDecorator::url($target, $context, $input);
+        $this->assertEquals($expected, $result);
+    }
+
+    public function dataProviderTestUrl()
+    {
+        return [
+            'target-context-class' => [
+                true,
+                'Magento\Framework\Registry',
+                'class',
+                '[{"reportTypes": ["interface", "class"], "url": "https://localhost/?target=%s"}]',
+                '<a href="https://localhost/?target=TWFnZW50b1xGcmFtZXdvcmtcUmVnaXN0cnk=" target="_blank">Magento\Framework\Registry</a>'
+            ],
+            'target-context-class-array' => [
+                true,
+                'Magento\Framework\Registry',
+                'class',
+                '[{"reportTypes": ["mftf"], "url": "https://localhost/?target=%s"}, {"reportTypes": ["class"], "url": "https://localhost/?target=%s"}]',
+                '<a href="https://localhost/?target=TWFnZW50b1xGcmFtZXdvcmtcUmVnaXN0cnk=" target="_blank">Magento\Framework\Registry</a>'
+            ],
+            'target-context-mftf' => [
+                true,
+                'Magento\Framework\Registry',
+                'mftf',
+                '[{"reportTypes": ["interface", "class"], "url": "https://localhost/?target=%s"}]',
+                'Magento\Framework\Registry'
+            ],
+            'empty-json' => [
+                true,
+                'Magento\Framework\Registry::$someProperty',
+                'class',
+                '',
+                'Magento\Framework\Registry::$someProperty'
+            ],
+            'broken-json' => [
+                true,
+                'Magento\Framework\Registry',
+                'class',
+                '[{"reportTypes": ["interface", "class"]',
+                'Magento\Framework\Registry'
+            ],
+            'has-no-option' => [
+                false,
+                'Magento\Framework\Registry',
+                'class',
+                '',
+                'Magento\Framework\Registry'
+            ],
+        ];
+    }
+}

src/Console/Command/CompareSourceCommand.php

@@ -97,6 +97,13 @@ protected function configure()
                     . '. Example: --report-type=' . ReportTypes::MFTF . PHP_EOL,
                     []
                 ),
+                new InputOption(
+                    'report-html-target-url',
+                    '',
+                    InputOption::VALUE_OPTIONAL,
+                    'Json data to create url for Target field in HTML report of a specific type. Example: [{"reportTypes": ["interface", "class"], "url": "https://example.com/?target=%s"}]',
+                    ''
+                ),
             ]);
     }
 

src/Reporter/HtmlDbSchemaReporter.php

@@ -137,7 +137,7 @@ protected function outputTable(OutputInterface $output, Report $report, $context
                 } elseif (substr($location, 0, strlen($sourceAfterDir)) == $sourceAfterDir) {
                     $location = substr($location, strlen($sourceAfterDir));
                 }
-
+                $target = HtmlTargetDecorator::url($target, $context, $this->input);
                 $output->writeln(
                     '<tr class="text-' . ($level > $allowedChangeLevel  ? 'danger' : 'success') .
                     '"><td>' . $levelStr . '</td><td>' . $target . '<br/>' . $location . '</td><td>' . $code . ' ' .

src/Reporter/HtmlTargetDecorator.php

@@ -0,0 +1,37 @@
+<?php
+
+namespace Magento\SemanticVersionChecker\Reporter;
+
+use Symfony\Component\Console\Input\InputInterface;
+
+/**
+ * Html decorator for Target field of the report
+ */
+class HtmlTargetDecorator
+{
+    private static string $optionName = 'report-html-target-url';
+
+    /**
+     * Create a link tag for specific report types
+     *
+     * @param string $target
+     * @param string $context
+     * @param InputInterface $input
+     * @return string
+     */
+    public static function url(string $target, string $context, InputInterface $input): string
+    {
+        if (!$input->hasOption(self::$optionName)) {
+            return $target;
+        }
+        $urlContextJson = $input->getOption(self::$optionName);
+        foreach (@json_decode($urlContextJson, true) ?? [] as $urlContext) {
+            if (!in_array($context, $urlContext['reportTypes']) || !$urlContext['url']) {
+                continue;
+            }
+            $href = sprintf($urlContext['url'], base64_encode($target));
+            $target = sprintf('<a href="%s" target="_blank">%s</a>', $href, $target);
+        }
+        return $target;
+    }
+}