cartage 1.0 → 1.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: d1f67642374f3f5997dd5d735d20b33e8e035c5c
-  data.tar.gz: 64cd9abc15c2bf0a2e8097545a1013d434b38e6b
+  metadata.gz: 76442e63f895e68ab77395c7070db5a050609eaa
+  data.tar.gz: 90a158c13769878cf94f637d2c3757008e7e54ba
 SHA512:
-  metadata.gz: 5939952a64d810668aeec416727bdaadda5011d594115719bbfd5aaf3af3ee86d89614dd3689d7cfc30c41a76b459e7de1a40c811f13285c5eb56b8e101d1d42
-  data.tar.gz: dfd005d425fff150f5b465c1a88af03f6e2df935a3c2152f0607e84265524d44a6ef90d8dcb3c59b28e0463d2ded90ae9ece49a58dcf87803fe91e87b8e9b4d3
+  metadata.gz: bd325df936363b4df3016284b183af381f0a3ca7af67fdb84df0a6611803b90f21cddc2a324dc5a46ac48e42364c5b748ad3931f56d6804725011462a5e84770
+  data.tar.gz: 6d454884b43b7d55a4f0e5141ab26d15f98b442963045cdb2691fbb5baadb8b7d2555e0db006b59a40ad33d158eb5ad8fdbc39aa0efa816ae51f56c6e16ec521

data/Cartage.yml.rdoc

@@ -258,14 +258,26 @@ as cartage-remote runs SSH in a paranoid mode.
 The postbuild script that will be run on the local system. This is optional
 with no default (no post-build actions).
 
+The postbuild script will be passed the stage identifier as <tt>$1</tt>
+(valid values are +config+, +ssh_config+, +prebuild+, +remote_clone+,
++remote_build+, +cleanup+, or +finished+). If the build was interrupted with
+an error, the error message will be passed as <tt>$2</tt>.
+
 An example that posts a message to Slack is below.
 
     plugins:
       remote:
         postbuild: |
           #!/bin/bash
-          t="token=SLACK_TOKEN"
-          c="channel=%23ci"
-          d=MYDOMAIN
-          u="https://${d}.slack.com/services/hooks/slackbot?${t}&${c}"
-          curl --data "Build %<name>s-%<timestamp>s complete." ${u}
+          case ${1:-undefined} in
+            finished)
+              t="token=SLACK_TOKEN"
+              c="channel=%23ci"
+              d=MYDOMAIN
+              u="https://${d}.slack.com/services/hooks/slackbot?${t}&${c}"
+              curl --data "Build %<name>s-%<timestamp>s complete." ${u}
+              ;;
+            *)
+              : # ${1} is the stage, ${2} is the error message
+              ;;
+          esac

data/History.rdoc

@@ -1,3 +1,21 @@
+=== 1.1 / 2015-03-26
+
+*   1 major enhancement
+
+    *   Added a Cartage::StatusError with an exitstatus support.
+        Cartage::QuietError is now based on this.
+
+*   1 minor bugfix
+
+    *   Restored an accidentally removed method,
+        Cartage::#create_bundle_cache.
+
+*   2 documentation improvements
+
+    *   Identified postbuild script stages.
+
+    *   Improved the Slack notifier example postbuild script.
+
 === 1.0 / 2015-03-24
 
 *   1 major enhancement

data/cartage.yml.sample

@@ -153,14 +153,26 @@ plugins:
 
     # The postbuild script that will be run on the local system. This is
     # optional with no default (no post-build actions).
+    #
+    # This script will be passed the stage identifier as $1 (valid values are
+    # config, ssh_config, prebuild, remote_clone, remote_build, cleanup, or
+    # finished). If the build was interrupted with an error, the error
+    # message will be passed as $2.
     # ---
     # postbuild: |
     #   #!/bin/bash
