dock_test 0.0.2 → 0.0.3

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: ab62525e9ffb9c9ad2f3dcd1e10f5d7b335a5a5f
-  data.tar.gz: 1fd814ff7d00075e55c6e3c1db86a0cada15cd91
+  metadata.gz: 5c43981a27f80adac84538b16c9ae454d8bb3eed
+  data.tar.gz: eb96234292816cd2308d78441ef9894c4006d716
 SHA512:
-  metadata.gz: 467ad61c6ea2b4ad5c3e0a133d4e35eb18c55450a3dd2ece31e7de297a712438ca7684baa6589a63549d0ae6ff3852d23fd4475c931309aee56dd186bc319765
-  data.tar.gz: 27085dd0a2532b84953b1622177d1d61a5a2610d5f69b507389d0c1f6a10ff5ead1757c950e13eddefcd6a237991e313b6e4ad69785cc815f4243ce3591eaff0
+  metadata.gz: d662ffa52961ac51da3f33f1a08f0b48af5181857938a34b626654ff035f2fbe8ee4479409d81ef66479c8022d9c66d08532ad89e39e3d09ea0cebc782e1f305
+  data.tar.gz: 93cd0d97755211dbca00c9f0ed640492d1acd1c80371e75a250993858d9d1b3ae456e1d674c9b52c5b86bb6f5da656a85f2b221c26fcac6d807c51d4800b9746

data/Gemfile

@@ -6,3 +6,4 @@ gemspec
 gem 'minitest'
 gem 'guard-jruby-minitest', '0.1.6'
 gem 'terminal-notifier-guard'
+gem 'pry'

data/dock_test.gemspec

@@ -19,6 +19,7 @@ Gem::Specification.new do |spec|
 
   spec.add_dependency 'multi_json'
   spec.add_dependency 'rack'
+  spec.add_dependency 'json-schema'
   spec.add_development_dependency "bundler", "~> 1.6"
   spec.add_development_dependency "rake"
 end

data/lib/dock_test/assertions.rb

@@ -1,5 +1,23 @@
-module DockTest
-  module Assertions
+module Minitest::Assertions
+  def assert_response_status(status)
+    assert last_response.code == status.to_s, "The response status is expected to be #{last_response.code}"
+  end
+
+  def assert_response_content_type(content_type)
+    assert last_response['Content-Type'] == content_type.to_s, "The response content_type is expected to be #{last_response['Content-Type']}"
+  end
+
+  def assert_response_headers(headers, options = {})
+    exclude_keys = Array(options[:exclude] || [])
+    response_headers = last_response.to_hash.delete_if {|k, _| exclude_keys.include?(k)}
+  end
+
+  def assert_response_body(body_string)
+    assert last_response.body == body_string, "The response body is expected to be #{last_response.body}"
+  end
 
+  def assert_response_json_schema(schema_path)
+    schema = File.open(schema_path).read
+    assert JSON::Validator.validate(schema, last_response.body), "The response is expected to have a schema defined in #{schema_path}"
   end
 end

data/lib/dock_test/methods.rb

@@ -4,6 +4,12 @@ module DockTest
     %w(get post put patch delete options head).each do |meth_name|
       define_method meth_name do |path, params = '', headers = {}, &block|
 
+        with_side_effects = verb_has_side_effects?(meth_name)
+
+        if with_side_effects && DockTest.skippy_envs.include?(dock_env)
+          skip_test_to_avoid_side_efforts
+        end
+
         uri = URI.join(DockTest.url, path)
 
         if DockTest.localhost?
@@ -11,7 +17,7 @@ module DockTest
         end
 
         # add the params to the GET requests
-        if meth_name == 'get' && !params.empty?
+        if !with_side_effects && !params.empty?
           if(params.is_a?(Hash))
             uri.query = URI.encode_www_form(URI.decode_www_form(uri.query || '') + params.to_a)
           else
@@ -22,7 +28,7 @@ module DockTest
         @last_request = Net::HTTP.const_get(meth_name.capitalize).new(uri.request_uri)
 
         # add the params to the body of other requests
-        if meth_name != 'get'
+        if with_side_effects
           @last_request.body = params
         end
 
@@ -45,6 +51,15 @@ module DockTest
     end
 
     private
+
+      def dock_env
+        ENV['DOCK_ENV']
+      end
+
+      def verb_has_side_effects?(verb)
+        %w(post put patch delete).include?(verb)
+      end
+
       def last_response
         @last_response
       end
@@ -53,5 +68,8 @@ module DockTest
         @last_request
       end
 
+      def skip_test_to_avoid_side_efforts
+        skip('this test is skipped in order to avoid potential side effects.')
+      end
   end
 end

data/lib/dock_test/version.rb

@@ -1,3 +1,3 @@
 module DockTest
-  VERSION = "0.0.2"
+  VERSION = "0.0.3"
 end

data/lib/dock_test.rb

@@ -1,28 +1,30 @@
+require 'multi_json'
+require 'json-schema'
 require "dock_test/version"
 require "dock_test/methods"
-require "dock_test/assertions"
+
+if defined?(::Minitest)
+  require 'dock_test/assertions'
+else
+end
 
 module DockTest
 
   class << self
 
-    attr_writer :port
-    def port
-      @port ||= 9999
-    end
-
     attr_reader :url
     # sets the test url
     # also creates a new webrick server process
     def url=(value)
       @url = value
-      if localhost?
+
+      if localhost? && @server_thread.nil?
         require "rack"
         require 'webrick'
         server = WEBrick::HTTPServer.new(:Port => port).tap do |server|
           server.mount '/', Rack::Handler::WEBrick, Rack::Server.new.app
         end
-        t = Thread.new { server.start }
+        @server_thread = Thread.new { server.start }
         trap('INT') do
           server.shutdown
           exit
@@ -30,8 +32,21 @@ module DockTest
       end
     end
 
+    def port
+      URI.parse(@url).port
+    end
+
     def localhost?
       @url && ['127.0.0.1', 'localhost'].include?(URI.parse(@url).host)
     end
+
+    attr_reader :skippy_envs
+    def skippy=(envs)
+      @skippy_envs = Array(envs).map(&:to_s)
+    end
+
+    def config(&block)
+      block.call(DockTest)
+    end
   end
 end

data/schemas/response.schema.json

@@ -0,0 +1,49 @@
+{
+  "type":"object",
+  "$schema": "http://json-schema.org/draft-03/schema",
+  "required":true,
+  "properties":{
+    "body": {
+      "type":"string",
+      "required":true
+    },
+    "headers": {
+      "type":"object",
+      "required":true,
+      "properties":{
+        "ACCEPT": {
+          "type":"string",
+          "required":true
+        },
+        "CONTENT_TYPE": {
+          "type":"string",
+          "required":true
+        },
+        "HOST": {
+          "type":"string",
+          "required":true
+        },
+        "USER_AGENT": {
+          "type":"string",
+          "required":true
+        },
+        "VERSION": {
+          "type":"string",
+          "required":true
+        }
+      }
+    },
+    "protcol": {
+      "type":"string",
+      "required":true
+    },
+    "uri": {
+      "type":"string",
+      "required":true
+    },
+    "verb": {
+      "type":"string",
+      "required":true
+    }
+  }
+}

data/test/dock_test/test_assertions.rb

@@ -0,0 +1,33 @@
+require 'test_helper'
+
+class TestAssertions < Minitest::Test
+
+  include DockTest::Methods
+
+  def test_assert_response_status_method
+    get '/path?foo=bar', {a: :b}, {'CONTENT_TYPE' => 'application/json'}
+    assert_response_status 200
+  end
+
+  def test_assert_response_content_type_method
+    get '/path?foo=bar', {a: :b}, {'CONTENT_TYPE' => 'application/json'}
+    assert_response_content_type 'application/json'
+  end
+
+  def test_assert_response_headers_method
+    get '/path?foo=bar', {a: :b}, {'CONTENT_TYPE' => 'application/json'}
+    assert_response_headers({"content-type"=>["application/json"], "content-length"=>["218"], "connection"=>["Keep-Alive"]} , {exclude: ['server', 'date']})
+  end
+
+  def test_assert_response_body_method
+    skip unless ENV['DOCK_ENV'] == 'development'
+    get '/path?foo=bar', {a: :b}, {'CONTENT_TYPE' => 'application/json'}
+    assert_response_body '{"verb":"GET","uri":"http://localhost:9871/path?foo=bar&a=b","body":"","protcol":"HTTP/1.1","headers":{"ACCEPT":"*/*","USER_AGENT":"Ruby","CONTENT_TYPE":"application/json","HOST":"localhost:9871","VERSION":"HTTP/1.1"}}'
+  end
+
+  def test_assert_response_json_schema_method
+    get '/path?foo=bar', {a: :b}, {'CONTENT_TYPE' => 'application/json'}
+    assert_response_json_schema 'schemas/response.schema.json'
+  end
+
+end

data/test/dock_test/{test_localhost_methods.rb → test_methods.rb}

@@ -1,15 +1,13 @@
 require 'test_helper'
-require 'multi_json'
 
 class TestMethods < Minitest::Test
 
   include DockTest::Methods
-  DockTest.url = 'http://localhost:3000'
 
   def test_get_method_with_hash_body
     get '/path?foo=bar', {a: :b}, {'CONTENT_TYPE' => 'application/json'}
 
-    assert_equal last_response_json['uri'], 'http://localhost:9999/path?foo=bar&a=b'
+    assert_equal last_response_json['uri'], "#{DockTest.url}/path?foo=bar&a=b"
     assert_equal last_response_json['verb'], 'GET'
     assert_equal last_response_json['body'], ''
     assert_equal last_response_json['headers']['CONTENT_TYPE'], 'application/json'
@@ -18,7 +16,7 @@ class TestMethods < Minitest::Test
   def test_get_method_with_string_body
     get '/path?foo=bar', 'a=b', {'CONTENT_TYPE' => 'application/json'}
 
-    assert_equal last_response_json['uri'], 'http://localhost:9999/path?foo=bar&a=b'
+    assert_equal last_response_json['uri'], "#{DockTest.url}/path?foo=bar&a=b"
     assert_equal last_response_json['verb'], 'GET'
     assert_equal last_response_json['body'], ''
     assert_equal last_response_json['headers']['CONTENT_TYPE'], 'application/json'
@@ -27,7 +25,7 @@ class TestMethods < Minitest::Test
   def test_get_method_to_root
     get '/', 'a=b', {'CONTENT_TYPE' => 'application/json'}
 
-    assert_equal last_response_json['uri'], 'http://localhost:9999/?a=b'
+    assert_equal last_response_json['uri'], "#{DockTest.url}/?a=b"
     assert_equal last_response_json['verb'], 'GET'
     assert_equal last_response_json['body'], ''
     assert_equal last_response_json['headers']['CONTENT_TYPE'], 'application/json'
@@ -36,7 +34,7 @@ class TestMethods < Minitest::Test
   def test_post_method
     post '/path?foo=bar', MultiJson.dump({guid: '12345'}), {'CONTENT_TYPE' => 'application/json'}
 
-    assert_equal last_response_json['uri'], 'http://localhost:9999/path?foo=bar'
+    assert_equal last_response_json['uri'], "#{DockTest.url}/path?foo=bar"
     assert_equal last_response_json['verb'], 'POST'
     assert_equal last_response_json['body'], "{\"guid\":\"12345\"}"
     assert_equal last_response_json['headers']['CONTENT_TYPE'], 'application/json'
