jenkins_pipeline_builder 0.10.11 → 0.10.12

checksums.yaml

@@ -1,15 +1,15 @@
 ---
 !binary "U0hBMQ==":
   metadata.gz: !binary |-
-    NzhiNTViYTRjNzBmMGYwZDcwOTdjMjNhOWM4ZjlmYjY0MmY3NGI5NA==
+    ZTM5YTI4ZDgwN2M1YjZjNzQ3MWY5NzliM2U4MTA4NmQ3MjQ5N2Y4NA==
   data.tar.gz: !binary |-
-    MjE0NGFjMzMxMjRmZGZlZjNkYTdmNzg2YWU5NTFmMDQ5MzcxMmRlMA==
+    MWFhY2QyYzc5MWQyOGM5MmE3YTM2MzhhNGY5ZWUxODdmMTQ0YjFiMg==
 SHA512:
   metadata.gz: !binary |-
-    ZjIwN2M5MTIxYzc1YmQ4NDY5MjU0NjhlZGEzMTEzZmU1MzZkOGE4Y2QyNGY3
-    MGQ5OTE5ZTg0ZTAxZmEyZjZmMTlkMGMzNDA0ZTQ1NzkyM2ZmMjk5MmRmNzI4
-    MmZkYTE0YTFmZjRmMzgwNzJhYjcwNDlmN2U4OGFmODhiODk1YmE=
+    NThjODRiYzA3ZDY1NDJmY2NjZWJjOTY3MTY0YmJmMTkyZTllODc4YTc0YmI5
+    MDhhODgyYWM3ZjdlZTQwZmFhY2U4YWJkZTQ4MjYwNzg4YmYyZWQ4ZGZmNjJh
+    NTMzMzJlOTBlOGY4MGViZjFiMWU0Yzk3NjYyNjI2MWQ2YzM0MjI=
   data.tar.gz: !binary |-
-    YzM3NGQ0OTgxNDA5OTAzNjFkNjJhZTVmYWU1MDg4Mzk2NDNhN2Y2NWEyYjU2
-    ZjY0NjhmMjVkNmNkMjU3NmYyNWI4MGRiZTczMDg4ZDc5NDcwYjhlMWNmMzcw
-    Y2M3Y2VmMjZmOWU3YjNmOGUxMmVmNjk3MmEwZjBhODk3Y2NjOTU=
+    NzhmYjZkNGRlMTVmYTBlNDBkNDRkMjE5YzMzZGIwYzZlMjRkMjI2YjkwYzlm
+    ODY2NGUwMDlkODVlNjcyZmNjNzIzMDk3NWJkMTJkMDdlMGFmZmE1NDE1NGNl
+    NzhkMjRmNmM4MDBkOTIzNTFhMDFkYmViNDc0MzQyNzcxYzNhNGY=

data/.rubocop.yml

@@ -7,7 +7,7 @@ Metrics/PerceivedComplexity:
 Metrics/MethodLength:
   Max: 27
 Metrics/ClassLength:
-  Max: 525
+  Max: 350
 
 #######
 # Finalized settings

data/lib/jenkins_pipeline_builder.rb

@@ -30,15 +30,36 @@ require 'jenkins_pipeline_builder/module_registry'
 require 'jenkins_pipeline_builder/pull_request_generator'
 require 'jenkins_pipeline_builder/pull_request'
 require 'jenkins_pipeline_builder/view'
+require 'jenkins_pipeline_builder/job_collection'
+require 'jenkins_pipeline_builder/job'
+require 'jenkins_pipeline_builder/remote_dependencies'
 require 'jenkins_pipeline_builder/generator'
 
 module JenkinsPipelineBuilder
   class << self
-    attr_reader :client, :credentials
+    attr_reader :client, :credentials, :debug, :file_mode
     def generator
       @_generator ||= Generator.new
     end
 
