jenkins-config-finder 0.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: fb7b5cdfa0594c4c1f6ab50459e6e5dbb69fb06c
+  data.tar.gz: e4a89e1cb0fde86776c50e98a44d55ec0359ed40
+SHA512:
+  metadata.gz: 1e1b771ed06e5cb11d1c355808c93f1e4a5da8385f12769077e01aa591bbdaffb33ab057aefba37542566a83c43391ab66c4bd43a25aeb34056a9e91300d646c
+  data.tar.gz: 33769b77f235c956e5ae9adad8ba8cdb491d970dd5d37f8a4879ae55599f2e14d81676182bc88f58711e908eeaba5e709811a7ef0853621f5b9803e2f2007726

data/.gitignore

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

data/.travis.yml

@@ -0,0 +1,4 @@
+language: ruby
+rvm:
+  - 1.9.3
+  - 1.8.7

data/Gemfile

@@ -0,0 +1,13 @@
+# A sample Gemfile
+source "https://rubygems.org"
+
+gem "jenkins_api_client"
+gem "nokogiri"
+gemspec
+
+group :development, :test do
+  gem "simplecov"
+  gem "yard"
+  gem "rspec"
+  gem "webmock"
+end

data/LICENSE.txt

@@ -0,0 +1,22 @@
+Copyright (c) 2014 Bradley, Dan
+
+MIT License
+
+Permission is hereby granted, free of charge, to any person obtaining
+a copy of this software and associated documentation files (the
+"Software"), to deal in the Software without restriction, including
+without limitation the rights to use, copy, modify, merge, publish,
+distribute, sublicense, and/or sell copies of the Software, and to
+permit persons to whom the Software is furnished to do so, subject to
+the following conditions:
+
+The above copyright notice and this permission notice shall be
+included in all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
+EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
+MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
+NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
+LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
+OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
+WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

data/README.md

@@ -0,0 +1,3 @@
+Jenkins config finder.
+
+Searches a jenkins server amongst all the jobs to find a supplied pattern.

data/Rakefile

@@ -0,0 +1,13 @@
+require "bundler/gem_tasks"
+require 'rspec/core/rake_task'
+require "yard"
+require 'yard/rake/yardoc_task'
+
+YARD::Rake::YardocTask.new do |t|
+  t.files   = ['lib/**/*.rb']   # optional
+  t.stats_options = ['--list-undoc']         # optional
+end
+
+RSpec::Core::RakeTask.new
+
+task :default => :spec

data/bin/jenkins-config-finder.rb

@@ -0,0 +1,49 @@
+#!/usr/bin/env ruby
+
+require 'optparse'
+require 'jenkins_config_finder'
+
+options = {}
+
+optparse = OptionParser.new do |opts|
+    opts.banner = "Usage: jenkins-config-finder [options]"
+
+    opts.on("-u", "--username USERNAME", "Username") do |user|
+        options[:user] = user
+    end
+    opts.on("-p", "--password PASSWORD", "Password") do |password|
+        options[:password] = password
+    end
+    opts.on("-s", "--server URL", "URL of the Jenkins server") do |url|
+        options[:url] = url
+    end
+    opts.on("-x", "--xml-path PATH", "XML Path to search for i.e. //project//description") do |path|
+        options[:path] = path
+    end
+    opts.on("-n", "--node NODE", "NODE to print i.e. name") do |node|
+        options[:node] = node
+    end
+end
+
+begin
+    optparse.parse!
+    mandatory = [:url, :user, :password, :path]
+    missing = mandatory.select{ |param| options[param].nil? }     
+    if not missing.empty?                                            
+      puts "Missing options: #{missing.join(', ')}"                  
+      puts optparse                                                  
+      exit                                                           
+    end                                                              
+rescue OptionParser::InvalidOption, OptionParser::MissingArgument      
+  puts $!.to_s                                                          
+  puts optparse                                                         
+  exit                                                                  
+end                                                                     
+
+JenkinsConfigFinder.connect(options[:url], options[:user], options[:password])
+jenkins_config = JenkinsConfigFinder.find(options[:path], options[:node])
+
+jenkins_config.each do |key, value| 
+  puts "::::::::#{key}::::::::"
+  puts value
+end

data/jenkins-config-finder.gemspec

