percy-common 1.3.0 → 1.4.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 843bb5ade878a82fa046f8024a37273a363310f0
-  data.tar.gz: 36f86e902963f0b3f209836b980428ef21e76334
+  metadata.gz: da785e6e731d99a3e9a2443232e3dafc8f9e7139
+  data.tar.gz: 662d50ea490653c199ca08a243348e0c41340bae
 SHA512:
-  metadata.gz: bef3758204d4b3ca170ca2b7c49636f54d623f8c26c2f8d5bb53d41feda0fb62068f92f52a26439f2ddb179839d3256644c34e68fbc39ac3b34b88df92218514
-  data.tar.gz: 2104a221fc389ddccd5a9c2e0efaed5e74c97733725e714f5b6e2527c92838bdc5820b6cffe89018f1fbc3b10ea79d4dec01520bdf5392eb2fbfbd090a678834
+  metadata.gz: 101b3fda6f5c3fe97a81e6539eb5bbdd7f77ae720ebe19a808fe91d0231d6f5e7376291a12ce1091339c03c5a498a8fb6fc2e1113fb340ac8a2c38d77dde1a98
+  data.tar.gz: 4d23ec8e50cba05655c1dad3a3396d556bcb4904d21df120d2622e1f60f147d4073b99050ffd7ca2441d8156a8e6a3cfe4c118207c5bc5718c715eea68dbbfc3

data/README.md

@@ -78,6 +78,49 @@ Percy::ProcessHelpers.gracefully_kill(pid)
 
 This will send `SIGTERM` to the process, wait up to 10 seconds, then send `SIGKILL` if it has not already shut down.
 
+### Percy::NetworkHelpers
+
+#### `random_open_port`
+
+Returns a random open port. This is guaranteed by the OS to be currently an unbound open port, but users must still handle race conditions where the port is bound by the time it is actually used.
+
+```ruby
+require 'percy/network_helpers'
+
+Percy::NetworkHelpers.random_open_port
+```
+
+#### `verify_healthcheck(url:[, expected_body: 'ok', retry_wait_seconds: 0.5])`
+
+Verify that a URL returns a specific body. Raises `Percy::NetworkHelpers::ServerDown` if the server is down or does not respond with the expected body.
+
+```ruby
+require 'percy/network_helpers'
+
+Percy::NetworkHelpers.verify_healthcheck('http://localhost/healthz')
+```
+
+#### `verify_http_server_up(hostname[, port: nil, path: nil, retry_wait_seconds: 0.25])`
+
+Verifies that a simple HTTP GET / request works against a hostname. Raises `Percy::NetworkHelpers::ServerDown` if the server is down or if the request times out.
+
+```ruby
+require 'percy/network_helpers'
+
+Percy::NetworkHelpers.verify_http_server_up('example.com')
+Percy::NetworkHelpers.verify_http_server_up('localhost', port: 8080)
+```
+
+#### `serve_static_directory(dir[, hostname: 'localhost', port: nil])`
+
+Starts a simple local WEBrick server to serve a directory of static assets. This is a testing helper and should not be used in production.
+
+```ruby
+require 'percy/network_helpers'
+
+Percy::NetworkHelpers.serve_static_directory(File.expand_path('../test_data/', __FILE__))
+```
+
 ### Percy::Stats
 
 Client for recording Datadog metrics and automatically setting up Percy-specific environment tags.

data/lib/percy/common/version.rb

@@ -1,5 +1,5 @@
 module Percy
   module Common
-    VERSION = '1.3.0'.freeze
+    VERSION = '1.4.0'.freeze
   end
 end

data/lib/percy/network_helpers.rb

@@ -0,0 +1,53 @@
+require 'socket'
+require 'excon'
+
+module Percy
+  class NetworkHelpers
+    class ServerDown < RuntimeError; end
+
+    def self.random_open_port
+      # Using a port of "0" relies on the system to pick an open port.
+      server = TCPServer.new('127.0.0.1', 0)
+      port = server.addr[1]
+      server.close
+      port
+    end
+
+    def self.verify_healthcheck(url:, expected_body: 'ok', retry_wait_seconds: 0.5)
+      10.times do
+        begin
+          response = Excon.get(url)
+          return true if response.body == expected_body
+        rescue Excon::Error::Socket, Excon::Error::Timeout
+          sleep retry_wait_seconds
+        end
+      end
+      raise ServerDown, "Healthcheck failed for #{url}"
+    end
+
+    def self.verify_http_server_up(hostname, port: nil, path: nil, retry_wait_seconds: 0.25)
+      10.times do
+        begin
+          Excon.get("http://#{hostname}#{port.nil? ? '' : ':' + port.to_s}#{path || ''}")
+          return true
+        rescue Excon::Error::Socket, Excon::Error::Timeout
+          sleep retry_wait_seconds
+        end
+      end
+      raise ServerDown, "Server is down: #{hostname}"
+    end
+
+    def self.serve_static_directory(dir, hostname: 'localhost', port: nil)
+      port ||= random_open_port
+
+      # Note: using this form of popen to keep stdout and stderr silent and captured.
+      process = IO.popen(
+        [
+          'ruby', '-run', '-e', 'httpd', dir, '-p', port.to_s, err: [:child, :out],
+        ].flatten,
+      )
+      verify_http_server_up(hostname, port: port)
+      process.pid
+    end
+  end
+end

data/percy-common.gemspec

@@ -18,6 +18,7 @@ Gem::Specification.new do |spec|
 
   spec.add_dependency 'dogstatsd-ruby', '~> 1.6'
   spec.add_dependency 'syslog-logger', '~> 1.6'
+  spec.add_dependency 'excon', '~> 0.57'
 
   spec.add_development_dependency 'bundler', '~> 1.15'
   spec.add_development_dependency 'rake', '~> 10.0'

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: percy-common
 version: !ruby/object:Gem::Version
-  version: 1.3.0
+  version: 1.4.0
 platform: ruby
 authors:
 - Perceptual Inc.
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2017-07-07 00:00:00.000000000 Z
+date: 2017-07-08 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: dogstatsd-ruby
@@ -38,6 +38,20 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: '1.6'
+- !ruby/object:Gem::Dependency
+  name: excon
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.57'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.57'
 - !ruby/object:Gem::Dependency
   name: bundler
   requirement: !ruby/object:Gem::Requirement
@@ -129,6 +143,7 @@ files:
 - lib/percy/common/version.rb
 - lib/percy/keyword_struct.rb
 - lib/percy/logger.rb
+- lib/percy/network_helpers.rb
 - lib/percy/process_helpers.rb
 - lib/percy/stats.rb
 - percy-common.gemspec
@@ -151,7 +166,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.6.12
+rubygems_version: 2.4.8
 signing_key: 
 specification_version: 4
 summary: Server-side common library for Percy.