cartage-remote 1.0 → 1.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 8ec28919c46cca17afd22212d913af4b3292c7eb
-  data.tar.gz: 50e8f6d1252e272526e4e8953f0a872107e0078d
+  metadata.gz: 8d8ac39718d7abe3c0091abb06c8d3ecb456626e
+  data.tar.gz: a143524b851528d44b9dde9f77a9946c76ca2b1e
 SHA512:
-  metadata.gz: a8cb9fd3b201d4951452c98b107fe68b01a3d61d4a544bbe864404467e28fea84791cf13654085d1a6201c0ed6407355e7da1b627dd9fb1b7b865dc4d8c23bc8
-  data.tar.gz: ec485dac5760aca2e8fa061050e72bdf3dd9c8a29a8ef71af6b5522b81f30345981ada21c9ee6ac47e71525aa79b6da746b8e593d37a3881db612ca4890fc6f3
+  metadata.gz: 7a36d402c39713f5e0c1d4337cc52e7a7d57ddf74db363add86ca1e0c8db08d876603b58c1e099f8782507dd3ee9fec0fcce42311ccab03502f73aed318d0814
+  data.tar.gz: 395e90926c44b60f527398084938f8755679110c2b404211975d74077068a5881598f8b504c54e7c2d50705c1af829561242a0c6f03e422010f10183412eb97d

data/History.rdoc

