jenkins_pipeline_builder 0.6.0 → 0.7.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 7732d073bba8e738befc23bd6c71249ccbf23ff5
-  data.tar.gz: 122b6fe751d205a6b108fab75ac549efa987444f
+  metadata.gz: 1b24c99f73cecb047e1f58cd328000f81ee3b31c
+  data.tar.gz: 43f6ce844efe1ed19940d3e8d0dfaab50b243d79
 SHA512:
-  metadata.gz: 8a880f17364c6d7a44aefd11f6cadabb9b4aaf8107d539accc2c81ffd61c9cc33dafe277d2508e5d463c11b062ae88fc83708f7920aad5f360163fefd9631609
-  data.tar.gz: b0e8b310565ba4327071029011a7a734d9383c04a1275a2587d753a70715cb5385355bbb7354233c71e93157b9eebcc9843ed078f37fd191c541b366a1ad2ee9
+  metadata.gz: 82bce578c0a059d5cbee047fcd984bbe765174ed58e96601c721b41eb806583e4301959822a6bbe1e729dbdce2636b99d30d9ae00ec877171b1b9b490ecd59c0
+  data.tar.gz: 60bc6c5d94f07227b5750813455267f80c05f2dc7a677bfb972829acd6f32d17e7673eb1b211a3ac849bc085b8d8f6d0682e023a4081e5b74bc2f8fd32848ef5

data/.rubocop.yml

@@ -26,6 +26,7 @@ Style/LineLength:
     - 'spec/lib/jenkins_pipeline_builder/compiler_spec.rb'
     - 'spec/lib/jenkins_pipeline_builder/view_spec.rb'
     - 'spec/lib/jenkins_pipeline_builder/pull_request_spec.rb'
+    - 'lib/jenkins_pipeline_builder/extensions/*'
 
 # Configuration parameters: CountComments.
 Style/MethodLength:
@@ -37,18 +38,9 @@ Style/Documentation:
 # Configuration parameters: EnforcedStyle, SupportedStyles.
 Style/Next:
   Exclude:
-    - 'lib/jenkins_pipeline_builder/publishers.rb'
-    - 'lib/jenkins_pipeline_builder/triggers.rb'
-    - 'lib/jenkins_pipeline_builder/wrappers.rb'
-    - 'lib/jenkins_pipeline_builder/builders.rb'
-    - 'lib/jenkins_pipeline_builder/job_builder.rb'
+    - 'lib/jenkins_pipeline_builder/extensions/*'
 
 # Configuration parameters: EnforcedStyle, SupportedStyles.
 Style/VariableName:
   Exclude:
-    - 'lib/jenkins_pipeline_builder/publishers.rb'
-    - 'lib/jenkins_pipeline_builder/triggers.rb'
-    - 'lib/jenkins_pipeline_builder/wrappers.rb'
-    - 'lib/jenkins_pipeline_builder/builders.rb'
-    - 'lib/jenkins_pipeline_builder/job_builder.rb'
-#######
+    - 'lib/jenkins_pipeline_builder/extensions/*'

data/README.md

