jenkins_pipeline_builder 1.3.0 → 1.4.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 0687f03b5b619d7c56c13d34bfe575bbe94c4311
-  data.tar.gz: 1c55278ff7368bbcb28996ed110d12f73cfd3672
+  metadata.gz: 0015906b8d8d1be908004af6227116d2b2cf44f0
+  data.tar.gz: 0c29e265ded1b244d5a3572ea1ec8eaa3dbab5ff
 SHA512:
-  metadata.gz: 36713dd4e6e414e241cb738d6efd757efae7e8bd0c3c4419831d0820829040920c453b887d8a0942307b1feb62e6d25ec9f97d44981f44cde3cb381922d3b256
-  data.tar.gz: b7118099694c46ca1d4b7e8c85da0604394d3e004c5f92b59ab3d91bef3241c2b556098c7f35dc9a4fc3e302815bdf7a0484a7a756c3e867b39e5d7e4e67a1e0
+  metadata.gz: 0c9f85580321286f501449bc5de9c41042838f33f60d0f570d2037b51c0bfaa7c51baaae60c5337324202b46076262566b8dc6f7984ee58797610564dfff4621
+  data.tar.gz: e113a4d54514393cb96db1967524d329b585d2e265d0699e087dc6ea59cceb71acefc5a3fe795f142d5f88a857afc2eb35d2b97ea62390bc565a6f42442cfec4

data/lib/jenkins_pipeline_builder/extensions/builders.rb

@@ -26,36 +26,86 @@ builder do
   jenkins_name 'MultiJob Phase'
   announced false
 
-  xml do |params|
-    params[:phases].each do |name, content|
-      send('com.tikal.jenkins.plugins.multijob.MultiJobBuilder') do
-        phaseName name
-        phaseJobs do
-          content[:jobs].each do |job|
-            send('com.tikal.jenkins.plugins.multijob.PhaseJobsConfig') do
-              jobName job[:name]
-              currParams job[:current_params] || false
-              exposedSCM job[:exposed_scm] || false
-              if job[:config]
-                configs do
-                  if job[:config].key? :predefined_build_parameters
-                    send('hudson.plugins.parameterizedtrigger.PredefinedBuildParameters') do
-                      properties job[:config][:predefined_build_parameters]
+  version '0' do
+    xml do |params|
+      params[:phases].each do |name, content|
+        send('com.tikal.jenkins.plugins.multijob.MultiJobBuilder') do
+          phaseName name
+          phaseJobs do
+            content[:jobs].each do |job|
+              send('com.tikal.jenkins.plugins.multijob.PhaseJobsConfig') do
+                jobName job[:name]
+                currParams job[:current_params] || false
+                exposedSCM job[:exposed_scm] || false
+                if job[:config]
+                  configs do
+                    if job[:config].key? :predefined_build_parameters
+                      send('hudson.plugins.parameterizedtrigger.PredefinedBuildParameters') do
+                        properties job[:config][:predefined_build_parameters]
+                      end
+                    end
+                    if job[:config].key? :properties_file
+                      send('hudson.plugins.parameterizedtrigger.FileBuildParameters') do
+                        propertiesFile job[:config][:properties_file][:file]
+                        failTriggerOnMissing job[:config][:properties_file][:skip_if_missing] || 'false'
+                      end
                     end
                   end
