lita-capistrano_rails 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 71bda2653837504766b7a01f7f7d6e1075d54bfb
+  data.tar.gz: 3ca22fd088d1e55c39a15b06548bb0df97d2b5d1
+SHA512:
+  metadata.gz: e7f05e1e58c7d72bc00510d9a62ba946606c339e7c7ab05abc9f38f2e528332b1d377c135ae9cf647b4fec7b9213c5713c6064ff494f95d6831b0173f5c76465
+  data.tar.gz: a13f8af62d235bc1e9c22b4b0d54eafd7c79c23d472d5e892e2d1d9904a26115ef04292a9b31e949fc3470059177cddcbcd1256a4ca84887fadb0be1ba0d245e

data/.gitignore

@@ -0,0 +1,17 @@
+*.gem
+*.rbc
+.bundle
+.config
+.yardoc
+Gemfile.lock
+InstalledFiles
+_yardoc
+coverage
+doc/
+lib/bundler/man
+pkg
+rdoc
+spec/reports
+test/tmp
+test/version_tmp
+tmp

data/Gemfile

@@ -0,0 +1,3 @@
+source "https://rubygems.org"
+
+gemspec

data/README.md

@@ -0,0 +1,19 @@
+# lita-capistrano_rails
+
+TODO: Add a description of the plugin.
+
+## Installation
+
+Add lita-capistrano_rails to your Lita instance's Gemfile:
+
+``` ruby
+gem "lita-capistrano_rails"
+```
+
+## Configuration
+
+TODO: Describe any configuration attributes the plugin exposes.
+
+## Usage
+
+TODO: Describe the plugin's features and how to use them.

data/Rakefile

@@ -0,0 +1,6 @@
+require "bundler/gem_tasks"
+require "rspec/core/rake_task"
+
+RSpec::Core::RakeTask.new(:spec)
+
+task default: :spec

data/lib/lita/handlers/capistrano_rails.rb

