Merge pull request #164 from lorisleiva/reload-php-fpm-after-rollback

Add rollback hook

Author: lorisleiva

docs/how-to-reload-fpm.md

@@ -1,6 +1,6 @@
 # How to reload php-fpm?
 
-In order to reload php-fpm after each deployment, you will need to add the `fpm:reload` task at the end of your deployment flow. You also have to set up which version of php-fpm you are using.
+In order to reload php-fpm after each deployment, you will need to add the `fpm:reload` task at the end of your deployment flow (including, if necessary, rolling back to a previous version). You also have to set up which version of php-fpm you are using.
 
 ```php
 // config/deploy.php
@@ -10,6 +10,7 @@ In order to reload php-fpm after each deployment, you will need to add the `fpm:
 ],
 'hooks' => [
     'done' => ['fpm:reload'],
+    'rollback' => ['fpm:reload'],
 ],
 ```
 
@@ -21,4 +22,4 @@ If you wish to customize the command executed by `fpm:reload`, you can override
 'options' => [
     'php_fpm_command' => 'echo "" | sudo -S /usr/sbin/service {{php_fpm_service}} reload',
 ],
-```
+```

docs/overview-getting-started.md

@@ -109,6 +109,11 @@ Before starting you first deployment, you should go check your `config/deploy.ph
 
         // Deployment failed. This can happen at any point of the deployment.
         'fail' => [],
