robopigeon 0.1.0 → 0.2.0

data/lib/robopigeon/extend/templates/default/lib/robopigeon-extension.erb.rb

@@ -0,0 +1,25 @@
+require 'robopigeon-<%= extension_name_lower %>/helper_dsl'
+require 'robopigeon-<%= extension_name_lower %>/dsl'
+require 'robopigeon-<%= extension_name_lower %>/version'
+
+module RoboPigeon::Dsl
+  module Helpers
+    include RoboPigeon::Dsl::Helpers::<%= extension_name_upper %>
+  end
+end
+
+module RoboPigeon::Dsl
+  class Root
+    def <%= extension_name_lower %>(&block)
+      RoboPigeon::Dsl::<%= extension_name_upper %>Root.run(&block)
+    end
+  end
+end
+
+module RoboPigeon::Dsl
+  class Job
+    def <%= extension_name_lower %>(&block)
+      RoboPigeon::Dsl::<%= extension_name_upper %>.run(&block)
+    end
+  end
+end

data/lib/robopigeon/extend/templates/default/robopigeon-extension.erb.gemspec

@@ -0,0 +1,41 @@
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'robopigeon-<%= extension_name_lower %>/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = 'robopigeon-<%= extension_name_lower %>'
+  spec.version       = RoboPigeon::<%= extension_name_upper %>::VERSION
+  spec.authors       = ['<%= user_name %>']
+  spec.email         = ['<%= user_email %>']
+
+  spec.summary       = 'An extension for RoboPigeon for <%= extension_name_upper %>'
+  spec.description   = 'TODO: Add a description'
+  spec.homepage      = 'TODO: Add a homepage'
+
+  # Prevent pushing this gem to RubyGems.org. To allow pushes either set the 'allowed_push_host'
+  # to allow pushing to a single host or delete this section to allow pushing to any host.
+  if spec.respond_to?(:metadata)
+    spec.metadata['homepage_uri'] = spec.homepage
+    spec.metadata['source_code_uri'] = 'TODO: Add source repo link'
+  else
+    raise 'RubyGems 2.0 or newer is required to protect against ' \
+      'public gem pushes.'
+  end
+
+  # Specify which files should be added to the gem when it is released.
+  # The `git ls-files -z` loads the files in the RubyGem that have been added into git.
+  spec.files = Dir.chdir(File.expand_path('..', __FILE__)) do
+    `git ls-files -z`.split("\x0").reject { |f| f.match(%r{^(test|spec|features)/}) }
+  end
+  spec.bindir        = 'exe'
+  spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
+  spec.require_paths = ['lib']
+
+  spec.add_dependency 'robopigeon'
+
+  spec.add_development_dependency 'bundler'
+  spec.add_development_dependency 'pry'
+  spec.add_development_dependency 'rake', '~> 10.0'
+  spec.add_development_dependency 'rspec', '~> 3.0'
+  spec.add_development_dependency 'rubocop'
+end

data/lib/robopigeon/extend/templates/default/spec/robopigeon-extension/dsl_spec.erb.rb

@@ -0,0 +1,33 @@
+require 'spec_helper'
+
+describe RoboPigeon::Dsl::GitLabRoot do
+  subject { RoboPigeon::Dsl::Root }
+
+  context 'do_some_global_thing' do
+    it 'does some global thing' do
+      expect do
+        subject.run do
+          <%= extension_name_lower %> do
+            do_some_global_thing
+          end
+        end
+      end.not_to raise_error
+    end
+  end
+end
+
+describe RoboPigeon::Dsl::GitLab do
+  subject { RoboPigeon::Dsl::Job }
+
+  context 'do_something' do
+    it 'does some global thing' do
+      expect do
+        subject.run do
+          <%= extension_name_lower %> do
+            do_something
+          end
+        end
+      end.not_to raise_error
+    end
+  end
+end

data/lib/robopigeon/extend/templates/default/spec/robopigeon-extension/helper_dsl_spec.erb.rb

@@ -0,0 +1,14 @@
+require 'spec_helper'
+
+describe RoboPigeon::Dsl::Helpers::<%= extension_name_upper %> do
+  class <%= extension_name_upper %>HelperTest
+    include RoboPigeon::Dsl::Helpers::<%= extension_name_upper %>
+  end
+  subject { <%= extension_name_upper %>HelperTest.new }
+
+  context 'some_helper_dsl' do
+    it 'does something really cool!' do
+      expect(subject.some_helper_dsl).to eq('nothing happens here yet')
+    end
+  end
+end

data/lib/robopigeon/extend/templates/default/spec/spec_helper.erb.rb

@@ -0,0 +1,18 @@
+$LOAD_PATH.unshift File.expand_path('../../lib', __FILE__)
+require 'bundler/setup'
+require 'robopigeon'
+require 'robopigeon-<%= extension_name_lower %>'
+require 'pry'
+
+RSpec.configure do |config|
+  # Enable flags like --only-failures and --next-failure
+  config.example_status_persistence_file_path = '.rspec_status'
+
+  config.expect_with :rspec do |c|
+    c.syntax = :expect
+  end
+end
+
+def file_fixture(path)
+  File.join(Dir.pwd, 'spec', 'fixtures', path)
+end

data/lib/robopigeon/extend.rb

@@ -0,0 +1,2 @@
+require 'robopigeon/extend/template'
+require 'robopigeon/extend/cli'

data/lib/robopigeon/gitlab/commit.rb

@@ -0,0 +1,31 @@
+module RoboPigeon::GitLab
+  class Commit
+    attr_accessor :files, :branch, :message, :author_name, :author_email
+    def initialize
+      self.files = []
+      self.author_name = ENV['GITLAB_USER_NAME']
+      self.author_email = ENV['GITLAB_USER_EMAIL']
+      self.branch = RoboPigeon::GitLab::Client.branch
+    end
+
+    def add_file(file, content=nil, method='update')
+      content ||= File.read(file)
+      files.push(action: method, file_path: file, content: content)
+    end
+
+    def client
+      RoboPigeon::GitLab::Client.client
+    end
+
+    def commit!
+      client.create_commit(
+        RoboPigeon::GitLab::Client.project,
+        branch,
+        message,
+        files,
+        author_name: author_name,
+        author_email: author_email
+      )
+    end
+  end
+end

data/lib/robopigeon/gitlab/commit_dsl.rb

@@ -0,0 +1,67 @@
+require 'gitlab'
+module RoboPigeon::Dsl
+  class GitLabCommit
+    attr_accessor :commit
+    def initialize
+      self.commit = RoboPigeon::GitLab::Commit.new
+    end
+
+    def self.run(&block)
+      instance = new
+      instance.instance_eval(&block)
+      instance.commit.commit!
+    end
+
+    RoboPigeon::Documentarian.add_command(
+      'file',
+      block: %w[job gitlab commit],
+      params: [
+        { name: 'path', type: 'String', desc: 'repo path of the file to add', example: 'app/config.rb' },
+        { name: 'contents', type: 'Text', desc: 'the content of the file to add (optional)', example: 'here is the contents of my file', default: 'on disk contents of file' }
+      ],
+      desc: 'add a file to the commit'
+    )
+    def file(path, content=nil)
+      method = File.exist?(path) ? 'update' : 'create'
+      commit.add_file(path, content, method)
+    end
+
+    RoboPigeon::Documentarian.add_command(
+      'message',
+      block: %w[job gitlab commit],
+      params: [
+        { name: 'message', type: 'string', desc: 'message to use in the commit', example: 'A commit to end all commits!' }
+      ],
+      desc: 'Set the message for the commit'
+    )
+    def message(message)
+      commit.message = message
+    end
+
+    RoboPigeon::Documentarian.add_command(
+      'author',
+      block: %w[job gitlab commit],
+      params: [
+        { name: 'name', type: 'String', desc: 'name of the user who is making the commit', example: 'Robo Pigeon', default: "ENV['GITLAB_USER_NAME']" },
+        { name: 'email', type: 'String', desc: 'email of the user who is making the commit', example: 'robo.pigeon@example.com', default: "ENV['GITLAB_USER_EMAIL']" }
+      ],
+      desc: 'set the author name and email address.'
+    )
+    def author(name, email)
+      commit.author_email = email
+      commit.author_name = name
+    end
+
+    RoboPigeon::Documentarian.add_command(
+      'branch',
+      block: %w[job gitlab commit],
+      params: [
+        { name: 'name', type: 'String', desc: 'name of the branch to commit to', example: 'master', defautl: "ENV['CI_COMMIT_REF_NAME']" }
+      ],
+      desc: 'Set the branch to commit to'
+    )
+    def branch(name)
+      commit.branch = name
+    end
+  end
+end

data/lib/robopigeon/gitlab/dsl.rb

@@ -1,11 +1,6 @@
 require 'gitlab'
 module RoboPigeon::Dsl
-  class GitLabRoot
-    def self.run(&block)
-      gitlab = RoboPigeon::Dsl::GitLabRoot.new
-      gitlab.instance_eval(&block)
-    end
-
+  class GitLabRoot < RoboPigeon::Dsl::Base
     RoboPigeon::Documentarian.add_command(
       'enabled',
       block: ['gitlab'],
@@ -81,7 +76,6 @@ module RoboPigeon::Dsl
 
   class GitLab < GitLabRoot
     attr_accessor :merge_request
-    include RoboPigeon::Dsl::Helpers
 
     def self.run(&block)
       if RoboPigeon::GitLab::Client.enabled
@@ -170,5 +164,15 @@ module RoboPigeon::Dsl
     def merge_merge_request
       merge_request.merge!
     end
+
+    RoboPigeon::Documentarian.add_block(
+      'commit',
+      helpers: true,
+      block: %w[job gitlab],
+      desc: 'Create a commit on a branch'
+    )
+    def commit(&block)
+      RoboPigeon::GitLab::Commit.run(&block)
+    end
   end
 end

data/lib/robopigeon/gitlab.rb

@@ -3,8 +3,10 @@ RoboPigeon::Documentarian.add_block('gitlab', helpers: true, block: ['job'], des
 
 require 'robopigeon/gitlab/dsl'
 require 'robopigeon/gitlab/client'
+require 'robopigeon/gitlab/commit'
 require 'robopigeon/gitlab/merge_request'
 require 'robopigeon/gitlab/helper_dsl'
+require 'robopigeon/gitlab/commit_dsl'
 
 module RoboPigeon::Dsl
   module Helpers

data/lib/robopigeon/jenkins/client.rb

@@ -0,0 +1,18 @@
+require 'jenkins_api_client'
+
+module RoboPigeon::Jenkins
+  class Client
+    @enabled = true
+
+    class << self
+      attr_accessor :url, :user, :token, :enabled
+      def client
+        @client ||= JenkinsApi::Client.new(
+          server_url: url,
+          username: user,
+          password: token
+        )
+      end
+    end
+  end
+end

data/lib/robopigeon/jenkins/dsl.rb

@@ -0,0 +1,98 @@
+module RoboPigeon::Dsl
+  class JenkinsRoot
+    def self.run(&block)
+      instance = new
+      instance.instance_eval(&block)
+    end
+
+    RoboPigeon::Documentarian.add_command(
+      'enabled',
+      block: ['jenkins'],
+      params: [
+        { name: 'enabled', type: 'boolean', desc: 'should it run Jenkins commands', example: 'false', default: 'true' }
+      ],
+      desc: 'Set whether or not to run Jenkins commands, defaults to true'
+    )
+    def enabled(bool)
+      RoboPigeon::Jenkins::Client.enabled = bool
+    end
+
+    RoboPigeon::Documentarian.add_command(
+      'api_url',
+      block: ['jenkins'],
+      params: [
+        { name: 'url', type: 'String', desc: 'jenkins server url', example: 'https://jenkins.example.com' }
+      ],
+      desc: 'Set the url for your jenkins server'
+    )
+    def api_url(url)
+      RoboPigeon::Jenkins::Client.url = url
+    end
+
+    RoboPigeon::Documentarian.add_command(
+      'api_user',
+      block: ['jenkins'],
+      params: [
+        { name: 'user', type: 'String', desc: 'jenkins server user', example: 'pigeon' }
+      ],
+      desc: 'Set the user for your jenkins server'
+    )
+    def api_user(user)
+      RoboPigeon::Jenkins::Client.user = user
+    end
+
+    RoboPigeon::Documentarian.add_command(
+      'api_key',
+      block: ['jenkins'],
+      params: [
+        { name: 'token', type: 'String', desc: 'jenkins server token', example: '9eNVDMWuY3zf0DZ5yxLH9Q' }
+      ],
+      desc: 'Set the token for your jenkins server'
+    )
+    def api_key(token)
+      RoboPigeon::Jenkins::Client.token = token
+    end
+  end
+  class Jenkins
+    attr_accessor :job
+    def initialize
+      self.job = RoboPigeon::Jenkins::Job.new
+    end
+
+    def self.run(run_now = true, &block)
+      if RoboPigeon::Jenkins::Client.enabled
+        instance = new
+        instance.instance_eval(&block)
+        instance.job.build_and_watch! if run_now
+        instance.job
+      else
+        puts 'Jenkins is disabled, please remove `enabled false` from your global jenkins config'
+      end
+    end
+
+    RoboPigeon::Documentarian.add_command(
+      'param',
+      block: ['jenkins'],
+      params: [
+        { name: 'key', type: 'String', desc: 'the key for the parameter to set', example: 'BUILD_PARAM' },
+        { name: 'value', type: 'String', desc: 'the value for the parameter to set', example: '42' }
+      ],
+      desc: 'Add a parameter to the job'
+    )
+    def param(key, value)
+      job.params[key] = value
+    end
+
+    def start_timeout(seconds)
+      job.start_timeout = seconds
+    end
+
+    def name(name)
+      job.name = name
+    end
+
+    def completion_timeout(seconds)
+      job.build_timeout = seconds
+    end
+  end
+end

data/lib/robopigeon/jenkins/job.rb

@@ -0,0 +1,69 @@
+module RoboPigeon::Jenkins
+  class Failure < StandardError; end
+  class Job
+    DEFAULT_START_TIMEOUT = (45 * 60) # 45 minutes
+    attr_accessor :build_timeout, :name, :params, :poll_interval, :build_opts, :logs, :jid
+    def initialize
+      self.build_timeout = 60 * 60 # 60 minutes in seconds
+      self.params = {}
+      self.poll_interval = 10
+      self.build_opts = {
+        'build_start_timeout' => DEFAULT_START_TIMEOUT,
+        'cancel_on_build_start_timeout' => true
+      }
+    end
+
+    def client
+      RoboPigeon::Jenkins::Client.client
+    end
+
+    def start_timeout=(timeout)
+      build_opts['build_start_timeout'] = timeout
+    end
+
+    def job_url(jid)
+      "#{RoboPigeon::Jenkins::Client.url}/jobs/#{name}/#{jid}"
+    end
+
+    def build_and_watch!
+      self.jid = client.job.build(name, params.to_h, build_opts)
+      puts "Created jenkins job: #{job_url(jid)}"
+
+      watch_build
+    end
+
+    private
+
+    def watch_build(iteration=0)
+      if iteration * poll_interval > build_timeout
+        output_logs(jid)
+        raise Timeout::Error, "Build timed out, see logs or look at #{job_url(jid)}" unless job_success?(jid)
+      elsif job_complete?(jid)
+        output_logs(jid)
+        raise RoboPigeon::Jenkins::Failure, "Build did not complete successfully, see logs or look at #{job_url(jid)}" unless job_success?(jid)
+
+        return
+      end
+
+      puts "Job not yet complete, Run time: #{(iteration * poll_interval / 60.0).round(2)} minutes"
+      sleep poll_interval
+      watch_build(iteration + 1)
+    end
+
+    def job_complete?(jid)
+      return true if client.job.get_build_details(name, jid)['result'] == 'SUCCESS'
+      return true if client.job.get_build_details(name, jid)['result'] == 'FAILURE'
+
+      false
+    end
+
+    def output_logs(jid)
+      self.logs = client.api_get_request("/job/#{name}/#{jid}/consoleText", nil, '')
+      puts logs
+    end
+
+    def job_success?(jid)
+      client.job.get_build_details(name, jid)['result'] == 'SUCCESS'
+    end
+  end
+end

data/lib/robopigeon/jenkins.rb

@@ -0,0 +1,22 @@
+RoboPigeon::Documentarian.add_block('jenkins', helpers: true, block: [], desc: 'a configuration block for jenkins')
+RoboPigeon::Documentarian.add_block('jenkins', helpers: true, block: ['job'], desc: 'configure a jenkins job to create, run, and watch')
+
+require 'robopigeon/jenkins/client'
+require 'robopigeon/jenkins/job'
+require 'robopigeon/jenkins/dsl'
+
+module RoboPigeon::Dsl
+  class Root
+    def jenkins(&block)
+      RoboPigeon::Dsl::JenkinsRoot.run(&block)
+    end
+  end
+end
+
+module RoboPigeon::Dsl
+  class Job
+    def jenkins(&block)
+      RoboPigeon::Dsl::Jenkins.run(&block)
+    end
+  end
+end

data/lib/robopigeon/jira/dsl.rb

@@ -1,10 +1,5 @@
 module RoboPigeon::Dsl
-  class JiraRoot
-    def self.run(&block)
-      jira = RoboPigeon::Dsl::JiraRoot.new
-      jira.instance_eval(&block)
-    end
-
+  class JiraRoot < RoboPigeon::Dsl::Base
     RoboPigeon::Documentarian.add_command(
       'enabled',
       block: ['jira'],
@@ -43,11 +38,13 @@ module RoboPigeon::Dsl
   end
 
   class Jira < JiraRoot
-    include RoboPigeon::Dsl::Helpers
-
     def self.run(&block)
-      jira = RoboPigeon::Dsl::Jira.new
-      jira.instance_eval(&block)
+      if RoboPigeon::Jira::Client.enabled
+        jira = RoboPigeon::Dsl::Jira.new
+        jira.instance_eval(&block)
+      else
+        puts 'Jira is disabled, please remove `enabled false` from your global jira config'
+      end
     end
 
     RoboPigeon::Documentarian.add_block(

data/lib/robopigeon/jira/helper_dsl.rb

@@ -19,6 +19,19 @@ module RoboPigeon::Dsl
         jira_url = RoboPigeon::Jira::Client.api_url
         "<#{issue_id}|#{jira_url}/browse/#{issue_id}>"
       end
+
+      RoboPigeon::Documentarian.add_command(
+        'jira_issue_slack_link',
+        params: [
+          { name: 'issue_id', type: 'String', desc: 'Issue to link to', example: 'TICK-1234' }
+        ],
+        block: ['helpers'],
+        desc: 'Returns a slack formatted link to the last created ticket.'
+      )
+      def jira_slack_link(issue_id)
+        jira_url = RoboPigeon::Jira::Client.api_url
+        "<#{issue_id}|#{jira_url}/browse/#{issue_id}>"
+      end
     end
   end
 end

data/lib/robopigeon/resources/initial_robopigeon.rb

@@ -31,6 +31,56 @@ jira do
   api_key ENV['JIRA_API_TOKEN'] # Always use an envrionment variable, don't check in secrets.
 end
 
+jenkins do
+  # Jira is currently disabled, make sure you have a valid api token with acces to
+  # to your repo, then remove the following line
+  enabled false
+  # This is where you configure your global jenkins settings, like api url and api token
+  # always keep your api key either in an environment variable or encrypted with
+  # something like `encryptatron` or rails secrets.
+  api_url  'https://jenkins.example.com'
+  api_user ENV['JENKINS_USER']
+  api_key  ENV['JENKINS_TOKEN']
+end
+
+# This job is an example of updating and tagging a new version of your project
+job 'update_version', 'Used to update the version to a new one!' do
+  gitlab do
+    # Creates a commit
+    commit do
+      # Check in updated report file that helps split tests.
+      file 'spec/knapsack_report.json'
+      # Check in this version file with the contents of a new verison number
+      file '.version', ENV['NEW_VERSION_NUMBER']
+
+      # You can configure a message for the commit too
+      message "Updating version to #{ENV['NEW_VERSION_NUMBER']}"
+      # And the author's name and email address (also can be auto-pulled from git)
+      author 'Deployment Pigeon', 'pigeon@ives.dev'
+      # What branch to commit to
+      branch 'master'
+    end
+
+    # Now, tag that commit with the new version!
+    create_tag('master', ENV['NEW_VERSION_NUMBER'], "Updating version to #{ENV['NEW_VERSION_NUMBER']}")
+  end
+end
+
+# Here's an example job that runs something in jenkins.
+job 'run_in_jenkins', 'Run a job in jenkins and make sure it passes' do
+  # The jenkins block takes arguments to configure an existing job, you have
+  # to at least specify a job name, and then everything else should be
+  # configured through parameters.
+  jenkins do
+    # This tells the job to run a job in jenkins named 'robopigoen-test'
+    name 'robopigeon-test'
+    # This tells it to set a parameter called 'BRANCH' to the branch from gitlab ci
+    param 'BRANCH', ENV['CI_COMMIT_REF_NAME']
+  end
+  # At this point the job will execute and then output the log to standard out so
+  # so you can keep a consistent log
+end
+
 job 'deploy_complete', 'Notify slack and comment in gitlab that a deploy is complete' do
   # This configures a slack notification, at the end of the block it sends to
   # the users and channels in the body. Un-comment the channels and fill in the
@@ -109,11 +159,16 @@ job 'create ticket' do
       # Print out the ticket number for logging/deubgging
       puts 'Created ticket:'
       print_id
+
+      # This transitions the ticket using a transition called 'Start Work'
+      transition 'Start Work'
     end
   end
 
+  # Then it sends a notification in slack wit the link to the ticket
   slack do
     user ENV['GITLAB_USER_EMAIL']
+    # That helper gives you a slack formatted link for the jira ticket
     message "Created #{jira_last_created_ticket_slack_link}"
   end
 end

data/lib/robopigeon/slack/attachments_dsl.rb

@@ -25,7 +25,7 @@ module RoboPigeon::Dsl
       attachment[:title] = title
     end
 
-    RoboPigeon::Documentarian.add_command('title_linke', block: %w[job slack attachment], params: [{ name: 'link', type: 'String', desc: 'a url', example: 'https://gitlab.com/robopigeon/robopigeon/pipelines' }], desc: 'Add a link to the title so that users can click on it')
+    RoboPigeon::Documentarian.add_command('title_linke', block: %w[job slack attachment], params: [{ name: 'link', type: 'String', desc: 'a url', example: 'https://gitlab.com/pigeons/robopigeon/pipelines' }], desc: 'Add a link to the title so that users can click on it')
     def title_link(title_link)
       attachment[:title_link] = title_link
     end
@@ -46,7 +46,7 @@ module RoboPigeon::Dsl
       params: [
         { name: 'type', type: 'String', desc: 'Currently only supports `button`', example: 'button' },
         { name: 'text', type: 'String', desc: 'Field label', example: 'Pipeline' },
-        { name: 'url', type: 'String', desc: 'Url to link to', example: 'https://gitlab.com/robopigeon/robopigeon/pipelines' },
+        { name: 'url', type: 'String', desc: 'Url to link to', example: 'https://gitlab.com/pigeons/robopigeon/pipelines' },
         { name: 'style', type: 'String', desc: 'button style, can be danger or primary', example: 'danger', defaut: 'nil' }
       ],
       desc: 'Add a Url linked button to your bot'

data/lib/robopigeon/slack/dsl.rb

@@ -1,10 +1,5 @@
 module RoboPigeon::Dsl
-  class SlackRoot
-    def self.run(&block)
-      slack = RoboPigeon::Dsl::SlackRoot.new
-      slack.instance_eval(&block)
-    end
-
+  class SlackRoot < RoboPigeon::Dsl::Base
     RoboPigeon::Documentarian.add_command(
       'enabled',
       block: ['slack'],
@@ -34,7 +29,6 @@ module RoboPigeon::Dsl
   end
 
   class Slack < SlackRoot
-    include RoboPigeon::Dsl::Helpers
     attr_accessor :message
 
     def self.run(&block)

data/lib/robopigeon.rb

@@ -1,7 +1,9 @@
 require 'robopigeon/documentarian'
 require 'robopigeon/dsl'
+require 'robopigeon/extend'
 require 'robopigeon/git'
 require 'robopigeon/gitlab'
+require 'robopigeon/jenkins'
 require 'robopigeon/jira'
 require 'robopigeon/markdown'
 require 'robopigeon/slack'