usagi 1.0.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 05d0450e25d612318e48d92c0fe7e3d4aaaa58c9
+  data.tar.gz: f5f666caec60871805e4f829cb599c4a4b3939e8
+SHA512:
+  metadata.gz: 37c026e882eb31c803c7344e7239683356886b81d4f498a925aef73d60b7d04b27dfa44883d07079b9fda1a1476fe51c171deffe107fce166fd4856206029471
+  data.tar.gz: c1ff4e485ac2c5e215ec7d0133b340c96abf595810a5737af66b31c00ab32180fbb7c08cd10e3bd10013d59a74db0b0833325cc3ce8e59f7ffb5daab87da93c6

data/.gitignore

@@ -0,0 +1,35 @@
+*.rbc
+capybara-*.html
+.rspec
+/log
+/tmp
+/db/*.sqlite3
+/db/*.sqlite3-journal
+/public/system
+/coverage/
+/spec/tmp
+**.orig
+rerun.txt
+pickle-email-*.html
+
+# TODO Comment out these rules if you are OK with secrets being uploaded to the repo
+config/initializers/secret_token.rb
+config/secrets.yml
+
+## Environment normalisation:
+/.bundle
+/vendor/bundle
+
+# these should all be checked in to normalise the environment:
+# Gemfile.lock, .ruby-version, .ruby-gemset
+
+# unless supporting rvm < 1.11.0 or doing something fancy, ignore this:
+.rvmrc
+
+# if using bower-rails ignore default bower_components path bower.json files
+/vendor/assets/bower_components
+*.bowerrc
+bower.json
+
+# Ignore pow environment settings
+.powenv

data/Gemfile

@@ -0,0 +1,13 @@
+source 'https://rubygems.org'
+
+group :test do
+  gem 'rspec', '3.2.0'
+  gem 'rspec-core', '3.2.3'
+  gem 'rspec-expectations', '3.2.1'
+  gem 'rspec-mocks', '3.2.1'
+  gem 'rspec-support', '3.2.2'
+  gem 'rspec-rails', '3.2.3'
+  gem 'database_cleaner'
+  gem 'nyan-cat-formatter'
+  gem 'simplecov', require: false
+end

data/Gemfile.lock

@@ -0,0 +1,84 @@
+GEM
+  remote: https://rubygems.org/
+  specs:
+    actionpack (4.1.8)
+      actionview (= 4.1.8)
+      activesupport (= 4.1.8)
+      rack (~> 1.5.2)
+      rack-test (~> 0.6.2)
+    actionview (4.1.8)
+      activesupport (= 4.1.8)
+      builder (~> 3.1)
+      erubis (~> 2.7.0)
+    activesupport (4.1.8)
+      i18n (~> 0.6, >= 0.6.9)
+      json (~> 1.7, >= 1.7.7)
+      minitest (~> 5.1)
+      thread_safe (~> 0.1)
+      tzinfo (~> 1.1)
+    builder (3.2.2)
+    database_cleaner (1.4.1)
+    diff-lcs (1.2.5)
+    docile (1.1.5)
+    erubis (2.7.0)
+    i18n (0.7.0)
+    json (1.8.3)
+    minitest (5.7.0)
+    nyan-cat-formatter (0.11)
+      rspec (>= 2.99, >= 2.14.2, < 4)
+    rack (1.5.5)
+    rack-test (0.6.3)
+      rack (>= 1.0)
+    railties (4.1.8)
+      actionpack (= 4.1.8)
+      activesupport (= 4.1.8)
+      rake (>= 0.8.7)
+      thor (>= 0.18.1, < 2.0)
+    rake (10.4.2)
+    rspec (3.2.0)
+      rspec-core (~> 3.2.0)
+      rspec-expectations (~> 3.2.0)
+      rspec-mocks (~> 3.2.0)
+    rspec-core (3.2.3)
+      rspec-support (~> 3.2.0)
+    rspec-expectations (3.2.1)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.2.0)
+    rspec-mocks (3.2.1)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.2.0)
+    rspec-rails (3.2.3)
+      actionpack (>= 3.0, < 4.3)
+      activesupport (>= 3.0, < 4.3)
+      railties (>= 3.0, < 4.3)
+      rspec-core (~> 3.2.0)
+      rspec-expectations (~> 3.2.0)
+      rspec-mocks (~> 3.2.0)
+      rspec-support (~> 3.2.0)
+    rspec-support (3.2.2)
+    simplecov (0.10.0)
+      docile (~> 1.1.0)
+      json (~> 1.8)
+      simplecov-html (~> 0.10.0)
+    simplecov-html (0.10.0)
+    thor (0.19.1)
+    thread_safe (0.3.5)
+    tzinfo (1.2.2)
+      thread_safe (~> 0.1)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  database_cleaner
+  nyan-cat-formatter
+  rspec (= 3.2.0)
+  rspec-core (= 3.2.3)
+  rspec-expectations (= 3.2.1)
+  rspec-mocks (= 3.2.1)
+  rspec-rails (= 3.2.3)
+  rspec-support (= 3.2.2)
+  simplecov
+
+BUNDLED WITH
+   1.10.5

data/LICENSE

@@ -0,0 +1,22 @@
+The MIT License (MIT)
+
+Copyright (c) 2015 
+
+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,2 @@
+# usagi
+兎 - Usagi is a functional test suite for rails APIs

data/bin/usagi

@@ -0,0 +1,27 @@
+#!/usr/bin/env ruby
+require 'rspec'
+require 'usagi'
+
+# Available startup arguments:
+# > --usagi-debug-requests:         Outputs all curl commands used and the results
+# > --usagi-rails-output:           Outputs all rails IO
+# > --usagi-allow-store-key-reuse:  Allows to use STORE_VALUE multiple times with same key name
+# > --usagi-allow_nil_store_values: Allows to store nil value for later use with REUSE_VALUE
+
+usagi_args = ARGV.grep(/--usagi-/)
+Usagi.start(*usagi_args)
+
+ENV['RAILS_ENV']  = 'test'
+
+begin
+  argv_list = ARGV - usagi_args
+  argv_list += Dir['./spec/usagi/**/*.rb'] unless ARGV.any?{|argv| argv =~ /\.rb$/ }
+  Usagi.rspec = RSpec::Core::Runner.run(argv_list.flatten)
+rescue
+  puts "[usagi][#{Usagi.pid}] RSpec encountered an exception"
+  Usagi.stop
+  raise
+end
+
+Usagi.stop
+Process.exit(Usagi.rspec) if Usagi.rspec != 0

