build-buddy 1.0.6

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 0b2d3eab19b59adf57beb5489d827f289c871f8e
+  data.tar.gz: b6ea074f9c8e13b36247c839715e549bc25428bc
+SHA512:
+  metadata.gz: 66842f29b1f61fd65b290d88e346fa364dcdce66585100f77370c5216ed673e3b2c4a8831c800084eab887f7ffc122549eded0d780b6eacdfe72b640c02a37fb
+  data.tar.gz: 20063e74483fc136eab52fbbb6a772491a1a6b6fd7f600a0d02b4efa22ecd3d9d4f1e255d627d897f9cf1ef1148c75388c2117449328fba45b2a3bd6b62aecbd

data/bin/build-buddy

@@ -0,0 +1,47 @@
+#!/usr/bin/env ruby
+
+require 'rubygems'
+require 'bundler/setup'
+require 'celluloid/current'
+require 'celluloid/supervision'
+require 'celluloid/supervision/container'
+require 'methadone'
+require 'build_buddy'
+
+class Tool
+  include Methadone::Main
+  include Methadone::CLILogging
+
+  main do |config_name|
+    config_file_name = config_name
+
+    if File.extname(config_file_name) != '.bbconfig'
+      config_file_name += '.bbconfig'
+    end
+
+    load config_file_name
+
+    build_log_dir = BuildBuddy::Config.build_log_dir
+
+    unless Dir.exist?(build_log_dir)
+      Dir.mkdir(build_log_dir)
+    end
+
+    Slack.configure do |config|
+      config.token = BuildBuddy::Config.slack_api_token
+    end
+
+    Celluloid.logger = Reel::Logger.logger
+
+    BuildBuddy::Builder.supervise as: :builder
+    BuildBuddy::Server.supervise as: :server
+
+    sleep
+  end
+
+  version BuildBuddy::VERSION
+  description 'Build Buddy'
+  arg :config_name, :required
+
+  go!
+end

data/lib/build_buddy.rb

@@ -0,0 +1,9 @@
+require 'build_buddy/config'
+require 'build_buddy/server'
+require 'build_buddy/builder'
+require 'build_buddy/watcher'
+
+module BuildBuddy
+  VERSION = "1.0.6"
+end
+

data/lib/build_buddy/builder.rb

