jenkins_api_client 1.1.0 → 1.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: f4bc7855c7d74b4542c7a98175b2319f92c5b667
-  data.tar.gz: 6ab8636c67ef0e24a747ebcc413547138ba0b3e1
+  metadata.gz: ae6ba9e0eccf49a825c6adc02e7d6d3a6200ac9d
+  data.tar.gz: eeb2d4cfb1d2858e157c74aa6b146ba572bf7246
 SHA512:
-  metadata.gz: 83a8e6835f8ba2c6de4b151b95a8ccc3f798abe0a808d4b448fd7e1ef16239f6b2ee7eedc0a89eeeba9e6866b7c92aac007e98e7599fb4f1417188948b4cf83a
-  data.tar.gz: c1e08e48ad162f2d7e9ae1d647cb96b24655d2f7bbe7f77527416e6eb8d4095d3199e3589cc214af7016c8f869a378e6b6f45cbd1d11ea502a23b9284563aa75
+  metadata.gz: 7e6088e2b7231336b556fca98788f58be9abb0d68a739ecc73789adf22f23532519cd7f08b7b4e7ed9d5f5a96db24de9ef3f303752e14784aae91e9a129d9acc
+  data.tar.gz: 148deba58cb95bb445af9b232613c740648590def0e96cfdb4bc5c7cb6687a68e17682cf8c3f9408e5ae086ecec5bb69240017547c0872a71a5376e071b77aa8

data/.gitignore

@@ -1,4 +1,7 @@
 
+# rbenv
+.ruby-version
+
 # bundler
 .bundle
 

data/CHANGELOG.md

@@ -4,6 +4,12 @@ CHANGELOG
 upcoming
 --------
 
