azbuild 1.0.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 912af354939208cdcaa18b47b7b566da75ac0107
+  data.tar.gz: e455f03afb79053387f59ca0522908aac607f4e2
+SHA512:
+  metadata.gz: a02e03e702ddbcae033201c29545fafe13728a77ce5c17de2363a8fe1c2f8b9114aeedaca37dc90bbd730ddaa1e0a6a70d5a51f0bbdc403fa7474ad9c8813ac5
+  data.tar.gz: 818145206931035c8176708d3f43fd65a6b2c58e5f8031ddd2f1cdc72d5154ac1654642626cbf4745e3daff5e90148f76d9e53c9b03dfc5c02d2329f7255ca68

data/README.md

@@ -0,0 +1,93 @@
+azbuild
+========
+
+.Net solutions that are built using the ruby gem albacore and use semantic versioning via semver have verbosity and bloated rake files with some boiler plate that can be reduced and simplified. There are also configuration transforms that can be applied per deployable environment before projects are built. This gem azbuild provides those functions.
+
+The gem also simplifies ruby version and gem dependencies by bootstrapping itself to detect and install right gem versions. This may soon chnage to use bundler in future.
+
+<b>Note: </b>azbuild is the next evolution of <b>azdeploy</b> gem that is available on http://rubygems.org
+
+<b>Where do configuration values come from?</b>
+
+Currently, configuration key value pairs for specific transforms are stored and retrived from an Azure Table using azure ruby gem. More transforms can be added as well as other configuration sources
+
+<b>How to use the gem</b>
+
+azbuild is in development and you'll need to use azdeploy until azbuild development is complete.
+
+To start using azdeploy, 
+
+1. install Ruby version 2.0.0p481
+2. install azdeploy from http://rubygems.org
+3. require the azdeploy gem in a blank rake script
+4. run rake script
+
+Running the rake script from above will kick-off the install sequence and install all requisite gems. Follow prompts and take appropriate actions like restarting console.
+
+A typical build would perform the following steps:
+
+1. clean solution build output folders
+2. transform configuration
+3. restore nuget packages
+4. build the solution
+5. run unit tests
+6. copy build output to specified folders
+7. create nuget packages as specified and copy to artifacts folders
+8. run publish where required (web projects)
+
+Few examples of tasks and their usage is as follows:
+
+```
+desc 'Prepares the working directory for a new build'
+task :clean do
+  cleantask(BUILD_PATHS)
+end
+
+desc 'Transform Configuration'
+task :transform_config do
+    Transform.new.transform([''])
+end
+
+desc 'restores missing packages'
+task :restore do
+    restore_nuget(NUGET)   # path of nuget exe
+end
+
+desc 'Only compiles the application.'
+msbuild :build do |msb|
+  msb.targets :Clean, :Build 
+  clean_build(msb, "src/#{PRODUCT}.sln")
+end
+
+desc "Publishes."
+msbuild :publish do |msb|
+  msb.targets :Publish
+  clean_build(msb, "src/#{PRODUCT}.sln")
+end
+
+desc 'Running rake for each sub project'
+task :package do
+   
+end
+
+desc 'Copies build output to designated folders.'
+task :copy_output do
+  outputs.each { |name, filter|
+    copy_output_files File.join(BUILD_PATHS[:src], name), filter, File.join(BUILD_PATHS[:output], 'net-4.5')
+  }
+end
+
+desc 'Cleans, versions, compiles the application and generates build_output.'
+task :compile => [:build, :tests, :copy_output]
+
+desc '**Default**, compiles and runs tests'
+task :default => [:clean, :transform_config, :restore, :compile, :package, :publish]
+
+```
+
+Instructions for azbuild when it's ready:
+
+1. Install latest version of Ruby
+2. Install the gem from http://rubygems.org
+3. Run bundle update
+4. require gem in a rake script and start using available methods

data/azbuild.gemspec

@@ -0,0 +1,12 @@
+Gem::Specification.new do |s|
+  s.name        = 'azbuild'
+  s.version     = '1.0.0'
+  s.date        = '2016-08-14'
+  s.summary     = 'Setup and scripting support for .Net project builds'
+  s.description = 'Build, Configuration and Deployment Gem for .Net Solutions'
+  s.authors     = ['Suresh Batta']
+  s.email       = 'subatta@hotmail.com'
+  s.files       = Dir['{lib,test}/**/*'] + ['azbuild.gemspec', 'README.md', 'rakefile.rb']
+  s.homepage    = 'http://rubygems.org/gems/azbuild'
+  s.license     = 'MIT'
+end

