jenkins_pipeline_builder 0.1.2 → 0.1.3

data/lib/jenksin_pipeline_builder/cli/view.rb

@@ -0,0 +1,40 @@
+#
+# Copyright (c) 2014 Igor Moochnick
+#
+# 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 the Software without restriction, including without limitation the rights
+# to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+# copies of the Software, and to permit persons to whom the Software is
+# furnished to do so, subject to the following conditions:
+#
+# The above copyright notice and this permission notice shall be included in
+# all copies or substantial portions of the Software.
+#
+# THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+# IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+# FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+# AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+# LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+# OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
+# THE SOFTWARE.
+#
+
+module JenkinsPipelineBuilder
+  module CLI
+    # This class provides various command line operations related to jobs.
+    class View < Thor
+      include Thor::Actions
+
+      desc 'dump', 'Dump view'
+      def dump(job_name)
+        Helper.setup(parent_options).dump(job_name)
+      end
+
+      desc 'bootstrap Path', 'Generates view from folder or a file'
+      def create(path)
+        Helper.setup(parent_options).view.generate(path)
+      end
+    end
+  end
+end

data/lib/jenksin_pipeline_builder/compiler.rb

@@ -0,0 +1,81 @@
+#
+# Copyright (c) 2014 Igor Moochnick
+#
+# 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 the Software without restriction, including without limitation the rights
+# to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+# copies of the Software, and to permit persons to whom the Software is
+# furnished to do so, subject to the following conditions:
+#
+# The above copyright notice and this permission notice shall be included in
+# all copies or substantial portions of the Software.
+#
+# THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+# IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+# FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+# AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+# LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+# OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
+# THE SOFTWARE.
+#
+
+module JenkinsPipelineBuilder
+  class Compiler
+    def self.resolve_value(value, settings)
+      value_s = value.to_s.clone
+      vars = value_s.scan(/{{([^}]+)}}/).flatten
+      vars.select! do |var|
+        var_val = settings[var.to_sym]
+        value_s.gsub!("{{#{var.to_s}}}", var_val) unless var_val.nil?
+        var_val.nil?
+      end
+      return nil if vars.count != 0
+      return value_s
+    end
+
+    def self.get_settings_bag(item_bag, settings_bag = {})
+      item = item_bag[:value]
+      bag = {}
+      return unless item.kind_of?(Hash)
+      item.keys.each do |k|
+        val = item[k]
+        if val.kind_of? String
+          new_value = resolve_value(val, settings_bag)
+          return nil if new_value.nil?
+          bag[k] = new_value
+        end
+      end
+      my_settings_bag = settings_bag.clone
+      return my_settings_bag.merge(bag)
+    end
+
+    def self.compile(item, settings = {})
+      case item
+        when String
+          new_value = resolve_value(item, settings)
+          puts "Failed to resolve #{item}" if new_value.nil?
+          return new_value
+        when Hash
+          result = {}
+          item.each do |key, value|
+            new_value = compile(value, settings)
+            puts "Failed to resolve #{value}" if new_value.nil?
+            return nil if new_value.nil?
+            result[key] = new_value
+          end
+          return result
+        when Array
+          result = []
+          item.each do |value|
+            new_value = compile(value, settings)
+            puts "Failed to resolve #{value}" if new_value.nil?
+            return nil if new_value.nil?
+            result << new_value
+          end
+          return result
+      end
+      return item
+    end
+  end
+end

data/lib/jenksin_pipeline_builder/generator.rb

@@ -0,0 +1,346 @@
+#
+# Copyright (c) 2014 Igor Moochnick
+#
+# 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 the Software without restriction, including without limitation the rights
+# to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+# copies of the Software, and to permit persons to whom the Software is
+# furnished to do so, subject to the following conditions:
+#
+# The above copyright notice and this permission notice shall be included in
+# all copies or substantial portions of the Software.
+#
+# THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+# IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+# FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+# AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+# LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+# OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
+# THE SOFTWARE.
+#
+
+require 'yaml'
+require 'pp'
+
+module JenkinsPipelineBuilder
+  class Generator
+    # Initialize a Client object with Jenkins Api Client
+    #
+    # @param args [Hash] Arguments to connect to Jenkins server
+    #
+    # @option args [String] :something some option description
+    #
+    # @return [JenkinsPipelineBuilder::Generator] a client generator
+    #
+    # @raise [ArgumentError] when required options are not provided.
+    #
+    def initialize(args, client)
+      @client        = client
+      @logger        = @client.logger
+      @job_templates = {}
+      @job_collection = {}
+
+      @module_registry = ModuleRegistry.new ({
+          job: {
+              description: JobBuilder.method(:change_description),
+              scm_params: JobBuilder.method(:apply_scm_params),
+              hipchat: JobBuilder.method(:hipchat_notifier),
+              parameters: JobBuilder.method(:build_parameters),
+              builders: {
+                  registry: {
+                      job_builder: Builders.method(:build_multijob_builder),
+                      inject_vars_file: Builders.method(:build_environment_vars_injector),
+                      shell_command: Builders.method(:build_shell_command),
+                      maven3: Builders.method(:build_maven3)
+                  },
+                  method:
+                    lambda { |registry, params, n_xml| @module_registry.run_registry_on_path('//builders', registry, params, n_xml) }
+              },
+              publishers: {
+                  registry: {
+                      git: Publishers.method(:push_to_git),
+                      hipchat: Publishers.method(:push_to_hipchat),
+                      description_setter: Publishers.method(:description_setter),
+                      downstream: Publishers.method(:push_to_projects),
+                      junit_result: Publishers.method(:publish_junit),
+                      coverage_result: Publishers.method(:publish_rcov)
+                  },
+                  method:
+                    lambda { |registry, params, n_xml| @module_registry.run_registry_on_path('//publishers', registry, params, n_xml) }
+              },
+              wrappers: {
+                  registry: {
+                      timestamp: Wrappers.method(:console_timestamp),
+                      ansicolor: Wrappers.method(:ansicolor),
+                      artifactory: Wrappers.method(:publish_to_artifactory),
+                      rvm: Wrappers.method(:run_with_rvm),
+                      inject_env_var: Wrappers.method(:inject_env_vars),
+                      inject_passwords: Wrappers.method(:inject_passwords)
+                  },
+                  method:
+                    lambda { |registry, params, n_xml| @module_registry.run_registry_on_path('//buildWrappers', registry, params, n_xml) }
+              },
+              triggers: {
+                  registry: {
+                      git_push: Triggers.method(:enable_git_push),
+                      scm_polling: Triggers.method(:enable_scm_polling)
+                  },
+                  method:
+                    lambda { |registry, params, n_xml| @module_registry.run_registry_on_path('//triggers', registry, params, n_xml) }
+              }
+          }
+      })
+    end
+
+    attr_accessor :client
+    attr_accessor :debug
+    # TODO: WTF?
+    attr_accessor :no_files
+    attr_accessor :job_collection
+
+    # Creates an instance to the View class by passing a reference to self
+    #
+    # @return [JenkinsApi::Client::System] An object to System subclass
+    #
+    def view
+      JenkinsPipelineBuilder::View.new(self)
+    end
+
+    def load_collection_from_path(path, recursively = false)
+      if File.directory?(path)
+        @logger.info "Generating from folder #{path}"
+        Dir.glob(File.join(path, '/*.yaml')).each do |file|
+          if File.directory?(file)
+            if recursively
+              load_collection_from_path(File.join(path, file), recursively)
+            else
+              next
+            end
+          end
+          @logger.info "Loading file #{file}"
+          yaml = YAML.load_file(file)
+          load_job_collection(yaml)
+        end
+      else
+        @logger.info "Loading file #{path}"
+        yaml = YAML.load_file(path)
+        load_job_collection(yaml)
+      end
+    end
+
+    def load_job_collection(yaml)
+      yaml.each do |section|
+        Utils.symbolize_keys_deep!(section)
+        key = section.keys.first
+        value = section[key]
+        name = value[:name]
+        raise "Duplicate item with name '#{name}' was detected." if @job_collection.has_key?(name)
+        @job_collection[name.to_s] = { name: name.to_s, type: key, value: value }
+      end
+    end
+
+    def get_item(name)
+      @job_collection[name.to_s]
+    end
+
+    def resolve_project(project)
+      defaults = get_item('global')
+      settings = defaults.nil? ? {} : defaults[:value] || {}
+
+      project[:settings] = Compiler.get_settings_bag(project, settings) unless project[:settings]
+      project_body = project[:value]
+
+      # Process jobs
+      jobs = project_body[:jobs] || []
+      jobs.map! do |job|
+        job.kind_of?(String) ? { job.to_sym => {} } : job
+      end
+      @logger.info project
+      jobs.each do |job|
+        job_id = job.keys.first
+        settings = project[:settings].clone.merge(job[job_id])
+        job[:result] = resolve_job_by_name(job_id, settings)
+      end
+
+      # Process views
+      views = project_body[:views] || []
+      views.map! do |view|
+        view.kind_of?(String) ? { view.to_sym => {} } : view
+      end
+      views.each do |view|
+        view_id = view.keys.first
+        settings = project[:settings].clone.merge(view[view_id])
+        # TODO: rename resolve_job_by_name properly
+        view[:result] = resolve_job_by_name(view_id, settings)
+      end
+
+      project
+    end
+
+    def resolve_job_by_name(name, settings = {})
+      job = get_item(name)
+      raise "Failed to locate job by name '#{name}'" if job.nil?
+      job_value = job[:value]
+      compiled_job =  Compiler.compile(job_value, settings)
+      return compiled_job
+    end
+
+    def projects
+      result = []
+      @job_collection.values.each do |item|
+        result << item if item[:type] == :project
+      end
+      return result
+    end
+
+    def bootstrap(path)
+      @logger.info "Bootstrapping pipeline from path #{path}"
+      load_collection_from_path(path)
+
+      projects.each do |project|
+        compiled_project = resolve_project(project)
+        pp compiled_project
+
+        if compiled_project[:value][:jobs]
+          compiled_project[:value][:jobs].each do |i|
+            job = i[:result]
+            xml = compile_job_to_xml(job)
+            create_or_update(job, xml)
+          end
+        end
+
+        if compiled_project[:value][:views]
+          compiled_project[:value][:views].each do |v|
+            _view = v[:result]
+            view.create(_view)
+          end
+        end
+      end
+
+    end
+
+    def dump(job_name)
+      @logger.info "Debug #{@debug}"
+      @logger.info "Dumping #{job_name} into #{job_name}.xml"
+      xml = @client.job.get_config(job_name)
+      File.open(job_name + '.xml', 'w') { |f| f.write xml }
+    end
+
+    def create_or_update(job, xml)
+      job_name = job[:name]
+      if @debug
+        @logger.info "Will create job #{job}"
+        @logger.info "#{xml}"
+        File.open(job_name + '.xml', 'w') { |f| f.write xml }
+        return
+      end
+
+      if @client.job.exists?(job_name)
+        @client.job.update(job_name, xml)
+      else
+        @client.job.create(job_name, xml)
+      end
+    end
+
+    def compile_job_to_xml(job)
+      raise 'Job name is not specified' unless job[:name]
+
+      @logger.info "Creating Yaml Job #{job}"
+      job[:job_type] = 'free_style' unless job[:job_type]
+      case job[:job_type]
+        when 'job_dsl'
+          xml = compile_freestyle_job_to_xml(job)
+          update_job_dsl(job, xml)
+        when 'multi_project'
+          xml = compile_freestyle_job_to_xml(job)
+          adjust_multi_project xml
+        when 'build_flow'
+          xml = compile_freestyle_job_to_xml(job)
+          add_job_dsl(job, xml)
+        when 'free_style'
+          compile_freestyle_job_to_xml job
+        else
+          @logger.info 'Unknown job type'
+          ''
+      end
+
+    end
+
+    def adjust_multi_project(xml)
+      n_xml = Nokogiri::XML(xml)
+      root = n_xml.root()
+      root.name = 'com.tikal.jenkins.plugins.multijob.MultiJobProject'
+      n_xml.to_xml
+    end
+
+    def compile_freestyle_job_to_xml(params)
+      if params.has_key?(:template)
+        template_name = params[:template]
+        raise "Job template '#{template_name}' can't be resolved." unless @job_templates.has_key?(template_name)
+        params.delete(:template)
+        template = @job_templates[template_name]
+        puts "Template found: #{template}"
+        params = template.deep_merge(params)
+        puts "Template merged: #{template}"
+      end
+
+      xml   = @client.job.build_freestyle_config(params)
+      n_xml = Nokogiri::XML(xml)
+
+      @module_registry.traverse_registry_path('job', params, n_xml)
+
+      n_xml.to_xml
+    end
+
+    def add_job_dsl(job, xml)
+      n_xml      = Nokogiri::XML(xml)
+      n_xml.root.name = 'com.cloudbees.plugins.flow.BuildFlow'
+      Nokogiri::XML::Builder.with(n_xml.root) do |xml|
+        xml.dsl job[:build_flow]
+      end
+      n_xml.to_xml
+    end
+
+    # TODO: make sure this is tested
+    def update_job_dsl(job, xml)
+      n_xml      = Nokogiri::XML(xml)
+      n_builders = n_xml.xpath('//builders').first
+      Nokogiri::XML::Builder.with(n_builders) do |xml|
+        build_job_dsl(job, xml)
+      end
+      n_xml.to_xml
+    end
+
+    def generate_job_dsl_body(params)
+      @logger.info "Generating pipeline"
+
+      xml = @client.job.build_freestyle_config(params)
+
+      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|
+          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")
+        xml = n_xml.to_xml
+      end
+      xml
+    end
+
+    def build_job_dsl(job, xml)
+      xml.send('javaposse.jobdsl.plugin.ExecuteDslScripts') {
+        if job.has_key?(:job_dsl)
+          xml.scriptText job[:job_dsl]
+          xml.usingScriptText true
+        else
+          xml.targets job[:job_dsl_targets]
+          xml.usingScriptText false
+        end
+        xml.ignoreExisting false
+        xml.removedJobAction 'IGNORE'
+      }
+    end
+  end
+end