data/lib/usagi.rb

@@ -0,0 +1,86 @@
+require 'logger'
+
+module Usagi
+  class << self
+    attr_accessor :pid, :port, :rspec, :suite_options, :options
+
+    def start(*opts)
+      @options = {}
+      opts.each{|opt| @options[opt.gsub(/^--usagi-/,'').gsub('-','_').to_sym] = true }
+      @port = (rand * 65535).to_i until defined?(@port) && @port > 1024
+      @io = IO.popen([{'RAILS_ENV' => 'test'},['rails', 'bundle'], 'server', '-p', @port.to_s])
+      Thread.new(@io) do |rails_io|
+        buffer = ''
+        until rails_io.eof?
+          buffer += rails_io.readpartial(1024)
+          while buffer["\n"]
+            minibuf = buffer.split("\n").first
+            buffer = buffer[(minibuf.length + 1)..-1]
+            puts "[rails]>> #{minibuf}" if Usagi.options[:rails_output]
+          end
+        end
+        puts "[rails]>> #{buffer}" if buffer.length > 0 && Usagi.options[:rails_output]
+      end
+      @pid = @io.pid
+      puts "[usagi][#{@pid}] Running rails server on port #{@port}"
+
+      Signal.trap('INT') do
+        stop
+        Process.exit
+      end
+
+      sleep 1 until `curl --silent "localhost:#{@port}"`.length > 0
+
+      puts "[usagi][#{@pid}] Rails server listening on port #{@port}"
+      true
+    end
+
+    def stop
+      begin
+        Process.kill('INT', @pid)
+        puts "[usagi][#{@pid}] SIGINT sent to rails server"
+        puts "[usagi][#{@pid}] Waiting for rails server to ack kill command..."
+        Process.wait(Usagi.pid)
+      rescue
+      end
+      puts "[usagi][#{@pid}] Killed rails server"
+    end
+
+    def options
+      @options ||= {}
+    end
+
+    def suite_options
+      @suite_options ||= {}
+    end
+
+    # Matchers methods
+    def define_matcher(name, &block)
+      if matchers[name.to_s.upcase]
+        raise ArgumentError("already defined matcher #{name.to_s.upcase}")
+      end
+      matchers[name.to_s.upcase] = Matcher.new(name.to_s.upcase, &block)
+    end
+
+    def remove_matcher(name)
+      unless matchers[name.to_s.upcase]
+        raise ArgumentError("undefined matcher #{name.to_s.upcase}")
+      end
+      matchers.delete(name.to_s.upcase)
+    end
+
+    def rename_matcher(old_name, new_name)
+      unless matchers[old_name.to_s.upcase]
+        raise ArgumentError("undefined matcher #{old_name.to_s.upcase}")
+      end
+      matchers[new_name.to_s.upcase] = matchers.delete(old_name.to_s.upcase)
+    end
+
+    def matchers
+      @matchers ||= MatcherContainer.new
+    end
+  end
+end
+
+require 'usagi/api_response'
+require 'usagi/rspec' if defined? RSpec