+    def file_mode!
+      @file_mode = true
+    end
+
+    def normal_mode!
+      @file_mode = false
+    end
+
+    def debug!
+      @debug = true
+      @client.logger.level = Logger::DEBUG
+    end
+
+    def no_debug!
+      @debug = false
+      @client.logger.level = Logger::INFO
+    end
+
     def credentials=(creds)
       @credentials = creds
       @client = JenkinsApi::Client.new(credentials)
@@ -57,6 +78,8 @@ module JenkinsPipelineBuilder
 end
 JenkinsPipelineBuilder.generator
 require 'jenkins_pipeline_builder/extensions'
+require 'jenkins_pipeline_builder/extension_dsl'
+require 'jenkins_pipeline_builder/extension_set'
 require 'jenkins_pipeline_builder/extensions/builders'
 require 'jenkins_pipeline_builder/extensions/job_attributes'
 require 'jenkins_pipeline_builder/extensions/wrappers'

data/lib/jenkins_pipeline_builder/cli/helper.rb

@@ -40,31 +40,35 @@ module JenkinsPipelineBuilder
       # @return [JenkinsPipelineBuilder::Generator] A new Client object
       #
       def self.setup(options)
+        creds = process_creds options
+
+        JenkinsPipelineBuilder.credentials = creds
+        generator = JenkinsPipelineBuilder.generator
+        JenkinsPipelineBuilder.debug! if options[:debug]
+        generator
+      end
+
+      def self.process_creds(options)
         if options[:username] && options[:server] && (options[:password] || options[:password_base64])
-          creds = process_cli_creds(options)
+          return process_cli_creds(options)
         elsif options[:creds_file]
           if options[:creds_file].end_with? 'json'
-            creds = JSON.parse(IO.read(File.expand_path(options[:creds_file])))
+            return JSON.parse(IO.read(File.expand_path(options[:creds_file])))
           else
-            creds = YAML.load_file(File.expand_path(options[:creds_file]))
+            return YAML.load_file(File.expand_path(options[:creds_file]))
           end
         elsif File.exist?("#{ENV['HOME']}/.jenkins_api_client/login.yml")
-          creds = YAML.load_file(
+          return 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 }
+          return { 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'
           $stderr.puts msg
           exit 1
         end
-
-        JenkinsPipelineBuilder.credentials = creds
-        generator = JenkinsPipelineBuilder.generator
-        generator.debug = options[:debug]
-        generator
       end
 
       def self.process_cli_creds(options)

data/lib/jenkins_pipeline_builder/extension_dsl.rb

@@ -0,0 +1,21 @@
+JenkinsPipelineBuilder.registry.entries.each do |type, path|
+  singular_type = type.to_s.singularize
+  define_method singular_type do |&block|
+    set = JenkinsPipelineBuilder::ExtensionSet.new singular_type, path, &block
+    return false unless set.valid?
+
+    JenkinsPipelineBuilder.registry.register([:job, type], set)
+    versions = set.extensions.map(&:min_version)
+    puts "Successfully registered #{set.name} for versions #{versions}" if set.announced
+    true
+  end
+end
+
+def job_attribute(&block)
+  set = JenkinsPipelineBuilder::ExtensionSet.new :job_attribute, &block
+  return false unless set.valid?
+
+  JenkinsPipelineBuilder.registry.register([:job], set)
+  versions = set.extensions.map(&:min_version)
+  puts "Successfully registered #{set.name} for versions #{versions}" if set.announced
+end

data/lib/jenkins_pipeline_builder/extension_set.rb

@@ -0,0 +1,174 @@
+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(type, path = nil, &block)
+      @blocks = {}
+      @settings = {}
+      @extensions = []
+
+      instance_eval(&block)
+
+      blocks.each do |version, settings|
+        add_extension type, version, settings, path
+      end
+    end
+
+    def installed_version=(version)
+      version = version.match(/\d+\.\d+/)
+      @version = Gem::Version.new version
+    end
+
+    def add_extension(type, version, settings, path = nil)
+      ext = JenkinsPipelineBuilder::Extension.new
+      ext.min_version version
+      ext.type type
+      self.settings.merge(settings).each do |key, value|
+        ext.send key, value
+      end
+
+      ext.path path unless ext.path
+      extensions << ext
+    end
+
+    def installed_version
+      return @version if @version
+      reg = JenkinsPipelineBuilder.registry
+      version = reg.versions[settings[:plugin_id]]
+      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'
+
+      extension = versions[highest_allowed_version]
+
+      unless extension
+        fail "Can't find version of #{name} lte #{installed_version}, available versions: #{versions.keys.map(&:to_s)}"
+      end
+      extension
+    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 extension sets' if mismatch.any?
+
+      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]
+      end
+      store_xml version, block, path
+    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
+      end
+    end
+
+    def valid?
+      valid = errors.empty?
+      unless valid
+        name ||= 'A plugin with no name provided'
+        puts "Encountered errors while registering #{name}"
+        puts errors.map { |k, v| "#{k}: #{v}" }.join(', ')
+      end
+      valid
+    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
+
+    private
+
+    def highest_allowed_version
+      ordered_version_list.each do |version|
+        return version if version <= installed_version
+      end
+    end
+
+    def store_xml(version, block, path)
+      if blocks[version]
+        blocks[version].merge!(xml: block, path: path)
+      else
+        blocks[version] = { xml: block, path: path }
+      end
+    end
+
+    def versions
+      @versions ||= extensions.each_with_object({}) do |ext, hash|
+        hash[Gem::Version.new(ext.min_version)] = ext
+      end
+    end
+
+    def ordered_version_list
+      versions.keys.sort.reverse
+    end
+
+    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

