jenkins_pipeline_builder 0.10.16 → 0.11.0

checksums.yaml

@@ -1,15 +1,15 @@
 ---
 !binary "U0hBMQ==":
   metadata.gz: !binary |-
-    MGExN2ExOTMzNjdkYzNlMTE2NzQ3Y2QyNjA1ODQ1MjEzNDllZjhmNw==
+    MWM3M2NlYzkyODVkOTJiMDcxNjgyY2U4MDFhZWRkNDkyMDViNGFmZg==
   data.tar.gz: !binary |-
-    ZDUzNmFkYTUxNjViYTcwZDAxYzBlYTEzZTAyZDIyNTE1MjFjNmVmOQ==
+    MGQ1MDM2NDQ4OGJjMWExNzRiZGI1ZDEwMzAwODcxNDFkMjAyYTE0Yw==
 SHA512:
   metadata.gz: !binary |-
-    MmI3YzUzODJjYjIwZjkzNjI4ZjRmMzEwOGU2NDdhNjZjMGI4M2M4MzI3YmQ5
-    OWExYWZlYjNlYTJiMTRhYTY4MjQyNzZlOTZkN2JiYjg1NjE5YzIzYjYxYTRi
-    YTk1NzM2MTA0MzMwYzJiYzljYWFmNzU0ZjM3YjM1M2E1ZDViNTU=
+    YTQ2ZjU1YzkwOWNlN2RjNTJjNzhhZGEwNmZmNTI5ZWU5ZjE5MzgwN2YzNjAx
+    NDIyNzJhMTI2ODkwMDhhOGE2NGNlYTc4OTgxYmZiODZjZjk3NmRhYTNiMWJh
+    YTRjMTQxMGYyM2U4YTM0N2JmMTg3NGMzMWI4NzdmY2I3ZmVlNWQ=
   data.tar.gz: !binary |-
-    MWQ2YzA5YjdmYmNkODgyOWMwZjRmZGY5NWU5MzEyMmU3ZjcwMTFjNjEzZjUy
-    MWU1OWEzY2YzYTQ0MjlkYzUwMTMwNDA4YzEyYzAxOGIzMDQ5ZGU1MTA5N2Fl
-    MTJjMGNhMTlkZDU0NzljZmRiY2ZlY2Q5ZjEwNzgyMzQxNmY2NGQ=
+    ZDE3OGY2ZDU3N2VjOTExN2MzNDYyZjEyYjU2MmZmM2I3ZmFkY2QxYzY4OGIw
+    YzY0NDZjZTczNWMzMGQ5NWFiYzY0N2Q4ZjUxYTMwYzY3ZTZjY2U4N2M2ZjNl
+    YmNiNjk2OTI4YmViODEyNWMxMzYxYTIzZjU3Y2I1YWQxMGU1MWE=

data/.rubocop.yml

@@ -5,7 +5,7 @@ Metrics/CyclomaticComplexity:
 Metrics/PerceivedComplexity:
   Max: 11
 Metrics/MethodLength:
-  Max: 30
+  Max: 20
 Metrics/ClassLength:
   Max: 175
 
@@ -19,7 +19,7 @@ Metrics/LineLength:
     - 'spec/lib/jenkins_pipeline_builder/view_spec.rb'
     - 'spec/lib/jenkins_pipeline_builder/pull_request_spec.rb'
     - 'spec/lib/jenkins_pipeline_builder/pull_request_generator_spec.rb'
-    - 'lib/jenkins_pipeline_builder/extensions/*'
+    - 'lib/jenkins_pipeline_builder/extensions/**/*'
 
 Style/Documentation:
   Enabled: false
@@ -27,12 +27,12 @@ Style/Documentation:
 # Configuration parameters: EnforcedStyle, SupportedStyles.
 Style/Next:
   Exclude:
-    - 'lib/jenkins_pipeline_builder/extensions/*'
+    - 'lib/jenkins_pipeline_builder/extensions/**/*'
 
 # Configuration parameters: EnforcedStyle, SupportedStyles.
 Style/VariableName:
   Exclude:
-    - 'lib/jenkins_pipeline_builder/extensions/*'
+    - 'lib/jenkins_pipeline_builder/extensions/**/*'
 
 Style/SymbolProc:
   IgnoredMethods: new

data/lib/jenkins_pipeline_builder.rb

@@ -80,6 +80,11 @@ JenkinsPipelineBuilder.generator
 require 'jenkins_pipeline_builder/extensions'
 require 'jenkins_pipeline_builder/extension_dsl'
 require 'jenkins_pipeline_builder/extension_set'
+require 'jenkins_pipeline_builder/extensions/helpers/extension_helper'
+Dir[File.join(File.dirname(__FILE__), 'jenkins_pipeline_builder/extensions/helpers/**/*.rb')].each do |file|
+  require file
+end
+
 require 'jenkins_pipeline_builder/extensions/builders'
 require 'jenkins_pipeline_builder/extensions/job_attributes'
 require 'jenkins_pipeline_builder/extensions/wrappers'

data/lib/jenkins_pipeline_builder/compiler.rb

@@ -88,29 +88,26 @@ module JenkinsPipelineBuilder
       [true, new_value]
     end
 
-    def compile_array(item, settings)
+    def compile_array(array, settings)
       errors = {}
       result = []
-      item.each do |value|
-        if value.nil?
-          errors[item] = "found a nil value when processing following array:\n #{item.inspect}"
-          break
-        end
-        success, payload = compile(value, settings)
-        unless success
-          errors.merge!(payload)
-          next
-        end
-        if payload.nil?
-          errors[value] = "Failed to resolve:\n===>item #{value}\n\n===>of list: #{item}"
-          next
-        end
+      array.each do |value|
+        success, payload = compile_array_item value, settings, array
+        errors[value] =  payload unless success
         result << payload
       end
       return false, errors unless errors.empty?
       [true, result]
     end
 
+    def compile_array_item(item, settings, array)
+      success, payload = compile(item, settings)
+      return false, "found a nil value when processing following array:\n #{array.inspect}" if item.nil?
+      return false, payload unless success
+      return false, "Failed to resolve:\n===>item #{item}\n\n===>of list: #{array.inspect}" if payload.nil?
+      [true, payload]
+    end
+
     def compile_item(key, value, errors, settings)
       if value.nil?
         errors[key] = "key: #{key} has a nil value, this is often a yaml syntax error. Skipping children and siblings"
@@ -155,16 +152,12 @@ module JenkinsPipelineBuilder
 
       settings = settings.with_indifferent_access
       value_s = value.to_s.clone
-      # First we try to do job name correction
-      vars = value_s.scan(/{{job@(.*)}}/).flatten
-      if vars.count > 0
-        vars.select! do |var|
-          var_val = job_collection[var.to_s]
-          value_s.gsub!("{{job@#{var}}}", var_val[:value][:name]) unless var_val.nil?
-          var_val.nil?
-        end
-      end
+      correct_job_names! value_s
       # Then we look for normal values to replace
+      # TODO: This needs to be pulled out into a 'replace_values' method
+      # However, there is not testing around if we can't replace everything
+      # (the return nil line can be removed and we are still green)
+      # Also, this should *not* be calling gsub! inside a select
       vars = value_s.scan(/{{([^{}@]+)}}/).flatten
       vars.select! do |var|
         var_val = settings[var]
@@ -174,5 +167,15 @@ module JenkinsPipelineBuilder
       return nil if vars.count != 0
       value_s
     end
+
+    def correct_job_names!(value)
+      vars = value.scan(/{{job@(.*)}}/).flatten
+      return unless vars.count > 0
+      vars.select! do |var|
+        var_val = job_collection[var.to_s]
+        value.gsub!("{{job@#{var}}}", var_val[:value][:name]) unless var_val.nil?
+        var_val.nil?
+      end
+    end
   end
 end

