albacore 2.0.0 → 2.0.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 125d41e32b2bbac2550a2eef4c0da84593bcf8fe
-  data.tar.gz: c850a38572d46972aef5ebdb000d7d363ac4cbdb
+  metadata.gz: 3199dffeb6514d20b0d70ad82103f3f9966136b0
+  data.tar.gz: f8d0a29b38090c7cfb97482e6713978bd36865cb
 SHA512:
-  metadata.gz: 51eb2096aa4ba6760c580e62c9569d49b36d09d8130827246af393e4e63a21ff456b2446df7bfb87b654aa925e5842985f1fb7c01b72422caf4e583d4509b9e0
-  data.tar.gz: e2f0bde8c465699e804a97501cd8957ba2a849f34281ba6dfc7ac16682d970f7d4fcefc514af5ac1856f8b03797a8f5931c71ca3195f2f969a0ea659884e6f9c
+  metadata.gz: 089ea6cc92e8331a35b135b7ce6ff3397bacafbbfc6ead76e741f2d3df3c77c0c657984957fbaf0b413a37636d8afe8c3a3c238d3d5ad944f78bb7898672f398
+  data.tar.gz: 62383f56f6bdffd54ad5f5f7144bfb8e300317e2ecccc3f4d840e9eaabab81733e6f15ef2e662f03b11c7b6ab95162501d33aafb9172ddc882f2f7f44655eeb3

data/README.md

