albacore 0.0.7 → 0.0.8

data/README.markdown

@@ -14,7 +14,9 @@ If you would like to install the current, stable release of Albacore, you can do
 
 **Step 2:** Install the Albacore gem
 
-> gem install Albacore
+> gem install albacore
+
+(note: as of v0.0.7, the "albacore" gem is spelled with a lowercase "a".)
 
 ## How To Manually Build And Install The Albacore Gem
 
@@ -34,15 +36,15 @@ In your local clone of Albacore, use the jeweler rake tasks to build the latest
 >
 > rake jeweler:build
 
-this will produce an 'Albacore-#.#.#.gem' file in the 'pkg' folder, where '#.#.#' is the version number. For example 'Albacore-0.0.1.gem'.
+this will produce an 'albacore-#.#.#.gem' file in the 'pkg' folder, where '#.#.#' is the version number. For example 'albacore-0.0.7.gem'.
 
 **Step 3:** Install the gem
 
 After building the gem, you can install it from your local file system.
 
-> gem install -l pkg\Albacore-#.#.#.gem
+> gem install -l pkg/albacore-#.#.#.gem
 
-where '#.#.#' is the version number of the gem. For example 'Albacore-0.0.1.gem'
+where '#.#.#' is the version number of the gem. For example 'albacore-0.0.7.gem'
 
 ## How To Use Albacore
 
@@ -53,18 +55,26 @@ After installing Albacore, you only need to
 in your rakefile. This will allow you to use the tasks that Albacore includes. 
 
     desc "Run a sample build using the MSBuildTask"
-    Albacore::MSBuildTask.new(:msbuild) do |msb|
-        msb.properties :configuration => :Debug
+    msbuildtask do |msb|
+        msb.properties = {:configuration => :Debug}
         msb.targets [:Clean, :Build]
         msb.solution = "spec/support/TestSolution/TestSolution.sln"
     end
 
 Beyond the simple example, check out the [Albacore Wiki](http://wiki.github.com/derickbailey/Albacore) for detailed instructions on how to use the built in tasks and their options.
 
+## How To Contribute, Collaborate, Communicate
+
+If you'd like to get involved with the Albacore framework, we have a discussion group over at google: **[AlbacoreDev](http://groups.google.com/group/albacoredev)**
+
+Anyone can fork the main repository and submit patches, as well. And lastly, the [wiki](http://wiki.github.com/derickbailey/Albacore) and [issues list](http://github.com/derickbailey/Albacore/issues) are also open for additions, edits, and discussion.
+
 ## Contributors
 
 Many thanks for contributions to Albacore are due:
 
-* [Ben Hall](http://github.com/benhall): SSH, SFTP, ZipDirectory, Rename, YAML auto config, and other great additions
+* [Ben Hall](http://github.com/benhall): SSH, SFTP, ZipDirectory, Rename, YAML auto config, Wiki pages, and other great additions
+* [Steven Harman] (http://github.com/stevenharman): Finding some wicked bugs, patching nunit test runner, and working on the nant task
+* [Brian Donahue] (http://github.com/briandonahue): Inspiration and initial code for the ExpandTemplates task
 * [Sean Biefeld](http://github.com/seanbiefeld): MSpecTestRunner for NCoverConsole
 * [Kevin Colyar](http://github.com/kevincolyar): Testing and updating of MSBuild to work with Cygwin

data/VERSION

@@ -1 +1 @@
-0.0.7
+0.0.8

data/install_dependencies.rb

@@ -0,0 +1,46 @@
+require 'rubygems'
+require 'rubygems/gem_runner'
+require 'rubygems/exceptions'
+
+#http://gist.github.com/236148
+required_version = Gem::Requirement.new "> 1.8.3"
+
+unless required_version.satisfied_by? Gem.ruby_version then
+  abort "Expected Ruby Version #{required_version}, was #{Gem.ruby_version}"
+end
+
+def install(lib)
+  begin
+  	matches = Gem.source_index.find_name(lib)
+    if matches.empty?
+    	puts "Installing #{lib}"
+    	Gem::GemRunner.new.run ['install', lib]
+    else
+    	puts "Found #{lib} gem - skipping"
+    end
+  rescue Gem::SystemExitException => e
+  end
+end
+
+def add_source(url)
+  begin
+  	if Gem.sources.include?(url)
+  		puts "Found #{url} gem source = skipping"
+  	else
+  		puts "Adding #{url} gem source."
+		Gem::GemRunner.new.run ['sources', '-a', url]
+	end
+  rescue Gem::SystemExitException => e
+  end
+end
+
+puts "Installing required dependencies"
+add_source 'http://gemcutter.org'
+install 'rake'
+install 'net-ssh'
+install 'net-sftp'
+install 'rubyzip'
+install 'jeweler'
+install 'rspec'
+install 'derickbailey-notamock'
+install 'jekyll'

data/lib/albacore.rb

@@ -5,5 +5,6 @@ $: << File.expand_path(File.join(File.dirname(__FILE__), "rake"))
 
 require 'logging'
 
+Dir.glob(File.join(File.expand_path(File.dirname(__FILE__)), 'rake/support/*.rb')).each {|f| require f }
 Dir.glob(File.join(File.expand_path(File.dirname(__FILE__)), 'rake/*.rb')).each {|f| require f }
 Dir.glob(File.join(File.expand_path(File.dirname(__FILE__)), 'albacore/*.rb')).each {|f| require f }

data/lib/albacore/command.rb

@@ -0,0 +1,23 @@
+require 'albacore/support/albacore_helper'
+
+class Command
+	include RunCommand
+	include YAMLConfig
+	include Logging
+	
+	attr_accessor :parameters
+	
+	def initialize()
+		super()
+		@require_valid_command=false
+		@path_to_command=''
+		@parameters = []
+	end
+	
+	def execute()
+		result = run_command "Command", @parameters.join(" ")
+
+		failure_message = 'Command Failed. See Build Log For Detail'
+		fail_with_message failure_message if !result
+	end
+end

data/lib/albacore/expandtemplates.rb

@@ -16,7 +16,7 @@ class ExpandTemplates
 		return if @data_file.nil?
 		return if @expand_files.empty?
 		
-		config = read_config
+		config = read_config(@data_file)
 		@expand_files.each { |template_file, output_file| 
 			file_config = get_config_for_file config, template_file
 			expand_template template_file, output_file, file_config
@@ -45,15 +45,30 @@ private
 		}
 	end
 	
-	def read_config
-		YAML::load(File.open(@data_file, "r"))
+	def read_config(file)
+		config = YAML::load(File.open(file, "r"))
+		if (config.include?("@include"))
+			include_file = File.join(File.dirname(file), config["@include"])
+			@logger.debug("Found @include directive. Loading additional data from #{include_file}")			
+			config.reject!{|k,v| k == "@include"}
+			include_config = read_config(include_file)
+			config = deep_merge(include_config, config)
+		end
+		return config
+	end
+	
+	def deep_merge(first, second)
+		# From: http://www.ruby-forum.com/topic/142809
+		# Author: Stefan Rusterholz
+		merger = proc { |key,v1,v2| Hash === v1 && Hash === v2 ? v1.merge(v2, &merger) : v2 }
+		first.merge(second, &merger)
 	end
 	
 	def get_config_for_file(original_config, file)
 		filename = File.basename(file)
 		file_config = original_config[filename]
 		if file_config.nil?
-			@logger.debug "No config data found for #{filename}. Using global data."
+			@logger.debug "No config data found for #{filename}. Using local data."
 			new_config = original_config
 		else
 			@logger.debug "Found config data for #{filename}."

data/lib/albacore/msbuild.rb

@@ -3,6 +3,7 @@ require 'albacore/support/albacore_helper'
 class MSBuild
 	include RunCommand
 	include YAMLConfig
+	include Logging
 	
 	attr_accessor :solution, :verbosity
 	
@@ -13,6 +14,8 @@ class MSBuild
 	
 	def build_path_to_command
 		win_dir = ENV['windir'] || ENV['WINDIR']
+		win_dir = 'C:/Windows' if win_dir.nil?
+		
 		File.join(win_dir.dup, 'Microsoft.NET', 'Framework', 'v3.5', 'MSBuild.exe')
 	end
 	

data/lib/albacore/mspectestrunner.rb

@@ -1,12 +1,12 @@
 require 'albacore/support/albacore_helper'
 
 class MSpecTestRunner
-	include Logging
+    include RunCommand
 	include YAMLConfig
 	
-	attr_accessor :assemblies, :path_to_command, :html_output
+	attr_accessor :assemblies, :path_to_command, :html_output, :options
 	
-	def initialize(path_to_command)
+	def initialize(path_to_command='')
 		super()
 		@path_to_command = path_to_command
 		@assemblies=[]
@@ -15,12 +15,26 @@ class MSpecTestRunner
 	def get_command_line
 		command = []
 		command << @path_to_command
-		command << build_assembly_list unless @assemblies.empty?
-		command << build_html_output unless @html_output.nil?
+		command << get_command_parameters
+		cmd = command.join(" ")
+		@logger.debug "Build MSpec Test Runner Command Line: " + cmd
+        return cmd
+	end
+	
+	def get_command_parameters
+		command_params = []
+		command_params << build_assembly_list unless @assemblies.empty?
+        command_params << @options.join(" ") unless @options.nil?
+		command_params << build_html_output unless @html_output.nil?
+		command_params
+	end
+	
+	def execute()
+		command_params = get_command_parameters
+		result = run_command "MSpec", command_params.join(" ")
 		
-		cmdline = command.join(" ")
-		@logger.debug "Build MSpec Test Runner Command Line: " + cmdline
-		cmdline
+		failure_message = 'MSpec Failed. See Build Log For Detail'
+		fail_with_message failure_message if !result
 	end
 	
 	def build_assembly_list

data/lib/albacore/nunittestrunner.rb

@@ -4,7 +4,7 @@ class NUnitTestRunner
 	include RunCommand
 	include YAMLConfig
 	
-	attr_accessor :assemblies, :options
+	attr_accessor :path_to_command, :assemblies, :options
 	
 	def initialize(path_to_command='')
 		super()
@@ -14,7 +14,9 @@ class NUnitTestRunner
 	end
 	
 	def get_command_line
-		command_params = get_command_parameters
+		command_params = []
+		command_params << @path_to_command
+		command_params << get_command_parameters
 		commandline = command_params.join(" ")
 		@logger.debug "Build NUnit Test Runner Command Line: " + commandline
 		commandline
@@ -22,7 +24,6 @@ class NUnitTestRunner
 	
 	def get_command_parameters
 		command_params = []
-		command_params << @path_to_command
 		command_params << @assemblies.join(" ") unless @assemblies.nil?
 		command_params << @options.join(" ") unless @options.nil?
 		command_params
@@ -30,7 +31,7 @@ class NUnitTestRunner
 	
 	def execute()
 		command_params = get_command_parameters
-		result = run_command "NUnit", command_params
+		result = run_command "NUnit", command_params.join(" ")
 		
 		failure_message = 'NUnit Failed. See Build Log For Detail'
 		fail_with_message failure_message if !result

data/lib/albacore/sftp.rb

@@ -5,15 +5,26 @@ class Sftp
 	include YAMLConfig
 	include Logging
 	
-	attr_accessor :server, :username, :password, :upload_files
-	
+	attr_accessor :server, :username, :password, :upload_files, :port, :key, :debug
+  
 	def initialize
 		super()
 		@upload_files = {}
 	end	
 	
+	def get_connection_options
+		options = {}
+		options[:verbose] = :debug if @debug == true
+		options[:password] = @password if @password
+		options[:port] = @port if @port
+		options[:keys] = [@key] if @key
+		options
+	end
+  
 	def upload()
-		Net::SFTP.start(@server, @username, :password => @password) do |sftp|
+		warn_about_key if @key
+    
+		Net::SFTP.start(@server, @username, get_connection_options) do |sftp|
 			@logger.debug "Starting File Upload"
 			@upload_files.each {|local_file, remote_file|
 				@logger.debug "Uploading #{local_file} to #{remote_file}"
@@ -21,4 +32,9 @@ class Sftp
 			}
 		end
 	end
+
+	def warn_about_key()
+		info.debug 'When using a key, you need an SSH-Agent running to manage the keys.'
+		info.debug 'On Windows, a recommended agent is called Pageant, downloadable from the Putty site.'
+	end
 end

data/lib/albacore/ssh.rb

@@ -5,15 +5,26 @@ class Ssh
 	include YAMLConfig
 	include Logging
 	
-	attr_accessor :server, :username, :password, :commands
-	
+	attr_accessor :server, :username, :password, :commands, :port, :key, :debug
+  	
 	def initialize
 		super()
 		@commands = []
 	end
+  
+  	def get_connection_options
+		options = {}
+		options[:verbose] = :debug if @debug == true
+		options[:password] = @password if @password
+		options[:port] = @port if @port
+		options[:keys] = [@key] if @key
+		options
+	end
 	
 	def execute()
-		Net::SSH.start(@server, @username, :password => @password) do |ssh|
+    	warn_about_key if @key
+    
+		Net::SSH.start(@server, @username, get_connection_options) do |ssh|
 			@commands.each{|cmd|
 				@logger.info "Executing remote command: #{cmd}"
 				output = ssh.exec!(cmd)
@@ -22,4 +33,10 @@ class Ssh
 			}
 		end
 	end
+  
+	def warn_about_key()
+		info.debug 'When using a key, you need an SSH-Agent running to manage the keys.'
+		info.debug 'On Windows, a recommended agent is called Pageant, downloadable from the Putty site.'
+	end
+  
 end

data/lib/albacore/xunittestrunner.rb

@@ -0,0 +1,48 @@
+require 'albacore/support/albacore_helper'
+
+class XUnitTestRunner
+  include RunCommand
+	include YAMLConfig
+
+	attr_accessor :assemblies, :path_to_command, :html_output, :options
+
+	def initialize(path_to_command='')
+		super()
+		@path_to_command = path_to_command
+		@assemblies=[]
+	end
+
+	def get_command_line
+		command = []
+		command << @path_to_command
+		command << get_command_parameters
+
+		cmd = command.join(" ")
+		@logger.debug "Build XUnit Test Runner Command Line: " + cmd
+        return cmd
+	end
+	
+	def get_command_parameters
+		command_params = []
+		command_params << build_assembly_list unless @assemblies.empty?
+    	command_params << @options.join(" ") unless @options.nil?
+		command_params << build_html_output unless @html_output.nil?
+		command_params
+	end
+
+	def execute()
+		command_params = get_command_parameters
+		result = run_command "XUnit", command_params.join(" ")
+
+		failure_message = 'XUnit Failed. See Build Log For Detail'
+		fail_with_message failure_message if !result
+	end
+
+	def build_assembly_list
+		@assemblies.map{|asm| "\"#{asm}\""}.join(" ")
+	end
+
+	def build_html_output
+		"/html #{@html_output}"
+	end
+end

data/lib/albacore/zipdirectory.rb

@@ -5,19 +5,22 @@ include Zip
 
 class ZipDirectory
 	include YAMLConfig
-	
-	attr_accessor :directory_to_zip
-	attr_accessor :additional_files
-	attr_accessor :file
+	include Failure
+  
+	attr_accessor :directories_to_zip, :additional_files
+	attr_accessor :output_path, :output_file
+	attr_accessor :flatten_zip
 
 	def initialize
 		super()
+		@flatten_zip = true
 	end
 		
 	def package()
-		return if @directory_to_zip.nil?
-		
-		@directory_to_zip.sub!(%r[/$],'')
+		fail_with_message 'Output File cannot be empty' if @output_file.nil?
+		return if @output_file.nil?
+        
+		clean_directories_names
 		remove zip_name
 
 		ZipFile.open(zip_name, 'w')	do |zipfile|
@@ -26,6 +29,11 @@ class ZipDirectory
 		end
 	end
 	
+	def clean_directories_names
+    	return if @directories_to_zip.nil?
+		@directories_to_zip.each { |d| d.sub!(%r[/$],'')}
+	end
+	
 	def remove(filename)
 		FileUtils.rm filename, :force=>true
 	end
@@ -35,20 +43,33 @@ class ZipDirectory
 	end
 	
 	def zip_name()
-		File.join(@directory_to_zip, @file)
+		@output_path = set_output_path
+		File.join(@output_path, @output_file)
+	end
+  
+	def set_output_path()
+		path = ''
+		path = @directories_to_zip.first unless @directories_to_zip.nil?
+		path = @output_path unless @output_path.nil?
+		return path
 	end
+    
 	
 	def zip_directory(zipfile)
-		Dir["#{@directory_to_zip}/**/**"].reject{|f| reject_file(f)}.each do |file_path|
-			file_name = file_path.sub(@directory_to_zip+'/','');
-			zipfile.add(file_name, file_path)
+		return if @directories_to_zip.nil?
+		@directories_to_zip.each do |d|
+			Dir["#{d}/**/**"].reject{|f| reject_file(f)}.each do |file_path|
+				file_name = file_path
+				file_name = file_path.sub(d + '/','') if @flatten_zip
+				zipfile.add(file_name, file_path)
+			end
 		end
 	end
 	
 	def zip_additional(zipfile)
 		return if @additional_files.nil?
 		@additional_files.reject{|f| reject_file(f)}.each do |file_path|
-			file_name = file_path#.split('/').last
+			file_name = file_path.split('/').last if @flatten_zip
 			zipfile.add(file_name, file_path)
 		end
 	end