stringup 0.2.0

data/.document

@@ -0,0 +1,5 @@
+README.rdoc
+lib/**/*.rb
+bin/*
+features/**/*.feature
+LICENSE

data/.gitignore

@@ -0,0 +1,4 @@
+.DS_Store
+coverage
+*.gemspec
+pkg

data/LICENSE

@@ -0,0 +1,20 @@
+Copyright (c) 2009 Bruce Williams
+
+Permission is hereby granted, free of charge, to any person obtaining
+a copy of this software and associated documentation files (the
+"Software"), to deal in the Software without restriction, including
+without limitation the rights to use, copy, modify, merge, publish,
+distribute, sublicense, and/or sell copies of the Software, and to
+permit persons to whom the Software is furnished to do so, subject to
+the following conditions:
+
+The above copyright notice and this permission notice shall be
+included in all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
+EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
+MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
+NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
+LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
+OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
+WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

data/README.markdown

@@ -0,0 +1,112 @@
+Stringup
+========
+
+Quick and dirty test harness for executables, testing assertions
+before and after it is run.
+
+Synopsis
+--------
+
+Run stringup with:
+
+    $ stringup execute /path/to/stringup/scenarios/description.rb
+
+The description file consists of exactle one `command` line and any
+number of `scenario` definitions; for example, the following file can
+be used to verify running `touch /tmp/foo` will create a new file:
+
+    command 'touch /tmp/foo'
+
+    scenario :new, "Creates a file" do
+      assert_creates '/tmp/foo'
+    end
+
+If this was in `scenarios.rb`, you could run this with stringup:
+
+    $ stringup execute scenarios.rb --scenario new
+
+If you had named the scenario `default`, the `--scenario` option
+wouldn't have been necessary, ie:
+
+    scenario :default "Creates a file" do
+      assert_creates '/tmp/foo'
+    end
+
+    $ stringup execute scenarios.rb
+
+You'll notice that this should pass the first time and fail on
+subsequent invocations -- because the `assert_creates` fails in the
+event a file exists *before* the command is run.
+
+If you want to see what command and scenarios are defined in a file,
+use `stringup info`, eg:
+
+    $ stringup info scenarios.rb
+
+Commands with arguments
+-----------------------
+
+Let's say you had an executable that reads in a configuration file and
+has some type of side-effect.  You'd like to test running the
+executable against multiple configuration files checking a scenario,
+without having to edit the stringup file every time, changing the path
+to the configuration file.
+
+Luckily the command can be provided in `sprintf` style.  Assuming our
+executable is named `myexec` and you pass the configuration file to it
+via `-c`, the following would work:
+
+    command 'myexec -c %s'
+
+Now, you just pass more options to `stringup execute`:
+
+    $ stringup execute scenarios.rb /path/to/my/configuration.conf
+
+.. and it's just as if you ran:
+
+    $ myexec -c /path/to/my/configuration.conf
+
+Usage help
+----------
+
+See the commandline help documentation:
+
+    $ stringup
+
+For more information on specific commands, you'll want to use `help`,
+eg:
+
+    $ stringup help execute
+
+Assertions
+----------
+
+The list of assertions is very short at this point.
+
+To add an assertion, create a class that inherits from
+`Stringup::Assertion` and implements all the neccessary methods.  See
+`Stringup::Assertion` and the currently defined assertions for
+examples.
+
+Note: If you put your assertions in `~/.stringup/assertions/*.rb`,
+they'll automatically be loaded.  If you create any interesting
+assertions, make sure you let me know!
+
+### assert_creates
+
+Checks to see if a file was created.
+
+You can pass `:file => true` or `:directory => true` to ensure the
+file is a regular file or directory.
+
+### assert_removes
+
+Checks to see if a file was removed.
+
+You can pass `:file => true` or `:directory => true` to ensure the
+file was a regular file or directory before being removed.
+
+Copyright
+---------
+
+Copyright (c) 2010 Bruce Williams. See LICENSE for details.

data/Rakefile

