jenkins_pipeline_builder 0.6.0 → 0.7.0

data/lib/jenkins_pipeline_builder/generator.rb

@@ -66,36 +66,34 @@ module JenkinsPipelineBuilder
       JenkinsPipelineBuilder::View.new(self)
     end
 
-    def bootstrap(path, project_name)
-      @logger.info "Bootstrapping pipeline from path #{path}"
+    def bootstrap(path, project_name = nil)
+      logger.info "Bootstrapping pipeline from path #{path}"
       load_collection_from_path(path)
-      # @logger.info @job_collection
       cleanup_temp_remote
       load_extensions(path)
       errors = {}
-      # Publish all the jobs if the projects are not found
-      if projects.count == 0
-        errors = publish_jobs(jobs)
-      else
+      if projects.any?
         errors = publish_project(project_name)
+      else
+        errors = publish_jobs(jobs)
       end
       errors.each do |k, v|
-        @logger.error "Encountered errors compiling: #{k}:"
-        @logger.error v
+        logger.error "Encountered errors compiling: #{k}:"
+        logger.error v
       end
       errors
     end
 
     def pull_request(path, project_name)
       success = false
-      @logger.info "Pull Request Generator Running from path #{path}"
+      logger.info "Pull Request Generator Running from path #{path}"
       load_collection_from_path(path)
       cleanup_temp_remote
       load_extensions(path)
-      @logger.info "Project: #{projects}"
+      logger.info "Project: #{projects}"
       projects.each do |project|
         next unless project[:name] == project_name || project_name.nil?
-        @logger.info "Using Project #{project}"
+        logger.info "Using Project #{project}"
         pull_job = find_pull_request_generator(project)
         p_success, p_payload = compile_pull_request_generator(pull_job[:name], project)
         next unless p_success
@@ -223,49 +221,13 @@ module JenkinsPipelineBuilder
     def load_extensions(path)
       path = "#{path}/extensions"
       path = File.expand_path(path, Dir.getwd)
-      unless File.directory?(path)
-        logger.info "Loading extensions from folder #{path}"
-        logger.info Dir.glob("#{path}/*.rb").inspect
-        Dir.glob("#{path}/*.rb").each do |file|
-          logger.info "Loaded #{file}"
-          require file
-        end
-      end
-      match_extension_versions
-    end
-
-    def match_extension_versions
-      registry = @module_registry.registry[:job]
-      installed_plugins = @debug ? nil : list_plugins # Only get plugins if not in debug mode
-      @logger.debug 'Loading newest version of all plugins since we are in debug mode.'
-      registry.each do |registry_key, registry_value|
-        if registry_value.count > 1
-          registry_value.each_key do |extension_key|
-            registry[registry_key][extension_key] = newest_compatible(extension_key, installed_plugins, registry_key)
-          end
-        else
-          registry[registry_key] = newest_compatible(registry_key, installed_plugins)
-        end
-      end
-    end
-
-    def newest_compatible(extension, installed_plugins, key = nil)
-      # Fetch the registrered_modules for the extension
-      registry = @module_registry.registry[:job]
-      registry = registry[key] unless key.nil?
-      registry = registry[extension]
-      keep = nil
-      keep_version = ''
-      registry.each do |ex|
-        is_available = @debug ? true : ex.min_version.to_s <= installed_plugins[ex.plugin_id.to_s].to_s
-        is_newer = ex.min_version.to_s >= keep_version
-
-        next unless keep.nil? || (is_available && is_newer)
-
-        keep = ex
-        keep_version = ex.min_version
+      return unless File.directory?(path)
+      logger.info "Loading extensions from folder #{path}"
+      logger.info Dir.glob("#{path}/*.rb").inspect
+      Dir.glob("#{path}/*.rb").each do |file|
+        logger.info "Loaded #{file}"
+        require file
       end
-      keep
     end
 
     def load_template(path, template)
@@ -423,7 +385,7 @@ module JenkinsPipelineBuilder
       logger.info project
       process_job_changes(jobs)
       errors = process_jobs(jobs, project)
-      errors = process_views(project_body[:views], project,  errors) if project_body[:views]
+      errors = process_views(project_body[:views], project, errors) if project_body[:views]
       errors.each do |k, v|
         puts "Encountered errors processing: #{k}:"
         v.each do |key, error|
@@ -466,7 +428,7 @@ module JenkinsPipelineBuilder
         next unless project_name.nil? || project[:name] == project_name
         success, payload = resolve_project(project)
         if success