data/lib/azbuild.rb

@@ -0,0 +1,24 @@
+require_relative 'string_extensions.rb'
+require_relative 'install.rb'
+require_relative 'build.rb'
+require_relative 'versioning.rb'
+require_relative 'package.rb'
+require_relative 'semver_extensions'
+
+# installation
+installers = [
+  'ruby', 'gems'
+]
+
+installers.each { |method|
+  exit if !send("check_#{method}")
+}
+
+#require 'rubygems'
+require 'nokogiri'
+
+# includes for rake build
+include FileTest
+require 'albacore'
+require 'semver'
+require 'json'

data/lib/build.rb

@@ -0,0 +1,92 @@
+
+def copy_output_files fromDir, filePattern, outDir
+  FileUtils.mkdir_p outDir unless exists?(outDir)
+  Dir.glob(File.join(fromDir, filePattern)){|file|
+    copy(file, outDir) if File.file?(file)
+  }
+end
+
+def project_outputs props
+  props[:projects].map{ |p| "src/#{p}/bin/#{BUILD_CONFIG}/#{p}.dll" }.
+    concat( props[:projects].map{ |p| "src/#{p}/bin/#{BUILD_CONFIG}/#{p}.exe" } ).
+    find_all{ |path| exists?(path) }
+end
+
+def add_files stage, what_dlls, nuspec, folder='lib'
+  [['net35', 'net-3.5'], ['net40', 'net-4.0'], ['net45', 'net-4.5']].each{|fw|
+    takeFrom = File.join(stage, fw[1], what_dlls)
+    Dir.glob(takeFrom).each do |f|
+      nuspec.file(f.gsub("/", "\\"), "#{folder}\\#{fw[0]}")
+    end
+  }
+end
+
+def commit_data
+  begin
+    commit = `git rev-parse --short HEAD`.chomp()[0,6]
+    git_date = `git log -1 --date=iso --pretty=format:%ad`
+    commit_date = DateTime.parse( git_date ).strftime("%Y-%m-%d %H%M%S")
+  rescue Exception => e
+    puts e.inspect
+    commit = (ENV['BUILD_VCS_NUMBER'] || "000000")[0,6]
+    commit_date = Time.new.strftime("%Y-%m-%d %H%M%S")
+  end
+  [commit, commit_date]
+end
+
+def waitfor &block
+  checks = 0
+
+  until block.call || checks >10
+    sleep 0.5
+    checks += 1
+  end
+
+  raise 'Waitfor timeout expired. Make sure that you aren\'t ' \
+    'running something from the build output folders, or that you ' \
+    'have browsed to it through Explorer.'.red if checks > 10
+end
+
+def cleantask props
+
+  if props.has_key?(:output) && File.directory?(props[:output])
+    FileUtils.rm_rf props[:output]
+    waitfor { !exists?(props[:output]) }
+  end
+
+  if props.has_key?(:artifacts) && File.directory?(props[:artifacts])
+    FileUtils.rm_rf props[:artifacts]
+    waitfor { !exists?(props[:artifacts]) }
+  end
+
+  if props.has_key?(:output)
+    Dir.mkdir props[:output]
+  end
+  if props.has_key?(:artifacts)
+    Dir.mkdir props[:artifacts]
+  end
+end
+
+def run_vsconsole_tests settings, params = nil, assemblies = nil
+
+  raise 'Settings file name is required' if settings.nil?
+
+  if assemblies.nil?
+    assemblies = FileList["**/#{OUTPUT_PATH}/*.Tests.dll"]
+    filelist = assemblies.map { |assembly| File.join(Dir.pwd, assembly)}
+  end
+
+  test_runner :tests do |tests|
+    tests.files = filelist
+    tests.exe = 'C:/Program Files (x86)/Microsoft Visual Studio 14.0/Common7/IDE/CommonExtensions/Microsoft/TestWindow/VSTest.console.exe'
+    if (params != nil)
+      params.each { | p |
+        tests.add_parameter p 
+      }
+    end
+    tests.add_parameter '/InIsolation'
+    tests.add_parameter '/Logger:trx'
+    tests.add_parameter "/Settings:#{Dir.pwd}/#{settings}.runsettings"
+  end
+
+end

data/lib/install.rb

