jamie 0.1.0.alpha16 → 0.1.0.alpha17

data/Rakefile

@@ -19,7 +19,7 @@ end
 
 Tailor::RakeTask.new
 
-desc "yep"
+desc "Display LOC stats"
 task :stats do
   sh "countloc -r lib/jamie lib/jamie.rb"
 end

data/lib/jamie/cli.rb

@@ -1,6 +1,5 @@
 # -*- encoding: utf-8 -*-
 
-require 'erb'
 require 'ostruct'
 require 'thor'
 
@@ -25,7 +24,7 @@ module Jamie
       say Array(result).map{ |i| i.name }.join("\n")
     end
 
-    [:create, :converge, :setup, :verify, :test, :destroy].each do |action|
+    [:create, :converge, :setup, :verify, :destroy].each do |action|
       desc(
         "#{action} (all ['REGEX']|[INSTANCE])",
         "#{action.capitalize} one or more instances"
@@ -33,6 +32,28 @@ module Jamie
       define_method(action) { |*args| exec_action(action) }
     end
 
+    desc "test (all ['REGEX']|[INSTANCE]) [opts]", "Test one or more instances"
+    long_desc <<-DESC
+      Test one or more instances
+
+      There are 3 post-verify modes for instance cleanup, triggered with
+      the `--destroy' flag:
+
+      * passing: instances passing verify will be destroyed afterwards.\n
+      * always: instances will always be destroyed afterwards.\n
+      * never: instances will never be destroyed afterwards.
+    DESC
+    method_option :destroy, :aliases => "-d", :default => "passing",
+      :desc => "Destroy strategy to use after testing (passing, always, never)."
+    def test(*args)
+      destroy_mode = options[:destroy]
+      if ! %w{passing always never}.include?(options[:destroy])
+        raise ArgumentError, "Destroy mode must be passing, always, or never."
+      end
+      result = parse_subcommand(args[0], args[1])
+      Array(result).each { |instance| instance.test(destroy_mode.to_sym) }
+    end
+
     desc "version", "Print Jamie's version information"
     def version
       say "Jamie version #{Jamie::VERSION}"

data/lib/jamie/driver/dummy.rb

@@ -0,0 +1,58 @@
+# -*- encoding: utf-8 -*-
+#
+# Author:: Fletcher Nichol (<fnichol@nichol.ca>)
+#
+# Copyright (C) 2012, Fletcher Nichol
+#
+# Licensed under the Apache License, Version 2.0 (the "License");
+# you may not use this file except in compliance with the License.
+# You may obtain a copy of the License at
+#
+#    http://www.apache.org/licenses/LICENSE-2.0
+#
+# Unless required by applicable law or agreed to in writing, software
+# distributed under the License is distributed on an "AS IS" BASIS,
+# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+# See the License for the specific language governing permissions and
+# limitations under the License.
+
+require 'jamie'
+
+module Jamie
+
+  module Driver
+
+    # Dummy driver for Jamie.
+    class Dummy < Jamie::Driver::Base
+
+      def create(instance, state)
+        state['my_id'] = "#{instance.name}-#{Time.now.to_i}"
+        report(:create, instance, state)
+      end
+
+      def converge(instance, state)
+        report(:converge, instance, state)
+      end
+
+      def setup(instance, state)
+        report(:setup, instance, state)
+      end
+
+      def verify(instance, state)
+        report(:verify, instance, state)
+      end
+
+      def destroy(instance, state)
+        report(:destroy, instance, state)
+        state.delete('my_id')
+      end
+
+      private
+
+      def report(action, instance, state)
+        puts "[Dummy] Action ##{action} called on " +
+          "instance=#{instance} with state=#{state}"
+      end
+    end
+  end
+end

data/lib/jamie/version.rb

@@ -2,5 +2,5 @@
 
 module Jamie
 
-  VERSION = "0.1.0.alpha16"
+  VERSION = "0.1.0.alpha17"
 end

data/lib/jamie.rb

@@ -3,6 +3,7 @@
 require 'base64'
 require 'delegate'
 require 'digest'
+require 'erb'
 require 'fileutils'
 require 'json'
 require 'mixlib/shellout'
@@ -150,7 +151,11 @@ module Jamie
     end
 
     def yaml
-      @yaml ||= YAML.load_file(File.expand_path(yaml_file)).rmerge(local_yaml)
+      @yaml ||= YAML.load(yaml_contents).rmerge(local_yaml)
+    end
+
+    def yaml_contents
+      ERB.new(IO.read(File.expand_path(yaml_file))).result
     end
 
     def local_yaml_file
@@ -161,7 +166,7 @@ module Jamie
     def local_yaml
       @local_yaml ||= begin
         if File.exists?(local_yaml_file)
-          YAML.load_file(local_yaml_file)
+          YAML.load(ERB.new(IO.read(local_yaml_file)).result)
         else
           Hash.new
         end
@@ -364,10 +369,7 @@ module Jamie
     # @todo rescue Driver::ActionFailed and return some kind of null object
     #   to gracfully stop action chaining
     def create
-      puts "-----> Creating instance #{name}"
-      action(:create) { |state| platform.driver.create(self, state) }
-      puts "       Creation of instance #{name} complete."
-      self
+      transition_to(:create)
     end
 
     # Converges this running instance.
@@ -378,10 +380,7 @@ module Jamie
     # @todo rescue Driver::ActionFailed and return some kind of null object
     #   to gracfully stop action chaining
     def converge
-      puts "-----> Converging instance #{name}"
-      action(:converge) { |state| platform.driver.converge(self, state) }
-      puts "       Convergence of instance #{name} complete."
-      self
+      transition_to(:converge)
     end
 
     # Sets up this converged instance for suite tests.
@@ -392,10 +391,7 @@ module Jamie
     # @todo rescue Driver::ActionFailed and return some kind of null object
     #   to gracfully stop action chaining
     def setup
-      puts "-----> Setting up instance #{name}"
-      action(:setup) { |state| platform.driver.setup(self, state) }
-      puts "       Setup of instance #{name} complete."
-      self
+      transition_to(:setup)
     end
 
     # Verifies this set up instance by executing suite tests.
@@ -406,10 +402,7 @@ module Jamie
     # @todo rescue Driver::ActionFailed and return some kind of null object
     #   to gracfully stop action chaining
     def verify
-      puts "-----> Verifying instance #{name}"
-      action(:verify) { |state| platform.driver.verify(self, state) }
-      puts "       Verification of instance #{name} complete."
-      self
+      transition_to(:verify)
     end
 
     # Destroys this instance.
@@ -420,40 +413,75 @@ module Jamie
     # @todo rescue Driver::ActionFailed and return some kind of null object
     #   to gracfully stop action chaining
     def destroy
-      puts "-----> Destroying instance #{name}"
-      action(:destroy) { |state| platform.driver.destroy(self, state) }
-      destroy_state
-      puts "       Destruction of instance #{name} complete."
-      self
+      transition_to(:destroy)
     end
 
     # Tests this instance by creating, converging and verifying. If this
     # instance is running, it will be pre-emptively destroyed to ensure a
     # clean slate. The instance will be left post-verify in a running state.
     #
-    # @see #destroy
-    # @see #create
-    # @see #converge
-    # @see #setup
-    # @see #verify
+    # @param destroy_mode [Symbol] strategy used to cleanup after instance
+    #   has finished verifying (default: `:passing`)
     # @return [self] this instance, used to chain actions
     #
     # @todo rescue Driver::ActionFailed and return some kind of null object
     #   to gracfully stop action chaining
-    def test
+    def test(destroy_mode = :passing)
       puts "-----> Cleaning up any prior instances of #{name}"
       destroy
       puts "-----> Testing instance #{name}"
-      create
-      converge
-      setup
       verify
+      destroy if destroy_mode == :passing
       puts "       Testing of instance #{name} complete."
       self
+    ensure
+      destroy if destroy_mode == :always
     end
 
     private
 
+    def transition_to(desired)
+      FSM.actions(last_action, desired).each do |transition|
+        send("#{transition}_action")
+      end
+    end
+
+    def create_action
+      puts "-----> Creating instance #{name}"
+      action(:create) { |state| platform.driver.create(self, state) }
+      puts "       Creation of instance #{name} complete."
+      self
+    end
+
+    def converge_action
+      puts "-----> Converging instance #{name}"
+      action(:converge) { |state| platform.driver.converge(self, state) }
+      puts "       Convergence of instance #{name} complete."
+      self
+    end
+
+    def setup_action
+      puts "-----> Setting up instance #{name}"
+      action(:setup) { |state| platform.driver.setup(self, state) }
+      puts "       Setup of instance #{name} complete."
+      self
+    end
+
+    def verify_action
+      puts "-----> Verifying instance #{name}"
+      action(:verify) { |state| platform.driver.verify(self, state) }
+      puts "       Verification of instance #{name} complete."
+      self
+    end
+
+    def destroy_action
+      puts "-----> Destroying instance #{name}"
+      action(:destroy) { |state| platform.driver.destroy(self, state) }
+      destroy_state
+      puts "       Destruction of instance #{name} complete."
+      self
+    end
+
     def action(what)
       state = load_state
       yield state if block_given?
@@ -482,6 +510,46 @@ module Jamie
         platform.driver['jamie_root'], ".jamie", "#{name}.yml"
       ))
     end
+
+    def last_action
+      load_state['last_action']
+    end
+
+    # The simplest finite state machine pseudo-implementation needed to manage
+    # an Instance.
+    class FSM
+
+      # Returns an Array of all transitions to bring an Instance from its last
+      # reported transistioned state into the desired transitioned state.
+      #
+      # @param last [String,Symbol,nil] the last known transitioned state of
+      #   the Instance, defaulting to `nil` (for unknown or no history)
+      # @param desired [String,Symbol] the desired transitioned state for the
+      #   Instance
+      # @return [Array<Symbol>] an Array of transition actions to perform
+      def self.actions(last = nil, desired)
+        last_index = index(last)
+        desired_index = index(desired)
+
+        if last_index == desired_index || last_index > desired_index
+          Array(TRANSITIONS[desired_index])
+        else
+          TRANSITIONS.slice(last_index + 1, desired_index - last_index)
+        end
+      end
+
+      private
+
+      TRANSITIONS = [ :destroy, :create, :converge, :setup, :verify ]
+
+      def self.index(transition)
+        if transition.nil?
+          0
+        else
+          TRANSITIONS.find_index { |t| t == transition.to_sym }
+        end
+      end
+    end
   end
 
   # Command string generator to interface with Jamie Runner (jr). The
@@ -781,7 +849,7 @@ module Jamie
       end
 
       def converge(instance, state)
-        ssh_args = generate_ssh_args(state)
+        ssh_args = build_ssh_args(state)
 
         install_omnibus(ssh_args) if config['require_chef_omnibus']
         prepare_chef_home(ssh_args)
@@ -790,7 +858,7 @@ module Jamie
       end
 
       def setup(instance, state)
-        ssh_args = generate_ssh_args(state)
+        ssh_args = build_ssh_args(state)
 
         if instance.jr.setup_cmd
           ssh(ssh_args, instance.jr.setup_cmd)
@@ -798,7 +866,7 @@ module Jamie
       end
 
       def verify(instance, state)
-        ssh_args = generate_ssh_args(state)
+        ssh_args = build_ssh_args(state)
 
         if instance.jr.run_cmd
           ssh(ssh_args, instance.jr.sync_cmd)
@@ -812,11 +880,12 @@ module Jamie
 
       protected
 
-      def generate_ssh_args(state)
-        [ state['hostname'],
-          config['username'],
-          { :password => config['password'] }
-        ]
+      def build_ssh_args(state)
+        opts = Hash.new
+        opts[:password] = config['password'] if config['password']
+        opts[:keys] = Array(config['ssh_key']) if config['ssh_key']
+
+        [ state['hostname'], config['username'], opts ]
       end
 
       def chef_home

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: jamie
 version: !ruby/object:Gem::Version
-  version: 0.1.0.alpha16
+  version: 0.1.0.alpha17
   prerelease: 6
 platform: ruby
 authors:
@@ -174,6 +174,7 @@ files:
 - jamie.gemspec
 - lib/jamie.rb
 - lib/jamie/cli.rb
+- lib/jamie/driver/dummy.rb
 - lib/jamie/rake_tasks.rb
 - lib/jamie/thor_tasks.rb
 - lib/jamie/version.rb
@@ -199,7 +200,7 @@ required_ruby_version: !ruby/object:Gem::Requirement
       version: '0'
       segments:
       - 0
-      hash: -1684640608008309798
+      hash: -4096747563693358273
 required_rubygems_version: !ruby/object:Gem::Requirement
   none: false
   requirements: