jenkins_pipeline_builder 0.15.4 → 0.16.0

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

@@ -1,7 +1,7 @@
 class BlockingDownstreamHelper < ExtensionHelper
   attr_reader :colors
-  def initialize(params, builder)
-    super params, builder, defaults
+  def initialize(extension, params, builder)
+    super extension, params, builder, defaults
     @colors = {
       'SUCCESS' => { ordinal:  0, color:  'BLUE' },
       'FAILURE' => { ordinal:  2, color:  'RED' },

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

@@ -1,6 +1,6 @@
 class Maven3Helper < ExtensionHelper
-  def initialize(params, builder)
-    super params, builder, defaults
+  def initialize(extension, params, builder)
+    super extension, params, builder, defaults
   end
 
   def defaults

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

@@ -1,7 +1,6 @@
 class ExtensionHelper < SimpleDelegator
   attr_reader :params, :builder
-  attr_accessor :extension
-  def initialize(params, builder, defaults = {})
+  def initialize(extension, 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
@@ -12,12 +11,13 @@ class ExtensionHelper < SimpleDelegator
                 params
               end
     @builder = builder
-    super @params
-  end
+    @extension = extension
 
-  def method_missing(name, *args, &block)
-    return super unless extension.parameters.include? name
-    self[name]
+    @extension.parameters.try(:each) do |method_name|
+      define_singleton_method(method_name) { self[method_name] }
+    end
+
+    super @params
   end
 
   # TODO: Method missing that pulls out of params?

data/lib/jenkins_pipeline_builder/extensions/helpers/triggers/upstream_helper.rb

@@ -1,7 +1,7 @@
 class UpstreamHelper < ExtensionHelper
   attr_reader :color, :name, :ordinal
-  def initialize(params, builder)
-    super params, builder
+  def initialize(extension, params, builder)
+    super extension, params, builder
 
     case params[:status]
     when 'unstable'

data/lib/jenkins_pipeline_builder/extensions/job_attributes.rb

@@ -20,6 +20,64 @@
 # THE SOFTWARE.
 #
 
+# Promotion specific job attributes
+job_attribute do
+  name :promotion_description
+  plugin_id 'builtin'
+  description 'This is the description of your promotion.'
+  jenkins_name 'Description'
+  announced false
+
+  xml path: '//hudson.plugins.promoted__builds.PromotionProcess' do |description|
+    description description.to_s
+  end
+end
+
+job_attribute do
+  name :block_when_downstream_building
+  plugin_id 'builtin'
+  description 'Prevents new builds from being executed until the downstream jobs have finished.'
+
+  xml path: '//hudson.plugins.promoted__builds.PromotionProcess' do |is_enabled|
+    blockBuildWhenDownstreamBuilding is_enabled
+  end
+end
+
+job_attribute do
+  name :block_when_upstream_building
+  plugin_id 'builtin'
+  description 'Prevents new builds from being executed until the upstream jobs have finished.'
+
+  xml path: '//hudson.plugins.promoted__builds.PromotionProcess' do |is_enabled|
+    blockBuildWhenUpstreamBuilding is_enabled
+  end
+end
+
+job_attribute do
+  name :is_visible
+  plugin_id 'builtin'
+  # TODO: Verify that this description is actually what this does
+  description 'Set a promotion process to be visible in the UI'
+
+  xml path: '//hudson.plugins.promoted__builds.PromotionProcess' do |is_enabled|
+    isVisible if is_enabled
+  end
+end
+
+job_attribute do
+  name :promotion_icon
+  plugin_id 'builtin'
+  description 'Set the star color for a promotion process'
+
+  # Should be one main color %[gold silver white blue green orange purple red]
+  # With an optional fill color "e" for empty "w" for white
+  # e.g. "gold" or "gold-w"
+  xml path: '//hudson.plugins.promoted__builds.PromotionProcess' do |icon_name|
+    icon "star-#{icon_name}"
+  end
+end
+
+# Job attributes for jobs
 job_attribute do
   name :description
   plugin_id 'builtin'
@@ -27,7 +85,7 @@ job_attribute do
   jenkins_name 'Description'
   announced false
 
-  before do
+  before do |_param|
     xpath('//project/description').remove
   end
 
@@ -367,6 +425,7 @@ job_attribute do
     end
   end
 end
+
 job_attribute do
   name :promoted_builds
   plugin_id 'promoted-builds'

data/lib/jenkins_pipeline_builder/extensions/promotion_conditions.rb

@@ -0,0 +1,80 @@
+promotion_condition do
+  name :manual
+  plugin_id 'promoted-builds'
+  parameters [
+    :users
+  ]
+
+  xml do |params|
+    send('hudson.plugins.promoted__builds.conditions.ManualCondition') do
+      users params[:users]
+    end
+  end
+end
+
+promotion_condition do
+  name :self_promotion
+  plugin_id 'promoted-builds'
+  parameters [
+    :even_if_unstable
+  ]
+
+  xml do |params|
+    send('hudson.plugins.promoted__builds.conditions.SelfPromotionCondition') do
+      evenIfUnstable true if params[:even_if_unstable].nil?
+      evenIfUnstable params[:even_if_unstable]
+    end
+  end
+end
+
+promotion_condition do
+  name :parameterized_self_promotion
+  plugin_id 'promoted-builds'
+  parameters [
+    :parameter_name,
+    :parameter_value,
+    :even_if_unstable
+  ]
+
+  xml do |params|
+    send('hudson.plugins.promoted__builds.conditions.ParameterizedSelfPromotionCondition') do
+      parameterName params[:parameter_name]
+      parameterValue true if params[:parameter_value].nil?
+      evenIfUnstable true if params[:even_if_unstable].nil?
+      parameterValue params[:parameter_value]
+      evenIfUnstable params[:even_if_unstable]
+    end
+  end
+end
+
+promotion_condition do
+  name :downstream_pass
+  plugin_id 'promoted-builds'
+  parameters [
+    :jobs,
+    :even_if_unstable
+  ]
+
+  xml do |params|
+    send('hudson.plugins.promoted__builds.conditions.DownstreamPassCondition') do
+      jobs params[:jobs] || '{{Example}}-Commit'
+      evenIfUnstable true if params[:even_if_unstable].nil?
+      evenIfUnstable params[:even_if_unstable]
+    end
+  end
+end
+
+promotion_condition do
+  name :upstream_promotion
+  plugin_id 'promoted-builds'
+  parameters [
+    :promotion_name
+  ]
+
+  xml do |params|
+    send('hudson.plugins.promoted__builds.conditions.UpstreamPromotionCondition') do
+      promotionName '01. Staging Promotion' if params[:promotion_name].nil?
+      promotionName params[:promotion_name]
+    end
+  end
+end

data/lib/jenkins_pipeline_builder/generator.rb

@@ -84,16 +84,6 @@ module JenkinsPipelineBuilder
       File.open(job_name + '.xml', 'w') { |f| f.write xml }
     end
 
-    def resolve_job_by_name(name, settings = {})
-      job = job_collection.get_item(name)
-      raise "Failed to locate job by name '#{name}'" if job.nil?
-      job_value = job[:value]
-      logger.debug "Compiling job #{name}"
-      compiler = JenkinsPipelineBuilder::Compiler.new self
-      success, payload = compiler.compile_job(job_value, settings)
-      [success, payload]
-    end
-
     def resolve_project(project)
       defaults = job_collection.defaults
       settings = defaults.nil? ? {} : defaults[:value] || {}
@@ -101,12 +91,25 @@ module JenkinsPipelineBuilder
       project[:settings] = compiler.get_settings_bag(project, settings)
 
       errors = process_project project
+
       print_project_errors errors
       return false, 'Encountered errors exiting' unless errors.empty?
 
       [true, project]
     end
 
+    # Works for jobs, views, and promotions
+    def resolve_job_by_name(name, settings = {})
+      job = job_collection.get_item(name)
+      raise "Failed to locate job by name '#{name}'" if job.nil?
+      job_value = job[:value]
+      logger.debug "Compiling job #{name}"
+      compiler = JenkinsPipelineBuilder::Compiler.new self
+      success, payload = compiler.compile_job(job_value, settings)
+      [success, payload]
+    end
+    alias resolve_section_by_name resolve_job_by_name
+
     private
 
     def load_job_collection(path)
@@ -125,12 +128,18 @@ module JenkinsPipelineBuilder
     end
 
     def process_project(project)
+      errors = {}
       project_body = project[:value]
-      jobs = prepare_jobs(project_body[:jobs]) if project_body[:jobs]
+
+      %i(jobs views promotions).each do |key|
+        next unless project_body[key]
+
+        Utils.symbolize_with_empty_hash!(project_body[key])
+        process_job_changes!(project_body[:jobs]) if key == :jobs
+        process_pipeline_section(project_body[key], project, errors)
+      end
+
       logger.info project
-      process_job_changes(jobs)
-      errors = process_jobs(jobs, project)
-      errors = process_views(project_body[:views], project, errors) if project_body[:views]
       errors
     end
 
@@ -143,18 +152,12 @@ module JenkinsPipelineBuilder
 
     def print_project_errors(errors)
       errors.each do |error|
-        puts 'Encountered errors processing:'
-        puts error.inspect
-      end
-    end
-
-    def prepare_jobs(jobs)
-      jobs.map! do |job|
-        job.is_a?(String) ? { job.to_sym => {} } : job
+        logger.error 'Encountered errors processing:'
+        logger.error error.inspect
       end
     end
 
-    def process_job_changes(jobs)
+    def process_job_changes!(jobs)
       jobs.each do |job|
         job_id = job.keys.first
         j = job_collection.get_item(job_id)
@@ -166,45 +169,21 @@ module JenkinsPipelineBuilder
       end
     end
 
-    def process_views(views, project, errors = {})
-      views.map! do |view|
-        view.is_a?(String) ? { view.to_sym => {} } : view
-      end
-      views.each do |view|
-        view_id = view.keys.first
-        settings = project[:settings].clone.merge(view[view_id])
-        # TODO: rename resolve_job_by_name properly
-        success, payload = resolve_job_by_name(view_id, settings)
-        if success
-          view[:result] = payload
-        else
-          errors[view_id] = payload
-        end
-      end
-      errors
-    end
+    def process_pipeline_section(section, project, errors = {})
+      section.each do |item|
+        item_id = item.keys.first
+        settings = project[:settings].clone.merge(item[item_id])
+        success, payload = resolve_section_by_name(item_id, settings)
 
-    def process_jobs(jobs, project, errors = {})
-      jobs.each do |job|
-        job_id = job.keys.first
-        settings = project[:settings].clone.merge(job[job_id])
-        success, payload = resolve_job_by_name(job_id, settings)
         if success
-          job[:result] = payload
+          item[:result] = payload
         else
-          errors[job_id] = payload
+          errors[item_id] = payload
         end
       end
       errors
     end
 
-    def create_views(views)
-      views.each do |v|
-        compiled_view = v[:result]
-        view.create(compiled_view)
-      end
-    end
-
     def create_jobs_and_views(project)
       success, payload = resolve_project(project)
       return { project_name: 'Failed to resolve' } unless success
@@ -212,9 +191,15 @@ module JenkinsPipelineBuilder
       logger.info 'successfully resolved project'
       compiled_project = payload
 
-      errors = publish_jobs(compiled_project[:value][:jobs]) if compiled_project[:value][:jobs]
-      return errors unless compiled_project[:value][:views]
-      create_views compiled_project[:value][:views]
+      errors = publish_jobs(compiled_project[:value][:jobs])
+
+      if compiled_project[:value][:views]
+        publish_views(compiled_project[:value][:views])
+      end
+
+      if compiled_project[:value][:promotions]
+        publish_promotions(compiled_project[:value][:promotions], compiled_project[:value][:jobs])
+      end
       errors
     end
 
@@ -223,6 +208,29 @@ module JenkinsPipelineBuilder
       create_jobs_and_views(project || raise("Project #{project_name} not found!"))
     end
 
+    def publish_promotions(promotions, jobs)
+      # Converts a list of jobs that might have a list of promoted_builds to
+      # A hash of promoted_builds names => associated job names
+      promotion_job_pairs = jobs.each_with_object({}) do |j, acc|
+        j[:result][:promoted_builds].each do |promotion_name|
+          acc[promotion_name] = j[:result][:name]
+        end if j[:result][:promoted_builds]
+      end
+
+      promotions.each do |promotion|
+        compiled_promotion = promotion[:result]
+        associated_job_name = promotion_job_pairs[compiled_promotion[:name]]
+        Promotion.new(self).create(compiled_promotion, associated_job_name)
+      end
+    end
+
+    def publish_views(views)
+      views.each do |view|
+        compiled_view = view[:result]
+        View.new(self).create(compiled_view)
+      end
+    end
+
     def publish_jobs(jobs, errors = {})
       jobs.each do |i|
         logger.info "Processing #{i}"

data/lib/jenkins_pipeline_builder/job.rb

@@ -20,11 +20,7 @@ module JenkinsPipelineBuilder
       xml = payload
       return local_output(xml) if JenkinsPipelineBuilder.debug || JenkinsPipelineBuilder.file_mode
 
-      if JenkinsPipelineBuilder.client.job.exists?(name)
-        JenkinsPipelineBuilder.client.job.update(name, xml)
-      else
-        JenkinsPipelineBuilder.client.job.create(name, xml)
-      end
+      JenkinsPipelineBuilder.client.job.create_or_update(name, xml)
       [true, nil]
     end
 
@@ -115,9 +111,7 @@ module JenkinsPipelineBuilder
         raise "Job template '#{template_name}' can't be resolved." unless @job_templates.key?(template_name)
         params.delete(:template)
         template = @job_templates[template_name]
-        puts "Template found: #{template}"
         params = template.deep_merge(params)
-        puts "Template merged: #{template}"
       end
 
       xml = JenkinsPipelineBuilder.client.job.build_freestyle_config(params)

data/lib/jenkins_pipeline_builder/job_collection.rb

@@ -18,24 +18,16 @@ module JenkinsPipelineBuilder
       JenkinsPipelineBuilder.logger
     end
 
-    def projects
-      result = []
-      collection.values.each do |item|
-        result << item if item[:type] == :project
-      end
-      result
-    end
-
     def standalone_jobs
       jobs.map { |job| { result: job } }
     end
 
+    def projects
+      collect_type :project
+    end
+
     def jobs
-      result = []
-      collection.values.each do |item|
-        result << item if item[:type] == :job
-      end
-      result
+      collect_type :job
     end
 
     def defaults
@@ -69,6 +61,10 @@ module JenkinsPipelineBuilder
 
     private
 
+    def collect_type(type_name)
+      collection.values.select { |item| item if item[:type] == type_name }
+    end
+
     def load_file(path, remote = false)
       hash = if path.end_with? 'json'
                JSON.parse(IO.read(path))
@@ -80,7 +76,7 @@ module JenkinsPipelineBuilder
         load_section section, remote
       end
     rescue StandardError => err
-      raise "There was an error while parsing a file #{err.message}"
+      raise CustomErrors::ParseError.new err.message, path
     end
 
     def load_section(section, remote)
@@ -92,6 +88,12 @@ module JenkinsPipelineBuilder
         remote_dependencies.load value
         return
       end
+
+      raise TypeError, %(Expected Hash received #{value.class}.
+        Verify that the pipeline section is made up of a single {key: Hash/Object} pair
+        See the definition for:
+        \t#{section}).squeeze(' ') unless value.is_a? Hash
+
       name = value[:name]
       process_collection! name, key, value, remote
     end