http-test 0.1.1 → 0.1.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 8c7b8727e630d398176de4c83f39c70e90fc1182
-  data.tar.gz: fd07f66e8928769800d0154515dd0ed8fec0fdba
+  metadata.gz: 7576a8a3222da33e7a0bf12deb38ff10349c6c10
+  data.tar.gz: 443c40c55cfbd964ed1c2042d90796429418680a
 SHA512:
-  metadata.gz: 3617c260c1ad84634e743238c3dd370abfcfd8c22b8cf6c4c979171a976a601c31b50ae72c94917371f4578a7aef5673863777b2fd030d1119cd937da0cd2fd8
-  data.tar.gz: 771e08efc9794c15fc106eb46e870e205b4e0f0c32caa61b54027c4263cf425ebdac4411d3112b0a5c0d9f4b03c29c916591ecc56af2e5e0302e9e5590e4c983
+  metadata.gz: 5ed39001ef88bc2599acf94e4bed1be3679a4179d4b631bb6c96fc93ca0a0516d4670cec6f4fba05179d5d602ad55fce94a8a124706a8d9144d616f2de334130
+  data.tar.gz: 0faeccf5395a928a6f4009ffe3ff91a038fdcbfd3b67d4d0a1e55e601df2ca034665bcb4aa05043b6abc63ac0a1ec0c31575b03c2ffde83d05aa69f61028a178

data/README.md

@@ -53,8 +53,26 @@ to start the server in a non-daemonized mode.
 
 **Limitations:**
 
-- The command should read the PORT to listen on from the "PORT" environment value.
-- Currently the only supported port is 4444. Expect this to change to a randomized port number.
+- test servers are always running locally. The port is determined randomly by http-test.
+- The command must read the PORT environment value to determine which port to listen on.
+- When being killed the command must kill all its children. For simple servers this is not a problem; for daemonizing servers or servers that start worker processes you might want to add a shell script which sets up servers correctly. This, for example, is a script which properly deals with a phoenix server:
+
+        #!/bin/bash
+        set -eu
+        
+        HERE="$(cd "$(dirname "${BASH_SOURCE[0]}")" && pwd)"
+        cd $HERE
+        
+        _term() { 
+          echo "Caught SIGTERM signal!" 
+          kill -TERM "$child" 2>/dev/null
+        }
+        
+        trap _term SIGTERM
+        mix phoenix.server &
+        
+        child=$! 
+        wait "$child"
 
 ## Development
 
@@ -62,6 +80,10 @@ After checking out the repo, run `bin/setup` to install dependencies. Then, run
 
 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).
 
+Some of these tests talk to a remote server at http://jsonplaceholder.typicode.com. To skip these tests run rake with the following command:
+
+    SKIP_REMOTE_TESTS=1 rake
+
 ## Contributing
 
 Bug reports and pull requests are welcome on GitHub at https://github.com/radiospiel/http-test.

data/lib/http-test.rb

@@ -2,32 +2,68 @@ require "test-unit"
 require "forwardable"
 
 module HttpTest
-  PORT = 4444
+  def self.start_session(session_parameters)
+    url_base, command = session_parameters.values_at :url_base, :command
+    @session = Session.start! url_base: url_base, command: command
+  end
+
+  def self.stop_session
+    @session = nil
+  end
+
+  def self.url_base
+    return @session.url_base if @session
 
-  def self.url_base(url_base = nil)
-    @url_base = url_base if url_base
-    return @url_base if @url_base
     STDERR.puts <<-MSG
 Either define a API endpoint via url_base <url>, or define a command to start a test_server via test_server "command"'
     MSG
-    exit 1
+    #STDERR.puts "called from\n\t#{caller[0,6].join("\n\t")}"
+    raise "Missing session definition"
   end
 
-  def self.test_server(command)
-    Server.start!(command)
-    url_base "http://localhost:#{PORT}"
-  end
+  # ---------------------------------------------------------------------------
 
   module TestUnitAdapter
-    extend Forwardable
+    module ClassMethods
+      attr_accessor :session_parameters
+    end
+
+    def self.extended(base)
+      base.extend ClassMethods
+    end
+
+    def url_base(url_base)
+      class << self
+        def startup
+          HttpTest.start_session(session_parameters)
+        end
+
+        def shutdown
+          HttpTest.stop_session
+        end
+      end
+
+      self.session_parameters = { url_base: url_base }
+    end
+
+    def test_server(command)
+      class << self
+        def startup
+          HttpTest.start_session(session_parameters)
+        end
+
+        def shutdown
+          HttpTest.stop_session
+        end
+      end
 
-    delegate url_base: HttpTest
-    delegate test_server: HttpTest
+      self.session_parameters = { command: command }
+    end
   end
 end
 
 require_relative "http-test/http_methods"
-require_relative "http-test/server"
+require_relative "http-test/session"
 
 class HttpTest::TestCase < Test::Unit::TestCase
   include HttpTest::HttpMethods # include HTTP helper methods, like GET, PUT etc.

data/lib/http-test/server.rb

@@ -1,63 +1,55 @@
-require "socket"
-require "timeout"
+require_relative "server/port"
 
 module HttpTest::Server
   extend self
 