-                  if job[:config].key? :properties_file
-                    send('hudson.plugins.parameterizedtrigger.FileBuildParameters') do
-                      propertiesFile job[:config][:properties_file][:file]
-                      failTriggerOnMissing job[:config][:properties_file][:skip_if_missing] || 'false'
+                end
+                killPhaseOnJobResultCondition job[:kill_phase_on] || 'FAILURE'
+              end
+            end
+          end
+          continuationCondition content[:continue_condition] || 'SUCCESSFUL'
+        end
+      end
+    end
+  end
+
+  version '1.27' do
+    xml do |params|
+      params[:phases].each do |name, content|
+        send('com.tikal.jenkins.plugins.multijob.MultiJobBuilder') do
+          phaseName name
+          phaseJobs do
+            content[:jobs].each do |job|
+              send('com.tikal.jenkins.plugins.multijob.PhaseJobsConfig') do
+                jobName job[:name]
+                currParams job[:current_params] || false
+                exposedSCM job[:exposed_scm] || false
+                disableJob job[:disable_job] || false
+                maxRetries job[:max_retries] || 0
+                enableRetryStrategy job[:enable_retry_strategy] || false
+                abortAllJob job[:abort_all_job] || false
+                if job[:condition]
+                  enableCondition true
+                  condition job[:condition]
+                  applyConditionOnlyIfNoSCMChanges job[:apply_condition_only_if]
+                end
+
+                if job[:config]
+                  configs do
+                    if job[:config].key? :predefined_build_parameters
+                      send('hudson.plugins.parameterizedtrigger.PredefinedBuildParameters') do
+                        properties job[:config][:predefined_build_parameters]
+                      end
+                    end
+                    if job[:config].key? :properties_file
+                      send('hudson.plugins.parameterizedtrigger.FileBuildParameters') do
+                        propertiesFile job[:config][:properties_file][:file]
+                        failTriggerOnMissing job[:config][:properties_file][:skip_if_missing] || 'false'
+                      end
                     end
                   end
                 end
+                killPhaseOnJobResultCondition job[:kill_phase_on] || 'FAILURE'
+                buildOnlyIfSCMChanges job[:build_only_if_scm_changes] || false
               end
-              killPhaseOnJobResultCondition job[:kill_phase_on] || 'FAILURE'
             end
           end
+          continuationCondition content[:continue_condition] || 'SUCCESSFUL'
+          executionType content[:execution_type] || 'PARALLEL'
         end
-        continuationCondition content[:continue_condition] || 'SUCCESSFUL'
       end
     end
   end

data/lib/jenkins_pipeline_builder/extensions/wrappers.rb

@@ -255,3 +255,56 @@ wrapper do
     send('hudson.plugins.ws__cleanup.PreBuildCleanup', 'plugin' => 'ws-cleanup')
   end
 end
+
+wrapper do
+  name :build_timeout
+  plugin_id 'build-timeout'
+  description 'Abort the build if it\'s stuck'
+  jenkins_name 'Abort the build if it\'s stuck'
+  announced false
+
+  xml do |wrapper|
+    send('hudson.plugins.build__timeout.BuildTimeoutWrapper', 'plugin' => 'build-timeout@1.18') do
+      if wrapper[:timeout_strategy] == 'Absolute'
+        strategy 'class' => 'hudson.plugins.build_timeout.impl.AbsoluteTimeOutStrategy' do
+          timeoutMinutes wrapper[:timeout_minutes]
+        end
+      elsif wrapper[:timeout_strategy] == 'Deadline'
+        strategy 'class' => 'hudson.plugins.build_timeout.impl.DeadlineTimeOutStrategy' do
+          deadlineTime wrapper[:deadline_time]
+          deadlineToleranceInMinutes wrapper[:deadline_tolerance]
+        end
+      elsif wrapper[:timeout_strategy] == 'Elastic'
+        strategy 'class' => 'hudson.plugins.build_timeout.impl.ElasticTimeOutStrategy' do
+          timeoutPercentage wrapper[:timeout_percentage]
+          numberOfBuilds wrapper[:number_of_builds]
+          failSafeTimeoutDuration wrapper[:fail_safe_timeout]
+          timeoutMinutesElasticDefault wrapper[:timeout_minutes]
+        end
+      elsif wrapper[:timeout_strategy] == 'Likely stuck'
+        strategy 'class' => 'hudson.plugins.build_timeout.impl.LikelyStuckTimeOutStrategy'
+      elsif wrapper[:timeout_strategy] == 'No Activity'
+        strategy 'class' => 'hudson.plugins.build_timeout.impl.NoActivityTimeOutStrategy' do
+          timeoutSecondsString wrapper[:timeout_seconds]
+        end
+      end
+      timeoutEnvVar wrapper[:timeout_env_var] unless wrapper[:timeout_env_var].nil?
+      if wrapper[:operation] == 'Abort'
+        operationList do
+          send('hudson.plugins.build__timeout.operations.AbortOperation')
+        end
+      elsif wrapper[:operation] == 'Fail'
+        operationList do
+          send('hudson.plugins.build__timeout.operations.FailOperation')
+        end
+      elsif wrapper[:operation] == 'Writing'
+        operationList do
+          send('hudson.plugins.build__timeout.operations.WriteDescriptionOperation') do
+            description wrapper[:description]
+          end
+        end
+      else operationList
+      end
+    end
+  end
+end