@@ -0,0 +1,22 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+
+Gem::Specification.new do |spec|
+  spec.name          = "jenkins-config-finder"
+  spec.version       = "0.1"
+  spec.authors       = ["Bradley, Dan"]
+  spec.email         = ["danb468@gmail.com"]
+  spec.summary       = %q{Search configurations for all jenkins jobs}
+  spec.description   = %q{Find configuration items across all jenkins jobs}
+  spec.homepage      = ""
+  spec.license       = "MIT"
+
+  spec.files         = `git ls-files -z`.split("\x0")
+  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_development_dependency "bundler", "~> 1.6"
+  spec.add_development_dependency "rake"
+end

data/lib/jenkins_config_finder.rb

@@ -0,0 +1,81 @@
+
+require 'jenkins_api_client'
+require 'nokogiri'
+
+
+
+module JenkinsConfigFinder
+
+  # Establishes a connection to the jenkins server
+  #
+  # ==== Attributes
+  # * +url+ A URL for a jenkins server
+  # * +user+ The username for jenkins
+  # * +password+ The password for the user
+  def self.connect(url, user, password)
+    @client = JenkinsApi::Client.new(:server_url => url,
+         :username => user, 
+         :password => password,
+         :log_location => '/dev/null')
+
+  end
+
+  # Searches all jobs in the jenkins server looking for the supplied path
+  #
+  # ==== Attributes
+  #
+  # * +path+ An xpath node to search for
+  # * +node+ Returns a node matched under the path (Optional)
+  #
+  # ==== Examples
+  #
+  #   # Find and return all projects descriptions
+  #   JenkinsConfigFinder.find('project//description')
+  #   # Find and return all git repositories urls
+  #   JenkinsConfigFinder.find('@class:hudson.plugins.git.GitSCM', //hudson.plugins.git.UserRemoteConfig//url)
+  #
+  # ==== Returns
+  #
+  # * a hash of all the matching jenkins jobs as keys, and the value being the matched config
+  def self.find(path, node = nil)
+
+      jenkins_config = {}
+      jobs =  @client.job.list(".*")
+
+      job = JenkinsApi::Client::Job.new(@client)
+      jobs.each do |j|
+        config =  job.get_config(j)
+        config_obj = Nokogiri::XML(config)    
+        if node.nil? 
+          if config_obj.root.at_xpath(path)
+            jenkins_config[j] = config_obj.root.at_xpath("#{path}").content.to_s 
+          end
+        else 
+          if config_obj.root.at_xpath("#{path}//#{node}")
+            jenkins_config[j] = config_obj.root.at_xpath("#{path}//#{node}").content.to_s 
+          end
+        end
+        if config_obj.root.at_xpath("//project//properties//hudson.plugins.promoted__builds.JobPropertyImpl")
+          promotion_name = config_obj.root.at_xpath("//project//properties//hudson.plugins.promoted__builds.JobPropertyImpl//activeProcessNames//string").content
+          begin
+            promotion_config = job.get_config("#{j}/promotion/process/#{promotion_name}")
+          rescue JenkinsApi::Exceptions::NotFound
+            promotion_config = nil
+          end
+
+          unless promotion_config.nil?
+            promotion_obj = Nokogiri::XML(promotion_config) 
+            if node.nil? then
+              if promotion_obj.root.at_xpath(path)
+                jenkins_config["#{j}/#{promotion_name}"] = promotion_obj.root.at_xpath("#{path}").content.to_s 
+              end
+            elsif promotion_obj.root.at_xpath("#{path}//#{node}")
+              jenkins_config["#{j}/#{promotion_name}"] = promotion_obj.root.at_xpath("#{path}//#{node}").content.to_s 
+            end
+          end
+        end
+      end
+
+      return jenkins_config
+    end
+end

data/spec/jenkins_config_finder_spec.rb

@@ -0,0 +1,72 @@
+require 'spec_helper'
+require 'pp'
+
+describe JenkinsConfigFinder do 
+    before do
+        stub_request(:any, "http://mock_user:mock_password@www.x.com/api/json").to_return(:body => %q|{ "jobs": [ { "name": "job1", "url": "http://www.x.com/job/job1", "color": "blue" }, { "name": "job2", "url": "http://www.x.com/job/job2", "color": "blue" } ] }|)
+        stub_request(:any, "http://mock_user:mock_password@www.x.com/job/job1/config.xml").to_return(:body => %q|<?xml version='1.0' encoding='UTF-8'?>
+           <project>
+             <description>MY_JOB_1</description>
+           </project>|)
+        stub_request(:any, "http://mock_user:mock_password@www.x.com/job/job2/config.xml").to_return(:body => %q|<?xml version='1.0' encoding='UTF-8'?>
+           <project>
+            <description>MY_JOB_2</description>
+              <properties>
+                <hudson.plugins.promoted__builds.JobPropertyImpl plugin="promoted-builds@2.18">
+                  <activeProcessNames>
+                    <string>push_test</string>
+                  <activeProcessNames>
+                </hudson.plugins.promoted__builds.JobPropertyImpl>
+                <hudson.plugins.jacoco.JacocoPublisher plugin="jacoco@1.0.16">
+                  <minimumMethodCoverage>0</minimumMethodCoverage>
+                </hudson.plugins.jacoco.JacocoPublisher>
+              </properties></project>|)
+        stub_request(:any, "http://mock_user:mock_password@www.x.com/job/job2/promotion/process/push_test/config.xml").to_return(:body => %q|<?xml version='1.0' encoding='UTF-8'?>
+            <hudson.plugins.promoted__builds.PromotionProcess plugin="promoted-builds@2.17">
+              <disabled>nope</disabled>
+              <buildSteps></buildSteps>
+            </hudson.plugins.promoted__builds.PromotionProcess>|)
+    end
+
+    describe "Connect" do
+       it "connects to jenkins" do
+          expect(
+            lambda do 
+              JenkinsConfigFinder.connect('http://www.x.com', 'mock_user', 'mock_password')
+            end
+          ).not_to raise_error
+        end
+
+        it "searches jenkins" do
+            JenkinsConfigFinder.connect('http://www.x.com', 'mock_user', 'mock_password')
+            conf = JenkinsConfigFinder.find("//project//description")
+            conf.should include('job1' => 'MY_JOB_1')
+        end
+
+        it "searches jenkins with a node" do
+            JenkinsConfigFinder.connect('http://www.x.com', 'mock_user', 'mock_password')
+            conf = JenkinsConfigFinder.find("//hudson.plugins.jacoco.JacocoPublisher", "minimumMethodCoverage")
+            conf.should include('job2' => '0')
+        end
+
+        it "searches a promotion job" do
+            JenkinsConfigFinder.connect('http://www.x.com', 'mock_user', 'mock_password')
+            conf = JenkinsConfigFinder.find("//disabled")
+            conf.should include('job2/push_test' => 'nope')
+        end
+
+        it "searches a promotion job for a node" do
+            JenkinsConfigFinder.connect('http://www.x.com', 'mock_user', 'mock_password')
+            conf = JenkinsConfigFinder.find("//hudson.plugins.promoted__builds.PromotionProcess", "disabled")
+            conf.should include('job2/push_test' => 'nope')
+        end
+
+        it "searches for something not found" do
+            JenkinsConfigFinder.connect('http://www.x.com', 'mock_user', 'mock_password')
+            conf = JenkinsConfigFinder.find("//monkeys")
+            expect(conf).to be_empty
+        end
+
+    end
+    
+end

data/spec/spec_helper.rb

@@ -0,0 +1,17 @@
+require 'simplecov'
+SimpleCov.start
+
+require 'rspec'
+require 'webmock/rspec'
+
+require_relative '../lib/jenkins_config_finder'
+
+RSpec.configure do |config|
+  config.expect_with :rspec do |c|
+    c.syntax = [:should, :expect]
+  end
+
+  config.mock_with :rspec do |c|
+    c.syntax = [:should, :expect]
+  end
+end

metadata

@@ -0,0 +1,88 @@
+--- !ruby/object:Gem::Specification
+name: jenkins-config-finder
+version: !ruby/object:Gem::Version
+  version: '0.1'
+platform: ruby
+authors:
+- Bradley, Dan
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2014-12-04 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.6'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.6'
+- !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'
+description: Find configuration items across all jenkins jobs
+email:
+- danb468@gmail.com
+executables:
+- jenkins-config-finder.rb
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".travis.yml"
+- Gemfile
+- Gemfile.lock
+- LICENSE.txt
+- README.md
+- Rakefile
+- bin/jenkins-config-finder.rb
+- jenkins-config-finder.gemspec
+- lib/jenkins_config_finder.rb
+- spec/jenkins_config_finder_spec.rb
+- spec/spec_helper.rb
+homepage: ''
+licenses:
+- MIT
+metadata: {}
+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.2.2
+signing_key: 
+specification_version: 4
+summary: Search configurations for all jenkins jobs
+test_files:
+- spec/jenkins_config_finder_spec.rb
+- spec/spec_helper.rb
+has_rdoc: