jenkins_pipeline_builder 0.4.2 → 0.5.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: dd3fbe192beffd805980b40fc49e45a17fc91573
-  data.tar.gz: 985c10461b9cda3e85736c37a448072d1c360b11
+  metadata.gz: 074e6a33bccd22a77790d7785fa41e3aed3b0643
+  data.tar.gz: bb21d846871e41518155c1569384de9d0a17377f
 SHA512:
-  metadata.gz: 9bcc9b579331bddee28a89bfa86e8a0f312dc071ae3e38b31c213d932f6b8744a44bc1dae8381fa552ea166c3a4eb661e22cc5d1e526375812898d9889246062
-  data.tar.gz: d52753724255e12b3662c441278d69a1423095d5661a415577f8578630a5c162c3934f0b8115cfaa657c77d094dc67c524eb4bd4deebb7dadd7a645cd31e6fc3
+  metadata.gz: 4c5c5d2102413b49a1f9cedbba8a7ee84541ddd2701cb69bc5e8305b2192f3f61a300332c729b6cf3c89e5ade81f79b25fc6abc2aafaf6716f6e3cdb71c5d331
+  data.tar.gz: 3a79067cc83f4e015200af29b2a8255c2d7f6b881cd2b8eedad5992435b4d95e5cbba4c170f8fc080a98876f05b857595ef626b3459148206b0741cc32acaa2a

data/.rubocop.yml

@@ -0,0 +1,65 @@
+# This configuration was generated by `rubocop --auto-gen-config`
+# on 2014-06-23 17:07:53 -0400 using RuboCop version 0.23.0.
+# The point is for the user to remove these configuration records
+# one by one as the offenses are removed from the code base.
+# Note that changes in the inspected code, or installation of new
+# versions of RuboCop, may require this file to be generated again.
+
+#######
+# WIP
+# Offense count: 17
+Style/LineLength:
+  Enabled: false
+  Max: 120
+
+# Offense count: 8
+# Configuration parameters: CountComments.
+Style/MethodLength:
+  Enabled: false
+  Max: 30
+
+########
+# Fix these later
+# Offense count: 1
+Lint/Eval:
+  Enabled: false
+
+# Offense count: 6
+Lint/ShadowingOuterLocalVariable:
+  Enabled: false
+
+# Offense count: 2
+# Configuration parameters: EnforcedStyle, SupportedStyles.
+Style/ClassAndModuleChildren:
+  Enabled: false
+
+# Offense count: 6
+# Configuration parameters: CountComments.
+Style/ClassLength:
+  Max: 506
+
+# Offense count: 12
+Style/CyclomaticComplexity:
+  Max: 18
+
+# Offense count: 17
+Style/Documentation:
+  Enabled: false
+
+#######
+# We actually want these off
+
+# Offense count: 2
+Lint/UselessSetterCall:
+  Enabled: false
+
+# Offense count: 9
+# Configuration parameters: EnforcedStyle, SupportedStyles.
+Style/Next:
+  Enabled: false
+
+# Offense count: 7
+# Configuration parameters: EnforcedStyle, SupportedStyles.
+Style/VariableName:
+  Enabled: false
+#######

data/LICENSE

@@ -1,6 +1,6 @@
 The MIT License (MIT)
 
-Copyright (c) 2014 IgorShare
+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

data/README.md

@@ -86,6 +86,7 @@ Here's a high level overview of what's available:
 - job:
     name: nameStr # Name of your Job
     job_type: free_style # Optional  [free_style|multi_project]
+    concurrent_build: true or false
     discard_old: # Discard old builds after:
       days: 1 # Optional, number of days after which the build is deleted
       number: 2 # Optional, number of builds after which the build is deleted
@@ -147,7 +148,7 @@ Here's a high level overview of what's available:
           mavenName: maven-name # Optional
       - remote_job:
           server: 'Name of Server' # Name of the Remote Jenkins Server
-          job_name: name_of_remote_build 
+          job_name: name_of_remote_build
           blocking: true # Block current job until remote job finishes
           polling_interval: 10 # Optional, number of seconds between polls, defaults to 10
           continue_on_remote_failure: false
@@ -160,6 +161,18 @@ Here's a high level overview of what's available:
             type: api_token or none
             username: name_of_user
             api_token: APITOKEN
+      - blocking_downstream:
+          project: nameStr
+          data:
+            - params: |
+                param1
+                param2
+          condition: FAILURE
+          trigger_with_no_parameters: false
+          # Below is Optional, values can be SUCCESS, FAILURE, UNSTABLE, never
+          fail: FAILURE # Fail this build step if the triggered build is worse or equal to
+          mark_fail: SUCCESS # Mark this build as failure if the triggered build is worse or equal to
+          mark_unstable: UNSTABLE # Mark this build as unstable if the triggered build is worse or equal to
     wrappers:
       - timestamp: true
       - ansicolor: true
@@ -170,13 +183,14 @@ Here's a high level overview of what's available:
           snapshot-repo: snapshot
           publish: 'pkg/*.gem'
           publish-build-info: true # Optional
+          properties: key=value;key2=value2,value2.1
       - maven3artifactory:
           url: https://artifactory.com/artifactory
           artifactory-name: name
           release-repo: release
           snapshot-repo: snapshot
           publish-build-info: true # Optional
-      - inject_env_var: 
+      - inject_env_var:
           file: 'foo.prop'
           content: |
             VAR1 = value_1
@@ -230,6 +244,35 @@ Here's a high level overview of what's available:
       }
 ```
 
+### Pull Request Generator
+
+The pull request generator will generate pipelines for pull requests that are noticed on your repo. It will also remove old pipelines from Jenkins if the pull_request is closed.
+If you need to modify job parameters please just specify that in the jobs section like the example below.
+
+When running a project through this module, the project {{name}} is appended with "-PR##" where ## is the number of the pull request.
+
+```yaml
+- job:
+    name: '{{name}}-ReqGen'
+    job_type: pull_request_generator
+    git_url: 'https://www.github.com/'
+    git_repo: 'jenkins_pipeline_builder'
+    git_org: 'IgorShare'
+    jobs:
+      - '{{name}}-Job1':
+          publishers:
+            - downstream:
+                project: '{{name}}-Job2'
+      - '{{name}}-Job2':
+          discard_old:
+            number: '100'
+      - '{{name}}-Job3'
+    builders:
+        - shell_command: |
+            generate -v || gem install jenkins_pipeline_builder
+            generate pipeline pull_request pipeline/ {{name}}
+```
+
 ### View DSL
 ```yaml
 - view:
