rack-test_server 0.1.0 → 0.1.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: fb7b0f9e10d19dc895ee1c4bbe8956a1915db3a608f4ecf9cc9e40f04353ba09
-  data.tar.gz: 4009b6a64fd4254ee6e5beb89f12932a734785eee7b4d6e550eaea56e101252e
+  metadata.gz: f2791fd8d73e918ebc3f60fab74d0f00962c42f523b1b6958ec0adc02c2a7736
+  data.tar.gz: 1c332c69e9975660dfb7098c29e84a47be10f6225b8d42201eefbfe5b96132a4
 SHA512:
-  metadata.gz: 65a25cfe539f001167decc4a20875dec33ba6c7e62bc7ee4e0feae500ce116bbcf9e72d347a5f97af3f9aeb3688e957250642feb6846ea3015f8738e20e95088
-  data.tar.gz: b6a41a945783e53fb00e4799350fc492d7137148e88ca07c6484fb66fccf5cc41019a4df88e0b0d1997a125e5ae501d78fca5050af0a40083154075ae5982c2a
+  metadata.gz: c420c29cc54f9afb3c4aea3ab866837ef0305b07ece9f96e5e8bb680e122c04d5fe119463e5a986cc2adc40e67f8403c96cb5922038b6199af810c7cf6302ba2
+  data.tar.gz: e23ddf59637e0d34a77adaa98621d8714b1c21d570eb29d1601de2fda4153bd815e0564ad0d209864edeedc68d98fdfea05d3151b4a352fb7f331d620e7407cb

data/README.md

@@ -1,38 +1,72 @@
-# Rack::TestServer
-
-Welcome to your new gem! In this directory, you'll find the files you need to be able to package up your Ruby library into a gem. Put your Ruby code in the file `lib/rack/test_server`. To experiment with that code, run `bin/console` for an interactive prompt.
+[![Gem Version](https://badge.fury.io/rb/rack-test_server.svg)](https://badge.fury.io/rb/rack-test_server)
 
-TODO: Delete this and the text above, and describe your gem
-
-## Installation
+# Rack::TestServer
 
-Add this line to your application's Gemfile:
+Just launch HTTP server for testing your Rack application.
 
 ```ruby
-gem 'rack-test_server'
+require 'rack/test_server'
+
+# Configuration with `rackup` compatible options.
+server = Rack::TestServer.new(
+           app: Rails.application,
+           server: :puma,
+           Host: '127.0.0.1',
+           Port: 3000)
+
+before(:suite) do
+  # Just launch it on a Thread
+  server.start_async
+  server.wait_for_ready
+end
 ```
 
-And then execute:
+## Background
 
-    $ bundle
+"System testing", introduced in Rails 5.1, consists of two remarkable features: [Sharing a DB connection](https://github.com/rails/rails/pull/28083) and [Capybara integration](https://github.com/rails/rails/pull/26703).
 
-Or install it yourself as:
+Since transactional fixtures are available by sharing a DB connection, we can see any mocked situation (ex. logged in as admin, receiving a lot of notifications, ...) from real browsers, which dramatically improved the testing experiences. Only one limitations for using this feature is that **we have to launch the HTTP server within the same process as test runnner's**.
 
-    $ gem install rack-test_server
+This library is designed **just for launching Rack application in a Thread**. We can simply use [Selenium](https://rubygems.org/gems/selenium-webdriver), [Playwright](https://playwright-ruby-client.vercel.app/) or other browser automation libraries in system testing, without studying any DSL :)
 
-## Usage
 
-TODO: Write usage instructions here
+## Installation
 
-## Development
+```ruby
+gem 'rack-test_server'
+```
 
-After checking out the repo, run `bin/setup` to install dependencies. Then, run `rake spec` to run the tests. You can also run `bin/console` for an interactive prompt that will allow you to experiment.
+and then `bundle install`.
 
-To install this gem onto your local machine, run `bundle exec rake install`. To release a new version, update the version number in `version.rb`, and then run `bundle exec rake release`, which will create a git tag for the version, push git commits and tags, and push the `.gem` file to [rubygems.org](https://rubygems.org).
+## Usage
 
-## Contributing
+If you are working with Rails application, add configuration like below in spec/support/system_testing_helper.rb:
+
+```ruby
+require 'rack/test_server'
+
+# Configure Rack server
+#
+# options for Rack::Server
+# @see https://github.com/rack/rack/blob/2.2.3/lib/rack/server.rb#L173
+# options for Rack::Handler::Puma
+# @see https://github.com/puma/puma/blob/v5.4.0/lib/rack/handler/puma.rb#L84
+server = Rack::TestServer.new(
+           app: Rails.application,
+           server: :puma,
+           Host: '127.0.0.1',
+           Port: 3000)
+
+RSpec.configure do
+  # Launch Rails application.
+  config.before(:suite) do
+    server.start_async
+    server.wait_for_ready
+  end
+end
+```
 
-Bug reports and pull requests are welcome on GitHub at https://github.com/[USERNAME]/rack-test_server. This project is intended to be a safe, welcoming space for collaboration, and contributors are expected to adhere to the [Contributor Covenant](http://contributor-covenant.org) code of conduct.
+If you are not Rails user, just replace `Rails.application` with your Rack application, and put the configuration file as you prefer. :)
 
 ## License
 

data/Rakefile

@@ -4,7 +4,6 @@ require 'bundler/gem_tasks'
 require 'rake/testtask'
 
 Rake::TestTask.new(:test) do |t|
-  t.libs << 'test'
   t.libs << 'lib'
-  t.test_files = FileList['tests/**/test_*.rb']
+  t.test_files = FileList['test/**/test_*.rb']
 end

data/lib/rack/test_server/version.rb

@@ -2,6 +2,6 @@
 
 module Rack
   class TestServer
-    VERSION = '0.1.0'
+    VERSION = '0.1.1'
   end
 end

data/lib/rack/test_server.rb

@@ -6,16 +6,15 @@ require 'timeout'
 require 'rack/test_server/version'
 
 module Rack
-  # An utility class for launching HTTP server with Rack::Server.start
+  # An utility class for launching HTTP server with Rack::Server#start
   # and waiting for the server available with checking a healthcheck endpoint with net/http.
   #
   # The most typical usage is:
   #
-  # ```
-  # server = Rack::TestServer.new(app: myapp, Port: 3000)
-  # server.start_async
-  # server.wait_for_ready
-  # ```
+  #     server = Rack::TestServer.new(app: myapp, Port: 3000)
+  #     server.start_async
+  #     server.wait_for_ready
+  #
   class TestServer
     # @param app [Proc] Rack application to run.
     #
@@ -32,7 +31,7 @@ module Rack
       @port = @server.options[:Port] || @server.default_options[:Port]
     end
 
-    # @returns [String]
+    # @return [String]
     def base_url
       if @host == '0.0.0.0'
         "http://127.0.0.1:#{@port}"
@@ -41,8 +40,9 @@ module Rack
       end
     end
 
-    # Start HTTP server.
-    # Note that this method will block the thread, and in most cases #start_async is suitable.
+    # Start HTTP server with blocking current thread.
+    #
+    # @note This method will block the thread, and in most cases {#start_async} is suitable.
     def start
       @server.start do |server|
         # server can be a Puma::Launcher, Webrick::Server, Thin::Server
@@ -52,26 +52,25 @@ module Rack
       end
     end
 
-    # Start HTTP server.
-    # This method is typically used together with `#wait_for_ready` method.
+    # Start HTTP server, typically used together with {#wait_for_ready} method.
+    #
+    #     server = Rack::TestServer.new(app: myapp)
+    #     server.start_async
+    #     server.wait_for_ready
     #
-    # ```
-    # server = Rack::TestServer.new(app: myapp)
-    # server.start_async
-    # server.wait_for_ready
-    # ```
     def start_async
       Thread.new { start }
     end
 
-    # Stop HTTP server
-    # This method doesn't always wait for the shutdown process,
-    # and use #wait_for_stopped to ensure the server is actually stopped.
+    # Stop HTTP server.
+    #
+    # @note This method doesn't wait for the shutdown process,
+    #  and use {#wait_for_stopped} to ensure the server is actually stopped.
     def stop_async
       Thread.new { @stop_proc.call }
     end
 
-    # @returns [true|false]
+    # @return [Boolean]
     #
     # Check if HTTP server actually responds.
     def ready?

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: rack-test_server
 version: !ruby/object:Gem::Version
-  version: 0.1.0
+  version: 0.1.1
 platform: ruby
 authors:
 - YusukeIwaki
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2021-09-11 00:00:00.000000000 Z
+date: 2021-09-20 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rack
@@ -126,9 +126,6 @@ files:
 - lib/rack/test_server.rb
 - lib/rack/test_server/version.rb
 - rack-test_server.gemspec
-- tests/test_launch_server.rb
-- tests/test_stop_server.rb
-- tests/test_version.rb
 homepage: https://github.com/YusukeIwaki/rack-test_server
 licenses:
 - MIT

data/tests/test_launch_server.rb

@@ -1,49 +0,0 @@
-# frozen_string_literal: true
-
-require 'minitest/autorun'
-require 'rack/test_server'
-require 'sinatra/base'
-
-class TestLaunchServer < Minitest::Test
-  class MyApp < Sinatra::Base
-    get('/') { '<h1>It works!</h1>' }
-  end
-
-  def _test(server)
-    server.start_async
-    server.wait_for_ready
-
-    html = Net::HTTP.get(URI("#{server.base_url}/"))
-    assert_equal '<h1>It works!</h1>', html
-  end
-
-  def test_launch_without_no_options
-    server = Rack::TestServer.new(app: MyApp)
-    _test(server)
-  end
-
-  def test_launch_with_port
-    server = Rack::TestServer.new(app: MyApp, Port: 8001)
-    _test(server)
-  end
-
-  def test_launch_with_host_and_port
-    server = Rack::TestServer.new(app: MyApp, Host: '127.0.0.1', Port: 8002)
-    _test(server)
-  end
-
-  def test_launch_webrick
-    server = Rack::TestServer.new(app: MyApp, Port: 8003, server: :webrick)
-    _test(server)
-  end
-
-  def test_launch_puma
-    server = Rack::TestServer.new(app: MyApp, Port: 8004, server: :puma)
-    _test(server)
-  end
-
-  def test_launch_thin
-    server = Rack::TestServer.new(app: MyApp, Port: 8005, server: :thin)
-    _test(server)
-  end
-end

data/tests/test_stop_server.rb

@@ -1,39 +0,0 @@
-# frozen_string_literal: true
-
-require 'minitest/autorun'
-require 'rack/test_server'
-
-class TestStopServer < Minitest::Test
-  APP = ->(_env) { [200, {}, 'OK'] }
-
-  def _test(server)
-    assert !server.ready?
-
-    server.start_async
-    server.wait_for_ready
-    assert server.ready?
-
-    server.stop_async
-    server.wait_for_stopped
-    assert !server.ready?
-
-    server.start_async
-    server.wait_for_ready
-    assert server.ready?
-  end
-
-  def test_stop_puma
-    server = Rack::TestServer.new(app: APP, server: :puma, Port: 8081)
-    _test(server)
-  end
-
-  def test_stop_webrick
-    server = Rack::TestServer.new(app: APP, server: :webrick, Port: 8082)
-    _test(server)
-  end
-
-  def test_stop_thin
-    server = Rack::TestServer.new(app: APP, server: :thin, Port: 8083)
-    _test(server)
-  end
-end

data/tests/test_version.rb

@@ -1,11 +0,0 @@
-# frozen_string_literal: true
-
-require 'minitest/autorun'
-require 'rack/test_server/version'
-
-class TestVersion < Minitest::Test
-  def test_version_present
-    version = Gem::Version.new(Rack::TestServer::VERSION)
-    assert version >= Gem::Version.new('0.0.1')
-  end
-end