@@ -1,9 +1,9 @@
 # Albacore v2.0
 
 [![Version     ](https://img.shields.io/gem/v/albacore.svg?style=flat)](https://rubygems.org/gems/albacore)
-[![Build Status](http://img.shields.io/travis/albacore/albacore/master.svg?style=flat)](http://travis-ci.org/Albacore/albacore)
+[![Build Status](http://img.shields.io/travis/Albacore/albacore/master.svg?style=flat)](http://travis-ci.org/Albacore/albacore)
 [![Gittip      ](http://img.shields.io/gittip/haf.svg?style=flat)](http://gittip.com/haf)
-[![Code Climate](https://img.shields.io/codeclimate/github/albacore/albacore.svg?style=flat)](https://codeclimate.com/github/albacore/albacore)
+[![Code Climate](https://img.shields.io/codeclimate/github/Albacore/albacore.svg?style=flat)](https://codeclimate.com/github/albacore/albacore)
 
 Albacore is a suite of tools for the professional .Net or mono developer that
 make their life easier.
@@ -13,8 +13,6 @@ make their life easier.
 ## Main Features
 
  - Runs .Net and mono builds on OS X, Windows and Linux quick and painless
- - Actively developed by Henrik Feldt, Software Architect at
-   [Intelliplan](http://intelliplan.se)
  - Manage xbuild/msbuild transparently
  - NuGet restore without intrusive .nuget target files in your project files,
    authentication supported
@@ -35,6 +33,15 @@ make their life easier.
    your company!
  - Transparent publish of artifacts to TeamCity with the TC extension
  - Unit tested, high quality Ruby code
+ - Actively developed by Henrik Feldt, Software Architect at
+   [Intelliplan](http://intelliplan.se) - there's someone looking after the
+   code. We're active and taking pull requests - an open source project is not a
+   single-person game, but it's nice to have some stability.
+
+The [wiki](https://github.com/Albacore/albacore/wiki) is the main reference for
+the above task types, but there's also [very
+extensive](http://rubydoc.info/gems/albacore/2.0.0/frames) documentation in the
+code, as well as hundreds of unit tests written in a easy-to-read rspec syntax.
 
 ## Getting Started
 
@@ -46,6 +53,11 @@ First create `Gemfile` with these contents:
     source 'https://rubygems.org'
     gem 'albacore', '2.0.0'
 
+When setting up your build you need to ensure it is reproducible.  Bundler
+allows you to lock down the few gems that Albacore depend on to their specific
+versions, ensuring that your peers can re-run the same build script you just
+built and that it works well on your continous integration server.
+
 Now you can bundle the dependencies, effectively freezing all gem dependencies
 that your build depends on.
 
@@ -77,23 +89,6 @@ Continue below with your first Rakefile.
 
 ## Creating Your First Rakefile
 
-Bundler is a tool that fetches gems for you. Now, specify what ruby gems your
-build will use. Create a new file, named `Gemfile`. This file should look like
-this:
-
-    source 'https://rubygems.org'
-    gem 'albacore', '2.0.0'
-
-When setting up your build you need to ensure it is reproducible.  Bundler
-allows you to lock down all gems that albacore depend on to their specific
-versions, ensuring that your peers can re-run the same rake script you just
-built and that it works well on your continous integration server.
-
-The first step after installing `bundler` is to create a `Gemfile` next to your
-Now, install albacore from this repository by running:
-
-    bundle
-
 In order to build your project, you need to create a `Rakefile`, with contents
 like these:
 
@@ -115,7 +110,7 @@ end
 desc 'restore all nugets as per the packages.config files'
 nugets_restore :restore do |p|
   p.out = 'src/packages'
-  p.exe = 'buildsupport/NuGet.exe'
+  p.exe = 'tools/NuGet.exe'
 end
 
 desc 'Perform full build'
@@ -158,334 +153,6 @@ You can now run:
     a. Make sure TravisCI is OK with it
     b. Describe your PR in English.
 
-## DSL
-
-When you `require 'albacore'` you will get a few methods added and available for
-use within your Rakefile, these are specified in CrossPlatformCmd, and are as
-follows:
-
- - `#system` : (processPath : string) -> (arguments : string array)
- - `#sh` : same as above
- - `#shie` : same as above
- - `#which` : (binaryName : string) -> (path : string)
- - `#normalise_slashes`  - takes a path-looking string and normalises the
-   slashes to the operating system that the command is running on. So for
-   Windows, you'd get back-slashes and for linux forward slashes.
- - `#chdir (work_dir : ?string) (block : Block<unit, x>) : x` - takes a string work dir to be
-   in and a block of ruby to execute in that work dir and returns the return
-   value of block.
-
-
-## Debugging Albacore scripts
-
-You can call the rakefile as such:
-
-```
-DEBUG=true rake
-```
-
-This changes the behaviour of the logging to output debug verbosity. It also
-changes some tasks to override Rakefile settings for verbosity and prints more
-debug information. I've tried to keep the information structured.
-
-If you're reporting a bug or need crash information to file a bug report, you
-can append the `--trace` flag to the invocation.
-
-```
-DEBUG=true rake --trace
-```
-
-## Task Types
-
-Task types are the pre-built factories for rake tasks. They often take care of
-what's slightly more complex, beyond just invoking commands. They are available
-and methods in the DSL you get when you do `require 'albacore'`
-
-### Docs: build
-
-``` ruby
-require 'albacore'
-build :compile_this do |b|
-  b.file   = Paths.join 'src', 'MyProj.fsproj' # the file that you want to build
-  # b.sln  = Paths.join 'src', 'MyProj.sln'    # alt. name
-  b.target = ['Clean', 'Rebuild']              # call with an array of targets or just a single target
-  b.prop 'Configuration', 'Release'            # call with 'key, value', to specify a MsBuild property
-  b.cores = 4                                  # no of cores to build with, defaults to the number of cores on your machine
-  b.clp 'ShowEventId'                          # any parameters you want to pass to the console logger of MsBuild
-  b.logging = 'verbose'                          # verbose logging mode
-  # b.be_quiet                                 # opposite of the above
-  b.no_logo                                    # no Microsoft/XBuild header output
-end
-
-```
-
-### Docs: nugets_pack
-
-``` ruby
-nugets_pack :create_nugets do |p|
-  p.files   = FileList['src/**/*.{csproj,fsproj,nuspec}'].
-    exclude(/Tests/)
-  p.out     = 'build/pkg'
-  p.exe     = 'buildsupport/NuGet.exe'
-  p.with_metadata do |m|
-    m.description = 'A cool nuget'
-    m.authors = 'Henrik'
-    m.version = ENV['NUGET_VERSION']
-  end
-  p.with_package do |p|
-    p.add_file 'file/relative/to/proj', 'lib/net40'
-  end
-end
-```
-
-#### nugets_pack Config##no_project_dependencies
-
-Cancel following of references between projects that cause nugets_pack to find and add as nuget dependencies, linked projects.
-
-### Docs: nugets_restore
-
-Enables nuget restore throughout the solution.
-
-``` ruby
-nugets_restore :restore do |p|
-  p.out = 'src/packages'             # required
-  p.exe = 'buildsupport/NuGet.exe'   # required
-  p.list_spec = '**/packages.config' # optional
-  p.exclude_version                  # exclude version number in directory name where NuGet package will be restored
-end
-```
-
-### Docs: asmver
-
-Generate a single file with assembly attributes. Code comments in example below
-mention output in F#.
-
-``` ruby
-asmver :asmver do |a|
-  a.file_path  = 'src/Version.fs' # required, no default
-  a.namespace  = 'Hello.World'    # required for F#, defaults to empty string '' for C#
-  # optional
-  a.attributes assembly_title: 'Hello.World', # generates: [<AssemblyTitle("Hello.World")>]
-    assembly_version: '0.1.2',                # generates: [<AssemblyVersion("0.1.2")>]
-    my_product_attr: 'Hello world',           # generates: [<MyProductAttr("Hello World")>]
-  a.out        = StringIO.new     # optional, don't use it this way: takes an IO/Stream
-end
-```
-
-### Docs: asmver_files
-
-``` ruby
-desc 'create assembly infos'
-asmver_files :assembly_info do |a|
-  a.files = FileList['**/*proj'] # optional, will find all projects recursively by default
-
-  # attributes are required:
-  a.attributes assembly_description: "My wonderful lib",
-               assembly_configuration: 'RELEASE',
-               assembly_company: 'Wonders Inc.',
-               assembly_copyright: "(c) #{Time.now.year} by John Doe",
-               assembly_version: ENV['LONG_VERSION'],
-               assembly_file_version: ENV['LONG_VERSION'],
-               assembly_informational_version: ENV['BUILD_VERSION']
-
-  # optional, not widely supported yet, as there's no way to read the attributes
-  # file an issue if you have a use-case
-  a.handle_config do |proj, conf|
-    # do something with configuration
-    # conf.attributes ...
-  end
-end
-```
-
-
-
-### Docs: test_runner
-
-``` ruby
-test_runner :tests do |tests|
-  tests.files = FileList['**/*.Tests/bin/Release/*.Tests.dll'] # dll files with test
-  tests.exe = 'src/packages/NUnit.Runners.2.5.3/tools/nunit-console.exe' # executable to run tests with
-  tests.add_parameter '/TestResults=Lallaa.xml' # you may add parameters to the execution
-  tests.copy_local # when running from network share
-end
-```
-
-### Docs: nugets_authentication
-
-TBD
-
-### Docs: appspecs
-
-Example rakefile (see
-[spec/test_appspecs/corp.service](https://github.com/Albacore/albacore/tree/master/spec/test_appspecs/corp.service)
-in albacore source).
-
-``` ruby
-require 'bundler/setup'
-require 'albacore'
-
-Configuration = ENV['CONFIGURATION'] || 'Release'
-
-desc 'build example project'
-build :compile do |b|
-  b.sln = 'corp.service.svc.sln'
-  b.prop 'Configuration', Configuration
-end
-
-desc 'build service packages from all the appspecs'
-appspecs :services => :compile do |as|
-  as.files = Dir.glob '**/.appspec', File::FNM_DOTMATCH
-  as.out   = 'build'
-end
-
-task :default => :services
-```
-
-This example Rakefile will create RPMs on RHEL-derivative systems, DEBs on
-Debian-derivative systems and Chocolatey packages on Windows, as well as publish
-those packages to the CI server.
-
-As usual you can use Albacore.subscribe to jack into the output of this
-task-type, if you e.g. want to publish your packages to your package server -
-DAB or YUM. If you include the TeamCity extension, your TeamCity server will
-automatically become a chocolatey package server that you can use
-[puppet-chocolatey](git@github.com:karaaie/puppet-chocolatey.git) to install the
-packages of on your Windows boxen. Or you can use puppet proper with a yum repo
-on your linux boxen.
-
-The appspec simply looks something like this:
-
-``` yaml
----
-version: 1.2.3
-authors: Henrik Feldt
-```
-
-You can put any nuget-spec property there in `snake_case` and it will be set in
-the resulting nuget file. When building RPMs, the title of the project file will
-be used as the id (the non-lowercased title will be used for the NuGet).
-
-This task-type works by checking if it's running on Windows, and then running
-chocolatey, otherwise running fpm. This means that you have to have either
-installed, depending on your OS of choice.
-
-#### Known .appspec options
-
-**project_path** - if you are, say, building a package from a web site (like
-CSharpWeb is an example of), then you probably don't want to package all of your
-.cs files, nor would you like to package only the bin folder. Instead you add
-the .appspec to the list of files in the csproj file, so that it gets copied
-when you have a local publish like this:
-
-``` ruby
-build :pkg_web do |b|
-  b.file = 'CSharpWeb/CSharpWeb.csproj'
-  b.prop 'DeployOnBuild',  'true'
-  b.prop 'PublishProfile', 'local'
-  b.prop 'Configuration',  Configuration
-end
-```
-
-After calling this task, you'll find the appspec at `CSharpWeb/build/.appspec`
-(which mean it's part of the contents of the site). Now it's easy for albacore
-to find it and create a package from it, but it can't easily find the project
-that corresponds to it, because it's not next to the csproj file.
-
-This is where `project_path` comes in; make it something like
-`../CSharpWeb.csproj` in the .appspec file and then albacore knows where to get
-the data from.
-
-**provider** - `defaults` or `iis_site` -- needs to be specified currently if
-you're building a site -- a nice PR would be to discover that from the project
-type.
-
-**deploy_dir** - fully qualified path to deploy the contents
-
-#### Example IIS Site `.appspec` file
-
-``` yaml
----
-authors: Intelliplan Employees
-provider: iis_site
-project_path: ../CMDB.Web.csproj
-```
-
-## Tasks
-
-Tasks are things you can include that create singleton ruby tasks that are
-pre-named and pre-made. As opposed to the task types, these are 'includeable'.
-More info can be found in the
-[README](https://github.com/Albacore/albacore/blob/master/lib/albacore/tasks/README.md).
-
-### Versionizer
-
-Helper for reading a `.semver` file and moving information from that file, as
-well as information from the git commit being built upon, to the execution of
-rake/albacore.
-
-Defines/sets ENV vars:
-
- * BUILD_VERSION
- * NUGET_VERSION
- * FORMAL_VERSION
-
-BUILD_VERSION s constructed as such: `.semver-file -> %Major.%minor.%patch%special.git-sha1`.
-
-NUGET_VERSION leaves out the git commit hash.
-
-FORMAL_VERSION uses only the integers 'major', 'minor' and 'patch'.
-
-Publishes symbol `:build_version`.
-
-``` ruby
-require 'albacore/tasks/versionizer'
-Albacore::Tasks::Versionizer.new :versioning
-```
-
-## Tools
-
-Tools are auxilliary items in albacore. They do not have the same amount of
-testing and are more often one-off utilities. Most of these should be moved to
-being commands in an albacore binary.
-
-### Docs: csprojfiles
-
-Checks the difference between the filesystem and the files referenced in a
-csproj, to make sure that they match. Run as a part of a CI build.
-
-``` ruby
-desc "Check the difference between the filesystem and the files referenced in a csproj"
-csprojfiles do |f|
-  # Files to ignore
-  # for instance if you have source control specific files that are not supposed to be in the project 
-  f.ignore_files = [/.*\.srccontrol/]
-  f.project = "src/MyMvcSite/MyMvcSite.csproj"
-end
-```
-
-When you run this task it will report any differences between the filesystem and
-the csproj file.
-
-Why is this important? It's important to know what resources will be deployed.
-For instance if you have added an image. If you forgot to include the image in
-the .csproj, it will show up while developing but not when you do a web
-deployment (i.e. a release).
-
-It could also be that you have deleted a file, but forgotten to save the project
-when you send your latest commit to source control&hellip;
-
-How do you use it? The best way is to have it on a CI server in order to get a
-notification whenever it detects deviations.
-
-The task will fail with a message and rake will return with an non zero exit
-code. For instance if a file is missing from csproj and another from the
-filesystem:
-
-    - Files in src/MyMvcSite/MyMvcSite.csproj but not on filesystem: 
-      file_missing_on_filesystem.cshtml
-    + Files not in src/MyMvcSite/MyMvcSite.csproj but on filesystem:
-      file_missing_in_csproj.png
-
 ## Writing Code
 
  1. Add a rspec spec in specs/
@@ -499,69 +166,3 @@ Document your code with
 writing it: it's much easier to write the documentation together with the code
 than afterwards.
 
-## Docs: Zippy
-
-This is a simple example which uses rubyzip to recursively generate a zip file
-from the contents of a specified directory. The directory itself is not included
-in the archive, rather just its contents.
-
-Usage:
-
-``` ruby
-dir_to_zip = "/tmp/input"
-out_file = "/tmp/out.zip"
-zf = Zippy.new dir_to_zip, out_file
-zf.write
-```
-
-Or:
-
-``` ruby
-z = Zippy.new(directory_to_zip, output_file) { |f| f.include? 'html' }
-z.write
-```
-
-## Albacore v1.0
-
-Please browse
-[https://github.com/Albacore/albacore/tree/releases/v1.x](https://github.com/Albacore/albacore/tree/releases/v1.x)
-for all of the README and code for v1.0 (which is API compatible with all pre
-1.0 releases).
-
-## Ideas:
-
-When building multiple configurations,
-Build tasks should be invoked with different parameters
-According to the graph of tasks to be executed
-
-``` ruby
-require 'albacore'
-
-Albacore.vary_by_parameters do |params|
-  # write to dynamic method
-  params.Configuration = ['Debug-Tests', 'Release']
-end
-
-build :b do |b|
-  b.vary_by_param 'Configuration'
-end
-
-nugets_pack :p => :b do |p|
- # ... 
-end
-
-task :default => :p
-```
-
-Creating two runs
-  * `:b[Debug-Tests] => :p => :default` and
-  * `:b[Release] => :p => :default`
-
-where only :b is invoked twice, but :p and :default are only invoked only once
-each.
-
----
-
-When building services and/or web sites,
-The bundling task_type should take care of packaging for deployment
-

data/lib/albacore/nuget_model.rb

@@ -347,7 +347,7 @@ end})
             verify_files:         false,
             nuget_dependencies:   true })
 
-        trace { "#from_xxproj proj: #{proj} opts: #{opts} [nuget model: package]" }
+        trace { "#from_xxproj proj: '#{proj}' opts: #{opts} [nuget model: package]" }
 
         version = opts.get :version
         package = Package.new

data/lib/albacore/project.rb

@@ -17,9 +17,11 @@ module Albacore
     attr_reader :proj_path_base, :proj_filename, :proj_xml_node
     
     def initialize proj_path
+      raise ArgumentError, 'project path does not exist' unless File.exists? proj_path.to_s
       proj_path = proj_path.to_s unless proj_path.is_a? String
       @proj_xml_node = Nokogiri.XML(open(proj_path))
       @proj_path_base, @proj_filename = File.split proj_path
+      sanity_checks
     end
     
     # get the project name specified in the project file
@@ -171,6 +173,9 @@ module Albacore
     end
 
     private
+    def sanity_checks
+      warn { "project '#{@proj_filename}' has no name" } unless name
+    end
 
     def read_property prop_name
       txt = @proj_xml_node.css("Project PropertyGroup #{prop_name}").inner_text

data/lib/albacore/task_types/nugets_pack.rb

@@ -269,7 +269,7 @@ module Albacore
         project_dependencies = @opts.get(:project_dependencies, true)
         target = @opts.get :target
 
-        trace "creating NON-SYMBOL package for #{proj.name}, targeting #{target} [nugets pack: task]"
+        trace "creating NON-SYMBOL package for '#{proj.name}', targeting '#{target}' [nugets pack: task]"
         nuspec = Albacore::NugetModel::Package.from_xxproj proj, 
           symbols:        false,
           verify_files:   true,
@@ -285,7 +285,7 @@ module Albacore
         trace { "nuspec: #{nuspec.to_s} [nugets pack: task]" }
 
         if @opts.get(:symbols)
-          trace { "creating SYMBOL package for #{proj.name} [nugets pack: task]" }
+          trace { "creating SYMBOL package for '#{proj.name}' [nugets pack: task]" }
           nuspec_symbols = Albacore::NugetModel::Package.from_xxproj proj,
             symbols:        true,
             verify_files:   true,

data/lib/albacore/task_types/test_runner.rb

@@ -18,25 +18,35 @@ module Albacore
       # constructor, no parameters
       def initialize
         @copy_local = false
+        @clr_command = true
         @files = []
       end
 
-      # gets the configured options
+      # Gets the configured options from the test runner configuration.
+      #
       def opts
         Map.new(
-          :files      => files,
-          :copy_local => @copy_local,
-          :exe        => @exe,
-          :parameters => @parameters)
+          :files       => files,
+          :copy_local  => @copy_local,
+          :exe         => @exe,
+          :parameters  => @parameters,
+          :clr_command => @clr_command)
       end
 
-      # mark that it should be possible to copy the test files local
+      # Mark that it should be possible to copy the test files local
       # -- this is great if you are running a VM and the host disk is
       # mapped as a network drive, which crashes some test runners
       def copy_local
         @copy_local = true
       end
 
+      # Call this on the confiuguration if you don't want 'mono' prefixed to the
+      # exe path on non-windows systems.
+      #
+      def native_exe
+        @clr_command = false
+      end
+
       private
       def files
         if @files.respond_to? :each
@@ -52,9 +62,10 @@ module Albacore
 
       # expects both parameters and executable to be relative to the
       # work_dir parameter
-      def initialize work_dir, executable, parameters, file
+      def initialize work_dir, executable, parameters, file, clr_command = true
         @work_dir, @executable = work_dir, executable
         @parameters = parameters.to_a.unshift(file)
+        @clr_command = clr_command
       end
 
       def execute
@@ -62,7 +73,7 @@ module Albacore
         system @executable,
           @parameters,
           :work_dir    => @work_dir,
-          :clr_command => true
+          :clr_command => @clr_command
       end
     end
 
@@ -86,7 +97,10 @@ module Albacore
       def execute_tests_for dll
         handle_directory dll, @opts.get(:exe) do |dir, exe|
           filename = File.basename dll
-          cmd = Albacore::TestRunner::Cmd.new dir, exe, @opts.get(:parameters, []), filename
+          cmd = Albacore::TestRunner::Cmd.new dir,
+                                              exe, @opts.get(:parameters, []),
+                                              filename,
+                                              @opts.get(:clr_command)
           cmd.execute
         end
       end

data/lib/albacore/version.rb

@@ -1,3 +1,3 @@
 module Albacore
-  VERSION = "2.0.0"
+  VERSION = "2.0.1"
 end

data/spec/test_runner_spec.rb

@@ -18,6 +18,9 @@ describe ::Albacore::TestRunner::Config do
   it do
     should respond_to :exe=
   end
+  it do
+    should respond_to :native_exe
+  end
 end
 describe ::Albacore::TestRunner::Config do
   subject do
@@ -26,11 +29,16 @@ describe ::Albacore::TestRunner::Config do
 
   before :each do
     subject.add_parameter '/TestResults=/b/c/d/e.xml'
+    subject.native_exe
   end
 
   it 'should have the appropriate parameter in #opts.get(:parameters)' do
     subject.opts.get(:parameters).should include('/TestResults=/b/c/d/e.xml')
   end
+  
+  it 'should have clr_command=false' do
+    expect(subject.opts.get(:clr_command)).to be false
+  end
 end
 
 describe 'the order of which parameters are passed', ::Albacore::TestRunner::Config do

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: albacore
 version: !ruby/object:Gem::Version
-  version: 2.0.0
+  version: 2.0.1
 platform: ruby
 authors:
 - Henrik Feldt
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2014-08-21 00:00:00.000000000 Z
+date: 2014-08-26 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rake