jenkins_pipeline_builder 0.1.2 → 0.1.3

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: a51b7671b90bc706508aba474628980817e8abfe
-  data.tar.gz: da82317e81c5a96e56c8db8fd689fd9bf3d8bc3b
+  metadata.gz: 7ca15662c8969eb3344f177fcb31ab60d00d6b22
+  data.tar.gz: 8f65fdb0f74e18c8f301db3d7002fe842ca9f972
 SHA512:
-  metadata.gz: 88428366c3ad687d61414669a70bae70d1c506c7c9163c737f732fa44f577d88048d5c111c4e70fcfd733cbcde0a09726dd691c185f8312b2da7deddd33cc5d1
-  data.tar.gz: 1f0988e8379ae9fa01d842db848eeaa99c57a1a10fc2fdd5e4ff81fd776d90e659131c3d0fa5d4a94c31582e374f72b646ce0d52340918c4fef8baa2a65c69ad
+  metadata.gz: 439d16077649cd6bcf6ab257c59ff1fe4703275a9eb25bbc43b4579ec867e579230761edbb30ef14420f32ab2bc4d0063e5c4e02555e000569242c83cb70dedd
+  data.tar.gz: 8f8f450ac270775f331038742d3c7390ae521339a4ef846197c1c8110a124f5d7e14565c5b2d2f959b39e9881d104a2a563ea895ba74371b135613167d89066a

data/.ruby-gemset

@@ -0,0 +1 @@
+jenkins_pipeline_builder

data/.ruby-version

@@ -0,0 +1 @@
+ruby-2.0.0-p247

data/Gemfile

@@ -0,0 +1,4 @@
+source "https://rubygems.org"
+
+# Specify your gem's dependencies in jenkins_pipeline_builder.gemspec
+gemspec

data/Rakefile

@@ -0,0 +1,68 @@
+#
+# 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.
+#
+
+#!/usr/bin/env rake
+require 'rspec/core/rake_task'
+require 'yard'
+
+RSpec::Core::RakeTask.new(:spec, :tag) do |t, task_args|
+  t.pattern = ".spec/**/*_spec.rb"
+  t.verbose = true
+  t.fail_on_error = false
+  t.rspec_opts = spec_output 'spec.xml'
+end
+
+def spec_output(filename)
+  "--color --format documentation --format RspecJunitFormatter --out out/#{filename}"
+end
+
+RSpec::Core::RakeTask.new(:unit_tests) do |spec|
+  spec.pattern = FileList['spec/unit_tests/*_spec.rb']
+  spec.rspec_opts = ['--color', '--format documentation']
+end
+
+RSpec::Core::RakeTask.new(:func_tests) do |spec|
+  spec.pattern = FileList['spec/func_tests/*_spec.rb']
+  spec.rspec_opts = ['--color', '--format documentation']
+end
+
+RSpec::Core::RakeTask.new(:test) do |spec|
+  spec.pattern = FileList['spec/*/*.rb']
+  spec.rspec_opts = ['--color', '--format documentation']
+end
+
+YARD::Config.load_plugin 'thor'
+YARD::Rake::YardocTask.new do |t|
+  t.files = ['lib/**/*.rb', 'lib/**/**/*.rb']
+end
+
+namespace :doc do
+  # This task requires that graphviz is installed locally. For more info:
+  # http://www.graphviz.org/
+  desc "Generates the class diagram using the yard generated dot file"
+  task :generate_class_diagram do
+    puts "Generating the dot file..."
+    `yard graph --file jenkins_api_client.dot`
+    puts "Generating class diagram from the dot file..."
+    `dot jenkins_api_client.dot -Tpng -o jenkins_api_client_class_diagram.png`
+  end
+end

data/bin/generate

@@ -0,0 +1,28 @@
+#
+# 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.
+#
+
+#!/usr/bin/env ruby
+
+$LOAD_PATH.unshift(File.expand_path(File.dirname(__FILE__) + "/../lib"))
+require 'jenksin_pipeline_builder'
+JenkinsPipelineBuilder::CLI::Base.start
+

data/config/login.yml

@@ -0,0 +1,24 @@
+# The Jenkins server and login information can be stored in a YAML file like this
+# so we don't have to pass in the parameters every we login to the server
+# through this API client.
+
+# This file contains the following four parameters
+
+# The IP address of the Jenkins CI Server
+
+:server_ip: server_ip
+#:server_url: https://server_url/
+
+# The port number on which the Jenkins listens on. The default is 8080
+
+#:server_port: 8080
+
+# If there is a web server routing your Jenkins requests you might need this
+
+#:jenkins_path: ""
+
+# The username and password to authenticate to the server
+
+:username: username
+#:password: my_password
+:password_base64: my_base64_password

