itesttool 0.0.1

data/Gemfile

@@ -0,0 +1,5 @@
+source 'http://rubygems.org'
+
+# Specify your gem's dependencies in hoge.gemspec
+gemspec
+

data/LICENSE.txt

@@ -0,0 +1,8 @@
+Copyright (c) 2013 Yohei Kariya  
+  
+ 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,263 @@
+# itesttool
+
+[![Build Status](https://travis-ci.org/bati11/itesttool.png?branch=master)](https://travis-ci.org/bati11/itesttool)
+
+WebアプリケーションのEnd-to-Endのテストを自動化するためのツール。  
+RSpecにユーティリティを追加して実現してます。
+
+
+# Install
+cloneしたらBundlerを使って必要なgemをインストールします。
+~~~~~ {sh}
+$ bundle install --path vendor/bundle
+~~~~~
+サンプルアプリケーションが起動します。
+
+~~~~~ {sh}
+$ bundle exec ruby sample/app.rb
+~~~~~
+
+以下のコマンドでサンプルに対するテストを実行します。
+
+~~~~~ {sh}
+$ bundle exec rspec
+~~~~~
+
+テストが通れば準備完了です。
+
+
+# Usage
+## GET リクエストを送信する
+GET リクエスト送って、レスポンスコードを確認するには以下のようにします。  
+`_given` ブロックでテストの前提条件を書きます。`_given`は、単純にRSpecの`before`の別名です。  
+`_when` ブロックでGETリクエストを送ります。  
+`_then` ブロック内でres変数を使うことでレスポンスにアクセスできます。  
+resは、Net::HTTPResponseオブジェクトです。
+
+~~~~~ {ruby}
+describe 'send GET request' do
+  _given {
+    headers 'referer' => 'http://local.example.com',
+  }
+  _when { get 'http://localhost:4567/index' }
+  _then {
+    res.code.should eq '200'
+  }
+end
+~~~~~
+
+## レスポンスを検証する
+上の例にもありますが、ステータスコードは`res.code.should eq '200'`と書きます。  
+レスポンスボディは`res.body.should eq 'Hello world!'`というように書きます。
+
+レスポンスボディが、JSON、XML、HTMLの場合はそれぞれ、JSONPath、XPath、CSSセレクタを用いて要素を検証できます。  
+JSONPath、XPathについては、下のサイトを参考にしてください。  
+[http://goessner.net/articles/JsonPath/](http://goessner.net/articles/JsonPath/)
+
+また、配列に対する検証のために、以下のカスタムマッチャーを定義してます。  
+`all`は引数に、matcherを受け取ります。引数で受け取ったmatcherを配列の全要素に適用します。  
+`be_one_and`は引数に、matcherを受け取ります。まず配列の要素が1つであることを検証してから引数で受け取ったmatcherを要素に適用します。
+`be_sorted`は配列の要素が、昇順もしくは降順で並んでいるかを検証します。
+
+  - `all`
+  - `be_one_and`
+  - `be_sorted`
+
+
+### JSON
+JSONPathを用いて、以下のように検証できます。  
+
+~~~~~ {ruby}
+res['$.team'].should eq ['ABC']
+res['$.members..name'].should eq ['Ichiro', 'Jiro', 'Saburo']
+res['$.members..age'].should include 32
+res['$.members[::]'].should have(3).items
+res['$.members[::]'].should have_at_most(3).items
+res['$.members[::]'].should have_at_least(1).items
+res['$.members..name'].should all be_kind_of String
+res['$.members..age'].should all be_kind_of Integer
+res['$.members..age'].should all be > 11
+res['$.members..age'].should all be >= 12
+res['$.members..age'].should all be < 33
+res['$.members..age'].should all be <= 32
+res['$.members..age'].should be_sorted :desc
+~~~~~
+
+
+同じ要素を色々検証したい場合は、`select`を使ってブロック内に検証を書くと見やすいかも。
+
+~~~~~ {ruby}
+res.select('$.members..age') do |member_ages|
+  member_ages.should all be_kind_of Integer
+  member_ages.should all be > 11
+  member_ages.should all be >= 12
+  member_ages.should all be < 33
+  member_ages.should all be <= 32
+  member_ages.should be_sorted :desc
+end
+~~~~~
+
+また、JSON schemaによる検証もできます。  
+json_schema/hello.js ファイルに以下のようなJSON schemaが記述します。
+
+    {
+      "type": "object",
+      "properties": {
+        "team": {"type": "string", "required": true},
+        "members": {
+          "type": "array",
+          "items": {
+            "type": "object",
+            "properties": {
+              "name": {"type": "string", "required": true},
+              "age":  {"type": "integer", "required": true}
+            }
+          }
+        }
+      }
+    }
+
+`_then`ブロックに以下のように記述することで、レスポンスボディが上記のJSON schemaとマッチするかを検証できます。
+
+~~~~~ {ruby}
+res.body.should eq_schema_of 'json_schema/hello.json'
+~~~~~
+
+
+### XML
+XPathを用いて以下のように検証できます。
+
+~~~~~ {ruby}
+res['/root/team/text()'].should eq ['ABC']
+res['/root/members//name/text()'].should eq ['Ichiro', 'Jiro', 'Saburo']
+res['/root/members//age/text()'].should include '32'
+res['/root/members/*'].should have(3).items
+res['/root/members/*'].should have_at_most(3).items
+res['/root/members/*'].should have_at_least(1).items
+res['/root/members//age/text()'].should all be > "11"
+member_ages = res['/root/members//age/text()']
+  member_ages.should all be >= "10"
+  member_ages.should all be < "33"
+  member_ages.should all be <= "32"
+  member_ages.should be_sorted :desc
+res['/root/members/member/@order'].should be_sorted :asc
+~~~~~
+
+
+### HTML
+CSSセレクタを用いて以下のように検証できます。
+
+~~~~~ {ruby}
+res['title'].should eq ['Page Title!']
+res['h1#team'].should eq ['ABC']
+res['.member dd.name'].should eq ['Ichiro', 'Jiro', 'Saburo']
+res['.member dd.age'].should include '32'
+res['.member'].should have(3).items
+res['.member'].should have_at_most(3).items
+res['.member'].should have_at_least(1).items
+res['.member dd.age'].should all be > "11"
+member_ages = res['.member dd.age']
+  member_ages.should all be >= 10
+  member_ages.should all be < 33
+  member_ages.should all be <= 32
+  member_ages.should be_sorted :desc
+~~~~~
+
+
+## クエリパラメータを設定する
+クエリパラメータを設定する方法は2通りあります。  
+1つ目が、単純にurlの末尾に"?"をつけてクエリパラメータを指定する方法です。
+~~~~~ {ruby}
+_when { get 'http://localhost:4567/index?night=true', as_text }
+_then {
+  res.code.should eq '200'
+}
+~~~~~
+
+2つ目が、`query`ヘルパー関数を使う方法です。
+~~~~~ {ruby}
+_when {
+  get 'http://localhost:4567/index',
+      as_text,
+      query('night' => 'true',
+            'times' => 3)
+}
+_then {
+  res.code.should eq '200'
+}
+~~~~~
+
+
+## リクエストヘッダを設定する
+リクエストヘッダの設定は、`_given`ブロックで、`headers`ヘルパー関数を呼び出して設定します。  
+`headers`関数に、ハッシュを渡して設定します。
+~~~~~ {ruby}
+_given {
+  headers 'referer' => 'http://local.example.com',
+          'user_agent' => 'itesttool'
+}
+_when { get 'http://localhost:4567/index.html', as_html }
+_then {
+  res.code.should eq '200'
+}
+~~~~~
+
+
+## POSTリクエストを送信する
+POSTリクエストを送信する場合、`get`の代わりに`post`を使います。  
+第1引数に送信先URL、第2引数にリクエストボディ、第３引数にレスポンスのフォーマット、を指定します。
+
+### formデータ
+リクエストボディに、formデータを設定する場合は、`body_as_form`を使用します。
+
+~~~~~ {ruby}
+_when {
+  post 'http://localhost:4567/login',
+       body_as_form('nickname' => 'admin',
+                    'password' => 'pass'),
+       res_is_json
+}
+_then {
+  res.code.should eq '200'
+  res['$.nickname'].should eq ['admin']
+}
+~~~~~
+
+### JSON
+リクエストボディに、JSONを設定する場合は、`body_as_json`を使用します。
+
+~~~~~ {ruby}
+_when {
+  post 'http://localhost:4567/echo',
+       body_as_json('name' => 'Shiro',
+                    'age' => 2),
+       res_is_json
+}
+_then {
+  res.code.should eq '200'
+  res.body.should eq '{"name":"Shiro","age":2}'
+}
+~~~~~
+
+単純に、`body`を使って直接文字列で設定することもできます。
+
+~~~~~ {ruby}
+_when {
+  post 'http://localhost:4567/echo',
+       body('{"name":"Shiro","age":2}'),
+       res_is_json
+}
+_then {
+  res.code.should eq '200'
+  res.body.should eq '{"name":"Shiro","age":2}'
+}
+~~~~~
+
+## PUT, DELETEリクエスト
+PUT, DELETEリクエストの場合は、`post`の代わりに`put`,`delete`を使ってください。  
+後は`post`の場合といっしょです。
+
+
+# License
+The MIT License. See LICENSE.txt
+

data/Rakefile

@@ -0,0 +1,7 @@
+require "bundler/gem_tasks"
+require "rspec/core/rake_task"
+
+RSpec::Core::RakeTask.new("spec")
+
+task :default => ["spec"]
+

data/lib/itesttool/custom_matchers.rb

@@ -0,0 +1,168 @@
+# coding: utf-8
+require 'rubygems'
+require 'json-schema'
+
+def eq_schema_of(schema_file)
+  EqSchemaOf.new(schema_file)
+end
+
+class EqSchemaOf
+  def initialize(schema_file)
+    @schema_file = schema_file
+  end
+  def matches? (body)
+    @body = body
+    @msg = ""
+    begin
+      JSON::Validator.validate!(@schema_file, body)
+      true
+    rescue JSON::Schema::ValidationError
+      @msg = $!.message
+      false
+    end
+  end
+
+  def failure_message_for_should
+<<"MSG"
+
+Invalid response body on "#{@schema_file}".
+#{@msg}
+
+Body is
+====================
+#{@body}
+
+#{@schema_file} is
+====================
+#{File.open(@schema_file).read}
+
+MSG
+  end
+
+  def failure_message_for_should_not
+    "\nValid response body on \"#{@schema_file}\".\n\n"
+  end
+end
+
+
+def be_sorted(order)
+  BeSorted.new(order)
+end
+
+class BeSorted
+  def initialize(order)
+    @order = order
+  end
+  def matches?(list)
+    @list = list
+    type = list.first.class
+    unless list.all?{|x| x.class == type }
+      @not_aligned = true
+      false
+    else
+      sorted_list = list.sort
+      if @order == :asc
+        list == sorted_list
+      elsif @order == :desc
+        list == sorted_list.reverse
+      else
+        @order_invalid = true
+        false
+      end
+    end
+  end
+
+  def failure_message_for_should
+    if @not_aligned
+      "expected #{@list.inspect} type is not available."
+    elsif @order_invalid
+      "specified order is invalid. valid order in [:asc, :desc]"
+    else
+      "expected #{@list.inspect} to be sorted #{@order}"
+    end
+  end
+end
+
+
+def all(meta)
+  All.new(meta)
+end
+
+class All
+  def initialize(matcher)
+    @matcher = matcher
+  end
+
+  def matches?(rows)
+    rows.each_with_index do |i, j|
+      @elem = j
+      unless @matcher.matches? i
+        return false
+      end
+    end
+    return true
+  end
+
+  def failure_message_for_should
+    "at[#{@elem}] #{@matcher.failure_message_for_should}"
+  end
+
+end
+
+
+def be_one_and(meta)
+  BeOneAnd.new(meta)
+end
+
+class BeOneAnd
+  def initialize(matcher)
+    @matcher = matcher
+  end
+
+  def matches?(rows)
+    @have_error = false
+    @have = RSpec::Matchers::BuiltIn::Have.new(1).items
+    unless @have.matches? rows then
+      @have_error = true
+      return false;
+    end
+    @matcher.matches? rows[0]
+  end
+
+  def failure_message_for_should
+    if @have_error 
+      @have.failure_message_for_should
+    else
+      @matcher.failure_message_for_should
+    end
+  end
+
+end
+
+def include_with(key, values)
+  IncludeWith.new(key, values)
+end
+
+class IncludeWith
+  def initialize(key, values)
+    @key = key
+    @values = values
+  end
+  def matches?(rows)
+    @rows = rows
+    list = rows.map{|x| x[@key]}
+    Set[*list] == Set[*@values]
+  end
+
+  def failure_message_for_should
+    str = @values.map{|x| "#{@key} => #{x}"}.join(" and ")
+    "expected #{@rows.inspect} to include #{str}"
+  end
+
+private
+  def msg_of_type_invalid
+    str = @values.map{|x| "#{@key} => #{x}"}.join(" and ")
+    "expected not #{@rows.inspect} to include #{str}"
+  end
+end
+

data/lib/itesttool/version.rb

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

data/lib/itesttool.rb

@@ -0,0 +1,156 @@
+# coding: utf-8
+require 'rubygems'
+require 'net/http'
+require 'uri'
+require 'json'
+require 'jsonpath'
+require 'nokogiri'
+require "itesttool/version"
+require "itesttool/custom_matchers"
+
+def _given(&b) before(:each, &b) end
+def _when(&b) let(:res, &b) end
+def _then(&b) it(&b) end
+
+module ItestHelpers
+
+  def as_text() "text" end
+  def as_json() "json" end
+  def as_xml() "xml" end
+  def as_html() "html" end
+
+  alias res_is_json as_json
+  alias res_is_xml as_xml
+  alias res_is_html as_html
+
+  def headers(h = {})
+    @headers = h
+  end
+
+  def query(h = {})
+     h.map{ |k, v| URI.encode(k) + "=" + URI.encode(v.to_s) }.join("&")
+  end
+
+  def body(data = "")
+    {:body => data}
+  end
+  def body_as_form(data = {})
+    {:form => data}
+  end
+  def body_as_json(data = {})
+    {:json => data}
+  end
+
+  def get(url, res_format="text", query="")
+    url_obj = URI.parse(url)
+    res = Net::HTTP.start(url_obj.host, url_obj.port) {|http|
+      queries = []
+      queries.push(query) unless query.empty?
+      queries.push(url_obj.query) unless url_obj.query.nil?
+      path_with_query =
+        if queries.empty?
+          url_obj.path
+        else
+          url_obj.path + "?" + queries.join("&")
+        end
+      request = Net::HTTP::Get.new(path_with_query)
+      add_headers(request)
+      http.request(request)
+    }
+    decorate_response(res, "GET", url, res_format)
+  end
+
+  def post(url, data, res_format)
+    url_obj = URI.parse(url)
+    res = Net::HTTP.start(url_obj.host, url_obj.port) {|http|
+      request = Net::HTTP::Post.new(url_obj.path)
+      setup(request, data)
+      http.request(request)
+    }
+    decorate_response(res, "POST", url, res_format)
+  end
+
+  def put(url, data, res_format)
+    url_obj = URI.parse(url)
+    res = Net::HTTP.start(url_obj.host, url_obj.port) {|http|
+      request = Net::HTTP::Put.new(url_obj.path)
+      setup(request, data)
+      http.request(request)
+    }
+    decorate_response(res, "PUT", url, res_format)
+  end
+
+  def delete(url, data, res_format)
+    url_obj = URI.parse(url)
+    res = Net::HTTP.start(url_obj.host, url_obj.port) {|http|
+      request = Net::HTTP::DELETE.new(url_obj.path)
+      setup(request, data)
+      http.request(request)
+    }
+    decorate_response(res, "DELETE", url, res_format)
+  end
+
+private
+  def setup(request, data)
+    set_body(request, data)
+    add_headers(request)
+  end
+
+  def add_headers(request)
+    if @headers then @headers.each{|k, v| request.add_field k, v} end
+  end
+
+  def set_body(request, data)
+    if data.include? :form
+      set_form_data(request, data[:form])
+    elsif data.include? :json
+      request.body = JSON.generate(data[:json])
+    else
+      request.body = data[:body]
+    end
+  end
+
+  def set_form_data(request, params, sep = '&')
+    request.body = params.map {|k, v| encode_kvpair(k, v) }.flatten.join(sep)
+    request.content_type = 'application/x-www-form-urlencoded'
+  end
+
+  def encode_kvpair(k, vs)
+    Array(vs).map {|v| "#{URI::encode(k.to_s)}=#{URI::encode(v.to_s)}" }
+  end
+
+  def decorate_response(res, method, url, res_format)
+    class << res
+      attr_accessor :url, :res_format, :method
+      def [](path)
+        select(path)
+      end
+      def select(path, &block)
+        result =
+          if res_format && res_format == "xml"
+            Nokogiri::XML(body).xpath(path).map{|x| x.text}
+          elsif res_format && res_format == "html"
+            Nokogiri::HTML(body).css(path).map{|x| x.text}
+          elsif res_format && res_format == "json"
+            JsonPath.on(body, path)
+          end
+        block.call(result) unless block.nil?
+        result
+      end
+      def to_s
+        method + " " + url
+      end
+    end
+    res.url = url
+    res.res_format = res_format
+    res.method = method
+    res
+  end
+
+  module_function :get, :post, :add_headers, :decorate_response
+end
+
+RSpec.configure do |c|
+    c.include ItestHelpers
+end
+

metadata

@@ -0,0 +1,187 @@
+--- !ruby/object:Gem::Specification
+name: itesttool
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+  prerelease: 
+platform: ruby
+authors:
+- bati11
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2014-01-26 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '2.14'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '2.14'
+- !ruby/object:Gem::Dependency
+  name: json-schema
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '2.2'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '2.2'
+- !ruby/object:Gem::Dependency
+  name: json
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - '='
+      - !ruby/object:Gem::Version
+        version: 1.8.1
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - '='
+      - !ruby/object:Gem::Version
+        version: 1.8.1
+- !ruby/object:Gem::Dependency
+  name: jsonpath
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 0.5.5
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 0.5.5
+- !ruby/object:Gem::Dependency
+  name: nokogiri
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 1.6.1
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 1.6.1
+- !ruby/object:Gem::Dependency
+  name: sinatra
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.4'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.4'
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.3'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.3'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+description: End-to-End Test tool for web api.
+email:
+- mail.bati11@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- lib/itesttool.rb
+- lib/itesttool/version.rb
+- lib/itesttool/custom_matchers.rb
+- Rakefile
+- Gemfile
+- README.md
+- LICENSE.txt
+homepage: ''
+licenses:
+- MIT
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+      segments:
+      - 0
+      hash: 242860858589185526
+required_rubygems_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+      segments:
+      - 0
+      hash: 242860858589185526
+requirements: []
+rubyforge_project: 
+rubygems_version: 1.8.23
+signing_key: 
+specification_version: 3
+summary: End-to-End Test tool for web api.
+test_files: []