@@ -0,0 +1,53 @@
+require 'rubygems'
+require 'rake'
+
+begin
+  require 'jeweler'
+  Jeweler::Tasks.new do |gem|
+    gem.name = "stringup"
+    gem.summary = %Q{A test harness for executables}
+    gem.description = %Q{An easy-to-use test harness that runs assertions before and after and executable is run}
+    gem.email = "bruce@codefluency.com"
+    gem.homepage = "http://github.com/bruce/stringup"
+    gem.authors = ["Bruce Williams"]
+    gem.add_dependency "thor"
+    gem.add_dependency "shoulda"
+  end
+  Jeweler::GemcutterTasks.new
+rescue LoadError
+  puts "Jeweler (or a dependency) not available. Install it with: sudo gem install jeweler"
+end
+
+require 'rake/testtask'
+Rake::TestTask.new(:test) do |test|
+  test.libs << 'lib' << 'test'
+  test.pattern = 'test/**/test_*.rb'
+  test.verbose = true
+end
+
+begin
+  require 'rcov/rcovtask'
+  Rcov::RcovTask.new do |test|
+    test.libs << 'test'
+    test.pattern = 'test/**/test_*.rb'
+    test.verbose = true
+  end
+rescue LoadError
+  task :rcov do
+    abort "RCov is not available. In order to run rcov, you must: sudo gem install spicycode-rcov"
+  end
+end
+
+task :test => :check_dependencies
+
+task :default => :test
+
+require 'rake/rdoctask'
+Rake::RDocTask.new do |rdoc|
+  version = File.exist?('VERSION') ? File.read('VERSION') : ""
+
+  rdoc.rdoc_dir = 'rdoc'
+  rdoc.title = "stringup #{version}"
+  rdoc.rdoc_files.include('README*')
+  rdoc.rdoc_files.include('lib/**/*.rb')
+end

data/VERSION

@@ -0,0 +1 @@
+0.2.0

data/bin/stringup

@@ -0,0 +1,7 @@
+#!/usr/bin/env ruby
+
+$LOAD_PATH.unshift File.join(File.dirname(__FILE__), '..', 'lib')
+
+require 'stringup'
+
+Stringup::CLI.start

data/examples/puppet/manifest.pp

@@ -0,0 +1,3 @@
+file { "/tmp/foo":
+  ensure => present
+}

data/examples/puppet/run.sh

@@ -0,0 +1,3 @@
+#!/usr/bin/env
+
+stringup execute scenarios.rb manifest.pp -s creation

data/examples/puppet/scenarios.rb

@@ -0,0 +1,5 @@
+command 'puppet %s'
+
+scenario :creation, "Creates a file" do
+  assert_creates '/tmp/foo'
+end

data/examples/touch/run.sh

@@ -0,0 +1,3 @@
+#!/usr/bin/env
+
+stringup execute scenarios.rb -s creation

data/examples/touch/scenarios.rb

@@ -0,0 +1,5 @@
+command 'touch /tmp/foo'
+
+scenario :creation, "Creates a file" do
+  assert_creates '/tmp/foo'
+end

data/lib/stringup/assertion.rb

@@ -0,0 +1,41 @@
+module Stringup
+  class Assertion
+    extend Enumerable
+    
+    def self.each(&block)
+      registry.each(&block)
+    end
+    
+    def self.[](name)
+      registry[name]
+    end
+    
+    def self.registry
+      @registry ||= {}
+    end
+    
+    def self.assertion(name)
+      Assertion.registry[name.to_sym] = self
+    end
+
+    def describe_should_at(event)
+      case event
+      when :before
+        raise NotImplementedError, "Assertion does not describe pre-puppet check"
+      when :after
+        raise NotImplementedError, "Assertion does not describe post-puppet check"
+      else
+        raise ArgumentError, "Unknown event #{event.inspect}"
+      end
+    end
+
+  end
+end
+
+Dir.glob(File.join(File.dirname(__FILE__), 'assertions', '**/*.rb')) do |path|
+  require path
+end
+
+Dir.glob(File.join(ENV['HOME'], '.stringup', 'assertions', '**/*.rb')) do |path|
+  require path
+end