data/lib/usagi/api_response.rb

@@ -0,0 +1,80 @@
+require_relative 'matcher_container'
+require_relative 'usagi_matchers'
+
+module Usagi
+  class ApiResponse
+    def initialize(data)
+      @data = data
+    end
+
+    def ==(other_data)
+      ## matchers
+      if @data =~ /^STORE_VALUE\((:.*)\)$/
+        return Usagi::ApiResponse.store_value($1, other_data)
+      end
+      if @data =~ /^REUSE_VALUE\((:.*)\)$/
+        @data = Usagi::ApiResponse.reuse_value($1)
+        unless @data == other_data
+          raise "non-matching stored data: #{@data}__#{other_data}__"
+        end
+        return true
+      end
+
+      # usagi_matchers
+      if matcher_and_args = Usagi.matchers.find_from_scenario(@data)
+        matcher, args = *matcher_and_args
+        return true if matcher.matches?(other_data, args)
+      else
+        raise "non-matching data: (expected: #{@data}, got: #{other_data})" unless @data.class == other_data.class
+        case @data.class.to_s
+        when 'Array'
+          raise "non-matching array length (expected: #{@data.length}, got #{other_data.length})" unless @data.length == other_data.length
+          raise "non-matching arrays (expected: #{@data}, got: #{other_data})" unless @data.each_with_index.all? do |value, i|
+            Usagi::ApiResponse.new(value) == other_data[i]
+          end
+        when 'Hash'
+          exp_keys = @data.keys.map(&:to_sym) - Usagi::ApiResponse.unmatchable_keys
+          got_keys = other_data.keys.map(&:to_sym) - Usagi::ApiResponse.unmatchable_keys
+          raise "non-matching hash keys (expected: #{exp_keys}, got: #{got_keys}" unless exp_keys.length == got_keys.length
+          raise "non-matching hashes (expected #{@data}, got: #{other_data})" unless @data.all? do |key, value|
+            next true if Usagi::ApiResponse.unmatchable_keys.include?(key)
+            Usagi::ApiResponse.new(value) == other_data[key]
+          end
+        else
+          raise "non-matching data (expected: #{@data}, got: #{other_data})" unless @data == other_data
+        end
+      end
+      true
+    end
+
+    class << self
+      attr_accessor :unmatchable_keys
+      attr_accessor :stored_values
+
+      def unmatchable_keys
+        Usagi.suite_options[:unmatchable_keys] ||%i(created_at updated_at)
+      end
+
+      def reuse_value(name)
+        @stored_values ||= {}
+        unless @stored_values.keys.include?(name) || Usagi.options[:allow_nil_store_values]
+          raise ArgumentError, "stored value name #{name} was never used"
+        end
+        value = @stored_values[name]
+        puts "[usagi][#{Usagi.pid}] REUSE _#{value}_"
+        value
+      end
+
+      def store_value(name, value)
+        @stored_values ||= {}
+        if @stored_values.keys.include?(name) && !Usagi.options[:allow_store_key_reuse]
+          raise ArgumentError, "stored value name #{name} already used"
+        end
+        @stored_values[name] = value
+        puts "[usagi][#{Usagi.pid}] STORE #{name} => #{value}"
+        return true
+      end
+    end
+  end
+end
+

data/lib/usagi/matcher.rb

@@ -0,0 +1,44 @@
+class Matcher
+  attr_accessor :name
+
+  def initialize(name, &block)
+    @name = name
+    @matcher = block
+  end
+
+  def matches?(api_value, args)
+    mi = MatcherInstance.new(@matcher, api_value, args)
+    raise mi.error_message unless mi.matches?
+  end
+
+  class MatcherInstance
+    attr_accessor :api_value, :args
+
+    def initialize(matcher_block, api_value, args)
+      @api_value = api_value
+      instance_exec(*args, &matcher_block)
+    end
+
+    def error_block
+      @error || lambda{|api_value| "non-matching value (got: #{api_value})" }
+    end
+
+    def error_message
+      error_block.call(api_value)
+    end
+
+    def matches?
+      @match.call(api_value)
+    end
+
+    private
+    def error(&block)
+      @error = block
+    end
+
+    def match(&block)
+      @match = block
+    end
+  end
+end
+

data/lib/usagi/matcher_container.rb

@@ -0,0 +1,32 @@
+require_relative 'matcher'
+
+class MatcherContainer
+  extend Enumerable
+
+  def each
+    matchers.each do |matcher|
+      yield matcher
+    end
+  end
+
+  def find_from_scenario(scenario_value)
+    return nil unless scenario_value =~ /^([A-Z_]+)(\(.*\))?$/
+    matcher, args = matchers[$1], $2
+    args = eval("[#{args[1..-2]}]") if args
+    return nil unless matcher
+    [matcher, args]
+  end
+
+  def [](name)
+    matchers[name.to_s.upcase]
+  end
+
+  def []=(name, value)
+    matchers[name.to_s.upcase] = value
+  end
+
+  private
+  def matchers
+    @matchers ||= {}
+  end
+end