+
+        // After a deployment has been rolled back.
+        'rollback' => [
+            'fpm:reload',
+        ],
     ],
 ```
 

src/LaravelDeployer/ConfigFile.php

@@ -20,6 +20,7 @@ class ConfigFile implements Arrayable
         'hooks.done',
         'hooks.success',
         'hooks.fail',
+        'hooks.rollback',
         'options',
         'hosts',
         'localhost',

src/LaravelDeployer/ConfigFileBuilder.php

@@ -24,12 +24,13 @@ class ConfigFileBuilder
         'default' => 'basic',
         'strategies' => [],
         'hooks' => [
-            'start'   => [],
-            'build'   => [],
-            'ready'   => [],
-            'done'    => [],
+            'start' => [],
+            'build' => [],
+            'ready' => [],
+            'done' => [],
             'success' => [],
-            'fail'    => [],
+            'fail' => [],
+            'rollback' => [],
         ],
         'options' => [
             'application' => "env('APP_NAME', 'Laravel')",
@@ -163,6 +164,7 @@ public function useForge($phpVersion = self::DEFAULT_PHP_VERSION)
     public function reloadFpm($phpVersion = self::DEFAULT_PHP_VERSION)
     {
         $this->add('hooks.done', 'fpm:reload');
+        $this->add('hooks.rollback', 'fpm:reload');
         $this->set('options.php_fpm_service', "php$phpVersion-fpm");
 
         return $this;

src/LaravelDeployer/stubs/config.stub

@@ -59,6 +59,9 @@ return [
 
         // Deployment failed.
         'fail' => {{hooks.fail}},
+        
+        // After a deployment has been rolled back.
+        'rollback' => {{hooks.rollback}},
     ],
 
     /*

src/recipe/laravel-deployer.php

@@ -68,3 +68,6 @@
 // Unlock when deployment fails.
 fail('deploy', 'deploy:failed');
 after('deploy:failed', 'deploy:unlock');
+
+// Add rollback hook.
+after('rollback', 'hook:rollback');

src/task/common.php

@@ -88,4 +88,4 @@
         writeln('<comment>To speed up composer installation setup "unzip" command with PHP zip extension https://goo.gl/sxzFcD</comment>');
     }
     run('cd {{release_path}} && {{bin/composer}} {{composer_options}}');
-});
+});

src/task/defaults.php

@@ -37,4 +37,4 @@
     preg_match_all('/(\d+\.?)+/', $result, $matches);
     $version = $matches[0][0] ?? 5.5;
     return $version;
-});
+});

src/task/fpm.php

@@ -8,4 +8,4 @@
 desc('Reload the php-fpm service');
 task('fpm:reload', function () {
     run('{{php_fpm_command}}');
-});
+});

src/task/helpers.php

@@ -71,4 +71,4 @@ function copyShared($from, $to)
             run("rsync --ignore-existing $from/$file $to/$file");
         }
     }
-}
+}

src/task/hook.php

@@ -5,4 +5,5 @@
 task('hook:start', function() {})->shallow()->setPrivate();
 task('hook:build', function() {})->shallow()->setPrivate();
 task('hook:ready', function() {})->shallow()->setPrivate();
-task('hook:done', function() {})->shallow()->setPrivate();
+task('hook:done', function() {})->shallow()->setPrivate();
+task('hook:rollback', function() {})->shallow()->setPrivate();

src/task/logs.php

@@ -8,4 +8,4 @@
 desc('Read logs from a given host');
 task('logs', function() {
     writeln(run('cd {{deploy_path}}/current && {{log_command}}'));
-})->shallow();
+})->shallow();

src/task/npm.php

@@ -8,4 +8,4 @@
 task('npm:development', '{{bin/npm}} run development');
 
 desc('Execute npm run production');
-task('npm:production', '{{bin/npm}} run production');
+task('npm:production', '{{bin/npm}} run production');

tests/Features/DeployInitTest.php

@@ -36,6 +36,7 @@ function it_generates_a_minimal_config_file()
                 "done" => [],
                 "fail" => [],
                 "success" => [],
+                "rollback" => [],
             ],
             "options" => [
                 "application" => "Laravel",
@@ -86,6 +87,9 @@ function it_generates_a_full_config_file_with_forge_defaults()
                 ],
                 "fail" => [],
                 "success" => [],
+                "rollback" => [
+                    'fpm:reload',
+                ],
             ],
             "options" => [
                 "application" => "Laravel",

tests/Features/DeployInitWithLumenTest.php

@@ -32,6 +32,7 @@ function it_generates_a_config_file_without_artisan_tasks_not_supported_by_lumen
                 "done" => [],
                 "fail" => [],
                 "success" => [],
+                "rollback" => [],
             ],
             "options" => [
                 "application" => "Laravel",

tests/Features/DeployRollbackTest.php

@@ -9,7 +9,7 @@ class DeployRollbackTest extends DeploymentTestCase
     protected $configs = 'basic';
 
     /** @test */
-    function a_rollback_with_no_previous_release_should_do_nothing_but_warn_user()
+    function a_rollback_with_no_previous_release_should_do_nothing_but_warn_the_user()
     {
         $output = $this->artisan('deploy:rollback');
 
@@ -42,9 +42,10 @@ function a_rollback_should_symlink_to_the_previous_release()
 
         /* Rollback */
 
-        $this->artisan('deploy:rollback');
+        $output = $this->artisan('deploy:rollback');
 
         $this->assertSuccessfulDeployment();
         $this->assertServerHas('unicorn.txt');
+        $this->assertStringContainsString('Executing task fpm:reload', $output);
     }
 }

tests/Unit/ConfigFileTest.php

@@ -28,6 +28,7 @@ function it_can_render_a_config_file_that_is_equivalent_to_its_content()
                 'done'    => [],
                 'fail'    => [],
                 'success' => [],
+                'rollback' => [],
             ],
             'options' => [
                 'application' => "env('APP_NAME', 'Laravel')",

tests/Unit/DeployFileTest.php

@@ -226,12 +226,13 @@ function it_adds_hooks()
     {
         $deployFile = (string) new DeployFile([
             'hooks' => [
-                'start'   => ['slack:notify'],
-                'build'   => ['npm:install', 'npm:production'],
-                'ready'   => ['artisan:cache:clear', 'artisan:migrate'],
-                'done'    => ['fpm:reload'],
-                'fail'    => ['slack:notify:failure'],
-                'success' => ['slack:notify:success'],
+                'start'    => ['slack:notify'],
+                'build'    => ['npm:install', 'npm:production'],
+                'ready'    => ['artisan:cache:clear', 'artisan:migrate'],
+                'done'     => ['fpm:reload'],
+                'fail'     => ['slack:notify:failure'],
+                'success'  => ['slack:notify:success'],
+                'rollback' => ['fpm:reload'],
             ]
         ]);
 
@@ -245,6 +246,7 @@ function it_adds_hooks()
 after('hook:done', 'fpm:reload');
 after('deploy:failed', 'slack:notify:failure');
 after('success', 'slack:notify:success');
+after('hook:rollback', 'fpm:reload');
 EOD
         , $deployFile);
     }

tests/fixtures/configs/basic.php

@@ -30,6 +30,9 @@
             'artisan:config:cache',
             'artisan:optimize',
         ],
+        'rollback' => [
+            'fpm:reload',
+        ],
     ],
 
     'include' => [

tests/fixtures/recipes/mocks.php

@@ -13,10 +13,9 @@
     run('echo "compiled app.js" > {{release_path}}/public/js/app.js');
 });
 
-// Mock vendors
+// Mock other tasks.
 task('deploy:vendors', function() {});
-
-// Mock artisan commands
+task('fpm:reload', function() {});
 task('artisan:storage:link', function() {});
 task('artisan:view:clear', function() {});
 task('artisan:view:cache', function() {});