data/lib/stringup/assertions/file_assertion.rb

@@ -0,0 +1,29 @@
+module Stringup
+  class FileAssertion < Assertion
+
+    def initialize(path, options = {})
+      @path = path
+      @options = options
+    end
+    
+    def kind
+      if @options[:directory]
+        :directory
+      elsif @options[:file]
+        :file
+      end
+    end
+
+    def kind_name
+      case kind
+      when :file
+        'a regular file'
+      when :directory
+        'a directory'
+      else
+        'a file'
+      end
+    end
+
+  end
+end

data/lib/stringup/assertions/file_creates_assertion.rb

@@ -0,0 +1,31 @@
+module Stringup
+  class FileCreatesAssertion < FileAssertion
+    assertion :creates
+
+    def before(test_case)
+      test_case.assert !File.exist?(@path), "File already exists at #{@path}"
+    end
+
+    def after(test_case)
+      test_case.assert File.exist?(@path), "File was not created at #{@path}"
+      case kind
+      when :file
+        test_case.assert File.file?(@path), "File created at #{@path} is not a regular file"
+      when :directory
+        test_case.assert File.file?(@path), "File created at #{@path} is not a directory"
+      end
+    end
+
+    def describe_should_at(event)
+      case event
+      when :before
+        "not find #{kind_name} at `#{@path}`"
+      when :after
+        "have created #{kind_name} at `#{@path}`"
+      else
+        super
+      end
+    end
+    
+  end
+end

data/lib/stringup/assertions/file_removes_assertion.rb

@@ -0,0 +1,31 @@
+module Stringup
+  class FileRemovesAssertion < FileAssertion
+    assertion :removes
+
+    def after(test_case)
+      test_case.assert !File.exist?(@path), "File still exists at #{@path}"
+    end
+
+    def before(test_case)
+      test_case.assert File.exist?(@path), "File does not exist at #{@path}"
+      case kind
+      when :file
+        test_case.assert File.file?(@path), "File to remove at #{@path} is not a regular file"
+      when :directory
+        test_case.assert File.file?(@path), "File to remove at #{@path} is not a directory"
+      end
+    end
+
+    def describe_should_at(event)
+      case event
+      when :after
+        "have removed #{kind_name} at `#{@path}`"
+      when :before
+        "find #{kind_name} at `#{@path}` to remove"
+      else
+        super
+      end
+    end
+    
+  end
+end

data/lib/stringup/cli.rb

@@ -0,0 +1,50 @@
+begin
+  require 'thor'
+rescue LoadError
+  abort "Requires 'thor'"
+end
+
+module Stringup
+  class CLI < Thor
+
+    desc "info FILE", "Display defined command and scenarios in FILE"
+    def info(path)
+      script = path_to_script(path)
+      puts "FILE\n\n  #{path}\n\n"
+      puts "COMMAND\n\n  #{script.command}\n\n"
+      puts "SCENARIOS\n\n"
+      script.scenarios.sort_by { |k, v| k.to_s }.each do |_, scenario|
+        puts "  #{scenario.name}: #{scenario.description}"
+        [:before, :after].each do |event|
+          puts "    #{event.to_s.upcase}"
+          scenario.assertions.each do |assertion|
+            puts "      should #{assertion.describe_should_at(event)}"
+          end
+        end
+      end
+    end
+    
+    method_option :scenario, :aliases => '-s', :description => "Scenario to run", :default => 'default'
+    desc "execute FILE [ARGS_FOR_COMMAND]", "Execute a scenario in FILE"
+    def execute(path, *args)
+      script = path_to_script(path)
+      scenario = script[options[:scenario]]
+      unless scenario
+        abort "Could not find scenario: #{options[:scenario]}"
+      end
+      Runner.new(script, scenario, *args).run
+    end
+
+    no_tasks do
+      def path_to_script(path)
+        unless File.exist?(path)
+          abort "No stringup file found at #{path}"
+        end
+        script = Script.evaluate_file(path)
+        script.validate!
+        script
+      end
+    end
+    
+  end
+end