data/lib/usagi/rspec.rb

@@ -0,0 +1,43 @@
+RSpec::Matchers.define :usagi_scenario do |*api_declaration|
+  description do
+    api_declaration.first
+  end
+
+  match do |data|
+    api_scenario, api_opts = *api_declaration
+    api_opts = Usagi.suite_options.deep_merge(api_opts || {})
+    current_context = @matcher_execution_context.class.metadata[:description]
+
+    file_path = @matcher_execution_context.class.metadata[:file_path].gsub(/\.rb$/, '.yml')
+    raise "missing scenario file: #{file_path}" unless File.exist?(file_path)
+    scenario = YAML.load_file(file_path)
+    raise "missing context: #{current_context}" unless scenario[current_context]
+    raise "missing scenario: #{current_context}:#{api_scenario}" unless scenario[current_context][api_scenario]
+    scenario = JSON.parse(scenario[current_context][api_scenario].to_json)
+    protocol, path = scenario['query'].split(' ')
+    query = URI.parse(path).query
+    path  = URI.parse(path).path
+    query = Rack::Utils.parse_nested_query(query).merge(api_opts[:query] || {}).to_query
+    post_data = api_opts[:body]
+    headers   = api_opts[:headers]
+
+    full_uri = URI::HTTP.build([
+      nil,
+      "localhost",
+      Usagi.port,
+      path,
+      query,
+      nil
+    ]).to_s
+    data = %[curl --silent -X #{protocol} "#{full_uri}"]
+    data += %[ --data "#{post_data.to_query}"] if post_data && post_data.keys.length > 0
+    headers.each do |key, value|
+      data += %[ -H "#{key}: #{value}"]
+    end if headers
+    puts "REQ__#{data}__" if Usagi.options[:debug_requests]
+    data = `#{data}`
+    puts "RES__#{data}__" if Usagi.options[:debug_requests]
+    data = JSON.parse(data)
+    Usagi::ApiResponse.new(scenario['reply']) == data
+  end
+end

data/lib/usagi/usagi_matchers.rb

@@ -0,0 +1,27 @@
+require_relative 'matcher_container'
+
+Usagi.define_matcher :any_value do
+  match do
+    true
+  end
+end
+
+Usagi.define_matcher :any_value_not_nil do
+  error do
+    "expected to be a non-nil value"
+  end
+
+  match do |api_value|
+    api_value != nil
+  end
+end
+
+Usagi.define_matcher :range do |from, to|
+  error do |api_value|
+    "expected to be in range #{from}..#{to} (got: #{api_value})"
+  end
+
+  match do |api_value|
+    api_value >= from && api_value <= to
+  end
+end

data/usagi.gemspec

@@ -0,0 +1,15 @@
+Gem::Specification.new do |s|
+  s.name        = 'usagi'
+  s.version      = '1.0.0'
+  s.platform     = Gem::Platform::RUBY
+  s.licenses     = ['MIT']
+  s.summary      = '兎 - Usagi is a functional test suite for rails APIs'
+  s.homepage     = 'https://github.com/savemysmartphone/usagi'
+  s.description  = 'Functional test suite for rails APIs'
+  s.authors      = ["Arnaud 'red' Rouyer", "Alice Clavel"]
+
+  s.files        = `git ls-files`.split("\n")
+  s.executables  << 'usagi'
+  s.require_path = 'lib'
+  s.required_ruby_version = '>= 2.0.0'
+end

metadata

@@ -0,0 +1,58 @@
+--- !ruby/object:Gem::Specification
+name: usagi
+version: !ruby/object:Gem::Version
+  version: 1.0.0
+platform: ruby
+authors:
+- Arnaud 'red' Rouyer
+- Alice Clavel
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2015-09-03 00:00:00.000000000 Z
+dependencies: []
+description: Functional test suite for rails APIs
+email: 
+executables:
+- usagi
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- Gemfile
+- Gemfile.lock
+- LICENSE
+- README.md
+- bin/usagi
+- lib/usagi.rb
+- lib/usagi/api_response.rb
+- lib/usagi/matcher.rb
+- lib/usagi/matcher_container.rb
+- lib/usagi/rspec.rb
+- lib/usagi/usagi_matchers.rb
+- usagi.gemspec
+homepage: https://github.com/savemysmartphone/usagi
+licenses:
+- MIT
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: 2.0.0
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.4.6
+signing_key: 
+specification_version: 4
+summary: "兎 - Usagi is a functional test suite for rails APIs"
+test_files: []