-    #   t="token=SLACK_TOKEN"
-    #   c="channel=%23ci"
-    #   d=MYDOMAIN
-    #   u="https://${d}.slack.com/services/hooks/slackbot?${t}&${c}"
-    #   curl --data "Build %<name>s-%<timestamp>s complete." ${u}
+    #   case ${1:-undefined} in
+    #     finished)
+    #       t="token=SLACK_TOKEN"
+    #       c="channel=%23ci"
+    #       d=MYDOMAIN
+    #       u="https://${d}.slack.com/services/hooks/slackbot?${t}&${c}"
+    #       curl --data "Build %<name>s-%<timestamp>s complete." ${u}
+    #       ;;
+    #     *)
+    #       : # ${1} is the stage, ${2} is the error message
+    #       ;;
+    #   esac
 
 # This must not be indented for it to work.
 <% if File.exist?('config/ansible/cartage.yml') %>
@@ -169,4 +181,3 @@ plugins:
 <% if File.exist?('config/local/cartage.yml') %>
 <%= File.read('config/local/cartage.yml') %>
 <% end %>
-

data/lib/cartage.rb

@@ -2,17 +2,29 @@ require 'pathname'
 
 # Cartage, a package builder.
 class Cartage
-  VERSION = '1.0' #:nodoc:
+  VERSION = '1.1' #:nodoc:
+
+  # Plug-in commands that want to return a specific exit code should use
+  # Cartage::StatusError to wrap the error.
+  class StatusError < StandardError
+    # Initialize the exception with +exitstatus+ and the exception to wrap.
+    def initialize(exitstatus, exception_or_message)
+      super(exception_or_message) if exception_or_message
+      @exitstatus = exitstatus
+    end
 
-  # Plug-in commands that want to return a non-zero exit code should raise
-  # Cartage::QuietError.new(exitstatus).
-  class QuietError < StandardError
+    # The exit status to be returned from this exception.
+    attr_reader :exitstatus
+  end
+
+  # Plug-in commands that want to return a non-zero exit code without a message
+  # should raise Cartage::QuietError.new(exitstatus).
+  class QuietError < StatusError
     # Initialize the exception with +exitstatus+.
     def initialize(exitstatus)
-      @exitstatus = exitstatus
+      super(exitstatus, nil)
     end
 
-    # The exit status to be returned from this exception.
     attr_reader :exitstatus
   end
 
@@ -285,6 +297,10 @@ class Cartage
     run %W(tar xfj #{bundle_cache} -C #{work_path}) if bundle_cache.exist?
   end
 
+  def create_bundle_cache
+    run %W(tar cfj #{bundle_cache} -C #{work_path} vendor/bundle)
+  end
+
   def install_vendor_bundle
     extract_bundle_cache
 
@@ -449,13 +465,10 @@ configuration file.
 
     registered_commands.uniq.each { |cmd| cli.add_command(cmd.new(cartage)) }
     cli.parse
-    0
-  rescue Cartage::QuietError => qe
-    qe.exitstatus
-  rescue StandardError => e
-    $stderr.puts "Error:\n    " + e.message
-    $stderr.puts e.backtrace.join("\n") if cartage.verbose
-    2
+    return 0
+  rescue Exception => exception
+    show_message_for exception, for_cartage: cartage
+    return exitstatus_for(exception)
   end
 
   # Set options common to anything that builds a package (that is, it calls
@@ -491,6 +504,21 @@ configuration file.
   def registered_commands
     @registered_commands ||= []
   end
+
+  def exitstatus_for(exception)
+    if exception.respond_to? :exitstatus
+      exception.exitstatus
+    else
+      2
+    end
+  end
+
+  def show_message_for(exception, for_cartage:)
+    unless exception.kind_of?(Cartage::QuietError)
+      $stderr.puts "Error:\n    " + exception.message
+      $stderr.puts exception.backtrace.join("\n") if for_cartage.verbose
+    end
+  end
 end
 
 require_relative 'cartage/config'

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: cartage
 version: !ruby/object:Gem::Version
-  version: '1.0'
+  version: '1.1'
 platform: ruby
 authors:
 - Austin Ziegler
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2015-03-24 00:00:00.000000000 Z
+date: 2015-03-26 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: cmdparse