jenkins_pipeline_builder 0.15.4 → 0.16.0

checksums.yaml

@@ -1,15 +1,7 @@
 ---
-!binary "U0hBMQ==":
-  metadata.gz: !binary |-
-    ZjNiOGM2YmE3ZWUwNWU3NWIzMDA3NWQ3NjViZWYxNmQ5M2I1NzU5MQ==
-  data.tar.gz: !binary |-
-    Yzc4NmM2NjllNzIyMzVlNWNlZjViMjFhZmYwMzJkYWU0Y2M2ZmJiNw==
+SHA1:
+  metadata.gz: 2435d7d3bfbce44945a8ac65b3a2e974447659aa
+  data.tar.gz: 91f22ff5ea5254f056d3ebbd2966b2ddb1a968d2
 SHA512:
-  metadata.gz: !binary |-
-    OWFiYTMxYWFjNjQ4Zjc4MTU3OWU5OTJhNWUxOTJkMTRkM2Y1ZjA3ZDBjZWU2
-    MzllZDExOGQ5MGU1YjhhMjFmMmVlMTEyYmE4M2YzZjEzMDYyMjg1NWU4OTJi
-    Y2UzYTdmNjkxMzZlYzA4MmU4YzM1YzZhMjhlY2NiYzRlZTE5NGU=
-  data.tar.gz: !binary |-
-    ODVkNDhlNjdjY2M3YzkyMGNlMzBiM2VmYzhjMjE3MzMxZDFiZjY1MTEyMTk4
-    MmMxMjZkMzlmOTE4YzNiYTA0ZDU5MmZiNDAwNDc2ODY3MDM1ZTJjYmQ2MWY3
-    YjI5NTA4OWRhZjIxZmU3ZGNjYmZkZDZjNTZmNGY0ZTE4M2JmN2I=
+  metadata.gz: e3eaad5a500bbe56cfd70dac4d56ee3834d041e935b984386432b0d84e7eacc2db8541348f79d19e083a0e412089232d36cc5400d7f646e00a6eda8cbfb90936
+  data.tar.gz: 8b55b43d229e060aca4165941242acdbaca512ad3b645314c76a13ac780496ee65312952fcf2aab456fbe46cfb4def734f41eed798efe7fc6bba4e5c30e56acb

data/example/pipeline/Example-Pipeline.yaml

@@ -3,25 +3,25 @@
     description: 'Pipeline'
     job_type: multi_project
     wrappers:
-        - timestamp: true
-        - ansicolor: true
-        - rvm: '{{rvm}}'
+      - timestamp: true
+      - ansicolor: true
+      - rvm: '{{rvm}}'
     builders:
-        - multi_job:
-            phases:
-                Commit:
-                    jobs:
-                        - name: '{{name}}-Commit'
-                    continue_condition: SUCCESSFUL
-                Acceptance:
-                    jobs:
-                        - name: '{{name}}-Acceptance'
-                    continue_condiction: SUCCESSFUL
-                Upgrade:
-                    jobs:
-                        - name: '{{name}}-Upgrade'
-                    continue_condiction: SUCCESSFUL
-                Release:
-                    jobs:
-                        - name: '{{name}}-Release'
-                    continue_condiction: SUCCESSFUL
+      - multi_job:
+          phases:
+            Commit:
+              jobs:
+                - name: '{{name}}-Commit'
+              continue_condition: SUCCESSFUL
+            Acceptance:
+              jobs:
+                - name: '{{name}}-Acceptance'
+              continue_condition: SUCCESSFUL
+            Upgrade:
+              jobs:
+                - name: '{{name}}-Upgrade'
+              continue_condition: SUCCESSFUL
+            Release:
+              jobs:
+                - name: '{{name}}-Release'
+              continue_condition: SUCCESSFUL

data/example/pipeline/Example-Promotion.yaml

@@ -0,0 +1,32 @@
+- promotion:
+    name: '01. Stage Promotion'
+    promotion_description: 'Describe the promotion process in play'
+    job_type: promotion
+    block_when_downstream_building: false # unless defined? false
+    block_when_upstream_building: false # unless defined? false
+    promotion_icon: 'silver' # defaults to gold, silver white blue green orange purple red
+    promotion_conditions: # follow parameters
+      - manual:
+          users: 'authenticated' # || ''
+      - self_promotion:
+          even_if_unstable: true # unless defined? false
+      - parameterized_self_promotion:
+          parameter_name: 'SOME_ENV_VAR'
+          parameter_value: true
+          even_if_unstable: true # unless defined? false
+      - downstream_pass:
+          jobs: '{{name}}-Commit'
+          even_if_unstable: true # unless defined? false
+      - upstream_promotion:
+          promotion_name: '01. Staging Promotion'
+    build_steps: # follow builders
+      - triggered_job:
+          name: '{{name}}-Release' # maps to <projects>
+          block_condition: # included in xml only if checked on UI
+            build_step_failure_threshold: 'FAILURE' # 'FAILURE' # %s(never FAILURE UNSTABLE SUCCESS)
+            failure_threshold: 'FAILURE' # || # %s(never FAILURE UNSTABLE SUCCESS)
+            unstable_threshold: 'UNSTABLE' # || # %s(never FAILURE UNSTABLE SUCCESS)
+          build_parameters:
+            current: true # unless defined? false
+      - keep_builds_forever:
+          value: true

data/example/pipeline/Example-Release.yaml

@@ -7,6 +7,8 @@
         local_branch: '{{git_branch}}'
         recursive_update: true
         wipe_workspace: true
+    promoted_builds:
+      - '01. Stage Promotion'
     builders:
         - shell_command: |
             sleep 60

data/example/pipeline/project.yaml

@@ -24,3 +24,5 @@
         - '{{name}}-Acceptance' # from template (see dependencies section)
         - '{{name}}-Upgrade'
         - '{{name}}-Release'
+    promotions:
+        - '01. Stage Promotion'

data/jenkins_pipeline_builder.gemspec

@@ -40,6 +40,7 @@ automating Job & Pipeline creation from the YAML files checked-in with your appl
   spec.add_development_dependency 'equivalent-xml'
   spec.add_development_dependency 'yard-thor'
   spec.add_development_dependency 'yard'
+  spec.add_development_dependency 'pry'
   spec.add_development_dependency 'rspec_junit_formatter'
   spec.add_development_dependency 'webmock', '~> 1.0'
   spec.add_development_dependency 'rubocop', '= 0.40.0'

data/lib/jenkins_pipeline_builder.rb

@@ -25,12 +25,14 @@ require 'active_support/core_ext'
 
 require 'jenkins_pipeline_builder/version'
 require 'jenkins_pipeline_builder/utils'
+require 'jenkins_pipeline_builder/custom_errors'
 require 'jenkins_pipeline_builder/compiler'
 require 'jenkins_pipeline_builder/module_registry'
 require 'jenkins_pipeline_builder/pull_request_generator'
 require 'jenkins_pipeline_builder/view'
 require 'jenkins_pipeline_builder/job_collection'
 require 'jenkins_pipeline_builder/job'
+require 'jenkins_pipeline_builder/promotion'
 require 'jenkins_pipeline_builder/remote_dependencies'
 require 'jenkins_pipeline_builder/generator'
 
@@ -75,6 +77,7 @@ module JenkinsPipelineBuilder
     end
   end
 end
+
 JenkinsPipelineBuilder.generator
 require 'jenkins_pipeline_builder/extensions'
 require 'jenkins_pipeline_builder/extension_dsl'
@@ -89,6 +92,8 @@ require 'jenkins_pipeline_builder/extensions/job_attributes'
 require 'jenkins_pipeline_builder/extensions/wrappers'
 require 'jenkins_pipeline_builder/extensions/publishers'
 require 'jenkins_pipeline_builder/extensions/triggers'
+require 'jenkins_pipeline_builder/extensions/build_steps'
+require 'jenkins_pipeline_builder/extensions/promotion_conditions'
 
 require 'jenkins_pipeline_builder/cli/helper'
 require 'jenkins_pipeline_builder/cli/view'

data/lib/jenkins_pipeline_builder/cli/describe.rb

@@ -24,7 +24,7 @@ module JenkinsPipelineBuilder
   module CLI
     entries = JenkinsPipelineBuilder.registry.entries.keys
     entries << :job_attributes
-    entries.each do |entry|
+    entries.try(:each) do |entry|
       klass_name = entry.to_s.classify
       # rubocop:disable Style/AccessModifierIndentation
       klass = Class.new(Thor) do
@@ -34,7 +34,7 @@ module JenkinsPipelineBuilder
                        JenkinsPipelineBuilder.registry.registry[:job][entry]
                      end
 
-        extensions.each do |key, extset|
+        extensions.try(:each) do |key, extset|
           # TODO: don't just take the first
           ext = extset.extensions.first
           desc key, "Details for #{ext.name}"
@@ -52,10 +52,12 @@ module JenkinsPipelineBuilder
       # rubocop:enable Style/AccessModifierIndentation
       Module.const_set(klass_name, klass)
     end
+
     class Describe < Thor
       entries = JenkinsPipelineBuilder.registry.entries.keys
       entries << :job_attributes
-      entries.each do |entry, _path|
+
+      entries.try(:each) do |entry, _path|
         klass_name = entry.to_s.classify
         singular_model = entry.to_s.singularize
 

data/lib/jenkins_pipeline_builder/custom_errors.rb

