purobu 0.0.1

data/.gitignore

@@ -0,0 +1,17 @@
+*.gem
+*.rbc
+.bundle
+.config
+.yardoc
+Gemfile.lock
+InstalledFiles
+_yardoc
+coverage
+doc/
+lib/bundler/man
+pkg
+rdoc
+spec/reports
+test/tmp
+test/version_tmp
+tmp

data/Gemfile

@@ -0,0 +1,4 @@
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in purobu.gemspec
+gemspec

data/LICENSE

@@ -0,0 +1,22 @@
+Copyright (c) 2012 Harold Giménez
+
+MIT License
+
+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.md

@@ -0,0 +1,125 @@
+# Purobu
+
+Black-box integration test framework for components on the Heroku platform.
+
+## Installation
+
+Install the gem
+
+    $ gem install purobu
+
+## Usage
+
+Tests [go through four phases](http://xunitpatterns.com/Four%20Phase%20Test.html):
+
+* _Setup_ the context for the test by creating test fixtures that are required
+  for the *System Under Test* (SUT) to expose the desired behavior.
+* _Exercise_ the SUT
+* _Verify_ the result to determine if the intended behavior was met.
+* _Teardown_ the state of the system by removing all fixtures and test
+  artifacts so that there are no state spills or interdependencies across
+tests.
+
+Purobu recognizes and embraces this by defining these phases in implicit blocks
+within your tests.
+
+For example:
+
+```ruby
+# test_can_create_crane_database.rb
+test 'can create crane database' do
+  setup do
+    heroku "apps:create --name some-app"
+  end
+
+  exercise do
+    heroku "addons:add heroku-postgresql:crane some-app"
+  end
+
+  verify do
+    addons = heroku "addons --app some-app"
+    addons.include?("heroku-postgresql:crane") #return true or false
+  end
+
+  teardown do
+    heroku "apps:remove some-app"
+  end
+end
+```
+
+Then run it with 4 concurrent jobs:
+
+    $ purobu -j 4
+
+Purobu will load any files that match `/test_.*\.rb/` recursively. An
+alternative is to specify files to run:
+
+    $ purobu -j 4 -f test_one.rb,test_two.rb
+
+For more command line switches, try `purobu -h`
+
+## Global setup
+
+It can be useful to have global setups, for example, to create an app to run a
+bunch of tests against.
+
+You can create a ruby file called purobu_config.rb to set up a global context.
+The global context will run once before the entire suite. Be sure to create a
+global teardown as well:
+
+```ruby
+# purobu_config.rb
+Purobu::Configuration.run do |config|
+  config.global_setup do
+    heroku "apps:create harolds-test-app"
+  end
+  config.global_teardown do
+    heroku "apps:destroy harolds-test-app --confirm harolds-test-app"
+  end
+end
+```
+
+## Interacting with heroku
+
+Access to heroku is facilitated in two ways:
+
+1. The `heroku` helper is a wrapper around the latest version of the heroku
+   CLI. You give it a string, and it shells out to execute the given command.
+For example:
+
+```ruby
+heroku "addons:add heroku-postgresql:dev"
+```
+
+2. The `heroku_api` helper exposes the [heroku api
+   client](https://github.com/heroku/heroku.rb) for more convenient retreival
+of information on heroku such as an app's config vars.
+
+*Note*: To use it, set the HEROKU_API_KEY environment variable or set it in a
+`Purobu::Configuration.run`
+
+For example:
+
+```ruby
+heroku_api.get_config_vars('some-app').body
+  # {"HEROKU_POSTGRESQL_PURPLE_URL"=>"postgres://user:pass@host:5732/database"}
+heroku_api.get_addons('some-app').body
+  # [{"slug"=>"crane", "selective"=>false,
+      "configured"=>true,
+      "url"=>nil,
+      "state"=>"public",
+      "group_description"=>"Heroku Postgresql",
+      "consumes_dyno_hours"=>false,
+      "price"=>{"cents"=>0, "unit"=>"month"},
+      "attachment_name"=>"HEROKU_POSTGRESQL_TEAL",
+      "plan_description"=>"Crane",
+      "name"=>"heroku-postgresql:crane",
+      "beta"=>false,
+      "attachable"=>false,
+      "description"=>"Heroku Postgres Crane",
+      "terms_of_service"=>false}]
+```
+
+## Meta
+
+purobu was written by Harold Giménez and is Copyright 2012 Heroku

data/Rakefile

@@ -0,0 +1,2 @@
+#!/usr/bin/env rake
+require "bundler/gem_tasks"

data/bin/purobu

@@ -0,0 +1,33 @@
+#!/usr/bin/env ruby
+
+require "optparse"
+
+options = {}
+parser = OptionParser.new do |opts|
+  opts.banner = "usage: purobu [--file file1,file2,...]"
+  opts.on("-f", "--files f", Array, "File or files to load and run") do |fs|
+    options[:files] = fs
+  end
+  opts.on("-j", "--jobs j", Integer, "Number of jobs") do |j|
+    options[:thread_count] = j
+  end
+  opts.on("-v", "--verbose", "Run verbosely") do |v|
+    options[:verbose] = v
+  end
+  opts.on("-h", "--help", "Display this help") { abort(opts.to_s) }
+end
+parser.parse!
+
+$:.unshift File.expand_path(File.join('..',  'lib'), File.dirname(__FILE__))
+
+require 'purobu'
+
+load './purobu_config.rb' if File.exists?('./purobu_config.rb')
+
+Purobu::Configuration.run do |conf|
+  conf.verbose      = options[:verbose] || false
+  conf.thread_count = options[:thread_count]
+  conf.files        = options[:files]
+end
+
+Purobu::DSL.new(files: Purobu::Configuration.files).run

data/lib/purobu/configuration.rb

@@ -0,0 +1,57 @@
+require 'singleton'
+module Purobu
+  class Configuration
+    include Singleton
+
+    # Run verbosely
+    attr_accessor :verbose
+
+    # Concurrency
+    attr_accessor :thread_count
+
+    # Which test files to run
+    attr_accessor :files
+
+    # Global teardown to run after the entire suite
+    attr_accessor :global_teardown
+
+    # Heroku api key to be used by the heroku-api client
+    attr_accessor :heroku_api_key
+
+    def self.run(&block)
+      self.instance.heroku_api_key = ENV['HEROKU_API_KEY']
+
+      yield self.instance
+    end
+
+    def global_setup(&block)
+      if block_given?
+        @global_setup = block
+      else
+        @global_setup
+      end
+    end
+
+    def global_teardown(&block)
+      if block_given?
+        @global_teardown = block
+      else
+        @global_teardown
+      end
+    end
+
+    class << self
+      def method_missing(method)
+        if self.instance.respond_to?(method)
+          self.instance.send(method)
+        else
+          super
+        end
+      end
+
+      def respond_to?(method)
+        self.instance.respond_to?(method) || super
+      end
+    end
+  end
+end

data/lib/purobu/dsl.rb

@@ -0,0 +1,26 @@
+module Purobu
+  class DSL
+    attr_reader :runner, :files
+    def initialize(opts = {})
+      @runner = Runner.new
+      @files  = opts[:files] || Dir['**/test_*.rb']
+    end
+
+    def test(name = nil, &block)
+      runner.tests.push( Test.new(name).tap { |t| t.instance_eval(&block) } )
+    end
+
+    def tests
+      runner.tests
+    end
+
+    def run
+      load_tests
+      runner.run
+    end
+
+    def load_tests
+      files.each { |f| instance_eval(File.read(f)) }
+    end
+  end
+end

data/lib/purobu/heroku.rb

@@ -0,0 +1,25 @@
+require 'fileutils'
+module Purobu
+  class Heroku
+    class FailedCommand < Exception; end
+
+    def self.run(command)
+      result = nil
+      Purobu.log(heroku: true, command: command) do
+        result = `#{heroku_path} #{command}`
+      end
+      raise FailedCommand.new(result) unless $?.exitstatus.zero?
+      result
+    end
+
+    def self.heroku_path
+      @heroku_path ||= begin
+                         FileUtils.cd File.expand_path(File.join("..", ".."), File.dirname(__FILE__)) do
+                           eval(File.read('purobu.gemspec'))
+                         end
+                         Gem.bin_path("heroku", "heroku")
+                       end
+    end
+
+  end
+end

data/lib/purobu/heroku_helpers.rb

@@ -0,0 +1,12 @@
+require 'heroku-api'
+module Purobu
+  module HerokuHelpers
+    def heroku(*args)
+      ::Purobu::Heroku.run(*args)
+    end
+
+    def heroku_api
+      ::Heroku::API.new(api_key: Configuration.heroku_api_key)
+    end
+  end
+end

data/lib/purobu/log.rb

@@ -0,0 +1,18 @@
+require 'scrolls'
+module Purobu
+  def self.log(data, &block)
+    if Configuration.verbose
+      Scrolls.log(data, &block)
+    else
+      yield
+    end
+  end
+
+  def self.log_context(data, &block)
+    if Configuration.verbose
+      Scrolls.context(data, &block)
+    else
+      yield
+    end
+  end
+end

data/lib/purobu/reporter.rb

@@ -0,0 +1,25 @@
+module Purobu
+  class Reporter
+    attr_reader :test
+    def initialize(test)
+      @test = test
+    end
+
+    def report_pass
+      puts "#{green("PASS")} #{@test.name}"
+    end
+
+    def report_fail
+      puts "#{red("FAIL")} #{@test.name}"
+    end
+
+  private
+    def green(string)
+      "[\e[32m#{string}\e[0m]"
+    end
+
+    def red(string)
+      "[\e[31m#{string}\e[0m]"
+    end
+  end
+end

data/lib/purobu/runner.rb

@@ -0,0 +1,49 @@
+require 'thread'
+module Purobu
+  class Runner
+    include HerokuHelpers
+
+    attr_reader :tests, :thread_count
+
+    def initialize
+      @tests        = Queue.new
+      @thread_count = Configuration.thread_count || 1
+    end
+
+    def run
+      Purobu.log(global_setup: true) do
+        run_global_setup
+      end
+      pool = Array.new(thread_count) do
+        Thread.new do
+          loop do
+            begin
+              test = tests.pop(true)
+              test.run
+              test.report_result
+            rescue
+              Thread.exit
+            end
+          end
+        end
+      end
+      pool.each(&:join)
+      Purobu.log(global_teardown: true) do
+        run_global_teardown
+      end
+    end
+
+  private
+    def run_global_setup
+      if setup = Configuration.global_setup
+        instance_eval &setup
+      end
+    end
+
+    def run_global_teardown
+      if teardown = Configuration.global_teardown
+        instance_eval &teardown
+      end
+    end
+  end
+end

data/lib/purobu/test.rb

@@ -0,0 +1,77 @@
+require 'heroku'
+module Purobu
+  class Test
+    include HerokuHelpers
+
+    attr_reader :setups, :teardowns, :name
+    attr_writer :exercise, :verification
+
+    def initialize(name = nil)
+      @setups       = []
+      @exercise     = -> {}
+      @verification = -> {}
+      @teardowns    = []
+      @fail         = true
+      @name         = name
+    end
+
+    def run
+      begin
+        Purobu.log_context(test: name) do
+          Purobu.log(setups: true) do
+            @setups.each { |s| s.call }
+          end
+          Purobu.log(exercise: true) do
+            @exercise.call
+          end
+          Purobu.log(verification: true) do
+            @fail = !@verification.call
+          end
+          Purobu.log(teardown: true) do
+            @teardowns.each { |s| s.call }
+          end
+        end
+      rescue => e
+        @fail = true
+      end
+      pass?
+    end
+
+    def pass?
+      !@fail
+    end
+
+    def setup(&block)
+      @setups << block
+    end
+
+    def exercise(&block)
+      @exercise = block
+    end
+
+    def verify(&block)
+      @verification = block
+    end
+
+    def teardown(&block)
+      @teardowns << block
+    end
+
+    def reporter
+      @reporter ||= Reporter.new(self)
+    end
+
+    def reporter=(new_reporter)
+      @reporter = new_reporter
+    end
+
+    def report_result
+      if pass?
+        reporter.report_pass
+      else
+        reporter.report_fail
+      end
+    end
+
+  end
+end

data/lib/purobu/version.rb

@@ -0,0 +1,3 @@
+module Purobu
+  VERSION = "0.0.1"
+end

data/lib/purobu.rb

@@ -0,0 +1,9 @@
+require "purobu/version"
+require "purobu/log"
+require "purobu/configuration"
+require "purobu/heroku_helpers"
+require "purobu/test"
+require "purobu/runner"
+require "purobu/dsl"
+require "purobu/heroku"
+require "purobu/reporter"

data/purobu.gemspec

@@ -0,0 +1,23 @@
+# -*- encoding: utf-8 -*-
+require File.expand_path('../lib/purobu/version', __FILE__)
+
+Gem::Specification.new do |gem|
+  gem.authors       = ["Harold Giménez"]
+  gem.email         = ["harold.gimenez@gmail.com"]
+  gem.description   = %q{ Probe your production or staging environment for behavior correctness }
+  gem.summary       = %q{ Black-box integration test framework for components on the Heroku platform. }
+  gem.homepage      = "http://practiceovertheory.com"
+
+  gem.files         = `git ls-files`.split($\)
+  gem.executables   = gem.files.grep(%r{^bin/}).map{ |f| File.basename(f) }
+  gem.test_files    = gem.files.grep(%r{^(test|spec|features)/})
+  gem.name          = "purobu"
+  gem.require_paths = ["lib"]
+  gem.version       = Purobu::VERSION
+
+  gem.add_dependency "heroku", "2.28.2"
+  gem.add_dependency "heroku-api"
+  gem.add_dependency "scrolls", "0.2.1"
+  gem.add_development_dependency "rspec"
+  gem.add_development_dependency "fakefs"
+end

data/spec/purobu/dsl_spec.rb

@@ -0,0 +1,42 @@
+require 'purobu'
+require 'fakefs/safe'
+require 'fakefs/spec_helpers'
+
+describe Purobu::DSL do
+  let(:dsl) { Purobu::DSL.new }
+  it 'adds tests to the runner' do
+    dsl.test do
+      verify { true }
+    end
+
+    dsl.tests.size.should == 1
+    test = dsl.tests.pop
+    test.should be_a Purobu::Test
+  end
+
+  it 'supports adding names to tests' do
+    dsl.test 'a name' do
+      verify { true }
+    end
+  end
+end
+
+describe Purobu::DSL, 'loading tests files' do
+  include FakeFS::SpecHelpers
+
+  before { FakeFS.activate! }
+  after  { FakeFS.deactivate! }
+
+  it 'loads tests' do
+    2.times do |i|
+      File.open("test_#{i}.rb", 'w') do |file|
+        file << "test { verify { true } }"
+      end
+    end
+
+    dsl = Purobu::DSL.new
+    dsl.load_tests
+
+    dsl.tests.size.should == 2
+  end
+end

data/spec/purobu/runner_spec.rb

@@ -0,0 +1,39 @@
+require 'purobu'
+
+describe Purobu::Runner, 'running tests' do
+  let(:runner) { Purobu::Runner.new }
+  it 'invokes each test and reports its result' do
+    test = Purobu::Test.new
+
+    test.should_receive(:run).once
+    test.should_receive(:report_result).once
+
+    runner.tests.push(test)
+
+    runner.run
+  end
+
+  it 'invokes the global setup before running any test' do
+    setup = nil
+    Purobu::Configuration.run do |config|
+      config.global_setup do
+        setup = :global_setup
+      end
+    end
+    setup.should be_nil
+    runner.run
+    setup.should == :global_setup
+  end
+
+  it 'invokes the global teardown before running any test' do
+    teardown = nil
+    Purobu::Configuration.run do |config|
+      config.global_teardown do
+        teardown = :global_teardown
+      end
+    end
+    teardown.should be_nil
+    runner.run
+    teardown.should == :global_teardown
+  end
+end

data/spec/purobu/test_spec.rb

@@ -0,0 +1,100 @@
+require 'purobu'
+
+describe Purobu::Test, '#run' do
+  it 'sets up' do
+    test = Purobu::Test.new
+    test.setup { throw :setup }
+    -> { test.run }.should throw_symbol :setup
+  end
+
+  it 'exercises' do
+    test = Purobu::Test.new
+    test.exercise { throw :exercise }
+
+    -> { test.run }.should throw_symbol :exercise
+  end
+
+  it 'verifies' do
+    test = Purobu::Test.new
+    test.verify { throw :validation }
+
+    -> { test.run }.should throw_symbol :validation
+  end
+
+  it 'tears down' do
+    test = Purobu::Test.new
+    test.teardown { throw :teardown }
+
+    -> { test.run }.should throw_symbol :teardown
+  end
+end
+
+describe Purobu::Test, 'pass/fail' do
+  it 'is failing be default' do
+    test = Purobu::Test.new
+    test.pass?.should be_false
+  end
+  it 'passes if the validation returns true' do
+    test = Purobu::Test.new
+    test.verification = -> { true }
+
+    test.run.should be_true
+    test.pass?.should be_true
+  end
+
+  it 'fails when validation returns false' do
+    test = Purobu::Test.new
+    test.verification = -> { false }
+
+    test.run.should be_false
+    test.pass?.should be_false
+  end
+
+  it 'fails when anything raises' do
+    test = Purobu::Test.new
+    test.verification = -> { raise "waa" }
+
+    test.run.should be_false
+    test.pass?.should be_false
+  end
+end
+
+describe Purobu::Test, '#heroku' do
+  it 'delegates to the heroku run command' do
+    Purobu::Heroku.should_receive(:run).with('addons')
+
+    Purobu::Test.new.heroku 'addons'
+  end
+end
+
+describe Purobu::Test, '#report_result' do
+  it 'reports to the reporter whether it passed or failed' do
+    reporter = double(:reporter)
+    reporter.should_receive(:report_pass).once
+    test = Purobu::Test.new
+    test.reporter = reporter
+
+    test.verify { true }
+    test.run
+
+    test.report_result
+
+
+    reporter.should_receive(:report_fail).once
+    test.verify { false }
+    test.run
+
+    test.report_result
+  end
+end
+
+describe Purobu::Test, '#heroku_api' do
+  it 'exposes the heroku api' do
+    test = Purobu::Test.new
+    heroku_api = double
+    heroku_api.should_receive(:something).once
+    Heroku::API.stub(new: heroku_api)
+
+    test.heroku_api.something
+  end
+end

metadata

@@ -0,0 +1,126 @@
+--- !ruby/object:Gem::Specification
+name: purobu
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+  prerelease: 
+platform: ruby
+authors:
+- Harold Giménez
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2012-06-26 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: heroku
+  requirement: &70132005273080 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - =
+      - !ruby/object:Gem::Version
+        version: 2.28.2
+  type: :runtime
+  prerelease: false
+  version_requirements: *70132005273080
+- !ruby/object:Gem::Dependency
+  name: heroku-api
+  requirement: &70132005172240 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: *70132005172240
+- !ruby/object:Gem::Dependency
+  name: scrolls
+  requirement: &70132005159400 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - =
+      - !ruby/object:Gem::Version
+        version: 0.2.1
+  type: :runtime
+  prerelease: false
+  version_requirements: *70132005159400
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: &70132005150920 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: *70132005150920
+- !ruby/object:Gem::Dependency
+  name: fakefs
+  requirement: &70132005148440 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: *70132005148440
+description: ! ' Probe your production or staging environment for behavior correctness '
+email:
+- harold.gimenez@gmail.com
+executables:
+- purobu
+extensions: []
+extra_rdoc_files: []
+files:
+- .gitignore
+- Gemfile
+- LICENSE
+- README.md
+- Rakefile
+- bin/purobu
+- lib/purobu.rb
+- lib/purobu/configuration.rb
+- lib/purobu/dsl.rb
+- lib/purobu/heroku.rb
+- lib/purobu/heroku_helpers.rb
+- lib/purobu/log.rb
+- lib/purobu/reporter.rb
+- lib/purobu/runner.rb
+- lib/purobu/test.rb
+- lib/purobu/version.rb
+- purobu.gemspec
+- spec/purobu/dsl_spec.rb
+- spec/purobu/reporter_spec.rb
+- spec/purobu/runner_spec.rb
+- spec/purobu/test_spec.rb
+homepage: http://practiceovertheory.com
+licenses: []
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 1.8.10
+signing_key: 
+specification_version: 3
+summary: Black-box integration test framework for components on the Heroku platform.
+test_files:
+- spec/purobu/dsl_spec.rb
+- spec/purobu/reporter_spec.rb
+- spec/purobu/runner_spec.rb
+- spec/purobu/test_spec.rb