hobby-test 0.0.0 → 0.0.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 166b6d9643f2120ba363ed8b12a3c9a15557dcb7
-  data.tar.gz: a1982ba0b5dfb002f03f35651dce123fa0233f15
+  metadata.gz: 6630ab85ce09d1fbd6661bd8ec6201e66a73c197
+  data.tar.gz: 7547c087095c379e16aafe99a62fb72dddedfba6
 SHA512:
-  metadata.gz: dbe0f5a1e37ce0e1caa14d74c834e196fc9aa115dee2defe79c4a0f1d3b566e9504a2cee03f2251d578f625ac6fa87b0cfe893981913e29b41eba87d2b102fe8
-  data.tar.gz: 769282da8aa96c7bc4efeb913a866830074552f7f87a179ebe349c29f45f5e33b53016f49e1353a504dbe3eb1fc99950be97ec4a0b9b85eedf8a217d9053a429
+  metadata.gz: 4f2d0e876e7b6e10990418aa0318aeca79189b30f9953eb24c50fe2d212110a0c4603e5d00a5d061bb9a01f3f18219c11a07369dbbd91c6fcbb7149c3b745fa7
+  data.tar.gz: 6f4c9b2756eb6fd613ed6ef211a208f5ef78eb74aa81312f81da11e0d5715dc8b86da986ab0aa2cd745e3a2d4ecc6bc1f27c14d2eff4bdc92a86083d9502d141

data/.gitignore

@@ -0,0 +1 @@
+Gemfile.lock

data/Gemfile

@@ -0,0 +1,15 @@
+source 'https://rubygems.org'
+
+gem 'hobby'
+gem 'hobby-json'
+gem 'rspec'
+gem 'minitest'
+gem 'minitest-power_assert'
+gem 'pry'
+gem 'awesome_print'
+gem 'puma'
+gem 'mutant'
+gem 'mutant-rspec'
+gem 'tra'
+
+gemspec

data/debug.rb

@@ -0,0 +1,7 @@
+require 'puma'
+require_relative 'spec/apps/main'
+
+server = Puma::Server.new MainApp.new
+server.add_unix_listener 'debug.socket'
+server.run
+sleep

data/hobby-test.gemspec

@@ -0,0 +1,10 @@
+Gem::Specification.new do |g|
+  g.name    = 'hobby-test'
+  g.files   = `git ls-files`.split($/)
+  g.version = '0.0.1'
+  g.summary = 'A way to test HTTP exchanges via YAML specifications'
+  g.authors = ['Anatoly Chernow']
+
+  g.add_dependency 'excon'
+  g.add_dependency 'to_proc'
+end

data/lib/hobby/test/exchange/assert.rb

