testengineer 0.1.2

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 test-engineer.gemspec
+gemspec

data/LICENSE

@@ -0,0 +1,22 @@
+Copyright (c) 2012 Lookout, Inc.
+
+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,56 @@
+# TestEngineer
+
+
+TestEngineer is a simple gem which adds some code around
+[foreman](https://github.com/ddollar/foreman) for integration testing.
+
+Currently it allows you to bring up an entire stack, based on what is defined
+in the Foreman `Procfile`, for the duration of a test case.
+
+TestEngineer also allows you to arbitrarily shut off processes by name during
+the runtime of a test case.
+
+
+
+## With Cucumber
+
+There is an `Around` hook that you can include with
+`require 'testengineer/cucumber'`. This will wrap any Scenario tagged with the
+`@testengineer` tag.
+
+Imagine a `Procfile` such as:
+
+    web: ruby -r thin app.rb
+    db: ./script/run-mongodb
+    cache: memcached
+
+A sample Cucumber feature might look like:
+
+
+    @testengineer
+    Feature: Log in to My Site
+      In order to facilitate meaningful relationships between users
+      As a web visitor
+      I should be able to log into my account on My Site
+
+    Scenario: Log in
+      Given an account named "octocat"
+      When I log in to My Site
+      Then I should be delighted with my fabulous profile
+
+    Scenario: Log in when the site is degraded
+      Given an account named "octocat"
+      And the database is offline
+      When I log in to My Site
+      Then I should see a nice friendly fail whale.
+
+
+For each scenario, TestEngineer will bring the entire stack (web, db, cache) up
+and down. In the second scenario, I would have defined the step for `And the
+database is offline` as:
+
+    Given /^the database is offline$/ do
+      TestEngineer.stop_process('db')
+    end
+
+

data/Rakefile

@@ -0,0 +1,10 @@
+#!/usr/bin/env rake
+require "bundler/gem_tasks"
+require 'rspec/core/rake_task'
+
+
+RSpec::Core::RakeTask.new('test') do |t|
+  t.rspec_opts = '-c --fail-fast'
+end
+
+task :default => [:test, :build]

data/lib/testengineer.rb

@@ -0,0 +1,70 @@
+require "testengineer/version"
+require 'timeout'
+require 'foreman/engine'
+
+module TestEngineer
+  def self.foreman
+    $foreman
+  end
+
+  def self.wait_for_socket(host='localhost', port=nil)
+    return if port.nil?
+
+    puts "Waiting for server at #{host}:#{port} to come online.."
+    running = false
+    while !running do
+      sleep 0.2
+      begin
+        TCPSocket.new(host, port)
+      rescue Errno::ECONNREFUSED => e
+        next
+      end
+      running = true
+    end
+  end
+
+  def self.stop_process(name)
+    if foreman.nil?
+      puts "Foreman hasn't been started, whoops"
+      return
+    end
+
+    if name.nil?
+      raise Exception, 'TestEngineer#stop_process cannot handle a nil process name'
+    end
+    procs = foreman.send(:running_processes)
+    procs.each do |pid, p|
+      parts = p.name.split('.')
+      unless parts.first.start_with? name
+        next
+      end
+      p.kill 'SIGTERM'
+      ::Timeout.timeout(5) do
+        begin
+          Process.waitpid(pid)
+        rescue Errno::ECHILD
+        end
+      end
+    end
+    # If we don't set @terminating to false, then the eventual invocation of
+    # #terminate_gracefully will return immediately
+    foreman.instance_variable_set(:@terminating, false)
+  end
+
+  def self.start_stack
+    procfile = File.expand_path(Dir.pwd + '/Procfile')
+    unless File.exists? procfile
+      raise StandardError, 'Procfile does not exist!'
+    end
+    $foreman = ::Foreman::Engine.new(procfile, {})
+
+    Thread.new do
+      foreman.start
+    end
+  end
+
+  def self.stop_stack
+    foreman.send(:terminate_gracefully) unless foreman.nil?
+    foreman = nil
+  end
+end

data/lib/testengineer/cucumber.rb

@@ -0,0 +1,8 @@
+Around('@testengineer') do |scenario, block|
+  TestEngineer.start_stack
+  begin
+    block.call
+  ensure
+    TestEngineer.stop_stack
+  end
+end

data/lib/testengineer/version.rb

@@ -0,0 +1,3 @@
+module TestEngineer
+  VERSION = "0.1.#{ENV['BUILD_NUMBER'] || 'dev'}"
+end

data/spec/spec_helper.rb

@@ -0,0 +1,3 @@
+$:.unshift File.expand_path(File.dirname(__FILE__) + '/../lib/')
+
+require 'testengineer'

data/spec/testengineer/main_spec.rb

@@ -0,0 +1,85 @@
+require 'spec_helper'
+
+describe TestEngineer do
+  let(:foreman) { double('Foreman::Engine') }
+
+  describe '#foreman' do
+    it 'should return nil when $foreman is nil' do
+      subject.foreman.should be nil
+    end
+
+    it 'return the value in $foreman' do
+      $foreman = foreman
+      subject.foreman.should be $foreman
+    end
+
+    after :each do
+      $foreman = nil
+    end
+  end
+
+  describe '#wait_for_socket' do
+  end
+
+  describe '#stop_process' do
+    before :each do
+      subject.stub(:foreman).and_return(foreman)
+    end
+    context 'no running processes' do
+      before :each do
+        foreman.stub(:running_processes).and_return([])
+      end
+
+      it 'do nothing and reset Foreman::Engine.terminating' do
+        foreman.should_receive(:instance_variable_set).with(:@terminating, false)
+        subject.stop_process('foreman')
+      end
+
+      it 'should raise an error on a nil name argument' do
+        expect {
+          subject.stop_process(nil)
+        }.to raise_error
+      end
+    end
+    context 'running processes' do
+      let(:process) { double('Foreman::Process') }
+      before :each do
+        process.stub(:name).and_return('mock.1')
+        foreman.stub(:running_processes).and_return([[1, process]])
+      end
+
+      it 'should not stop unmatched names' do
+        process.should_not_receive(:kill)
+        subject.stop_process('foreman')
+      end
+
+      it 'should not stop partially matched names' do
+        process.should_not_receive(:kill)
+        subject.stop_process('mockery')
+      end
+
+      it 'should stop matching named processes' do
+        process.should_receive(:kill)
+        Process.stub(:waitpid).and_return(true)
+        subject.stop_process('mock')
+      end
+    end
+  end
+
+  describe '#start_stack' do
+  end
+
+  describe '#stop_stack' do
+    it 'should not do anything if foreman is nil' do
+      foreman.should_not_receive(:terminate_gracefully)
+      subject.stub(:foreman).and_return(nil)
+      subject.stop_stack
+    end
+
+    it 'should invoke #terminate_gracefully if foreman exists' do
+      foreman.should_receive(:terminate_gracefully)
+      subject.stub(:foreman).and_return(foreman)
+      subject.stop_stack
+    end
+  end
+end

data/testengineer.gemspec

@@ -0,0 +1,21 @@
+# -*- encoding: utf-8 -*-
+require File.expand_path('../lib/testengineer/version', __FILE__)
+
+Gem::Specification.new do |gem|
+  gem.authors       = ["R. Tyler Croy"]
+  gem.email         = ["rtyler.croy@mylookout.com"]
+  gem.description   = %q{TestEngineer}
+  gem.summary       = %q{TestEngineer}
+  gem.homepage      = ""
+
+  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          = "testengineer"
+  gem.require_paths = ["lib"]
+  gem.version       = TestEngineer::VERSION
+
+  gem.add_dependency 'foreman'
+  gem.add_development_dependency 'rake'
+  gem.add_development_dependency 'rspec'
+end

metadata

@@ -0,0 +1,120 @@
+--- !ruby/object:Gem::Specification 
+name: testengineer
+version: !ruby/object:Gem::Version 
+  hash: 31
+  prerelease: 
+  segments: 
+  - 0
+  - 1
+  - 2
+  version: 0.1.2
+platform: ruby
+authors: 
+- R. Tyler Croy
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2012-04-17 00:00:00 +00:00
+default_executable: 
+dependencies: 
+- !ruby/object:Gem::Dependency 
+  requirement: &id001 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        hash: 3
+        segments: 
+        - 0
+        version: "0"
+  version_requirements: *id001
+  name: foreman
+  prerelease: false
+  type: :runtime
+- !ruby/object:Gem::Dependency 
+  requirement: &id002 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        hash: 3
+        segments: 
+        - 0
+        version: "0"
+  version_requirements: *id002
+  name: rake
+  prerelease: false
+  type: :development
+- !ruby/object:Gem::Dependency 
+  requirement: &id003 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        hash: 3
+        segments: 
+        - 0
+        version: "0"
+  version_requirements: *id003
+  name: rspec
+  prerelease: false
+  type: :development
+description: TestEngineer
+email: 
+- rtyler.croy@mylookout.com
+executables: []
+
+extensions: []
+
+extra_rdoc_files: []
+
+files: 
+- .gitignore
+- Gemfile
+- LICENSE
+- README.md
+- Rakefile
+- lib/testengineer.rb
+- lib/testengineer/cucumber.rb
+- lib/testengineer/version.rb
+- spec/spec_helper.rb
+- spec/testengineer/main_spec.rb
+- testengineer.gemspec
+has_rdoc: true
+homepage: ""
+licenses: []
+
+post_install_message: 
+rdoc_options: []
+
+require_paths: 
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement 
+  none: false
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      hash: 3
+      segments: 
+      - 0
+      version: "0"
+required_rubygems_version: !ruby/object:Gem::Requirement 
+  none: false
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      hash: 3
+      segments: 
+      - 0
+      version: "0"
+requirements: []
+
+rubyforge_project: 
+rubygems_version: 1.6.2
+signing_key: 
+specification_version: 3
+summary: TestEngineer
+test_files: 
+- spec/spec_helper.rb
+- spec/testengineer/main_spec.rb