data/lib/stringup/runner.rb

@@ -0,0 +1,87 @@
+require 'open3'
+
+begin
+  require 'shoulda'
+rescue LoadError
+  abort "Requires 'shoulda'"
+end
+
+begin
+  require 'test/unit'
+rescue LoadError
+  abort "Requires 'test/unit'.  On Ruby 1.9 you may need to install the 'test-unit' gem."
+end
+
+require 'test/unit/ui/console/testrunner'
+
+module Stringup
+  class Runner
+    
+    attr_reader :script, :scenario
+    def initialize(script, scenario, *args)
+      @script = script
+      @scenario = scenario
+      @args = args
+      @log = ''
+    end
+    
+    def run
+      Test::Unit.run = false
+      suite = Test::Unit::TestSuite.new("#{scenario.description} for `#{command}`")
+      suite << test(:before).suite
+      suite << test(:after).suite
+      Test::Unit::UI::Console::TestRunner.run(suite)
+      output_log
+    end
+
+    def output_log
+      if @log.empty?
+        puts "NO OUTPUT FROM `#{command}`"
+      else
+        line = "\nOUTPUT FROM `#{command}`"
+        puts line, ('=' * line.size)
+        puts @log
+      end
+    end
+
+    def run_command
+      Open3.popen3(command) do |stdin, stdout, stderr|
+        stdin.close
+        @log << stdout.read
+        @log << stderr.read
+      end
+      true
+    end
+
+    def test(event)
+      klass = Class.new(Test::Unit::TestCase) do
+        class << self; attr_accessor :stringup, :name, :event; end
+      end
+      klass.name = "Stringup::Test::Order#{event == :after ? 1 : 0}::#{event.to_s.capitalize}Puppet"
+      klass.stringup = self
+      klass.event = event
+      klass.context "#{event} `#{command}`" do
+        if parent.event == :after
+          setup do
+            @ran_puppet ||= self.class.stringup.run_command
+          end
+        end
+        parent.stringup.scenario.assertions.each do |assertion|
+          should assertion.describe_should_at(event) do
+            assertion.__send__(event, self)
+          end
+        end
+      end
+      klass
+    end
+
+    private
+
+    def command
+      @command ||= @script.command % @args
+    rescue ArgumentError
+      abort "You provided the wrong number of arguments for command: #{@script.command}"
+    end
+
+  end
+end

data/lib/stringup/scenario.rb

