jenkins_pipeline_builder 0.7.6 → 0.8.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 27bfce0d8e1ed49ce1f7d1712159c7085aab313e
-  data.tar.gz: d441dec1b686f09b8fc0a31f8f29c429ff2c33b4
+  metadata.gz: 2ca43becc8a1b41d7db4b5eed240b85f9924ab91
+  data.tar.gz: cb8dc5088ab19da3cde68b8b09782d8e002b662b
 SHA512:
-  metadata.gz: 73cf874e69635ebcb6e463d190bca2672c9f05dfbde153167abb70e4e333d55cc4aa122ae7c3518e36998d444162c548d41231440a85d4cf35609958d77224da
-  data.tar.gz: 572698d42843aa3a019ac5a3642f87282450e3c9bc0d69d146b17de3d21a9e2aca784b096b1073d38f255f75ea876bd9f2c2da1771f7e8473d454f29123f1863
+  metadata.gz: 550a353d6674f1efd02be4a10bcb242684ae0e0e2675b419deabdc5b68cbfcb9923d87159f273b02f540a9a572dae9d4c34e3ffbf761970209fe7ed3f321d70a
+  data.tar.gz: 7e2e5a8ef0954ec7b947444bae305a24e965439c369e9d9a96af10ec3e4cf74aaa836a79a07aa034c45aa4654e0b02dc73763e95cfc1c2cb635302aabd9b1f20

data/.rubocop.yml

@@ -7,7 +7,7 @@
 
 #######
 # WIP
-Style/CyclomaticComplexity:
+Metrics/CyclomaticComplexity:
   Max: 9
 
 Metrics/PerceivedComplexity:
@@ -16,14 +16,14 @@ Metrics/PerceivedComplexity:
 ########
 # Fix these later
 # Configuration parameters: CountComments.
-Style/ClassLength:
+Metrics/ClassLength:
   #Enabled: false
   Max: 500
 
 #######
 # Finalized settings
 
-Style/LineLength:
+Metrics/LineLength:
   Max: 120
   Exclude:
     - 'spec/lib/jenkins_pipeline_builder/compiler_spec.rb'
@@ -32,7 +32,7 @@ Style/LineLength:
     - 'lib/jenkins_pipeline_builder/extensions/*'
 
 # Configuration parameters: CountComments.
-Style/MethodLength:
+Metrics/MethodLength:
   Max: 25
 
 Style/Documentation:

data/README.md

@@ -73,7 +73,6 @@ Now you ready to bootstrap a pipeline:
     generate pipeline -c config/login.yml bootstrap ./pipeline
 
 NOTE: you can run the pipeline in NOOP (debug-only) mode by addind -d parameter, like:
-
     generate pipeline -d -c config/login.yml bootstrap ./pipeline
 
 The command comes with fairly extensive help. For example you can list all of the registered extension types with `generate list` and a list of all extensions of a type with `generate list type`
@@ -359,6 +358,7 @@ publisher do
   min_version '0.4'
   jenkins_name "Jenkins UI Name"
   description "Description of this feature"
+  params[:thing, :value]
 
   xml do |params, xml|
    send("new_element") do
@@ -371,6 +371,57 @@ publisher do
 end
 ```
 
+You can also declare multiple versions of an extension. Some plugins have breaking xml changes between versions. Simply declare a version block with the minimum required version and then declare your xml, before and after blocks inside that version.
+
+```ruby
+publisher do
+  name :yaml_name
+  plugin_id 123
+  min_version '0.4'
+  jenkins_name "Jenkins UI Name"
+  description "Description of this feature"
+
+  version '0' do
+    before do
+      # preprocessing here
+    end
+
+    after do
+      # post processing here
+    end
+
+    xml do |params, xml|
+     send("new.element") do
+        property params[:value]
+        if params[:thing]
+          thing 'true'
+        end
+      end
+    end
+  end
+
+  version '1.0' do
+    before do
+      # preprocessing here
+    end
+
+    after do
+      # post processing here
+    end
+
+    xml do |params, xml|
+     send("different.element") do
+        property params[:value]
+        if params[:thing]
+          thing 'true'
+        end
+      end
+    end
+  end
+end
+```
+
+
 Finally, you can add the new DSL in your YAML:
 
 ```yaml

