RubyGems - itg_test - Versions diffs - 0.0.0 - Mend

itg_test 0.0.0

Files changed (9) hide show

data/.gitignore ADDED Viewed

@@ -0,0 +1,5 @@
+# Ignore bundler config
+/.bundle
+# Mac's file index cache
+.DS_Store

data/README.md ADDED Viewed

@@ -0,0 +1,69 @@
+# itg_test - simple integration test framework
+## Description
+For Rails apps that are too complicated to be tested with the
+builtin integration test, such as apps that spawn threads
+that update the same database table.
+itg_test overcomes this obstacle by simply starting a server
+and a client in separate processes.
+## Installation
+`gem install itg_test`
+## Usage
+* Create a `itg` folder under Rail's default test folder by running
+  `mkdir test/itg`.
+  Now your `test` directory structure should look something like
+  `$ls test`
+  `fixtures  functional  integration  itg  test_helper.rb  unit`
+* Write integration tests as you would with Rail's default
+  integration test framework. Remember to place them under
+  the `itg` folder instead of Rail's default `integration` folder.
+  For example, create `test/itg/your_app_test.rb` with the following contents
+  ```
+  require 'itg_test'
+  class YourAppTest < ItgTest::TestCase
+    test 'a complete test' do
+      get '/peanuts'
+      assert_select 'h3 p:nth-child(3)', 'very yummy'
+      ...
+    end
+  end
+  ```
+* Run your itg_test tests with `rake test:itg`
+* itg_test supports the common Rails integration test helpers,
+  including `assert_equal`, `assert_difference` and `assert_select` etc.
+* You might find the following script that runs all
+  Rails and itg_test tests in one shot handy
+  ```
+  desc "all tests"
+  task 'test:all' => :environment do
+      Rake::Task['test'].invoke
+      Rake::Task['test:itg'].invoke
+  end
+  ```
+## CONTRIBUTORS:
+* awaw fumin (@awawfumin)
+## LICENSE:
+Apache License 2.0
+Copyright (c) 2011-2012, Cardinal Blue
+Licensed under the Apache License, Version 2.0 (the "License");
+you may not use this file except in compliance with the License.
+You may obtain a copy of the License at
+   <http://www.apache.org/licenses/LICENSE-2.0>
+Unless required by applicable law or agreed to in writing, software
+distributed under the License is distributed on an "AS IS" BASIS,
+WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+See the License for the specific language governing permissions and
+limitations under the License.

data/itg_test.gemspec ADDED Viewed

@@ -0,0 +1,21 @@
+Gem::Specification.new do |s|
+  s.name        = 'itg_test'
+  s.version     = '0.0.0'
+  s.date        = '2012-08-29'
+  s.summary     = "rails integration test"
+  s.description = "for rails apps that are too complicated to be tested with builtin integration test"
+  s.authors     = ["awawfumin"]
+  s.email       = 'fumin@cardinalblue.com'
+  s.files       = [
+    ".gitignore",
+    "lib/itg_test.rb",
+    "lib/itg_test/http_client.rb",
+    "lib/itg_test/railtie.rb",
+    "lib/itg_test/test_case.rb",
+    "lib/tasks/test_itg.rake",
+    "itg_test.gemspec",
+    "README.md"
+  ]
+  s.homepage    = 'http://cardinalblue.com'
+  s.add_runtime_dependency "nokogiri", [">= 0"]
+end

data/lib/itg_test/http_client.rb ADDED Viewed

@@ -0,0 +1,82 @@
+require 'net/http'
+# Synopsis
+# c = ItgTest::HTTPClient.new 'http://localhost:3000'
+# c.get '/scheduled_posts/post_due' => <head></head><body>...</body>
+module ItgTest; end
+class ItgTest::HTTPClient
+  attr_accessor :cookie
+  def initialize url
+    new_url = if %r|^http://.+$| =~ url || %r|^https://.+$| =~ url
+                url
+              else
+                "http://" + url
+              end
+    @cookie = ""
+    @uri = URI(new_url)
+  end
+  def session
+    Net::HTTP.start(@uri.host, @uri.port, use_ssl: @uri.scheme == 'https')
+  rescue Errno::ECONNREFUSED => e
+    sleep(1); retry
+  end
+  def get path, query=''
+    path = path[0...-1] if path[-1] == "/"
+    path = "/#{path}" unless path[0] == "/"
+    if query == ''
+      _get path
+    else
+      _get "#{path}?#{to_query(query)}"
+    end
+  end
+  def _get path, limit = 10
+    raise ArgumentError, 'too many HTTP redirects' if limit == 0
+    res = session.get(path, {'Cookie'=>@cookie})
+    cookie_array = res.get_fields('set-cookie')
+    @cookie = cookie_array.collect{|ea| ea[/^.*?;/]}.join if cookie_array
+    final_res = handle_res res, limit
+    JSON.parse final_res
+  rescue JSON::ParserError
+    final_res
+  end
+  def post path, params
+    res = session.post path, to_query(params), {'Cookie'=>@cookie}
+    handle_res res
+  end
+  def to_query params, namespace=nil
+    if params.is_a?(Hash)
+      params.collect do |key, value|
+        to_query(value, namespace ? "#{namespace}[#{key}]" : key)
+      end.sort * '&'
+    elsif params.is_a?(Array)
+      prefix = "#{namespace}[]"
+      params.collect { |value| to_query(value, prefix) }.join '&'
+    else
+      "#{CGI.escape(namespace.to_s)}=#{CGI.escape(params.to_s)}"
+    end
+  end
+  def handle_res res, limit=10
+    case res
+    when Net::HTTPRedirection
+      location = res['location']
+      warn "redirected to #{location}"
+      if %r|^http://.+$| =~ location || %r|^https://.+$| =~ location
+        @uri = URI(location)
+        _get(@uri.path, limit - 1)
+      else
+        _get(location, limit - 1)
+      end
+    when Net::HTTPSuccess
+      res.body
+    else
+      res.value
+    end
+  end
+end

data/lib/itg_test/railtie.rb ADDED Viewed

@@ -0,0 +1,11 @@
+require 'itg_test'
+require 'rails'
+module ItgTest
+  class Railtie < Rails::Railtie
+    railtie_name :itg_test
+    rake_tasks do
+      load "tasks/test_itg.rake"
+    end
+  end
+end

data/lib/itg_test/test_case.rb ADDED Viewed

@@ -0,0 +1,68 @@
+require 'itg_test/http_client'
+require 'nokogiri'
+module Declarative
+  def test name, &block
+    test_name = "test_#{name.gsub(/\s+/,'_')}".to_sym
+    define_method test_name, &block
+  end
+end
+module ItgTest; end
+class ItgTest::TestCase
+  extend Declarative
+  def run_test
+    methods.select{|m| /^test_\w+$/ =~ m.to_s}.each{|m| send(m); print "."}
+    puts "\nFinished Tests"
+  rescue Exception => e
+    puts "#{e.class}: #{e}"
+    puts e.backtrace
+  ensure
+    wait_exit
+  end
+  def initialize url, pid
+    @pid = pid
+    @client = ItgTest::HTTPClient.new url
+  end
+  def post path, data
+    @response = @client.post path, data
+  end
+  def get path
+    @response = @client.get path
+  end
+  def assert_difference expression, difference=1
+    exs = [expression].flatten
+    before = exs.map{|e| eval e}
+    yield
+    exs.each_with_index{ |e, i| assert_equal(before[i] + difference, eval(e), e) }
+  end
+  def assert_select selector, content
+    unless Nokogiri::HTML(@response).at_css(selector).try(:content) == content
+      raise "#{content} doesn't match #{selector} of\n#{@response}"
+    end
+  end
+  def assert_equal a, b, msg=""
+    raise "Expected #{a} == #{b} #{msg}" unless a == b
+  end
+  def wait_exit
+    child_pids(@pid).each{|p| Process.kill "INT", p} # kill grand_children
+    Process.kill "INT", @pid # kill child
+    Process.wait
+    exit
+  end
+  def child_pids pid
+    pipe = IO.popen("ps -ef | grep #{pid}")
+    pipe.readlines.map do |line|
+      parts = line.split(/\s+/)
+      parts[2] if parts[3] == pid.to_s and parts[2] != pipe.pid.to_s
+    end.compact.map(&:to_i)
+  end
+end

data/lib/itg_test.rb ADDED Viewed

@@ -0,0 +1,11 @@
+module ItgTest
+  require 'itg_test/railtie' if defined?(Rails)
+  require 'itg_test/test_case'
+  require 'itg_test/http_client'
+  module_function
+  def absolute_file_name_to_class_name abs_fn
+    fn = abs_fn.match(%r|^/.*/([a-zA-Z_]+)\.rb$|)[1]
+    fn.split('_').map{|w| w.capitalize}.join
+  end
+end

data/lib/tasks/test_itg.rake ADDED Viewed

@@ -0,0 +1,17 @@
+desc "integration test"
+task 'test:itg' => :environment do
+  Rails.env = 'test'
+  Rake::Task['db:fixtures:load'].invoke
+  pid = Process.fork
+  if pid.nil?
+    exec('rails s -e test -p 3006')
+    exec('rails s -e test -p 3006 > /dev/null 2>&1')
+  else
+    Dir[Dir.pwd + '/test/itg/*.rb'].each {|file|
+      require file
+      Object.const_get(ItgTest.absolute_file_name_to_class_name(file)).
+             new('http://localhost:3006', pid).run_test
+    }
+  end
+end

metadata ADDED Viewed

@@ -0,0 +1,69 @@
+--- !ruby/object:Gem::Specification
+name: itg_test
+version: !ruby/object:Gem::Version
+  version: 0.0.0
+  prerelease:
+platform: ruby
+authors:
+- awawfumin
+autorequire:
+bindir: bin
+cert_chain: []
+date: 2012-08-29 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: nokogiri
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+description: for rails apps that are too complicated to be tested with builtin integration
+  test
+email: fumin@cardinalblue.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- .gitignore
+- lib/itg_test.rb
+- lib/itg_test/http_client.rb
+- lib/itg_test/railtie.rb
+- lib/itg_test/test_case.rb
+- lib/tasks/test_itg.rake
+- itg_test.gemspec
+- README.md
+homepage: http://cardinalblue.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.24
+signing_key:
+specification_version: 3
+summary: rails integration test
+test_files: []