lita-capistrano 0.1.3 → 0.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: c3c19a8b4e1c2c29eeea20d0900ec200abecc545
-  data.tar.gz: d4d457dbf0e1162edf8d94adaead7fedf93edebd
+  metadata.gz: c1f3c26d550035dc25ff4a29fde961965b2aa3b3
+  data.tar.gz: 2e90474c1194516456af12e226b0179d441843d7
 SHA512:
-  metadata.gz: 570635dd217d78445f09ea31570dcaf5ec6cf3feaaf02961e70c128e3a233288c0cffe9939d1f3e97cc1f0cc449d347cd679a399ac470bdd3b672a370e437267
-  data.tar.gz: e9c00cfafe4d5020c3b29149200ad7e98e7360b910427af8e428103f45b87c0799f5c60b2404234587082aca3651682e5fdff1d9c38465911731eefa42dba120
+  metadata.gz: 9389b67972da5324053a44b9e332a9d456064429f583570fa6c5057ceb7ea74ff5467cb1ae4a1d31621af950d94bcd34642782286aa4ea07d7945a28558326a9
+  data.tar.gz: cd4aa4c7a3f9852e4d26aa142c2120e5d1115bfd93f0f816340a6889e87e73a3c550fdb6c1974eb706317d498c3a490e050cfd530894da36099dd13cf58c2d86

data/README.md

@@ -1,6 +1,12 @@
 # lita-capistrano
 
-TODO: Add a description of the plugin.
+[![Gem Version](https://badge.fury.io/rb/lita-capistrano.png)](http://badge.fury.io/rb/lita-capistrano)
+
+**lita-capistrano** is a hanlder for [Lita](https://www.lita.io/) that allows you to use make deploys through your robot.
+
+## Requirements
+
+In order to **lita-capistrano** to identify a good deploy from a failed one, you capistrano script should always end with a message.
 
 ## Installation
 
@@ -12,8 +18,91 @@ gem "lita-capistrano"
 
 ## Configuration
 
-TODO: Describe any configuration attributes the plugin exposes.
+### Required attributes
+
+* `server` (String) – The deploy server host.
+
+* `server_user` (String) – The deploy server host ssh user.
+
+* `server_password` (String) – The deploy server host ssh password.
+
+* `deploy_tree` (String) – A json configuration of how deploys work.
+
+### Example
+
+``` ruby
+Lita.configure do |config|
+  config.handlers.capistrano.server = "capistrano-deploy.com"
+  config.handlers.capistrano.server_user = "lita"
+  config.handlers.capistrano.server_password = "secret"
+end
+
+config.handlers.capistrano.deploy_tree = {
+  first_app: {
+    qa: {
+      dir: "/capistrano/first_app/qa",
+      auth_group: "first_app_qa", # auth_group required to be able to deploy
+      channel: "first_app_channel", # not required, if configured limits deploys to this channel
+      envs: [
+        "qa1",
+        "qa2"
+      ]
+    },
+    staging: {
+      dir: "/capistrano/fist_app/staging",
+      auth_group: "first_app_staging",
+      envs: [
+        "stagin1",
+        "staging2",
+        "staging3"
+      ]
+    }
+  },
+  second_app: {
+    prod: {
+      dir: "/capistrano/second_app/production",
+      auth_group: "second_app_staging",
+      channel: "second_app_prod_channel",
+      envs: [
+        "dc1",
+        "dc2"
+      ]
+    }
+  }
+```
 
 ## Usage
 
-TODO: Describe the plugin's features and how to use them.
+List available apps for deploy:
+
+```
+Lita: deploy list
+```
+
+List available app areas for deploy:
+
+```
+Lita: deploy list [APP]
+```
+
+List required auth groups to deploy:
+
+```
+Lita: deploy auth list [APP]
+```
+
+Deploy a tag or branch:
+
+```
+Lita: deploy [APP] [AREA] [ENV] [TAG]
+```
+
+Rollback last tag or branch:
+
+```
+Lita: deploy [APP] [AREA] [ENV] rollback
+```
+
+## License
+
+[MIT](http://opensource.org/licenses/MIT)

data/lib/lita/handlers/capistrano.rb

@@ -46,6 +46,14 @@ module Lita
         area = response.matches[0][1]
         env = response.matches[0][2]
         tag = response.matches[0][3]
+        allowed_channel = config.deploy_tree[app.to_sym][area.to_sym][:channel]
+        room_id = response.message.source.room_object.id
+
+        # Do not deploy if not in the right channel, only if channel is
+        # set in config.
+        if !allowed_channel.nil? && !allowed_room?(room_id, allowed_channel)
+          return response.reply("Deploy da app #{app} #{area} permitido somente no canal ##{allowed_channel}")
+        end
 
         unless area_exists?(area)
           return response.reply("A área informada é inválida.")
@@ -54,11 +62,11 @@ module Lita
           return response.reply("O ambiente informado é inválido.")
         end
 
-        # Pre deploy check
+        # Pre deploy check, if no deploy in progress, deploy-tracker will
+        # trigger :deploy_checked to continue the deploy.
         deploy_in_progress?(app, area, env, tag, response)
       end
 
-
       def area_exists?(area)
         config.deploy_tree[:commerce].include?(area.to_sym)
       end
@@ -109,58 +117,104 @@ module Lita
         tag = payload[:tag]
         response = payload[:response]
         dir = config.deploy_tree[app.to_sym][area.to_sym][:dir]
+        responsible_user = response.user.mention_name
+        target = response.message.source.room_object
+
+        # Default initial message
+        initial_message = "#{responsible_user}: Deploy da tag #{tag} iniciado no ambiente #{env}."
 
-        # Deploy start
-        response.reply("#{response.user.mention_name}: Deploy da tag #{tag} iniciado no ambiente #{env}.")
+        if (tag == "rollback")
+          # Change the initial message in case of rollback
+          initial_message = "#{responsible_user}: Rollback iniciado no ambiente #{env}."
+        end
+
+        # Deploy/Rollback start
+        response.reply(initial_message)
         start_time = Time.now
         robot.trigger(:deploy_started,
                       app: app,
                       area: area,
                       env: env,
                       tag: tag,
-                      responsible: response.user.mention_name,
+                      responsible: responsible_user,
                       start_time: start_time)
 
-        # Deploy execution
-        output = deploy(dir, env, tag)
+        # Deploy/Rollback execution
+        output = ""
+        if (tag == "rollback")
+          output = rollback(dir, env)
+        else
+          output = deploy(dir, env, tag)
+        end
+
         # After deploy stopped
         finish_time =Time.now
 
-        # The deploy:restart could be in two positions depending on the
-        # capistrano config
-        if (output.lines.last.include? "deploy:restart") || (output.lines.last(5)[0].include? "deploy:restart")
+        msg_components = {}
+
+        # Send back a message indicating the deploy status
+        if !output[:error]
           robot.trigger(:deploy_finished,
                         app: app,
                         area: area,
                         env: env,
                         tag: tag,
-                        responsible: response.user.mention_name,
+                        responsible: responsible_user,
                         start_time: start_time,
                         finish_time: finish_time,
                         status: 'success')
-        return response.reply("#{response.user.mention_name}: Deploy da tag #{tag} no ambiente #{env} realizado com sucesso!")
-        elsif output.lines.last.include? "status code 32768"
+        msg_components = {title: "Finalizado com sucesso!",
+                          color: "good",
+                          text: ""}
+      elsif output[:data].lines.last.include? "status code 32768"
           robot.trigger(:deploy_finished,
                         app: app,
                         area: area,
                         env: env,
                         tag: tag,
-                        responsible: response.user.mention_name,
+                        responsible: responsible_user,
                         start_time: start_time,
                         finish_time: finish_time,
                         status: 'invalid tag')
-          return response.reply("#{response.user.mention_name}: A tag #{tag} informada não existe. Deploy não realizado.")
+          msg_components = {title: "A tag informada não existe.",
+                            color: "warning",
+                            text: ""}
         else
           robot.trigger(:deploy_finished,
                         app: app,
                         area: area,
                         env: env,
                         tag: tag,
-                        responsible: response.user.mention_name,
+                        responsible: responsible_user,
                         start_time: start_time,
                         finish_time: finish_time,
                         status: 'error')
-          return response.reply("#{response.user.mention_name}: Ocorreu um erro na execução do deploy da tag #{tag} no ambiente #{env}.")
+          msg_components = {title: "Error!",
+                            color: "danger",
+                            text: output[:data]}
+        end
+
+        # generate the Attachment for slack
+        attachment = gen_deploy_msg(msg_components[:title],
+                            msg_components[:color],
+                            msg_components[:text],
+                            responsible_user,
+                            app,
+                            area,
+                            env,
+                            tag)
+
+        # Default message for other adapters
+        message = "Deploy - #{msg_components[:title]}. #{msg_components[:text]}"
+        if (tag == "rollback")
+          message = "Rollback - #{msg_components[:title]}. #{msg_components[:text]}"
+        end
+
+        case robot.config.robot.adapter
+        when :slack
+          return robot.chat_service.send_attachments(target, attachment)
+        else
+          robot.send_message(target, message)
         end
       end
 
@@ -177,7 +231,7 @@ module Lita
           %r{^deploy\s+auth\s+list},
           :deploy_auth_list,
           command: false,
-          help: { "deploy auth list [APP] " => "List available apps for deploy"}
+          help: { "deploy auth list [APP] " => "List required auth groups to deploy"}
         )
       end
 
@@ -191,6 +245,7 @@ module Lita
               restrict_to: [:admins, value[:auth_group].to_sym],
               help: { "deploy #{app} #{area} ENV TAG " => "Executa deploy da app #{app} na area #{area}"}
             )
+
           end
         end
       end
@@ -199,13 +254,69 @@ module Lita
         output = ssh_exec("cd #{dir}; cap #{env} deploy tag=#{tag}")
       end
 
+      def rollback(dir, env)
+        output = ssh_exec("cd #{dir}; cap #{env} deploy:rollback")
+      end
+
       def ssh_exec(cmd)
-        #TODO tornar acesso ao servidor dinamico entro prod e test
-        Net::SSH.start(config.server, config.server_user, :password => config.server_password) do |ssh|
-          @output = ssh.exec!(cmd)
+        Net::SSH.start(config.server, config.server_user, password: config.server_password) do |ssh|
+          exec_ssh(ssh, cmd)
+        end
+      end
+
+      def exec_ssh(ssh, cmd)
+        ssh.exec! cmd do |ch, stream, data|
+          @output = get_deploy_output(stream, data)
         end
         @output
       end
+
+       def get_deploy_output(stream, data)
+         if stream == :stderr
+           { data: "#{data}", error: true }
+         else
+           { data: "#{data}", error: false }
+         end
+       end
+
+
+      def gen_deploy_msg (title, color, body, user, app, area, env, tag)
+        msg = Adapters::Slack::Attachment.new(
+          body,
+          title: "Deploy - #{title}",
+          color: "#{color}",
+          pretext: "@#{user}:",
+          fields: [
+            {
+              title: "App",
+              value: app,
+              short: true
+            },
+            {
+              title: "Área",
+              value: area,
+              short: true
+            },
+            {
+              title: "Ambiente",
+              value: env,
+              short: true
+            },
+            {
+              title: "tag",
+              value: tag,
+              short: true
+            },
+          ]
+        )
+      end
+
+      def allowed_room?(room_id, allowed_channel)
+        room = Lita::Room.find_by_id(room_id)
+        return false if room.nil?
+        return true if room.metadata["name"] == allowed_channel
+      end
+
     end
 
     Lita.register_handler(Capistrano)

data/lita-capistrano.gemspec

@@ -1,6 +1,6 @@
 Gem::Specification.new do |spec|
   spec.name          = "lita-capistrano"
-  spec.version       = "0.1.3"
+  spec.version       = "0.2.0"
   spec.authors       = ["Alexandre Gomes"]
   spec.email         = ["alejdg@outlook.com.br"]
   spec.summary       = "A Lita handler to integrate with Capistrano.rb"

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: lita-capistrano
 version: !ruby/object:Gem::Version
-  version: 0.1.3
+  version: 0.2.0
 platform: ruby
 authors:
 - Alexandre Gomes
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2016-01-25 00:00:00.000000000 Z
+date: 2016-02-04 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: lita