-          @logger.info 'successfully resolved project'
+          logger.info 'successfully resolved project'
           compiled_project = payload
         else
           return false
@@ -484,7 +446,7 @@ module JenkinsPipelineBuilder
 
     def publish_jobs(jobs, errors = {})
       jobs.each do |i|
-        @logger.info "Processing #{i}"
+        logger.info "Processing #{i}"
         job = i[:result]
         fail "Result is empty for #{i}" if job.nil?
         success, payload = compile_job_to_xml(job)
@@ -502,7 +464,8 @@ module JenkinsPipelineBuilder
       if @debug
         logger.info "Will create job #{job}"
         logger.info "#{xml}"
-        File.open(job_name + '.xml', 'w') { |f| f.write xml }
+        FileUtils.mkdir_p(out_dir) unless File.exist?(out_dir)
+        File.open("#{out_dir}/#{job_name}.xml", 'w') { |f| f.write xml }
         return
       end
 
@@ -555,7 +518,7 @@ module JenkinsPipelineBuilder
         puts "Template merged: #{template}"
       end
 
-      xml   = client.job.build_freestyle_config(params)
+      xml = client.job.build_freestyle_config(params)
       n_xml = Nokogiri::XML(xml)
 
       logger.debug 'Loading the required modules'
@@ -576,7 +539,7 @@ module JenkinsPipelineBuilder
 
     # TODO: make sure this is tested
     def update_job_dsl(job, xml)
-      n_xml      = Nokogiri::XML(xml)
+      n_xml = Nokogiri::XML(xml)
       n_builders = n_xml.xpath('//builders').first
       Nokogiri::XML::Builder.with(n_builders) do |b_xml|
         build_job_dsl(job, b_xml)
@@ -591,11 +554,11 @@ module JenkinsPipelineBuilder
 
       n_xml = Nokogiri::XML(xml)
       if n_xml.xpath('//javaposse.jobdsl.plugin.ExecuteDslScripts').empty?
-        p_xml = Nokogiri::XML::Builder.new(encoding:  'UTF-8') do |b_xml|
+        p_xml = Nokogiri::XML::Builder.new(encoding: 'UTF-8') do |b_xml|
           build_job_dsl(params, b_xml)
         end
 
-        n_xml.xpath('//builders').first.add_child("\r\n" + p_xml.doc.root.to_xml(indent:  4) + "\r\n")
+        n_xml.xpath('//builders').first.add_child("\r\n" + p_xml.doc.root.to_xml(indent: 4) + "\r\n")
         xml = n_xml.to_xml
       end
       xml
@@ -614,5 +577,9 @@ module JenkinsPipelineBuilder
         xml.removedJobAction 'IGNORE'
       end
     end
+
+    def out_dir
+      'out/xml'
+    end
   end
 end

data/lib/jenkins_pipeline_builder/module_registry.rb

@@ -27,6 +27,16 @@ module JenkinsPipelineBuilder
       @registry = { job: {} }
     end
 
+    def versions
+      # Return a hash with a default of 1000 so that we'll get the newest in debug
+      return Hash.new { |_| '1000.0' } if JenkinsPipelineBuilder.generator.debug
+      @versions ||= JenkinsPipelineBuilder.client.plugin.list_installed
+    end
+
+    def clear_versions
+      @versions = nil
+    end
+
     def logger
       JenkinsPipelineBuilder.logger
     end
@@ -42,13 +52,17 @@ module JenkinsPipelineBuilder
       }
     end
 
-    def register(prefix, extension)
+    def register(prefix, set)
       name = prefix.pop
       root = prefix.inject(@registry, :[])
       root[name] = {} unless root[name]
+      # TODO: Set installed version here
 
-      root[name][extension.name] = [] unless root[name][extension.name]
-      root[name][extension.name] << extension
+      if root[name][set.name]
+        root[name][set.name].merge set
+      else
+        root[name][set.name] = set
+      end
     end
 
     def get(path)
@@ -76,12 +90,10 @@ module JenkinsPipelineBuilder
           next
         end
         reg_value = registry[key]