@@ -0,0 +1,24 @@
+module Stringup
+  class Scenario
+
+    attr_reader :name, :description
+    def initialize(name, description = name.to_s.capitalize, &block)
+      @name = name
+      @description = description
+      instance_eval(&block)
+    end
+
+    def assertions
+      @assertions ||= []
+    end
+
+    Assertion.each do |name, klass|
+      class_eval %{
+        def assert_#{name}(*args, &block)
+          assertions << Assertion[:#{name}].new(*args, &block)
+        end
+      }
+    end
+
+  end
+end

data/lib/stringup/script.rb

@@ -0,0 +1,52 @@
+module Stringup
+  class Script
+
+    attr_accessor :command
+
+    def self.evaluate_file(path)
+      evaluate(File.read(path), path)
+    end
+
+    def self.evaluate(text, path)
+      script = new
+      Builder.new(script).instance_eval(text, path, 1)
+      script
+    end
+
+    def <<(scenario)
+      scenarios[scenario.name.to_sym] = scenario
+    end
+
+    def scenarios
+      @scenarios ||= {}
+    end
+
+    def [](name)
+      scenarios[name.to_sym]
+    end
+
+    def validate!
+      unless @command
+        abort "ERROR: The command was not set.\n\nExample:\n\n  command 'cat %s'"
+      end
+    end
+
+    class Builder
+
+      def initialize(script, &block)
+        @script = script
+        instance_eval(&block) if block_given?
+      end
+      
+      def scenario(name, description = name.to_s, &block)
+        scenario = ::Stringup::Scenario.new(name, description, &block)
+        @script << scenario
+      end
+      def command(line)
+        @script.command = line
+      end
+
+    end
+
+  end
+end   

data/lib/stringup.rb

@@ -0,0 +1,9 @@
+module Stringup
+  autoload :Scenario,      'stringup/scenario'
+  autoload :Script,        'stringup/script'
+  autoload :CLI,           'stringup/cli'
+  autoload :DSL,           'stringup/dsl'
+  autoload :Assertion,     'stringup/assertion'
+  autoload :FileAssertion, 'stringup/assertions/file_assertion'
+  autoload :Runner,        'stringup/runner'
+end

data/test/helper.rb

@@ -0,0 +1,10 @@
+require 'rubygems'
+require 'test/unit'
+require 'shoulda'
+
+$LOAD_PATH.unshift(File.join(File.dirname(__FILE__), '..', 'lib'))
+$LOAD_PATH.unshift(File.dirname(__FILE__))
+require 'stringup'
+
+class Test::Unit::TestCase
+end

data/test/test_stringup.rb

@@ -0,0 +1,7 @@
+require 'helper'
+
+class TestStringup < Test::Unit::TestCase
+  should "probably rename this file and start testing for real" do
+    flunk "hey buddy, you should probably rename this file and start testing for real"
+  end
+end

metadata

@@ -0,0 +1,111 @@
+--- !ruby/object:Gem::Specification 
+name: stringup
+version: !ruby/object:Gem::Version 
+  prerelease: false
+  segments: 
+  - 0
+  - 2
+  - 0
+  version: 0.2.0
+platform: ruby
+authors: 
+- Bruce Williams
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2010-04-08 00:00:00 -07:00
+default_executable: stringup
+dependencies: 
+- !ruby/object:Gem::Dependency 
+  name: thor
+  prerelease: false
+  requirement: &id001 !ruby/object:Gem::Requirement 
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        segments: 
+        - 0
+        version: "0"
+  type: :runtime
+  version_requirements: *id001
+- !ruby/object:Gem::Dependency 
+  name: shoulda
+  prerelease: false
+  requirement: &id002 !ruby/object:Gem::Requirement 
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        segments: 
+        - 0
+        version: "0"
+  type: :runtime
+  version_requirements: *id002
+description: An easy-to-use test harness that runs assertions before and after and executable is run
+email: bruce@codefluency.com
+executables: 
+- stringup
+extensions: []
+
+extra_rdoc_files: 
+- LICENSE
+- README.markdown
+files: 
+- .document
+- .gitignore
+- LICENSE
+- README.markdown
+- Rakefile
+- VERSION
+- bin/stringup
+- examples/puppet/manifest.pp
+- examples/puppet/run.sh
+- examples/puppet/scenarios.rb
+- examples/touch/run.sh
+- examples/touch/scenarios.rb
+- lib/stringup.rb
+- lib/stringup/assertion.rb
+- lib/stringup/assertions/file_assertion.rb
+- lib/stringup/assertions/file_creates_assertion.rb
+- lib/stringup/assertions/file_removes_assertion.rb
+- lib/stringup/cli.rb
+- lib/stringup/runner.rb
+- lib/stringup/scenario.rb
+- lib/stringup/script.rb
+- test/helper.rb
+- test/test_stringup.rb
+has_rdoc: true
+homepage: http://github.com/bruce/stringup
+licenses: []
+
+post_install_message: 
+rdoc_options: 
+- --charset=UTF-8
+require_paths: 
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement 
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      segments: 
+      - 0
+      version: "0"
+required_rubygems_version: !ruby/object:Gem::Requirement 
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      segments: 
+      - 0
+      version: "0"
+requirements: []
+
+rubyforge_project: 
+rubygems_version: 1.3.6
+signing_key: 
+specification_version: 3
+summary: A test harness for executables
+test_files: 
+- test/helper.rb
+- test/test_stringup.rb
+- examples/puppet/scenarios.rb
+- examples/touch/scenarios.rb