@@ -45,7 +43,7 @@ class TestMethods < Minitest::Test
   def test_put_method
     put '/path?foo=bar', MultiJson.dump({guid: '12345'}), {'CONTENT_TYPE' => 'application/json'}
 
-    assert_equal last_response_json['uri'], 'http://localhost:9999/path?foo=bar'
+    assert_equal last_response_json['uri'], "#{DockTest.url}/path?foo=bar"
     assert_equal last_response_json['verb'], 'PUT'
     assert_equal last_response_json['body'], "{\"guid\":\"12345\"}"
     assert_equal last_response_json['headers']['CONTENT_TYPE'], 'application/json'
@@ -54,7 +52,7 @@ class TestMethods < Minitest::Test
   def test_patch_method
     patch '/path?foo=bar', MultiJson.dump({guid: '12345'}), {'CONTENT_TYPE' => 'application/json'}
 
-    assert_equal last_response_json['uri'], 'http://localhost:9999/path?foo=bar'
+    assert_equal last_response_json['uri'], "#{DockTest.url}/path?foo=bar"
     assert_equal last_response_json['verb'], 'PATCH'
     assert_equal last_response_json['body'], "{\"guid\":\"12345\"}"
     assert_equal last_response_json['headers']['CONTENT_TYPE'], 'application/json'
@@ -63,7 +61,7 @@ class TestMethods < Minitest::Test
   def test_delete_method
     delete '/path?foo=bar', '', {'CONTENT_TYPE' => 'application/json'}
 
-    assert_equal last_response_json['uri'], 'http://localhost:9999/path?foo=bar'
+    assert_equal last_response_json['uri'], "#{DockTest.url}/path?foo=bar"
     assert_equal last_response_json['verb'], 'DELETE'
     assert_equal last_response_json['body'], ''
     assert_equal last_response_json['headers']['CONTENT_TYPE'], 'application/json'

data/test/test_helper.rb

@@ -1,5 +1,16 @@
-require 'dock_test'
-
 require 'bundler/setup'
-Bundler.require(:default, :test)
 require 'minitest/autorun'
+Bundler.require(:default, :test)
+
+require 'dock_test'
+
+DockTest.config do |c|
+  c.url = case ENV['DOCK_ENV']
+          when 'production'
+            'http://floating-mesa-6194.herokuapp.com'
+          else
+            'http://localhost:9871'
+          end
+  c.skippy = :production
+end
+

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: dock_test
 version: !ruby/object:Gem::Version
-  version: 0.0.2
+  version: 0.0.3
 platform: ruby
 authors:
 - Jack Xu
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2014-07-17 00:00:00.000000000 Z
+date: 2014-07-18 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: multi_json
@@ -38,6 +38,20 @@ dependencies:
         version: '0'
   prerelease: false
   type: :runtime
+- !ruby/object:Gem::Dependency
+  name: json-schema
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  prerelease: false
+  type: :runtime
 - !ruby/object:Gem::Dependency
   name: bundler
   version_requirements: !ruby/object:Gem::Requirement
@@ -85,7 +99,9 @@ files:
 - lib/dock_test/assertions.rb
 - lib/dock_test/methods.rb
 - lib/dock_test/version.rb
-- test/dock_test/test_localhost_methods.rb
+- schemas/response.schema.json
+- test/dock_test/test_assertions.rb
+- test/dock_test/test_methods.rb
 - test/test_helper.rb
 homepage: https://github.com/jackxxu/dock_test
 licenses:
@@ -112,5 +128,6 @@ signing_key:
 specification_version: 4
 summary: an outside-in service api test framework.
 test_files:
-- test/dock_test/test_localhost_methods.rb
+- test/dock_test/test_assertions.rb
+- test/dock_test/test_methods.rb
 - test/test_helper.rb