-        if reg_value.is_a?(Array) && reg_value.first.is_a?(Extension)
-          next unless reg_value.select { |x| x.class == Extension }.size == reg_value.size
-          # TODO: Actually compare versions installed on box here
-          reg = reg_value.sort { |x, y| x.min_version <=> y.min_version }.last
-          logger.debug "Using #{reg.type} #{reg.name} version #{reg.min_version}"
-          execute_extension(reg, value, n_xml)
+        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
         elsif value.is_a? Hash
           traverse_registry reg_value, value, n_xml, true
         elsif value.is_a? Array

data/lib/jenkins_pipeline_builder/pull_request.rb

@@ -51,7 +51,7 @@ module JenkinsPipelineBuilder
     #
     # 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
+    # args[:git_org] The Orig user ex. constantcontact
     # @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]

data/lib/jenkins_pipeline_builder/version.rb

@@ -21,5 +21,5 @@
 #
 
 module JenkinsPipelineBuilder
-  VERSION = '0.6.0'
+  VERSION = '0.7.0'
 end

data/pipeline/Jenkins-Pipeline-Builder.yaml

@@ -1,7 +1,7 @@
 - job:
-    name: 'Jenkins-Pipeline-Builder'
+    name: '{{name}}-Commit'
     scm_provider: git
-    scm_url: https://github.com/IgorShare/jenkins_pipeline_builder.git
+    scm_url: https://github.com/constantcontact/jenkins_pipeline_builder.git
     scm_branch: master
     scm_params:
       excuded_users: buildmaster
@@ -11,14 +11,10 @@
     wrappers:
       - timestamp: true
       - ansicolor: true
-      - rvm: "`cat .ruby-version`@`cat .ruby-gemset`"
+      - rvm: "`cat .ruby-version`"
     publishers:
       - junit_result:
           test_results: 'out/**/*.xml'
-      - git:
-          push-merge: true
-          push-only-if-success: false
-      - hipchat: true
       - coverage_result:
           report_dir: out/coverage/rcov
           total:

data/pipeline/project.yaml

@@ -0,0 +1,10 @@
+- project:
+    name: Jenkins-Pipeline-Builder
+    description: 'Do not edit this job through the web!'
+    git_repo: git@github.com:constantcontact/jenkins_pipeline_builder.git
+    git_branch: master
+    discard_days: '30'
+    discard_number: '100'
+    rvm: '`cat .ruby-version`'
+    jobs:
+        - '{{name}}-Commit'

data/spec/lib/jenkins_pipeline_builder/compiler_spec.rb

@@ -1,6 +1,14 @@
 require File.expand_path('../spec_helper', __FILE__)
-require 'pp'
 describe JenkinsPipelineBuilder::Compiler do
+  before :all do
+    JenkinsPipelineBuilder.credentials = {
+      server_ip: '127.0.0.1',
+      server_port: 8080,
+      username: 'username',
+      password: 'password',
+      log_location: '/dev/null'
+    }
+  end
   let(:compiler) { JenkinsPipelineBuilder::Compiler }
   let(:settings_project) { { name: 'DummyPipeline', type: :project, value: { name: 'DummyPipeline', jobs: ['{{name}}-00', { '{{name}}-01' => { job_name: '{{name}}-02' } }] } } }
   let(:settings_global) { { name: 'global', description: 'Do not edit this job through the web!', discard_days: '14', pipeline_repo: 'git@github.com:constantcontact/jenkins_pipeline_builder.git', pipeline_branch: 'master' } }

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

@@ -0,0 +1,53 @@
+require File.expand_path('../../spec_helper', __FILE__)
+
+describe 'builders' 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.builders }
+    @n_xml = builder.doc
+  end
+
+  after :each do |example|
+    name = example.description.gsub ' ', '_'
+    File.open("./out/xml/builder_#{name}.xml", 'w') { |f| @n_xml.write_xml_to f }
+  end
+
+  context 'multi_job builder' do
+    before :each do
+      allow(JenkinsPipelineBuilder.client).to receive(:plugin).and_return double(
+        list_installed: { 'jenkins-multijob-plugin' => '20.0' })
+    end
+    it 'generates a configuration' do
+      params = { builders: { multi_job: { phases: { foo: { jobs: [{ name: 'foo' }] } } } } }
+
+      JenkinsPipelineBuilder.registry.traverse_registry_path('job', params, @n_xml)
+
+      builder = @n_xml.root.children.first
+      expect(builder.name).to match 'com.tikal.jenkins.plugins.multijob.MultiJobBuilder'
+    end
+
+    it 'provides job specific config' do
+      params = { builders: { multi_job: { phases: { foo: { jobs: [{ name: 'foo', config: {
+        predefined_build_parameters: 'bar'
+      } }] } } } } }
+
+      JenkinsPipelineBuilder.registry.traverse_registry_path('job', params, @n_xml)
+
+      node = @n_xml.xpath '//hudson.plugins.parameterizedtrigger.PredefinedBuildParameters'
+      expect(node.children.first.content).to eq 'bar'
+    end
+  end
+end

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

