cicd-builder 0.9.10

data/README.md

@@ -0,0 +1,4 @@
+cicd-builder
+============
+
+Continuous Integration/ Continuous Deployment builder helper

data/Rakefile

@@ -0,0 +1,30 @@
+# encoding: utf-8
+
+require 'rubygems'
+
+begin
+  require 'bundler'
+rescue LoadError => e
+  warn e.message
+  warn "Run `gem install bundler` to install Bundler."
+  exit -1
+end
+
+begin
+  Bundler.setup(:development)
+rescue Bundler::BundlerError => e
+  warn e.message
+  warn "Run `bundle install` to install missing gems."
+  exit e.status_code
+end
+
+require 'rake'
+
+require 'rubygems/tasks'
+Gem::Tasks.new
+
+require 'cucumber/rake/task'
+
+Cucumber::Rake::Task.new do |t|
+  t.cucumber_opts = %w[--format pretty]
+end

data/cicd-builder.gemspec

@@ -0,0 +1,33 @@
+# -*- encoding: utf-8 -*-
+
+require File.expand_path('../lib/cicd/builder/version', __FILE__)
+
+Gem::Specification.new do |gem|
+  gem.name          = 'cicd-builder'
+  gem.version       = CiCd::Builder::VERSION
+  gem.summary       = 'Jenkins builder task for CI/CD'
+  gem.description   = 'Jenkins builder task for CI/CD'
+  gem.license       = 'Apachev2'
+  gem.authors       = ['Christo De Lange']
+  gem.email         = 'rubygems@dldinternet.com'
+  gem.homepage      = 'https://rubygems.org/gems/cicd-builder'
+
+  gem.files         = `git ls-files`.split($/)
+  gem.executables   = gem.files.grep(%r{^bin/}).map{ |f| File.basename(f) }
+  gem.test_files    = gem.files.grep(%r{^(test|spec|features)/})
+  gem.require_paths = ['lib']
+
+  gem.add_dependency 'awesome_print', ">= 0.0.0"
+  gem.add_dependency 'inifile', '>= 0.0.0'
+  gem.add_dependency 'logging', '>= 0.0.0'
+  gem.add_dependency 'json', '= 1.7.7'
+  gem.add_dependency 'chef', '>= 11.8.2'
+  gem.add_dependency 'aws-sdk', '>= 0.0.0'
+  gem.add_dependency 'yajl-ruby', '>= 0.0.0'
+  gem.add_dependency 'git', '>= 1.2.7'
+
+  gem.add_development_dependency 'bundler', '~> 1.0'
+  gem.add_development_dependency 'rake', '~> 10.3'
+  gem.add_development_dependency 'rubygems-tasks', '~> 0.2'
+  gem.add_development_dependency 'cucumber'
+end

data/features/ci-cd-builder.feature

@@ -0,0 +1 @@
+Feature: Blah blah blah

data/features/cicd-builder.feature

@@ -0,0 +1 @@
+Feature: Blah blah blah

data/features/step_definitions/ci-cd-builder_steps.rb

@@ -0,0 +1 @@
+@wip

data/features/step_definitions/cicd-builder_steps.rb

@@ -0,0 +1 @@
+@wip

data/lib/cicd/builder.rb

