albacore 2.1.2 → 2.2.0.pre.beta

data/lib/albacore/task_types/test_runner.rb

@@ -1,143 +1,143 @@
-require 'set'
-require 'map'
-require 'tmpdir'
-require 'fileutils'
-require 'pathname'
-require 'albacore/cmd_config'
-require 'albacore/cross_platform_cmd'
-
-module Albacore
-  module TestRunner
-    # the configuration object for the test runner
-    class Config
-      include CmdConfig
-
-      # give this property the list of dlls you want to test
-      attr_writer :files
-
-      # constructor, no parameters
-      def initialize
-        @copy_local = false
-        @clr_command = true
-        @files = []
-      end
-
-      # Gets the configured options from the test runner configuration.
-      #
-      def opts
-        Map.new(
-          :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
-      # -- 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
-          @files
-        else
-          [@files]
-        end
-      end
-    end
-
-    class Cmd
-      include CrossPlatformCmd
-
-      # expects both parameters and executable to be relative to the
-      # work_dir parameter
-      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
-        info { "executing in directory './#{@work_dir}'" }
-        system @executable,
-          @parameters,
-          :work_dir    => @work_dir,
-          :clr_command => @clr_command
-      end
-    end
-
-    class Task
-      include Logging
-
-      def initialize opts
-        @opts = opts
-      end
-
-      def execute
-        raise ArgumentError, 'missing :exe' unless @opts.get :exe
-        raise ArgumentError, 'missing :files' unless @opts.get :files
-        @opts.get(:files).each do |dll|
-          raise ArgumentError, "could not find test dll '#{dll}' in dir #{FileUtils.pwd}" unless File.exists? dll
-          execute_tests_for dll
-        end
-      end
-
-      private
-      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,
-                                              @opts.get(:clr_command)
-          cmd.execute
-        end
-      end
-      def handle_directory dll, exe, &block
-        if @opts.get(:copy_local)
-          # TODO: #mktmpdir is not always reliable; consider contributing a patch to ruby?
-          # Fails sometimes with "directory already exists"
-          Dir.mktmpdir 'alba-test' do |dir|
-            sut, runners = Paths.join(dir, 'sut').to_s, Paths.join(dir, 'runners').to_s
-            [sut, runners].each { |d| FileUtils.mkdir_p d }
-
-            sut_glob = Paths.join(File.dirname(dll), '*').as_unix.to_s
-            debug { "copying recursively from #{sut_glob} [test_runner #handle_directory]" }
-            FileUtils.cp_r(Dir.glob(sut_glob), sut, :verbose => true)
-
-            runners_glob = Paths.join(File.dirname(exe), '*').as_unix.to_s
-            debug { "copying the runners form #{runners_glob} [test_runner #handle_directory]" }
-            FileUtils.cp_r(Dir.glob(runners_glob), runners, :verbose => true)
-
-            # call back with the new paths, easy because we have copied everything
-            yield [sut, Paths.join(runners, File.basename(exe)).to_s]
-          end
-        else
-          dir, exe =
-            case File.dirname dll
-              when /^\.\./
-                # if the dll is negative to this Rakefile, use absolute paths
-                [Pathname.new(File.absolute_path(dll)), Pathname.new(File.absolute_path(exe))]
-              else 
-                # otherwise, please continue with the basics
-                [Pathname.new(File.dirname(dll)), Pathname.new(exe)]
-            end
-
-          exe_rel = exe.relative_path_from dir
-          yield [File.dirname(dll), exe_rel.to_s]
-        end
-      end
-    end
-  end
-end
+require 'set'
+require 'map'
+require 'tmpdir'
+require 'fileutils'
+require 'pathname'
+require 'albacore/cmd_config'
+require 'albacore/cross_platform_cmd'
+
+module Albacore
+  module TestRunner
+    # the configuration object for the test runner
+    class Config
+      include CmdConfig
+
+      # give this property the list of dlls you want to test
+      attr_writer :files
+
+      # constructor, no parameters
+      def initialize
+        @copy_local = false
+        @clr_command = true
+        @files = []
+      end
+
+      # Gets the configured options from the test runner configuration.
+      #
+      def opts
+        Map.new(
+          :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
+      # -- 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
+          @files
+        else
+          [@files]
+        end
+      end
+    end
+
+    class Cmd
+      include CrossPlatformCmd
+
+      # expects both parameters and executable to be relative to the
+      # work_dir parameter
+      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
+        info { "executing in directory './#{@work_dir}'" }
+        system @executable,
+          @parameters,
+          :work_dir    => @work_dir,
+          :clr_command => @clr_command
+      end
+    end
+
+    class Task
+      include Logging
+
+      def initialize opts
+        @opts = opts
+      end
+
+      def execute
+        raise ArgumentError, 'missing :exe' unless @opts.get :exe
+        raise ArgumentError, 'missing :files' unless @opts.get :files
+        @opts.get(:files).each do |dll|
+          raise ArgumentError, "could not find test dll '#{dll}' in dir #{FileUtils.pwd}" unless File.exists? dll
+          execute_tests_for dll
+        end
+      end
+
+      private
+      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,
+                                              @opts.get(:clr_command)
+          cmd.execute
+        end
+      end
+      def handle_directory dll, exe, &block
+        if @opts.get(:copy_local)
+          # TODO: #mktmpdir is not always reliable; consider contributing a patch to ruby?
+          # Fails sometimes with "directory already exists"
+          Dir.mktmpdir 'alba-test' do |dir|
+            sut, runners = Paths.join(dir, 'sut').to_s, Paths.join(dir, 'runners').to_s
+            [sut, runners].each { |d| FileUtils.mkdir_p d }
+
+            sut_glob = Paths.join(File.dirname(dll), '*').as_unix.to_s
+            debug { "copying recursively from #{sut_glob} [test_runner #handle_directory]" }
+            FileUtils.cp_r(Dir.glob(sut_glob), sut, :verbose => true)
+
+            runners_glob = Paths.join(File.dirname(exe), '*').as_unix.to_s
+            debug { "copying the runners form #{runners_glob} [test_runner #handle_directory]" }
+            FileUtils.cp_r(Dir.glob(runners_glob), runners, :verbose => true)
+
+            # call back with the new paths, easy because we have copied everything
+            yield [sut, Paths.join(runners, File.basename(exe)).to_s]
+          end
+        else
+          dir, exe =
+            case File.dirname dll
+              when /^\.\./
+                # if the dll is negative to this Rakefile, use absolute paths
+                [Pathname.new(File.absolute_path(dll)), Pathname.new(File.absolute_path(exe))]
+              else 
+                # otherwise, please continue with the basics
+                [Pathname.new(File.dirname(dll)), Pathname.new(exe)]
+            end
+
+          exe_rel = exe.relative_path_from dir
+          yield [File.dirname(dll), exe_rel.to_s]
+        end
+      end
+    end
+  end
+end

data/lib/albacore/tasks/albasemver.rb

@@ -1,49 +1,49 @@
-# -*- encoding: utf-8 -*-
-
-require 'semver'
-require 'albacore/logging'
-
-module Albacore
-  module AlbaSemVer
-    class Error < StandardError
-      attr_reader :original
-      def initialize msg, original
-        raise ArgumentError, "original is nil" unless original
-        super msg
-        @original = original
-      end
-      def message
-        %Q{#{super.to_s}
-#{@original.to_s}}
-      end
-    end
-    class Cmd
-      def initialize
-      end
-      def execute
-        puts "TODO: execute versioning"
-      end
-    end
-    class Config
-      include Logging
-      
-      attr_accessor :tag
-      
-      def initialize
-        begin
-          @semver = SemVer.find
-        rescue SemVerMissingError => e
-          raise Error.new("could not find .semver file - please run 'semver init'", e)
-        end
-      end
-    end
-    class Task
-      def initialize cmd
-        @cmd = cmd
-      end
-      def execute
-        @cmd.execute
-      end
-    end
-  end
-end
+# -*- encoding: utf-8 -*-
+
+require 'semver'
+require 'albacore/logging'
+
+module Albacore
+  module AlbaSemVer
+    class Error < StandardError
+      attr_reader :original
+      def initialize msg, original
+        raise ArgumentError, "original is nil" unless original
+        super msg
+        @original = original
+      end
+      def message
+        %Q{#{super.to_s}
+#{@original.to_s}}
+      end
+    end
+    class Cmd
+      def initialize
+      end
+      def execute
+        puts "TODO: execute versioning"
+      end
+    end
+    class Config
+      include Logging
+
+      attr_accessor :tag
+
+      def initialize
+        begin
+          @semver = SemVer.find
+        rescue SemVerMissingError => e
+          raise Error.new("could not find .semver file - please run 'semver init'", e)
+        end
+      end
+    end
+    class Task
+      def initialize cmd
+        @cmd = cmd
+      end
+      def execute
+        @cmd.execute
+      end
+    end
+  end
+end

data/lib/albacore/tasks/release.rb

@@ -0,0 +1,150 @@
+require 'rake'
+require 'albacore/dsl'
+require 'map'
+
+module Albacore
+  module Tasks
+    # The published message on a finished release
+    #
+    class ReleaseData
+      # The semver that was released
+      #
+      attr_reader :semver
+
+      # The enumerable thing of artifacts that were created from the release
+      #
+      attr_reader :artifacts
+
+      # Create a new ReleaseData object with a semver (XSemVer::SemVer instance)
+      # and a list of artifacts
+      #
+      def initialize semver, artifacts
+        raise ArgumentError, 'missing "semver" argument' unless semver
+        raise ArgumentError, 'missing "artifacts" argument' unless artifacts
+        raise ArgumentError, '"artifacts" should respond to #each' unless artifacts.respond_to? :each
+        @semver = semver
+        @artifacts = artifacts
+      end
+    end
+
+    # Inspiration from: https://github.com/bundler/bundler/blob/master/lib/bundler/gem_helper.rb
+    #
+    class Release
+      include ::Rake::DSL
+      include ::Albacore::DSL
+
+      def initialize name = :release, opts = {}
+        @name = name
+        @opts = Map.new(opts).apply \
+          pkg_dir:      'build/pkg',
+          nuget_exe:    'tools/NuGet.exe',
+          nuget_source: 'https://www.nuget.org/api/v2/package',
+          clr_command:  true,
+          depend_on:    :versioning,
+          semver:       nil
+        semver = @opts.get :semver
+
+        unless semver
+          ::Albacore.subscribe :build_version do |data|
+            @semver = data.semver
+          end
+        else
+          @semver = semver
+        end
+
+        install
+      end
+
+      # Installs the rake tasks under the 'release' namespace with a named task
+      # (given as the first parameter to the c'tor) that calls all subtasks.
+      #
+      def install
+        namespace :release do
+          desc 'ensure the tree is not dirty'
+          task :guard_clean => @opts.get(:depend_on) do
+            guard_clean
+          end
+
+          task :scm_write => @opts.get(:depend_on) do
+            tag_version { git_push } unless already_tagged?
+          end
+
+          task :nuget_push => @opts.get(:depend_on) do
+            packages = Dir.glob "#{@opts.get :pkg_dir}/*.#{@semver.format "%M.%m.%p"}.nupkg"
+            packages.each do |package|
+              nuget_push package
+            end
+          end
+        end
+
+        desc 'release current package(s)'
+        task @name => [:'release:guard_clean', :'release:scm_write', :'release:nuget_push']
+      end
+
+      protected
+      def run *cmd
+        block = lambda { |ok, status, output| [output, status] }
+        sh(*cmd, &block)
+      end
+
+      def nuget_push package
+        exe     = @opts.get :nuget_exe
+        api_key = @opts.get :api_key
+        params = %W|push #{package}|
+        params << api_key if api_key
+        params << %W|-Source #{@opts.get :nuget_source}|
+        system exe, params, clr_command: @opts.get(:clr_command)
+      end
+
+      def git_push
+        perform_git_push
+        perform_git_push ' --tags'
+        info "Pushed git commits and tags."
+      end
+
+      def perform_git_push(options = '')
+        cmd = "git push #{options}"
+        out, code = run cmd
+        raise "Couldn't git push. `#{cmd}' failed with the following output:\n\n#{out}\n" unless code == 0
+      end
+
+      def already_tagged?
+        tags = run('git tag', silent: true)[0].split(/\n/)
+        if tags.include? version_tag
+          warn "Tag #{version_tag} has already been created."
+          true
+        end
+      end
+
+      def guard_clean
+        clean? && committed? or raise("There are files that need to be committed first.")
+      end
+
+      def clean?
+        run('git diff --exit-code', silent: true)[1] == 0
+      end
+
+      def committed?
+        run('git diff-index --quiet --cached HEAD', silent: true)[1] == 0
+      end
+
+      def tag_version
+        system 'git', %W|tag -a -m Version\ #{@semver.format '%M.%m.%p'} #{version_tag}|, silent: true
+        info "Tagged #{version_tag}."
+        yield if block_given?
+      rescue
+        error "Untagging #{version_tag} due to error."
+        system 'git', %W|tag -d #{version_tag}|, silent: true
+        raise
+      end
+
+      def version_tag
+        @semver.to_s
+      end
+
+      def gem_push?
+        ! %w{n no nil false off 0}.include?(ENV['gem_push'].to_s.downcase)
+      end
+    end
+  end
+end