@@ -0,0 +1,74 @@
+require 'net/http'
+
+$ruby_version_map = {
+  '2.3.1-p112' => {
+    :gems => {
+      'nokogiri' => '1.6.8',
+      'albacore' => '2.6.1',
+      'semver2' => '3.4.2',
+      'nuget' => '3.2.0'
+    }
+  }
+}
+
+$selected_version = {}
+
+# Ruby version check
+def check_ruby
+  puts "Checking ruby version...".bg_green.white if (ENV['debug'])
+
+  # check if expected ruby version exists. If not download and install ruby
+  rubyVersion = "#{RUBY_VERSION}"
+  localVersion = "#{RUBY_VERSION}-p#{RUBY_PATCHLEVEL}"
+  expectedVersions = $ruby_version_map.keys
+  if (!rubyVersion.nil? && !expectedVersions.include?(localVersion))
+    puts "Uninstall incompatible version of ruby: #{localVersion} and " \
+    	"install any one of these Ruby versions: #{expectedVersions}. " \
+    	"Then Restart rake. Goto http://rubyinstaller.org/downloads/".red
+    return false
+  else
+    puts "#{localVersion} is the expected version.".green if (ENV['debug'])
+  end
+
+  $selected_version = $ruby_version_map[localVersion]
+  if ($selected_version != nil)
+    puts "Ruby version found: #{localVersion}".green if (ENV['debug'])
+    puts 'Ruby ok'.green if (ENV['debug'])
+  end
+  return true
+end
+
+# check and install required gems
+def check_gems
+  puts 'Checking required gems...'.bg_green.white if (ENV['debug'])
+  $selected_version[:gems].each {|key, value|
+    if !gem_exists(key, value)
+      begin
+        puts "Installing missing gem: #{key}".bg_green.white
+        cmd = "gem install #{key} -v #{value}"
+        cmdoutput = `#{cmd}`
+        puts cmdoutput.bg_green.white
+      rescue
+        puts 'gem install failed'.red
+        puts $!
+        return false    # don't continue if even one gem install fails
+      end
+    else
+      puts "Gem #{key}, #{value} exists".green if (ENV['debug'])
+    end
+  }
+  # all gems installed
+  return true
+end
+
+# Checks if a gem of a version exists
+def gem_exists(name, version)
+  begin
+    gem name, "=#{version}"
+  rescue Gem::LoadError
+    puts "failed to load gem #{name} -v #{version}".red
+    Gem.clear_paths
+    return false
+  end
+  return true
+end

data/lib/package.rb

@@ -0,0 +1,76 @@
+def nuget_pack id, config, artifact_path
+  require 'albacore/task_types/nugets_pack'
+
+  p = Albacore::NugetsPack::Config.new
+
+  p.configuration = BUILD_CONFIG
+
+  if !config.has_key? :project || config[:project] == ''
+    raise 'At least one project is required to build'.red
+  end
+
+  p.files = config[:project]
+
+  if config.has_key? :nuspec && config[:nuspec] != ''
+    p.nuspec = config[:nuspec]
+  end
+
+  p.out = artifact_path
+
+  p.with_metadata do |m|
+    m.id = id
+    m.title = PRODUCT
+    m.description = PRODUCT_DESCRIPTION
+    m.authors = COMPANY
+    m.version = config[:version]
+    if config.has_key? :dependencies
+      config[:dependencies].each { |name, version|
+        m.add_dependency name, version
+      }
+    end
+  end
+
+  p.target = config[:target_framework]
+  p.with_package do |p|
+    if config.has_key? :files
+      config[:files].each { |folder, files|
+        files.each{ |file|
+          p.add_file file, folder
+        }
+      }
+    end
+  end
+  
+  p.gen_symbols
+  p.nuget_gem_exe
+  #p.leave_nuspec
+
+  Albacore::NugetsPack::ProjectTask.new(p.opts).execute
+end
+
+def nuget_content nuget_name, path, dotnet_ver
+
+  content = {}
+
+  metadata = SemVerMetadata.new ".semver/#{nuget_name}.semver"
+
+  content[:files] = {}
+  content[:files]['lib'] = metadata.files
+
+  file_names = metadata.assemblies.map{ |x|
+    "#{path}/#{x}"
+  }
+  assemblies = []
+  file_names.each{ |file|
+    assemblies.concat(file.expand_with(['dll','pdb','xml']))
+  }
+  content[:files]['lib'].concat assemblies
+
+  content[:dependencies] = metadata.depends
+
+  content[:version] = read_versions[nuget_name][:nuget_version]
+  content[:target_framework] = dotnet_ver
+
+  content
+end
+