data/jenkins_pipeline_builder.gemspec

@@ -0,0 +1,42 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'jenksin_pipeline_builder/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = 'jenkins_pipeline_builder'
+  spec.version       = JenkinsPipelineBuilder::VERSION
+  spec.authors       = ['Igor Moochnick']
+  spec.email         = %w(igor.moochnick@gmail.com)
+  spec.description   = %q{This is a simple and easy-to-use Jenkins Pipeline generator with features focused on
+automating Job & Pipeline creation from the YAML files checked-in with your application source code}
+  spec.summary       = %q{This gem is will boostrap your Jenkins pipelines}
+  spec.homepage      = 'https://github.com/IgorShare/jenkins_pipeline_builder'
+  spec.license       = 'MIT'
+
+  spec.files         = `git ls-files`.split($/)
+  spec.executables   = spec.files.grep(%r{^bin/}) { |f| File.basename(f) }
+  spec.test_files    = spec.files.grep(%r{^(test|spec|features)/})
+  spec.require_paths = ["lib"]
+
+  ENV['NOKOGIRI_USE_SYSTEM_LIBRARIES']='true'
+
+  spec.add_dependency 'nokogiri', '~> 1.5.0'
+  spec.add_dependency 'jenkins_api_client', '~> 0.14.1'
+  spec.add_dependency 'thor', '>= 0.18.0'
+
+  spec.add_development_dependency 'bundler', '~> 1.3'
+  spec.add_development_dependency 'rake'
+  spec.add_development_dependency 'rspec', '~> 2.14'
+  spec.add_development_dependency 'bump'
+  spec.add_development_dependency 'gem-release'
+  spec.add_development_dependency 'pry'
+  spec.add_development_dependency 'simplecov'
+  spec.add_development_dependency 'simplecov-rcov'
+  spec.add_development_dependency 'kwalify'
+  spec.add_development_dependency 'equivalent-xml'
+  spec.add_development_dependency 'yard-thor'
+  spec.add_development_dependency 'yard'
+  spec.add_development_dependency 'rspec_junit_formatter'
+  spec.add_development_dependency 'webmock'
+end

data/lib/jenksin_pipeline_builder.rb

@@ -0,0 +1,39 @@
+#
+# 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 'jenksin_pipeline_builder/version'
+require 'jenksin_pipeline_builder/utils'
+require 'jenksin_pipeline_builder/xml_helper'
+require 'jenksin_pipeline_builder/compiler'
+require 'jenksin_pipeline_builder/job_builder'
+require 'jenksin_pipeline_builder/module_registry'
+require 'jenksin_pipeline_builder/builders'
+require 'jenksin_pipeline_builder/wrappers'
+require 'jenksin_pipeline_builder/triggers'
+require 'jenksin_pipeline_builder/publishers'
+require 'jenksin_pipeline_builder/view'
+require 'jenksin_pipeline_builder/generator'
+
+require 'jenksin_pipeline_builder/cli/helper'
+require 'jenksin_pipeline_builder/cli/view'
+require 'jenksin_pipeline_builder/cli/pipeline'
+require 'jenksin_pipeline_builder/cli/base'

data/lib/jenksin_pipeline_builder/builders.rb

@@ -0,0 +1,72 @@
+#
+# 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 Builders
+    def self.build_multijob_builder(params, xml)
+      xml.send('com.tikal.jenkins.plugins.multijob.MultiJobBuilder') {
+        xml.phaseName 'Child Jobs'
+        xml.phaseJobs {
+          proc = lambda do |xml, name|
+            xml.send('com.tikal.jenkins.plugins.multijob.PhaseJobsConfig') {
+              xml.jobName name
+              xml.currParams false
+              xml.exposedSCM false
+              xml.configs {
+                xml.send('hudson.plugins.parameterizedtrigger.PredefinedBuildParameters') {
+                  xml.properties 'PARENT_WORKSPACE=${WORKSPACE}'
+                }
+              }
+            }
+          end
+          params[:child_jobs].each do |name|
+            proc.call xml, name
+          end
+        }
+        xml.continuationCondition params[:mark_phase]
+      }
+    end
+
+    def self.build_maven3(params, xml)
+      xml.send('org.jfrog.hudson.maven3.Maven3Builder') {
+        xml.mavenName 'tools-maven-3.0.3'
+        xml.rootPom params[:rootPom]
+        xml.goals params[:goals]
+        xml.mavenOpts params[:options]
+      }
+    end
+
+    def self.build_shell_command(param, xml)
+      xml.send('hudson.tasks.Shell') {
+        xml.command param
+      }
+    end
+
+    def self.build_environment_vars_injector(params, xml)
+      xml.EnvInjectBuilder {
+        xml.info {
+          xml.propertiesFilePath params
+        }
+      }
+    end
+  end
+end

data/lib/jenksin_pipeline_builder/cli/base.rb

@@ -0,0 +1,69 @@
+#
+# 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 'thor'
+#require "#{File.dirname(__FILE__)}/pipeline.rb"
+
+module JenkinsPipelineBuilder
+  module CLI
+    class Base < Thor
+
+      class_option :username, :aliases => "-u", :desc => "Name of Jenkins user"
+      class_option :password, :aliases => "-p",
+                   :desc => "Password of Jenkins user"
+      class_option :password_base64, :aliases => "-b",
+                   :desc => "Base 64 encoded password of Jenkins user"
+      class_option :server_ip, :aliases => "-s",
+                   :desc => "Jenkins server IP address"
+      class_option :server_port, :aliases => "-o", :desc => "Jenkins port"
+      class_option :creds_file, :aliases => "-c",
+                   :desc => "Credentials file for communicating with Jenkins server"
+      class_option :debug, :type => :boolean, :aliases => "-d", :desc => "Run in debug mode (no Jenkins changes)",
+                   :default => false
+
+
+      map "-v" => :version
+
+      desc "version", "Shows current version"
+      # CLI command that returns the version of Jenkins API Client
+      def version
+        puts JenkinsPipelineBuilder::VERSION
+      end
+
+      # Register the CLI::Pipeline class as "pipeline" subcommand to CLI
+      register(
+          CLI::Pipeline,
+          'pipeline',
+          'pipeline [subcommand]',
+          'Provides functions to access pipeline functions of the Jenkins CI server'
+      )
+
+      # Register the CLI::Job class as "view" subcommand to CLI
+      register(
+          CLI::View,
+          'view',
+          'view [subcommand]',
+          'Provides functions to access view interface of Jenkins CI server'
+      )
+    end
+  end
+end

data/lib/jenksin_pipeline_builder/cli/helper.rb

@@ -0,0 +1,68 @@
+#
+# 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 'fileutils'
+require 'yaml'
+require 'jenkins_api_client'
+
+module JenkinsPipelineBuilder
+  module CLI
+    # This is the helper class that sets up the credentials from the command
+    # line parameters given and initializes the Jenkins Pipeline Builder.
+    class Helper
+      # Sets up the credentials and initializes the Jenkins Pipeline Builder
+      #
+      # @param [Hash] options Options obtained from the command line
+      #
+      # @return [JenkinsPipelineBuilder::Generator] A new Client object
+      #
+      def self.setup(options)
+        if options[:username] && options[:server_ip] && \
+          (options[:password] || options[:password_base64])
+          creds = options
+        elsif options[:creds_file]
+          creds = YAML.load_file(
+              #File.expand_path(options[:creds_file], __FILE__)
+              options[:creds_file]
+          )
+        elsif File.exist?("#{ENV['HOME']}/.jenkins_api_client/login.yml")
+          creds = YAML.load_file(
+              File.expand_path(
+                  "#{ENV['HOME']}/.jenkins_api_client/login.yml", __FILE__
+              )
+          )
+        else
+          msg = "Credentials are not set. Please pass them as parameters or"
+          msg << " set them in the default credentials file"
+          puts msg
+          exit 1
+        end
+
+        #creds[:log_level] =  Logger::DEBUG
+        client = JenkinsApi::Client.new(creds)
+        generator = JenkinsPipelineBuilder::Generator.new(options, client)
+        generator.debug = options[:debug] #== 'debug'
+        return generator
+      end
+    end
+  end
+end

data/lib/jenksin_pipeline_builder/cli/pipeline.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 Pipeline < Thor
+      include Thor::Actions
+
+      desc 'dump', 'Dump job'
+      def dump(job_name)
+        Helper.setup(parent_options).dump(job_name)
+      end
+
+      desc 'bootstrap Path', 'Generates pipeline from folder or a file'
+      def bootstrap(path)
+        Helper.setup(parent_options).bootstrap(path)
+      end
+    end
+  end
+end