jenkins_pipeline_builder 0.4.2 → 0.5.0

data/lib/jenkins_pipeline_builder/job_builder.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,7 +23,7 @@
 module JenkinsPipelineBuilder
   class JobBuilder
     def self.change_description(description, n_xml)
-      desc = n_xml.xpath("//description").first
+      desc = n_xml.xpath('//description').first
       desc.content = "#{description}"
     end
 
@@ -34,118 +34,121 @@ module JenkinsPipelineBuilder
       XmlHelper.update_node_text(n_xml, '//scm/excludedUsers', params[:excluded_users]) if params[:excluded_users]
       XmlHelper.update_node_text(n_xml, '//scm/userRemoteConfigs/hudson.plugins.git.UserRemoteConfig/name', params[:remote_name]) if params[:remote_name]
       XmlHelper.update_node_text(n_xml, '//scm/skipTag', params[:skip_tag]) if params[:skip_tag]
+      XmlHelper.update_node_text(n_xml, '//scm/userRemoteConfigs/hudson.plugins.git.UserRemoteConfig/refspec', params[:refspec]) if params[:refspec]
     end
 
     def self.hipchat_notifier(params, n_xml)
-      raise "No HipChat room specified" unless params[:room]
+      fail 'No HipChat room specified' unless params[:room]
 
-      properties = n_xml.xpath("//properties").first
+      properties = n_xml.xpath('//properties').first
       Nokogiri::XML::Builder.with(properties) do |xml|
-        xml.send('jenkins.plugins.hipchat.HipChatNotifier_-HipChatJobProperty') {
+        xml.send('jenkins.plugins.hipchat.HipChatNotifier_-HipChatJobProperty') do
           xml.room params[:room]
           xml.startNotification params[:'start-notify'] || false
-        }
+        end
       end
     end
 
     def self.use_specific_priority(params, n_xml)
       n_builders = n_xml.xpath('//properties').first
       Nokogiri::XML::Builder.with(n_builders) do |xml|
-        xml.send('jenkins.advancedqueue.AdvancedQueueSorterJobProperty', 'plugin' => 'PrioritySorter') {
+        xml.send('jenkins.advancedqueue.AdvancedQueueSorterJobProperty', 'plugin' => 'PrioritySorter') do
           xml.useJobPriority params[:use_priority]
           xml.priority params[:job_priority] || -1
-        }
+        end
       end
     end
 
     def self.build_parameters(params, n_xml)
       n_builders = n_xml.xpath('//properties').first
       Nokogiri::XML::Builder.with(n_builders) do |xml|
-        xml.send('hudson.model.ParametersDefinitionProperty') {
-          xml.parameterDefinitions {
+        xml.send('hudson.model.ParametersDefinitionProperty') do
+          xml.parameterDefinitions do
             param_proc = lambda do |xml, params, type|
-              xml.send(type) {
+              xml.send(type) do
                 xml.name params[:name]
                 xml.description params[:description]
                 xml.defaultValue params[:default]
                 if params[:type] == 'choice'
-                  puts 'choice'
-                  puts params
-                  xml.choices('class' => 'java.util.Arrays$ArrayList') {
-                    xml.a('class' => 'string-array') {
+                  xml.choices('class' => 'java.util.Arrays$ArrayList') do
+                    xml.a('class' => 'string-array') do
                       params[:values].each do |value|
                         xml.string value
                       end
-                    }
-                  }
+                    end
+                  end
                 end
-              }
+              end
             end
             params.each do |param|
               case param[:type]
-                when 'string'
-                  paramType = 'hudson.model.StringParameterDefinition'
-                when 'bool'
-                  paramType = 'hudson.model.BooleanParameterDefinition'
-                when 'text'
-                  paramType = 'hudson.model.TextParameterDefinition'
-                when 'password'
-                  paramType = 'hudson.model.PasswordParameterDefinition'
-                when 'choice'
-                  paramType = 'hudson.model.ChoiceParameterDefinition'
-                else
-                  paramType = 'hudson.model.StringParameterDefinition'
-                end
+              when 'string'
+                paramType = 'hudson.model.StringParameterDefinition'
+              when 'bool'
+                paramType = 'hudson.model.BooleanParameterDefinition'
+              when 'text'
+                paramType = 'hudson.model.TextParameterDefinition'
+              when 'password'
+                paramType = 'hudson.model.PasswordParameterDefinition'
+              when 'choice'
+                paramType = 'hudson.model.ChoiceParameterDefinition'
+              else
+                paramType = 'hudson.model.StringParameterDefinition'
+              end
 
               param_proc.call xml, param, paramType
             end
-          }
-        }
+          end
+        end
       end
     end
 
     def self.discard_old_param(params, n_xml)
       properties = n_xml.child
       Nokogiri::XML::Builder.with(properties) do |xml|