data/lib/jenkins_pipeline_builder/extensions.rb

@@ -139,7 +139,19 @@ module JenkinsPipelineBuilder
       blocks.merge other_set.blocks
     end
 
+    def parameters(params)
+      version = @min_version || '0'
+
+      blocks[version] = {} unless blocks[version]
+      blocks[version][:parameters] = params
+    end
+
     def xml(path: false, version: '0', &block)
+      if @min_version
+        version = @min_version
+      elsif version != '0'
+        deprecation_warning(settings[:name], 'xml')
+      end
       unless block
         fail "no block found for version #{version}" unless blocks.key version
         return blocks[version][:block]
@@ -151,8 +163,19 @@ module JenkinsPipelineBuilder
       end
     end
 
+    def version(ver, &block)
+      @min_version = ver
+      yield block
+    end
+
     [:after, :before].each do |method_name|
       define_method method_name do |version: '0', &block|
+        if @min_version
+          version = @min_version
+        elsif version != '0'
+          deprecation_warning(settings[:name], method_name)
+        end
+
         return instance_variable_get(method_name) unless block
         blocks[version] = {} unless blocks[version]
         blocks[version][method_name] = block
@@ -172,6 +195,12 @@ module JenkinsPipelineBuilder
       end
       errors
     end
+
+    private
+
+    def deprecation_warning(name, block)
+      puts "WARNING: #{name} set the version in the #{block} block, this is deprecated. Please use a version block."
+    end
   end
 end
 
@@ -188,7 +217,8 @@ module JenkinsPipelineBuilder
       type: false,
       before: false,
       after: false,
-      xml: false
+      xml: false,
+      parameters: []
     }
     EXT_METHODS.keys.each do |method_name|
       define_method method_name do |value = nil|

data/lib/jenkins_pipeline_builder/extensions/job_attributes.rb

@@ -60,88 +60,118 @@ job_attribute do
   jenkins_name "Git (inside 'Source Code Management')"
   announced false
 
-  # XML preprocessing
-  # TODO: Actually figure out how to merge using the builder DSL
-  # This delete the things we are going to add later is pretty crappy
-  # Alternately don't use/tweak the xml the api client generates
-  # (which is where I assume this is coming from)
-  before do |params|
-    xpath('//scm/localBranch').remove if params[:local_branch]
-    xpath('//scm/recursiveSubmodules').remove if params[:recursive_update]
-    xpath('//scm/wipeOutWorkspace').remove if params[:wipe_workspace]
-    xpath('//scm/excludedUsers').remove if params[:excluded_users]
-    if params[:remote_name] || params[:refspec]
-      remote_url = xpath('//scm/userRemoteConfigs/hudson.plugins.git.UserRemoteConfig/url').first
-      params[:remote_url] = remote_url.content if remote_url
-      xpath('//scm/userRemoteConfigs').remove
+  version '0' do
+    parameters [
+      :remote_name,
+      :refspec,
+      :local_branch,
+      :recursive_update,
+      :wipe_workspace,
+      :excluded_users,
+      :skip_tag,
+      :remote_url,
+      :excluded_regions,
+      :included_regions
+    ]
+
+    # XML preprocessing
+    # TODO: Actually figure out how to merge using the builder DSL
+    # This delete the things we are going to add later is pretty crappy
+    # Alternately don't use/tweak the xml the api client generates
+    # (which is where I assume this is coming from)
+    before do |params|
+      xpath('//scm/localBranch').remove if params[:local_branch]
+      xpath('//scm/recursiveSubmodules').remove if params[:recursive_update]
+      xpath('//scm/wipeOutWorkspace').remove if params[:wipe_workspace]
+      xpath('//scm/excludedUsers').remove if params[:excluded_users]
+      if params[:remote_name] || params[:refspec]
+        remote_url = xpath('//scm/userRemoteConfigs/hudson.plugins.git.UserRemoteConfig/url').first
+        params[:remote_url] = remote_url.content if remote_url
+        xpath('//scm/userRemoteConfigs').remove
+      end
+      xpath('//scm/skipTag').remove if params[:skip_tag]
+      xpath('//scm/excludedRegions').remove if params[:excluded_regions]
+      xpath('//scm/includedRegions').remove if params[:included_regions]
     end
-    xpath('//scm/skipTag').remove if params[:skip_tag]
-    xpath('//scm/excludedRegions').remove if params[:excluded_regions]
-    xpath('//scm/includedRegions').remove if params[:included_regions]
-  end
 
-  before version: '2.0' do |params|
-    if params[:remote_name] || params[:refspec]
-      remote_url = xpath('//scm/userRemoteConfigs/hudson.plugins.git.UserRemoteConfig/url').first
-      params[:remote_url] = remote_url.content if remote_url
-      xpath('//scm/userRemoteConfigs').remove
+    xml path: '//scm' do |params|
+      localBranch params[:local_branch] if params[:local_branch]
+      recursiveSubmodules params[:recursive_update] if params[:recursive_update]
+      wipeOutWorkspace params[:wipe_workspace] if params[:wipe_workspace]
+      excludedUsers params[:excluded_users] if params[:excluded_users]
+      if params[:remote_name] || params[:refspec]
+        userRemoteConfigs do
+          send('hudson.plugins.git.UserRemoteConfig') do
+            name params[:remote_name] if params[:remote_name]
+            refspec params[:refspec] if params[:refspec]
+            url params[:remote_url] if params[:remote_url]
+          end
+        end
+      end
+      skipTag params[:skip_tag] if params[:skip_tag]
+      excludedRegions params[:excluded_regions] if params[:excluded_regions]
+      includedRegions params[:included_regions] if params[:included_regions]
     end
   end
 
-  xml path: '//scm' do |params|
-    localBranch params[:local_branch] if params[:local_branch]
-    recursiveSubmodules params[:recursive_update] if params[:recursive_update]
-    wipeOutWorkspace params[:wipe_workspace] if params[:wipe_workspace]
-    excludedUsers params[:excluded_users] if params[:excluded_users]
-    if params[:remote_name] || params[:refspec]
+  version '2.0' do
+    parameters [
+      :credentials_id,
+      :excluded_regions,
+      :excluded_users,
+      :included_regions,
+      :local_branch,
+      :recursive_update,
+      :refspec,
+      :remote_name,
+      :remote_url,
+      :wipe_workspace
+    ]
+
+    before do |params|
+      if params[:remote_name] || params[:refspec]
+        remote_url = xpath('//scm/userRemoteConfigs/hudson.plugins.git.UserRemoteConfig/url').first
+        params[:remote_url] = remote_url.content if remote_url
+        xpath('//scm/userRemoteConfigs').remove
+      end
+    end
+
+    xml path: '//scm' do |params|
+      configVersion 2
       userRemoteConfigs do
         send('hudson.plugins.git.UserRemoteConfig') do
           name params[:remote_name] if params[:remote_name]
           refspec params[:refspec] if params[:refspec]
           url params[:remote_url] if params[:remote_url]
+          credentialsId params[:credentials_id] if params[:credentials_id]
         end
       end
-    end
-    skipTag params[:skip_tag] if params[:skip_tag]
-    excludedRegions params[:excluded_regions] if params[:excluded_regions]
-    includedRegions params[:included_regions] if params[:included_regions]
-  end
-
-  xml version: '2.0', path: '//scm' do |params|
-    configVersion 2
-    userRemoteConfigs do
-      send('hudson.plugins.git.UserRemoteConfig') do
-        name params[:remote_name] if params[:remote_name]
-        refspec params[:refspec] if params[:refspec]
-        url params[:remote_url] if params[:remote_url]
-        credentialsId params[:credentials_id] if params[:credentials_id]
-      end
-    end
-    doGenerateSubmoduleConfigurations false
-    submoduleCfg
-    extensions do
-      send('hudson.plugins.git.extensions.impl.WipeWorkspace') if params[:wipe_workspace]
-      if params[:local_branch]
-        send('hudson.plugins.git.extensions.impl.LocalWorkspace') do
-          localBranch params[:local_branch]
+      doGenerateSubmoduleConfigurations false
+      submoduleCfg
+      extensions do
+        send('hudson.plugins.git.extensions.impl.WipeWorkspace') if params[:wipe_workspace]
+        if params[:local_branch]
+          send('hudson.plugins.git.extensions.impl.LocalWorkspace') do
+            localBranch params[:local_branch]
+          end
         end
