rack-test_server 0.1.0

checksums.yaml

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

data/.travis.yml

@@ -0,0 +1,7 @@
+---
+sudo: false
+language: ruby
+cache: bundler
+rvm:
+  - 2.6.3
+before_install: gem install bundler -v 1.17.2

data/CODE_OF_CONDUCT.md

@@ -0,0 +1,74 @@
+# Contributor Covenant Code of Conduct
+
+## Our Pledge
+
+In the interest of fostering an open and welcoming environment, we as
+contributors and maintainers pledge to making participation in our project and
+our community a harassment-free experience for everyone, regardless of age, body
+size, disability, ethnicity, gender identity and expression, level of experience,
+nationality, personal appearance, race, religion, or sexual identity and
+orientation.
+
+## Our Standards
+
+Examples of behavior that contributes to creating a positive environment
+include:
+
+* Using welcoming and inclusive language
+* Being respectful of differing viewpoints and experiences
+* Gracefully accepting constructive criticism
+* Focusing on what is best for the community
+* Showing empathy towards other community members
+
+Examples of unacceptable behavior by participants include:
+
+* The use of sexualized language or imagery and unwelcome sexual attention or
+advances
+* Trolling, insulting/derogatory comments, and personal or political attacks
+* Public or private harassment
+* Publishing others' private information, such as a physical or electronic
+  address, without explicit permission
+* Other conduct which could reasonably be considered inappropriate in a
+  professional setting
+
+## Our Responsibilities
+
+Project maintainers are responsible for clarifying the standards of acceptable
+behavior and are expected to take appropriate and fair corrective action in
+response to any instances of unacceptable behavior.
+
+Project maintainers have the right and responsibility to remove, edit, or
+reject comments, commits, code, wiki edits, issues, and other contributions
+that are not aligned to this Code of Conduct, or to ban temporarily or
+permanently any contributor for other behaviors that they deem inappropriate,
+threatening, offensive, or harmful.
+
+## Scope
+
+This Code of Conduct applies both within project spaces and in public spaces
+when an individual is representing the project or its community. Examples of
+representing a project or community include using an official project e-mail
+address, posting via an official social media account, or acting as an appointed
+representative at an online or offline event. Representation of a project may be
+further defined and clarified by project maintainers.
+
+## Enforcement
+
+Instances of abusive, harassing, or otherwise unacceptable behavior may be
+reported by contacting the project team at iwaki@i3-systems.com. All
+complaints will be reviewed and investigated and will result in a response that
+is deemed necessary and appropriate to the circumstances. The project team is
+obligated to maintain confidentiality with regard to the reporter of an incident.
+Further details of specific enforcement policies may be posted separately.
+
+Project maintainers who do not follow or enforce the Code of Conduct in good
+faith may face temporary or permanent repercussions as determined by other
+members of the project's leadership.
+
+## Attribution
+
+This Code of Conduct is adapted from the [Contributor Covenant][homepage], version 1.4,
+available at [http://contributor-covenant.org/version/1/4][version]
+
+[homepage]: http://contributor-covenant.org
+[version]: http://contributor-covenant.org/version/1/4/

data/Gemfile

@@ -0,0 +1,8 @@
+# frozen_string_literal: true
+
+source 'https://rubygems.org'
+
+git_source(:github) { |repo_name| "https://github.com/#{repo_name}" }
+
+# Specify your gem's dependencies in rack-test_server.gemspec
+gemspec

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2021 YusukeIwaki
+
+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,43 @@
+# 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.
+
+TODO: Delete this and the text above, and describe your gem
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'rack-test_server'
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install rack-test_server
+
+## Usage
+
+TODO: Write usage instructions here
+
+## Development
+
+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.
+
+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).
+
+## Contributing
+
+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.
+
+## License
+
+The gem is available as open source under the terms of the [MIT License](https://opensource.org/licenses/MIT).
+
+## Code of Conduct
+
+Everyone interacting in the Rack::TestServer project’s codebases, issue trackers, chat rooms and mailing lists is expected to follow the [code of conduct](https://github.com/[USERNAME]/rack-test_server/blob/master/CODE_OF_CONDUCT.md).

data/Rakefile

@@ -0,0 +1,10 @@
+# frozen_string_literal: true
+
+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']
+end

data/bin/console

@@ -0,0 +1,15 @@
+#!/usr/bin/env ruby
+# frozen_string_literal: true
+
+require 'bundler/setup'
+require 'rack/test_server'
+
+# You can add fixtures and/or initialization code here to make experimenting
+# with your gem easier. You can also use a different console, if you like.
+
+# (If you use this, don't forget to add pry to your Gemfile!)
+# require "pry"
+# Pry.start
+
+require 'irb'
+IRB.start(__FILE__)

data/bin/setup

@@ -0,0 +1,8 @@
+#!/usr/bin/env bash
+set -euo pipefail
+IFS=$'\n\t'
+set -vx
+
+bundle install
+
+# Do any other automated setup that you need to do here

data/lib/rack/test_server/version.rb

@@ -0,0 +1,7 @@
+# frozen_string_literal: true
+
+module Rack
+  class TestServer
+    VERSION = '0.1.0'
+  end
+end

data/lib/rack/test_server.rb

@@ -0,0 +1,102 @@
+# frozen_string_literal: true
+
+require 'net/http'
+require 'rack'
+require 'timeout'
+require 'rack/test_server/version'
+
+module Rack
+  # 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
+  # ```
+  class TestServer
+    # @param app [Proc] Rack application to run.
+    #
+    # Available options can be found here: https://github.com/rack/rack/blob/2.2.3/lib/rack/server.rb#L173
+    def initialize(app:, **options)
+      testapp = Rack::Builder.app(app) do
+        map '/__ping' do
+          run ->(_env) { [200, { 'Content-Type' => 'text/plain' }, ['OK']] }
+        end
+      end
+
+      @server = Rack::Server.new(app: testapp, **options)
+      @host = @server.options[:Host] || @server.default_options[:Host]
+      @port = @server.options[:Port] || @server.default_options[:Port]
+    end
+
+    # @returns [String]
+    def base_url
+      if @host == '0.0.0.0'
+        "http://127.0.0.1:#{@port}"
+      else
+        "http://#{@host}:#{@port}"
+      end
+    end
+
+    # Start HTTP server.
+    # Note that 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
+        # They all happen to have 'stop' method for greaceful shutdown.
+        # Remember the method as Proc here for stopping server manually.
+        @stop_proc = -> { server.stop }
+      end
+    end
+
+    # Start HTTP server.
+    # This method is typically used together with `#wait_for_ready` method.
+    #
+    # ```
+    # 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.
+    def stop_async
+      Thread.new { @stop_proc.call }
+    end
+
+    # @returns [true|false]
+    #
+    # Check if HTTP server actually responds.
+    def ready?
+      Net::HTTP.get(URI("#{base_url}/__ping"))
+      true
+    rescue Errno::EADDRNOTAVAIL
+      false
+    rescue Errno::ECONNREFUSED
+      false
+    rescue Errno::EINVAL
+      false
+    end
+
+    # This method blocks until the HTTP server is ensured to respond to HTTP request.
+    def wait_for_ready(timeout: 3)
+      Timeout.timeout(timeout) do
+        sleep 0.1 until ready?
+      end
+    end
+
+    # This method returns after the server is shutdown.
+    def wait_for_stopped(timeout: 5)
+      Timeout.timeout(timeout) do
+        sleep 0.1 if ready?
+      end
+    end
+  end
+end

data/rack-test_server.gemspec

@@ -0,0 +1,34 @@
+# frozen_string_literal: true
+
+lib = File.expand_path('lib', __dir__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'rack/test_server/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = 'rack-test_server'
+  spec.version       = Rack::TestServer::VERSION
+  spec.authors       = ['YusukeIwaki']
+  spec.email         = ['q7w8e9w8q7w8e9@yahoo.co.jp']
+
+  spec.summary       = 'Simple HTTP server launcher for Rack application (Sinatra, Rails, etc...)'
+  spec.homepage      = 'https://github.com/YusukeIwaki/rack-test_server'
+  spec.license       = 'MIT'
+
+  spec.files         = Dir.chdir(File.expand_path(__dir__)) do
+    `git ls-files -z`.split("\x0").reject do |f|
+      f.match(%r{^(test|spec|features)/}) || f.include?('.git')
+    end
+  end
+  spec.bindir        = 'exe'
+  spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
+  spec.require_paths = ['lib']
+
+  spec.required_ruby_version = '>= 2.3'
+  spec.add_dependency 'rack'
+  spec.add_development_dependency 'minitest'
+  spec.add_development_dependency 'puma'
+  spec.add_development_dependency 'rake'
+  spec.add_development_dependency 'sinatra'
+  spec.add_development_dependency 'thin'
+  spec.add_development_dependency 'webrick'
+end

data/tests/test_launch_server.rb

@@ -0,0 +1,49 @@
+# 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

@@ -0,0 +1,39 @@
+# 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

@@ -0,0 +1,11 @@
+# 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

metadata

@@ -0,0 +1,155 @@
+--- !ruby/object:Gem::Specification
+name: rack-test_server
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- YusukeIwaki
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2021-09-11 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: rack
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: minitest
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: puma
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: sinatra
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: thin
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: webrick
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+description: 
+email:
+- q7w8e9w8q7w8e9@yahoo.co.jp
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".travis.yml"
+- CODE_OF_CONDUCT.md
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- bin/console
+- bin/setup
+- 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
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '2.3'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 3.2.22
+signing_key: 
+specification_version: 4
+summary: Simple HTTP server launcher for Rack application (Sinatra, Rails, etc...)
+test_files: []