Adds an option to check if the repository is aligned with the remote before the deploy

roibeart · roibeart · commit d66cace3a8f5 · 2017-10-02T21:27:56.000+02:00
If in the .ini file the option'check_sync_with_remote' is set to true, it will be checked if the remote is aligned with the local repository. If it fails, the deploy will not be performed.
It can be useful when there is more than one person working on the repository, because it pervents inconsistent deploys to the production server.
If the remote is called 'origin', it is possible to specify the branch of the remote where to check the alignment, defining it through the option 'remote_branch'.
diff --git a/git-deploy b/git-deploy
diff --git a/tools/src/Config.php b/tools/src/Config.php
@@ -73,8 +73,18 @@ public static function getServers($config_file) {
                     'ignore_files' => array(),
                     'ignore_directories' => array(),
                     'upload_untracked' => array(),
+                    'check_sync_with_remote' => false,
+                    'remote_branch' => null
                 ), $options);
 
+                if ($options['check_sync_with_remote'])
+                {
+                    if (empty($options['remote_branch']))
+                    {
+                        $options['remote_branch'] = (!empty($options['branch'])) ?  "origin/".$options['branch'] : null;
+                    }
+                }
+
                 if (!isset($options['pass']) && !isset($options['sftp_key'])) {
                     $options['pass'] = self::promptPassword();
                 }
diff --git a/tools/src/Git.php b/tools/src/Git.php
@@ -90,6 +90,47 @@ public function get_changes($target_commit, $current_commit) {
         return $return;
     }
 
+    // http://stackoverflow.com/a/3278427
+    public function get_status_towards_remote($local_branch, $remote_branch)
+    {
+        if (empty($local_branch))
+        {
+            $local_branch = "@";
+        }
+
+        if (empty($remote_branch))
+        {
+            $remote_branch = "@{u}";
+        }
+
+        $status;
+
+        $this->exec("remote update");
+
+        $local = $this->exec("rev-parse ".$local_branch);
+        $remote = $this->exec("rev-parse ".$remote_branch);
+        $base = $this->exec("merge-base ".$local_branch." ".$remote_branch);
+
+        if ($local == $remote)
+        {
+            $status = "up-to-date";
+        }
+        else if ($local == $base)
+        {
+            $status = "pull-needed";
+        }
+        else if ($remote == $base)
+        {
+            $status = "push-needed";
+        }
+        else
+        {
+            $status = "diverged";
+        }
+
+        return $status;
+    }
+
     protected function get_file_contents($path) {
         $temp = tempnam(sys_get_temp_dir(), "git-deploy-");
         $this->exec('show "' . $path . '"', "> \"$temp\"");
diff --git a/tools/src/Helpers.php b/tools/src/Helpers.php
@@ -16,12 +16,16 @@ public static function logmessage($message) {
             fwrite($log_handle, $log);
         }
 
-        echo $log;
+        echo "\033[0m".$log;
     }
 
-    public static function error($message) {
-        self::logmessage("ERROR: $message");
-        die;
+    public static function error($message, $die = true) {
+        self::logmessage("\033[0;31mERROR: $message");
+
+        if ($die)
+        {
+            die();
+        }
     }
 
     public static function get_recursive_file_list($folder, $prefix = '') {
diff --git a/tools/src/Server.php b/tools/src/Server.php
@@ -29,6 +29,31 @@ public function __construct($server, $deploy_script = 'deploy.ini') {
     }
 
     public function deploy(Git $git, $target_commit, $is_revert = false, $list_only = false) {
+
+        if ($this->server['check_sync_with_remote'])
+        {
+            $statusTowardsRemote = $git->get_status_towards_remote($this->server['branch'], $this->server['remote_branch']);
+
+            if ($statusTowardsRemote != "up-to-date")
+            {
+                Helpers::error("In order to deploy, local and remote repository must be in sync.", false);
+                if ($statusTowardsRemote == "push-needed")
+                {
+                    Helpers::logmessage("Push your changes to the remote and come back here to retry.");
+                }
+                else if ($statusTowardsRemote == "pull-needed")
+                {
+                    Helpers::logmessage("Pull the changes from the remote and come back here to retry.");
+                }
+                else if ($statusTowardsRemote == "diverged")
+                {
+                    Helpers::logmessage("Pull the changes from the remote, merge them with yours and then push to the repository. Thereafter come back here to retry.");
+                }
+                return;
+            }
+        }
+
+
         if ($target_commit == $this->current_commit) {
             Helpers::logmessage("Nothing to update on: $this->host");
             return;

Original file line number	Diff line number	Diff line change
`@@ -16,12 +16,16 @@ public static function logmessage($message) {`
`16`	`16`	`fwrite($log_handle, $log);`
`17`	`17`	`}`
`18`	`18`
`19`		`- echo $log;`
	`19`	`+ echo "\033[0m".$log;`
`20`	`20`	`}`
`21`	`21`
`22`		`- public static function error($message) {`
`23`		`- self::logmessage("ERROR: $message");`
`24`		`- die;`
	`22`	`+ public static function error($message, $die = true) {`
	`23`	`+ self::logmessage("\033[0;31mERROR: $message");`
	`24`	`+`
	`25`	`+ if ($die)`
	`26`	`+ {`
	`27`	`+ die();`
	`28`	`+ }`
`25`	`29`	`}`
`26`	`30`
`27`	`31`	`public static function get_recursive_file_list($folder, $prefix = '') {`