@@ -0,0 +1,80 @@
+require 'rubygems'
+require 'bundler'
+require 'celluloid'
+require 'ostruct'
+require_relative './watcher.rb'
+require_relative './config.rb'
+
+module BuildBuddy
+  class Builder
+    include Celluloid
+    include Celluloid::Internals::Logger
+
+    # TODO: Respond to request to kill the build.
+    # TODO: Kill the build pid after a certain amount of time has elapsed and report.
+
+    def initialize
+      @pid = nil
+      @watcher = nil
+    end
+
+    def start_build(build_data)
+      @build_data = build_data
+      repo_parts = build_data.repo_full_name.split('/')
+      command = "bash "
+      env = {
+          "GIT_REPO_OWNER" => repo_parts[0],
+          "GIT_REPO_NAME" => repo_parts[1],
+          "RBENV_DIR" => nil,
+          "RBENV_VERSION" => nil,
+          "PATH" => ENV['PATH'].split(':').select { |v| !v.match(/\.rbenv\/versions/) }.join(':')
+      }
+
+      case build_data.build_type
+        when :pull_request
+          env["GIT_PULL_REQUEST"] = build_data.pull_request.to_s
+          command += Config.pull_request_build_script
+        when :master
+          command += Config.master_build_script
+        when :release
+          env["GIT_BRANCH"] = build_data.build_version
+          command += Config.release_build_script
+        else
+          raise "Unknown build type"
+      end
+
+      build_log_filename = File.join(Config.build_log_dir, "build_#{build_data.build_type.to_s}_#{Time.now.utc.strftime('%Y%m%d%H%M%S')}.log")
+      build_data.build_log_filename = build_log_filename
+
+      command += " >#{build_log_filename} 2>&1"
+
+      Bundler.with_clean_env do
+        @pid = Process.spawn(env, command)
+      end
+      info "Running '#{command}' (process #{@pid})"
+
+      if @watcher
+        @watcher.terminate
+      end
+
+      @watcher = Watcher.new(@pid)
+      @watcher.async.watch_pid
+    end
+
+    def process_done(status)
+      @build_data.termination_type = (status.signaled? ? :killed : :exited)
+      @build_data.exit_code = (status.exited? ? status.exitstatus : -1)
+      info "Process #{status.pid} #{@build_data.termination_type == :killed ? 'was terminated' : "exited (#{@build_data.exit_code})"}"
+      Celluloid::Actor[:server].async.on_build_completed(@build_data)
+      @watcher.terminate
+      @watcher = nil
+    end
+
+    def stop_build
+      if @pid
+        info "Killing pid #{@pid}"
+        Process.kill(:SIGABRT, @pid)
+      end
+    end
+  end
+end

data/lib/build_buddy/config.rb

@@ -0,0 +1,28 @@
+module BuildBuddy
+  module Config
+    extend self
+
+    attr_accessor :github_webhook_secret_token
+    attr_accessor :github_webhook_repo_full_name
+    attr_accessor :github_api_token
+    attr_accessor :slack_api_token
+    attr_accessor :slack_build_channel
+    attr_accessor :slack_builders
+    attr_accessor :xcode_workspace
+    attr_accessor :xcode_test_scheme
+    attr_accessor :build_log_dir
+    attr_accessor :pull_request_build_script
+    attr_accessor :master_build_script
+    attr_accessor :release_build_script
+  end
+
+  class << self
+    def configure
+      block_given? ? yield(Config) : Config
+    end
+
+    def config
+      Config
+    end
+  end
+end

data/lib/build_buddy/server.rb

@@ -0,0 +1,288 @@
+require 'rubygems'
+require 'celluloid/current'
+require 'reel'
+require 'slack-ruby-client'
+require 'json'
+require 'ostruct'
+require 'octokit'
+require 'thread'
+require 'timers'
+require 'rack'
+require_relative './builder.rb'
+
+module BuildBuddy
+  class Server < Reel::Server::HTTP
+    include Celluloid::Internals::Logger
+
+    def initialize(host = "127.0.0.1", port = 4567)
+      super(host, port, &method(:on_connection))
+      @gh_client ||= Octokit::Client.new(:access_token => Config.github_api_token)
+      @rt_client = Slack::RealTime::Client.new
+      @rt_client.on :hello do
+        self.on_slack_hello()
+      end
+      @rt_client.on :message do |data|
+        self.on_slack_data(data)
+      end
+      @rt_client.on :error do |error|
+        self.on_slack_error(error)
+      end
+      @rt_client.start_async
+      @active_build = nil
+      @build_queue = Queue.new
+      @done_queue = Queue.new
+      @notify_slack_channel = nil
+      @reverse_user_map = nil
+    end
+
+    def on_slack_error(error)
+      sub_error = error['error']
+      error "Whoops! Slack error #{sub_error['code']} - #{sub_error['msg']}}"
+    end
+
+    def on_slack_hello
+      user_id = @rt_client.self['id']
+      user_map = @rt_client.users.map {|user| [user['name'], user['id']]}.to_h
+      @reverse_user_map = user_map.invert
+      info "Connected to Slack as user id #{user_id} (@#{@reverse_user_map[user_id]})"
+
+      channel_map = @rt_client.channels.map {|channel| [channel['name'], channel['id']]}.to_h
+      group_map = @rt_client.groups.map {|group| [group['name'], group['id']]}.to_h
+      channel = Config.slack_build_channel
+      is_channel = (channel[0] == '#')
+
+      @notify_slack_channel = (is_channel ? channel_map[channel[1..-1]] : group_map[channel])
+      if @notify_slack_channel.nil?
+        error "Unable to identify the slack channel #{channel}"
+      else
+        info "Slack notification channel is #{@notify_slack_channel} (#{channel})"
+      end
+    end
+
+    def on_slack_data(data)
+      message = data['text']
+
+      # If no message, then there's nothing to do
+      if message.nil?
+        return
+      end
+
+      sending_user_id = data['user']
+      sending_user_name = @reverse_user_map[sending_user_id]
+
+      # Don't respond if _we_ sent the message!
+      if sending_user_id == @rt_client.self['id']
+        return
+      end
+
+      sender_is_a_builder = (Config.slack_builders.nil? ? true : Config.slack_builders.include?('@' + sending_user_name))
+
+      c = data['channel'][0]
+      in_channel = (c == 'C' || c == 'G')
+
+      # Don't respond if the message is to a channel and our name is not in the message
+      if in_channel and !message.match(@rt_client.self['id'])
+        return
+      end
+
+      case message
+        when /build/i
+          unless sender_is_a_builder
+            if in_channel
+              response = "I'm sorry @#{sending_user_name} you are not on my list of allowed builders."
+            else
+              response = "I'm sorry but you are not on my list of allowed builders."
+            end
+          else
+            case message
+              when /master/i
+                response = "OK, I've queued a build of the `master` branch."
+                queue_a_build(OpenStruct.new(
+                    :build_type => :master,
+                    :repo_full_name => Config.github_webhook_repo_full_name))
+              when /(?<version>v\d+\.\d+)/
+                version = $~[:version]
+                response = "OK, I've queued a build of `#{version}` branch."
+                queue_a_build(OpenStruct.new(
+                    :build_type => :release,
+                    :build_version => version,
+                    :repo_full_name => Config.github_webhook_repo_full_name))
+              when /stop/i
+                build_data = @active_build
+                if build_data.nil?
+                  response = "There is no build running to stop"
+                else
+                  # TODO: We need some more checks here to avoid accidental stoppage
+                  response = "OK, I'm trying to *stop* the currently running build..."
+                  Celluloid::Actor[:builder].async.stop_build
+                end
+              else
+                response = "Sorry#{in_channel ? " <@#{data['user']}>" : ""}, I'm not sure if you want do an internal *master*, external *M.m* build, or maybe *stop* any running build?"
+            end
+          end
+        when /status/i
+          build_data = @active_build
+          queue_length = @build_queue.length
+          if build_data == nil
+            response = "There is currently no build running"
+            if queue_length == 0
+              response += " and no builds in the queue."
+            else
+              response += " and #{queue_length} in the queue."
+            end
+          else
+            case build_data.build_type
+              when :pull_request
+                response = "There is a pull request build in progress for https://github.com/#{build_data.repo_full_name}/pull/#{build_data.pull_request}."
+              when :master
+                response = "There is a build of the `master` branch of https://github.com/#{build_data.repo_full_name} in progress."
+              when :release
+                response = "There is a build of the `#{build_data.build_version}` branch of https://github.com/#{build_data.repo_full_name} in progress."
+            end
+            if queue_length == 1
+              response += " There is one build in the queue."
+            elsif queue_length > 1
+              response += " There are #{queue_length} builds in the queue."
+            end
+          end
+        when /help/i, /what can/i
+          # TODO: The repository should be a link to GitHub
+          response = %Q(Hello#{in_channel ? " <@#{data['user']}>" : ""}, I'm the *@#{@rt_client.self['name']}* build bot! I look after 3 types of build: pull request, master and release.
+
+  A pull request *build* happens when you make a pull request to the *#{Config.github_webhook_repo_full_name}* GitHub repository. I can stop those builds if you ask me too through Slack, but you have to start them with a pull request.
+
+  I can run builds of the *master* branch when you ask me, as well as doing builds of a release branch, e.g. *v1.0*, *v2.3*, etc..
+
+  You can also ask me about the *status* of builds and I'll tell you if anything is currently happening.
+
+  I am configured to let the *\##{Config.slack_build_channel}* channel know if master or release builds fail. Note the words I have highlighted in bold. These are the keywords that I'll look for to understand what you are asking me.
+  )
+        else
+          response = "Sorry#{in_channel ? " <@#{data['user']}>" : ""}, I'm not sure how to respond."
+      end
+      @rt_client.message channel: data['channel'], text: response
+      info "Slack message '#{message}' from #{data['channel']} handled"
+    end
+
+    def on_connection(connection)
+      connection.each_request do |request|
+        case request.method
+        when 'POST'
+          case request.path
+          when '/webhook'
+            case request.headers["X-GitHub-Event"]
+              when 'pull_request'
+                payload_text = request.body.to_s
+                # TODO: Also need to validate that it's the github_webhook_repo_full_name
+                if !verify_signature(payload_text, request.headers["X-Hub-Signature"])
+                  request.respond 500, "Signatures didn't match!"
+                else
+                  payload = JSON.parse(payload_text)
+                  pull_request = payload['pull_request']
+                  build_data = OpenStruct.new(
+                    :build_type => :pull_request,
+                    :pull_request => pull_request['number'],
+                    :repo_sha => pull_request['head']['sha'],
+                    :repo_full_name => pull_request['base']['repo']['full_name'])
+                  info "Got pull request #{build_data[:pull_request]} from GitHub"
+                  queue_a_build(build_data)
+                  request.respond 200
+                end
+              when 'ping'
+                request.respond 200, "Running"
+              else
+                request.respond 404, "Path not found"
+            end
+          end
+          else
+            request.respond 404, "Method not supported"
+        end
+      end
+    end
+
+    def queue_a_build(build_data)
+      @build_queue.push(build_data)
+
+      case build_data.build_type
+        when :pull_request
+          @gh_client.create_status(
+            build_data.repo_full_name, build_data.repo_sha, 'pending',
+            { :description => "This build is in the queue" })
+          info "Pull request build queued"
+        when :master
+          info "Internal build queued"
+        when :release
+          info "External build queued"
+      end
+
+      if @build_timer.nil?
+        @build_timer = every(5) { on_build_interval }
+        info "Build timer started"
+      end
+    end
+
+    def on_build_interval
+      if @active_build.nil?
+        if @build_queue.length > 0
+          build_data = @build_queue.pop()
+          @active_build = build_data
+          # TODO: Add timing information into the build_data
+          if build_data.build_type == :pull_request
+            @gh_client.create_status(
+              build_data.repo_full_name, build_data.repo_sha, 'pending',
+              { :description => "This build has started" })
+          end
+          Celluloid::Actor[:builder].async.start_build(build_data)
+        elsif @done_queue.length > 0
+          # TODO: Should pop everything in the done queue
+          build_data = @done_queue.pop
+          term_msg = (build_data.termination_type == :killed ? "was stopped" : "completed")
+          if build_data.termination_type == :exited
+            if build_data.exit_code != 0
+              term_msg += " with errors (exit code #{build_data.exit_code}). See log file `#{build_data.build_log_filename}` for more details."
+            else
+              term_msg += " successfully"
+            end
+          end
+          if build_data.build_type == :pull_request
+            description = "The buddy build #{term_msg}"
+            @gh_client.create_status(
+              build_data.repo_full_name, build_data.repo_sha,
+              build_data.termination_type == :killed ? 'failure' : build_data.exit_code != 0 ? 'error' : 'success',
+              { :description => description })
+            info "Pull request build #{term_msg}"
+          else
+            case build_data.build_type
+              when :master
+                message = "A build of the `master` branch #{term_msg}."
+                info "Internal build #{term_msg}"
+              when :release
+                message = "A build of the `#{build_data.build_version}` branch #{term_msg}."
+                info "External build #{term_msg}"
+            end
+            unless @notify_slack_channel.nil?
+              @rt_client.message(channel: @notify_slack_channel, text: message)
+            end
+          end
+        else
+          @build_timer.cancel
+          @build_timer = nil
+          info "Build timer stopped"
+        end
+      else
+        # TODO: Make sure that the build has not run too long and kill if necessary
+      end
+    end
+
+    def on_build_completed(build_data)
+      @active_build = nil
+      @done_queue.push(build_data)
+    end
+
+    def verify_signature(payload_body, gh_signature)
+      signature = 'sha1=' + OpenSSL::HMAC.hexdigest(
+          OpenSSL::Digest.new('sha1'), Config.github_webhook_secret_token, payload_body)
+      Rack::Utils.secure_compare(signature, gh_signature)
+    end
+  end
+end

data/lib/build_buddy/watcher.rb

@@ -0,0 +1,17 @@
+require 'rubygems'
+require 'celluloid'
+
+module BuildBuddy
+  class Watcher
+    include Celluloid
+
+    def initialize(pid)
+      @pid = pid
+    end
+
+    def watch_pid
+      Process.waitpid2(@pid)
+      Celluloid::Actor[:builder].async.process_done($?)
+    end
+  end
+end

metadata

@@ -0,0 +1,204 @@
+--- !ruby/object:Gem::Specification
+name: build-buddy
+version: !ruby/object:Gem::Version
+  version: 1.0.6
+platform: ruby
+authors:
+- John Lyon-smith
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2016-01-27 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: timers
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '4.1'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '4.1'
+- !ruby/object:Gem::Dependency
+  name: celluloid
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.17.2
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.17.2
+- !ruby/object:Gem::Dependency
+  name: celluloid-supervision
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.20.5
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.20.5
+- !ruby/object:Gem::Dependency
+  name: methadone
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.9'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.9'
+- !ruby/object:Gem::Dependency
+  name: slack-ruby-client
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.5.3
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.5.3
+- !ruby/object:Gem::Dependency
+  name: json
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.8'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.8'
+- !ruby/object:Gem::Dependency
+  name: http
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.0'
+- !ruby/object:Gem::Dependency
+  name: reel
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '='
+      - !ruby/object:Gem::Version
+        version: 0.6.0.pre3
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '='
+      - !ruby/object:Gem::Version
+        version: 0.6.0.pre3
+- !ruby/object:Gem::Dependency
+  name: octokit
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '4.2'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '4.2'
+- !ruby/object:Gem::Dependency
+  name: rack
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.6'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.6'
+- !ruby/object:Gem::Dependency
+  name: code-tools
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '5.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '5.0'
+description: A build buddy bot with GitHub and Slack integration.
+email: john@jamoki.com
+executables:
+- build-buddy
+extensions: []
+extra_rdoc_files: []
+files:
+- bin/build-buddy
+- lib/build_buddy.rb
+- lib/build_buddy/builder.rb
+- lib/build_buddy/config.rb
+- lib/build_buddy/server.rb
+- lib/build_buddy/watcher.rb
+homepage: http://rubygems.org/gems/build-buddy
+licenses:
+- MIT
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - "~>"
+    - !ruby/object:Gem::Version
+      version: '2.2'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.4.5
+signing_key: 
+specification_version: 4
+summary: An automated build buddy
+test_files: []