data/lib/jenkins_pipeline_builder/extension_dsl.rb

@@ -18,4 +18,5 @@ 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
+  true
 end

data/lib/jenkins_pipeline_builder/extension_set.rb

@@ -34,7 +34,7 @@ module JenkinsPipelineBuilder
     end
 
     def installed_version=(version)
-      version = version.match(/\d+\.\d+/)
+      version = version.match(/\d+\.\d+(\.\d+)?/)
       @version = Gem::Version.new version
     end
 
@@ -83,7 +83,7 @@ module JenkinsPipelineBuilder
       end
       fail 'Values did not match, cannot merge extension sets' if mismatch.any?
 
-      blocks.merge other_set.blocks
+      self.extensions = versions.merge(other_set.versions).values
     end
 
     def parameters(params)
@@ -145,6 +145,12 @@ module JenkinsPipelineBuilder
       errors
     end
 
+    def versions
+      @versions ||= extensions.each_with_object({}) do |ext, hash|
+        hash[Gem::Version.new(ext.min_version)] = ext
+      end
+    end
+
     private
 
     def highest_allowed_version
@@ -161,12 +167,6 @@ module JenkinsPipelineBuilder
       end
     end
 
-    def versions
-      @versions ||= extensions.each_with_object({}) do |ext, hash|
-        hash[Gem::Version.new(ext.min_version)] = ext
-      end
-    end
-
     def ordered_version_list
       versions.keys.sort.reverse
     end

data/lib/jenkins_pipeline_builder/extensions.rb

@@ -19,31 +19,9 @@
 # OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
 # THE SOFTWARE.
 
-require 'jenkins_pipeline_builder'
-JenkinsPipelineBuilder.registry.entries.each do |type, path|
-  singular_type = type.to_s.singularize
-  define_method singular_type do |&block|
-    set = JenkinsPipelineBuilder::ExtensionSet.new singular_type, path, &block
-    return false unless set.valid?
-
-    JenkinsPipelineBuilder.registry.register([:job, type], set)
-    versions = set.extensions.map(&:min_version)
-    puts "Successfully registered #{set.name} for versions #{versions}" if set.announced
-    true
-  end
-end
-
-def job_attribute(&block)
-  set = JenkinsPipelineBuilder::ExtensionSet.new :job_attribute, &block
-  return false unless set.valid?
-
-  JenkinsPipelineBuilder.registry.register([:job], set)
-  versions = set.extensions.map(&:min_version)
-  puts "Successfully registered #{set.name} for versions #{versions}" if set.announced
-end
-
 module JenkinsPipelineBuilder
   class Extension