data/lib/jenkins_pipeline_builder/version.rb

@@ -21,5 +21,5 @@
 #
 
 module JenkinsPipelineBuilder
-  VERSION = '1.3.0'.freeze
+  VERSION = '1.4.0'.freeze
 end

data/spec/lib/jenkins_pipeline_builder/extensions/builders_spec.rb

@@ -50,25 +50,91 @@ describe 'builders' do
   end
 
   context 'multi_job builder' do
+    params = {}
+
     before :each do
+      params = { builders: { multi_job: { phases: { foo: { jobs:
+        [{
+          name: 'foo'
+        }] } } } } }
       allow(JenkinsPipelineBuilder.client).to receive(:plugin).and_return double(
         list_installed: { 'jenkins-multijob-plugin' => '20.0' }
       )
     end
 
     it 'generates a configuration' do
-      params = { builders: { multi_job: { phases: { foo: { jobs: [{ name: 'foo' }] } } } } }
       JenkinsPipelineBuilder.registry.traverse_registry_path('job', params, @n_xml)
       builder = @n_xml.root.children.first
       expect(builder.name).to match 'com.tikal.jenkins.plugins.multijob.MultiJobBuilder'
     end
 
-    it 'provides job specific config' do
-      params = { builders: { multi_job: { phases: { foo: { jobs: [{ name: 'foo', config: {
-        predefined_build_parameters: 'bar',
-        properties_file: { file: 'props', skip_if_missing: true }
-      } }] } } } } }
+    it 'generates a jobName' do
+      JenkinsPipelineBuilder.registry.traverse_registry_path('job', params, @n_xml)
+      node = @n_xml.xpath '//jobName'
+      expect(node.text).to eq 'foo'
+    end
 
+    it 'generates buildOnlyIfSCMChanges flag and sets to parameter' do
+      params = { builders: { multi_job: { phases: { foo: { jobs:
+        [{
+          name: 'foo',
+          build_only_if_scm_changes: true
+        }] } } } } }
+      JenkinsPipelineBuilder.registry.traverse_registry_path('job', params, @n_xml)
+      node = @n_xml.xpath '//buildOnlyIfSCMChanges'
+      expect(node.text).to eq 'true'
+    end
+
+    it 'generates buildOnlyIfSCMChanges flag and sets to default' do
+      JenkinsPipelineBuilder.registry.traverse_registry_path('job', params, @n_xml)
+      node = @n_xml.xpath '//buildOnlyIfSCMChanges'
+      expect(node.text).to eq 'false'
+    end
+
+    it 'generates disableJob flag and sets to parameter' do
+      params = { builders: { multi_job: { phases: { foo: { jobs:
+        [{
+          name: 'foo',
+          disable_job: true
+        }] } } } } }
+      JenkinsPipelineBuilder.registry.traverse_registry_path('job', params, @n_xml)
+      node = @n_xml.xpath '//disableJob'
+      expect(node.text).to eq 'true'
+    end
+
+    it 'generates disableJob flag and sets to default' do
+      JenkinsPipelineBuilder.registry.traverse_registry_path('job', params, @n_xml)
+      node = @n_xml.xpath '//disableJob'
+      expect(node.text).to eq 'false'
+    end
+
+    it 'generates maxRetries tag' do
+      params = { builders: { multi_job: { phases: { foo: { jobs:
+        [{
+          name: 'foo',
+          max_retries: 1
+        }] } } } } }
+      JenkinsPipelineBuilder.registry.traverse_registry_path('job', params, @n_xml)
+      node = @n_xml.xpath '//maxRetries'
+      expect(node.text).to eq '1'
+    end
+
+    it 'generates enableRetryStrategy tag and sets to default' do
+      JenkinsPipelineBuilder.registry.traverse_registry_path('job', params, @n_xml)
+      node = @n_xml.xpath '//enableRetryStrategy'
+      expect(node.text).to eq 'false'
+    end
+
+    it 'provides job specific config' do
+      params = { builders: { multi_job: { phases: { foo: { jobs:
+        [{
+          name: 'foo',
+          config:
+            {
+              predefined_build_parameters: 'bar',
+              properties_file: { file: 'props', skip_if_missing: true }
+            }
+        }] } } } } }
       JenkinsPipelineBuilder.registry.traverse_registry_path('job', params, @n_xml)
 
       node = @n_xml.xpath '//hudson.plugins.parameterizedtrigger.PredefinedBuildParameters'