data/lib/semver_extensions.rb

@@ -0,0 +1,51 @@
+class SemVerMetadata
+  
+  def initialize file
+    @assemblies = []
+    @files = []
+    @depends = {}
+    parse file
+  end
+
+  def assemblies
+    @assemblies
+  end
+
+  def files
+    @files
+  end
+
+  def depends
+    @depends
+  end
+
+  def parse file
+
+    semver = SemVer.new
+    semver.load file
+
+    return if semver.metadata == ''
+
+    parts = semver.metadata.split('|')
+
+    return if parts.length < 1
+
+    proj_lines = parts[0].split(',')
+    proj_lines.each {|line|
+      @assemblies << line.strip
+    }
+
+    return if parts.length < 2
+    
+    folders = parts[1].split(',')
+    folders.each { |f|
+      @files << File.join(Dir.pwd, "#{f}/*")
+    }
+
+    return if parts.length < 3
+
+    @depends = JSON.parse parts[2]
+
+  end
+
+end

data/lib/string_extensions.rb

@@ -0,0 +1,82 @@
+class String
+
+	def colorize(text, color_code)
+  		"\e[#{color_code}m#{text}\e[0m"
+	end
+	def black
+	  colorize self, 30
+	end
+	def red
+	  colorize self, 31
+	end
+	def green
+	  colorize self, 32
+	end
+	def white
+	  colorize self, 33
+	end
+	def blue
+	  colorize self, 34
+	end
+	def magenta
+	  colorize self, 35
+	end
+	def cyan
+	  colorize self, 36
+	end
+	def yellow
+	  colorize self, 37
+	end
+
+	def bg_black
+	  colorize self, 40
+	end
+	def bg_red
+	  colorize self, 41
+	end
+	def bg_green
+	  colorize self, 42
+    end
+	def bg_white
+	  colorize self, 43 
+	end
+	def bg_blue
+	  colorize self, 44
+	end
+	def bg_magenta
+	  colorize self, 45
+	end
+	def bg_cyan
+	  colorize self, 46
+	end
+	def bg_yellow
+	  colorize self, 47
+	end
+
+	def bold
+	  "\e[1m#{self}\e[22m" 
+	end
+	def italic
+		"\e[3m#{self}\e[23m" 
+	end
+	def underline
+	  "\e[4m#{self}\e[24m" 
+	end
+	def blink
+	  "\e[5m#{self}\e[25m" 
+	end
+	def reverse_color
+	  "\e[7m#{self}\e[27m" 
+	end
+
+	def expand_with list
+		out = []
+		list.each{ |i|
+			f = self + '.' + i
+			if File.exists? f
+				out << f
+			end
+		}
+		out
+	end
+end

data/lib/versioning.rb