@@ -0,0 +1,87 @@
+require 'cicd/builder/version'
+module CiCd
+	module Builder
+
+		require 'awesome_print'
+		require 'optparse'
+		require 'inifile'
+		require 'logging'
+		require 'net/http'
+		require 'uri'
+		require 'fileutils'
+		require 'digest'
+		require 'yajl/json_gem'
+		require 'aws-sdk'
+
+		_lib=File.dirname(__FILE__)
+		$:.unshift(_lib) unless $:.include?(_lib)
+
+		require 'cicd/builder/version'
+		require 'cicd/builder/mixlib/constants'
+
+		#noinspection ALL
+		class BuilderBase
+			attr_accessor :default_options
+			attr_accessor :options
+			attr_accessor :logger
+			attr_accessor :vars
+
+			def initialize()
+        @vars = {
+            return_code: -1
+        }
+				@default_options = {
+						builder:        ::CiCd::Builder::VERSION,
+						env_keys:       %w(JENKINS_HOME BUILD_NUMBER JOB_NAME)
+				}
+			end
+
+			require 'cicd/builder/mixlib/errors'
+			require 'cicd/builder/mixlib/utils'
+			require 'cicd/builder/mixlib/options'
+			require 'cicd/builder/mixlib/environment'
+			require 'cicd/builder/mixlib/repo'
+			require 'cicd/builder/mixlib/build'
+
+			# ---------------------------------------------------------------------------------------------------------------
+      def getBuilderVersion
+        {
+            version:  VERSION,
+            major:    MAJOR,
+            minor:    MINOR,
+            patch:    PATCH,
+        }
+      end
+
+			# ---------------------------------------------------------------------------------------------------------------
+			def run()
+				$stdout.write("CiCd::Builder v#{@VERSION}\n")
+				parseOptions()
+
+				ret = checkEnvironment()
+				if 0 == ret
+					ret = getVars()
+          if 0 == ret
+            ret = prepareBuild()
+            if 0 == ret
+              ret = makeBuild()
+              if 0 == ret
+                ret = saveBuild()
+                if 0 == ret
+                  ret = uploadBuildArtifacts()
+                  if 0 == ret
+                    # noop
+                  end
+                end
+              end
+            end
+          end
+        end
+
+				@vars[:return_code]
+			end
+
+		end
+
+	end
+end

data/lib/cicd/builder/mixlib/build.rb

@@ -0,0 +1,160 @@
+require 'json'
+
+module CiCd
+	module Builder
+
+		# ---------------------------------------------------------------------------------------------------------------
+		def cleanupBuild()
+      [ :build_pkg, :build_chk, :build_mdf, :build_mff ].each do |fil|
+        if File.exists?(@vars[fil])
+          begin
+            FileUtils.rm_f(@vars[fil])
+          rescue => e
+            @logger.error e.to_s
+            #raise e
+            return -96
+          end
+        end
+      end
+			if Dir.exists?(@vars[:build_dir])
+				begin
+					FileUtils.rm_r(@vars[:build_dir])
+				rescue => e
+					@logger.error e.to_s
+					#raise e
+					return -95
+				end
+			end
+			0
+		end
+
+    # ---------------------------------------------------------------------------------------------------------------
+    def prepareBuild()
+      meta = {}
+      %w[ WORKSPACE PROJECT_NAME VERSION RELEASE ].each do |e|
+        unless ENV.has_key?(e)
+          raise "#{e} environment variable is required"
+        end
+      end
+      meta[:Version] = ENV['VERSION']
+      meta[:Release] = ENV['RELEASE']
+
+      place = ''
+      begin
+        place = 'require "git"'
+        eval place
+
+        # Assuming we are in the workspace ...
+        place = "Git.open('#{ENV['WORKSPACE']}')"
+        git = Git.open(ENV['WORKSPACE'], :log => @logger)
+        place = 'git.log'
+        meta[:Commit] = git.log[0].sha
+        place = 'git.current_branch'
+        meta[:Branch] = git.current_branch
+
+        @vars[:build_bra] = meta[:Branch].gsub(%r([/|]),'.')
+        @vars[:build_ver] = "#{meta[:Version]}"
+        @vars[:build_vrb] = "#{@vars[:build_ver]}-release-#{meta[:Release]}-#{@vars[:build_bra]}-#{@vars[:variant]}" #
+        @vars[:build_nam] = "#{@vars[:project_name]}-#{@vars[:build_vrb]}"
+        @vars[:build_rel] = "#{@vars[:build_nam]}-build-#{@vars[:build_num]}"
+        @vars[:build_dir] = "#{ENV['WORKSPACE']}/#{@vars[:build_rel]}"
+        @vars[:latest_pkg]= "#{@vars[:build_store]}/#{@vars[:build_rel]}.tar.gz"
+        @vars[:build_pkg] = "#{@vars[:build_rel]}.tar.gz"
+        @vars[:build_chk] = "#{@vars[:build_rel]}.checksum"
+        @vars[:build_mff] = "#{@vars[:build_rel]}.manifest"
+        @vars[:build_mdf] = "#{@vars[:build_rel]}.meta"
+        @vars[:build_mdd] = meta.dup
+        #noinspection RubyArgCount
+        @vars[:build_mds] = Digest::SHA256.hexdigest(meta.to_s)
+
+        @vars[:return_code] = 0
+
+      rescue Exception => e
+        @logger.error "#{e.class}:: '#{place}' - #{e.message}"
+        @vars[:return_code] = -98
+      end
+
+      @vars[:return_code]
+    end
+
+    # ---------------------------------------------------------------------------------------------------------------
+    def makeBuild()
+      if @vars.has_key?(:build_dir) and @vars.has_key?(:build_pkg)
+        begin
+          do_build = false
+          if File.exists?(@vars[:build_chk])
+            @vars[:build_sha] = IO.readlines(@vars[:build_chk])
+            unless @vars[:build_sha].is_a?(Array)
+              @logger.error "Unable to parse build checksum from #{@vars[:build_chk]}"
+              return -97
+            end
+            @vars[:build_sha] = @vars[:build_sha][0].chomp()
+          else
+            @vars[:build_sha] = ''
+            do_build = true
+          end
+          unless File.exists?(@vars[:build_pkg])
+            do_build = true
+          end
+          if do_build
+            @vars[:return_code] = cleanupBuild()
+            return @vars[:return_code] unless @vars[:return_code] == 0
+            @vars[:build_dte] = DateTime.now.strftime("%F %T%:z")
+            createMetaData()
+            @vars[:return_code] = packageBuild()
+            if 0 == @vars[:return_code]
+              @vars[:check_sha] = @vars[:build_sha]
+              @vars[:build_sha] = Digest::SHA256.file(@vars[:build_pkg]).hexdigest()
+              IO.write(@vars[:build_chk], @vars[:build_sha])
+            end
+            reportStatus()
+            reportResult()
+          else
+            reportStatus()
+
+            # No need to build again :)
+            @logger.info "NO_CHANGE: #{ENV['JOB_NAME']} #{ENV['BUILD_NUMBER']} #{@vars[:build_nam]} #{@vars[:build_pkg]} #{@vars[:build_chk]} [#{@vars[:build_sha]}]"
+            @vars[:return_code] = 0
+            return 1
+          end
+        rescue => e
+          @logger.error "#{e.class.name} #{e.message}"
+          @vars[:return_code] = -99
+        end
+      else
+        @logger.error ":build_dir or :build_pkg is unknown"
+        @vars[:return_code] = 2
+      end
+      @vars[:return_code]
+    end
+
+    # ---------------------------------------------------------------------------------------------------------------
+		def packageBuild()
+			excludes=%w(*.iml *.txt *.sh *.md .gitignore .editorconfig .jshintrc *.deprecated adminer doc)
+			excludes = excludes.map{ |e| "--exclude=#{@vars[:build_nam]}/#{e}" }.join(' ')
+			cmd = %(cd #{ENV['WORKSPACE']}; tar zcvf #{@vars[:build_pkg]} #{excludes} #{@vars[:build_nam]} 1>#{@vars[:build_pkg]}.manifest)
+			@logger.info cmd
+			logger_info = %x(#{cmd})
+			ret = $?.exitstatus
+			@logger.info logger_info
+			FileUtils.rmtree(@vars[:build_dir])
+			ret
+		end
+
+    # ---------------------------------------------------------------------------------------------------------------
+    def createMetaData()
+      @vars[:build_mdd].merge!({
+                                :Generation => @options[:gen],
+                                :Project => @vars[:project_name],
+                                :Variant => @vars[:variant],
+                                :Build => @vars[:build_num],
+                                :Date => @vars[:build_dte],
+                                :Builder => VERSION,
+
+                                      })
+      json = JSON.pretty_generate( @vars[:build_mdd], { indent: "\t", space: ' '})
+      IO.write(@vars[:build_mdf], json)
+    end
+
+  end
+end

data/lib/cicd/builder/mixlib/constants.rb

@@ -0,0 +1,18 @@
+module CiCd
+	module Builder
+		#noinspection RubyStringKeysInHashInspection
+		LOGLEVELS = {
+			'crit'     => :fatal,
+			'critical' => :fatal,
+			'err'      => :error,
+			'error'    => :error,
+			'warn'     => :warn,
+			'warning'  => :warn,
+			'info'     => :info,
+			'debug'    => :debug,
+		}
+
+		MYNAME       = File.basename(__FILE__)
+
+	end
+end

data/lib/cicd/builder/mixlib/environment.rb

@@ -0,0 +1,194 @@
+module CiCd
+	module Builder
+    require 'awesome_print'
+
+		# ---------------------------------------------------------------------------------------------------------------
+		def checkEnvironment()
+			# [2013-12-30 Christo] Detect CI ...
+			unless ENV.has_key?('JENKINS_HOME')
+				puts 'Sorry, your CI environment is not supported at this time (2013-12-30) ... Christo De Lange'
+				puts 'This script is developed for Jenkins so either you are not using Jenkins or you ran me outside of the CI ecosystem ...'
+				return 99
+			end
+
+			# Check for the necessary environment variables
+			map_keys = {}
+
+			@options[:env_keys].each { |k|
+				map_keys[k]= (not ENV.has_key?(k))
+			}
+			missing = map_keys.keys.select{ |k| map_keys[k] }
+
+			if missing.count() > 0
+				ap missing
+				raise Exception.new("Need environment variables: #{missing}")
+			end
+			0
+		end
+
+		# ---------------------------------------------------------------------------------------------------------------
+		def getVars()
+			@vars               ||= {}
+			@vars[:release]     = 'latest'
+			@vars[:build_store] = '/tmp'
+			@vars[:variant]     = 'SNAPSHOT'
+
+			if ENV.has_key?('PROJECT_NAME')
+				@vars[:project_name] = ENV['PROJECT_NAME']
+			end
+
+			if ENV.has_key?('RELEASE')
+				@vars[:release] = ENV['RELEASE']
+			end
+
+			if ENV.has_key?('BUILD_STORE')
+				@vars[:build_store] = "#{ENV['BUILD_STORE']}"
+			end
+
+			if ENV.has_key?('VARIANT')
+				@vars[:variant] = "#{ENV['VARIANT']}"
+			end
+
+			if ENV.has_key?('BUILD_NUMBER')
+				@vars[:build_num] = "#{ENV['BUILD_NUMBER']}"
+			end
+
+			@vars[:return_code] = getLatest()
+		end
+
+    def getLatest
+      ret = 0
+      @vars[:vars_fil] = "#{@vars[:build_store]}/#{ENV['JOB_NAME']}-#{@vars[:variant]}.env"
+      @vars[:latest_fil] = "#{@vars[:build_store]}/#{ENV['JOB_NAME']}-#{@vars[:variant]}.latest"
+      @vars[:latest_ver] = ''
+      @vars[:latest_sha] = ''
+      @vars[:latest_pkg] = ''
+      if @vars[:build_nam]
+        @vars[:latest_pkg]= "#{@vars[:build_store]}/#{@vars[:build_nam]}.tar.gz"
+      end
+      if File.exists?(@vars[:latest_fil])
+        @vars[:latest_ver] = IO.readlines(@vars[:latest_fil])
+        unless @vars[:latest_ver].is_a?(Array)
+          @logger.error "Unable to parse latest version from #{@vars[:latest_fil]}"
+          ret = -97
+        end
+        @vars[:latest_sha] = @vars[:latest_ver][1].chomp() if (@vars[:latest_ver].length > 1)
+        @vars[:latest_ver] = @vars[:latest_ver][0].chomp()
+      end
+      ret
+    end
+
+    # ---------------------------------------------------------------------------------------------------------------
+		def saveEnvironment(ignored=[])
+			@logger.info "Save environment to #{@vars[:vars_fil]}"
+			vstr = ['[global]']
+			ENV.to_hash.sort.each{|k,v|
+				vstr << %(#{k}="#{v}") unless ignored.include?(k)
+			}
+
+			IO.write(@vars[:vars_fil], vstr.join("\n"))
+		end
+
+    # ---------------------------------------------------------------------------------------------------------------
+    def saveBuild()
+      begin
+        raise 'ERROR: Checksum not read'       unless @vars.has_key?(:latest_sha)
+        raise 'ERROR: Checksum not calculated' unless @vars.has_key?(:build_sha)
+        change = false
+        if @vars[:latest_sha] != @vars[:build_sha]
+          change = true
+          @logger.info "CHANGE: Checksum [#{@vars[:latest_sha]}] => [#{@vars[:build_sha]}]"
+        end
+        if @vars[:latest_ver] != @vars[:build_ver]
+          change = true
+          @logger.info "CHANGE: Release [#{@vars[:latest_ver]}] => [#{@vars[:build_ver]}]"
+        end
+        unless File.file?(@vars[:build_pkg])
+          change = true
+          @logger.info "CHANGE: No #{@vars[:build_pkg]}"
+        end
+        unless File.symlink?(@vars[:latest_pkg])
+          change = true
+          @logger.info "CHANGE: No #{@vars[:latest_pkg]}"
+        end
+
+        if change
+          if @vars[:latest_pkg] != @vars[:build_pkg]
+            @logger.info "Link #{@vars[:latest_pkg]} to #{@vars[:build_pkg]}"
+            begin
+              File.unlink(@vars[:latest_pkg])
+            rescue
+              # noop
+            end
+            File.symlink(@vars[:build_pkg], @vars[:latest_pkg])
+          end
+          @logger.info "Save latest build info to #{@vars[:latest_fil]}"
+          IO.write(@vars[:latest_fil], "#{@vars[:build_ver]}\n#{@vars[:build_sha]}")
+          saveEnvironment(['LS_COLORS','AWS_ACCESS_KEY_ID','AWS_SECRET_ACCESS_KEY'])
+          # NOTE the '.note'!
+          @logger.note "CHANGE: #{ENV['JOB_NAME']} (#{@vars[:build_ver]}[#{@vars[:build_sha]}])"
+
+        else
+          @logger.info "Artifact #{@vars[:latest_pkg]} unchanged (#{@vars[:latest_ver]} [#{@vars[:latest_sha]}])"
+          @logger.info "NO_CHANGE: #{ENV['JOB_NAME']} #{@vars[:latest_ver]}"
+        end
+        @vars[:return_code] = 0
+      rescue => e
+        @logger.error "#{e.backtrace[0]}: #{e.class.name} #{e.message}"
+        @vars[:return_code] = 2
+      end
+      @vars[:return_code]
+    end
+
+    def reportResult()
+      if 0 == @vars[:return_code]
+        # NOTE the '.note'!
+        @logger.note  "CHANGE:  #{ENV['JOB_NAME']} #{ENV['BUILD_NUMBER']} #{@vars[:build_nam]} (#{@vars[:build_pkg]}) [#{@vars[:check_sha]}] => [#{@vars[:build_sha]}]"
+      else
+        @logger.error "FAILURE: #{ENV['JOB_NAME']} #{ENV['BUILD_NUMBER']} #{@vars[:build_pkg]} #{@vars[:return_code]}"
+      end
+    end
+
+		# ---------------------------------------------------------------------------------------------------------------
+		def reportStatus(ignored=[])
+      # [2013-12-30 Christo] Report status,environment, etc.
+
+			if @logger.level < ::Logging::LEVELS['warn']
+				@logger.info '='*100
+				@logger.info Dir.getwd()
+				@logger.info '='*100
+
+				@logger.info "Config:"
+				@options.each{|k,v|
+					unless ignored.include?(k)
+						@logger.info sprintf("%25s: %s", "#{k.to_s}",  "#{v.to_s}")
+					end
+				}
+
+				@logger.info '='*100
+
+				@logger.info "Parameters:"
+				@vars.sort.each{|k,v|
+					unless ignored.include?(k)
+						@logger.info sprintf("%25s: %s", "#{k.to_s}",  "#{v.to_s}")
+					end
+				}
+
+				@logger.info '='*100
+			end
+
+			if @logger.level < ::Logging::LEVELS['info']
+				@logger.debug '='*100
+				@logger.debug "Environment:"
+				ENV.sort.each{|k,v|
+					unless ignored.include?(k)
+						@logger.debug sprintf("%25s: %s", "#{k.to_s}",  "#{v.to_s}")
+					end
+				}
+
+				@logger.debug '='*100
+			end
+		end
+
+	end
+end