@@ -265,6 +308,25 @@ If a set of Defaults is specified with the name global, that will be used by all
     param1: 'value 1'
 ```
 
+PLUGINS:
+--------
+
+A number of the DSL options rely on Jenkins plugins, including:
+
+* ansicolor - "AnsiColor"    
+* (view) type: 'categorizedView' - "categorized-view"
+* hipchat - "HipChat Plugin"    
+* inject_env_vars - "Environment Injector Plugin"    
+* priority - "Priority Sorter plugin"    
+* downstream - "Parameterized Trigger plugin"    
+* rvm - "Rvm"    
+* throttle - "Throttle Concurrent Builds Plug-in"    
+* timestamp - "Timestamper"  
+* groovy_postbuild - "Groovy Postbuild"  
+
+Just about every plugin above can be installed through Jenkins (Manage Jenkins > Manage Plugins > Available)
+
+Exceptions:
 
 CONTRIBUTING:
 ----------------

data/Rakefile

@@ -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
@@ -20,15 +20,17 @@
 # THE SOFTWARE.
 #
 
-#!/usr/bin/env rake
 require 'rspec/core/rake_task'
 require 'yard'
+require 'rubocop/rake_task'
 
-RSpec::Core::RakeTask.new(:spec, :tag) do |t, task_args|
-  t.pattern = ".spec/**/*_spec.rb"
-  t.verbose = true
-  t.fail_on_error = false
-  t.rspec_opts = spec_output 'spec.xml'
+RuboCop::RakeTask.new
+
+RSpec::Core::RakeTask.new(:spec, :tag) do |spec|
+  spec.pattern = '.spec/**/*_spec.rb'
+  spec.verbose = true
+  spec.fail_on_error = false
+  spec.rspec_opts = spec_output 'spec.xml'
 end
 
 def spec_output(filename)
@@ -58,13 +60,13 @@ end
 namespace :doc do
   # This task requires that graphviz is installed locally. For more info:
   # http://www.graphviz.org/
-  desc "Generates the class diagram using the yard generated dot file"
+  desc 'Generates the class diagram using the yard generated dot file'
   task :generate_class_diagram do
-    puts "Generating the dot file..."
+    puts 'Generating the dot file...'
     `yard graph --file jenkins_api_client.dot`
-    puts "Generating class diagram from the dot file..."
+    puts 'Generating class diagram from the dot file...'
     `dot jenkins_api_client.dot -Tpng -o jenkins_api_client_class_diagram.png`
   end
 end
 
-task default: :unit_tests
+task default: [:unit_tests, :rubocop]

data/bin/generate

@@ -1,6 +1,6 @@
 #!/usr/bin/env ruby
 #
-# 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,8 +21,6 @@
 # THE SOFTWARE.
 #
 
-
-$LOAD_PATH.unshift(File.expand_path(File.dirname(__FILE__) + "/../lib"))
+$LOAD_PATH.unshift(File.expand_path(File.dirname(__FILE__) + '/../lib'))
 require 'jenkins_pipeline_builder'
 JenkinsPipelineBuilder::CLI::Base.start
-

data/jenkins_pipeline_builder.gemspec

@@ -6,30 +6,32 @@ require 'jenkins_pipeline_builder/version'
 Gem::Specification.new do |spec|
   spec.name          = 'jenkins_pipeline_builder'
   spec.version       = JenkinsPipelineBuilder::VERSION
-  spec.authors       = ['Igor Moochnick']
-  spec.email         = %w(igor.moochnick@gmail.com)
-  spec.description   = %q{This is a simple and easy-to-use Jenkins Pipeline generator with features focused on
-automating Job & Pipeline creation from the YAML files checked-in with your application source code}
-  spec.summary       = %q{This gem is will boostrap your Jenkins pipelines}
-  spec.homepage      = 'https://github.com/IgorShare/jenkins_pipeline_builder'
+  spec.authors       = ['Igor Moochnick', 'Joseph Henrich']
+  spec.email         = %w(igor.moochnick@gmail.com crimsonknave@gmail.com)
+  spec.description   = %q(This is a simple and easy-to-use Jenkins Pipeline generator with features focused on
+automating Job & Pipeline creation from the YAML files checked-in with your application source code)
+  spec.summary       = %q(This gem is will boostrap your Jenkins pipelines)
+  spec.homepage      = 'https://github.com/ConstantContact/jenkins_pipeline_builder'
   spec.license       = 'MIT'
 
-  spec.files         = `git ls-files`.split($/)
-  spec.executables   = spec.files.grep(%r{^bin/}) { |f| File.basename(f) }
-  spec.test_files    = spec.files.grep(%r{^(test|spec|features)/})
-  spec.require_paths = ["lib"]
+  spec.files         = `git ls-files`.split($RS)
+  spec.executables   = spec.files.grep(/^bin\//) { |f| File.basename(f) }
+  spec.test_files    = spec.files.grep(/^(test|spec|features)\//)
+  spec.require_paths = ['lib']
 
-  ENV['NOKOGIRI_USE_SYSTEM_LIBRARIES']='true'
+  ENV['NOKOGIRI_USE_SYSTEM_LIBRARIES'] = 'true'
 
   spec.add_dependency 'nokogiri', '~> 1.5.0'
   spec.add_dependency 'jenkins_api_client', '~> 0.14.1'
   spec.add_dependency 'thor', '>= 0.18.0'
   spec.add_dependency 'activesupport'
+  spec.add_dependency 'archive-tar-minitar'
 
   spec.add_development_dependency 'bundler', '~> 1.3'
   spec.add_development_dependency 'rake'
   spec.add_development_dependency 'rspec', '~> 2.14'
   spec.add_development_dependency 'bump'
+  spec.add_development_dependency 'json'
   spec.add_development_dependency 'gem-release'
   spec.add_development_dependency 'pry'
   spec.add_development_dependency 'simplecov'
@@ -40,4 +42,5 @@ automating Job & Pipeline creation from the YAML files checked-in with your appl
   spec.add_development_dependency 'yard'
   spec.add_development_dependency 'rspec_junit_formatter'
   spec.add_development_dependency 'webmock'
+  spec.add_development_dependency 'rubocop'
 end

data/lib/jenkins_pipeline_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
@@ -30,6 +30,7 @@ require 'jenkins_pipeline_builder/builders'
 require 'jenkins_pipeline_builder/wrappers'
 require 'jenkins_pipeline_builder/triggers'
 require 'jenkins_pipeline_builder/publishers'
+require 'jenkins_pipeline_builder/pull_request'
 require 'jenkins_pipeline_builder/view'
 require 'jenkins_pipeline_builder/generator'
 

data/lib/jenkins_pipeline_builder/builders.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
@@ -24,57 +24,114 @@ module JenkinsPipelineBuilder
   class Builders
     def self.build_multijob(params, xml)
       params[:phases].each do |name, content|
-        xml.send('com.tikal.jenkins.plugins.multijob.MultiJobBuilder') {
+        xml.send('com.tikal.jenkins.plugins.multijob.MultiJobBuilder') do
           xml.phaseName name
-          xml.phaseJobs {
+          xml.phaseJobs do
             content[:jobs].each do |job|
-              xml.send('com.tikal.jenkins.plugins.multijob.PhaseJobsConfig') {
+              xml.send('com.tikal.jenkins.plugins.multijob.PhaseJobsConfig') do
                 xml.jobName job[:name]
                 xml.currParams job[:current_params] || false
                 xml.exposedSCM job[:exposed_scm] || false
                 if job[:config]
-                  xml.configs {
-                    if job[:config].has_key? :predefined_build_parameters
-                      xml.send('hudson.plugins.parameterizedtrigger.PredefinedBuildParameters') {
+                  xml.configs do
+                    if job[:config].key? :predefined_build_parameters
+                      xml.send('hudson.plugins.parameterizedtrigger.PredefinedBuildParameters') do
                         xml.properties job[:config][:predefined_build_parameters].join "\n"
-                      }
+                      end
                     end
-                  }
+                  end
                 end
-              }
+              end
             end
-          }
+          end
           xml.continuationCondition content[:continue_condition] || 'SUCCESSFUL'
-        }
+        end
       end
     end
 
     def self.build_maven3(params, xml)
-      xml.send('org.jfrog.hudson.maven3.Maven3Builder') {
+      xml.send('org.jfrog.hudson.maven3.Maven3Builder') do
         xml.mavenName params[:mavenName] || 'tools-maven-3.0.3'
         xml.rootPom params[:rootPom]
         xml.goals params[:goals]
         xml.mavenOpts params[:options]
-      }
+      end
     end
 
     def self.build_shell_command(param, xml)
-      xml.send('hudson.tasks.Shell') {
+      xml.send('hudson.tasks.Shell') do
         xml.command param
-      }
+      end
     end
 
     def self.build_environment_vars_injector(params, xml)
-      xml.EnvInjectBuilder {
-        xml.info {
+      xml.EnvInjectBuilder do
+        xml.info do
           xml.propertiesFilePath params
-        }
-      }
+        end
+      end
+    end
+
+    def self.blocking_downstream(params, xml)
+      colors = { 'SUCCESS' => { ordinal:  0, color:  'BLUE' }, 'FAILURE' => { ordinal:  2, color:  'RED' }, 'UNSTABLE' => { ordinal:  1, color:  'YELLOW' } }
+      xml.send('hudson.plugins.parameterizedtrigger.TriggerBuilder', 'plugin' => 'parameterized-trigger') do
+        xml.configs do
+          xml.send('hudson.plugins.parameterizedtrigger.BlockableBuildTriggerConfig') do
+
+            xml.configs do
+              params[:data] = [{ params: '' }] unless params[:data]
+              params[:data].each do |config|
+                if config[:params]
+                  xml.send('hudson.plugins.parameterizedtrigger.PredefinedBuildParameters') do
+                    xml.properties config[:params]
+                  end
+                end
+                if config[:file]
+                  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
+            xml.block do
+              if params[:fail] && colors.include?(params[:fail])
+                xml.buildStepFailureThreshold do
+                  xml.name params[:fail]
+                  xml.ordinal colors[params[:fail]][:ordinal]
+                  xml.color colors[params[:fail]][:color]
+                  xml.completeBuild 'true'
+                end
+              end
+              if params[:mark_fail] && colors.include?(params[:mark_fail])
+                xml.failureThreshold do
+                  xml.name params[:mark_fail]
+                  xml.ordinal colors[params[:mark_fail]][:ordinal]
+                  xml.color colors[params[:mark_fail]][:color]
+                  xml.completeBuild 'true'
+                end
+              end
+              if params[:mark_unstable] && colors.include?(params[:mark_unstable])
+                xml.unstableThreshold do
+                  xml.name params[:mark_unstable]
+                  xml.ordinal colors[params[:mark_unstable]][:ordinal]
+                  xml.color colors[params[:mark_unstable]][:color]
+                  xml.completeBuild 'true'
+                end
+              end
+            end
+            xml.buildAllNodesWithLabel false
+          end
+        end
+      end
     end
 
     def self.start_remote_job(params, xml)
       parameters = params[:parameters][:content].split("\n") if params[:parameters] && params[:parameters][:content]
-      xml.send('org.jenkinsci.plugins.ParameterizedRemoteTrigger.RemoteBuildConfiguration', 'plugin'=>'Parameterized-Remote-Trigger'){
+      xml.send('org.jenkinsci.plugins.ParameterizedRemoteTrigger.RemoteBuildConfiguration', 'plugin' => 'Parameterized-Remote-Trigger') do
         xml.remoteJenkinsName params[:server]
         xml.job params[:job_name]
         xml.shouldNotFailBuild params[:continue_on_remote_failure] if params[:continue_on_remote_failure]
@@ -83,36 +140,35 @@ module JenkinsPipelineBuilder
         xml.token
         if params[:parameters] && params[:parameters][:content]
           xml.parameters parameters.join("\n")
-          xml.parameterList{
+          xml.parameterList do
             parameters.each do |p|
               xml.string p
             end
-          }
+          end
         elsif params[:parameters] && params[:parameters][:file]
-          xml.loadParamsFromFile 'true' 
+          xml.loadParamsFromFile 'true'
           xml.parameterFile params[:parameters][:file]
         else
           xml.parameters
-          xml.parameterList{
+          xml.parameterList do
             xml.string
-          }
+          end
         end
         if params[:credentials] && params[:credentials][:type]
           xml.overrideAuth 'true'
-          xml.auth{
-            xml.send('org.jenkinsci.plugins.ParameterizedRemoteTrigger.Auth'){
-              if params[:credentials][:type]=="api_token"
+          xml.auth do
+            xml.send('org.jenkinsci.plugins.ParameterizedRemoteTrigger.Auth') do
+              if params[:credentials][:type] == 'api_token'
                 xml.authType 'apiToken'
                 xml.username params[:credentials][:username]
                 xml.API__TOKEN params[:credentials][:api_token]
               else
                 xml.authType 'none'
               end
-            }
-          }
+            end
+          end
         end
-      }
+      end
     end
-
   end
 end