MC-38191: Implement check for patch availability in MQP

app/autoload.php

@@ -0,0 +1,11 @@
+<?php
+/**
+ * Copyright © Magento, Inc. All rights reserved.
+ * See COPYING.txt for license details.
+ */
+
+$vendorAutoloadPath = __DIR__ . '/../vendor/autoload.php';
+if (!file_exists($vendorAutoloadPath)) {
+    throw new RuntimeException('Required file \'autoload.php\' was not found.');
+}
+require $vendorAutoloadPath;

app/bootstrap.php

@@ -12,3 +12,5 @@
 define('VAR_DIR_NAME', 'var');
 define('UPLOAD_PATH', 'var/uploads/');
 define('STATS_PATH', 'var/stats/');
+
+require_once __DIR__ . '/autoload.php';

app/code/Cache/File.php

@@ -1,6 +1,13 @@
 <?php
+/**
+ * Copyright © Magento, Inc. All rights reserved.
+ * See COPYING.txt for license details.
+ */
+declare(strict_types=1);
 
-class Cache_File
+namespace Magento\PatchChecker\Cache;
+
+class File
 {
     const CACHE_DIR_NAME = 'cache';
 
@@ -24,7 +31,7 @@ public function __construct()
             } elseif (!is_dir($cachePath) || !is_writable($cachePath)) {
                 $cachePath = '/tmp';
                 if (!$this->validateWritablePath($cachePath)) {
-                    throw new Exception('Cache dir is not writable.');
+                    throw new \Exception('Cache dir is not writable.');
                 }
             }
         }

app/code/Deploy/Instance.php

@@ -1,6 +1,13 @@
 <?php
+/**
+ * Copyright © Magento, Inc. All rights reserved.
+ * See COPYING.txt for license details.
+ */
+declare(strict_types=1);
 
-class Deploy_Instance
+namespace Magento\PatchChecker\Deploy;
+
+class Instance
 {
     const INSTANCE_TYPE_GIT      = 'git';
     const INSTANCE_TYPE_COMPOSER = 'composer';

app/code/Deploy/InstanceManager.php

@@ -1,8 +1,13 @@
 <?php
+/**
+ * Copyright © Magento, Inc. All rights reserved.
+ * See COPYING.txt for license details.
+ */
+declare(strict_types=1);
 
-require_once 'app/code/Deploy/Instance.php';
+namespace Magento\PatchChecker\Deploy;
 
-class Deploy_InstanceManager
+class InstanceManager
 {
     private $instanceList = [];
 
@@ -24,7 +29,7 @@ private function generateInstanceList()
             foreach ($groupInstanceList as $instanceName => $instancePath) {
                 $this->instanceList[$groupName][] = is_int($instancePath)
                     ? $instancePath
-                    : new Deploy_Instance($instanceName, $instancePath);
+                    : new Instance($instanceName, $instancePath);
             }
         }
 

app/code/Design.php

@@ -1,6 +1,13 @@
 <?php
+/**
+ * Copyright © Magento, Inc. All rights reserved.
+ * See COPYING.txt for license details.
+ */
+declare(strict_types=1);
 
-require_once 'app/code/Cache/File.php';
+namespace Magento\PatchChecker;
+
+use Magento\PatchChecker\Cache\File;
 
 class Design
 {
@@ -32,7 +39,7 @@ public function generateStaticHash()
 
     public function getStaticHash()
     {
-        $cache = new Cache_File();
+        $cache = new File();
         $content = $cache->loadCache(self::STATIC_HASH_CACHE_ID);
         if (!$content) {
             $content = $this->generateStaticHash();

app/code/File/Filesystem.php

@@ -1,4 +1,11 @@
 <?php
+/**
+ * Copyright © Magento, Inc. All rights reserved.
+ * See COPYING.txt for license details.
+ */
+declare(strict_types=1);
+
+namespace Magento\PatchChecker\File;
 
 class Filesystem
 {

app/code/File/Uploader.php

@@ -1,6 +1,15 @@
 <?php
+/**
+ * Copyright © Magento, Inc. All rights reserved.
+ * See COPYING.txt for license details.
+ */
+declare(strict_types=1);
 
-class File_Uploader
+namespace Magento\PatchChecker\File;
+
+use Magento\PatchChecker\Patch\Converter;
+
+class Uploader
 {
     protected $_maximumFileSize = 15728640; // 15Mb
 
@@ -94,8 +103,7 @@ public function upload()
                 $newFileName[$fileId] = $this->getHashedFileName($name) . '.patch';
                 $patchPath = $this->_uploadPath . $newFileName[$fileId];
                 if (move_uploaded_file($_FILES[$fileElementName]['tmp_name'][$fileId], $patchPath)) {
-                    require_once 'app/code/Patch/Converter.php';
-                    $converter = new Patch_Converter();
+                    $converter = new Converter();
                     $converter->preparePatch($patchPath);
                 } else {
                     $error[$fileId][] = 'Unable to move uploaded file from tmp folder.';

app/code/Patch/AbstractChecker.php

@@ -0,0 +1,73 @@
+<?php
+/**
+ * Copyright © Magento, Inc. All rights reserved.
+ * See COPYING.txt for license details.
+ */
+declare(strict_types=1);
+
+namespace Magento\PatchChecker\Patch;
+
+use Magento\PatchChecker\Deploy\Instance;
+use Magento\PatchChecker\Deploy\InstanceManager;
+
+/**
+ * Abstract patch checker
+ */
+abstract class AbstractChecker
+{
+    const PATCH_APPLY_RESULT_FAILED     = 0;
+    const PATCH_APPLY_RESULT_SUCCESSFUL = 1;
+    const PATCH_APPLY_RESULT_MERGED     = 2;
+
+    /**
+     * @var InstanceManager
+     */
+    private $instanceManager;
+
+    /**
+     * @param InstanceManager $instanceManager
+     */
+    public function __construct(
+        InstanceManager $instanceManager
+    ) {
+        $this->instanceManager = $instanceManager;
+    }
+
+    /**
+     * Return patch status for each configured version.
+     *
+     * @param string $patch
+     * @return array
+     */
+    public function check(string $patch)
+    {
+        $result = [];
+        foreach ($this->instanceManager->getInstanceList() as $groupName => $groupInstanceList) {
+            foreach ($groupInstanceList as $instance) {
+                if (is_int($instance)) {
+                    for ($i = 0; $i < $instance; $i++) {
+                        $result[$groupName][] = ['instance_name' => 'n/a', 'result' => 'n/a'];
+                    }
+                } elseif ($instance->getInstanceType() == Instance::INSTANCE_TYPE_INVALID) {
+                    $result[$groupName][] = ['instance_name' => $instance->getInstanceName(), 'result' => 'n/a'];
+                } else {
+                    $result[$groupName][] = [
+                        'instance_name'  => $instance->getInstanceName(),
+                        'result' => $this->getResult($instance, $patch)
+                    ];
+                }
+            }
+        }
+
+        return $result;
+    }
+
+    /**
+     * Get status of the patch
+     *
+     * @param Instance $instance
+     * @param string $patch
+     * @return array|string
+     */
+    abstract public function getResult(Instance $instance, string $patch);
+}

app/code/Patch/Check/Strategy/AbstractStrategy.php

@@ -1,4 +1,13 @@
 <?php
+/**
+ * Copyright © Magento, Inc. All rights reserved.
+ * See COPYING.txt for license details.
+ */
+declare(strict_types=1);
+
+namespace Magento\PatchChecker\Patch\Check\Strategy;
+
+use Magento\PatchChecker\Patch\Checker;
 
 abstract class AbstractStrategy implements StrategyInterface
 {
@@ -47,17 +56,19 @@ protected function executeCommand($command)
     public function check($patchPath, $instancePath)
     {
         if (!$patchPath) {
-            return false;
+            return Checker::PATCH_APPLY_RESULT_FAILED;
         }
 
         $result = $this->executeCommand($this->getCommand($patchPath, $instancePath));
         if (!$result) {
-            return Patch_Checker::PATCH_APPLY_RESULT_SUCCESSFUL;
+            return Checker::PATCH_APPLY_RESULT_SUCCESSFUL;
         }
 
         $result = $this->executeCommand($this->getCommand($patchPath, $instancePath, true));
         if (!$result) {
-            return Patch_Checker::PATCH_APPLY_RESULT_MERGED;
+            return Checker::PATCH_APPLY_RESULT_MERGED;
         }
+
+        return Checker::PATCH_APPLY_RESULT_FAILED;
     }
 }

app/code/Patch/Check/Strategy/GitApplyStrategy.php

@@ -1,4 +1,11 @@
 <?php
+/**
+ * Copyright © Magento, Inc. All rights reserved.
+ * See COPYING.txt for license details.
+ */
+declare(strict_types=1);
+
+namespace Magento\PatchChecker\Patch\Check\Strategy;
 
 class GitApplyStrategy extends AbstractStrategy
 {

app/code/Patch/Check/Strategy/PatchStrategy.php

@@ -1,4 +1,11 @@
 <?php
+/**
+ * Copyright © Magento, Inc. All rights reserved.
+ * See COPYING.txt for license details.
+ */
+declare(strict_types=1);
+
+namespace Magento\PatchChecker\Patch\Check\Strategy;
 
 class PatchStrategy extends AbstractStrategy
 {

app/code/Patch/Check/Strategy/StrategyInterface.php

@@ -1,4 +1,11 @@
 <?php
+/**
+ * Copyright © Magento, Inc. All rights reserved.
+ * See COPYING.txt for license details.
+ */
+declare(strict_types=1);
+
+namespace Magento\PatchChecker\Patch\Check\Strategy;
 
 interface StrategyInterface
 {

app/code/Patch/Check/StrategyManager.php

@@ -1,9 +1,15 @@
 <?php
+/**
+ * Copyright © Magento, Inc. All rights reserved.
+ * See COPYING.txt for license details.
+ */
+declare(strict_types=1);
 
-require_once 'app/code/Patch/Check/Strategy/StrategyInterface.php';
-require_once 'app/code/Patch/Check/Strategy/AbstractStrategy.php';
-require_once 'app/code/Patch/Check/Strategy/PatchStrategy.php';
-require_once 'app/code/Patch/Check/Strategy/GitApplyStrategy.php';
+namespace Magento\PatchChecker\Patch\Check;
+
+use Magento\PatchChecker\Patch\Check\Strategy\GitApplyStrategy;
+use Magento\PatchChecker\Patch\Check\Strategy\PatchStrategy;
+use Magento\PatchChecker\Patch\Check\Strategy\StrategyInterface;
 
 class StrategyManager
 {