-      end
-      if params[:recursive_update]
-        send('hudson.plugins.git.extensions.impl.SubmoduleOption') do
-          disableSubmodules false
-          recursiveSubmodules true
-          trackingSubmodules false
+        if params[:recursive_update]
+          send('hudson.plugins.git.extensions.impl.SubmoduleOption') do
+            disableSubmodules false
+            recursiveSubmodules true
+            trackingSubmodules false
+          end
         end
-      end
-      if params[:excluded_users]
-        send('hudson.plugins.git.extensions.impl.UserExclusion') do
-          excludedUser params[:excluded_users]
+        if params[:excluded_users]
+          send('hudson.plugins.git.extensions.impl.UserExclusion') do
+            excludedUser params[:excluded_users]
+          end
         end
-      end
-      if params[:included_regions] || params[:excluded_regions]
-        send('hudson.plugins.git.extensions.impl.PathRestrictions') do
-          includedRegions params[:included_regions] if params[:included_regions]
-          excludedRegions params[:excluded_regions] if params[:excluded_regions]
+        if params[:included_regions] || params[:excluded_regions]
+          send('hudson.plugins.git.extensions.impl.PathRestrictions') do
+            includedRegions params[:included_regions] if params[:included_regions]
+            excludedRegions params[:excluded_regions] if params[:excluded_regions]
+          end
         end
       end
     end

data/lib/jenkins_pipeline_builder/extensions/wrappers.rb

@@ -26,6 +26,7 @@ wrapper do
   announced false
   jenkins_name 'Color ANSI Console Output'
   description 'This plugin adds support for ANSI escape sequences, including color, to Console Output.'
+  parameters false
   xml do |_|
     send('hudson.plugins.ansicolor.AnsiColorBuildWrapper') do
       colorMapName 'xterm'
@@ -53,26 +54,30 @@ wrapper do
   announced false
   description 'rvm plugin'
 
-  xml version: '0.5' do |wrapper|
-    send('ruby-proxy-object') do
-      send('ruby-object', 'ruby-class' => 'Jenkins::Tasks::BuildWrapperProxy', 'pluginid' => 'rvm') do
-        object('ruby-class' => 'RvmWrapper', 'pluginid' => 'rvm') do
-          impl('pluginid' => 'rvm', 'ruby-class' => 'String') { text wrapper }
+  version '0.5' do
+    xml do |wrapper|
+      send('ruby-proxy-object') do
+        send('ruby-object', 'ruby-class' => 'Jenkins::Tasks::BuildWrapperProxy', 'pluginid' => 'rvm') do
+          object('ruby-class' => 'RvmWrapper', 'pluginid' => 'rvm') do
+            impl('pluginid' => 'rvm', 'ruby-class' => 'String') { text wrapper }
+          end
+          pluginid(:pluginid => 'rvm', 'ruby-class' => 'String') { text 'rvm' }
         end
-        pluginid(:pluginid => 'rvm', 'ruby-class' => 'String') { text 'rvm' }
       end
     end
   end
 
-  xml do |wrapper|
-    send('ruby-proxy-object') do
-      send('ruby-object', 'ruby-class' => 'Jenkins::Plugin::Proxies::BuildWrapper', 'pluginid' => 'rvm') do
-        object('ruby-class' => 'RvmWrapper', 'pluginid' => 'rvm') do
-          impl('pluginid' => 'rvm', 'ruby-class' => 'String') do
-            text wrapper
+  version '0' do
+    xml do |wrapper|
+      send('ruby-proxy-object') do
+        send('ruby-object', 'ruby-class' => 'Jenkins::Plugin::Proxies::BuildWrapper', 'pluginid' => 'rvm') do
+          object('ruby-class' => 'RvmWrapper', 'pluginid' => 'rvm') do
+            impl('pluginid' => 'rvm', 'ruby-class' => 'String') do
+              text wrapper
+            end
           end
