jenkins_pipeline_builder 0.4.2 → 0.5.0

data/lib/jenkins_pipeline_builder/triggers.rb

@@ -1,5 +1,5 @@
 #
-# Copyright (c) 2014 Igor Moochnick
+# Copyright (c) 2014 Constant Contact
 #
 # Permission is hereby granted, free of charge, to any person obtaining a copy
 # of this software and associated documentation files (the "Software"), to deal
@@ -22,51 +22,50 @@
 
 module JenkinsPipelineBuilder
   class Triggers
-    def self.enable_git_push(git_push, xml)
-      xml.send('com.cloudbees.jenkins.GitHubPushTrigger') {
+    def self.enable_git_push(_, xml)
+      xml.send('com.cloudbees.jenkins.GitHubPushTrigger') do
         xml.spec
-      }
+      end
     end
 
     def self.enable_scm_polling(scm_polling, xml)
-      xml.send('hudson.triggers.SCMTrigger') {
+      xml.send('hudson.triggers.SCMTrigger') do
         xml.spec scm_polling
         xml.ignorePostCommitHooks false
-      }
+      end
     end
 
     def self.enable_periodic_build(periodic_build, xml)
-      xml.send('hudson.triggers.TimerTrigger') {
+      xml.send('hudson.triggers.TimerTrigger') do
         xml.spec periodic_build
-      }
+      end
     end
 
     def self.enable_upstream_check(params, xml)
       case params[:status]
-      when "unstable"
-        name = "UNSTABLE"
-        ordinal = "1"
-        color = "yellow"
-      when "failed"
-        name = "FAILURE"
-        ordinal = "2"
-        color = "RED"
+      when 'unstable'
+        name = 'UNSTABLE'
+        ordinal = '1'
+        color = 'yellow'
+      when 'failed'
+        name = 'FAILURE'
+        ordinal = '2'
+        color = 'RED'
       else
-        name = "SUCCESS"
-        ordinal = "0"
-        color = "BLUE"
+        name = 'SUCCESS'
+        ordinal = '0'
+        color = 'BLUE'
       end
-      xml.send('jenkins.triggers.ReverseBuildTrigger') {
+      xml.send('jenkins.triggers.ReverseBuildTrigger') do
         xml.spec
         xml.upstreamProjects params[:projects]
-        xml.send('threshold'){
+        xml.send('threshold') do
           xml.name name
           xml.ordinal ordinal
           xml.color color
           xml.completeBuild true
-        }
-      }
+        end
+      end
     end
-
   end
-end
+end

data/lib/jenkins_pipeline_builder/utils.rb

@@ -1,5 +1,5 @@
 #
-# Copyright (c) 2014 Igor Moochnick
+# Copyright (c) 2014 Constant Contact
 #
 # Permission is hereby granted, free of charge, to any person obtaining a copy
 # of this software and associated documentation files (the "Software"), to deal
@@ -23,8 +23,8 @@
 module JenkinsPipelineBuilder
   class ::Hash
     def deep_merge(second)
-      merger = proc { |key, v1, v2| Hash === v1 && Hash === v2 ? v1.merge(v2, &merger) : v2 }
-      self.merge(second, &merger)
+      merger = proc { |_key, v1, v2| v1.is_a?(Hash) && v2.is_a?(Hash) ? v1.merge(v2, &merger) : v2 }
+      merge(second, &merger)
     end
   end
 
@@ -36,11 +36,17 @@ module JenkinsPipelineBuilder
         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].kind_of? Hash
-        if h[ks].kind_of? Array
-          #puts "Array #{h[ks]}"
-          h[ks].each { |item| symbolize_keys_deep!(item) }
+        h[ks].each { |item| symbolize_keys_deep!(item) } if h[ks].is_a?(Array)
+      end
+    end
+    def self.hash_merge!(old, new)
+      old.merge!(new) do |_key, old, new|
+        if old.is_a?(Hash) && new.is_a?(Hash)
+          hash_merge!(old, new)
+        else
+          new
         end
       end
     end
   end
-end
+end

data/lib/jenkins_pipeline_builder/version.rb

@@ -1,5 +1,5 @@
 #
-# Copyright (c) 2014 Igor Moochnick
+# Copyright (c) 2014 Constant Contact
 #
 # Permission is hereby granted, free of charge, to any person obtaining a copy
 # of this software and associated documentation files (the "Software"), to deal
@@ -21,5 +21,5 @@
 #
 
 module JenkinsPipelineBuilder
-  VERSION = "0.4.2"
+  VERSION = '0.5.0'
 end

data/lib/jenkins_pipeline_builder/view.rb

@@ -1,5 +1,5 @@
 #
-# Copyright (c) 2014 Igor Moochnick
+# Copyright (c) 2014 Constant Contact
 #
 # Permission is hereby granted, free of charge, to any person obtaining a copy
 # of this software and associated documentation files (the "Software"), to deal
@@ -45,20 +45,20 @@ module JenkinsPipelineBuilder
 
     def get_mode(type)
       case type
-        when 'listview'
-          'hudson.model.ListView'
-        when 'myview'
-          'hudson.model.MyView'
-        when 'nestedView'
-          'hudson.plugins.nested_view.NestedView'
-        when 'categorizedView'
-          'org.jenkinsci.plugins.categorizedview.CategorizedJobsView'
-        when 'dashboardView'
-          'hudson.plugins.view.dashboard.Dashboard'
-        when 'multijobView'
-         'com.tikal.jenkins.plugins.multijob.views.MultiJobView'
-        else
-          raise "Type #{type} is not supported by Jenkins."
+      when 'listview'
+        'hudson.model.ListView'
+      when 'myview'
+        'hudson.model.MyView'
+      when 'nestedView'
+        'hudson.plugins.nested_view.NestedView'
+      when 'categorizedView'
+        'org.jenkinsci.plugins.categorizedview.CategorizedJobsView'
+      when 'dashboardView'
+        'hudson.plugins.view.dashboard.Dashboard'
+      when 'multijobView'
+        'com.tikal.jenkins.plugins.multijob.views.MultiJobView'
+      else
+        fail "Type #{type} is not supported by Jenkins."
       end
     end
 
@@ -72,12 +72,12 @@ module JenkinsPipelineBuilder
       @logger.info "Creating a view '#{view_name}' of type '#{type}'"
       mode = get_mode(type)
       initial_post_params = {
+        'name' => view_name,
+        'mode' => mode,
+        'json' => {
           'name' => view_name,
-          'mode' => mode,
-          'json' => {
-              'name' => view_name,
-              'mode' => mode
-          }.to_json
+          'mode' => mode
+        }.to_json
       }
 
       if @generator.debug
@@ -110,46 +110,57 @@ 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]
+      fail ArgumentError, 'Name is required for creating view' unless params.is_a?(Hash) && params[:name]
       unless @generator.debug
-        if @client.view.exists?(params[:name])
-          @client.view.delete(params[:name])
+        # If we have a parent view, we need to do some additional checks
+        if params[:parent_view]
+          # If there is no current parent view, create it
+          unless @client.view.exists?(params[:parent_view])
+            create_base_view(params[:parent_view], 'nestedView')
+          end
+          # If the view currently exists, delete it
+          if exists?(params[:name], params[:parent_view])
+            delete(params[:name], params[:parent_view])
+          end
+        else
+          if @client.view.exists?(params[:name])
+            @client.view.delete(params[:name])
+          end
         end
       end
       params[:type] = 'listview' unless params[:type]
       create_base_view(params[:name], params[:type], params[:parent_view])
       @logger.debug "Creating a #{params[:type]} view with params: #{params.inspect}"
       status_filter = case params[:status_filter]
-                        when "all_selected_jobs"
-                          ""
-                        when "enabled_jobs_only"
-                          "1"
-                        when "disabled_jobs_only"
-                          "2"
-                        else
-                          ""
+                      when 'all_selected_jobs'
+                        ''
+                      when 'enabled_jobs_only'
+                        '1'
+                      when 'disabled_jobs_only'
+                        '2'
+                      else
+                        ''
                       end
 
       json = {
-          "name" => params[:name],
-          "description" => params[:description],
-          "mode" => get_mode(params[:type]),
-          "statusFilter" => "",
-          "columns" => get_columns(params[:type])
+        'name' => params[:name],
+        'description' => params[:description],
+        'mode' => get_mode(params[:type]),
+        'statusFilter' => '',
+        'columns' => get_columns(params[:type])
       }
