jenkins_pipeline_builder 1.6.0 → 1.10.0

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

@@ -2,6 +2,7 @@ class CoberturaReportHelper < ExtensionHelper
   def thresholds
     @thresholds ||= params[:metric_targets]
     return @thresholds if @thresholds
+
     @thresholds = {
       failing: [
         { type: 'type', value: 0 },

data/lib/jenkins_pipeline_builder/extensions/job_attributes.rb

@@ -227,6 +227,7 @@ job_attribute do
         if params[:changelog_to_branch]
           opts = params[:changelog_to_branch]
           raise 'remote and branch are required for changelog_to_branch' unless opts[:remote] && opts[:branch]
+
           send('hudson.plugins.git.extensions.impl.ChangelogToBranch') do
             options do
               compareRemote opts[:remote]
@@ -264,6 +265,29 @@ job_attribute do
   end
 end
 
+job_attribute do
+  name :google_chat
+  plugin_id 'google-chat-notification'
+  description 'This plugin allows your team to setup build notifications to be sent to Google Chat rooms.'
+  jenkins_name 'Google Chat Notification'
+  announced false
+
+  xml path: '//properties' do |params|
+    send('io.cnaik.GoogleChatNotification', 'plugin' => 'google-chat-notification') do
+      url params[:url] || ''
+      notifyAborted params[:notifyAborted] || false
+      notifyFailure params[:notifyFailure] || false
+      notifyNotBuilt params[:notifyNotBuilt] || false
+      notifySuccess params[:notifySuccess] || false
+      notifyUnstable params[:notifyUnstable] || false
+      notifyBackToNormal params[:notifyBackToNormal] || false
+      suppressInfoLoggers params[:suppressInfoLoggers] || false
+      sameThreadNotification params[:sameThreadNotification] || false
+      message params[:message] || ''
+    end
+  end
+end
+
 job_attribute do
   name :hipchat
   plugin_id 'hipchat'

data/lib/jenkins_pipeline_builder/extensions/publishers.rb

@@ -72,6 +72,32 @@ publisher do
   end
 end
 
+publisher do
+  name :google_chat
+  plugin_id 'google-chat-notification'
+  description 'This plugin allows your team to setup build notifications to be sent to Google Chat rooms.'
+  jenkins_name 'Google Chat Notification'
+  announced false
+
+  version '0' do
+    xml do |params|
+      params = {} if params == true
+      send('io.cnaik.GoogleChatNotification') do
+        url params[:url] || ''
+        message params[:message] || ''
+        notifyAborted params[:notifyAborted] || false
+        notifyFailure params[:notifyFailure] || false
+        notifyNotBuilt params[:notifyNotBuilt] || false
+        notifySuccess params[:notifySuccess] || false
+        notifyUnstable params[:notifyUnstable] || false
+        notifyBackToNormal params[:notifyBackToNormal] || false
+        suppressInfoLoggers params[:suppressInfoLoggers] || false
+        sameThreadNotification params[:sameThreadNotification] || false
+      end
+    end
+  end
+end
+
 publisher do
   name :hipchat
   plugin_id 'hipchat'
@@ -382,7 +408,6 @@ publisher do
   xml do |params|
     send('hudson.plugins.sonar.SonarPublisher') do
       jdk params[:jdk] || '(Inherit From Job)'
-      branch params[:branch] || ''
       language
       mavenOpts
       jobAdditionalProperties params[:additional_properties] || ''

data/lib/jenkins_pipeline_builder/extensions/wrappers.rb

@@ -26,7 +26,6 @@ wrapper do
   announced false
   jenkins_name 'Color ANSI Console Output'
   description 'This plugin adds support for ANSI escape sequences, including color, to Console Output.'
-
   xml do |_|
     send('hudson.plugins.ansicolor.AnsiColorBuildWrapper') do
       colorMapName 'xterm'
@@ -99,6 +98,7 @@ wrapper do
         passwords = wrapper
       end
       break unless passwords
+
       passwordEntries do
         passwords.each do |password|
           EnvInjectPasswordEntry do
@@ -148,6 +148,7 @@ wrapper do
       resolvePattern
       matrixParams wrapper[:properties]
       deployBuildInfo wrapper[:'publish-build-info']
+      useSpecs false
       includeEnvVars false
       envVarsPatterns do
         includePatterns

data/lib/jenkins_pipeline_builder/generator.rb

@@ -56,7 +56,7 @@ module JenkinsPipelineBuilder
       publish(project_name || job_collection.projects.first[:name])
     end
 
-    def pull_request(path, project_name)
+    def pull_request(path, project_name, base_branch_only = false)
       logger.info "Pull Request Generator Running from path #{path}"
       load_job_collection path unless job_collection.loaded?
       defaults = job_collection.defaults[:value]
@@ -64,7 +64,9 @@ module JenkinsPipelineBuilder
       pr_generator.delete_closed_prs
       errors = []
       pr_generator.open_prs.each do |pr|
-        pr_generator.convert! job_collection, pr
+        next if base_branch_only && defaults[:git_branch] != pr[:base]
+
+        pr_generator.convert! job_collection, pr[:number]
         error = publish(project_name)
         errors << error unless error.empty?
       end
@@ -102,6 +104,7 @@ module JenkinsPipelineBuilder
     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
@@ -211,6 +214,7 @@ module JenkinsPipelineBuilder
       # A hash of promoted_builds names => associated job names
       promotion_job_pairs = jobs.each_with_object({}) do |j, acc|
         next unless j[:result][:promoted_builds]
+
         j[:result][:promoted_builds].each do |promotion_name|
           acc[promotion_name] = j[:result][:name]
         end
@@ -235,6 +239,7 @@ module JenkinsPipelineBuilder
         logger.info "Processing #{i}"
         job = i[:result]
         raise "Result is empty for #{i}" if job.nil?
+
         job = Job.new job
         success, payload = job.create_or_update
         errors[job.name] = payload unless success

data/lib/jenkins_pipeline_builder/job.rb

@@ -17,6 +17,7 @@ module JenkinsPipelineBuilder
     def create_or_update
       success, payload = to_xml
       return success, payload unless success
+
       xml = payload
       return local_output(xml) if JenkinsPipelineBuilder.debug || JenkinsPipelineBuilder.file_mode
 
@@ -31,6 +32,7 @@ module JenkinsPipelineBuilder
       job[:job_type] = 'free_style' unless job[:job_type]
       type = job[:job_type]
       return false, "Job type: #{type} is not one of #{job_methods.join(', ')}" unless known_type? type
+
       @xml = setup_freestyle_base(job)
       payload = send("update_#{type}")
 
@@ -109,6 +111,7 @@ module JenkinsPipelineBuilder
       if params.key?(:template)
         template_name = params[:template]
         raise "Job template '#{template_name}' can't be resolved." unless @job_templates.key?(template_name)
+
         params.delete(:template)
         template = @job_templates[template_name]
         params = template.deep_merge(params)

data/lib/jenkins_pipeline_builder/job_collection.rb

@@ -75,8 +75,8 @@ module JenkinsPipelineBuilder
       hash.each do |section|
         load_section section, remote
       end
-    rescue StandardError => err
-      raise CustomErrors::ParseError.new err.message, path
+    rescue StandardError => e
+      raise CustomErrors::ParseError.new e.message, path
     end
 
     def load_section(section, remote)
@@ -108,6 +108,7 @@ module JenkinsPipelineBuilder
         # skip if the existing item is local and the new item is remote
         return if remote && !existing_remote
         raise "Duplicate item with name '#{name}' was detected." unless existing_remote && !remote
+
         # override if the existing item is remote and the new is local
         logger.info "Duplicate item with name '#{name}' was detected from the remote folder."
       end
@@ -118,9 +119,10 @@ module JenkinsPipelineBuilder
       path = "#{path}/extensions"
       path = File.expand_path(path, Dir.getwd)
       return unless File.directory?(path)
+
       logger.info "Loading extensions from folder #{path}"
       logger.info Dir.glob("#{path}/*.rb").inspect
-      Dir.glob("#{path}/**/*.rb").each do |file|
+      Dir.glob("#{path}/**/*.rb").sort.each do |file|
         logger.info "Loaded #{file}"
         require file
       end

data/lib/jenkins_pipeline_builder/module_registry.rb

@@ -29,6 +29,7 @@ module JenkinsPipelineBuilder
     def versions
       # Return a hash with a default of 1000 so that we'll get the newest in debug
       return Hash.new { |_| '1000.0' } if JenkinsPipelineBuilder.debug
+
       @versions ||= JenkinsPipelineBuilder.client.plugin.list_installed
     end
 
@@ -77,6 +78,7 @@ module JenkinsPipelineBuilder
     def get_by_path_collection(path, registry)
       item = registry[path.shift.to_sym]
       return item if path.count == 0
+
       get_by_path_collection(path, item)
     end
 
@@ -88,8 +90,10 @@ module JenkinsPipelineBuilder
     def traverse_registry(registry, params, n_xml, strict = false)
       params.each do |key, value|
         next unless registry.is_a? Hash
+
         unless registry.key? key
           raise TypeError, "!!!! could not find key #{key} !!!!" if strict
+
           next
         end
         reg_value = registry[key]

data/lib/jenkins_pipeline_builder/promotion.rb

@@ -31,6 +31,7 @@ module JenkinsPipelineBuilder
     def create(params, job_name)
       success, payload = prom_to_xml(params)
       return success, payload unless success
+
       xml = payload
       return local_output(xml) if JenkinsPipelineBuilder.debug || JenkinsPipelineBuilder.file_mode
 

data/lib/jenkins_pipeline_builder/pull_request_generator.rb

@@ -29,32 +29,33 @@ module JenkinsPipelineBuilder
       @open_prs = active_prs defaults[:github_site], defaults[:git_org], defaults[:git_repo_name]
     end
 
-    def convert!(job_collection, pr)
-      job_collection.defaults[:value][:application_name] = "#{application_name}-PR#{pr}"
-      job_collection.defaults[:value][:pull_request_number] = pr.to_s
-      job_collection.jobs.each { |j| override j[:value], pr }
+    def convert!(job_collection, pr_number)
+      job_collection.defaults[:value][:application_name] = "#{application_name}-PR#{pr_number}"
+      job_collection.defaults[:value][:pull_request_number] = pr_number.to_s
+      job_collection.jobs.each { |j| override j[:value], pr_number }
     end
 
     def delete_closed_prs
       return if JenkinsPipelineBuilder.debug
+
       jobs_to_delete = JenkinsPipelineBuilder.client.job.list "^#{application_name}-PR(\\d+)-(.*)$"
-      open_prs.each do |n|
-        jobs_to_delete.reject! { |j| j.start_with? "#{application_name}-PR#{n}" }
+      open_prs.each do |pr|
+        jobs_to_delete.reject! { |j| j.start_with? "#{application_name}-PR#{pr[:number]}" }
       end
       jobs_to_delete.each { |j| JenkinsPipelineBuilder.client.job.delete j }
     end
 
     private
 
-    def override(job, pr)
+    def override(job, pr_number)
       git_version = JenkinsPipelineBuilder.registry.registry[:job][:scm_params].installed_version
-      job[:scm_branch] = "origin/pr/#{pr}/head"
+      job[:scm_branch] = "origin/pr/#{pr_number}/head"
       job[:scm_params] ||= {}
-      job[:scm_params][:refspec] = "refs/pull/#{pr}/head:refs/remotes/origin/pr/#{pr}/head"
+      job[:scm_params][:refspec] = "refs/pull/#{pr_number}/head:refs/remotes/origin/pr/#{pr_number}/head"
       job[:scm_params][:changelog_to_branch] ||= {}
       if Gem::Version.new(2.0) < git_version
         job[:scm_params][:changelog_to_branch]
-          .merge!(remote: 'origin', branch: "pr/#{pr}/head")
+          .merge!(remote: 'origin', branch: "pr/#{pr_number}/head")
       end
     end
 
@@ -66,7 +67,7 @@ module JenkinsPipelineBuilder
       begin
         resp = Net::HTTP.get_response(URI.parse(url))
         pulls = JSON.parse(resp.body)
-        pulls.map { |p| p['number'] }
+        pulls.map { |p| { number: p['number'], base: p['base']['ref'] } }
       rescue StandardError
         raise 'Failed connecting to github!'
       end

data/lib/jenkins_pipeline_builder/remote_dependencies.rb

@@ -88,8 +88,8 @@ module JenkinsPipelineBuilder
     def download_yaml(url, file, remote_opts = {})
       entries[url] = file
       logger.info "Downloading #{url} to #{file}.tar"
-      open("#{file}.tar", 'w') do |local_file|
-        open(url, remote_opts) do |remote_file|
+      File.open("#{file}.tar", 'w') do |local_file|
+        URI.parse(url).open(remote_opts) do |remote_file|
           local_file.write(Zlib::GzipReader.new(remote_file).read)
         end
       end

data/lib/jenkins_pipeline_builder/utils.rb

@@ -30,14 +30,19 @@ end
 module JenkinsPipelineBuilder
   class Utils
     # Code was duplicated from jeknins_api_client
-    def self.symbolize_keys_deep!(h)
-      return unless h.is_a?(Hash)
-      h.keys.each do |k|
-        ks    = k.respond_to?(:to_sym) ? k.to_sym : k
-        h[ks] = h.delete k # Preserve order even when k == ks
-        symbolize_keys_deep! h[ks] if h[ks].is_a? Hash
-        h[ks].each { |item| symbolize_keys_deep!(item) } if h[ks].is_a?(Array)
+    def self.symbolize_keys_deep!(to_symbolize)
+      return unless to_symbolize.is_a?(Hash)
+
+      # This lint is disabled here because each_key requires that you not add or remove keys
+      # during iteration, which apparently this block does...
+      # rubocop:disable Style/HashEachMethods
+      to_symbolize.keys.each do |k|
+        ks = k.respond_to?(:to_sym) ? k.to_sym : k
+        to_symbolize[ks] = to_symbolize.delete k # Preserve order even when k == ks
+        symbolize_keys_deep! to_symbolize[ks] if to_symbolize[ks].is_a? Hash
+        to_symbolize[ks].each { |item| symbolize_keys_deep!(item) } if to_symbolize[ks].is_a?(Array)
       end
+      # rubocop:enable Style/HashEachMethods
     end
 
     def self.symbolize_with_empty_hash!(array_of_maybe_str)

data/lib/jenkins_pipeline_builder/version.rb

@@ -21,5 +21,5 @@
 #
 
 module JenkinsPipelineBuilder
-  VERSION = '1.6.0'.freeze
+  VERSION = '1.10.0'.freeze
 end

data/lib/jenkins_pipeline_builder/view.rb

@@ -67,6 +67,7 @@ module JenkinsPipelineBuilder
     def create(params)
       # Name is a required parameter. Raise an error if not specified
       raise ArgumentError, 'Name is required for creating view' unless params.is_a?(Hash) && params[:name]
+
       clean_up_views(params) unless JenkinsPipelineBuilder.debug
       params[:type] ||= 'listview'
       create_base_view(params[:name], params[:type], params[:parent_view])
@@ -133,7 +134,8 @@ module JenkinsPipelineBuilder
         'dashboardView' => 'hudson.plugins.view.dashboard.Dashboard',
         'multijobView' => 'com.tikal.jenkins.plugins.multijob.views.MultiJobView'
       }
-      raise "Type #{type} is not supported by Jenkins." unless types.keys.include? type
+      raise "Type #{type} is not supported by Jenkins." unless types.key?(type)
+
       types[type]
     end
 

data/spec/lib/jenkins_pipeline_builder/cli/helper_spec.rb

@@ -1,4 +1,4 @@
-require File.expand_path('../../spec_helper', __FILE__)
+require File.expand_path('../spec_helper', __dir__)
 
 describe JenkinsPipelineBuilder::CLI::Helper do
   file_suffixes = JenkinsPipelineBuilder::CLI::Helper::DEFAULT_FILE_FORMATS

data/spec/lib/jenkins_pipeline_builder/compiler_spec.rb

@@ -1,4 +1,4 @@
-require File.expand_path('../spec_helper', __FILE__)
+require File.expand_path('spec_helper', __dir__)
 describe JenkinsPipelineBuilder::Compiler do
   before :all do
     JenkinsPipelineBuilder.credentials = {

data/spec/lib/jenkins_pipeline_builder/extension_dsl_spec.rb

@@ -1,4 +1,4 @@
-require File.expand_path('../spec_helper', __FILE__)
+require File.expand_path('spec_helper', __dir__)
 
 describe 'extension dsl' do
   before :all do

data/spec/lib/jenkins_pipeline_builder/extension_set_spec.rb

@@ -1,7 +1,7 @@
-require File.expand_path('../spec_helper', __FILE__)
+require File.expand_path('spec_helper', __dir__)
 
 describe JenkinsPipelineBuilder::ExtensionSet do
-  subject(:set) { JenkinsPipelineBuilder::ExtensionSet.new('foo'){} }
+  subject(:set) { JenkinsPipelineBuilder::ExtensionSet.new('foo') {} }
 
   before :each do
     set.name 'example'
@@ -108,7 +108,7 @@ describe JenkinsPipelineBuilder::ExtensionSet do
     it 'works for snapshot/beta stuff' do
       ext_versions ['1.9', '2.3']
 
-      set.installed_version = '2.0-SNAPSHOT (private-06/06/2014 09:51-bgaulin)'
+      set.installed_version = '2.0-SNAPSHOT'
       # Other examples
       # set.installed_version = '2.0-beta-1'
       # set.installed_version = '2.0+build.93'

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

@@ -1,4 +1,4 @@
-require File.expand_path('../../spec_helper', __FILE__)
+require File.expand_path('../spec_helper', __dir__)
 
 describe 'build_steps' do
   after :each do

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

@@ -1,4 +1,4 @@
-require File.expand_path('../../spec_helper', __FILE__)
+require File.expand_path('../spec_helper', __dir__)
 
 describe 'builders' do
   after :each do
@@ -329,9 +329,9 @@ describe 'builders' do
 
       begin
         JenkinsPipelineBuilder.registry.traverse_registry_path('job', params, @n_xml)
-      rescue RuntimeError => boom
-        puts "Caught error #{boom}"
-        error = boom.to_s
+      rescue RuntimeError => e
+        puts "Caught error #{e}"
+        error = e.to_s
       end
       builder = @n_xml.root.children.first
       expect(builder.name).to match 'hudson.plugins.groovy.SystemGroovy'
@@ -407,8 +407,8 @@ describe 'builders' do
       )
       begin
         JenkinsPipelineBuilder.registry.traverse_registry_path('job', params, @n_xml)
-      rescue RuntimeError => err
-        puts 'Runtime Error: ' + err.to_s
+      rescue RuntimeError => e
+        puts 'Runtime Error: ' + e.to_s
       end
       builder = @n_xml.root.children.first
       expect(builder.name).to match 'jenkins.plugins.nodejs.NodeJsCommandInterpreter'

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

@@ -1,4 +1,4 @@
-require File.expand_path('../../spec_helper', __FILE__)
+require File.expand_path('../spec_helper', __dir__)
 
 describe 'job_attributes' do
   after :each do

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

@@ -1,4 +1,4 @@
-require File.expand_path('../../spec_helper', __FILE__)
+require File.expand_path('../spec_helper', __dir__)
 
 describe 'promotion_conditions' do
   after :each do