@@ -1,4 +1,26 @@
-=== 1.0 / 2015-03-20
+=== 1.1 / 2015-03-26
+
+*   1 major bugfix
+
+    *   When a remote script fails, the error would not result in a non-zero
+        exit code, meaning that scripts could not detect failures in cartage
+        remote. Fixes [#1]{https://github.com/KineticCafe/cartage/issues/1}.
+
+*   1 minor enhancement
+
+    *   When the build is interrupted and a postbuild script is to be run, it
+        will be passed the exception error message as well as the stage.
+
+*   1 minor bugfix
+
+    *   Ensured that the last stage is not +cleanup+; added a +finished+ stage.
+
+*   Internal changes:
+
+    *   Using [micromachine]{https://github.com/soveran/micromachine} to
+        provide the remote builds state machine cleanly.
+
+=== 1.0 / 2015-03-24
 
 *   1 major enhancement
 

data/README.rdoc

@@ -24,7 +24,7 @@ control rules and without requiring development tool access.
 
 Add cartage-remote to your Gemfile:
 
-    gem 'cartage-remote', '~> 1.0'
+    gem 'cartage-remote', '~> 1.1'
 
 Or manually install:
 

data/Rakefile

@@ -20,7 +20,8 @@ spec = Hoe.spec 'cartage-remote' do
 
   license 'MIT'
 
-  self.extra_deps << ['cartage', '~> 1.0']
+  self.extra_deps << ['cartage', '~> 1.1']
+  self.extra_deps << ['micromachine', '~> 1.2']
   self.extra_deps << ['fog', '~> 1.27']
 
   self.extra_dev_deps << ['rake', '~> 10.0']
@@ -28,7 +29,6 @@ spec = Hoe.spec 'cartage-remote' do
   self.extra_dev_deps << ['hoe-gemspec2', '~> 1.1']
   self.extra_dev_deps << ['hoe-git', '~> 1.5']
   self.extra_dev_deps << ['hoe-geminabox', '~> 0.3']
-=begin
   self.extra_dev_deps << ['minitest', '~> 5.4']
   self.extra_dev_deps << ['minitest-autotest', '~> 1.0']
   self.extra_dev_deps << ['minitest-bisect', '~> 1.2']
@@ -36,10 +36,8 @@ spec = Hoe.spec 'cartage-remote' do
   self.extra_dev_deps << ['minitest-moar', '~> 0.0']
   self.extra_dev_deps << ['minitest-pretty_diff', '~> 0.1']
   self.extra_dev_deps << ['simplecov', '~> 0.7']
-=end
 end
 
-=begin
 namespace :test do
   task :coverage do
     prelude = <<-EOS
@@ -51,6 +49,5 @@ gem 'minitest'
     Rake::Task['test'].execute
   end
 end
-=end
 
 # vim: syntax=ruby

data/lib/cartage/remote.rb

@@ -5,6 +5,7 @@ end
 require 'tempfile'
 require 'yaml'
 require 'erb'
+require 'micromachine'
 require 'cartage/plugin'
 
 class Cartage
@@ -102,8 +103,11 @@ class Cartage
   #                #!/bin/bash
   #                ssh-keyscan -H %<remote_host>s >> ~/.ssh/known_hosts
   # +postbuild+:: A multiline YAML string that is run as a script on the local
-  #               machine to finish the build process locally. If not provided,
-  #               nothing will run.
+  #               machine to finish the build process locally. If not
+  #               provided, nothing will run. The script will be passed the
+  #               stage (+config+, +ssh_config+, +prebuild+, +remote_clone+,
+  #               +remote_build+, +cleanup+, or +finished+) and, if the stage
+  #               is not +finished+, the error message.
   #
   # == Script Substitution
   #
@@ -153,32 +157,70 @@ class Cartage
   #         bundle exec cartage s3 --config-file %<config_file>s
   #
   class Remote < Cartage::Plugin
-    VERSION = '1.0' #:nodoc:
+    VERSION = '1.1' #:nodoc:
 
     def initialize(*) #:nodoc:
       super
       @tmpfiles = []
+      @fsm = MicroMachine.new(:new).tap do |fsm|
+        fsm.when(:local_setup, new: :config)
+        fsm.when(:ssh_setup, config: :ssh_config)
+        fsm.when(:run_prebuild, ssh_config: :prebuild)
+        fsm.when(:clone_remote, prebuild: :remote_clone)
+        fsm.when(:build_remote, remote_clone: :remote_build)
+        fsm.when(:clean_remote, remote_build: :cleanup)
+        fsm.when(:complete, cleanup: :finished)
+        fsm.on(:any) { |event| dispatch(event, @fsm.state) }
+      end
     end
 
     # Build on the remote server.
     def build
+      @fsm.trigger!(:local_setup)
+      @fsm.trigger!(:ssh_setup)
+      @fsm.trigger!(:run_prebuild)
+      @fsm.trigger!(:clone_remote)
+      @fsm.trigger!(:build_remote)
+      @fsm.trigger!(:clean_remote)
+      @fsm.trigger!(:complete)
+    rescue Cartage::StatusError
+      raise
+    rescue Exception => e
+      error = e.exception("Remote error in stage #{@fsm.state}: #{e.message}")
+      error.set_backtrace(e.backtrace)
+      raise error
+    ensure
+      if @postbuild
+        @cartage.display 'Running postbuild script...'
+        system(make_tmpscript('postbuild', @postbuild, @subs).path,
+               @fsm.state.to_s, error.to_s)
+      end
+
+      @tmpfiles.each { |tmpfile|
+        tmpfile.close
+        tmpfile.unlink
+      }
+      @tmpfiles.clear
+    end
+
+    private
+
+    def local_setup
       @cartage.display 'Pre-build configuration...'
-      stage = :config
-
-      paths = OpenStruct.new(build_root: @build_root)
-      paths.cartage_path = paths.build_root.join('cartage')
-      paths.project_path = paths.cartage_path.join(@cartage.name)
-      paths.isolation_path = paths.project_path.join(@cartage.timestamp)
-      paths.build_path = paths.isolation_path.join(@cartage.name)
-      paths.remote_bundle = paths.isolation_path.join('deps')
-      paths.bundle_cache = paths.project_path
-      paths.config_file = paths.isolation_path.join('cartage.yml')
-      paths.build_script = paths.isolation_path.join('cartage-build-remote')
-
-      config_file = make_config(paths).path
-
-      subs = OpenStruct.new(
-        paths.to_h.merge(repo_url:        @cartage.repo_url,
+      @paths = OpenStruct.new(build_root: @build_root)
+      @paths.cartage_path = @paths.build_root.join('cartage')
+      @paths.project_path = @paths.cartage_path.join(@cartage.name)
+      @paths.isolation_path = @paths.project_path.join(@cartage.timestamp)
+      @paths.build_path = @paths.isolation_path.join(@cartage.name)
+      @paths.remote_bundle = @paths.isolation_path.join('deps')
+      @paths.bundle_cache = @paths.project_path
+      @paths.config_file = @paths.isolation_path.join('cartage.yml')
+      @paths.build_script = @paths.isolation_path.join('cartage-build-remote')
+
+      @config_file = make_config(@paths).path
+
+      @subs = OpenStruct.new(
+        @paths.to_h.merge(repo_url:        @cartage.repo_url,
                          name:            @cartage.name,
                          release_hashref: @cartage.release_hashref,
                          timestamp:       @cartage.timestamp,
@@ -187,51 +229,56 @@ class Cartage
                          remote_user:     @remote_user)
       )
 
-      stage = :ssh_config
-      configure_ssh
+    end
+
+    def ssh_setup
+      require 'fog'
+      options = {
+        paranoid: true,
+        keys:     @keys,
+        key_data: @key_data
+      }
+
+      options[:port] = @remote_port if @remote_port
+
+      @ssh = Fog::SSH.new(@remote_host, @remote_user, options)
+      @scp = Fog::SCP.new(@remote_host, @remote_user, options)
+    end
 
+    def run_prebuild
       @cartage.display 'Running prebuild script...'
-      stage = :prebuild
-      system(make_tmpscript('prebuild', @prebuild, subs).path)
+      system(make_tmpscript('prebuild', @prebuild, @subs).path)
+    end
 
-      stage = :remote_clone
+    def clone_remote
       @cartage.display <<-message
 Checking out #{@cartage.repo_url} at #{@cartage.release_hashref} remotely...
       message
 
-      ssh %Q(mkdir -p #{paths.isolation_path})
-      @scp.upload(config_file, user_path(paths.config_file))
-      ssh %Q(git clone #{@cartage.repo_url} #{paths.build_path})
+      ssh %Q(mkdir -p #{@paths.isolation_path})
+      @scp.upload(@config_file, user_path(@paths.config_file))
+      ssh %Q(git clone #{@cartage.repo_url} #{@paths.build_path})
       ssh <<-command
-cd #{paths.build_path} && git checkout #{@cartage.release_hashref}
+cd #{@paths.build_path} && git checkout #{@cartage.release_hashref}
       command
+    end
 
+    def build_remote
       @cartage.display 'Running build script...'
-      stage = :remote_build
-      script = make_tmpscript('build', @build, subs).path
-      @scp.upload(script, user_path(paths.build_script))
-      ssh %Q(cd #{paths.build_path} && #{paths.build_script})
+      script = make_tmpscript('build', @build, @subs).path
+      @scp.upload(script, user_path(@paths.build_script))
+      ssh %Q(cd #{@paths.build_path} && #{@paths.build_script})
+    end
 
-      stage = :cleanup
+    def clean_remote
       @cartage.display 'Cleaning up after the build...'
-      ssh %Q(rm -rf #{paths.isolation_path})
-    rescue StandardError => e
-      $stderr.puts "Remote error in stage #{stage}: #{e.message}"
-      $stderr.puts e.backtrace.join("\n") if @cartage.verbose
-    ensure
-      if @postbuild
-        @cartage.display 'Running postbuild script...'
-        system(make_tmpscript('postbuild', @postbuild, subs).path, stage.to_s)
-      end
-
-      @tmpfiles.each { |tmpfile|
-        tmpfile.close
-        tmpfile.unlink
-      }
-      @tmpfiles.clear
+      ssh %Q(rm -rf #{@paths.isolation_path})
     end
 
-    private
+    def dispatch(event, state)
+      send(event) if respond_to?(event, true)
+      send(state) if respond_to?(state, true)
+    end
 
     def resolve_config!(remote_config)
       unless remote_config
@@ -296,19 +343,6 @@ No build script to run on remote #{@remote_server}.
       @cartage
     end
 
-    def configure_ssh
-      require 'fog'
-      options = {
-        paranoid: true,
-        keys:     @keys,
-        key_data: @key_data
-      }
-
-      options[:port] = @remote_port if @remote_port
-
-      @ssh = Fog::SSH.new(@remote_host, @remote_user, options)
-      @scp = Fog::SCP.new(@remote_host, @remote_user, options)
-    end
 
     def ssh(*commands)
       results = @ssh.run(commands) do |stdout, stderr|
@@ -318,8 +352,12 @@ No build script to run on remote #{@remote_server}.
 
       results.each do |result|
         if result.status.nonzero?
-          fail "SSH Command failed with status (#{result.status}): " +
-            "#{result.status}"
+          message = <<-msg
+Remote error in stage #{@fsm.state}:
+  SSH command failed with status (#{result.status}):
+    #{result.command}
+          msg
+          fail Cartage::StatusError.new(result.status, message)
         end
       end
     end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: cartage-remote
 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: cartage
@@ -16,14 +16,28 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '1.0'
+        version: '1.1'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '1.0'
+        version: '1.1'
+- !ruby/object:Gem::Dependency
+  name: micromachine
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.2'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.2'
 - !ruby/object:Gem::Dependency
   name: fog
   requirement: !ruby/object:Gem::Requirement
@@ -136,6 +150,90 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: '0.3'
+- !ruby/object:Gem::Dependency
+  name: minitest-autotest
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.0'
+- !ruby/object:Gem::Dependency
+  name: minitest-bisect
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.2'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.2'
+- !ruby/object:Gem::Dependency
+  name: minitest-focus
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.1'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.1'
+- !ruby/object:Gem::Dependency
+  name: minitest-moar
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.0'
+- !ruby/object:Gem::Dependency
+  name: minitest-pretty_diff
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.1'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.1'
+- !ruby/object:Gem::Dependency
+  name: simplecov
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.7'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.7'
 - !ruby/object:Gem::Dependency
   name: hoe
   requirement: !ruby/object:Gem::Requirement