+          pluginid(:pluginid => 'rvm', 'ruby-class' => 'String') { text 'rvm' }
         end
-        pluginid(:pluginid => 'rvm', 'ruby-class' => 'String') { text 'rvm' }
       end
     end
   end

data/lib/jenkins_pipeline_builder/generator.rb

@@ -523,7 +523,7 @@ module JenkinsPipelineBuilder
       end
 
       xml = client.job.build_freestyle_config(params)
-      n_xml = Nokogiri::XML(xml)
+      n_xml = Nokogiri::XML(xml, &:noblanks)
 
       logger.debug 'Loading the required modules'
       @module_registry.traverse_registry_path('job', params, n_xml)

data/lib/jenkins_pipeline_builder/module_registry.rb

@@ -93,7 +93,8 @@ module JenkinsPipelineBuilder
         if reg_value.is_a? ExtensionSet
           ext = reg_value.extension
           logger.debug "Using #{ext.type} #{ext.name} version #{ext.min_version}"
-          execute_extension ext, value, n_xml
+          success = execute_extension ext, value, n_xml
+          fail 'Encountered errors compiling the xml' unless success
         elsif value.is_a? Hash
           traverse_registry reg_value, value, n_xml, true
         elsif value.is_a? Array
@@ -105,12 +106,28 @@ module JenkinsPipelineBuilder
     end
 
     def execute_extension(extension, value, n_xml)
+      errors = []
+      params = extension.parameters
+      if params == false || params.any?
+        if value.is_a? Hash
+          value.each_key do |key|
+            next if params && params.include?(key)
+            errors << "Extension #{extension.name} does not support parameter #{key}"
+          end
+        end
+      end
+      errors.each do |error|
+        logger.error error
+      end
+      return false if errors.any?
+
       n_builders = n_xml.xpath(extension.path).first
       n_builders.instance_exec(value, &extension.before) if extension.before
       Nokogiri::XML::Builder.with(n_builders) do |xml|
         xml.instance_exec value, &extension.xml
       end
       n_builders.instance_exec(value, &extension.after) if extension.after
+      true
     end
   end
 end

data/lib/jenkins_pipeline_builder/version.rb

@@ -21,5 +21,5 @@
 #
 
 module JenkinsPipelineBuilder
-  VERSION = '0.7.6'
+  VERSION = '0.8.0'
 end

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

@@ -91,7 +91,12 @@ describe 'job_attributes' do
             recursive_update: true,
             excluded_users: :exclude_me,
             included_regions: :included_region,
-            excluded_regions: :excluded_region
+            excluded_regions: :excluded_region,
+            wipe_workspace: true,
+            remote_name: :foo,
+            refspec: :refspec,
+            remote_url: :remote_url,
+            credentials_id: :creds
           },
           scm_url: 'http://foo.com'
         }
@@ -107,6 +112,10 @@ describe 'job_attributes' do
         expect(scm_config.css('excludedUser').first).to be_truthy
         expect(scm_config.css('includedRegions').first).to be_truthy
         expect(scm_config.css('excludedRegions').first).to be_truthy
+        expect(scm_config.css('credentialsId').first).to be_truthy
+        expect(
+          scm_config.xpath('//scm/extensions/hudson.plugins.git.extensions.impl.WipeWorkspace').first
+        ).to_not be_nil
 
         expect(scm_config.css('disableSubmodules').first.content).to eq 'false'
         expect(scm_config.css('recursiveSubmodules').first.content).to eq 'true'
@@ -115,6 +124,7 @@ describe 'job_attributes' do
         expect(scm_config.css('excludedUser').first.content).to eq 'exclude_me'
         expect(scm_config.css('includedRegions').first.content).to eq 'included_region'
         expect(scm_config.css('excludedRegions').first.content).to eq 'excluded_region'
+        expect(scm_config.css('credentialsId').first.content).to eq 'creds'
       end
     end
 

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