-  PORT = HttpTest::PORT
+  # Kills the current server process and checks that the port becomes unavailable.
+  def kill!
+    return unless @pid
 
-  def available!(timeout = 0.1)
-    s = nil
-    Timeout.timeout(timeout) do
-      STDERR.print "."
-      s = TCPSocket.new("127.0.0.1", PORT)
+    Process.kill("TERM", @pid)
+    Process.wait
+
+    if @port && Port.available?(@port)
+      STDERR.puts "Could not stop server"
+      exit 1
     end
 
-    STDERR.puts "[http-test] test server became available on http://127.0.0.1:#{PORT}"
-  ensure
-    s&.close
+    @port = nil
+    @pid = nil
   end
 
-  def available?(timeout = 0.1)
-    available!(timeout)
-    true
-  rescue Errno::ECONNREFUSED, Errno::EHOSTUNREACH, Timeout::Error
-    false
+  def url_base
+    "http://127.0.0.1:#{@port}"
   end
 
-  def wait_for_port(timeout = 10)
-    (timeout / 0.1).to_i.times do
-      return true if available?(PORT)
-      sleep(0.1)
-    end
+  def start!(command)
+    return if @started == command && @port
 
-    available!
-  end
+    kill! if @started
 
-  def started?
-    @started ? true : false
-  end
+    started_at = Time.now
 
-  def start!(command)
-    return if started?
+    @port = Port.choose
 
-    pid = fork do
+    @pid = fork do
       # Signal.trap("HUP") { STDERR.puts "Exiting web server"; exit }
       # # ... do some work ...
       ENV["RACK_ENV"] = "test"
-      ENV["PORT"] = PORT.to_s
+      ENV["PORT"] = @port.to_s
 
       exec command
     end
 
-    STDERR.puts "[http-test] Trying to start test server via '#{command}', as pid: #{pid}"
+    Port.wait(@port)
 
-    at_exit do
-      Process.kill("TERM", pid)
-      Process.wait
-    end
+    secs = Time.now - started_at
+    STDERR.puts "\n[http-test##{@pid}] test server '#{command}' running on #{url_base} after #{'%.3f secs' % secs}"
 
-    wait_for_port
-    @started = true
+    @started = command
   end
 end
+
+at_exit do
+  HttpTest::Server.kill!
+end

data/lib/http-test/server/port.rb

@@ -0,0 +1,52 @@
+require "socket"
+require "timeout"
+
+# helper methods for port handling ---------------------------------------
+module HttpTest
+  module Server
+    module Port
+      extend self
+
+      # return an unused port.
+      def choose
+        server = TCPServer.new('127.0.0.1', 0)
+        port = server.addr[1]
+      ensure
+        # don't know if this is really necessary
+        server&.close
+      end
+
+      # is a given port available? This raises ECONNREFUSED or EHOSTUNREACH if not,
+      # and Timeout::Error if we don't know.
+      def available!(port, timeout = 0.1)
+        s = nil
+        Timeout.timeout(timeout) do
+          STDERR.print "."
+          s = TCPSocket.new("127.0.0.1", port)
+        end
+      ensure
+        s&.close
+      end
+
+      # is a given port available? This returns true if so, and false if not or unsure.
+      def available?(port, timeout = 0.1)
+        available!(port, timeout)
+        true
+      rescue Errno::ECONNREFUSED, Errno::EHOSTUNREACH, Timeout::Error
+        false
+      end
+
+      # wait until a port becomes available. Raises either ECONNREFUSED, EHOSTUNREACH, 
+      # or Timeout::Error if the port cannot be established.
+      def wait(port, timeout = 10)
+        (timeout / 0.1).to_i.times do
+          return true if available?(port)
+          sleep(0.1)
+        end
+
+        available!(port)
+      end
+    end
+  end
+end
+

data/lib/http-test/session.rb

@@ -0,0 +1,32 @@
+require_relative "server"
+
+module HttpTest
+  # A session of the test server. Note that one might think that a session would
+  # holds its own test server instance; we do, however, reuse servers between
+  # tests in case multiple test cases use the same test server - which is quite
+  # likely the most common use case. 
+  class Session
+    attr_reader :url_base
+    attr_reader :command
+
+    def initialize(url_base: nil, command: nil)
+      @url_base = url_base
+      @command  = command
+    end
+
+    private
+
+    def start!
+      return unless @command
+
+      Server.start! @command
+      @url_base = Server.url_base
+    end
+
+    def self.start!(url_base: nil, command: nil)
+      session = Session.new url_base: url_base, command: command
+      session.send :start!
+      session
+    end
+  end
+end

data/lib/http-test/version.rb

@@ -1,3 +1,3 @@
 module HttpTest
-  VERSION = "0.1.1"
+  VERSION = "0.1.2"
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: http-test
 version: !ruby/object:Gem::Version
-  version: 0.1.1
+  version: 0.1.2
 platform: ruby
 authors:
 - eno
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2017-01-17 00:00:00.000000000 Z
+date: 2017-01-18 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: faraday
@@ -86,6 +86,8 @@ files:
 - lib/http-test.rb
 - lib/http-test/http_methods.rb
 - lib/http-test/server.rb
+- lib/http-test/server/port.rb
+- lib/http-test/session.rb
 - lib/http-test/version.rb
 homepage: 
 licenses: