lita-jenkins 0.0.3 → 0.0.4

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: dcffef9c4fb103a261e3c90e6fdfa19274cf6efc
-  data.tar.gz: 60a9bbe4ef16289c48a21756418a72fec9ea6a6f
+  metadata.gz: 2e4bae16d034bae22bcb09463001f0713740b7f4
+  data.tar.gz: 827d8a0c091f77c8f44c7b4cfb1c0991d35cc9e1
 SHA512:
-  metadata.gz: 7ab1d5548358ab37e304e3470f506c7a9950acdf4883bae95b5af3ba15d7a8c2ecccf8f1151ac2edd375c8da25b907dcf95624824d8c42e2e8d3570f40595fa7
-  data.tar.gz: e39bd4c67170ba91f49f2668aaff6902e65c380e8713faff672b600876f21d701f26fee977943c8ea545072a456cf0b6badea5080321a06bc196f1d6c2b49422
+  metadata.gz: 9ea7092693b33fb132b24db70261bad4e4a581b6e65583cfdffeb7f72cd07aef307a6d017dc4db0abb9002b37244b5275024f3edb2cab75f4aa13dc5073b668a
+  data.tar.gz: 548703e81c0ca9ea1ca82a175f811cb0b2336b99a74260fbf39239b2c6617e0f8ea1d2df7f86b0bc4947813153c8c152186af2bc7b340d05673506ef1cdf4efb

data/.gitignore

@@ -1,13 +1,15 @@
-*.gem
-*.rbc
+_yardoc
 .bundle
 .config
+.ruby-gemset
+.ruby-version
 .yardoc
-Gemfile.lock
-InstalledFiles
-_yardoc
+*.gem
+*.rbc
 coverage
 doc/
+Gemfile.lock
+InstalledFiles
 lib/bundler/man
 pkg
 rdoc

data/.rspec

@@ -0,0 +1 @@
+--color

data/.travis.yml

@@ -1,8 +1,13 @@
+sudo: false
 language: ruby
+cache: bundler
 rvm:
-  - 2.0.0
+  - 2.1
+  - 2.2
+  - 2.2.3
 script: bundle exec rake
 before_install:
   - gem update --system
+  - gem install bundler
 services:
   - redis-server

data/lib/lita/handlers/jenkins.rb

@@ -4,39 +4,47 @@ require 'base64'
 module Lita
   module Handlers
     class Jenkins < Handler
-      class << self
-        attr_accessor :jobs
-      end
 
-      def self.default_config(config)
-        config.url = nil
-        self.jobs = {}
-      end
+      config :auth
+      config :url
 
       route /j(?:enkins)? list( (.+))?/i, :jenkins_list, command: true, help: {
         'jenkins list <filter>' => 'lists Jenkins jobs'
       }
 
-      route /j(?:enkins)? b(?:uild)? (\d+)/i, :jenkins_build, command: true, help: {
-        'jenkins b(uild) <job_id>' => 'builds the job specified by job_id. List jobs to get ID.'
+      route /j(?:enkins)? b(?:uild)? ([\w\.\-_ ]+)(, (.+))?/i, :jenkins_build, command: true, help: {
+        'jenkins b(uild) <job_id or job_name>' => 'builds the job specified by ID or name. List jobs to get ID.'
       }
 
-      def jenkins_build(response)
-        if job = jobs[response.matches.last.last.to_i - 1]
-          url    = Lita.config.handlers.jenkins.url
-          path   = "#{url}/job/#{job['name']}/build"
+      def jenkins_build(response, empty_params = false)
+        job = find_job(response.matches.last.first)
+        input_params = response.matches.last.last
 
-          http_resp = http.post(path) do |req|
-            req.headers = headers
-          end
+        unless job
+          response.reply "I couldn't find that job. Try `jenkins list` to get a list."
+          return
+        end
 
-          if http_resp.status == 201
-            response.reply "(#{http_resp.status}) Build started for #{job['name']} #{url}/job/#{job['name']}"
-          else
-            response.reply http_resp.body
-          end
+        # Either a Hash of params or True/False
+        params = input_params ? parse_params(input_params) : empty_params
+
+        named_job_url = job_url(job['name'])
+        path = job_build_url(named_job_url, params)
+
+        http_resp = http.post(path) do |req|
+          req.headers = headers
+          req.params  = params if params.is_a? Hash
+        end
+
+        if http_resp.status == 201
+          reply_text = "(#{http_resp.status}) Build started for #{job['name']} #{named_job_url}"
+          reply_text << ", Params: '#{input_params}'" if input_params
+          response.reply reply_text
+        elsif http_resp.status == 400
+          log.debug 'Issuing rebuild with empty_params'
+          jenkins_build(response, true)
         else
-          response.reply "I couldn't find that job. Try `jenkins list` to get a list."
+          response.reply http_resp.body
         end
       end
 
@@ -56,28 +64,47 @@ module Lita
       end
 
       def headers
-        headers = {}
-        if auth = Lita.config.handlers.jenkins.auth
-          headers["Authorization"] = "Basic #{Base64.encode64(auth).chomp}"
+        {}.tap do |headers|
+          headers["Authorization"] = "Basic #{Base64.encode64(config.auth).chomp}" if config.auth
         end
-        headers
       end
 
       def jobs
-        if self.class.jobs.empty?
-          path = "#{Lita.config.handlers.jenkins.url}/api/json"
-          api_response = http.get(path) do |req|
-            req.headers = headers
-          end
-          self.class.jobs = JSON.parse(api_response.body)["jobs"]
+        api_response = http.get(api_url) do |req|
+          req.headers = headers
         end
-        self.class.jobs
+        JSON.parse(api_response.body)["jobs"]
       end
 
       private
 
+      def api_url
+        "#{config.url}/api/json"
+      end
+
+      def job_url(job_name)
+        "#{config.url}/job/#{job_name}"
+      end
+
+      def job_build_url(named_job_url, params)
+        if params
+          "#{named_job_url}/buildWithParameters?#{params}"
+        else
+          "#{named_job_url}/build"
+        end
+      end
+
+      def find_job(requested_job)
+        # Determine if job is only a number.
+        if requested_job.match(/\A[-+]?\d+\z/)
+          jobs[requested_job.to_i - 1]
+        else
+          jobs.select { |j| j['name'] == requested_job }.last
+        end
+      end
+
       def format_job(i, state, job_name)
-        "[#{i+1}] #{state} #{job_name}\n"
+        "[#{i + 1}] #{state} #{job_name}\n"
       end
 
       def color_to_state(text)
@@ -94,6 +121,16 @@ module Lita
       def filter_match(filter, text)
         text.match(/#{filter}/i)
       end
+
+      def parse_params(input_params)
+        {}.tap do |params|
+          input_params.split(',').each do |pair|
+            key, value = pair.split(/=/)
+            params[key.strip] = value.strip
+          end
+          log.debug "lita-jenkins#parse_params: #{params}"
+        end
+      end
     end
 
     Lita.register_handler(Jenkins)

data/lita-jenkins.gemspec

@@ -1,8 +1,8 @@
 Gem::Specification.new do |spec|
   spec.name          = "lita-jenkins"
-  spec.version       = "0.0.3"
-  spec.authors       = ["Daniel Yoon"]
-  spec.email         = ["daniel.kiros@gmail.com"]
+  spec.version       = "0.0.4"
+  spec.authors       = ["Daniel Yoon", "Mike Fiedler"]
+  spec.email         = ["daniel.kiros@gmail.com", "miketheman@gmail.com"]
   spec.description   = %q{Interact with Jenkins CI server.}
   spec.summary       = %q{Interact with Jenkins CI server.}
   spec.homepage      = "https://github.com/daniely/lita-jenkins.git"
@@ -14,6 +14,8 @@ Gem::Specification.new do |spec|
   spec.test_files    = spec.files.grep(%r{^(test|spec|features)/})
   spec.require_paths = ["lib"]
 
+  spec.required_ruby_version = ">= 2.1"
+
   spec.add_runtime_dependency "lita", ">= 3.0"
 
   spec.add_development_dependency "bundler", "~> 1.3"

data/spec/lita/handlers/jenkins_spec.rb

@@ -1,33 +1,51 @@
 require "spec_helper"
 
 describe Lita::Handlers::Jenkins, lita_handler: true do
-  it { routes_command('jenkins list').to(:jenkins_list) }
-  it { routes_command('jenkins list filter').to(:jenkins_list) }
+  describe 'lita routes' do
+    it { is_expected.to route_command('jenkins list').to(:jenkins_list) }
+    it { is_expected.to route_command('jenkins list filter').to(:jenkins_list) }
+    it { is_expected.to route_command('jenkins build 2').to(:jenkins_build) }
+    it { is_expected.to route_command('jenkins build deploy').to(:jenkins_build) }
+    it { is_expected.to route_command('jenkins build deploy, PARAM=value').to(:jenkins_build) }
+  end
 
-  describe '#jenkins list' do
-    let(:response) { double("Faraday::Response") }
-    let(:api_response) { %{
-      {"assignedLabels":[{}],"mode":"NORMAL","nodeDescription":"the master Jenkins node",
-      "nodeName":"","numExecutors":4,"description":null,"jobs":[
-      {"name":"chef_converge", "url":"http://test.com/job/chef_converge/","color":"disabled"},
-      {"name":"deploy", "url":"http://test.com/job/deploy/","color":"red"},
-      {"name":"build-all", "url":"http://test.com/job/build-all/","color":"blue"},
-      {"name":"website", "url":"http://test.com/job/website/","color":"red"}],
-      "overallLoad":{},
-      "primaryView":{"name":"All","url":"http://test.com/"},"quietingDown":false,"slaveAgentPort":8090,"unlabeledLoad":{},
-      "useCrumbs":false,"useSecurity":true,"views":[
-      {"name":"All","url":"http://test.com/"},
-      {"name":"Chef","url":"http://test.com/view/Chef/"},
-      {"name":"Deploy","url":"http://test.com/view/Deploy/"},
-      {"name":"Status","url":"http://test.com/view/Status/"},
-      {"name":"deploy-pipeline","url":"http://test.com/view/deploy-pipeline/"}]}
-    } }
-
-    before do
-      allow_any_instance_of(Faraday::Connection).to receive(:get).and_return(response)
-      allow_any_instance_of(Faraday::Connection).to receive(:post).and_return(response)
+  let(:response) { double("Faraday::Response") }
+  let(:api_response) { %{
+    {"assignedLabels":[{}],"mode":"NORMAL","nodeDescription":"the master Jenkins node",
+    "nodeName":"","numExecutors":4,"description":null,"jobs":[
+    {"name":"chef_converge", "url":"http://test.com/job/chef_converge/","color":"disabled"},
+    {"name":"deploy", "url":"http://test.com/job/deploy/","color":"red"},
+    {"name":"build-all", "url":"http://test.com/job/build-all/","color":"blue"},
+    {"name":"website", "url":"http://test.com/job/website/","color":"red"}],
+    "overallLoad":{},
+    "primaryView":{"name":"All","url":"http://test.com/"},"quietingDown":false,"slaveAgentPort":8090,"unlabeledLoad":{},
+    "useCrumbs":false,"useSecurity":true,"views":[
+    {"name":"All","url":"http://test.com/"},
+    {"name":"Chef","url":"http://test.com/view/Chef/"},
+    {"name":"Deploy","url":"http://test.com/view/Deploy/"},
+    {"name":"Status","url":"http://test.com/view/Status/"},
+    {"name":"deploy-pipeline","url":"http://test.com/view/deploy-pipeline/"}]}
+  } }
+
+  before do
+    allow_any_instance_of(Faraday::Connection).to receive(:get).and_return(response)
+    allow_any_instance_of(Faraday::Connection).to receive(:post).and_return(response)
+  end
+
+  describe '#headers' do
+    it 'returns empty auth headers correctly by default' do
+      return_value = described_class.new(robot).headers
+      expect(return_value.inspect).to eq("{}")
+    end
+
+    it 'encodes auth headers correctly' do
+      registry.config.handlers.jenkins.auth = "foo:bar"
+      return_value = described_class.new(robot).headers
+      expect(return_value.inspect).to eq("{\"Authorization\"=>\"Basic Zm9vOmJhcg==\"}")
     end
+  end
 
+  describe '#jenkins list' do
     it 'lists all jenkins jobs' do
       allow(response).to receive(:status).and_return(200)
       allow(response).to receive(:body).and_return(api_response)
@@ -41,7 +59,9 @@ describe Lita::Handlers::Jenkins, lita_handler: true do
       send_command('jenkins list fail')
       expect(replies.last).to eq("[2] FAIL deploy\n[4] FAIL website\n")
     end
+  end
 
+  describe '#jenkins build' do
     it 'build job id' do
       allow(response).to receive(:status).and_return(201)
       allow(response).to receive(:body).and_return(api_response)
@@ -49,6 +69,27 @@ describe Lita::Handlers::Jenkins, lita_handler: true do
       expect(replies.last).to eq("(201) Build started for deploy /job/deploy")
     end
 
+    it 'build job name' do
+      allow(response).to receive(:status).and_return(201)
+      allow(response).to receive(:body).and_return(api_response)
+      send_command('jenkins b deploy')
+      expect(replies.last).to eq("(201) Build started for deploy /job/deploy")
+    end
+
+    it 'build job underscored name' do
+      allow(response).to receive(:status).and_return(201)
+      allow(response).to receive(:body).and_return(api_response)
+      send_command('jenkins b chef_converge')
+      expect(replies.last).to eq("(201) Build started for chef_converge /job/chef_converge")
+    end
+
+    it 'build job hyphenated name' do
+      allow(response).to receive(:status).and_return(201)
+      allow(response).to receive(:body).and_return(api_response)
+      send_command('jenkins b build-all')
+      expect(replies.last).to eq("(201) Build started for build-all /job/build-all")
+    end
+
     it 'build job bad id' do
       allow(response).to receive(:status).and_return(201)
       allow(response).to receive(:body).and_return(api_response)
@@ -56,6 +97,13 @@ describe Lita::Handlers::Jenkins, lita_handler: true do
       expect(replies.last).to eq("I couldn't find that job. Try `jenkins list` to get a list.")
     end
 
+    it 'build job bad name' do
+      allow(response).to receive(:status).and_return(201)
+      allow(response).to receive(:body).and_return(api_response)
+      send_command('jenkins b sloppyjob')
+      expect(replies.last).to eq("I couldn't find that job. Try `jenkins list` to get a list.")
+    end
+
     it 'build job error 500 response' do
       allow(response).to receive(:status).and_return(500)
       allow(response).to receive(:body).and_return(api_response)
@@ -63,10 +111,22 @@ describe Lita::Handlers::Jenkins, lita_handler: true do
       expect(replies.last).to eq(api_response)
     end
 
-    it 'build job error 500 response' do
-      Lita.config.handlers.jenkins.auth = "foo:bar"
-      return_value = Lita::Handlers::Jenkins.new.headers
-      expect(return_value.inspect).to eq("{\"Authorization\"=>\"Basic Zm9vOmJhcg==\"}")
+    context 'paramterized builds' do
+      describe 'job with param' do
+        it 'builds job id' do
+          allow(response).to receive(:status).and_return(201)
+          allow(response).to receive(:body).and_return(api_response)
+          send_command('jenkins b 2, PARAM=value')
+          expect(replies.last).to eq("(201) Build started for deploy /job/deploy, Params: 'PARAM=value'")
+        end
+
+        it 'builds job name' do
+          allow(response).to receive(:status).and_return(201)
+          allow(response).to receive(:body).and_return(api_response)
+          send_command('jenkins b deploy, PARAM=value')
+          expect(replies.last).to eq("(201) Build started for deploy /job/deploy, Params: 'PARAM=value'")
+        end
+      end
     end
   end
 end

data/spec/spec_helper.rb

@@ -8,3 +8,5 @@ SimpleCov.start { add_filter "/spec/" }
 
 require "lita-jenkins"
 require "lita/rspec"
+
+Lita.version_3_compatibility_mode = false

metadata

@@ -1,108 +1,111 @@
 --- !ruby/object:Gem::Specification
 name: lita-jenkins
 version: !ruby/object:Gem::Version
-  version: 0.0.3
+  version: 0.0.4
 platform: ruby
 authors:
 - Daniel Yoon
+- Mike Fiedler
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2015-05-01 00:00:00.000000000 Z
+date: 2015-11-14 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: lita
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - '>='
+    - - ">="
       - !ruby/object:Gem::Version
         version: '3.0'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - '>='
+    - - ">="
       - !ruby/object:Gem::Version
         version: '3.0'
 - !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: 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: rspec
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - '>='
+    - - ">="
       - !ruby/object:Gem::Version
         version: 3.0.0.beta2
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - '>='
+    - - ">="
       - !ruby/object:Gem::Version
         version: 3.0.0.beta2
 - !ruby/object:Gem::Dependency
   name: simplecov
   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: coveralls
   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'
 description: Interact with Jenkins CI server.
 email:
 - daniel.kiros@gmail.com
+- miketheman@gmail.com
 executables: []
 extensions: []
 extra_rdoc_files: []
 files:
-- .gitignore
-- .travis.yml
+- ".gitignore"
+- ".rspec"
+- ".travis.yml"
 - Gemfile
 - LICENSE
 - README.md
@@ -124,17 +127,17 @@ require_paths:
 - lib
 required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
-  - - '>='
+  - - ">="
     - !ruby/object:Gem::Version
-      version: '0'
+      version: '2.1'
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
-  - - '>='
+  - - ">="
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.0.3
+rubygems_version: 2.4.7
 signing_key: 
 specification_version: 4
 summary: Interact with Jenkins CI server.