robopigeon 0.1.0

data/lib/robopigeon/dsl.rb

@@ -0,0 +1,46 @@
+require 'robopigeon/dsl/helpers'
+require 'robopigeon/dsl/initial_jobs'
+require 'robopigeon/dsl/job'
+
+module RoboPigeon::Dsl
+  class Root
+    include RoboPigeon::Dsl::InitialJobs
+    attr_accessor :jobs, :file
+
+    def initialize(file = RoboPigeon::DEFAULT_FILE)
+      self.file = file
+      self.jobs = {}
+      base
+      init_help
+      if File.exist?(file)
+        instance_exec do
+          eval(File.read(file))
+        end
+      else
+        init_job
+      end
+    end
+
+    def run(name)
+      jobs[name][:action].call
+    end
+
+    def job?(name)
+      !jobs[name].nil?
+    end
+
+    def usage
+      max_size = jobs.keys.max_by(&:length).size
+      jobs_strings = jobs.keys.reject do |key|
+        jobs[key][:hidden]
+      end.map do |name|
+        padding = ' ' * (max_size - name.length)
+        "  '#{name}' #{padding}- #{jobs[name][:desc]}"
+      end.join("\n")
+      puts "Usage: robopigeon 'job name'"
+      puts "Jobs are configured in #{file}"
+      puts 'See https://gitlab.com/robopigeon/robopigeon for configuration'
+      puts "Configured Jobs:\n#{jobs_strings}"
+    end
+  end
+end

data/lib/robopigeon/git/helper_dsl.rb

@@ -0,0 +1,60 @@
+module RoboPigeon::Dsl
+  module Helpers
+    module Git
+      RoboPigeon::Documentarian.add_command('git_committer_name', block: ['helpers'], desc: 'name of the last person to make a non-merge commit')
+      def git_committer_name
+        `git log -1 --pretty=format:'%an' --no-merges`
+      end
+
+      RoboPigeon::Documentarian.add_command('git_committer_email', block: ['helpers'], desc: 'email of the last person to make a non-merge commit')
+      def git_committer_email
+        `git log -1 --pretty=format:'%ae' --no-merges`
+      end
+
+      RoboPigeon::Documentarian.add_command('git_merger_name', block: ['helpers'], desc: 'name of the last person to make a merge commit')
+      def git_merger_name
+        `git log -1 --pretty=format:'%an' --merges`
+      end
+
+      RoboPigeon::Documentarian.add_command('git_merger_email', block: ['helpers'], desc: 'email of the last person to make a merge commit')
+      def git_merger_email
+        `git log -1 --pretty=format:'%ae' --merges`
+      end
+
+      RoboPigeon::Documentarian.add_command('git_branch_merged_source', block: ['helpers'], desc: 'source branch in the last merge commit')
+      def git_branch_merged_source
+        get_merge_data[:source]
+      end
+
+      RoboPigeon::Documentarian.add_command('git_branch_merged_target', block: ['helpers'], desc: 'target branch in the last merge commit')
+      def git_branch_merged_target
+        get_merge_data[:target]
+      end
+
+      private
+
+      def merge_commit_subject
+        `git log -1 --merges --pretty=format:'%s'`
+      end
+
+      def get_merge_data
+        commit_subject = merge_commit_subject || ''
+        if data = commit_subject.match(/Merge branch '(.*)' into '(.*)'/)
+          return {
+            source: data[1],
+            target: data[2]
+          }
+        elsif data = commit_subject.match(/Merge branch '(.*)' of (.*)/)
+          return {
+            source: "#{data[2]}/#{data[1]}",
+            target: data[1]
+          }
+        end
+        {
+          source: 'unknown',
+          target: 'unknown'
+        }
+      end
+    end
+  end
+end

data/lib/robopigeon/git.rb

@@ -0,0 +1,7 @@
+require 'robopigeon/git/helper_dsl'
+
+module RoboPigeon::Dsl
+  module Helpers
+    include RoboPigeon::Dsl::Helpers::Git
+  end
+end

data/lib/robopigeon/gitlab/client.rb

@@ -0,0 +1,42 @@
+module RoboPigeon::GitLab
+  class Client
+    @project = ENV['CI_PROJECT_PATH']
+    @pipeline_id = ENV['CI_PIPELINE_ID']
+    @branch = ENV['CI_COMMIT_REF_NAME']
+    @enabled = true
+
+    class << self
+      attr_accessor :project, :branch, :pipeline_id, :enabled
+      def client
+        Gitlab.client
+      end
+
+      def get_deployment(environment, page = 0)
+        deployments = client.deployments(
+          project,
+          order_by: 'created_at',
+          sort: 'desc',
+          per_page: 20,
+          page: page
+        )
+        deployment = deployments.select { |dep| dep.environment.name == environment }.first
+        return get_deployment(environment, project, page + 1) if deployment.nil? && deployments.has_next_page?
+
+        deployment
+      end
+
+      def create_tag(ref, tag, message)
+        client.create_tag(project, tag, ref, message)
+      end
+
+      def merge_request_comment(text, source = branch)
+        merge_requests = client.merge_requests(project, source_branch: source)
+        raise "No merge requests exist for branch '#{source}'" if merge_requests.empty?
+
+        merge_requests.each do |merge_request|
+          client.create_merge_request_discussion(project, merge_request.iid, body: text)
+        end
+      end
+    end
+  end
+end

data/lib/robopigeon/gitlab/dsl.rb

@@ -0,0 +1,174 @@
+require 'gitlab'
+module RoboPigeon::Dsl
+  class GitLabRoot
+    def self.run(&block)
+      gitlab = RoboPigeon::Dsl::GitLabRoot.new
+      gitlab.instance_eval(&block)
+    end
+
+    RoboPigeon::Documentarian.add_command(
+      'enabled',
+      block: ['gitlab'],
+      params: [
+        { name: 'enabled', type: 'boolean', desc: 'should it run gitlab commands', example: 'false', default: 'true' }
+      ],
+      desc: 'Set whether or not to run gitlab commands, defaults to true'
+    )
+    def enabled(bool)
+      RoboPigeon::GitLab::Client.enabled = bool
+    end
+
+    RoboPigeon::Documentarian.add_command(
+      'api_key',
+      block: ['gitlab'],
+      params: [
+        { name: 'api_key', type: 'String', desc: 'your gitlab api key', example: 'aeoiabDasdf-B', default: "ENV['GITLAB_API_KEY']" }
+      ],
+      desc: 'Set the gitlab api key for your gitlab account'
+    )
+    def api_key(key)
+      Gitlab.private_token = key
+    end
+
+    RoboPigeon::Documentarian.add_command(
+      'api_url',
+      block: ['gitlab'],
+      params: [
+        { name: 'url', type: 'String', desc: 'the url to your gitlab instance', example: 'https://gitlab.com/api/v4/', default: "ENV['CI_API_V4_URL']" }
+      ],
+      desc: 'Set the gitlab api url for your account'
+    )
+    def api_url(url)
+      Gitlab.endpoint = url
+    end
+
+    RoboPigeon::Documentarian.add_command(
+      'project',
+      block: ['gitlab'],
+      params: [
+        { name: 'project_path', type: 'String', desc: 'path to your project', example: 'robopigeon/robopigeon', default: "ENV['CI_PROJECT_PATH']" }
+      ],
+      desc: 'Override the project path reference'
+    )
+    def project(project_path)
+      RoboPigeon::GitLab::Client.project = project_path
+    end
+
+    RoboPigeon::Documentarian.add_command(
+      'pipeline_id',
+      block: ['gitlab'],
+      params: [
+        { name: 'pipeline_id', type: 'String', desc: 'id of the current pipeline', example: '1359234', default: "ENV['CI_PIPELINE_ID']" }
+      ],
+      desc: 'Override the pipeline id reference'
+    )
+    def pipeline_id(pipeline_id)
+      RoboPigeon::GitLab::Client.pipeline_id = pipeline_id
+    end
+
+    RoboPigeon::Documentarian.add_command(
+      'branch',
+      block: ['gitlab'],
+      params: [
+        { name: 'branch', type: 'String', desc: 'branch you want to refer to', example: 'master', default: "ENV['CI_COMMIT_REF_NAME']" }
+      ],
+      desc: 'Override the branch reference'
+    )
+    def branch(branch)
+      RoboPigeon::GitLab::Client.branch = branch
+    end
+  end
+
+  class GitLab < GitLabRoot
+    attr_accessor :merge_request
+    include RoboPigeon::Dsl::Helpers
+
+    def self.run(&block)
+      if RoboPigeon::GitLab::Client.enabled
+        gitlab = RoboPigeon::Dsl::GitLab.new
+        gitlab.instance_eval(&block)
+      else
+        puts 'Gitlab is disabled, please remove `enabled false` from your global gitlab config'
+      end
+    end
+
+    RoboPigeon::Documentarian.add_command(
+      'merge_request_comment',
+      block: %w[job gitlab],
+      params: [
+        { name: 'text', type: 'String', desc: 'text you want to post as a comment', example: 'this branch failed during a deployment' },
+        { name: 'source_branch', type: 'String', desc: 'branch you want to refer to', example: 'master', default: "current global branch, defaults ENV['CI_COMMIT_REF_NAME']" }
+      ],
+      desc: 'post a comment to all merge requests with the branch source'
+    )
+    def merge_request_comment(text, source_branch = RoboPigeon::GitLab::Client.branch)
+      RoboPigeon::GitLab::Client.merge_request_comment(text, source_branch)
+    end
+
+    RoboPigeon::Documentarian.add_command(
+      'create_merge_request',
+      block: %w[job gitlab],
+      params: [
+        { name: 'source_branch', type: 'String', desc: 'source branch you want to merge from', example: "ENV['CI_COMMIT_REF_NAME']" },
+        { name: 'target_branch', type: 'String', desc: 'target branch to merge to', example: 'master' },
+        { name: 'title', type: 'String', desc: 'Optional string to use as the merge request title.', example: 'Merge my_face into master on tuesdays', default: "Automated merge request from \#{source} to \#{target}" }
+      ],
+      desc: 'create a merge request between two supplied branches'
+    )
+    def create_merge_request(source, target, arg_title=nil)
+      title = arg_title || "Automated merge request from #{source} to #{target}"
+      self.merge_request = RoboPigeon::GitLab::MergeRequest.create!(source, target, title)
+    end
+
+    RoboPigeon::Documentarian.add_command(
+      'merge_branches',
+      block: %w[job gitlab],
+      params: [
+        { name: 'source_branch', type: 'String', desc: 'source branch you want to merge from', example: "ENV['CI_COMMIT_REF_NAME']" },
+        { name: 'target_branch', type: 'String', desc: 'target branch to merge to', example: 'master' },
+        { name: 'title', type: 'String', desc: 'Optional string to use as the merge request title.', example: 'Merge my_face into master on tuesdays', default: "Automated merge request from \#{source} to \#{target}" }
+      ],
+      desc: 'merge two branches together using a merge request that automatically merges'
+    )
+    def merge_branches(source, target, arg_title=nil)
+      title = arg_title || "Automated merge request from #{source} to #{target}"
+      RoboPigeon::GitLab::MergeRequest.create!(source, target, title).merge!
+    end
+
+    RoboPigeon::Documentarian.add_command(
+      'tag',
+      block: %w[job gitlab],
+      params: [
+        { name: 'tag', type: 'String', desc: 'the tag to create', example: '1.2.3' },
+        { name: 'ref', type: 'String', desc: 'branch or sha that you want to tag', example: 'master', default: ENV['CI_COMMIT_REF_NAME'] },
+        { name: 'message', type: 'String', desc: 'message to annotate the tag with', example: 'updating version to 1.2.3', default: "RoboPigeon tagged at \#{Time.now}" }
+      ],
+      desc: 'look up a merge request by source and target'
+    )
+    def tag(tag, ref=ENV['CI_COMMIT_REF_NAME'], message="RoboPigeon tagged at #{Time.now}")
+      RoboPigeon::GitLab::Client.create_tag(ref, tag, message)
+    end
+
+    RoboPigeon::Documentarian.add_command(
+      'find_merge_request',
+      block: %w[job gitlab],
+      params: [
+        { name: 'source_branch', type: 'String', desc: 'source branch you want to merge from', example: "ENV['CI_COMMIT_REF_NAME']" },
+        { name: 'target_branch', type: 'String', desc: 'target branch to merge to', example: 'master' }
+      ],
+      desc: 'look up a merge request by source and target'
+    )
+    def find_merge_request(source, target)
+      RoboPigeon::GitLab::MergeRequest.find(source, target)
+    end
+
+    RoboPigeon::Documentarian.add_command(
+      'merge_merge_request',
+      block: %w[job gitlab],
+      desc: 'merge the recently created merge request'
+    )
+    def merge_merge_request
+      merge_request.merge!
+    end
+  end
+end

data/lib/robopigeon/gitlab/helper_dsl.rb

@@ -0,0 +1,44 @@
+require 'gitlab'
+
+module RoboPigeon::Dsl
+  module Helpers
+    module GitLab
+      RoboPigeon::Documentarian.add_command('deployment_sha', block: ['helpers'], params: [{ name: 'environment', type: 'String', desc: 'the name of a gitlab operations environment', example: 'production' }], desc: 'get the git sha of the specified deployed environement')
+      def deployment_sha(environment)
+        dep = RoboPigeon::GitLab::Client.get_deployment(environment)
+        dep.sha
+      end
+
+      RoboPigeon::Documentarian.add_command('deployment_ref', block: ['helpers'], params: [{ name: 'environment', type: 'String', desc: 'the name of a gitlab operations environment', example: 'production' }], desc: 'get the git ref (branch or tag) of the specified deployed environement')
+      def deployment_ref(environment)
+        dep = RoboPigeon::GitLab::Client.get_deployment(environment)
+        dep.ref
+      end
+
+      RoboPigeon::Documentarian.add_command('deployment_shortlog', block: ['helpers'], params: [{ name: 'environment', type: 'String', desc: 'the name of a gitlab operations environment', example: 'production' }], desc: 'get a shortlog of changes between head and the specified environment')
+      def deployment_shortlog(environment)
+        dep = RoboPigeon::GitLab::Client.get_deployment(environment)
+        `git shortlog --no-merges #{dep.sha}..`
+      end
+
+      RoboPigeon::Documentarian.add_command('deployment_time', block: ['helpers'], params: [{ name: 'environment', type: 'String', desc: 'the name of a gitlab operations environment', example: 'production' }], desc: 'get the time the last deployment for the given environment happened')
+      def deployment_time(environment)
+        dep = RoboPigeon::GitLab::Client.get_deployment(environment)
+        dep.deployable.finished_at
+      end
+
+      RoboPigeon::Documentarian.add_command('deployment_git_log_jira_tickets',
+                                            block: ['helpers'],
+                                            params: [
+                                              { name: 'environment', type: 'String', desc: 'the name of a gitlab operations environment', example: 'production' },
+                                              { name: 'project_key', type: 'String', desc: 'the project key to search history for', example: 'TIC' }
+                                            ],
+                                            desc: 'returns a list of jira tickets for the given project key in history since the deployment')
+      def tickets_in_log_since_deployment_to(environment, _project)
+        dep = RoboPigeon::GitLab::Client.get_deployment(environment)
+        log = `git log #{dep.sha}..`
+        log.scan(/[A-Za-z]+-\d+/)
+      end
+    end
+  end
+end

data/lib/robopigeon/gitlab/merge_request.rb

@@ -0,0 +1,78 @@
+module RoboPigeon::GitLab
+  class MergeRequest
+    attr_accessor :merge_request
+    def initialize(merge_request)
+      self.merge_request = merge_request
+    end
+
+    def self.create!(source, target, title)
+      RoboPigeon::GitLab::MergeRequest.new(RoboPigeon::GitLab::Client.client.create_merge_request(
+                                             RoboPigeon::GitLab::Client.project,
+                                             title,
+                                             source_branch: source,
+                                             target_branch: target
+                                           ))
+    end
+
+    def self.find(source, target)
+      RoboPigeon::GitLab::MergeRequest.new(
+        RoboPigeon::GitLab::Client.client.merge_requests(
+          RoboPigeon::GitLab::Client.project,
+          state: 'opened',
+          source_branch: source,
+          target_branch: target
+        ).first
+      )
+    end
+
+    def gitlab
+      RoboPigeon::GitLab::Client
+    end
+
+    def client
+      gitlab.client
+    end
+
+    def comment!(text)
+      client.create_merge_request_note(RoboPigeon::GitLab::Client.project, merge_request.iid, body: text)
+    end
+
+    def merge!
+      return if already_up_to_date
+
+      return if merge_merge_request!
+
+      close_merge_request!
+      raise 'Merge request could not be merged'
+    end
+
+    private
+
+    def already_up_to_date
+      if merge_request.changes_count.nil? || merge_request.changes_count == '0'
+        close_merge_request!
+        puts 'Merge request had no changes, aborting.'
+        return true
+      end
+      false
+    end
+
+    def merge_merge_request!
+      begin
+        merge = client.accept_merge_request(RoboPigeon::GitLab::Client.project, merge_request.iid, merge_when_pipeline_succeeds: true)
+        return merge.merge_status == 'can_be_merged' && (merge.merge_when_pipeline_succeeds || merge.state == 'merged')
+      rescue Gitlab::Error::Error => e
+        puts "Failed to merge branch - #{e}\n#{e.message}"
+      end
+      false
+    end
+
+    def close_merge_request!
+      client.update_merge_request(RoboPigeon::GitLab::Client.project, merge_request.iid, state_event: 'close')
+      true
+    rescue Gitlab::Error::Error => e
+      puts "Failed to close merge request - #{e}\n#{e.message}"
+      false
+    end
+  end
+end

data/lib/robopigeon/gitlab.rb

@@ -0,0 +1,29 @@
+RoboPigeon::Documentarian.add_block('gitlab', helpers: true, block: [], desc: 'a configuration block for gitlab')
+RoboPigeon::Documentarian.add_block('gitlab', helpers: true, block: ['job'], desc: 'interact with gitlab, can have multiple')
+
+require 'robopigeon/gitlab/dsl'
+require 'robopigeon/gitlab/client'
+require 'robopigeon/gitlab/merge_request'
+require 'robopigeon/gitlab/helper_dsl'
+
+module RoboPigeon::Dsl
+  module Helpers
+    include RoboPigeon::Dsl::Helpers::GitLab
+  end
+end
+
+module RoboPigeon::Dsl
+  class Root
+    def gitlab(&block)
+      RoboPigeon::Dsl::GitLabRoot.run(&block)
+    end
+  end
+end
+
+module RoboPigeon::Dsl
+  class Job
+    def gitlab(&block)
+      RoboPigeon::Dsl::GitLab.run(&block)
+    end
+  end
+end

data/lib/robopigeon/jira/client.rb

@@ -0,0 +1,17 @@
+module RoboPigeon::Jira
+  class Client
+    @enabled = true
+    @api_key = ENV['JIRA_TOKEN']
+
+    class << self
+      attr_accessor :api_key, :api_url, :enabled, :last_created_ticket
+      def jira_request
+        Faraday.new(url: RoboPigeon::Jira::Client.api_url) do |faraday|
+          faraday.adapter Faraday.default_adapter
+          faraday.headers['Content-Type'] = 'application/json'
+          faraday.headers['Authorization'] = 'Basic ' + RoboPigeon::Jira::Client.api_key
+        end
+      end
+    end
+  end
+end

data/lib/robopigeon/jira/dsl.rb

@@ -0,0 +1,81 @@
+module RoboPigeon::Dsl
+  class JiraRoot
+    def self.run(&block)
+      jira = RoboPigeon::Dsl::JiraRoot.new
+      jira.instance_eval(&block)
+    end
+
+    RoboPigeon::Documentarian.add_command(
+      'enabled',
+      block: ['jira'],
+      params: [
+        { name: 'enabled', type: 'boolean', desc: 'should it run jira commands', example: 'false', default: 'true' }
+      ],
+      desc: 'Set whether or not to run jira commands, defaults to true'
+    )
+    def enabled(bool)
+      RoboPigeon::Jira::Client.enabled = bool
+    end
+
+    RoboPigeon::Documentarian.add_command(
+      'api_key',
+      block: ['jira'],
+      params: [
+        { name: 'api_key', type: 'String', desc: 'the api key for your jira account', example: 'someLongString12ofLettersAndNumber5', default: "ENV['JIRA_TOKEN']" }
+      ],
+      desc: 'set your jira api key globally'
+    )
+    def api_key(key)
+      RoboPigeon::Jira::Client.api_key = key
+    end
+
+    RoboPigeon::Documentarian.add_command(
+      'api_url',
+      block: ['jira'],
+      params: [
+        { name: 'api_url', type: 'String', desc: 'the api url for your jira', example: 'https://jira.example.com/' }
+      ],
+      desc: 'set your jira api key globally'
+    )
+    def api_url(key)
+      RoboPigeon::Jira::Client.api_url = key
+    end
+  end
+
+  class Jira < JiraRoot
+    include RoboPigeon::Dsl::Helpers
+
+    def self.run(&block)
+      jira = RoboPigeon::Dsl::Jira.new
+      jira.instance_eval(&block)
+    end
+
+    RoboPigeon::Documentarian.add_block(
+      'ticket',
+      params: [
+        { name: 'number', type: 'String', desc: 'Existing ticket number to reference (optional)', example: 'TIC-1234' }
+      ],
+      helpers: true,
+      block: %w[job jira],
+      desc: 'Create or update a ticket'
+    )
+    def ticket(number = nil, &block)
+      RoboPigeon::Dsl::JiraTicket.run(number, &block)
+    end
+
+    RoboPigeon::Documentarian.add_block(
+      'comment_on',
+      params: [
+        { name: 'number', type: 'String', desc: 'Existing ticket number to reference', example: 'TIC-1234' },
+        { name: 'comment', type: 'String', desc: 'Comment to add to the ticket', example: 'A comment for a ticket' }
+      ],
+      helpers: true,
+      block: %w[job jira],
+      desc: 'Add a comment to specified ticket'
+    )
+    def comment_on(number, comment)
+      jira = RoboPigeon::Jira::Ticket.new(number)
+      jira.add_comment(comment)
+    end
+  end
+end

data/lib/robopigeon/jira/helper_dsl.rb

@@ -0,0 +1,24 @@
+module RoboPigeon::Dsl
+  module Helpers
+    module Jira
+      RoboPigeon::Documentarian.add_command('jira_last_created_ticket', block: ['helpers'], desc: 'Returns the id of the last created ticket.')
+      def jira_last_created_ticket
+        RoboPigeon::Jira::Client.last_created_ticket
+      end
+
+      RoboPigeon::Documentarian.add_command('jira_last_created_ticket_link', block: ['helpers'], desc: 'Returns a link to the last created ticket.')
+      def jira_last_created_ticket_link
+        issue_id = RoboPigeon::Jira::Client.last_created_ticket
+        jira_url = RoboPigeon::Jira::Client.api_url
+        "#{jira_url}/browse/#{issue_id}"
+      end
+
+      RoboPigeon::Documentarian.add_command('jira_last_created_ticket_slack_link', block: ['helpers'], desc: 'Returns a slack formatted link to the last created ticket.')
+      def jira_last_created_ticket_slack_link
+        issue_id = RoboPigeon::Jira::Client.last_created_ticket
+        jira_url = RoboPigeon::Jira::Client.api_url
+        "<#{issue_id}|#{jira_url}/browse/#{issue_id}>"
+      end
+    end
+  end
+end