jamie 0.1.0.alpha2 → 0.1.0.alpha3

data/README.md

@@ -1,5 +1,8 @@
 # Jamie
 
+[![Build Status](https://secure.travis-ci.org/jamie-ci/jamie.png)](https://travis-ci.org/jamie-ci/jamie)
+[![Code Climate](https://codeclimate.com/badge.png)](https://codeclimate.com/github/jamie-ci/jamie)
+
 A Chef convergence integration test harness.
 
 ## Installation

data/lib/jamie/driver/vagrant.rb

@@ -21,6 +21,22 @@ module Jamie
         run "vagrant provision #{instance.name}"
       end
 
+      def setup(instance)
+        if instance.jr.setup_cmd
+          ssh instance, instance.jr.setup_cmd
+        else
+          super
+        end
+      end
+
+      def verify(instance)
+        if instance.jr.run_cmd
+          ssh instance, instance.jr.run_cmd
+        else
+          super
+        end
+      end
+
       def destroy(instance)
         run "vagrant destroy #{instance.name} -f"
       end
@@ -28,17 +44,26 @@ module Jamie
       private
 
       def run(cmd)
-        puts "       [vagrant command] '#{cmd}'"
+        puts "       [vagrant command] '#{display_cmd(cmd)}'"
         shellout = Mixlib::ShellOut.new(
           cmd, :live_stream => STDOUT, :timeout => 60000
         )
         shellout.run_command
-        puts "       [vagrant command] '#{cmd}' ran " +
+        puts "       [vagrant command] '#{display_cmd(cmd)}' ran " +
           "in #{shellout.execution_time} seconds."
         shellout.error!
       rescue Mixlib::ShellOut::ShellCommandFailed => ex
         raise ActionFailed, ex.message
       end
+
+      def ssh(instance, cmd)
+        run %{vagrant ssh #{instance.name} --command '#{cmd}'}
+      end
+
+      def display_cmd(cmd)
+        parts = cmd.partition("\n")
+        parts[1] == "\n" ? "#{parts[0]}..." : cmd
+      end
     end
   end
 end

data/lib/jamie/vagrant.rb

@@ -15,7 +15,7 @@ module Jamie
 
       def_delegators :@config, :suites, :suites=, :platforms, :platforms=,
         :instances, :yaml_file, :yaml_file=, :log_level, :log_level=,
-        :data_bags_base_path, :data_bags_base_path=, :yaml_data
+        :test_base_path, :test_base_path=, :yaml_data
 
       def initialize
         @config = Jamie::Config.new
@@ -52,7 +52,7 @@ module Jamie
     end
 
     def self.calculate_data_bags_path(config, instance)
-      base_path = config.jamie.data_bags_base_path
+      base_path = config.jamie.test_base_path
       instance_data_bags_path = File.join(base_path, instance.name, "data_bags")
       common_data_bags_path = File.join(base_path, "data_bags")
 

data/lib/jamie/version.rb

@@ -2,5 +2,5 @@
 
 module Jamie
 
-  VERSION = "0.1.0.alpha2"
+  VERSION = "0.1.0.alpha3"
 end

data/lib/jamie.rb

@@ -1,5 +1,8 @@
 # -*- encoding: utf-8 -*-
 
+require 'base64'
+require 'digest'
+require 'net/https'
 require 'yaml'
 
 require 'jamie/core_ext'
@@ -15,7 +18,7 @@ module Jamie
     attr_writer :platforms
     attr_writer :suites
     attr_writer :log_level
-    attr_writer :data_bags_base_path
+    attr_writer :test_base_path
 
     # Default path to the Jamie YAML file
     DEFAULT_YAML_FILE = File.join(Dir.pwd, '.jamie.yml').freeze
@@ -27,7 +30,7 @@ module Jamie
     DEFAULT_DRIVER_PLUGIN = "vagrant".freeze
 
     # Default base path which may contain `data_bags/` directories
-    DEFAULT_DATA_BAGS_BASE_PATH = File.join(Dir.pwd, 'test/integration').freeze
+    DEFAULT_TEST_BASE_PATH = File.join(Dir.pwd, 'test/integration').freeze
 
     # Creates a new configuration.
     #
@@ -68,8 +71,8 @@ module Jamie
 
     # @return [String] base path that may contain a common `data_bags/`
     #   directory or an instance's `data_bags/` directory
-    def data_bags_base_path
-      @data_bags_path ||= DEFAULT_DATA_BAGS_BASE_PATH
+    def test_base_path
+      @test_base_path ||= DEFAULT_TEST_BASE_PATH
     end
 
     private
@@ -85,7 +88,22 @@ module Jamie
     end
 
     def yaml
-      @yaml ||= YAML.load_file(File.expand_path(yaml_file))
+      @yaml ||= YAML.load_file(File.expand_path(yaml_file)).rmerge(local_yaml)
+    end
+
+    def local_yaml_file
+      std = File.expand_path(yaml_file)
+      std.sub(/(#{File.extname(std)})$/, '.local\1')
+    end
+
+    def local_yaml
+      @local_yaml ||= begin
+        if File.exists?(local_yaml_file)
+          YAML.load_file(local_yaml_file)
+        else
+          Hash.new
+        end
+      end
     end
 
     def merge_platform_config(platform_config)
@@ -131,12 +149,9 @@ module Jamie
 
     private
 
-    def validate_options(options)
-      if options['name'].nil?
-        raise ArgumentError, "The option 'name' is required."
-      end
-      if options['run_list'].nil?
-        raise ArgumentError, "The option 'run_list' is required."
+    def validate_options(opts)
+      %w(name run_list).each do |k|
+        raise ArgumentError, "Attribute '#{attr}' is required." if opts[k].nil?
       end
     end
   end
@@ -180,12 +195,9 @@ module Jamie
 
     private
 
-    def validate_options(options)
-      if options['name'].nil?
-        raise ArgumentError, "The option 'name' is required."
-      end
-      if options['driver'].nil?
-        raise ArgumentError, "The option 'driver' is required."
+    def validate_options(opts)
+      %w(name driver).each do |k|
+        raise ArgumentError, "Attribute '#{attr}' is required." if opts[k].nil?
       end
     end
   end
@@ -201,6 +213,9 @@ module Jamie
     # @return [Platform] the target platform configuration
     attr_reader :platform
 
+    # @return [Jr] jr command string generator
+    attr_reader :jr
+
     # Creates a new instance, given a suite and a platform.
     #
     # @param suite [Suite] a suite
@@ -208,6 +223,7 @@ module Jamie
     def initialize(suite, platform)
       @suite = suite
       @platform = platform
+      @jr = Jr.new(@suite.name)
     end
 
     # @return [String] name of this instance
@@ -259,7 +275,21 @@ module Jamie
       self
     end
 
-    # Verifies this converged instance by executing tests.
+    # Sets up this converged instance for suite tests.
+    #
+    # @see Driver::Base#setup
+    # @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 setup
+      puts "-----> Setting up instance #{name}"
+      platform.driver.setup(self)
+      puts "       Setup of instance #{name} complete."
+      self
+    end
+
+    # Verifies this set up instance by executing suite tests.
     #
     # @see Driver::Base#verify
     # @return [self] this instance, used to chain actions
@@ -294,6 +324,7 @@ module Jamie
     # @see #destroy
     # @see #create
     # @see #converge
+    # @see #setup
     # @see #verify
     # @return [self] this instance, used to chain actions
     #
@@ -305,12 +336,157 @@ module Jamie
       puts "-----> Testing instance #{name}"
       create
       converge
+      setup
       verify
       puts "       Testing of instance #{name} complete."
       self
     end
   end
 
+  # Command string generator to interface with Jamie Runner (jr). The
+  # commands that are generated are safe to pass to an SSH command or as an
+  # unix command argument (escaped in single quotes).
+  class Jr
+
+    # Constructs a new jr command generator, given a suite name.
+    #
+    # @param [String] suite_name name of suite on which to operate
+    #   (**Required**)
+    # @param [Hash] opts optional configuration
+    # @option opts [TrueClass, FalseClass] :use_sudo whether or not to invoke
+    #   sudo before commands requiring root access (default: `true`)
+    def initialize(suite_name, opts = {:use_sudo => true})
+      validate_options(suite_name)
+
+      @suite_name = suite_name
+      @use_sudo = opts[:use_sudo]
+    end
+
+    # Returns a command string which installs the Jamie Runner (jr), installs
+    # all required jr plugins for the suite, and transfers all suite test
+    # files.
+    #
+    # If no work needs to be performed, for example if there are no tests for
+    # the given suite, then `nil` will be returned.
+    #
+    # @return [String] a command string to setup the test suite, or nil if no
+    #   work needs to be performed
+    def setup_cmd
+      @setup_cmd ||= begin
+        cmd = []
+        cmd << install_cmd  if install_cmd
+        cmd << sync_cmd     if sync_cmd
+        cmd.empty? ? nil : cmd.join("\n")
+      end
+    end
+
+    # Returns a command string which runs all jr suite tests for the suite.
+    #
+    # If no work needs to be performed, for example if there are no tests for
+    # the given suite, then `nil` will be returned.
+    #
+    # @return [String] a command string to run the test suites, or nil if no
+    #   work needs to be performed
+    def run_cmd
+      @run_cmd ||= if plugins.empty?
+        nil
+      else
+        plugins.map { |p| "#{sudo}#{jr_bin} #{p}" }.join(' && ')
+      end
+    end
+
+    private
+
+    INSTALL_URL = "https://raw.github.com/jamie-ci/jr/go".freeze
+    DEFAULT_RUBY_BINPATH = "/opt/chef/embedded/bin".freeze
+    DEFAULT_JR_ROOT = "/opt/jr".freeze
+    DEFAULT_TEST_ROOT = File.join(Dir.pwd, "test/integration").freeze
+
+    def validate_options(suite_name)
+      raise ArgumentError, "'suite_name' is required." if suite_name.nil?
+    end
+
+    def install_cmd
+      @install_cmd ||= if plugins.empty?
+        nil
+      else
+        <<-INSTALL_CMD.gsub(/ {10}/, '')
+          #{sudo}#{ruby_bin} -e "$(cat <<"EOF"
+          #{install_script}
+          EOF
+          )"
+          #{sudo}#{jr_bin} install #{plugins.join(' ')}
+        INSTALL_CMD
+      end
+    end
+
+    def sync_cmd
+      @sync_cmd ||= if local_suite_files.empty?
+        nil
+      else
+        [ "#{sudo}rm -rf $(#{jr_bin} suitepath)/*",
+          local_suite_files.map { |f| stream_file(f, remote_file(f)) }.join
+        ].join("\n")
+      end
+    end
+
+    def install_script
+      @install_script ||= begin
+        uri = URI.parse(INSTALL_URL)
+        http = Net::HTTP.new(uri.host, 443)
+        http.use_ssl = true
+        response = http.request(Net::HTTP::Get.new(uri.path))
+        response.body
+      end
+    end
+
+    def plugins
+      Dir.glob(File.join(test_root, @suite_name, "*")).select { |d|
+        File.directory?(d) && File.basename(d) != "data_bags"
+      }.map { |d| File.basename(d) }.sort.uniq
+    end
+
+    def local_suite_files
+      Dir.glob(File.join(test_root, @suite_name, "*/**/*")).reject do |f|
+        f["data_bags"] || File.directory?(f)
+      end
+    end
+
+    def remote_file(file)
+      local_prefix = File.join(test_root, @suite_name)
+      "$(#{jr_bin} suitepath)/".concat(file.sub(%r{^#{local_prefix}/}, ''))
+    end
+
+    def stream_file(local_path, remote_path)
+      local_file = IO.read(local_path)
+      md5 = Digest::MD5.hexdigest(local_file)
+      perms = sprintf("%o", File.stat(local_path).mode)[3,3]
+      jr_stream_file = "#{jr_bin} stream-file #{remote_path} #{md5} #{perms}"
+
+      <<-STREAMFILE.gsub(/^ {8}/, '')
+        cat <<"__EOFSTREAM__" | #{sudo}#{jr_stream_file}
+        #{Base64.encode64(local_file)}
+        __EOFSTREAM__
+      STREAMFILE
+    end
+
+    def sudo
+      @use_sudo ? "sudo " : ""
+    end
+
+    def ruby_bin
+      File.join(DEFAULT_RUBY_BINPATH, "ruby")
+    end
+
+    def jr_bin
+      File.join(DEFAULT_JR_ROOT, "bin/jr")
+    end
+
+    def test_root
+      DEFAULT_TEST_ROOT
+    end
+  end
+
   module Driver
 
     # Wrapped exception for any internally raised driver exceptions.
@@ -365,6 +541,11 @@ module Jamie
       # @raise [ActionFailed] if the action could not be completed
       def destroy(instance) ; end
 
+      def setup(instance)
+        # Subclass may choose to implement
+        puts "       Nothing to do!"
+      end
+
       # Verifies a converged instance.
       #
       # @param instance [Instance] an instance

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: jamie
 version: !ruby/object:Gem::Version
-  version: 0.1.0.alpha2
+  version: 0.1.0.alpha3
   prerelease: 6
 platform: ruby
 authors:
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2012-12-03 00:00:00.000000000 Z
+date: 2012-12-10 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: mixlib-shellout
@@ -140,9 +140,6 @@ required_ruby_version: !ruby/object:Gem::Requirement
   - - ! '>='
     - !ruby/object:Gem::Version
       version: '0'
-      segments:
-      - 0
-      hash: -4553058254287566395
 required_rubygems_version: !ruby/object:Gem::Requirement
   none: false
   requirements: