leeroy_jenkins 0.3.0 → 0.4.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 4612f068204c29e5974fca44bc9caecb6748c7e9
-  data.tar.gz: a83a55f9e5611c7faedf56993f8c39c5118159eb
+  metadata.gz: e7250c26ddbb7688160d7f465e969a04a31384d9
+  data.tar.gz: 4232370b71230e292664ccdb2d4845b9333c2533
 SHA512:
-  metadata.gz: f3d432dd6f88cb2b13f19d74cb0749f9c5e6589b440d426c1a985632ab512e635e42f9ddf8e7e35aa1b04966d40c7774cb19cc32820859df58e25044ca79730e
-  data.tar.gz: c741588ce832eaf3faaa90db0c11293bb9bfb59e6597de287de584ec6e1f7e0dc73bb60786e786c155a8ec984ed739ac9d1d265384250886f3d54c450de14469
+  metadata.gz: 4f4da81497645190fd871ccfc9eea476e57ea6e3b9867ec7ef71333f9408c4872ef58ab25368345053f1cb99554a64fb66a932d9049362470985b28ea960dc46
+  data.tar.gz: ac7db9f73e29117082e41dfdfed0fa05e1db14f0f9caa68fdf7f71ae6c4d72f048b47df801863338382ae648856f702dae1036630a726142db8a786cd4c157b3

data/.rubocop.yml

@@ -0,0 +1,24 @@
+inherit_from: .rubocop_todo.yml
+
+Style/WordArray:
+  Enabled: false
+
+Style/HashSyntax:
+  Exclude:
+    - 'Rakefile'
+
+Metrics/LineLength:
+  Exclude:
+    - 'lib/leeroy_jenkins/cli.rb'
+
+Metrics/AbcSize:
+  Max: 25
+
+Metrics/MethodLength:
+  Max: 20
+
+Style/Documentation:
+  Enabled: false
+
+Metrics/ParameterLists:
+  Max: 6

data/.rubocop_todo.yml

@@ -0,0 +1,18 @@
+# This configuration was generated by
+# `rubocop --auto-gen-config`
+# on 2016-08-09 13:57:32 -0500 using RuboCop version 0.42.0.
+# The point is for the user to remove these configuration records
+# one by one as the offenses are removed from the code base.
+# Note that changes in the inspected code, or installation of new
+# versions of RuboCop, may require this file to be generated again.
+
+# Offense count: 3
+Lint/AmbiguousRegexpLiteral:
+  Exclude:
+    - 'features/step_definitions/jenkins.rb'
+
+# Offense count: 49
+# Configuration parameters: AllowHeredoc, AllowURI, URISchemes.
+# URISchemes: http, https
+Metrics/LineLength:
+  Max: 172

data/README.md

@@ -1,5 +1,7 @@
 # leeroy_jenkins
 
+[![Gem](https://img.shields.io/gem/v/leeroy_jenkins.svg)](https://rubygems.org/gems/leeroy_jenkins)
+
 ## Description
 A CLI tool for managing Jenkins job configurations: bulk update, backup, and restore your Jenkins job configurations
 
@@ -21,14 +23,44 @@ Or install it yourself as:
 
 ## Usage
 
-Set your `LEEROY_JENKINS_USERNAME`, `LEEROY_JENKINS_PASSWORD`, and `LEEROY_JENKINS_SERVER_URL` appropriately for your Jenkins. These can also be overridden with command line options.
+Set your `LEEROY_JENKINS_USERNAME`, `LEEROY_JENKINS_PASSWORD`, and `LEEROY_JENKINS_SERVER_URL` environment variables appropriately for your Jenkins. These can also be overridden with command line options. Run `leeroy --help` to see the available sub-commands and options:
 
     $ leeroy --help
-	$ leeroy help [COMMAND_NAME]
+    Commands:
+      leeroy append NEW_NODE.xml      # Append to XML nodes in jenkins jobs' config.xml
+      leeroy backup BACKUP_DIR_PATH   # Save the config.xml of Jenkins jobs to disk, BACKUP_DIR created if it does not exist
+      leeroy delete                   # Delete XML nodes in jenkins jobs' config.xml
+      leeroy help [COMMAND]           # Describe available commands or one specific command
+      leeroy replace NEW_NODE.xml     # Replace XML nodes in jenkins jobs' config.xml
+      leeroy restore BACKUP_DIR_PATH  # Restore config.xml files to Jenkins jobs from backups
 
-## Development
+    Options:
+      [--dry-run], [--no-dry-run]                    # Show what leeroy would do, without doing it
+                                                     # Default: true
+      [--jenkins-log-level=N]                        # Detail of the messages logged by the Jenkins API client: DEBUG (0), INFO (1), WARN (2), FATAL (3)
+                                                     # Default: 3
+                                                     # Possible values: 0, 1, 2, 3
+      [--jenkins-log-location=JENKINS_LOG_LOCATION]  # Path to write messages logged by the Jenkins API client
+                                                     # Default: /dev/stdout
+      [--job-regex=JOB_REGEX]                        # Regular expression to select jobs by name
+                                                     # Default: .*
+      [--jobs=JOBS]                                  # Path to a file containing a job name on each line
+      [--password=PASSWORD]                          # Override LEEROY_JENKINS_PASSWORD
+      [--server-url=SERVER_URL]                      # Override LEEROY_JENKINS_SERVER_URL
+      [--threads=N]                                  # Number of threads to use for network and disk IO
+                                                     # Default: 4
+      [--username=USERNAME]                          # Override LEEROY_JENKINS_USERNAME
+
+For more specific examples and documentation of features, take a look in the `features` directory (the fixtures referenced there are [here](https://github.com/Jellyvision/leeroy_jenkins/tree/master/features/fixtures)):
 
-After checking out the repo, run `bundle install` to install dependencies. Then, run `bundle exec rspec` to run the unit tests. You can also run `bundle exec bin/console` for an interactive prompt that will allow you to experiment. Run `bundle exec exe/leeroy` to use the gem in this directory, ignoring other installed copies of this gem.
+* [append](https://github.com/Jellyvision/leeroy_jenkins/blob/master/features/append.feature)
+* [backup](https://github.com/Jellyvision/leeroy_jenkins/blob/master/features/backup.feature)
+* [delete](https://github.com/Jellyvision/leeroy_jenkins/blob/master/features/delete.feature)
+* [replace](https://github.com/Jellyvision/leeroy_jenkins/blob/master/features/replace.feature)
+* [restore](https://github.com/Jellyvision/leeroy_jenkins/blob/master/features/restore.feature)
+
+## Development
 
-To run the acceptance tests, run `vagrant up` to start your own Jenkins instance. This may take 5-10 minutes, but when finished you'll be able to access Jenkins at `192.168.50.33:8080` in your web browser. Then run `bundle exec cucumber`.
+After checking out the repo, run `bundle install` to install dependencies. Then, run `bundle exec rake rspec` to run the unit tests. Run `bundle exec rake rubocop` to lint. You can also run `bundle exec bin/console` to launch a pry session with all code and dependencies loaded. Run `bundle exec exe/leeroy` to use the gem in this directory, ignoring other installed copies of this gem.
 
+To run the acceptance tests, run `vagrant up` to start your own Jenkins instance. This may take 5-10 minutes, but when finished you'll be able to access Jenkins at `192.168.50.33:8080` in your web browser. Then run `bundle exec rake cucumber`. `bundle exec rake verify` will lint, run unit tests, and run acceptance tests. This is also the default rake task.

data/Rakefile

@@ -1,6 +1,21 @@
-require "bundler/gem_tasks"
-require "rspec/core/rake_task"
+require 'bundler/gem_tasks'
 
-RSpec::Core::RakeTask.new(:spec)
+desc 'Lint, run unit tests, and run acceptance tests.'
+task :verify => [:rubocop, :rspec, :cucumber]
 
-task :default => :spec
+desc 'Lint.'
+task :rubocop do
+  sh 'bundle exec rubocop'
+end
+
+desc 'Run unit tests.'
+task :rspec do
+  sh 'bundle exec rspec'
+end
+
+desc 'Run acceptance tests.'
+task :cucumber do
+  sh 'bundle exec cucumber'
+end
+
+task :default => :verify

data/Vagrantfile

@@ -1,16 +1,20 @@
 Vagrant.configure 2 do |config|
-  config.vm.box = "ubuntu/trusty64"
-  config.vm.network "private_network", ip: "192.168.50.33"
+  config.vm.box = 'ubuntu/trusty64'
+  config.vm.network 'private_network', ip: '192.168.50.33'
 
-  config.vm.provision "shell", inline: <<-SCRIPT
-apt-get update
-apt-get upgrade -y
+  config.vm.provision 'shell', inline: <<EOF
+set -ex
 
-apt-get install openjdk-7-jdk -y
+JENKINS_VERSION=1.658
 
-wget -q -O - https://jenkins-ci.org/debian/jenkins-ci.org.key | apt-key add -
-sh -c 'echo deb http://pkg.jenkins-ci.org/debian binary/ > /etc/apt/sources.list.d/jenkins.list'
 apt-get update
-apt-get install jenkins -y
-  SCRIPT
+
+curl -sL \
+  -o /tmp/jenkins_${JENKINS_VERSION}_all.deb \
+  http://pkg.jenkins-ci.org/debian/binary/jenkins_${JENKINS_VERSION}_all.deb
+
+apt-get install openjdk-7-jre-headless daemon -y
+dpkg -i /tmp/jenkins_${JENKINS_VERSION}_all.deb
+
+EOF
 end

data/bin/console

@@ -1,7 +1,7 @@
 #!/usr/bin/env ruby
 
-require "bundler/setup"
-require "leeroy_jenkins"
+require 'bundler/setup'
+require 'leeroy_jenkins'
 
-require "pry"
+require 'pry'
 Pry.start

data/exe/leeroy

@@ -1,5 +1,5 @@
 #!/usr/bin/env ruby
 
-require "leeroy_jenkins"
+require 'leeroy_jenkins'
 
 LeeroyJenkins::Cli.start ARGV

data/leeroy_jenkins.gemspec

@@ -19,17 +19,17 @@ Gem::Specification.new do |spec|
   spec.require_paths = ['lib']
 
   spec.add_dependency 'jenkins_api_client', '~> 1.4'
-  spec.add_dependency 'thor', '~> 0.19.1'
   spec.add_dependency 'nokogiri', '~> 1.6'
   spec.add_dependency 'parallel', '~> 1.6'
+  spec.add_dependency 'thor', '~> 0.19.1'
 
+  spec.add_development_dependency 'aruba', '~> 0.14.1'
   spec.add_development_dependency 'bundler', '~> 1.10'
-  spec.add_development_dependency 'rake', '~> 10.0'
-  spec.add_development_dependency 'rspec', '~> 3.3'
-  spec.add_development_dependency 'aruba', '~> 0.9.0'
-  spec.add_development_dependency 'cucumber', '~> 2.1'
   spec.add_development_dependency 'pry', '~> 0.10.1'
   spec.add_development_dependency 'pry-doc', '~> 0.8.0'
   spec.add_development_dependency 'pry-stack_explorer', '~> 0.4.9'
-  spec.add_development_dependency 'rubocop', '~> 0.37.2'
+  spec.add_development_dependency 'rake', '~> 10.0'
+  spec.add_development_dependency 'rspec', '~> 3.3'
+  spec.add_development_dependency 'rubocop', '~> 0.42.0'
+  spec.add_development_dependency 'simplecov', '~> 0.12.0'
 end

data/lib/leeroy_jenkins.rb

@@ -1,20 +1,21 @@
-require "jenkins_api_client"
-require "thor"
-require "nokogiri"
-require "parallel"
+require 'jenkins_api_client'
+require 'thor'
+require 'nokogiri'
+require 'parallel'
 
-require "leeroy_jenkins/version"
-require "leeroy_jenkins/cli"
-require "leeroy_jenkins/job_finder"
-require "leeroy_jenkins/jenkins_client_builder"
-require "leeroy_jenkins/job_updater"
-require "leeroy_jenkins/job_backupper"
-require "leeroy_jenkins/job_restorer"
+require 'leeroy_jenkins/version'
+require 'leeroy_jenkins/cli'
+require 'leeroy_jenkins/result'
+require 'leeroy_jenkins/job_finder'
+require 'leeroy_jenkins/jenkins_client_builder'
+require 'leeroy_jenkins/job_updater'
+require 'leeroy_jenkins/job_backupper'
+require 'leeroy_jenkins/job_restorer'
 
 module LeeroyJenkins
-  def self.invalid_xml_document? raw_xml
+  def self.invalid_xml_document?(raw_xml)
     begin
-      Nokogiri::XML(raw_xml) { |config| config.strict }
+      Nokogiri::XML(raw_xml, &:strict)
     rescue Nokogiri::XML::SyntaxError => e
       return e
     end

data/lib/leeroy_jenkins/cli.rb

@@ -1,93 +1,87 @@
 module LeeroyJenkins
   class Cli < Thor
-    class_option :log_level,    required: false, type: :numeric, desc: 'The detail of the messages logged by the Jenkins API client. DEBUG (0), INFO (1), WARN (2), FATAL (3)', enum: [0, 1, 2, 3], default: 3
-    class_option :log_location, required: false, type: :string,  desc: 'Path to the log file', default: STDOUT
-    class_option :username,     required: false, type: :string,  desc: 'Override LEEROY_JENKINS_USERNAME'
-    class_option :password,     required: false, type: :string,  desc: 'Override LEEROY_JENKINS_PASSWORD'
-    class_option :server_url,   required: false, type: :string,  desc: 'Override LEEROY_JENKINS_SERVER_URL'
-    class_option :threads,      required: false, type: :numeric, desc: 'Number of threads to use for network and disk IO', default: 4
-
-    desc 'update-config', 'Modify jobs\' config.xml'
-    option :job_regex, required: false, type: :string,  desc: 'Regular expression to select jobs by name', default: '.*'
-    option :new_xml,   required: true,  type: :string,  desc: 'Path to an XML file'
-    option :xpath,     required: false, type: :string,  desc: 'XPath of node(s) to modify in the config.xml of the specified job(s)', default: '/'
-    option :dry_run,                    type: :boolean, desc: 'Write XML to STDOUT instead of to Jenkins', default: true
-    option :at_xpath,  required: false, type: :string,  desc: 'Replace, append to, or delete the XML node(s) specified by the given XPath', enum: ['replace', 'append', 'delete'], default: 'replace'
-    option :jobs,      required: false, type: :string,  desc: 'Path to a file containing a job name on each line'
-    def update_config
-      raw_xml_string = File.read options[:new_xml]
-      if error = LeeroyJenkins.invalid_xml_document?(raw_xml_string)
-        error "#{options[:new_xml]}} is not well-formed XML: #{error}"
-        exit 1
-      end
+    # exit non-zero on failure
+    # https://github.com/erikhuda/thor/issues/244
+    def self.exit_on_failure?
+      true
+    end
 
-      jenkins_client = build_jenkins_client(options)
+    class_option :dry_run,              type: :boolean, default: true,          desc: 'Show what leeroy would do, without doing it'
+    class_option :jenkins_log_level,    type: :numeric, default: 3,             desc: 'Detail of the messages logged by the Jenkins API client: DEBUG (0), INFO (1), WARN (2), FATAL (3)', enum: [0, 1, 2, 3]
+    class_option :jenkins_log_location, type: :string,  default: '/dev/stdout', desc: 'Path to write messages logged by the Jenkins API client'
+    class_option :job_regex,            type: :string,  default: '.*',          desc: 'Regular expression to select jobs by name'
+    class_option :jobs,                 type: :string,                          desc: 'Path to a file containing a job name on each line'
+    class_option :password,             type: :string,                          desc: 'Override LEEROY_JENKINS_PASSWORD'
+    class_option :server_url,           type: :string,                          desc: 'Override LEEROY_JENKINS_SERVER_URL'
+    class_option :threads,              type: :numeric, default: 4,             desc: 'Number of threads to use for network and disk IO'
+    class_option :username,             type: :string,                          desc: 'Override LEEROY_JENKINS_USERNAME'
 
-      job_rows =
-        if options[:jobs]
-          File.read(options[:jobs]).split("\n")
-        else
-          nil
-        end
+    desc 'append NEW_NODE.xml', 'Append to XML nodes in jenkins jobs\' config.xml'
+    option :xpath, type: :string, default: '/', desc: 'XPath of node(s) to modify in the config.xml of the specified job(s)'
+    def append(xml_file_path)
+      puts update_jobs(read_and_validate_xml_file(xml_file_path), __method__)
+    end
 
-      job_names_to_update = JobFinder.new(jenkins_client).find_jobs(options[:job_regex], job_rows)
-      job_updater = JobUpdater.new job_names_to_update, raw_xml_string, jenkins_client, options[:xpath], options[:at_xpath], options[:threads]
-      result = options[:dry_run] ? job_updater.dry_run : job_updater.update_jobs!
+    desc 'replace NEW_NODE.xml', 'Replace XML nodes in jenkins jobs\' config.xml'
+    option :xpath, type: :string, default: '/', desc: 'XPath of node(s) to modify in the config.xml of the specified job(s)'
+    def replace(xml_file_path)
+      puts update_jobs(read_and_validate_xml_file(xml_file_path), __method__)
+    end
 
-      if options[:dry_run]
-        result.each do |key, value|
-          puts "#{key}:"
-          puts
-          puts value
-        end
-      else
-        result.each do |key, value|
-          puts "#{key}: #{value}"
-        end
-      end
+    desc 'delete', 'Delete XML nodes in jenkins jobs\' config.xml'
+    option :xpath, type: :string, default: '/', desc: 'XPath of node(s) to modify in the config.xml of the specified job(s)'
+    def delete
+      puts update_jobs('', __method__)
     end
 
-    desc 'backup', 'Save the config.xml of Jenkins jobs to disk'
-    option :job_regex,  required: false, type: :string, desc: 'Regular expression to select jobs by name', default: '.*'
-    option :backup_dir, required: true,  type: :string, desc: 'Path to the directory to save the config.xml file to, created if it does not exist'
-    def backup
-      jenkins_client = build_jenkins_client options
-      job_names_to_backup = JobFinder.new(jenkins_client).find_jobs(options[:job_regex])
-      JobBackupper.new(job_names_to_backup, jenkins_client, options[:backup_dir], options[:threads]).backup
+    desc 'backup BACKUP_DIR_PATH', 'Save the config.xml of Jenkins jobs to disk, BACKUP_DIR created if it does not exist'
+    def backup(backup_dir)
+      puts JobBackupper.new(job_names, jenkins_client, backup_dir, options[:threads]).backup(options[:dry_run])
     end
 
-    desc 'restore', 'Restore config.xml files to Jenkins jobs from backups'
-    option :backup_dir, required: true, type: :string,  desc: 'Path to the directory where config.xml files were backed up'
-    option :dry_run,                    type: :boolean, desc: 'Write XML to STDOUT instead of to Jenkins', default: true
-    def restore
-      jenkins_client = build_jenkins_client options
-      job_restorer = JobRestorer.new jenkins_client, options[:backup_dir], options[:threads]
+    desc 'restore BACKUP_DIR_PATH', 'Restore config.xml files to Jenkins jobs from backups'
+    def restore(backup_dir)
+      job_restorer = JobRestorer.new(jenkins_client, backup_dir, options[:threads], job_rows, options[:job_regex])
       result = options[:dry_run] ? job_restorer.dry_run : job_restorer.restore!
 
-      if options[:dry_run]
-        result.each do |key, value|
-          puts "#{key}:"
-          puts
-          puts value
-        end
-      else
-        result.each do |key, value|
-          puts "#{key}: #{value}"
-        end
-      end
+      puts result
     end
 
     private
 
-    def build_jenkins_client options
-      JenkinsClientBuilder.new(
+    def read_and_validate_xml_file(xml_file_path)
+      raw_xml_string = File.read(xml_file_path)
+      xml_parse_error = LeeroyJenkins.invalid_xml_document?(raw_xml_string)
+      die("#{xml_file_path} does not contain well-formed XML: #{xml_parse_error}") if xml_parse_error
+      raw_xml_string
+    end
+
+    def update_jobs(raw_xml_string, command_name)
+      job_updater = JobUpdater.new(job_names, raw_xml_string, jenkins_client, options[:xpath], command_name, options[:threads])
+      job_updater.update_jobs(options[:dry_run])
+    end
+
+    def jenkins_client
+      @jenkins_client ||= JenkinsClientBuilder.new(
         server_url: options[:server_url],
         username: options[:username],
         password: options[:password],
-        log_level: options[:log_level],
-        log_location: options[:log_location]
+        log_level: options[:jenkins_log_level],
+        log_location: options[:jenkins_log_location]
       ).build
     end
 
+    def job_names
+      JobFinder.new(jenkins_client).find_jobs(options[:job_regex], job_rows)
+    end
+
+    def job_rows
+      options[:jobs] ? File.read(options[:jobs]).split("\n") : []
+    end
+
+    def die(error_message)
+      error error_message
+      exit 1
+    end
   end
 end

data/lib/leeroy_jenkins/jenkins_client_builder.rb

@@ -1,4 +1,5 @@
 module LeeroyJenkins
+  # TODO: this isn't what a builder is
   class JenkinsClientBuilder
     attr_reader :server_url, :username, :password, :log_level, :log_location
 

data/lib/leeroy_jenkins/job_backupper.rb

@@ -9,32 +9,35 @@ module LeeroyJenkins
       @threads = threads
     end
 
-    def get_job_configs
-      pairs = map_job_configs do |job_name, job_config|
-        [job_name, job_config]
+    def backup(dry = true)
+      Result.new(dry ? dry_run : backup!)
+    end
+
+    private
+
+    def backup!
+      FileUtils.mkdir_p(backup_dir) unless Dir.exist?(backup_dir)
+
+      pairs = Parallel.map(job_names_to_backup, in_threads: threads) do |job_name|
+        job_config = jenkins_client.job.get_config(job_name)
+        path = xml_file_path(job_name)
+        File.write(path, job_config)
+        [job_name, path]
       end
 
       Hash[pairs]
     end
 
-    def backup
-      unless Dir.exists? backup_dir
-        FileUtils.mkdir_p backup_dir
+    def dry_run
+      pairs = job_names_to_backup.map do |job_name|
+        [job_name, xml_file_path(job_name)]
       end
 
-      map_job_configs do |job_name, job_config|
-        File.write "#{backup_dir}/#{job_name}.xml", job_config
-      end
+      Hash[pairs]
     end
 
-    private
-
-    def map_job_configs &block
-      Parallel.map(job_names_to_backup, in_threads: threads) do |job_name|
-        job_config = jenkins_client.job.get_config job_name
-        yield job_name, job_config
-      end
+    def xml_file_path(job_name)
+      "#{backup_dir}/#{job_name}.xml"
     end
-
   end
 end

data/lib/leeroy_jenkins/job_finder.rb

@@ -6,10 +6,10 @@ module LeeroyJenkins
       @jenkins_client = jenkins_client
     end
 
-    def find_jobs(regex, job_names = nil)
+    def find_jobs(regex, job_names = [])
       jobs_matching_regex = jenkins_client.job.list(regex)
 
-      if job_names
+      if job_names.any?
         jobs_matching_regex.select do |job|
           job_names.include? job
         end

data/lib/leeroy_jenkins/job_restorer.rb

@@ -1,39 +1,56 @@
 module LeeroyJenkins
   class JobRestorer
-    attr_reader :backup_dir, :jenkins_client, :threads
+    attr_reader :backup_dir, :jenkins_client, :threads, :job_names, :job_regex
 
-    def initialize(jenkins_client, backup_dir, threads)
+    def initialize(jenkins_client, backup_dir, threads, job_names, job_regex)
       @jenkins_client = jenkins_client
       @backup_dir = backup_dir
       @threads = threads
+      @job_names = job_names
+      @job_regex = Regexp.new(job_regex)
     end
 
     def dry_run
       pairs = Parallel.map(config_xml_file_paths, in_threads: threads) do |xml_path|
-        job_name = File.basename xml_path, '.*'
+        job_name = File.basename(xml_path, '.*')
         [job_name, File.read(xml_path)]
       end
 
-      Hash[pairs]
+      Result.new(Hash[pairs])
     end
 
     def restore!
       pairs = Parallel.map(config_xml_file_paths, in_threads: threads) do |xml_path|
-        job_name = File.basename xml_path, '.*'
-        http_status_code = jenkins_client.job.create_or_update job_name, File.read(xml_path)
+        job_name = File.basename(xml_path, '.*')
+
+        http_status_code = jenkins_client.job.create_or_update(
+          job_name, File.read(xml_path)
+        )
+
         [job_name, http_status_code]
       end
 
-      Hash[pairs]
+      Result.new(Hash[pairs])
     end
 
     private
 
     def config_xml_file_paths
-      Dir.entries(backup_dir).
-        select { |file_name| file_name.end_with? '.xml' }.
-        map { |file_name| "#{backup_dir}/#{file_name}" }
+      Dir.entries(backup_dir)
+         .select { |file_name| file_name.end_with? '.xml' }
+         .select { |file_name| restore_job?(file_name) }
+         .map { |file_name| "#{backup_dir}/#{file_name}" }
     end
 
+    def restore_job?(file_name)
+      # http://rubular.com/r/UxTupLRyg4
+      job_name = file_name.match(/^(?<job_name>[^.]+)\.xml$/)['job_name']
+
+      if job_names.any?
+        job_names.include?(job_name) && job_name =~ job_regex
+      else
+        job_name =~ job_regex
+      end
+    end
   end
 end

data/lib/leeroy_jenkins/job_updater.rb

@@ -1,6 +1,11 @@
 module LeeroyJenkins
   class JobUpdater
-    attr_reader :job_names_to_update, :new_xml, :jenkins_client, :xpath, :at_xpath, :threads
+    attr_reader :job_names_to_update,
+                :new_xml,
+                :jenkins_client,
+                :xpath,
+                :at_xpath,
+                :threads
 
     def initialize(job_names_to_update, new_xml, jenkins_client, xpath, at_xpath, threads)
       @job_names_to_update = job_names_to_update
@@ -11,9 +16,15 @@ module LeeroyJenkins
       @threads = threads
     end
 
+    def update_jobs(dry = true)
+      Result.new(dry ? dry_run : update_jobs!)
+    end
+
+    private
+
     def update_jobs!
       pairs = Parallel.map(job_names_to_update, in_threads: threads) do |job_name|
-        http_status_code = jenkins_client.job.post_config job_name, construct_xml(job_name)
+        http_status_code = jenkins_client.job.post_config job_name, build_xml(job_name)
         [job_name, http_status_code]
       end
 
@@ -22,28 +33,26 @@ module LeeroyJenkins
 
     def dry_run
       pairs = Parallel.map(job_names_to_update, in_threads: threads) do |job_name|
-        [job_name, construct_xml(job_name)]
+        [job_name, build_xml(job_name)]
       end
 
       Hash[pairs]
     end
 
-    private
-
-    def construct_xml job_name
+    def build_xml(job_name)
       element_to_insert = Nokogiri.XML(new_xml).root
-      document_to_modify = Nokogiri.XML current_xml(job_name), &:noblanks
+      document_to_modify = Nokogiri.XML(current_xml(job_name), &:noblanks)
       elements_to_modify = document_to_modify.xpath(xpath).map do |node|
         node.document? ? node.root : node
       end
 
       elements_to_modify.each do |node|
         case at_xpath
-        when 'replace'
+        when :replace
           node.replace element_to_insert
-        when 'append'
+        when :append
           node << element_to_insert
-        when 'delete'
+        when :delete
           node.remove
         end
       end
@@ -51,9 +60,8 @@ module LeeroyJenkins
       document_to_modify.canonicalize
     end
 
-    def current_xml job_name
-      jenkins_client.job.get_config job_name
+    def current_xml(job_name)
+      jenkins_client.job.get_config(job_name)
     end
-
   end
 end

data/lib/leeroy_jenkins/result.rb

@@ -0,0 +1,19 @@
+module LeeroyJenkins
+  class Result
+    def initialize(result_hashes)
+      @result_hashes = result_hashes
+    end
+
+    def to_s
+      JSON.pretty_generate(result_hashes)
+    end
+
+    def ==(other)
+      other.class == self.class && result_hashes == other.result_hashes
+    end
+
+    protected
+
+    attr_reader :result_hashes
+  end
+end

data/lib/leeroy_jenkins/version.rb

@@ -1,3 +1,3 @@
 module LeeroyJenkins
-  VERSION = '0.3.0'
+  VERSION = '0.4.0'.freeze
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: leeroy_jenkins
 version: !ruby/object:Gem::Version
-  version: 0.3.0
+  version: 0.4.0
 platform: ruby
 authors:
 - Jeff Rabovsky
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2016-02-12 00:00:00.000000000 Z
+date: 2016-08-30 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: jenkins_api_client
@@ -25,21 +25,21 @@ dependencies:
       - !ruby/object:Gem::Version
         version: '1.4'
 - !ruby/object:Gem::Dependency
-  name: thor
+  name: nokogiri
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 0.19.1
+        version: '1.6'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 0.19.1
+        version: '1.6'
 - !ruby/object:Gem::Dependency
-  name: nokogiri
+  name: parallel
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
@@ -53,145 +53,145 @@ dependencies:
       - !ruby/object:Gem::Version
         version: '1.6'
 - !ruby/object:Gem::Dependency
-  name: parallel
+  name: thor
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '1.6'
+        version: 0.19.1
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '1.6'
+        version: 0.19.1
 - !ruby/object:Gem::Dependency
-  name: bundler
+  name: aruba
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '1.10'
+        version: 0.14.1
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '1.10'
+        version: 0.14.1
 - !ruby/object:Gem::Dependency
-  name: rake
+  name: bundler
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '10.0'
+        version: '1.10'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '10.0'
+        version: '1.10'
 - !ruby/object:Gem::Dependency
-  name: rspec
+  name: pry
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '3.3'
+        version: 0.10.1
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '3.3'
+        version: 0.10.1
 - !ruby/object:Gem::Dependency
-  name: aruba
+  name: pry-doc
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 0.9.0
+        version: 0.8.0
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 0.9.0
+        version: 0.8.0
 - !ruby/object:Gem::Dependency
-  name: cucumber
+  name: pry-stack_explorer
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '2.1'
+        version: 0.4.9
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '2.1'
+        version: 0.4.9
 - !ruby/object:Gem::Dependency
-  name: pry
+  name: rake
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 0.10.1
+        version: '10.0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 0.10.1
+        version: '10.0'
 - !ruby/object:Gem::Dependency
-  name: pry-doc
+  name: rspec
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 0.8.0
+        version: '3.3'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 0.8.0
+        version: '3.3'
 - !ruby/object:Gem::Dependency
-  name: pry-stack_explorer
+  name: rubocop
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 0.4.9
+        version: 0.42.0
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 0.4.9
+        version: 0.42.0
 - !ruby/object:Gem::Dependency
-  name: rubocop
+  name: simplecov
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 0.37.2
+        version: 0.12.0
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 0.37.2
+        version: 0.12.0
 description: 
 email:
 - jeffr@jellyvision.com
@@ -202,7 +202,8 @@ extra_rdoc_files: []
 files:
 - ".gitignore"
 - ".rspec"
-- ".travis.yml"
+- ".rubocop.yml"
+- ".rubocop_todo.yml"
 - Gemfile
 - LICENSE.txt
 - README.md
@@ -218,6 +219,7 @@ files:
 - lib/leeroy_jenkins/job_finder.rb
 - lib/leeroy_jenkins/job_restorer.rb
 - lib/leeroy_jenkins/job_updater.rb
+- lib/leeroy_jenkins/result.rb
 - lib/leeroy_jenkins/version.rb
 homepage: https://github.com/Jellyvision/leeroy_jenkins
 licenses:

data/.travis.yml

@@ -1,4 +0,0 @@
-language: ruby
-rvm:
-  - 2.2.2
-before_install: gem install bundler -v 1.10.6