-        xml.send('logRotator', 'class' => 'hudson.tasks.LogRotator') {
+        xml.send('logRotator', 'class' => 'hudson.tasks.LogRotator') do
           xml.daysToKeep params[:days] if params[:days]
           xml.numToKeep params[:number] || -1
           xml.artifactDaysToKeep params[:artifact_days] || -1
           xml.artifactNumToKeep params[:artifact_number] || -1
-        }
+        end
       end
     end
 
     def self.throttle_job(params, n_xml)
       properties = n_xml.xpath('//properties').first
-      cat_set = params[:option]=="category"
+      cat_set = params[:option] == 'category'
       Nokogiri::XML::Builder.with(properties) do |xml|
-        xml.send('hudson.plugins.throttleconcurrents.ThrottleJobProperty', 'plugin' => 'throttle-concurrents') {
+        xml.send('hudson.plugins.throttleconcurrents.ThrottleJobProperty', 'plugin' => 'throttle-concurrents') do
           xml.maxConcurrentPerNode params[:max_per_node] || 0
           xml.maxConcurrentTotal params[:max_total] || 0
           xml.throttleEnabled true
-          xml.throttleOption params[:option] || "alone"
-          xml.categories {
+          xml.throttleOption params[:option] || 'alone'
+          xml.categories do
             xml.string params[:category] if cat_set
-          }
-        }
+          end
+        end
       end
     end
 
     def self.prepare_environment(params, n_xml)
       properties = n_xml.xpath('//properties').first
       Nokogiri::XML::Builder.with(properties) do |xml|
-        xml.send('EnvInjectJobProperty') {
-          xml.info{
+        xml.send('EnvInjectJobProperty') do
+          xml.info do
             xml.propertiesContent params[:properties_content] if params[:properties_content]
             xml.loadFilesFromMaster params[:load_from_master] if params[:load_from_master]
-          }
+          end
           xml.on true
           xml.keepJenkinsSystemVariables params[:keep_environment] if params[:keep_environment]
           xml.keepBuildVariables params[:keep_build] if params[:keep_build]
-        }
+        end
       end
     end
 
+    def self.concurrent_build(params, n_xml)
+      concurrentBuild = n_xml.xpath('//concurrentBuild').first
+      concurrentBuild.content = (params == true) ? 'true' : 'false'
+    end
   end
 end

data/lib/jenkins_pipeline_builder/module_registry.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
@@ -30,14 +30,12 @@ module JenkinsPipelineBuilder
 
     def get(path)
       parts = path.split('/')
-      self.get_by_path_collection(parts, @registry)
+      get_by_path_collection(parts, @registry)
     end
 
     def get_by_path_collection(path, registry)
       item = registry[path.shift.to_sym]
-      if path.count == 0
-        return item
-      end
+      return item if path.count == 0
 
       get_by_path_collection(path, item)
     end
@@ -67,7 +65,7 @@ module JenkinsPipelineBuilder
         sub_registry = registry_item[:registry]
         method = registry_item[:method]
         method.call(sub_registry, value, n_xml)
-      elsif registry_item.kind_of?(Method)
+      elsif registry_item.kind_of?(Method) || registry_item.kind_of?(Proc)
         registry_item.call(value, n_xml) unless registry_item.nil?
       end
     end

data/lib/jenkins_pipeline_builder/publishers.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,106 +23,121 @@
 module JenkinsPipelineBuilder
   class Publishers
     def self.description_setter(params, xml)
-      xml.send('hudson.plugins.descriptionsetter.DescriptionSetterPublisher') {
+      xml.send('hudson.plugins.descriptionsetter.DescriptionSetterPublisher') do
         xml.regexp params[:regexp]
         xml.regexpForFailed params[:regexp]
         xml.description params[:description]
         xml.descriptionForFailed params[:description]
         xml.setForMatrix false
-      }
+      end
     end
 
     def self.push_to_projects(params, xml)
-      xml.send('hudson.plugins.parameterizedtrigger.BuildTrigger') {
-        xml.configs {
-          xml.send('hudson.plugins.parameterizedtrigger.BuildTriggerConfig') {
-            xml.configs {
-              params[:data] = [ { params: "" } ] unless params[:data]
+      xml.send('hudson.plugins.parameterizedtrigger.BuildTrigger') do
+        xml.configs do
+          xml.send('hudson.plugins.parameterizedtrigger.BuildTriggerConfig') do
+            xml.configs do
+              params[:data] = [{ params: '' }] unless params[:data]
               params[:data].each do |config|
                 if config[:params]
-                  xml.send('hudson.plugins.parameterizedtrigger.PredefinedBuildParameters') {
+                  xml.send('hudson.plugins.parameterizedtrigger.PredefinedBuildParameters') do
                     xml.properties config[:params]
-                  }
+                  end
                 end
                 if config[:file]
-                  xml.send('hudson.plugins.parameterizedtrigger.FileBuildParameters') {
+                  xml.send('hudson.plugins.parameterizedtrigger.FileBuildParameters') do
                     xml.propertiesFile config[:file]
                     xml.failTriggerOnMissing false
-                  }
+                  end
                 end
               end
-            }
+            end
             xml.projects params[:project]
             xml.condition params[:condition] || 'SUCCESS'
             xml.triggerWithNoParameters params[:trigger_with_no_parameters] || false
-          }
-        }
-      }
+          end
+        end
+      end
     end
 
     def self.push_to_hipchat(params, xml)
       params = {} if params == true
-      xml.send('jenkins.plugins.hipchat.HipChatNotifier') {
+      xml.send('jenkins.plugins.hipchat.HipChatNotifier') do
         xml.jenkinsUrl params[:jenkinsUrl] || ''
         xml.authToken params[:authToken] || ''
         xml.room params[:room] || ''
-      }
+      end
     end
 
     def self.push_to_git(params, xml)
-      xml.send('hudson.plugins.git.GitPublisher') {
+      xml.send('hudson.plugins.git.GitPublisher') do
         xml.configVersion params[:configVersion] || 2
         xml.pushMerge params[:'push-merge'] || false
         xml.pushOnlyIfSuccess params[:'push-only-if-success'] || false
-        xml.branchesToPush {
-          xml.send('hudson.plugins.git.GitPublisher_-BranchToPush') {
+        xml.branchesToPush do
+          xml.send('hudson.plugins.git.GitPublisher_-BranchToPush') do
             xml.targetRepoName params[:targetRepoName] || 'origin'
             xml.branchName params[:branchName] || 'master'
-          }
-        }
-      }
+          end
+        end
+      end
     end
 
     def self.publish_junit(params, xml)
-      xml.send('hudson.tasks.junit.JUnitResultArchiver') {
+      xml.send('hudson.tasks.junit.JUnitResultArchiver') do
         xml.testResults params[:test_results] || ''
         xml.keepLongStdio false
         xml.testDataPublishers
-      }
+      end
     end
 
     def self.coverage_metric(name, params, xml)
-      xml.send('hudson.plugins.rubyMetrics.rcov.model.MetricTarget') {
+      xml.send('hudson.plugins.rubyMetrics.rcov.model.MetricTarget') do
         xml.metric name
         xml.healthy params[:healthy]
         xml.unhealthy params[:unhealthy]
         xml.unstable params[:unstable]
-      }
+      end
     end
 
     def self.publish_rcov(params, xml)
-      xml.send('hudson.plugins.rubyMetrics.rcov.RcovPublisher') {
+      xml.send('hudson.plugins.rubyMetrics.rcov.RcovPublisher') do
         xml.reportDir params[:report_dir]
-        xml.targets {
+        xml.targets do
           coverage_metric('TOTAL_COVERAGE', params[:total], xml)
           coverage_metric('CODE_COVERAGE', params[:code], xml)
-        }
-      }
+        end
+      end
     end
 
     def self.post_build_script(params, xml)
-      xml.send('org.jenkinsci.plugins.postbuildscript.PostBuildScript') {
-        xml.buildSteps {
+      xml.send('org.jenkinsci.plugins.postbuildscript.PostBuildScript') do
+        xml.buildSteps do
           if params[:shell_command]
-            xml.send('hudson.tasks.Shell') {
+            xml.send('hudson.tasks.Shell') do
               xml.command params[:shell_command]
-            }
+            end
           end
-        }
+        end
         xml.scriptOnlyIfSuccess params[:on_success]
         xml.scriptOnlyIfFailure params[:on_failure]
         xml.executeOn params[:execute_on] || 'BOTH'
-      }
+      end
+    end
+
+    def self.groovy_postbuild(params, xml)
+      xml.send('org.jvnet.hudson.plugins.groovypostbuild.GroovyPostbuildRecorder', 'plugin' => 'groovy-postbuild') do
+        xml.groovyScript params[:groovy_script]
+        xml.behavior params[:behavior] || '0'
+        xml.runFormMatrixParent 'false'
+        if params[:additional_classpaths]
+          params[:additional_classpaths].each do |path|
+            xml.send('org.jvnet.hudson.plugins.groovypostbuild.GroovyScriptPath') do
+              xml.path path[:path] || '/'
+            end
+          end
+        end
+      end
     end
   end
 end

data/lib/jenkins_pipeline_builder/pull_request.rb