-      json.merge!("groupingRules" => params[:groupingRules]) if params[:groupingRules]
+      json.merge!('groupingRules' => params[:groupingRules]) if params[:groupingRules]
       post_params = {
-          "name" => params[:name],
-          "mode" => get_mode(params[:type]),
-          "description" => params[:description],
-          "statusFilter" => status_filter,
-          "json" => json.to_json
+        'name' => params[:name],
+        'mode' => get_mode(params[:type]),
+        'description' => params[:description],
+        'statusFilter' => status_filter,
+        'json' => json.to_json
       }
-      post_params.merge!("filterQueue" => "on") if params[:filter_queue]
-      post_params.merge!("filterExecutors" => "on") if params[:filter_executors]
-      post_params.merge!("useincluderegex" => "on",
-                         "includeRegex" => params[:regex]) if params[:regex]
+      post_params.merge!('filterQueue' => 'on') if params[:filter_queue]
+      post_params.merge!('filterExecutors' => 'on') if params[:filter_executors]
+      post_params.merge!('useincluderegex' => 'on',
+                         'includeRegex' => params[:regex]) if params[:regex]
 
       if @generator.debug
         pp post_params
@@ -164,60 +175,60 @@ module JenkinsPipelineBuilder
 
     def get_columns(type)
       columns_repository = {
-          'Status' =>
-              {
-                  'stapler-class' => 'hudson.views.StatusColumn',
-                  'kind' => 'hudson.views.StatusColumn'
-              },
-          'Weather' =>
-              {
-                  "stapler-class" => "hudson.views.WeatherColumn",
-                  "kind" => "hudson.views.WeatherColumn"
-              },
-          'Name' =>
-              {
-                  "stapler-class" => "hudson.views.JobColumn",
-                  "kind" => "hudson.views.JobColumn"
-              },
-          'Last Success' =>
-              {
-                  "stapler-class" => "hudson.views.LastSuccessColumn",
-                  "kind" => "hudson.views.LastSuccessColumn"
-              },
-          'Last Failure' =>
-              {
-                  "stapler-class" => "hudson.views.LastFailureColumn",
-                  "kind" => "hudson.views.LastFailureColumn"
-              },
-          'Last Duration' =>
-              {
-                  "stapler-class" => "hudson.views.LastDurationColumn",
-                  "kind" => "hudson.views.LastDurationColumn"
-              },
-          'Build Button' =>
-              {
-                  'stapler-class' => 'hudson.views.BuildButtonColumn',
-                  'kind' => 'hudson.views.BuildButtonColumn'
-              },
-          'Categorized - Job' =>
-              {
-                  'stapler-class' => 'org.jenkinsci.plugins.categorizedview.IndentedJobColumn',
-                  'kind' => 'org.jenkinsci.plugins.categorizedview.IndentedJobColumn'
-              }
+        'Status' =>
+        {
+          'stapler-class' => 'hudson.views.StatusColumn',
+          'kind' => 'hudson.views.StatusColumn'
+        },
+        'Weather' =>
+        {
+          'stapler-class' => 'hudson.views.WeatherColumn',
+          'kind' => 'hudson.views.WeatherColumn'
+        },
+        'Name' =>
+        {
+          'stapler-class' => 'hudson.views.JobColumn',
+          'kind' => 'hudson.views.JobColumn'
+        },
+        'Last Success' =>
+        {
+          'stapler-class' => 'hudson.views.LastSuccessColumn',
+          'kind' => 'hudson.views.LastSuccessColumn'
+        },
+        'Last Failure' =>
+        {
+          'stapler-class' => 'hudson.views.LastFailureColumn',
+          'kind' => 'hudson.views.LastFailureColumn'
+        },
+        'Last Duration' =>
+        {
+          'stapler-class' => 'hudson.views.LastDurationColumn',
+          'kind' => 'hudson.views.LastDurationColumn'
+        },
+        'Build Button' =>
+        {
+          'stapler-class' => 'hudson.views.BuildButtonColumn',
+          'kind' => 'hudson.views.BuildButtonColumn'
+        },
+        'Categorized - Job' =>
+        {
+          'stapler-class' => 'org.jenkinsci.plugins.categorizedview.IndentedJobColumn',
+          'kind' => 'org.jenkinsci.plugins.categorizedview.IndentedJobColumn'
+        }
       }
 
       column_names = case type
-                       when 'categorizedView'
-                         ['Status', 'Weather', 'Categorized - Job', 'Last Success', 'Last Failure', 'Last Duration', 'Build Button']
-                       else
-                         ['Status', 'Weather', 'Name', 'Last Success', 'Last Failure', 'Last Duration', 'Build Button']
+                     when 'categorizedView'
+                       ['Status', 'Weather', 'Categorized - Job', 'Last Success', 'Last Failure', 'Last Duration', 'Build Button']
+                     else
+                       ['Status', 'Weather', 'Name', 'Last Success', 'Last Failure', 'Last Duration', 'Build Button']
                      end
 
       result = []
       column_names.each do |name|
         result << columns_repository[name]
       end
-      return result
+      result
     end
 
     def path_encode(path)
@@ -230,18 +241,18 @@ module JenkinsPipelineBuilder
     # @param [String] filter a regex to filter view names
     # @param [Bool] ignorecase whether to be case sensitive or not
     #
-    def list_children(parent_view = nil, filter = "", ignorecase = true)
+    def list_children(parent_view = nil, filter = '', ignorecase = true)
       @logger.info "Obtaining children views of parent #{parent_view} based on filter '#{filter}'"
       view_names = []
       path = parent_view.nil? ? '' : "/view/#{parent_view}"
       response_json = @client.api_get_request(path)
-      response_json["views"].each { |view|
+      response_json['views'].each do |view|
         if ignorecase
-          view_names << view["name"] if view["name"] =~ /#{filter}/i
+          view_names << view['name'] if view['name'] =~ /#{filter}/i
         else
-          view_names << view["name"] if view["name"] =~ /#{filter}/
+          view_names << view['name'] if view['name'] =~ /#{filter}/
         end
-      }
+      end
       view_names
     end
 
@@ -255,5 +266,16 @@ module JenkinsPipelineBuilder
       path += "/view/#{view_name}/doDelete"
       @client.api_post_request(path)
     end
+    # Checks if the given view exists in Jenkins
+    #
+    # @param [String] view_name
+    #
+    def exists?(view_name, parent_view = nil)
+      if parent_view
+        list_children(parent_view, view_name).include?(view_name)
+      else
+        list(view_name).include?(view_name)
+      end
+    end
   end
-end
+end

data/lib/jenkins_pipeline_builder/wrappers.rb

@@ -1,5 +1,5 @@
 #
-# Copyright (c) 2014 Igor Moochnick
+# Copyright (c) 2014 Constant Contact
 #
 # Permission is hereby granted, free of charge, to any person obtaining a copy
 # of this software and associated documentation files (the "Software"), to deal
@@ -22,102 +22,102 @@
 
 module JenkinsPipelineBuilder
   class Wrappers
-    def self.ansicolor(wrapper, xml)
-      xml.send('hudson.plugins.ansicolor.AnsiColorBuildWrapper') {
+    def self.ansicolor(_, xml)
+      xml.send('hudson.plugins.ansicolor.AnsiColorBuildWrapper') do
         xml.colorMapName 'xterm'
-      }
+      end
     end
 
-    def self.console_timestamp(wrapper, xml)
+    def self.console_timestamp(_, xml)
       xml.send('hudson.plugins.timestamper.TimestamperBuildWrapper', 'plugin' => 'timestamper')
     end
 
     def self.run_with_rvm05(wrapper, xml)
-      xml.send('ruby-proxy-object') {
-        xml.send('ruby-object', 'ruby-class' => 'Jenkins::Tasks::BuildWrapperProxy', 'pluginid' => 'rvm') {
-          xml.object('ruby-class' => 'RvmWrapper', 'pluginid' => 'rvm') {
-            xml.impl('pluginid' => "rvm", 'ruby-class' => 'String') { xml.text wrapper }
-          }
+      xml.send('ruby-proxy-object') do
+        xml.send('ruby-object', 'ruby-class' => 'Jenkins::Tasks::BuildWrapperProxy', 'pluginid' => 'rvm') do
+          xml.object('ruby-class' => 'RvmWrapper', 'pluginid' => 'rvm') do
+            xml.impl('pluginid' => 'rvm', 'ruby-class' => 'String') { xml.text wrapper }
+          end
           xml.pluginid(:pluginid => 'rvm', 'ruby-class' => 'String') { xml.text 'rvm' }
-        }
-      }
+        end
+      end
     end
     def self.run_with_rvm(wrapper, xml)