@@ -15,7 +15,7 @@ amazing progress done by the Open Stack community with their [jenkins-job-builde
 The YAML structure very closely resembles the OpenStack Job Builder, but, in comparison to Python version, is 100%
 pure Ruby and uses Jenkins API Client and has additional functionlity of building different types of Jenkins views.
 
-# JenkinsPipeline::Generator
+# JenkinsPipelineBuilder
 
 USAGE:
 ------
@@ -76,6 +76,8 @@ NOTE: you can run the pipeline in NOOP (debug-only) mode by addind -d parameter,
 
     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`
+
 DSL:
 ----
 
@@ -282,7 +284,7 @@ When running a project through this module, the project {{name}} is appended wit
     job_type: pull_request_generator
     git_url: 'https://www.github.com/'
     git_repo: 'jenkins_pipeline_builder'
-    git_org: 'IgorShare'
+    git_org: 'constantcontact'
     jobs:
       - '{{name}}-Job1':
           publishers:
@@ -338,39 +340,27 @@ Extending the Pipeline Builder
 
 Have a feature you want to test out before adding it to the source? Now you can create a quick "extension" to the pipeline builder to add new or overwrite existing functionality.
 
-To add an extension, create an "extensions" directiroy inside of "pipeline" and create a file named "myExtension.rb" (or any name). Use `JenkinsPipelineBuilder.extend` to register your extension.
-
-When registering, you must use one of the following register methods, depending on what category your change falls into:
-* register_job_attribute    
-* register_builder    
-* register_publisher    
-* register_wrapper    
-* register_trigger    
+To add an extension, create an "extensions" directiroy inside of "pipeline" and create a file named "my_extension.rb" (or any name). Then just `require 'jenkins_pipeline_builder/extensions'` and you can begin using the extension DSL. All of the plugins use this DSL and provide an excellent source of examples. You can find them in lib/jenkins_pipeline_builder/extensions.
 
 For help figuring out what category your change is, examine the config.xml for a job that uses your feature. If it is a first child of the root "project" node, your change is a job_attribute. Otherwise it should be either a builder, publisher, wrapper, or trigger, depending what child node it is found in the XML tree.
 
 Here is an example of extending the pipeline builder with a new publisher:
 
 ```ruby
-JenkinsPipelineBuilder.extend do |registry|
-  registry.register_publisher :yaml_name, "Jenkins UI Name", "Description of this feature" { |params, xml| apply_extension(params, xml) }
-
-  def apply_extension(params, xml)
-    xml.send("new_element") {
-      xml.property params[:value]
-    }
-  end
-end
-```
-
-OR
-
-```ruby
-JenkinsPipelineBuilder.extend do |registry|
-  registry.register_publisher :yaml_name, "Jenkins UI Name", "Description of this feature" do |params, xml|
-    xml.send("new_element") {
-      xml.property params[:value]
-    }
+publisher do
+  name :yaml_name
+  plugin_id 123
+  min_version '0.4'
+  jenkins_name "Jenkins UI Name"
+  description "Description of this feature"
+
+  xml do |params, xml|
+   send("new_element") do
+      property params[:value]
+      if params[:thing]
+        thing 'true'
+      end
+    end
   end
 end
 ```

data/commit_build.sh

@@ -1,7 +1,4 @@
 #!/bin/bash
 bundle --version || gem install bundler --no-ri --no-rdoc
 bundle install
-rm -f *.gem
-bundle exec rake spec || exit $?
-bundle exec gem build jenkins_pipeline_builder.gemspec || exit $?
-bundle exec gem bump
+bundle exec rake spec || exit $?

data/lib/jenkins_pipeline_builder.rb

@@ -40,32 +40,28 @@ module JenkinsPipelineBuilder
 
     def credentials=(creds)
       @credentials = creds
-      @client =
-      @_client = JenkinsApi::Client.new(credentials)
-      generator.logger = @_client.logger
+      @client = JenkinsApi::Client.new(credentials)
+      generator.logger = @client.logger
       @credentials
     end
 
     def logger
-      @_client.logger
+      client.logger
     end
 
     def registry
       generator.module_registry
     end
-
-    def load_registry
-      load 'jenkins_pipeline_builder/builders.rb'
-      load 'jenkins_pipeline_builder/job_builder.rb'
-      load 'jenkins_pipeline_builder/wrappers.rb'
-      load 'jenkins_pipeline_builder/publishers.rb'
-      load 'jenkins_pipeline_builder/triggers.rb'
-    end
   end
 end
 JenkinsPipelineBuilder.generator
 require 'jenkins_pipeline_builder/extensions'
-JenkinsPipelineBuilder.load_registry
+require 'jenkins_pipeline_builder/extensions/builders'
+require 'jenkins_pipeline_builder/extensions/job_attributes'
+require 'jenkins_pipeline_builder/extensions/wrappers'
+require 'jenkins_pipeline_builder/extensions/publishers'
+require 'jenkins_pipeline_builder/extensions/triggers'
+
 require 'jenkins_pipeline_builder/cli/helper'
 require 'jenkins_pipeline_builder/cli/view'
 require 'jenkins_pipeline_builder/cli/pipeline'

data/lib/jenkins_pipeline_builder/cli/describe.rb

@@ -22,15 +22,22 @@
 
 module JenkinsPipelineBuilder
   module CLI
-    JenkinsPipelineBuilder.registry.entries.keys.each do |entry|
+    entries = JenkinsPipelineBuilder.registry.entries.keys
+    entries << :job_attributes
+    entries.each do |entry|
       klass_name = entry.to_s.classify
       # rubocop:disable Style/AccessModifierIndentation
       klass = Class.new(Thor) do
 
-        extensions = JenkinsPipelineBuilder.registry.registry[:job][entry]
-        extensions.each do |key, exts|
+        if entry == :job_attributes
+          extensions = JenkinsPipelineBuilder.registry.registry[:job].select { |_, x| x.is_a? ExtensionSet }
+        else
+          extensions = JenkinsPipelineBuilder.registry.registry[:job][entry]
+        end
+
+        extensions.each do |key, extset|
           # TODO: don't just take the first
-          ext = exts.first
+          ext = extset.extensions.first
           desc key, "Details for #{ext.name}"
           define_method(ext.name) do
             display_module(ext)
@@ -47,7 +54,9 @@ module JenkinsPipelineBuilder
       Module.const_set(klass_name, klass)
     end
     class Describe < Thor
-      JenkinsPipelineBuilder.registry.entries.each do |entry, _path|
+      entries = JenkinsPipelineBuilder.registry.entries.keys
+      entries << :job_attributes
+      entries.each do |entry, _path|
         klass_name = entry.to_s.classify
         singular_model = entry.to_s.singularize
 

data/lib/jenkins_pipeline_builder/cli/helper.rb

@@ -49,6 +49,8 @@ module JenkinsPipelineBuilder
           creds = YAML.load_file(
             File.expand_path("#{ENV['HOME']}/.jenkins_api_client/login.yml", __FILE__)
           )
+        elsif options[:debug]
+          creds = { username: :foo, password: :bar, server_ip: :baz }
         else
           msg = 'Credentials are not set. Please pass them as parameters or'
           msg << ' set them in the default credentials file'

data/lib/jenkins_pipeline_builder/cli/list.rb

@@ -26,15 +26,22 @@ module JenkinsPipelineBuilder
       JenkinsPipelineBuilder.registry.entries.keys.each do |entry|
         desc entry, "List all #{entry}"
         define_method(entry) do
-          extensions =  JenkinsPipelineBuilder.registry.registry[:job][entry]
-          extensions.each { |name, ext| display_module(name, ext) }
+          entries =  JenkinsPipelineBuilder.registry.registry[:job][entry]
+          entries.each do |name, set|
+            ext = set.extensions.first
+            display_module(name, ext)
+          end
         end
       end
 
       desc 'job_attributes', 'List all job attributes'
       def job_attributes
-        extensions =  JenkinsPipelineBuilder.registry.registry[:job]
-        extensions.each { |name, ext| display_module(name, ext) }
+        entries =  JenkinsPipelineBuilder.registry.registry[:job]
+        entries.each do |name, set|
+          next unless set.is_a? ExtensionSet
+          ext = set.extensions.first
+          display_module(name, ext)
+        end
       end
 
       private

data/lib/jenkins_pipeline_builder/extensions.rb

@@ -23,74 +23,185 @@ require 'jenkins_pipeline_builder'
 JenkinsPipelineBuilder.registry.entries.each do |type, path|
   singular_type = type.to_s.singularize
   define_method singular_type do |&block|
-    ext = JenkinsPipelineBuilder::Extension.new
-    ext.instance_eval(&block)
-    ext.path path
-    ext.type singular_type
-    unless ext.valid?
-      name = ext.name || 'A plugin with no name provided'
+    set = JenkinsPipelineBuilder::ExtensionSet.new
+    set.instance_eval(&block)
+    set.blocks.each do |version, settings|
+      ext = JenkinsPipelineBuilder::Extension.new
+      ext.min_version version
+      ext.type singular_type
+      set.settings.merge(settings).each do |key, value|
+        ext.send key, value
+      end
+      ext.path path unless ext.path
+      set.extensions << ext
+    end
+    unless set.valid?
+      name = set.name || 'A plugin with no name provided'
       puts "Encountered errors while registering #{name}"
-      puts ext.errors.map { |k, v| "#{k}: #{v}" }.join(', ')
+      puts set.errors.map { |k, v| "#{k}: #{v}" }.join(', ')
       return false
     end
-    JenkinsPipelineBuilder.registry.register([:job, type], ext)
-    puts "Successfully registered #{ext.name} for versions #{ext.min_version} and higher" if ext.announced
+    JenkinsPipelineBuilder.registry.register([:job, type], set)
+    versions = set.extensions.map { |ext| ext.min_version }
+    puts "Successfully registered #{set.name} for versions #{versions}" if set.announced
   end
 end
 
 def job_attribute(&block)
-  ext = JenkinsPipelineBuilder::Extension.new
-  ext.instance_eval(&block)
-  ext.type :job_attribute
-  unless ext.valid?
-    name = ext.name || 'A plugin with no name provided'
+  set = JenkinsPipelineBuilder::ExtensionSet.new
+  set.instance_eval(&block)
+  set.blocks.each do |version, settings|
+    ext = JenkinsPipelineBuilder::Extension.new
+    ext.min_version version
+    ext.type :job_attribute
+    set.settings.merge(settings).each do |key, value|
+      ext.send key, value
+    end
+    set.extensions << ext
+  end
+  unless set.valid?
+    name = set.name || 'A plugin with no name provided'
     puts "Encountered errors while registering #{name}"
-    puts ext.errors.map { |k, v| "#{k}: #{v}" }.join(', ')
+    puts set.errors.map { |k, v| "#{k}: #{v}" }.join(', ')
     return false
   end
-  JenkinsPipelineBuilder.registry.register([:job], ext)
-  puts "Successfully registered #{ext.name} for versions #{ext.min_version} and higher" if ext.announced
+  JenkinsPipelineBuilder.registry.register([:job], set)
+  puts "Successfully registered #{set.name} for versions #{set.min_version} and higher" if set.announced
+end
+
+module JenkinsPipelineBuilder
+  class ExtensionSet
+    SET_METHODS = [
+      :name,
+      :plugin_id,
+      :jenkins_name,
+      :description,
+      :announced,
+      :type
+    ]
+    SET_METHODS.each do |method_name|
+      define_method method_name do |value = nil|
+        return settings[method_name] if value.nil?
+        settings[method_name] = value
+      end
+    end
+
+    attr_accessor :blocks, :extensions, :settings
+
+    def initialize
+      @blocks = {}
+      @settings = {}
+      @extensions = []
+    end
+
+    def installed_version=(version)
+      version = version.match(/\d+\.\d+/)
+      @version = Gem::Version.new version
+    end
+
+    def installed_version
+      return @version if @version
+      reg = JenkinsPipelineBuilder.registry
+      version = reg.versions[settings[:plugin_id]]
+      puts reg.versions.inspect if version.nil?
+      fail "Plugin #{settings[:name]} is not installed (plugin_id: #{settings[:plugin_id]})" if version.nil?
+      self.installed_version = version
+      @version
+    end
+
+    def extension
+      # TODO: Support multiple xml sections for the native to jenkins plugins
+      return extensions.first if settings[:plugin_id] == 'builtin'
+
+      versions = extensions.each_with_object({}) do |ext, hash|
+        hash[Gem::Version.new(ext.min_version)] = ext
+      end
+      versions.keys.sort!.reverse!.each do |version|
+        return versions[version] if version <= installed_version
+      end
+
+      fail "Can't find version of #{name} lte #{installed_version}, versions available are #{versions.keys.map(&:to_s)}"
+    end
+
+    def merge(other_set)
+      mismatch = []
+      SET_METHODS.each do |method_name|
+        val1 = settings[method_name]
+        val2 = other_set.settings[method_name]
+        mismatch << "The values for #{method_name} do not match '#{val1}' : '#{val2}'" unless val1 == val2
+      end
+      mismatch.each do |error|
+        puts error
+      end
+      fail 'Values did not match, cannot merge exception sets' if mismatch.any?
+
+      blocks.merge other_set.blocks
+    end
+
+    def xml(path: false, version: '0', &block)
+      unless block
+        fail "no block found for version #{version}" unless blocks.key version
+        return blocks[version][:block]
+      end
+      if blocks[version]
+        blocks[version].merge!(xml: block, path: path)
+      else
+        blocks[version] = { xml: block, path: path }
+      end
+    end
+
+    [:after, :before].each do |method_name|
+      define_method method_name do |version: '0', &block|
+        return instance_variable_get(method_name) unless block
+        blocks[version] = {} unless blocks[version]
+        blocks[version][method_name] = block
+      end
+    end
+
+    def valid?
+      errors.empty?
+    end
+
+    def errors
+      errors = {}
+      errors['ExtensionSet'] = 'no extensions successfully registered' if extensions.empty?
+      extensions.each do |ext|
+        ver = ext.min_version || 'unknown'
+        errors["#{ext.name} version #{ver}"] = ext.errors unless ext.valid?
+      end
+      errors
+    end
+  end
 end
 
 module JenkinsPipelineBuilder
   class Extension
-    DSL_METHODS = {
+    EXT_METHODS = {
       name: false,
       plugin_id: false,
-      min_version: false,
       jenkins_name: 'No jenkins display name set',
       description: 'No description set',
-      path: false,
       announced: true,
-      type: false
+      min_version: false,
+      path: false,
+      type: false,
+      before: false,
+      after: false,
+      xml: false
     }
-    DSL_METHODS.keys.each do |method_name|
+    EXT_METHODS.keys.each do |method_name|
       define_method method_name do |value = nil|
         return instance_variable_get("@#{method_name}") if value.nil?
         instance_variable_set("@#{method_name}", value)
       end
     end
 
-    def xml(path = false, &block)
-      @path = path if path
-      return @xml unless block
-      @xml = block
-    end
-
-    def after(&block)
-      return @after unless block
-      @after = block
-    end
-
-    def before(&block)
-      return @before unless block
-      @before = block
-    end
-
     def initialize
-      DSL_METHODS.each do |key, value|
+      EXT_METHODS.each do |key, value|
         instance_variable_set("@#{key}", value) if value
       end
+      before false
+      after false
     end
 
     def valid?
@@ -99,7 +210,7 @@ module JenkinsPipelineBuilder
 
     def errors
       errors = {}
-      DSL_METHODS.keys.each do |name|
+      EXT_METHODS.keys.each do |name|
         errors[name] = 'Must be set' if send(name).nil?
       end
       errors