Merge pull request #3 from J-T-McC/refactor

Refactoring

Author: J-T-McC

README.md

@@ -1,5 +1,7 @@
 # Atomic Deployment Package for Laravel Framework
-![run-tests](https://github.com/J-T-McC/laravel-atomic-deployments/workflows/run-tests/badge.svg) [![StyleCI](https://github.styleci.io/repos/330310979/shield?branch=main)](https://github.styleci.io/repos/330310979?branch=main)
+![run-tests](https://github.com/J-T-McC/laravel-atomic-deployments/workflows/run-tests/badge.svg)
+[![StyleCI](https://github.styleci.io/repos/330310979/shield?branch=main)](https://github.styleci.io/repos/330310979?branch=main)
+[![License: MIT](https://img.shields.io/badge/License-MIT-brightgreen.svg)](https://opensource.org/licenses/MIT)
 
 The purpose of this package is to introduce local zero-downtime deployments into a laravel application.
 
@@ -43,36 +45,45 @@ return [
 
     /**
      * Symbolic link to the current deployed build
-     * This path should be used for schedules and setting your web root
+     * This path should be used for schedules and setting your web root.
      */
     'deployment-link' => env('ATM_DEPLOYMENT_LINK'),
 
     /**
      * The primary build folder
-     * This folder is where all deployments ran and ultimately copied to a deployment directory
+     * This folder is where all deployments ran and ultimately copied to a deployment directory.
      */
     'build-path' => env('ATM_BUILD'),
 
     /**
      * Production build directory
      * Builds are copied here and linked for deployment
-     * Ensure this directory has the required permissions to allow php and your webserver to run your application here
+     * Ensure this directory has the required permissions to allow php and your webserver to run your application here.
      */
     'deployments-path' => env('ATM_DEPLOYMENTS'),
 
     /**
      * Max number of build directories allowed
-     * Once limit is hit, old deployments will be removed automatically after a successful build
+     * Once limit is hit, old deployments will be removed automatically after a successful build.
      */
     'build-limit' => 10,
 
     /**
-     * Migrate files|folders from the outgoing production build to your new release using a relative path and pattern
+     * Migrate files|folders from the outgoing production build to your new release using a relative path and pattern.
+     *
      * @see https://www.php.net/manual/en/function.glob.php
      */
     'migrate' => [
-//        'storage/framework/sessions/*',
-    ]
+        //        'storage/framework/sessions/*',
+    ],
+
+    /**
+     * Deployment class used.
+     *
+     * Add custom deployments by implementing @see \JTMcC\AtomicDeployments\Interfaces\DeploymentInterface
+     * and adding your class to this config property
+     */
+    'deployment-class' => \JTMcC\AtomicDeployments\Services\Deployment::class,
 
 ];
 ```

config/atomic-deployments.php

@@ -36,4 +36,12 @@
         //        'storage/framework/sessions/*',
     ],
 
+    /**
+     * Deployment class used.
+     *
+     * Add custom deployments by implementing @see \JTMcC\AtomicDeployments\Interfaces\DeploymentInterface
+     * and adding your class to this config property
+     */
+    'deployment-class' => \JTMcC\AtomicDeployments\Services\Deployment::class,
+
 ];

src/AtomicDeploymentsServiceProvider.php

@@ -5,6 +5,8 @@
 use Illuminate\Support\ServiceProvider;
 use JTMcC\AtomicDeployments\Commands\DeployCommand;
 use JTMcC\AtomicDeployments\Commands\ListCommand;
+use JTMcC\AtomicDeployments\Interfaces\DeploymentInterface;
+use JTMcC\AtomicDeployments\Services\AtomicDeploymentService;
 
 class AtomicDeploymentsServiceProvider extends ServiceProvider
 {
@@ -15,9 +17,19 @@ public function boot()
 
     public function register()
     {
-        $this->registerPublishables();
         $this->mergeConfigFrom(__DIR__.'/../config/atomic-deployments.php', 'atomic-deployments');
+        $this->registerPublishables();
         $this->registerCommands();
+
+        $this->app->bind(DeploymentInterface::class, config('atomic-deployments.deployment-class'));
+
+        $this->app->bind(AtomicDeploymentService::class, function ($app, $params) {
+            if (empty($params) || (count($params) && !is_a($params[0], DeploymentInterface::class))) {
+                array_unshift($params, $app->make(DeploymentInterface::class));
+            }
+
+            return new AtomicDeploymentService(...$params);
+        });
     }
 
     protected function registerPublishables(): void

src/Commands/DeployCommand.php

@@ -5,7 +5,8 @@
 use JTMcC\AtomicDeployments\Events\DeploymentSuccessful;
 use JTMcC\AtomicDeployments\Helpers\ConsoleOutput;
 use JTMcC\AtomicDeployments\Models\AtomicDeployment;
-use JTMcC\AtomicDeployments\Services\AtomicDeployments;
+use JTMcC\AtomicDeployments\Services\AtomicDeploymentService;
+use JTMcC\AtomicDeployments\Services\Deployment;
 use JTMcC\AtomicDeployments\Services\Output;
 
 class DeployCommand extends BaseCommand
@@ -21,48 +22,47 @@ public function handle()
     {
         Output::alert('Running Atomic Deployment');
 
-        $buildPath = config('atomic-deployments.build-path');
-        $deploymentLink = config('atomic-deployments.deployment-link');
-        $deploymentsPath = config('atomic-deployments.deployments-path');
         $migrate = config('atomic-deployments.migrate', []);
-
-        $atomicDeployment = (new AtomicDeployments(
-            $deploymentLink,
-            $deploymentsPath,
-            $buildPath,
-            $migrate,
-            $this->option('dry-run')
-        ));
+        $dryRun = $this->option('dry-run');
 
         if ($hash = $this->option('hash')) {
             Output::info("Updating symlink to previous build: {$hash}");
 
-            $deploymentModel = AtomicDeployment::successful()->where('commit_hash', $hash)->orderBy('id', 'desc')->first();
+            $deploymentModel = AtomicDeployment::successful()->where('commit_hash', $hash)->first();
 
             if (!$deploymentModel || !$deploymentModel->hasDeployment) {
                 Output::warn("Build not found for hash: {$hash}");
             } else {
+                $atomicDeployment = AtomicDeploymentService::create(
+                    new Deployment($deploymentModel),
+                    $migrate,
+                    $dryRun
+                );
+
                 try {
-                    $atomicDeployment->linkDeployment(
-                        $deploymentModel->deployment_link,
-                        $deploymentModel->deployment_path
-                    );
-                    $atomicDeployment->confirmSymbolicLink($deploymentModel->deployment_path);
+                    $atomicDeployment->getDeployment()->linkDeployment();
+                    $atomicDeployment->confirmSymbolicLink();
                     DeploymentSuccessful::dispatch($atomicDeployment, $deploymentModel);
                 } catch (\Throwable $e) {
+                    $atomicDeployment->failed();
                     Output::throwable($e);
-                    $atomicDeployment->rollback();
                 }
             }
         } else {
+            $atomicDeployment = AtomicDeploymentService::create($migrate, $dryRun);
+
             Output::info('Running Deployment...');
 
-            if ($deployDir = trim($this->option('directory'))) {
-                Output::info("Deployment directory option set. Deployment will use {$deployDir}");
-                $atomicDeployment->setDeploymentDirectory($deployDir);
+            try {
+                if ($deployDir = trim($this->option('directory'))) {
+                    Output::info("Deployment directory option set - Deployment will use directory: {$deployDir} ");
+                    $atomicDeployment->getDeployment()->setDeploymentDirectory($deployDir);
+                }
+                $atomicDeployment->deploy(fn () => $atomicDeployment->cleanBuilds(config('atomic-deployments.build-limit')));
+            } catch (\Throwable $e) {
+                $atomicDeployment->failed();
+                Output::throwable($e);
             }
-
-            $atomicDeployment->deploy(fn () => $atomicDeployment->cleanBuilds(config('atomic-deployments.build-limit')));
         }
 
         Output::info('Finished');

src/Events/DeploymentFailed.php

@@ -6,23 +6,23 @@
 use Illuminate\Foundation\Events\Dispatchable;
 use Illuminate\Queue\SerializesModels;
 use JTMcC\AtomicDeployments\Models\AtomicDeployment;
-use JTMcC\AtomicDeployments\Services\AtomicDeployments;
+use JTMcC\AtomicDeployments\Services\AtomicDeploymentService;
 
 class DeploymentFailed implements ShouldQueue
 {
     use Dispatchable;
     use SerializesModels;
 
-    public AtomicDeployments $deploymentService;
+    public AtomicDeploymentService $deploymentService;
     public ?AtomicDeployment $deployment = null;
 
     /**
      * DeploymentSuccessful constructor.
      *
-     * @param AtomicDeployments $deploymentService
-     * @param mixed             $deployment
+     * @param AtomicDeploymentService $deploymentService
+     * @param AtomicDeployment|null   $deployment
      */
-    public function __construct(AtomicDeployments $deploymentService, ?AtomicDeployment $deployment = null)
+    public function __construct(AtomicDeploymentService $deploymentService, AtomicDeployment $deployment = null)
     {
         $this->deploymentService = $deploymentService;
         $this->deployment = $deployment;

src/Events/DeploymentSuccessful.php

@@ -6,23 +6,23 @@
 use Illuminate\Foundation\Events\Dispatchable;
 use Illuminate\Queue\SerializesModels;
 use JTMcC\AtomicDeployments\Models\AtomicDeployment;
-use JTMcC\AtomicDeployments\Services\AtomicDeployments;
+use JTMcC\AtomicDeployments\Services\AtomicDeploymentService;
 
 class DeploymentSuccessful implements ShouldQueue
 {
     use Dispatchable;
     use SerializesModels;
 
-    public AtomicDeployments $deploymentService;
+    public AtomicDeploymentService $deploymentService;
     public ?AtomicDeployment $deployment = null;
 
     /**
      * DeploymentSuccessful constructor.
      *
-     * @param AtomicDeployments $deploymentService
-     * @param mixed             $deployment
+     * @param AtomicDeploymentService $deploymentService
+     * @param AtomicDeployment|null   $deployment
      */
-    public function __construct(AtomicDeployments $deploymentService, ?AtomicDeployment $deployment = null)
+    public function __construct(AtomicDeploymentService $deploymentService, AtomicDeployment $deployment = null)
     {
         $this->deploymentService = $deploymentService;
         $this->deployment = $deployment;

src/Helpers/FileHelper.php

@@ -24,14 +24,4 @@ public static function confirmPathsExist(string ...$paths): bool
 
         return true;
     }
-
-    /**
-     * @param $path
-     * @param int   $mode
-     * @param false $recursive
-     */
-    public static function createDirectory($path, $mode = 0755, $recursive = true): void
-    {
-        File::ensureDirectoryExists($path, $mode, $recursive);
-    }
 }

src/Interfaces/DeploymentInterface.php

@@ -0,0 +1,26 @@
+<?php
+
+namespace JTMcC\AtomicDeployments\Interfaces;
+
+interface DeploymentInterface
+{
+    public function getBuildPath();
+
+    public function setDeploymentDirectory(string $name = '');
+
+    public function setDeploymentPath();
+
+    public function getDeploymentPath();
+
+    public function getCurrentDeploymentPath();
+
+    public function copyContents();
+
+    public function linkDeployment();
+
+    public function getDeploymentLink();
+
+    public function getModel();
+
+    public function updateDeploymentStatus(int $status);
+}