@@ -0,0 +1,62 @@
+require File.expand_path('../../spec_helper', __FILE__)
+
+describe 'wrappers' do
+  after :each do
+    JenkinsPipelineBuilder.registry.clear_versions
+  end
+
+  before :all do
+    JenkinsPipelineBuilder.credentials = {
+      server_ip: '127.0.0.1',
+      server_port: 8080,
+      username: 'username',
+      password: 'password',
+      log_location: '/dev/null'
+    }
+  end
+
+  before :each do
+    builder = Nokogiri::XML::Builder.new { |xml| xml.buildWrappers }
+    @n_xml = builder.doc
+  end
+
+  after :each do |example|
+    name = example.description.gsub ' ', '_'
+    File.open("./out/xml/wrapper_#{name}.xml", 'w') { |f| @n_xml.write_xml_to f }
+  end
+
+  context 'ansicolor' do
+    before :each do
+      JenkinsPipelineBuilder.registry.registry[:job][:wrappers][:ansicolor].installed_version = '0.0'
+    end
+
+    it 'generates correct xml' do
+      JenkinsPipelineBuilder.registry.traverse_registry_path('job', { wrappers: { ansicolor: true } }, @n_xml)
+
+      node = @n_xml.root.xpath('//buildWrappers/hudson.plugins.ansicolor.AnsiColorBuildWrapper')
+      expect(node.first).to be_truthy
+      expect(node.first.content).to eq 'xterm'
+    end
+
+    it 'fails parameters are passed' do
+      params = { wrappers: { ansicolor: { config: false } } }
+      expect do
+        JenkinsPipelineBuilder.registry.traverse_registry_path('job', params, @n_xml)
+      end.to raise_error
+    end
+  end
+
+  context 'timestamp' do
+    before :each do
+      JenkinsPipelineBuilder.registry.registry[:job][:wrappers][:timestamp].installed_version = '0.0'
+    end
+
+    it 'generates correct xml' do
+      JenkinsPipelineBuilder.registry.traverse_registry_path('job', { wrappers: { timestamp: true } }, @n_xml)
+
+      node = @n_xml.root.xpath('//buildWrappers/hudson.plugins.timestamper.TimestamperBuildWrapper')
+      expect(node.first).to_not be_nil
+    end
+  end
+
+end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: jenkins_pipeline_builder
 version: !ruby/object:Gem::Version
-  version: 0.7.6
+  version: 0.8.0
 platform: ruby
 authors:
 - Igor Moochnick
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2014-09-23 00:00:00.000000000 Z
+date: 2014-09-24 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: nokogiri
@@ -359,6 +359,7 @@ files:
 - spec/lib/jenkins_pipeline_builder/extensions/builders_spec.rb
 - spec/lib/jenkins_pipeline_builder/extensions/job_attributes_spec.rb
 - spec/lib/jenkins_pipeline_builder/extensions/publishers_spec.rb
+- spec/lib/jenkins_pipeline_builder/extensions/wrappers_spec.rb
 - spec/lib/jenkins_pipeline_builder/extensions_spec.rb
 - spec/lib/jenkins_pipeline_builder/fixtures/generator_tests/pullrequest_pipeline/PullRequest-10-SampleJob.yaml
 - spec/lib/jenkins_pipeline_builder/fixtures/generator_tests/pullrequest_pipeline/PullRequest-40-PullRequestGenerator.yaml
@@ -410,6 +411,7 @@ test_files:
 - spec/lib/jenkins_pipeline_builder/extensions/builders_spec.rb
 - spec/lib/jenkins_pipeline_builder/extensions/job_attributes_spec.rb
 - spec/lib/jenkins_pipeline_builder/extensions/publishers_spec.rb
+- spec/lib/jenkins_pipeline_builder/extensions/wrappers_spec.rb
 - spec/lib/jenkins_pipeline_builder/extensions_spec.rb
 - spec/lib/jenkins_pipeline_builder/fixtures/generator_tests/pullrequest_pipeline/PullRequest-10-SampleJob.yaml
 - spec/lib/jenkins_pipeline_builder/fixtures/generator_tests/pullrequest_pipeline/PullRequest-40-PullRequestGenerator.yaml