@@ -0,0 +1,140 @@
+require File.expand_path('../../spec_helper', __FILE__)
+
+describe 'publishers' 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.publishers }
+    @n_xml = builder.doc
+  end
+
+  after :each do |example|
+    name = example.description.gsub ' ', '_'
+    File.open("./out/xml/publisher_#{name}.xml", 'w') { |f| @n_xml.write_xml_to f }
+  end
+
+  context 'sonar publisher' do
+    before :each do
+      allow(JenkinsPipelineBuilder.client).to receive(:plugin).and_return double(
+        list_installed: { 'sonar' => '20.0' })
+    end
+
+    it 'generates a configuration' do
+      params = { publishers: { sonar_result: {} } }
+
+      JenkinsPipelineBuilder.registry.traverse_registry_path('job', params, @n_xml)
+
+      sonar_publisher = @n_xml.root.children.first
+      expect(sonar_publisher.name).to match 'hudson.plugins.sonar.SonarPublisher'
+    end
+
+    it 'populates branch' do
+      params = { publishers: { sonar_result: { branch: 'test' } } }
+
+      JenkinsPipelineBuilder.registry.traverse_registry_path('job', params, @n_xml)
+
+      sonar_nodes = @n_xml.root.children.first.children
+      branch = sonar_nodes.select { |node| node.name == 'branch' }
+      expect(branch.first.content).to match 'test'
+    end
+
+    it 'populates maven installation name' do
+      params = { publishers: { sonar_result: { maven_installation_name: 'test' } } }
+
+      JenkinsPipelineBuilder.registry.traverse_registry_path('job', params, @n_xml)
+
+      sonar_nodes = @n_xml.root.children.first.children
+      maven_installation_name = sonar_nodes.select { |node| node.name == 'mavenInstallationName' }
+      expect(maven_installation_name.first.content).to match 'test'
+    end
+  end
+
+  context 'description_setter' do
+    before :each do
+      allow(JenkinsPipelineBuilder.client).to receive(:plugin).and_return double(
+        list_installed: { 'description-setter' => '20.0' })
+    end
+    it 'generates a configuration' do
+      puts JenkinsPipelineBuilder.registry.versions
+      params = { publishers: { description_setter: {} } }
+
+      JenkinsPipelineBuilder.registry.traverse_registry_path('job', params, @n_xml)
+
+      publisher = @n_xml.root.children.first
+      expect(publisher.name).to match 'hudson.plugins.descriptionsetter.DescriptionSetterPublisher'
+    end
+  end
+
+  context 'downstream' do
+    before :each do
+      allow(JenkinsPipelineBuilder.client).to receive(:plugin).and_return double(
+        list_installed: { 'parameterized-trigger' => '20.0'
+    })
+    end
+
+    it 'generates a configuration' do
+      params = { publishers: { downstream: {} } }
+
+      JenkinsPipelineBuilder.registry.traverse_registry_path('job', params, @n_xml)
+
+      publisher = @n_xml.root.children.first
+      expect(publisher.name).to match 'hudson.plugins.parameterizedtrigger.BuildTrigger'
+    end
+
+    it 'populates data'
+    it 'passes params'
+    it 'sets the file'
+  end
+
+  context 'hipchat' do
+    it 'generates a configuration'
+    it 'does an option'
+  end
+
+  context 'git' do
+    it 'generates a configuration'
+    it 'does an option'
+  end
+
+  context 'junit_result' do
+    it 'generates a configuration'
+    it 'does an option'
+  end
+
+  context 'coverage_result' do
+    it 'generates a configuration'
+    it 'does an option'
+  end
+
+  context 'post_build_script' do
+    it 'generates a configuration'
+    it 'does an option'
+  end
+
+  context 'groovy_postbuild' do
+    it 'generates a configuration'
+    it 'does an option'
+  end
+
+  context 'archive_artifact' do
+    it 'generates a configuration'
+    it 'does an option'
+  end
+
+  context 'email_notification' do
+    it 'generates a configuration'
+    it 'does an option'
+  end
+end