linecook 0.6.2 → 1.0.0

data/lib/linecook/test/shell_test.rb

@@ -0,0 +1,176 @@
+require 'linecook/test/regexp_escape'
+require 'linecook/test/command_parser'
+
+module Linecook
+  module Test
+    module ShellTest
+      
+      def setup
+        super
+        @notify_method_name = true
+      end
+
+      # Returns true if the ENV variable 'VERBOSE' is true.  When verbose,
+      # ShellTest prints the expanded commands of sh_test to $stdout.
+      def verbose?
+        verbose = ENV['VERBOSE']
+        verbose && verbose =~ /^true$/i ? true : false
+      end
+      
+      # Sets the specified ENV variables and returns the *current* env.
+      # If replace is true, current ENV variables are replaced; otherwise
+      # the new env variables are simply added to the existing set.
+      def set_env(env={}, replace=false)
+        current_env = {}
+        ENV.each_pair do |key, value|
+          current_env[key] = value
+        end
+
+        ENV.clear if replace
+
+        env.each_pair do |key, value|
+          if value.nil?
+            ENV.delete(key)
+          else
+            ENV[key] = value
+          end
+        end if env
+
+        current_env
+      end
+
+      # Sets the specified ENV variables for the duration of the block.
+      # If replace is true, current ENV variables are replaced; otherwise
+      # the new env variables are simply added to the existing set.
+      #
+      # Returns the block return.
+      def with_env(env={}, replace=false)
+        current_env = nil
+        begin
+          current_env = set_env(env, replace)
+          yield
+        ensure
+          if current_env
+            set_env(current_env, true)
+          end
+        end
+      end
+      
+      def sh(cmd)
+        if @notify_method_name && verbose?
+          @notify_method_name = false
+          puts
+          puts method_name 
+        end
+        
+        start  = Time.now
+        result = `#{cmd}`
+        finish = Time.now
+        
+        if verbose?
+          elapsed = "%.3f" % [finish-start]
+          puts "  (#{elapsed}s) #{cmd}"
+        end
+        
+        result
+      end
+      
+      def assert_script(script, options={})
+        _assert_script outdent(script), options
+      end
+      
+      def _assert_script(script, options={})
+        commands = CommandParser.new(options).parse(script)
+        commands.each do |cmd, output, status|
+          result = sh(cmd)
+          
+          _assert_output_equal(output, result, cmd) if output
+          assert_equal(status, $?.exitstatus, cmd)  if status
+        end
+      end
+      
+      def assert_script_match(script, options={})
+        _assert_script_match outdent(script), options
+      end
+      
+      def _assert_script_match(script, options={})
+        commands = CommandParser.new(options).parse(script)
+        commands.each do |cmd, output, status|
+          result = sh(cmd)
+          
+          _assert_alike(output, result, cmd)       if output
+          assert_equal(status, $?.exitstatus, cmd) if status
+        end
+      end
+      
+      # Asserts whether or not the a and b strings are equal, with a more
+      # readable output than assert_equal for large strings (especially large
+      # strings with significant whitespace).
+      def assert_output_equal(a, b, msg=nil)
+        _assert_output_equal outdent(a), b, msg
+      end
+      
+      def _assert_output_equal(a, b, msg=nil)
+        if a == b
+          assert true
+        else
+          flunk %Q{
+#{msg}
+==================== expected output ====================
+#{whitespace_escape(a)}
+======================== but was ========================
+#{whitespace_escape(b)}
+=========================================================
+}
+        end
+      end
+
+      # Asserts whether or not b is like a (which should be a Regexp), and
+      # provides a more readable output in the case of a failure as compared
+      # with assert_match.
+      #
+      # If a is a string it is turned into a RegexpEscape.
+      def assert_alike(a, b, msg=nil)
+        a = outdent(a) if a.kind_of?(String)
+        _assert_alike a, b, msg
+      end
+      
+      def _assert_alike(a, b, msg=nil)
+        if a.kind_of?(String)
+          a = RegexpEscape.new(a)
+        end
+
+        if b =~ a
+          assert true
+        else
+          flunk %Q{
+#{msg}
+================= expected output like ==================
+#{whitespace_escape(a)}
+======================== but was ========================
+#{whitespace_escape(b)}
+=========================================================
+}
+        end
+      end
+      
+      # helper for stripping indentation off a string
+      def outdent(str)
+        str =~ /\A(?:\s*?\n)( *)(.*)\z/m ? $2.gsub!(/^ {0,#{$1.length}}/, '') : str
+      end
+      
+      # helper for formatting escaping whitespace into readable text
+      def whitespace_escape(str)
+        str.to_s.gsub(/\s/) do |match|
+          case match
+          when "\n" then "\\n\n"
+          when "\t" then "\\t"
+          when "\r" then "\\r"
+          when "\f" then "\\f"
+          else match
+          end
+        end
+      end
+    end
+  end
+end

data/lib/linecook/utils.rb

@@ -1,17 +1,35 @@
+require 'yaml'
+
 module Linecook
   module Utils
     module_function
     
-    def nest_hash
-      Hash.new {|hash, key| hash[key] = nest_hash }
+    def load_config(path)
+      (path ? YAML.load_file(path) : nil) || {}
     end
     
-    def serial_merge(*hashes)
-      attrs = {}
-      while overrides = hashes.shift
-        attrs = deep_merge(attrs, overrides)
+    def arrayify(obj)
+      case obj
+      when nil    then []
+      when String then obj.split(':')
+      else obj
+      end
+    end
+    
+    def hashify(obj)
+      case obj
+      when Hash then obj
+      when nil  then {}
+      when Array
+        hash = {}
+        obj.each {|entry| hash[entry] = entry }
+        hash
+      
+      when String 
+        hashify obj.split(':')
+      
+      else nil
       end
-      attrs
     end
     
     def deep_merge(a, b)

data/lib/linecook/version.rb

@@ -1,8 +1,8 @@
 module Linecook
-  MAJOR = 0
-  MINOR = 6
-  TINY  = 2
-
+  MAJOR = 1
+  MINOR = 0
+  TINY  = 0
+  
   VERSION = "#{MAJOR}.#{MINOR}.#{TINY}"
   WEBSITE = "http://github.com/pinnacol/linecook"
 end

data/templates/Rakefile

@@ -1,14 +1,16 @@
 require 'rake'
+require 'rake/rdoctask'
+require 'rake/gempackagetask'
 
 #
 # Gem tasks
 #
 
-require 'rake/rdoctask'
-require 'rake/gempackagetask'
-
 def gemspec
-  @gemspec ||= eval(File.read('<%= project_name %>.gemspec'), TOPLEVEL_BINDING)
+  @gemspec ||= begin
+    gemspec_path = File.expand_path('../<%= project_name %>.gemspec', __FILE__)
+    eval(File.read(gemspec_path), TOPLEVEL_BINDING)
+  end
 end
 
 Rake::GemPackageTask.new(gemspec) do |pkg|
@@ -72,56 +74,40 @@ end
 # Linecook Helpers
 #
 
-lib_dir     = File.expand_path("../lib", __FILE__)
-helpers_dir = File.expand_path("../helpers", __FILE__)
+package = ENV['PACKAGE']
+force = (ENV['FORCE'] == 'true')
 
-sources = {}
-helpers = []
-
-Dir.glob("#{helpers_dir}/**/*").each do |source|
-  next if File.directory?(source)
-  (sources[File.dirname(source)] ||= []) << source
+desc "build helpers and packages"
+task :build => :bundle do
+  sh "bundle exec linecook build #{force ? '--force ' : nil}#{package}"
 end
 
-sources.each_pair do |dir, sources|
-  name = dir[(helpers_dir.length + 1)..-1]
-  target = File.join(lib_dir, 'linebook', "#{name}.rb")
-  
-  file target => sources + [dir] do
-    system "bundle exec linecook helper '#{name}' --force"
-  end
-  
-  helpers << target
+desc "run packages"
+task :run => :build do
+  sh "bundle exec linecook run #{package}"
 end
 
-desc "generate helpers"
-task :helpers => helpers + [:bundle]
-
-#
-# Linecook Scripts
-#
+desc "start each vm at CURRENT"
+task :start => :bundle do
+  sh 'bundle exec linecook start --socket --snapshot CURRENT'
+end
 
-scripts      = Dir.glob("scripts/*.yml")
-dependencies = Dir.glob('{attributes,files,recipes,templates}/**/*')
+desc "snapshot each vm to a new CURRENT"
+task :snapshot => :bundle do
+  sh 'bundle exec linecook snapshot CURRENT'
+end
 
-scripts.each do |source|
-  target = source.chomp('.yml')
-  name   = File.basename(target)
-  
-  namespace :scripts do
-    file target => dependencies + [source] + helpers do
-      sh "bundle exec linecook package '#{source}' '#{target}' --force"
-    end
-    
-    desc "generate the script: #{name}"
-    task name => target
-  end
-  
-  task :scripts => target
+desc "reset each vm to BASE"
+task :reset_base => :bundle do
+  sh 'bundle exec linecook snapshot --reset BASE'
+  sh 'bundle exec linecook snapshot CURRENT'
+  sh 'bundle exec linecook start --socket --snapshot CURRENT'
 end
 
-desc "generate scripts"
-task :scripts
+desc "stop each vm"
+task :stop => :bundle do
+  sh 'bundle exec linecook stop'
+end
 
 #
 # Test tasks
@@ -130,9 +116,10 @@ task :scripts
 desc 'Default: Run tests.'
 task :default => :test
 
-desc 'Run the tests'
-task :test => :helpers do
+desc 'Run the tests assuming each vm is setup'
+task :quicktest => :build do
   tests = Dir.glob('test/**/*_test.rb')
+  tests.delete_if {|test| test =~ /_test\/test_/ }
   
   if ENV['RCOV'] == 'true'
     FileUtils.rm_rf File.expand_path('../coverage', __FILE__)
@@ -142,6 +129,16 @@ task :test => :helpers do
   end
 end
 
+desc 'Run the tests'
+task :test do
+  begin
+    Rake::Task["start"].invoke
+    Rake::Task["quicktest"].invoke
+  ensure
+    Rake::Task["stop"].execute(nil)
+  end
+end
+
 desc 'Run rcov'
 task :rcov do
   ENV['RCOV'] = 'true'

data/templates/_gitignore

@@ -2,4 +2,4 @@
 .bundle
 *.gem
 /rdoc
-vbox/log
+vm

data/templates/attributes/project_name.rb

@@ -1,4 +1,4 @@
-# Define default recipe attributes here and include in a recipe using
-# 'attributes "filename"'. Script attributes override these values.
-attrs['<%= project_name %>']['letters'] = ['a', 'b', 'c']
-attrs['<%= project_name %>']['numbers'] = [1, 2, 3]
+# Define default recipe attributes here.
+# (note string keys are usually better than symbols)
+attrs['<%= project_name %>']['year'] = Time.now.year
+attrs['<%= project_name %>']['resolutions'] = []

data/templates/config/ssh

@@ -0,0 +1,15 @@
+# Declare hosts for packages - the vm name can be specified in a special
+# comment following the Host declaration (defaults to the host).
+Host abox   # [abox]
+Port 2220
+
+# Define global configs here.  By default tests run vs this default host.
+Host *
+HostName localhost
+User linecook
+Port 2220
+UserKnownHostsFile /dev/null
+StrictHostKeyChecking no
+IdentitiesOnly yes
+ControlMaster auto
+ControlPath /tmp/socket-%r@%h:%p

data/templates/files/help.txt

@@ -0,0 +1 @@
+* https://github.com/pinnacol/linecook

data/templates/helpers/project_name/assert_content_equal.erb

@@ -0,0 +1,15 @@
+Asserts the content of the file is as expected. Prints a diff and exits 1 if
+the content is not as expected.
+(expected, file)
+--
+expected='<%= '<' %>%= expected.rstrip %<%= '>' %>'
+actual=$(cat <%= '<' %>%= file %<%= '>' %>)
+
+echo "Check file: <%= '<' %>%= file %<%= '>' %>"
+if [ "$actual" != "$expected" ]
+then
+  echo "[$0] unequal output: <%= '<' %>%= file %<%= '>' %>" >&2
+  diff <(cat <<< "$expected") <(cat <<< "$actual") >&2
+  exit 1
+fi
+

data/templates/helpers/project_name/create_dir.erb

@@ -0,0 +1,9 @@
+Creates a directory and parents as needed.
+(dir)
+--
+if ! [ -d <%= '<' %>%= dir %<%= '>' %> ]
+then
+  echo "Create dir: <%= '<' %>%= dir %<%= '>' %>"
+  mkdir -p <%= '<' %>%= dir %<%= '>' %>
+fi
+

data/templates/helpers/project_name/create_file.erb

@@ -0,0 +1,8 @@
+Creates a file with the specified content.
+(file, content)
+--
+<%= '<' %>% create_dir File.dirname(file) %<%= '>' %>
+
+echo "Create file: <%= '<' %>%= file %<%= '>' %>"
+echo -n '<%= '<' %>%= content %<%= '>' %>' > <%= '<' %>%= file %<%= '>' %>
+

data/templates/helpers/project_name/install_file.erb

@@ -0,0 +1,8 @@
+Installs a file.
+(source, target)
+--
+<%= '<' %>% create_dir File.dirname(target) %<%= '>' %>
+
+echo "Install file: <%= '<' %>%= target %<%= '>' %>"
+cp <%= '<' %>%= source %<%= '>' %> <%= '<' %>%= target %<%= '>' %>
+