Added --safe flag to the installApp high-level command.

This way on the client side we can check if it is safe to deploy a new version.

Author: Slavey Karadzhov

README.md

@@ -154,6 +154,27 @@ php bin/zs-client.phar installApp --zpk="<location-of-the-zpk-file>" \
                                  --baseUri="<baseUri>" \
                                  --userParams="APPLICATION_ENV=staging&DB_TYPE=mysql"
 ```
+
+#### Safe Package Deployment ####
+If you deploy a new version of your zpk if the old version is still being deployed then 
+this can lead to unpredictable results. In order to prevent this you can use the `--safe` flag.
+If it is present zs-client will check if there is a current deployment going on for this app
+and will exit if that is the case. 
+
+Example:
+```
+php bin/zs-client.phar installApp --zpk="<location-of-the-zpk-file>" --safe ...
+```
+
+If you want to be safe AND want to wait for the previous deployment to finish then 
+you can use the --safe and --wait flags together.  
+
+Example:
+```
+php bin/zs-client.phar installApp --zpk="<location-of-the-zpk-file>" --safe --wait ...
+```
+
+
 #### Deploy Multiple Packages
 If you use the composer integration then packZpk can create multiple packages, instead of one. Below is a suggestion how you can
 deploy these newly created packages in the correct order.

module/Client/config/module.config.php

@@ -119,10 +119,11 @@
                             ),
                             'installApp' => array(
                                 'options' => array(
-                                    'route' => 'installApp --zpk= --baseUri= [--userParams=] [--userAppName=] [--createVhost=] [--defaultServer=] [--ignoreFailures=] [--target=] [--zsurl=] [--zskey=] [--zssecret=] [--zsversion=] [--http=] [--wait]',
+                                    'route' => 'installApp --zpk= --baseUri= [--userParams=] [--userAppName=] [--createVhost=] [--defaultServer=] [--ignoreFailures=] [--target=] [--zsurl=] [--zskey=] [--zssecret=] [--zsversion=] [--http=] [--wait] [--safe]',
                                     'defaults' => array(
                                         'controller' => 'webapi-app-controller',
-                                        'action' => 'install'
+                                        'action' => 'install',
+                                        'safe'   => false,
                                     ),
                                     'group'=>'high-level',
                                     'async' => true,
@@ -146,6 +147,7 @@
                                         array('--http', 'Allows you to set http connection parameters'),
                                         array('--wait', 'If this option is present then the client will wait until the operation finishes successfully on all servers.'.
                                                         'By default this option is not present which means that the client will return results and exit as soon as the server has reported that it started to handle the task.'),
+                                        array('--safe', 'Deploys the application only when there is not current deployment running for this application'),
                                     ),
                                     'arrays' => array(
                                         'userParams',

module/Client/src/Client/Controller/AppController.php

@@ -19,7 +19,9 @@ public function installAction()
         $userParams = $this->params('userParams', array());
         $appName    = $this->params('userAppName');
         $appId      = 0;
+        $appStatus  = null;
         $wait       = $this->params('wait');
+        $safe       = $this->params('safe');
 
         $apiManager = $this->serviceLocator->get('zend_server_api');
         $zpkService = $this->serviceLocator->get('zpk');
@@ -50,6 +52,7 @@ public function installAction()
         foreach ($response->responseData->applicationsList->applicationInfo as $appElement) {
             if ($appElement->userAppName == $appName) {
                 $appId = $appElement->id;
+                $appStatus = sprintf("%s", $appElement->status);
                 break;
             }
         }
@@ -74,24 +77,68 @@ public function installAction()
             if ($wait) {
                 $xml = new \SimpleXMLElement($response->getBody());
                 $appId = $xml->responseData->applicationInfo->id;
+                $response = $this->repeater()->doUntil(array($this, 'onWaitInstall'),
+                                                       array(
+                                                          'appId'=>sprintf("%s", $appId)
+                                                       ));
             }
-        } else {
-            // otherwise update the application
+            
+            return $response;
+        }
+        
+        if ($safe && !$wait && $this->isAppDeploymentRunning($appStatus)) {
+            throw new \Zend\Mvc\Exception\RuntimeException(
+                "Previous version is still being deployed. Use the --wait flag if you want to wait"
+                );
+        }
+        
+        $updateFunc = function ($wait) use ($appId, $zpk, $userParams) {
+            // update the application
             $response = $this->forward()->dispatch('webapi-api-controller', array(
                 'action'     => 'applicationUpdate',
                 'appId'      => $appId,
                 'appPackage' => $zpk,
                 'userParams' => $userParams,
             ));
+            
+            if ($wait) {
+                $response = $this->repeater()->doUntil(array($this, 'onWaitInstall'),
+                    array(
+                        'appId'=>sprintf("%s", $appId),
+                    ));
+            }
+            
+            return $response;
+        };
+        
+        if (!$safe || ($safe && !$this->isAppDeploymentRunning($appStatus))) {
+            return $updateFunc($wait);
         }
-
-        if ($wait) {
-            $response = $this->repeater()->doUntil(array($this, 'onWaitInstall'), array('appId'=>sprintf("%s", $appId)));
-        }
-
-        return $response;
+        
+        // if safe and wait
+        return $this->repeater()->doUntil(function () use ($apiManager, $updateFunc, $appId, $wait) {
+            $response = $apiManager->applicationGetStatus(array('applications'=> $appId));
+            foreach ($response->responseData->applicationsList->applicationInfo as $appElement) {
+                if (sprintf("%s", $appElement->id) == $appId) {
+                    $appStatus = sprintf("%s", $appElement->status);
+                    break;
+                }
+            }
+            
+            if (!$this->isAppDeploymentRunning($appStatus)) {
+                return $updateFunc($wait);
+            }
+        });
     }
 
+    public function isAppDeploymentRunning($appStatus)
+    {
+        return !(
+            in_array($appStatus, array("error", "deployed", "notExists")) ||
+            preg_match('/(\w+)Error$/', $appStatus)
+        );
+    }
+    
     /**
      * Returns response if the action finished as expected
      * @param AbstractActionController $controller