+    attr_accessor :helper
     EXT_METHODS = {
       name: false,
       plugin_id: false,
@@ -88,7 +66,9 @@ module JenkinsPipelineBuilder
       n_builders = n_xml.xpath(path).first
       n_builders.instance_exec(value, &before) if before
       Nokogiri::XML::Builder.with(n_builders) do |builder|
-        builder.instance_exec value, &xml
+        include_helper value, builder
+        helper.extension = self
+        builder.instance_exec helper, &xml
       end
       n_builders.instance_exec(value, &after) if after
       true
@@ -110,5 +90,13 @@ module JenkinsPipelineBuilder
       end
       errors
     end
+
+    private
+
+    def include_helper(params, builder)
+      klass = "#{name.to_s.camelize}Helper".safe_constantize
+      klass ||= ExtensionHelper
+      self.helper = klass.new params, builder
+    end
   end
 end

data/lib/jenkins_pipeline_builder/extensions/builders.rb

@@ -67,13 +67,19 @@ builder do
   description 'Jenkins plugin for building Maven 2/3 jobs via a special project type.'
   jenkins_name 'Invoke Maven 3'
   announced false
+  parameters [
+    :mavenName,
+    :rootPom,
+    :goals,
+    :options
+  ]
 
-  xml do |params|
+  xml do |helper|
     send('org.jfrog.hudson.maven3.Maven3Builder') do
-      mavenName params[:mavenName] || 'tools-maven-3.0.3'
-      rootPom params[:rootPom]
-      goals params[:goals]
-      mavenOpts params[:options]
+      mavenName helper.mavenName
+      rootPom helper.rootPom
+      goals helper.goals
+      mavenOpts helper.options
     end
   end
 end
@@ -114,19 +120,22 @@ builder do
   description 'This plugin lets you trigger new builds when your build has completed, with various ways of specifying parameters for the new build.'
   jenkins_name 'Trigger/call builds on other projects'
   announced false
+  parameters [
+    :data,
+    :project,
+    :trigger_with_no_parameters,
+    :fail,
+    :mark_fail,
+    :mark_unstable
+  ]
 
-  xml do |params|
-    colors = {
-      'SUCCESS' => { ordinal:  0, color:  'BLUE' },
-      'FAILURE' => { ordinal:  2, color:  'RED' },
-      'UNSTABLE' => { ordinal:  1, color:  'YELLOW' }
-    }
+  xml do |helper|
     send('hudson.plugins.parameterizedtrigger.TriggerBuilder', 'plugin' => 'parameterized-trigger') do
       configs do
         send('hudson.plugins.parameterizedtrigger.BlockableBuildTriggerConfig') do
           configs do
-            params[:data] = [{ params: '' }] unless params[:data]
-            params[:data].each do |config|
+            helper.data
+            helper.data.each do |config|
               if config[:params]
                 send('hudson.plugins.parameterizedtrigger.PredefinedBuildParameters') do
                   properties config[:params]
@@ -140,31 +149,31 @@ builder do
               end
             end
           end
-          projects params[:project]
+          projects helper[:project]
           condition 'ALWAYS'
-          triggerWithNoParameters params[:trigger_with_no_parameters] || false
+          triggerWithNoParameters helper.trigger_with_no_parameters
           block do
-            if params[:fail] && colors.include?(params[:fail])
+            if helper.fail && helper.colors.include?(helper.fail)
               buildStepFailureThreshold do
-                name params[:fail]
-                ordinal colors[params[:fail]][:ordinal]
-                color colors[params[:fail]][:color]
+                name helper.fail
+                ordinal helper.colors[helper.fail][:ordinal]
+                color helper.colors[helper.fail][:color]
                 completeBuild 'true'
               end
             end
-            if params[:mark_fail] && colors.include?(params[:mark_fail])
+            if helper.mark_fail && helper.colors.include?(helper.mark_fail)
               failureThreshold do
-                name params[:mark_fail]
-                ordinal colors[params[:mark_fail]][:ordinal]
-                color colors[params[:mark_fail]][:color]
+                name helper.mark_fail
+                ordinal helper.colors[helper.mark_fail][:ordinal]
+                color helper.colors[helper.mark_fail][:color]
                 completeBuild 'true'
               end
             end
-            if params[:mark_unstable] && colors.include?(params[:mark_unstable])
+            if helper.mark_unstable && helper.colors.include?(helper.mark_unstable)
               unstableThreshold do
-                name params[:mark_unstable]
-                ordinal colors[params[:mark_unstable]][:ordinal]
-                color colors[params[:mark_unstable]][:color]
+                name helper.mark_unstable
+                ordinal helper.colors[helper.mark_unstable][:ordinal]
+                color helper.colors[helper.mark_unstable][:color]
                 completeBuild 'true'
               end
             end

data/lib/jenkins_pipeline_builder/extensions/helpers/builders/blocking_downstream_helper.rb

@@ -0,0 +1,18 @@
+class BlockingDownstreamHelper < ExtensionHelper
+  attr_reader :colors
+  def initialize(params, builder)
+    super params, builder, defaults
+    @colors = {
+      'SUCCESS' => { ordinal:  0, color:  'BLUE' },
+      'FAILURE' => { ordinal:  2, color:  'RED' },
+      'UNSTABLE' => { ordinal:  1, color:  'YELLOW' }
+    }
+  end
+
+  def defaults
+    {
+      data: [{ params: '' }],
+      trigger_with_no_parameters: false
+    }
+  end
+end

data/lib/jenkins_pipeline_builder/extensions/helpers/builders/maven3_helper.rb

@@ -0,0 +1,11 @@
+class Maven3Helper < ExtensionHelper
+  def initialize(params, builder)
+    super params, builder, defaults
+  end
+
+  def defaults
+    {
+      mavenName: 'tools-maven-3.0.3'
+    }
+  end
+end

data/lib/jenkins_pipeline_builder/extensions/helpers/extension_helper.rb

@@ -0,0 +1,26 @@
+class ExtensionHelper < SimpleDelegator
+  attr_reader :params, :builder
+  attr_accessor :extension
+  def initialize(params, builder, defaults = {})
+    # TODO: We should allow for default values to be passed in here
+    # That will allow for defaults to be pulled out of the extension and it
+    # will also let better enable overriding of those values that do not have
+    # an option to do so currently.
+    if params.is_a? Hash
+      @params = defaults.merge params
+    else
+      @params = params
+    end
+    @builder = builder
+    super @params
+  end
+
+  def method_missing(name, *args, &block)
+    return super unless extension.parameters.include? name
+    self[name]
+  end
+
+  # TODO: Method missing that pulls out of params?
+  # That would allow everything to just call helper.foo
+  # and then the helper can do any fiddling it needs to (or not)
+end

data/lib/jenkins_pipeline_builder/extensions/helpers/job_attributes/parameters_helper.rb

@@ -0,0 +1,18 @@
+class ParametersHelper < ExtensionHelper
+  def param_type(param)
+    case param[:type]
+    when 'string'
+      'hudson.model.StringParameterDefinition'
+    when 'bool'
+      'hudson.model.BooleanParameterDefinition'
+    when 'text'
+      'hudson.model.TextParameterDefinition'
+    when 'password'
+      'hudson.model.PasswordParameterDefinition'
+    when 'choice'
+      'hudson.model.ChoiceParameterDefinition'
+    else
+      'hudson.model.StringParameterDefinition'
+    end
+  end
+end

data/lib/jenkins_pipeline_builder/extensions/helpers/publishers/cobertura_report_helper.rb

@@ -0,0 +1,40 @@
+class CoberturaReportHelper < ExtensionHelper
+  def thresholds
+    @thresholds ||= params[:metric_targets]
+    return @thresholds if @thresholds
+    @thresholds = {
+      failing: [
+        { type: 'type', value: 0 },
+        { type: 'line', value: 0 },
+        { type: 'conditional', value: 0 }
+      ],
+      unhealthy: [
+        { type: 'type', value: 0 },
+        { type: 'line', value: 0 },
+        { type: 'conditional', value: 0 }
+      ],
+      healthy: [
+        { type: 'type', value: 80 },
+        { type: 'line', value: 80 },
+        { type: 'conditional', value: 70 }
+      ]
+    }
+  end
+
+  def send_metric_targets(target)
+    name = "#{target}Target"
+
+    builder.instance_exec self do |helper|
+      send name do
+        targets 'class' => 'enum-map', 'enum-type' => 'hudson.plugins.cobertura.targets.CoverageMetric' do
+          helper.thresholds[target].each do |threshold|
+            entry do
+              send('hudson.plugins.cobertura.targets.CoverageMetric') { text threshold[:type].upcase }
+              send('int') { text(threshold[:value] * 100_000).to_i }
+            end
+          end
+        end
+      end
+    end
+  end
+end