+v1.2.0   [12-NOV-2014]
+----------------------
+* [#156][] Added workspace cleanup plugin. Credit [@hubert][]
+* [#157][] Added ability to configure SCM trigger via job creation. Credit: [@hubert][]
+* [#158][] Add ability to configure post build artifact archiver step. Credit: [@hubert][]
+
 v1.1.0   [05-NOV-2014]
 ----------------------
 * [#145][] Fix `BuildQueue#get_details` to compare against task_name. Credit: [@notruthless][]
@@ -285,6 +291,9 @@ v0.0.1  [15-OCT-2012]
 [#149]: https://github.com/arangamani/jenkins_api_client/issues/149
 [#151]: https://github.com/arangamani/jenkins_api_client/issues/151
 [#153]: https://github.com/arangamani/jenkins_api_client/issues/153
+[#156]: https://github.com/arangamani/jenkins_api_client/issues/156
+[#157]: https://github.com/arangamani/jenkins_api_client/issues/157
+[#158]: https://github.com/arangamani/jenkins_api_client/issues/158
 [@Loa]: https://github.com/Loa
 [@Niarfe]: https://github.com/Niarfe
 [@bobbrez]: https://github.com/bobbrez

data/jenkins_api_client.gemspec

@@ -2,16 +2,16 @@
 # DO NOT EDIT THIS FILE DIRECTLY
 # Instead, edit Jeweler::Tasks in Rakefile, and run 'rake gemspec'
 # -*- encoding: utf-8 -*-
-# stub: jenkins_api_client 1.1.0 ruby lib
+# stub: jenkins_api_client 1.2.0 ruby lib
 
 Gem::Specification.new do |s|
   s.name = "jenkins_api_client"
-  s.version = "1.1.0"
+  s.version = "1.2.0"
 
   s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
   s.require_paths = ["lib"]
   s.authors = ["Kannan Manickam"]
-  s.date = "2014-11-05"
+  s.date = "2014-11-13"
   s.description = "\nThis is a simple and easy-to-use Jenkins Api client with features focused on\nautomating Job configuration programaticaly and so forth"
   s.email = ["arangamani.kannan@gmail.com"]
   s.executables = ["jenkinscli"]
@@ -46,6 +46,7 @@ Gem::Specification.new do |s|
     "lib/jenkins_api_client/plugin_settings/base.rb",
     "lib/jenkins_api_client/plugin_settings/collection.rb",
     "lib/jenkins_api_client/plugin_settings/hipchat.rb",
+    "lib/jenkins_api_client/plugin_settings/workspace_cleanup.rb",
     "lib/jenkins_api_client/system.rb",
     "lib/jenkins_api_client/urihelper.rb",
     "lib/jenkins_api_client/user.rb",
@@ -73,6 +74,7 @@ Gem::Specification.new do |s|
     "spec/unit_tests/node_spec.rb",
     "spec/unit_tests/plugin_settings/colllection_spec.rb",
     "spec/unit_tests/plugin_settings/hipchat_spec.rb",
+    "spec/unit_tests/plugin_settings/workspace_cleanup_spec.rb",
     "spec/unit_tests/plugin_spec.rb",
     "spec/unit_tests/spec_helper.rb",
     "spec/unit_tests/system_spec.rb",

data/lib/jenkins_api_client.rb

@@ -44,6 +44,7 @@ module JenkinsApi
 
       autoload :Base, 'jenkins_api_client/plugin_settings/base'
       autoload :Hipchat, 'jenkins_api_client/plugin_settings/hipchat'
+      autoload :WorkspaceCleanup, 'jenkins_api_client/plugin_settings/workspace_cleanup'
       autoload :Collection, 'jenkins_api_client/plugin_settings/collection'
     end
   end

data/lib/jenkins_api_client/client.rb

@@ -74,7 +74,8 @@ module JenkinsApi
     #
     # @option args [String] :server_ip the IP address of the Jenkins CI server
     # @option args [String] :server_port the port on which the Jenkins listens
-    # @option args [String] :server_url the full URL address of the Jenkins CI server (http/https). This can include username/password. :username/:password options will override any user/pass value in the URL
+    # @option args [String] :server_url the full URL address of the Jenkins CI server (http/https). This can include
+    #   username/password. :username/:password options will override any user/pass value in the URL
     # @option args [String] :username the username used for connecting to the server (optional)
     # @option args [String] :password the password or API Key for connecting to the CI server (optional)
     # @option args [String] :password_base64 the password with base64 encoded format for connecting to the CI
@@ -263,9 +264,11 @@ module JenkinsApi
       request = Net::HTTP::Get.new(uri.request_uri)
       request.basic_auth(@username, @password)
       response = http.request(request)
-      File.write(File.expand_path(filename), response.body) if response.code == "200"
-    rescue
-      raise "Response was not 200"
+      if response.code == "200"
+        File.write(File.expand_path(filename), response.body)
+      else
+        raise "Couldn't get the artifact"
+      end
     end
 
     # Connects to the Jenkins server, sends the specified request and returns

data/lib/jenkins_api_client/job.rb

@@ -322,14 +322,19 @@ module JenkinsApi
               "#{params[:block_build_when_downstream_building]}")
             xml.blockBuildWhenUpstreamBuilding(
               "#{params[:block_build_when_upstream_building]}")
-            if params[:timer]
-              xml.triggers.vector do
+            xml.triggers.vector do 
+              if params[:timer]
                 xml.send("hudson.triggers.TimerTrigger") do
                   xml.spec params[:timer]
                 end
               end
-            else
-              xml.triggers.vector
+
+              if params[:scm_trigger]
+                xml.send("hudson.triggers.SCMTrigger") do
+                  xml.spec params[:scm_trigger]
+                  xml.ignorePostCommitHooks params.fetch(:ignore_post_commit_hooks) { false }
+                end
+              end
             end
             xml.concurrentBuild "#{params[:concurrent_build]}"
             # Shell command stuff
@@ -348,6 +353,7 @@ module JenkinsApi
               notification_email(params, xml) if params[:notification_email]
               # Build portion of XML that adds skype notification
               skype_notification(params, xml) if params[:skype_targets]
+              artifact_archiver(params[:artifact_archiver], xml)
             end
             xml.buildWrappers
           end
@@ -424,6 +430,40 @@ module JenkinsApi
         end
       end
 
+      # Configure post-build step to archive artifacts
+      #
+      # @param artifact_params [Hash] parameters controlling how artifacts are archived
+      #
+      # @option artifact_params [String] :artifact_files
+      #   pattern or names of files to archive
+      # @option artifact_params [String] :excludes
+      #   pattern or names of files to exclude
+      # @option artifact_params [Boolean] :fingerprint (false)
+      #   fingerprint the archives
+      # @option artifact_params [Boolean] :allow_empty_archive (false)
+      #   whether to allow empty archives
+      # @option artifact_params [Boolean] :only_if_successful (false)
+      #   only archive if successful
+      # @option artifact_params [Boolean] :default_excludes (false)
+      #   exclude defaults automatically
+      #
+      # @return [Nokogiri::XML::Builder] 
+      #
+      def artifact_archiver(artifact_params, xml)
+        return xml if artifact_params.nil?
+
+        xml.send('hudson.tasks.ArtifactArchiver') do |x|
+          x.artifacts artifact_params.fetch(:artifact_files) { '' }
+          x.excludes artifact_params.fetch(:excludes) { '' }
+          x.fingerprint artifact_params.fetch(:fingerprint) { false }
+          x.allowEmptyArchive artifact_params.fetch(:allow_empty_archive) { false }
+          x.onlyIfSuccessful artifact_params.fetch(:only_if_successful) { false }
+          x.defaultExcludes artifact_params.fetch(:default_excludes) { false }
+        end
+
+        xml
+      end
+
       # Rename a job given the old name and new name
       #
       # @param [String] old_job Name of the old job

data/lib/jenkins_api_client/plugin_manager.rb

@@ -26,7 +26,7 @@ module JenkinsApi
     # installed plugins, installing new plgins through hacks, and performing a
     # lot of operations on installed plugins. It also gives the ability to
     # obtain the details about available plugins in Jenkins update center by
-    # commmunicating with /updateCenter API.
+    # communicating with /updateCenter API.
     #
     class PluginManager
 

data/lib/jenkins_api_client/plugin_settings/hipchat.rb

@@ -28,7 +28,7 @@ module JenkinsApi
         # This gives some flexibility for creating/updating simple jobs so the
         # user doesn't have to learn about handling xml.
         #
-        # @param params [Hash] parameters to create a freestyle project
+        # @param xml_doc [Nokogiri::XML::Document] xml document to be updated with the plugin configuration
         #
         # @return [Nokogiri::XML::Document]
         def configure(xml_doc)

data/lib/jenkins_api_client/plugin_settings/workspace_cleanup.rb

@@ -0,0 +1,35 @@
+module JenkinsApi
+  class Client
+    module PluginSettings
+      class WorkspaceCleanup < Base
+
+        # @option params [Boolean] :delete_dirs (false)
+        #   whether to also apply pattern on directories
+        # @option params [String] :cleanup_parameters
+        # @option params [String] :external_delete
+        def initialize(params={})
+          @params = params
+        end
+
+        # Create or Update a job with params given as a hash instead of the xml
+        # This gives some flexibility for creating/updating simple jobs so the
+        # user doesn't have to learn about handling xml.
+        #
+        # @param xml_doc [Nokogiri::XML::Document] xml document to be updated with the plugin configuration
+        #
+        # @return [Nokogiri::XML::Document]
+        def configure(xml_doc)
+          xml_doc.tap do |doc|
+            Nokogiri::XML::Builder.with(doc.at('buildWrappers')) do |build_wrappers|
+              build_wrappers.send('hudson.plugins.ws__cleanup.PreBuildCleanup') do |x|
+                x.deleteDirs @params.fetch(:delete_dirs) { false }
+                x.cleanupParameter @params.fetch(:cleanup_parameter) { '' }
+                x.externalDelete @params.fetch(:external_delete) { '' }
+              end
+            end
+          end
+        end
+      end
+    end
+  end
+end

data/lib/jenkins_api_client/version.rb

@@ -25,7 +25,7 @@ module JenkinsApi
     # Major version of the gem
     MAJOR   = 1
     # Minor version of the gem
-    MINOR   = 1
+    MINOR   = 2
     # Tiny version of the gem used for patches
     TINY    = 0
     # Used for pre-releases

data/spec/unit_tests/job_spec.rb

@@ -641,6 +641,80 @@ describe JenkinsApi::Client::Job do
         expect(@job.plugin_collection).to receive(:configure).and_return(Nokogiri::XML::Document.new(''))
         @job.build_freestyle_config(name: 'foobar')
       end
+
+      context 'scm_trigger and ignore_post_commit_hooks params' do
+        it 'configures triggers with a hudson.triggers.SCMTrigger' do
+          xml = @job.build_freestyle_config(
+            name: 'foobar',
+            scm_trigger: 'H 0 29 2 0',
+            ignore_post_commit_hooks: true
+          )
+
+          xml_config = Nokogiri::XML(xml)
+          expect(xml_config.at_css('triggers spec').content).to eql('H 0 29 2 0')
+          expect(xml_config.at_css('triggers ignorePostCommitHooks').content).to eql('true')
+        end
+
+        it 'does not add a tag to triggers if not passed scm_trigger param' do
+          xml = @job.build_freestyle_config(
+            name: 'foobar'
+          )
+
+          xml_config = Nokogiri::XML(xml)
+          expect(xml_config.at_css('triggers').children).to be_empty
+        end
+      end
+
+      context 'artifact archiver build step' do
+        context 'given artifact_archiver params' do
+          it 'configures with given params' do
+            artifact_archiver_params = {
+              artifact_files: '**',
+              excludes: 'foo',
+              fingerprint: true,
+              allow_empty_archive: true,
+              only_if_successful: true,
+              default_excludes: true,
+            }
+            xml = @job.build_freestyle_config(
+              name: 'foobar',
+              artifact_archiver: artifact_archiver_params,
+            )
+            xml_config = Nokogiri::XML(xml)
+
+            expect(xml_config.at_xpath('//publishers/hudson.tasks.ArtifactArchiver/artifacts').content).to eql('**')
+            expect(xml_config.at_xpath('//publishers/hudson.tasks.ArtifactArchiver/excludes').content).to eql('foo')
+            expect(xml_config.at_xpath('//publishers/hudson.tasks.ArtifactArchiver/fingerprint').content).to eql('true')
+            expect(xml_config.at_xpath('//publishers/hudson.tasks.ArtifactArchiver/allowEmptyArchive').content).to eql('true')
+            expect(xml_config.at_xpath('//publishers/hudson.tasks.ArtifactArchiver/onlyIfSuccessful').content).to eql('true')
+            expect(xml_config.at_xpath('//publishers/hudson.tasks.ArtifactArchiver/defaultExcludes').content).to eql('true')
+          end
+
+          it 'configures with defaults for non-specified options' do
+            xml = @job.build_freestyle_config(
+              name: 'foobar',
+              artifact_archiver: {},
+            )
+            xml_config = Nokogiri::XML(xml)
+
+            expect(xml_config.at_xpath('//publishers/hudson.tasks.ArtifactArchiver/artifacts').content).to eql('')
+            expect(xml_config.at_xpath('//publishers/hudson.tasks.ArtifactArchiver/excludes').content).to eql('')
+            expect(xml_config.at_xpath('//publishers/hudson.tasks.ArtifactArchiver/fingerprint').content).to eql('false')
+            expect(xml_config.at_xpath('//publishers/hudson.tasks.ArtifactArchiver/allowEmptyArchive').content).to eql('false')
+            expect(xml_config.at_xpath('//publishers/hudson.tasks.ArtifactArchiver/onlyIfSuccessful').content).to eql('false')
+            expect(xml_config.at_xpath('//publishers/hudson.tasks.ArtifactArchiver/defaultExcludes').content).to eql('false')
+          end
+        end
+
+        context 'not given artifact_archiver params' do
+          it 'omits hudson.tasks.ArtifactArchiver tag' do
+            xml = @job.build_freestyle_config(name: 'foobar')
+            xml_config = Nokogiri::XML(xml)
+
+            expect(xml_config.xpath('//publishers/hudson.tasks.ArtifactArchiver')).to be_empty
+          end
+        end
+      end
     end
 
     context 'plugin settings' do

data/spec/unit_tests/plugin_settings/workspace_cleanup_spec.rb

@@ -0,0 +1,31 @@
+require File.expand_path('../../spec_helper', __FILE__)
+
+describe JenkinsApi::Client::PluginSettings::WorkspaceCleanup do
+  describe '#configure' do
+    context 'given a Nokogiri::XML::Builder object' do
+      let(:xml_doc) { Nokogiri::XML("<?xml version=\"1.0\"?>\n<buildWrappers>\n</buildWrappers>\n") }
+
+      it 'adds workspace cleanup configuration to the buildWrappers' do
+        workspace_cleanup_settings = JenkinsApi::Client::PluginSettings::WorkspaceCleanup.new
+        workspace_cleanup_settings.configure(xml_doc)
+
+        expect(xml_doc.at_css('buildWrappers deleteDirs').content).to eql('false')
+        expect(xml_doc.at_css('buildWrappers cleanupParameter').content).to eql('')
+        expect(xml_doc.at_css('buildWrappers externalDelete').content).to eql('')
+      end
+
+      it 'uses params if given' do
+        workspace_cleanup_settings = JenkinsApi::Client::PluginSettings::WorkspaceCleanup.new({
+          :delete_dirs => true,
+          :cleanup_parameter => 'foo',
+          :external_delete => 'bar',
+        })
+        workspace_cleanup_settings.configure(xml_doc)
+
+        expect(xml_doc.at_css('buildWrappers deleteDirs').content).to eql('true')
+        expect(xml_doc.at_css('buildWrappers cleanupParameter').content).to eql('foo')
+        expect(xml_doc.at_css('buildWrappers externalDelete').content).to eql('bar')
+      end
+    end
+  end
+end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: jenkins_api_client
 version: !ruby/object:Gem::Version
-  version: 1.1.0
+  version: 1.2.0
 platform: ruby
 authors:
 - Kannan Manickam
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2014-11-05 00:00:00.000000000 Z
+date: 2014-11-13 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: nokogiri
@@ -219,6 +219,7 @@ files:
 - lib/jenkins_api_client/plugin_settings/base.rb
 - lib/jenkins_api_client/plugin_settings/collection.rb
 - lib/jenkins_api_client/plugin_settings/hipchat.rb
+- lib/jenkins_api_client/plugin_settings/workspace_cleanup.rb
 - lib/jenkins_api_client/system.rb
 - lib/jenkins_api_client/urihelper.rb
 - lib/jenkins_api_client/user.rb
@@ -246,6 +247,7 @@ files:
 - spec/unit_tests/node_spec.rb
 - spec/unit_tests/plugin_settings/colllection_spec.rb
 - spec/unit_tests/plugin_settings/hipchat_spec.rb
+- spec/unit_tests/plugin_settings/workspace_cleanup_spec.rb
 - spec/unit_tests/plugin_spec.rb
 - spec/unit_tests/spec_helper.rb
 - spec/unit_tests/system_spec.rb