@@ -0,0 +1,156 @@
+#
+# 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
+# in the Software without restriction, including without limitation the rights
+# to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+# copies of the Software, and to permit persons to whom the Software is
+# furnished to do so, subject to the following conditions:
+#
+# The above copyright notice and this permission notice shall be included in
+# all copies or substantial portions of the Software.
+#
+# THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+# IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+# FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+# AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+# LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+# OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
+# THE SOFTWARE.
+#
+
+module JenkinsPipelineBuilder
+  class PullRequestGenerator
+    # Initializes a new View object.
+    #
+    # @param generator [Generator] the client object
+    #
+    # @return [View] the view object
+    #
+    def initialize(generator)
+      @generator = generator
+      @client = generator.client
+      @logger = @client.logger
+    end
+
+    # Check for Github Pull Requests
+    #
+    # args[:git_url] URL to the github main page ex. https://www.github.com/
+    # args[:git_repo] Name of repo only, not url  ex. jenkins_pipeline_builder
+    # args[:git_org] The Orig user ex. igorshare
+    # @return = array of pull request numbers
+    def check_for_pull(args)
+      fail 'Please specify all arguments' unless args[:git_url] && args[:git_org] && args[:git_repo]
+      # Build the Git URL
+      git_url = "#{args[:git_url]}api/v3/repos/#{args[:git_org]}/#{args[:git_repo]}/pulls"
+
+      # Download the JSON Data from the API
+      resp = Net::HTTP.get_response(URI.parse(git_url))
+      pulls = JSON.parse(resp.body)
+      pulls.map { |p| p['number'] }
+    end
+
+    # Purge old builds
+    def purge_old(pull_requests, project)
+      reqs = pull_requests.clone.map { |req| "#{project[:name]}-PR#{req}" }
+      @logger.info "Current pull requests: #{reqs}"
+      # Read File
+      old_requests = File.new('pull_requests.csv', 'a+').read.split(',')
+
+      # Pop off current pull requests
+      old_requests.delete_if { |req| reqs.include?("#{req}") }
+
+      # Delete the old requests from jenkins
+      @logger.info "Purging old requests: #{old_requests}"
+      old_requests.each do |req|
+        jobs = @client.job.list "#{req}.*"
+        jobs.each do |job|
+          @client.job.delete job
+        end
+      end
+      # Write File
+      File.open('pull_requests.csv', 'w+') { |file| file.write reqs.join(',') }
+    end
+
+    def run(project, job_collection, generator_job)
+      @logger.info 'Begin running Pull Request Generator'
+      pull_requests = check_for_pull generator_job[:value]
+      purge_old(pull_requests, project)
+      main_collection = job_collection
+      @logger.info pull_requests
+      pull_requests.each do |number|
+        # Manipulate the YAML
+        req = JenkinsPipelineBuilder::PullRequest.new(project, number, main_collection, generator_job)
+        @generator.job_collection.merge req.jobs
+        project = req.project
+
+        # Overwrite the jobs from the generator to the project
+        project[:value][:jobs] = generator_job[:value][:jobs]
+
+        # Build the jobs
+        success, compiled_project = @generator.resolve_project(project)
+        compiled_project[:value][:jobs].each do |i|
+          job = i[:result]
+          success, payload = @generator.compile_job_to_xml(job)
+          @generator.create_or_update(job, payload) if success
+        end
+      end
+    end
+  end
+
+  class PullRequest
+    attr_reader :project    # The root project YAML as a hash
+    attr_reader :number     # The pull request number
+    attr_reader :jobs       # The jobs in the pull request as an array of hashes
+    attr_reader :generator  # The generator job YAML as a hash
+
+    # Initialize
+    def initialize(project, number, jobs, generator)
+      @project = project.clone
+      @number = number
+      @jobs = jobs.clone
+      @generator = generator.clone
+
+      run!
+    end
+
+    private
+
+    # Apply all changes
+    def run!
+      update_jobs!
+      change_git!
+      change_name!
+    end
+
+    # Change the git branch for each job
+    def change_git!
+      @jobs.each_value do |job|
+        job[:value][:scm_branch] = "origin/pr/#{@number}/head"
+        job[:value][:scm_params] = {} unless job[:value][:scm_params]
+        job[:value][:scm_params][:refspec] = 'refs/pull/*:refs/remotes/origin/pr/*'
+      end
+    end
+
+    # Change the name of the pull request project
+    def change_name!
+      @project[:name] = "#{@project[:name]}-PR#{@number}" if @project[:name]
+      @project[:value][:name] = "#{@project[:value][:name]}-PR#{@number}" if @project[:value][:name]
+    end
+
+    # Apply any specified changes to each job
+    def update_jobs!
+      @jobs.each_value do |job|
+        name = job[:name]
+        changes = nil
+        # Search the generator for changes
+        @generator[:value][:jobs].each do |gen|
+          changes = gen[name.to_sym] if gen.is_a?(Hash) && gen.keys[0] == name.to_sym
+        end
+        # Apply changes
+        Utils.hash_merge!(job[:value], changes) unless changes.nil?
+      end
+    end
+  end
+end