-      xml.send('ruby-proxy-object') {
-        xml.send('ruby-object', 'ruby-class' => 'Jenkins::Plugin::Proxies::BuildWrapper', 'pluginid' => 'rvm') {
-          xml.object('ruby-class' => 'RvmWrapper', 'pluginid' => 'rvm') {
-            xml.impl('pluginid' => "rvm", 'ruby-class' => 'String') { xml.text wrapper }
-          }
+      xml.send('ruby-proxy-object') do
+        xml.send('ruby-object', 'ruby-class' => 'Jenkins::Plugin::Proxies::BuildWrapper', 'pluginid' => 'rvm') do
+          xml.object('ruby-class' => 'RvmWrapper', 'pluginid' => 'rvm') do
+            xml.impl('pluginid' => 'rvm', 'ruby-class' => 'String') { xml.text wrapper }
+          end
           xml.pluginid(:pluginid => 'rvm', 'ruby-class' => 'String') { xml.text 'rvm' }
-        }
-      }
+        end
+      end
     end
 
     def self.inject_passwords(passwords, xml)
-      xml.EnvInjectPasswordWrapper {
+      xml.EnvInjectPasswordWrapper do
         xml.injectGlobalPasswords false
-        xml.passwordEntries {
+        xml.passwordEntries do
           passwords.each do |password|
-            xml.EnvInjectPasswordEntry {
+            xml.EnvInjectPasswordEntry do
               xml.name password[:name]
               xml.value password[:value]
-            }
+            end
           end
-        }
-      }
+        end
+      end
     end
 
     def self.inject_env_vars(params, xml)
-      xml.EnvInjectBuildWrapper {
-        xml.info {
+      xml.EnvInjectBuildWrapper do
+        xml.info do
           xml.propertiesFilePath params[:file] if params[:file]
           xml.propertiesContent params[:content] if params[:content]
           xml.loadFilesFromMaster false
-        }
-      }
+        end
+      end
     end
 
     def self.publish_to_artifactory(wrapper, xml)
-      xml.send('org.jfrog.hudson.generic.ArtifactoryGenericConfigurator') {
-        xml.details {
+      xml.send('org.jfrog.hudson.generic.ArtifactoryGenericConfigurator') do
+        xml.details do
           xml.artifactoryUrl wrapper[:url]
           xml.artifactoryName wrapper[:'artifactory-name']
           xml.repositoryKey wrapper[:'release-repo']
           xml.snapshotsRepositoryKey wrapper.fetch(:'snapshot-repo', wrapper[:'release-repo'])
-        }
+        end
         xml.deployPattern wrapper[:publish]
         xml.resolvePattern
-        xml.matrixParams
+        xml.matrixParams wrapper[:properties]
         xml.deployBuildInfo wrapper[:'publish-build-info']
         xml.includeEnvVars false
-        xml.envVarsPatterns {
+        xml.envVarsPatterns do
           xml.includePatterns
           xml.excludePatterns '*password*,*secret*'
-        }
+        end
         xml.discardOldBuilds false
         xml.discardBuildArtifacts true
-      }
+      end
     end
 
     def self.artifactory_maven3_configurator(wrapper, xml)
-      xml.send('org.jfrog.hudson.maven3.ArtifactoryMaven3Configurator') { # plugin="artifactory@2.2.1"
-        xml.details {
+      xml.send('org.jfrog.hudson.maven3.ArtifactoryMaven3Configurator') do # plugin='artifactory@2.2.1'
+        xml.details do
           xml.artifactoryUrl wrapper[:url]
           xml.artifactoryName wrapper[:'artifactory-name']
           xml.repositoryKey wrapper[:'release-repo']
           xml.snapshotsRepositoryKey wrapper.fetch(:'snapshot-repo', wrapper[:'release-repo'])
-        }
+        end
         xml.deployArtifacts wrapper.fetch(:'deploy', true)
-        xml.artifactDeploymentPatterns {
+        xml.artifactDeploymentPatterns do
           xml.includePatterns
           xml.excludePatterns
-        }
+        end
         xml.includeEnvVars false
         xml.deployBuildInfo wrapper.fetch(:'publish-build-info', true)
-        xml.envVarsPatterns {
+        xml.envVarsPatterns do
           xml.includePatterns
           xml.excludePatterns '*password*,*secret*'
-        }
+        end
         xml.runChecks false
         xml.violationRecipients
         xml.includePublishArtifacts false
@@ -138,7 +138,7 @@ module JenkinsPipelineBuilder
         xml.autoCreateMissingComponentRequests true
         xml.autoDiscardStaleComponentRequests true
         xml.filterExcludedArtifactsFromBuild false
-      }
+      end
     end
   end
 end