@@ -0,0 +1,135 @@
+ASTER = '*'
+CSPROJ = '.csproj'
+
+$version_map = {}
+
+def get_commit_hash_and_date
+  begin
+    commit = `git log -1 --pretty=format:%H`
+    git_date = `git log -1 --date=iso --pretty=format:%ad`
+    commit_date = DateTime.parse( git_date ).strftime("%Y-%m-%d %H%M%S")
+  rescue
+    commit = "git unavailable"
+  end
+
+  [commit, commit_date]
+end
+
+# put semver versions in a map
+def read_versions
+
+  return $version_map if !$version_map.empty?
+  
+  files = Dir['.semver/**/*.semver']
+  files.each { | file |
+    v = SemVer.new
+    v.load file
+    v.patch = (ENV['BUILD_NUMBER'] || v.patch).to_i
+    version = versions(v, &method(:commit_data))
+
+    sm = SemVerMetadata.new file
+    assemblies = sm.assemblies
+    sm.assemblies.each { |a|
+      $version_map[a] = version
+    }
+
+    name = file
+      .gsub(/.semver/, '')
+      .gsub('/', '')
+
+    $version_map[name] = version
+  }
+
+  # this is for assemblies not versioned with semver
+  $version_map[ASTER] = versions_no_semver(&method(:commit_data))
+
+  $version_map
+end
+
+def update_assembly_versions
+  require 'albacore/task_types/asmver'
+
+  $version_map = read_versions
+
+  files = FileList['**/*' + CSPROJ]
+  files.each { |f|
+      
+    ns =  File.basename(f, CSPROJ)
+
+    asm_file = File.join File.dirname(f), '/Properties/AssemblyVersion.cs'
+    next if ns.nil? || ns.to_s == '' || !File.file?(asm_file)
+
+    c = Albacore::Asmver::Config.new
+    c.file_path = asm_file
+
+    if ($version_map.key? ns)
+      c.attributes assembly_configuration: BUILD_CONFIG,
+            assembly_version: $version_map[ns][:long_version],
+            assembly_file_version: $version_map[ns][:long_version],
+            assembly_informational_version: $version_map[ns][:build_version]
+    else 
+      c.attributes assembly_configuration: BUILD_CONFIG,
+            assembly_version: $version_map[ASTER][:long_version],
+            assembly_file_version: $version_map[ASTER][:long_version],
+            assembly_informational_version: $version_map[ASTER][:build_version]
+    end
+    
+    Albacore::Asmver::Task.new(c.opts).execute
+  }
+end
+
+def self.versions semver, &commit_data
+  {
+    # just a monotonic inc
+    :build_number   => semver.patch,
+    :semver         => semver,
+
+    # purely M.m.p format
+    :formal_version => "#{ XSemVer::SemVer.new(semver.major, semver.minor, semver.patch).format "%M.%m.%p"}",
+
+    # four-numbers version, useful if you're dealing with COM/Windows
+    :long_version   => "#{semver.format '%M.%m.%p'}.0",
+
+    # extensible number w/ git hash
+    :build_version  => semver.format("%M.%m.%p%s") + ".#{yield[0]}",
+
+    # nuget (not full semver 2.0.0 support) see http://nuget.codeplex.com/workitem/1796
+    :nuget_version  => format_nuget(semver)
+  }
+end
+
+def self.versions_no_semver &commit_data
+  dt_ver = Time.new.strftime('%y.%-m.%-d') + ".#{(ENV['BUILD_NUMBER'] || '0')}"
+  {
+
+    :formal_version => dt_ver,
+
+    # four-numbers version, useful if you're dealing with COM/Windows
+    :long_version   => dt_ver,
+
+    # extensible number w/ git hash
+    :build_version  => dt_ver + ".#{yield[0]}"
+  }
+end
+
+def self.format_nuget semver
+  if semver.prerelease and not semver.prerelease.empty?
+    "#{semver.major}.#{semver.minor}.#{semver.patch}-#{semver.prerelease.gsub(/\W/, '')}"
+  else
+    semver.format '%M.%m.%p'
+  end
+end
+
+# load the commit data
+# returns: [short-commit :: String, date :: DateTime]
+def self.commit_data
+  begin
+    commit = `git rev-parse --short HEAD`.chomp()[0,6]
+    git_date = `git log -1 --date=iso --pretty=format:%ad`
+    commit_date = DateTime.parse( git_date ).strftime("%Y-%m-%d %H:%M:%S")
+  rescue
+    commit = (ENV['BUILD_VCS_NUMBER'] || "000000")[0,6]
+    commit_date = Time.new.strftime("%Y-%m-%d %H:%M:%S")
+  end
+  [commit, commit_date]
+end

data/rakefile.rb

@@ -0,0 +1,8 @@
+require 'rake/testtask'
+
+Rake::TestTask.new do |t|
+  t.libs << 'test'
+end
+
+desc "Run tests"
+task :default => :test

metadata

@@ -0,0 +1,53 @@
+--- !ruby/object:Gem::Specification
+name: azbuild
+version: !ruby/object:Gem::Version
+  version: 1.0.0
+platform: ruby
+authors:
+- Suresh Batta
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2016-08-14 00:00:00.000000000 Z
+dependencies: []
+description: Build, Configuration and Deployment Gem for .Net Solutions
+email: subatta@hotmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- README.md
+- azbuild.gemspec
+- lib/azbuild.rb
+- lib/build.rb
+- lib/install.rb
+- lib/package.rb
+- lib/semver_extensions.rb
+- lib/string_extensions.rb
+- lib/versioning.rb
+- rakefile.rb
+homepage: http://rubygems.org/gems/azbuild
+licenses:
+- MIT
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.5.1
+signing_key: 
+specification_version: 4
+summary: Setup and scripting support for .Net project builds
+test_files: []