data/lib/jenkins_pipeline_builder/extensions.rb

@@ -42,181 +42,6 @@ def job_attribute(&block)
   puts "Successfully registered #{set.name} for versions #{versions}" 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(type, path = nil, &block)
-      @blocks = {}
-      @settings = {}
-      @extensions = []
-
-      instance_eval(&block)
-
-      blocks.each do |version, settings|
-        add_extension type, version, settings, path
-      end
-    end
-
-    def installed_version=(version)
-      version = version.match(/\d+\.\d+/)
-      @version = Gem::Version.new version
-    end
-
-    def add_extension(type, version, settings, path = nil)
-      ext = JenkinsPipelineBuilder::Extension.new
-      ext.min_version version
-      ext.type type
-      self.settings.merge(settings).each do |key, value|
-        ext.send key, value
-      end
-
-      ext.path path unless ext.path
-      extensions << ext
-    end
-
-    def installed_version
-      return @version if @version
-      reg = JenkinsPipelineBuilder.registry
-      version = reg.versions[settings[:plugin_id]]
-      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'
-
-      extension = versions[highest_allowed_version]
-
-      unless extension
-        fail "Can't find version of #{name} lte #{installed_version}, available versions: #{versions.keys.map(&:to_s)}"
-      end
-      extension
-    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 extension sets' if mismatch.any?
-
-      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]
-      end
-      store_xml version, block, path
-    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
-      end
-    end
-
-    def valid?
-      valid = errors.empty?
-      unless valid
-        name ||= 'A plugin with no name provided'
-        puts "Encountered errors while registering #{name}"
-        puts errors.map { |k, v| "#{k}: #{v}" }.join(', ')
-      end
-      valid
-    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
-
-    private
-
-    def highest_allowed_version
-      ordered_version_list.each do |version|
-        return version if version <= installed_version
-      end
-    end
-
-    def store_xml(version, block, path)
-      if blocks[version]
-        blocks[version].merge!(xml: block, path: path)
-      else
-        blocks[version] = { xml: block, path: path }
-      end
-    end
-
-    def versions
-      @versions ||= extensions.each_with_object({}) do |ext, hash|
-        hash[Gem::Version.new(ext.min_version)] = ext
-      end
-    end
-
-    def ordered_version_list
-      versions.keys.sort.reverse
-    end
-
-    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
-
 module JenkinsPipelineBuilder
   class Extension
     EXT_METHODS = {