@@ -80,6 +146,93 @@ describe 'builders' do
       node = @n_xml.xpath '//hudson.plugins.parameterizedtrigger.FileBuildParameters/failTriggerOnMissing'
       expect(node.children.first.content).to eq 'true'
     end
+
+    it 'generates conditional job tag' do
+      condition = '1+1==2'
+      params = { builders: [{ multi_job: { phases: { foo: { jobs:
+        [{
+          name: 'foo',
+          condition: condition,
+          apply_condition_only_if: false
+        }] } } } }] }
+
+      JenkinsPipelineBuilder.registry.traverse_registry_path('job', params, @n_xml)
+
+      node = @n_xml.xpath '//enableCondition'
+      expect(node.children.first.content).to eq 'true'
+
+      node = @n_xml.xpath '//condition'
+      expect(node.children.first.content).to eq condition
+
+      node = @n_xml.xpath '//applyConditionOnlyIfNoSCMChanges'
+      expect(node.children.first.content).to eq 'false'
+    end
+
+    it 'generates abort all other jobs tag' do
+      params = { builders: [{ multi_job: { phases: { foo: { jobs:
+        [{
+          name: 'foo',
+          abort_all_job: true
+        }] } } } }] }
+      JenkinsPipelineBuilder.registry.traverse_registry_path('job', params, @n_xml)
+      node = @n_xml.xpath '//abortAllJob'
+      expect(node.children.first.content).to eq 'true'
+    end
+
+    it 'generates abort all other jobs tag and sets to default' do
+      JenkinsPipelineBuilder.registry.traverse_registry_path('job', params, @n_xml)
+      node = @n_xml.xpath '//abortAllJob'
+      expect(node.children.first.content).to eq 'false'
+    end
+
+    it 'generates current job parameters with parameters' do
+      params = { builders: [{ multi_job: { phases: { foo: { jobs:
+        [{
+          name: 'foo',
+          current_params: true
+        }] } } } }] }
+      JenkinsPipelineBuilder.registry.traverse_registry_path('job', params, @n_xml)
+      node = @n_xml.xpath '//currParams'
+      expect(node.children.first.content).to eq 'true'
+    end
+
+    it 'generates current job parameters and sets to default' do
+      JenkinsPipelineBuilder.registry.traverse_registry_path('job', params, @n_xml)
+      node = @n_xml.xpath '//currParams'
+      expect(node.children.first.content).to eq 'false'
+    end
+
+    it 'generates continuation condition tag with parameter' do
+      params = { builders: [{ multi_job: { phases: { foo: {
+        jobs: [{ name: 'foo' }],
+        continue_condition: 'ALWAYS'
+      } } } }] }
+      JenkinsPipelineBuilder.registry.traverse_registry_path('job', params, @n_xml)
+      node = @n_xml.xpath '//continuationCondition'
+      expect(node.children.first.content).to eq 'ALWAYS'
+    end
+
+    it 'generates continuation condition tag and sets to default' do
+      JenkinsPipelineBuilder.registry.traverse_registry_path('job', params, @n_xml)
+      node = @n_xml.xpath '//continuationCondition'
+      expect(node.children.first.content).to eq 'SUCCESSFUL'
+    end
+
+    it 'generates execution type tag with parameter' do
+      params = { builders: [{ multi_job: { phases: { foo: {
+        jobs: [{ name: 'foo' }],
+        execution_type: 'SEQUENTIALLY'
+      } } } }] }
+      JenkinsPipelineBuilder.registry.traverse_registry_path('job', params, @n_xml)
+      node = @n_xml.xpath '//executionType'
+      expect(node.children.first.content).to eq 'SEQUENTIALLY'
+    end
+
+    it 'generates execution type tag and sets to default' do
+      JenkinsPipelineBuilder.registry.traverse_registry_path('job', params, @n_xml)
+      node = @n_xml.xpath '//executionType'
+      expect(node.children.first.content).to eq 'PARALLEL'
+    end
   end
 
   context 'maven3' do