@@ -0,0 +1,20 @@
+module CustomErrors
+  class ParseError < StandardError
+    def initialize(msg, path = nil)
+      super(format_msg(msg, path).squeeze(' '))
+    end
+
+    private
+
+    def format_msg(msg, path)
+      if path.nil?
+        %(There was an error while parsing a file:
+        #{msg})
+      else
+        %(There was an error while parsing a file:
+        #{path}
+        #{msg})
+      end
+    end
+  end
+end

data/lib/jenkins_pipeline_builder/extension_dsl.rb

@@ -6,7 +6,7 @@ JenkinsPipelineBuilder.registry.entries.each do |type, path|
 
     JenkinsPipelineBuilder.registry.register([:job, type], set)
     versions = set.extensions.map(&:min_version)
-    puts "Successfully registered #{set.name} for versions #{versions}" if set.announced
+    JenkinsPipelineBuilder.logger.info "Successfully registered #{set.name} for versions #{versions}" if set.announced
     true
   end
 end
@@ -17,6 +17,6 @@ def job_attribute(&block)
 
   JenkinsPipelineBuilder.registry.register([:job], set)
   versions = set.extensions.map(&:min_version)
-  puts "Successfully registered #{set.name} for versions #{versions}" if set.announced
+  JenkinsPipelineBuilder.logger.info "Successfully registered #{set.name} for versions #{versions}" if set.announced
   true
 end

data/lib/jenkins_pipeline_builder/extension_set.rb

@@ -8,6 +8,7 @@ module JenkinsPipelineBuilder
       :announced,
       :type
     ].freeze
+
     SET_METHODS.each do |method_name|
       define_method method_name do |value = nil|
         return settings[method_name] if value.nil?
@@ -66,7 +67,8 @@ module JenkinsPipelineBuilder
       extension = versions[highest_allowed_version]
 
       unless extension
-        raise "Can't find version of #{name} lte #{installed_version}, available versions: #{versions.keys.map(&:to_s)}"
+        raise %(Can't find version of #{name} lte #{installed_version}.
+          Available versions: #{versions.keys.map(&:to_s)})
       end
       extension
     end
@@ -79,7 +81,7 @@ module JenkinsPipelineBuilder
         mismatch << "The values for #{method_name} do not match '#{val1}' : '#{val2}'" unless val1 == val2
       end
       mismatch.each do |error|
-        puts error
+        logger.error error
       end
       raise 'Values did not match, cannot merge extension sets' if mismatch.any?
 
@@ -129,8 +131,8 @@ module JenkinsPipelineBuilder
       valid = errors.empty?
       unless valid
         name ||= 'A plugin with no name provided'
-        puts "Encountered errors while registering #{name}"
-        puts errors.map { |k, v| "#{k}: #{v}" }.join(', ')
+        logger.error "Encountered errors while registering #{name}"
+        logger.error errors.map { |k, v| "#{k}: #{v}" }.join(', ')
       end
       valid
     end
@@ -154,6 +156,10 @@ module JenkinsPipelineBuilder
 
     private
 
+    def logger
+      JenkinsPipelineBuilder.logger
+    end
+
     def highest_allowed_version
       ordered_version_list.each do |version|
         return version if version <= installed_version
@@ -173,7 +179,8 @@ module JenkinsPipelineBuilder
     end
 
     def deprecation_warning(name, block)
-      puts "WARNING: #{name} set the version in the #{block} block, this is deprecated. Please use a version block."
+      logger.warn %(WARNING: #{name} set the version in the #{block} block, this is deprecated.
+      Please use a version block.)
     end
   end
 end

data/lib/jenkins_pipeline_builder/extensions.rb

@@ -36,6 +36,7 @@ module JenkinsPipelineBuilder
       xml: false,
       parameters: []
     }.freeze
+
     EXT_METHODS.keys.each do |method_name|
       define_method method_name do |value = nil|
         return instance_variable_get("@#{method_name}") if value.nil?
@@ -57,10 +58,11 @@ module JenkinsPipelineBuilder
 
     def execute(value, n_xml)
       errors = check_parameters value
-      errors.each do |error|
-        JenkinsPipelineBuilder.logger.error error
-      end
-      return false if errors.any?
+      raise ArgumentError, errors.join("\n") if errors.any?
+      raise ArgumentError, %(Extension #{name} has no valid path
+      Check ModuleRegistry#entries and the definition of the extension
+      Note: job_attributes have no implicit path and must be set in the builder
+      ).squeeze(' ') unless path
 
       n_builders = n_xml.xpath(path).first
       n_builders.instance_exec(value, &before) if before
@@ -93,7 +95,6 @@ module JenkinsPipelineBuilder
     def build_extension_xml(n_builders, value)
       Nokogiri::XML::Builder.with(n_builders) do |builder|
         include_helper value, builder
-        helper.extension = self
         builder.instance_exec helper, &xml
       end
     end
@@ -101,7 +102,7 @@ module JenkinsPipelineBuilder
     def include_helper(params, builder)
       klass = "#{name.to_s.camelize}Helper".safe_constantize
       klass ||= ExtensionHelper
-      self.helper = klass.new params, builder
+      self.helper = klass.new self, params, builder
     end
   end
 end

data/lib/jenkins_pipeline_builder/extensions/build_steps.rb

@@ -0,0 +1,93 @@
+# Technically triggered_job takes multiple jobs in the xml
+# Since Nokogiri builders don't allow modifying existing nodes this is not
+# straightforward to abstract away the underlying XML from the user.
+#
+# 1. So either we need to only accept 1 triggered job per promotion process OR
+# 2. Make it take array of triggered jobs
+#
+# Current implementation went with option 1.
+#
+# This is very similar to the implementation for :blocking_downstream, but
+# unfortunately sharing code between extensions doesn't seem to be possible
+
+build_step do
+  name :triggered_job
+  plugin_id 'parameterized-trigger'
+  parameters [
+    :name,
+    # block_condition: {  }
+    # or
+    # block_condition: _ # for the defaults
+    :block_condition,
+    # build_parameters: [
+    # [ :current, _ ],
+    # [ :predefined, {val: x, val2: y} ],
+    # [ :file, 'filpath' ] ]
+    :build_parameters
+  ]
+
+  xml do |state|
+    send('hudson.plugins.parameterizedtrigger.TriggerBuilder',
+         'plugin' => 'parameterized-trigger@2.31') do
+      configs do
+        send('hudson.plugins.parameterizedtrigger.BlockableBuildTriggerConfig') do
+          if state[:build_parameters].present? && state[:build_parameters].respond_to?(:each)
+            configs do
+              state[:build_parameters].each do |param_key, param_val|
+                case param_key
+                when /current/i, :current
+                  send('hudson.plugins.parameterizedtrigger.CurrentBuildParameters')
+
+                when /predefined/i, :predefined
+                  send('hudson.plugins.parameterizedtrigger.PredefinedBuildParameters') do
+                    properties param_val.map { |k, v| "#{k.upcase}=#{v}" }.join(' ')
+                  end
+
+                when /file/i, :file
+                  send('hudson.plugins.parameterizedtrigger.FileBuildParameters') do
+                    propertiesFile param_val
+                    failTriggerOnMissing false
+                    useMatrixChild false
+                    onlyExactRuns false
+                  end
+                end
+              end
+            end
+          else
+            configs(class: 'empty-list') {}
+          end
+
+          projects state[:name]
+          condition 'ALWAYS'
+          triggerWithNoParameters false
+
+          block do
+            buildStepFailureThreshold do
+              state.generate_for_threshold(self,
+                                           state.resolve_block_condition(:build_step_failure_threshold) || :failure)
+            end
+            unstableThreshold do
+              state.generate_for_threshold(self,
+                                           state.resolve_block_condition(:unstable_threshold) || :unstable)
+            end
+            failureThreshold do
+              state.generate_for_threshold(self,
+                                           state.resolve_block_condition(:failure_threshold) || :failure)
+            end
+          end if state.block_condition?
+
+          buildAllNodesWithLabel false
+        end
+      end
+    end
+  end
+end
+
+build_step do
+  name :keep_builds_forever
+  plugin_id 'promoted-builds'
+
+  xml do
+    send('hudson.plugins.promoted__builds.KeepBuildForeverAction')
+  end
+end

data/lib/jenkins_pipeline_builder/extensions/helpers/build_steps/triggered_job.rb

@@ -0,0 +1,36 @@
+class TriggeredJobHelper < ExtensionHelper
+  # @param xml_builder [Nokogiri::Builder] this will be self inside an extension
+  # @param threshold_type [String, Symbol] case-insensitive string or symbol
+  #  from the %(failure unstable success)
+  # @returns [Nokogiri::Builder] continues the mutation of the passed in builder
+  def generate_for_threshold(xml_builder, threshold_type)
+    case threshold_type
+    when /failure/i, :failure
+      generate_threshold_xml({ name: 'FAILURE', ordinal: 2, color: 'RED' }, xml_builder)
+    when /unstable/i, :unstable
+      generate_threshold_xml({ name: 'UNSTABLE', ordinal: 1, color: 'YELLOW' }, xml_builder)
+    when /success/i, :success
+      generate_threshold_xml({ name: 'SUCCESS', ordinal: 0, color: 'BLUE' }, xml_builder)
+    else
+      raise ArgumentError("Input should be one of the following either as a case insensitive string or symbol: \n
+                          'failure', 'unstable', 'success'")
+    end
+  end
+
+  def resolve_block_condition(key)
+    try(:block_condition).try([], key)
+  end
+
+  def block_condition?
+    respond_to?(:block_condition) && block_condition != false
+  end
+
+  private
+
+  def generate_threshold_xml(data, xml)
+    xml.send(:name, data[:name])
+    xml.send(:ordinal, data[:ordinal])
+    xml.send(:color, data[:color])
+    xml.send(:completeBuild, 'true')
+  end
+end