@@ -0,0 +1,233 @@
+require "step_flow"
+require "open3"
+
+module Lita
+  module Handlers
+    class CapistranoRails < Handler
+      include StepFlow
+
+      # example:
+      # config.handlers.capistrano_rails.apps = {
+      #   'app1' => {
+      #     git: 'git@git.example.com:account/app1.git',
+      #   }, # this will use "production" as rails env and using "master" branch
+      #   'app2' => {
+      #     git: 'git@git.example.com:account/app2.git',
+      #       envs: {
+      #         'production' => 'master',
+      #         'staging' => 'develop',
+      #       }
+      #   },
+      # }
+      config :apps, type: Hash, required: true
+
+      on :loaded, :define_routes
+
+      def define_routes(payload)
+        define_static_routes
+        define_dinamic_routes
+      end
+
+      # command: "deploy list"
+      def deploy_list_apps(response)
+        response.reply_privately('Available apps:')
+        apps = config.apps.map do |app, app_config|
+          envs = app_config[:envs] ? app_config[:envs].keys.join(",") : 'production'
+          "#{app}(#{envs})"
+        end
+        response.reply_privately(apps )
+      end
+
+      # command: "deploy #{env} for #{app}"
+      def deploy_env_for_app(response)
+        env = response.matches[0][0]
+        app = response.matches[0][1]
+        deploy_app(app, env, response)
+      end
+
+      # command: "deploy #{app}"
+      def deploy_production_for_app(response)
+        env = 'production'
+        app = response.matches[0][0]
+        deploy_app(app, env, response)
+      end
+
+      private
+
+      def deploy_app(app, env, response)
+        app_config = config.apps[app]
+
+        # check env
+        branch = \
+        step :validate_deploy_request, :first_step do
+          app_envs = app_config[:envs] ? app_config[:envs].keys : ['production'] # use "production" as default env
+          if !app_envs.include?(env)
+            return response.reply(%{"#{env}" is not available env for #{app}, available env is: #{app_envs.join("|")}})
+          end
+
+          branch = app_config[:envs] ? app_config[:envs][env] : 'master' # use "master" as default branch
+
+          response.reply("I'm deploying #{env} using #{branch} branch for #{app} ...")
+          branch
+        end
+
+        app_path, app_source_path, bundle_path = \
+        step :prepare_tmp_dirs do
+          # prepare the dirs
+          app_path    = File.expand_path("tmp/capistrano_rails/apps/#{app}")
+          app_source_path = File.expand_path("#{app_path}/source")
+          bundle_path     = File.expand_path("tmp/capistrano_rails/bundle") # sharing bundle to reduce space usage and reuse gems
+          FileUtils.mkdir_p(app_path)
+          [app_path, app_source_path, bundle_path]
+        end
+
+        step :get_source_code do
+          # if dir ".git" exists, use `git pull`
+          if File.exists?("#{app_source_path}/.git")
+            step_log 'Found ".git" exists, run `git pull`'
+            # run_in_dir("git checkout #{branch} && git pull", app_source_path)
+            revision = "origin/#{branch}"
+            # since we're in a local branch already, just reset to specified revision rather than merge
+            run_in_dir("git fetch #{verbose} && git reset #{verbose} --hard #{revision}", app_source_path)
+          else
+            step_log 'not found ".git", run `git clone`'
+            run_in_dir("git clone -b #{branch} #{app_config[:git]} source", app_path)
+          end
+
+          # TODO: if ".git" exists but repo url changed, clean up the dir then run `git clone`
+        end
+
+        step :hack_gemfile do
+          # disable "ruby 'x.y.z'" config in Gemfile
+          # to avoid errors like "Your Ruby version is 2.2.4, but your Gemfile specified 2.1.2 (Bundler::RubyVersionMismatch)"
+          gemfile_path = "#{app_source_path}/Gemfile"
+          gemfile_content = File.read gemfile_path
+          if gemfile_content.match(/^ruby .+/)
+            gemfile_content.sub!(/(^ruby .+)/, '# \1 # hacked by Lita::Handlers::CapistranoRails to avoid "Bundler::RubyVersionMismatch" problem')
+            File.open(gemfile_path, 'w') { |gemfile| gemfile.write(gemfile_content) }
+          end
+        end
+
+        step :run_bundle_install do
+          # run_in_dir("bundle install --quiet", app_source_path)
+          run_in_dir("bundle install --gemfile #{app_source_path}/Gemfile --path #{bundle_path} --deployment --without darwin test", app_source_path)
+          # TODO: check result, reply failure message
+          # TODO: check result, auto retry 1 time if timeout as "Gem::RemoteFetcher::FetchError: Errno::ETIMEDOUT: Operation timed out"
+        end
+
+        step :run_cap_deploy do
+          # TODO: check "Capfile"
+          # if "Capfile" not exits, reply "not a capistrano project"
+          result = run_in_dir("bundle exec cap #{env} deploy", app_source_path)
+          if result[:exit_status] != 0 # could be 256
+            failure = %{errrors while executing: "#{result[:cmd]}"\n}
+            failure << result[:stderr]
+            step_fails(response, failure)
+          end
+        end
+
+        step :reply_deploy_success, :last_step do
+          deploy_success = "deploy #{env} for #{app} finished!"
+
+          # TODO: get "app_url"
+          app_url = ""
+          deploy_success += ", please visit #{app_url}" if !app_url.empty?
+
+          response.reply(deploy_success)
+        end
+      end
+
+      def run_in_dir(cmd, dir)
+        lita_mark = "LITA=#{Lita::VERSION}"
+        _cmd = "cd #{dir} && #{lita_mark} #{cmd}"
+        # log.info _cmd
+        # running bundle install inside a bundle-managed shell to avoid "RuntimeError: Specs already loaded"
+        # see https://github.com/bundler/bundler/issues/1981#issuecomment-6292686
+        Bundler.with_clean_env do
+          # system(_cmd) # can't catch output
+          execute_command(_cmd)
+        end
+      end
+
+      # execute commandline and catch stdout and stderr
+      def execute_command(cmd)
+        log.debug "execute: #{cmd}"
+        full_stdout = String.new
+        full_stderr = String.new
+        started_at  = Time.now
+
+        Open3.popen3(cmd) do |stdin, stdout, stderr, wait_thr|
+          stdout_thread = Thread.new do
+            while (line = stdout.gets) do
+              full_stdout += line
+              # printf line
+            end
+          end
+
+          stderr_thread = Thread.new do
+            while (line = stderr.gets) do
+              full_stderr += line
+            end
+          end
+
+          stdout_thread.join
+          stderr_thread.join
+
+          exit_status = wait_thr.value.to_i
+          finished_at = Time.now
+          runtime     = finished_at - started_at
+
+          {
+            cmd:          cmd,
+            started_at:   started_at,
+            finished_at:  finished_at,
+            exit_status:  exit_status,
+            runtime:      runtime,
+            stdout:       full_stdout,
+            stderr:       full_stderr,
+          }
+        end
+      end
+
+      def verbose
+        # config.scm_verbose ? nil : "-q"
+      end
+
+      def define_static_routes
+        self.class.route(
+          %r{deploy\s+list},
+          :deploy_list_apps,
+          command: true,
+          help: { "deploy list" => "List available apps for deploy"}
+        )
+      end
+
+      # define route for each rapporteur
+      def define_dinamic_routes
+        config.apps.each do |app, app_config|
+          # define command "deploy APP"
+          self.class.route(
+            %r{deploy (#{app})$},
+            :deploy_production_for_app,
+            command: true,
+            # restrict_to: [:admins, value[:deploy_group]],
+            help: { "deploy #{app}" => "deploy produciton for #{app}"}
+          )
+
+          # define command "deploy ENV for APP"
+          # puts "define route: ^deploy\s+(#{app})\s+(#{area})\s+(.+)\s+(.+)"
+          envs = app_config[:envs] ? app_config[:envs].keys : ['production']
+          self.class.route(
+            %r{deploy +(\w+) +for +(#{app})$},
+            :deploy_env_for_app,
+            command: true,
+            # restrict_to: [:admins, value[:deploy_group]],
+            help: { "deploy #{envs.join("|")} for #{app}" => "deploy ENV for #{app}"}
+          )
+        end
+      end
+
+      Lita.register_handler(self)
+    end
+  end
+end

data/lib/lita-capistrano_rails.rb

@@ -0,0 +1,12 @@
+require "lita"
+
+Lita.load_locales Dir[File.expand_path(
+  File.join("..", "..", "locales", "*.yml"), __FILE__
+)]
+
+require "lita/handlers/capistrano_rails"
+
+Lita::Handlers::CapistranoRails.template_root File.expand_path(
+  File.join("..", "..", "templates"),
+ __FILE__
+)

data/lib/step_flow.rb

@@ -0,0 +1,55 @@
+module StepFlow
+  # store steps for flow
+  # for example:
+  # {
+  #   "deploy_app" [:valid_request, :prepare_dirs]
+  # }
+  attr_reader :flow_steps
+  attr_reader :step_failed
+
+  private
+
+  def step(step_key, first_or_last = nil, &block)
+    return if @step_failed
+    is_first = (first_or_last == :first_step)
+    is_last  = (first_or_last == :last_step)
+    flow = caller_locations(1,1)[0].label # # get from caller
+
+    # init
+    @flow_steps ||= {}
+    if @flow_steps[flow].nil?
+      if is_first
+        @flow_steps[flow] = []
+      else
+        raise "should specific which is the first step"
+      end
+    end
+
+    @flow_steps[flow].push step_key
+    step_no = @flow_steps[flow].size
+    log.info "#{flow} flow start:" if is_first
+    log.info "  #{flow} #{step_no}):#{step_key}"
+    result = nil
+    # capture_stdout do
+      result = yield
+    # end
+    # step_log step_stdout
+    log.info "#{flow} flow end" if is_last
+    result
+  end
+
+  def step_log(message)
+    log.info "    #{message}"
+  end
+
+  # mark a step fails, reply errors message, stop rest steps
+  def step_fails(response, failure)
+    @step_failed = true
+    flow = @flow_steps.keys.last
+    step_no = @flow_steps[flow].size
+    step_key = @flow_steps[flow].last
+    failure = %{deploy faild on #{flow}(#{step_no}):#{step_key}\n} + failure
+    response.reply(failure)
+  end
+
+end

data/lita-capistrano_rails.gemspec

@@ -0,0 +1,24 @@
+Gem::Specification.new do |spec|
+  spec.name          = "lita-capistrano_rails"
+  spec.version       = "0.1.0"
+  spec.authors       = ["RainChen"]
+  spec.email         = ["hirainchen@gmail.com"]
+  spec.description   = "A Lita handler to integrate with Capistrano for rails project"
+  spec.summary       = "A Lita handler to integrate with Capistrano for rails project"
+  spec.homepage      = "https://github.com/rainchen/lita-capistrano_rails"
+  spec.license       = "TODO: Add a license"
+  spec.metadata      = { "lita_plugin_type" => "handler" }
+
+  spec.files         = `git ls-files`.split($/)
+  spec.executables   = spec.files.grep(%r{^bin/}) { |f| File.basename(f) }
+  spec.test_files    = spec.files.grep(%r{^(test|spec|features)/})
+  spec.require_paths = ["lib"]
+
+  spec.add_runtime_dependency "lita", ">= 4.6"
+
+  spec.add_development_dependency "bundler", "~> 1.3"
+  spec.add_development_dependency "pry-byebug"
+  spec.add_development_dependency "rake"
+  spec.add_development_dependency "rack-test"
+  spec.add_development_dependency "rspec", ">= 3.0.0"
+end

data/locales/en.yml

@@ -0,0 +1,4 @@
+en:
+  lita:
+    handlers:
+      capistrano_rails:

data/spec/lita/handlers/capistrano_rails_spec.rb

@@ -0,0 +1,4 @@
+require "spec_helper"
+
+describe Lita::Handlers::CapistranoRails, lita_handler: true do
+end

data/spec/spec_helper.rb

@@ -0,0 +1,6 @@
+require "lita-capistrano_rails"
+require "lita/rspec"
+
+# A compatibility mode is provided for older plugins upgrading from Lita 3. Since this plugin
+# was generated with Lita 4, the compatibility mode should be left disabled.
+Lita.version_3_compatibility_mode = false

metadata

@@ -0,0 +1,143 @@
+--- !ruby/object:Gem::Specification
+name: lita-capistrano_rails
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- RainChen
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2016-07-26 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: lita
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '4.6'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '4.6'
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.3'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.3'
+- !ruby/object:Gem::Dependency
+  name: pry-byebug
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: rack-test
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 3.0.0
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 3.0.0
+description: A Lita handler to integrate with Capistrano for rails project
+email:
+- hirainchen@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- Gemfile
+- README.md
+- Rakefile
+- lib/lita-capistrano_rails.rb
+- lib/lita/handlers/capistrano_rails.rb
+- lib/step_flow.rb
+- lita-capistrano_rails.gemspec
+- locales/en.yml
+- spec/lita/handlers/capistrano_rails_spec.rb
+- spec/spec_helper.rb
+- templates/.gitkeep
+homepage: https://github.com/rainchen/lita-capistrano_rails
+licenses:
+- 'TODO: Add a license'
+metadata:
+  lita_plugin_type: handler
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.5.1
+signing_key: 
+specification_version: 4
+summary: A Lita handler to integrate with Capistrano for rails project
+test_files:
+- spec/lita/handlers/capistrano_rails_spec.rb
+- spec/spec_helper.rb