data/spec/lib/jenkins_pipeline_builder/extensions/registered_spec.rb

@@ -9,7 +9,8 @@ WRAPPERS = {
   rvm: ['0', '0.5'],
   timestamp: ['0'],
   xvfb: ['0'],
-  prebuild_cleanup: ['0']
+  prebuild_cleanup: ['0'],
+  build_timeout: ['0']
 }.freeze
 
 PUBLISHERS = {
@@ -41,7 +42,7 @@ BUILDERS = {
   copy_artifact: ['0'],
   inject_vars_file: ['0'],
   maven3: ['0'],
-  multi_job: ['0'],
+  multi_job: ['0', '1.27'],
   remote_job: ['0'],
   shell_command: ['0'],
   checkmarx_scan: ['0'],

data/spec/lib/jenkins_pipeline_builder/extensions/wrappers_spec.rb

@@ -129,4 +129,115 @@ describe 'wrappers' do
       expect(node.first).to_not be_nil
     end
   end
+
+  context 'build_timeout' do
+    before :each do
+      JenkinsPipelineBuilder.registry.registry[:job][:wrappers][:build_timeout].installed_version = '0.0'
+    end
+
+    it 'generates the correct tags and values for the Absolute strategy' do
+      params = { wrappers: { build_timeout: {
+        timeout_strategy: 'Absolute',
+        timeout_minutes: '5'
+      } } }
+      JenkinsPipelineBuilder.registry.traverse_registry_path('job', params, @n_xml)
+
+      node = @n_xml.root.xpath('//buildWrappers/hudson.plugins.build__timeout.BuildTimeoutWrapper/strategy')
+      expect(node.to_s).to include('AbsoluteTimeOutStrategy')
+      expect(node.xpath('timeoutMinutes').first).to_not be_nil
+      expect(node.xpath('timeoutMinutes').first.content).to match('5')
+    end
+
+    it 'generates the correct tags and values for the Deadline strategy' do
+      params = { wrappers: { build_timeout: {
+        timeout_strategy: 'Deadline',
+        deadline_time: '12:05:12',
+        deadline_tolerance: '10'
+      } } }
+      JenkinsPipelineBuilder.registry.traverse_registry_path('job', params, @n_xml)
+
+      node = @n_xml.root.xpath('//buildWrappers/hudson.plugins.build__timeout.BuildTimeoutWrapper/strategy')
+      expect(node.to_s).to include('DeadlineTimeOutStrategy')
+      expect(node.xpath('deadlineTime').first).to_not be_nil
+      expect(node.xpath('deadlineToleranceInMinutes').first).to_not be_nil
+      expect(node.xpath('deadlineTime').first.content).to match('12:05:12')
+      expect(node.xpath('deadlineToleranceInMinutes').first.content).to match('10')
+    end
+
+    it 'generates the correct tags and values for the Elastic strategy' do
+      params = { wrappers: { build_timeout: {
+        timeout_strategy: 'Elastic',
+        timeout_percentage: '150',
+        number_of_builds: '5',
+        fail_safe_timeout: 'true',
+        timeout_minutes: '60'
+      } } }
+      JenkinsPipelineBuilder.registry.traverse_registry_path('job', params, @n_xml)
+
+      node = @n_xml.root.xpath('//buildWrappers/hudson.plugins.build__timeout.BuildTimeoutWrapper/strategy')
+      expect(node.to_s).to include('ElasticTimeOutStrategy')
+      expect(node.xpath('timeoutPercentage').first).to_not be_nil
+      expect(node.xpath('numberOfBuilds').first).to_not be_nil
+      expect(node.xpath('failSafeTimeoutDuration').first).to_not be_nil
+      expect(node.xpath('timeoutMinutesElasticDefault').first).to_not be_nil
+      expect(node.xpath('timeoutPercentage').first.content).to match('150')
+      expect(node.xpath('numberOfBuilds').first.content).to match('5')
+      expect(node.xpath('failSafeTimeoutDuration').first.content).to match('true')
+      expect(node.xpath('timeoutMinutesElasticDefault').first.content).to match('60')
+    end
+
+    it 'generates the Likely stuck strategy' do
+      params = { wrappers: { build_timeout: { timeout_strategy: 'Likely stuck' } } }
+      JenkinsPipelineBuilder.registry.traverse_registry_path('job', params, @n_xml)
+
+      node = @n_xml.root.xpath('//buildWrappers/hudson.plugins.build__timeout.BuildTimeoutWrapper/strategy')
+      expect(node.to_s).to include('LikelyStuckTimeOutStrategy')
+    end
+
+    it 'generates the correct tags for the No Activity strategy' do
+      params = { wrappers: { build_timeout: {
+        timeout_strategy: 'No Activity',
+        timeout_seconds: '180'
+      } } }
+      JenkinsPipelineBuilder.registry.traverse_registry_path('job', params, @n_xml)
+
+      node = @n_xml.root.xpath('//buildWrappers/hudson.plugins.build__timeout.BuildTimeoutWrapper/strategy')
+      expect(node.to_s).to include('NoActivityTimeOutStrategy')
+      expect(node.xpath('timeoutSecondsString').first).to_not be_nil
+      expect(node.xpath('timeoutSecondsString').first.content).to match('180')
+    end
+
+    it 'generates the correct tags and values for Time-out variable' do
+      params = { wrappers: { build_timeout: { timeout_env_var: '55' } } }
+      JenkinsPipelineBuilder.registry.traverse_registry_path('job', params, @n_xml)
+
+      node = @n_xml.root.xpath('//buildWrappers/hudson.plugins.build__timeout.BuildTimeoutWrapper/timeoutEnvVar')
+      expect(node.first).to_not be_nil
+    end
+
+    it 'generates the correct tag for the Abort the build action' do
+      params = { wrappers: { build_timeout: { operation: 'Abort' } } }
+      JenkinsPipelineBuilder.registry.traverse_registry_path('job', params, @n_xml)
+
+      node = @n_xml.root.xpath('//buildWrappers/hudson.plugins.build__timeout.BuildTimeoutWrapper/operationList')
+      expect(node.xpath('hudson.plugins.build__timeout.operations.AbortOperation').first).to_not be_nil
+    end
+
+    it 'generates the correct tag for the Fail the build action' do
+      params = { wrappers: { build_timeout: { operation: 'Fail' } } }
+      JenkinsPipelineBuilder.registry.traverse_registry_path('job', params, @n_xml)
+
+      node = @n_xml.root.xpath('//buildWrappers/hudson.plugins.build__timeout.BuildTimeoutWrapper/operationList')
+      expect(node.xpath('hudson.plugins.build__timeout.operations.FailOperation').first).to_not be_nil
+    end
+
+    it 'generates the correct tags for the Writing the build description actions' do
+      params = { wrappers: { build_timeout: { operation: 'Writing' } } }
+      JenkinsPipelineBuilder.registry.traverse_registry_path('job', params, @n_xml)
+      str = 'hudson.plugins.build__timeout.operations.WriteDescriptionOperation'
+      node = @n_xml.root.xpath('//buildWrappers/hudson.plugins.build__timeout.BuildTimeoutWrapper/operationList')
+      expect(node.xpath(str).first).to_not be_nil
+      expect(node.xpath("#{str}/description").first).to_not be_nil
+    end
+  end
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: jenkins_pipeline_builder
 version: !ruby/object:Gem::Version
-  version: 1.3.0
+  version: 1.4.0
 platform: ruby
 authors:
 - Igor Moochnick
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2017-08-24 00:00:00.000000000 Z
+date: 2017-09-01 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: nokogiri