@@ -0,0 +1,62 @@
+class Hobby::Test::Exchange
+  module Assert
+    def self.[] pair
+      key, delimiter, chain = pair[0].partition /\.|\[/
+      chain.prepend (delimiter == '[' ? 'self[' : 'self.') unless chain.empty?
+      const_get(key.capitalize).new key, chain, pair[1]
+    end
+
+    def initialize key, chain, value
+      @key, @chain, @specified_value = key, chain, value
+    end
+
+    def ok?
+      @ok
+    end
+    
+    def [] response
+      dup.assert response
+    end
+
+    attr_reader :actual_value, :specified_value, :chain, :key
+
+    class Status
+      include Assert
+
+      def assert response
+        @actual_value = response.public_send key
+        @ok = actual_value == specified_value
+        self
+      end
+    end
+
+    class Body
+      include Assert
+
+      def assert response
+        @actual_value = response.public_send key
+        @actual_value = begin
+                          JSON.parse actual_value
+                        rescue JSON::ParserError
+                          actual_value
+                        end
+
+        @ok = if chain.empty?
+                actual_value == specified_value
+              else
+                compare_chain
+              end
+
+        self
+      end
+
+      def compare_chain
+        if chain.end_with? '>', '=', '<'
+          actual_value.instance_eval "#{chain}(#{specified_value})"
+        else
+          (actual_value.instance_eval chain) == specified_value
+        end
+      end
+    end
+  end
+end

data/lib/hobby/test/exchange/request.rb

@@ -0,0 +1,16 @@
+class Hobby::Test::Exchange
+  class Request < OpenStruct
+    VERBS = %w[delete get head options patch post put]
+    def initialize array
+      @verb = array[0]
+      super array[1]
+    end
+    attr_reader :verb
+
+    def to_hash
+      hash = to_h
+      hash[:body] = hash[:body].to_json
+      hash
+    end
+  end
+end

data/lib/hobby/test/exchange.rb

@@ -0,0 +1,31 @@
+module Hobby
+  class Test
+    class Exchange
+      def initialize hash
+        @request = Request.new hash.find { |key, _|
+          Request::VERBS.include? key
+        }
+        @asserts = (hash['response']&.map &Assert) || []
+      end
+      attr_reader :request, :asserts
+
+      def [] connection
+        dup.run_against connection
+      end
+
+      def ok?
+        asserts.all? &:ok?
+      end
+
+      protected
+        def run_against connection
+          response = connection.public_send request.verb, **request
+          @asserts = asserts.map &[response]
+          self
+        end
+    end
+  end
+end
+
+require 'hobby/test/exchange/request'
+require 'hobby/test/exchange/assert'

data/lib/hobby/test/report.rb

@@ -0,0 +1,17 @@
+module Hobby
+  class Test
+    class Report
+      def initialize exchanges
+        @exchanges = exchanges
+      end
+
+      def ok?
+        @exchanges.all? &:ok?
+      end
+
+      include Enumerable
+      extend Forwardable
+      delegate [:each, :[], :size] => :@exchanges
+    end
+  end
+end

data/lib/hobby/test.rb

@@ -0,0 +1,28 @@
+require 'to_proc/all'
+require 'excon'
+
+require 'yaml'
+require 'json'
+require 'forwardable'
+require 'ostruct'
+
+require 'hobby/test/exchange'
+require 'hobby/test/report'
+
+module Hobby
+  class Test
+    def initialize file
+      @exchanges = (YAML.load_file file).map &Exchange
+    end
+
+    def [] address
+      connection = if address.start_with? 'http'
+                     Excon.new address
+                   else
+                     Excon.new 'unix:///', socket: address
+                   end
+
+      Report.new @exchanges.map &[connection]
+    end
+  end
+end

data/spec/apps/main.rb

@@ -0,0 +1,69 @@
+require 'hobby'
+require 'hobby/json'
+
+class MainApp
+  include Hobby::App
+  get { 'root-only app' }
+
+  class Counter
+    include Hobby::App
+    @@counter = 0
+    get { @@counter }
+    post { @@counter += 1 }
+  end
+  map('/counter') { run Counter.new }
+
+  class Echo
+    include Hobby::App
+    include Hobby::JSON
+
+    get { json }
+  end
+  map('/echo') { run Echo.new }
+  get('/echo-with-query') { request.params.to_json }
+
+  class Query
+    include Hobby::App
+    get { request.params['array'].class }
+  end
+  map('/query') { run Query.new }
+
+  class HashApp
+    include Hobby::App
+    include Hobby::JSON
+    get do
+      {
+        'a' => 1,
+        'b' => 2,
+        'c' => 3
+      }
+    end
+  end
+  map('/hash') { run HashApp.new }
+
+  class ArrayApp
+    include Hobby::App
+    include Hobby::JSON
+    get do
+      [
+        {
+          'first' => {
+            'a' => 0, 'b' => 1
+          },
+          'second' => {
+            'c' => 2, 'd' => 3
+          }
+        },
+        {
+          'first' => {
+            'a' => 5, 'b' => 6
+          },
+          'second' => {
+            'c' => 2, 'd' => 3
+          }
+        }
+      ]
+    end
+  end
+  map('/array') { run ArrayApp.new }
+end

data/spec/auto_spec.rb

@@ -0,0 +1,20 @@
+require 'helper'
+
+describe 'passing and failing YAML specifications' do
+  Dir["spec/yml/**/*.yml"].each do |path|
+    name = path.split('/').last
+    test = Hobby::Test.new path
+
+    if path.include? 'passing'
+      it "passing #{name}" do
+        report = test[@socket]
+        assert { report.ok? }
+      end
+    else
+      it "failing #{name}" do
+        report = test[@socket]
+        assert { not report.ok? }
+      end
+    end
+  end
+end

data/spec/helper.rb

@@ -0,0 +1,30 @@
+require_relative 'setup/power_assert'
+require_relative 'setup/mutant'
+require_relative 'apps/main'
+
+require 'hobby/test'
+require 'puma'
+
+RSpec.configure do |config|
+  config.expect_with :rspec, :minitest
+
+  config.before :each do |example|
+    @socket = "MainApp.for.#{example}.socket"
+    @pid = fork do
+      server = Puma::Server.new MainApp.new
+      server.add_unix_listener @socket
+      server.run
+      sleep
+    end
+
+    sleep 0.01 until File.exist? @socket
+  end
+
+  config.after :each do 
+    `kill #{@pid}`
+  end
+
+  config.after :suite do
+    `rm *.socket` unless Dir['*.socket'].empty?
+  end
+end

data/spec/http/basic.yml

@@ -0,0 +1,14 @@
+- request:
+    verb: get
+    path: /
+
+  response:
+    status: 200
+    body: root-only app
+
+- request:
+    verb: get
+    path: /non-existent
+
+  response:
+    status: 404

data/spec/http/event.yml

@@ -0,0 +1,11 @@
+request:
+  verb: POST
+  data:
+    text: text
+    username: username
+
+response:
+  code: 201
+  body:
+    id: event-endpoint
+    text: txet

data/spec/http/reverse.yml

@@ -0,0 +1,24 @@
+- default:
+    verb: post
+    path: /event
+    format: json
+
+- request:
+    body:
+      text: text
+
+  response:
+    status: 201
+    body:
+      name: ReverseApp
+      text: txet
+
+- request:
+    body:
+      text: reverse
+
+  response:
+    status: 201
+    body:
+      name: ReverseApp
+      text: something entirely else

data/spec/run_mutant.rb

@@ -0,0 +1,70 @@
+# A workaround for
+# https://github.com/mbj/mutant/#the-crash--stuck-problem-mri
+#
+# For Hobby::Test::Report
+# https://gist.github.com/ch1c0t/c5e0a8de8de14d10bec49839fb6e2fee
+# this mutation
+# https://gist.github.com/ch1c0t/c1626fe232032489fad93dab8d3a10c0
+# causes the infinite running.
+#
+# This workaround "solves" it by introducing a timeout enforced
+# from the parent process.
+#
+# With this workaround, Mutant ends its run successfully, but lefts out
+# a process which keeps running in the background. That process, apparently,
+# is forked from the process with the offending mutation.
+# TODO: find out why it happens; create a workaround for the workaround
+# (because killing that process manually every time is too much hassle).
+require 'mutant'
+
+Runner = Mutant::Runner
+Bootstrap = Mutant::Env::Bootstrap
+Integration = Mutant::Integration
+
+require 'tra/run'
+module MyIsolation
+  def self.call &block
+    pid = fork do
+      Process.setproctitle Process.pid.to_s
+      Process.ppid.put block.call
+    end
+    Timeout.timeout(3) { Tra.next }
+  rescue
+    Process.kill :KILL, pid
+    fail Mutant::Isolation::Error
+  ensure
+    Process.waitpid pid
+  end
+end
+
+class MyIntegration
+  def initialize _config
+  end
+  
+  def setup
+    self
+  end
+end
+
+DEFAULT = Mutant::Config::DEFAULT
+config = DEFAULT.with \
+  matcher: DEFAULT.matcher.add(:match_expressions, DEFAULT.expression_parser.(ARGV[0])),
+  integration: Integration.setup(Kernel, 'rspec'),
+  isolation: MyIsolation
+
+#Runner.call Bootstrap.call config
+
+env = Bootstrap.call config
+puts "#{env.mutations.size} mutations are to be checked."
+result_mutations = env.mutations.map.with_index 1 do |mutation, index|
+  puts index
+  env.kill mutation
+end
+
+failed_mutations = result_mutations.reject &:success?
+if failed_mutations.empty?
+  puts 'Covered.'
+else
+  require 'pry'
+  failed_mutations.__binding__.pry
+end

data/spec/setup/mutant.rb

@@ -0,0 +1,24 @@
+if defined? Mutant::CLI
+  module Mutant
+    class Selector::Expression
+      def call _subject
+        integration.all_tests
+      end
+    end
+
+    require 'timeout'
+    class Isolation::Fork
+      def parent reader, writer, &block
+        pid = process.fork do
+          child reader, writer, &block
+        end
+
+        writer.close
+        Timeout::timeout(3) { marshal.load reader }
+      ensure
+        process.kill :KILL, pid
+        process.waitpid pid
+      end
+    end
+  end
+end

data/spec/setup/power_assert.rb

@@ -0,0 +1,19 @@
+require 'minitest'
+require 'minitest-power_assert'
+
+assert = if ENV['PRY']
+  require 'pry'
+  require 'awesome_print'
+
+  Module.new do
+    def assert &block
+      PowerAssert.start Proc.new, assertion_method: __method__ do |pa|
+        block.binding.pry unless pa.yield
+      end
+    end
+  end
+else
+  Minitest::PowerAssert::Assertions
+end
+
+Minitest::Assertions.prepend assert

data/spec/tcp_spec.rb

@@ -0,0 +1,28 @@
+describe Hobby::Test do
+  before do
+    @tcp_pid = fork do
+      server = Puma::Server.new MainApp.new
+      server.add_tcp_listener 'localhost', 8080
+      server.run
+      sleep
+    end
+
+    begin
+      Excon.get 'http://localhost:8080'
+    rescue
+      sleep 0.01
+      retry
+    end
+
+  end
+
+  after do
+    `kill #{@tcp_pid}`
+  end
+
+  it 'in case of success' do
+    test = described_class.new 'spec/yml/passing/0.yml'
+    report = test['http://localhost:8080']
+    assert { report.ok? }
+  end
+end

data/spec/yml/failing/0.yml

@@ -0,0 +1,12 @@
+- get:
+    path: /
+
+  response:
+    status: 200
+    body: root-only app
+
+- get:
+    path: /non-existent
+
+  response:
+    status: 200

data/spec/yml/passing/0.yml

@@ -0,0 +1,12 @@
+- get:
+    path: /
+
+  response:
+    status: 200
+    body: root-only app
+
+- get:
+    path: /non-existent
+
+  response:
+    status: 404

data/spec/yml/passing/chain_assertions.yml

@@ -0,0 +1,36 @@
+- get:
+    path: /hash
+
+  response:
+    body:
+      a: 1
+      b: 2
+      c: 3
+    body.>:
+      a: 1
+    body.size: 3
+    body['b']: 2
+
+- get:
+    path: /array
+
+  response:
+    body:
+      - first:
+          a: 0
+          b: 1
+        second:
+          c: 2
+          d: 3
+      - first:
+          a: 5
+          b: 6
+        second:
+          c: 2
+          d: 3
+    body.size: 2
+    body[1]['first']:
+      a: 5
+      b: 6
+    body[1]['first'].>:
+      a: 5

data/spec/yml/passing/counter.yml

@@ -0,0 +1,11 @@
+- post:
+    path: /counter
+
+- post:
+    path: /counter
+
+- get:
+    path: /counter
+
+  response:
+    body: "2"

data/spec/yml/passing/echo.yml

@@ -0,0 +1,23 @@
+- get:
+    path: /echo-with-query
+    query:
+      first: one
+      second: two
+
+  response:
+    status: 200
+    body:
+      first: one
+      second: two
+
+- get:
+    path: /echo
+    body:
+      first: one
+      second: two
+
+  response:
+    status: 200
+    body:
+      first: one
+      second: two

data/spec/yml/passing/query.yml

@@ -0,0 +1,8 @@
+- get:
+    path: /query
+    query:
+      array: [1, 2]
+
+  response:
+    status: 200
+    body: String

data/useful_links

@@ -0,0 +1,3 @@
+https://github.com/excon/excon
+http://blog.paulrugelhiatt.com/ruby/testing/rspec/2014/11/28/improving-rspec-test-clarity-with-yaml-expectations.html
+http://rspec-api.github.io/

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: hobby-test
 version: !ruby/object:Gem::Version
-  version: 0.0.0
+  version: 0.0.1
 platform: ruby
 authors:
 - Anatoly Chernow
@@ -43,7 +43,33 @@ email:
 executables: []
 extensions: []
 extra_rdoc_files: []
-files: []
+files:
+- ".gitignore"
+- Gemfile
+- debug.rb
+- hobby-test.gemspec
+- lib/hobby/test.rb
+- lib/hobby/test/exchange.rb
+- lib/hobby/test/exchange/assert.rb
+- lib/hobby/test/exchange/request.rb
+- lib/hobby/test/report.rb
+- spec/apps/main.rb
+- spec/auto_spec.rb
+- spec/helper.rb
+- spec/http/basic.yml
+- spec/http/event.yml
+- spec/http/reverse.yml
+- spec/run_mutant.rb
+- spec/setup/mutant.rb
+- spec/setup/power_assert.rb
+- spec/tcp_spec.rb
+- spec/yml/failing/0.yml
+- spec/yml/passing/0.yml
+- spec/yml/passing/chain_assertions.yml
+- spec/yml/passing/counter.yml
+- spec/yml/passing/echo.yml
+- spec/yml/passing/query.yml
+- useful_links
 homepage: 
 licenses: []
 metadata: {}