benchmark-http 0.2.0 → 0.3.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: a7198efc6883b1ab033fabd79461782dc4a283d7a8643b962f13fc6ec9d8b630
-  data.tar.gz: ae74b4d5cfb6d5407c600d46af92817897556fdd246b68591c23b3d40b3a8602
+  metadata.gz: de65883bfb494a1d1da97429666bd4a590361632cc008d1292e11003a00a8acc
+  data.tar.gz: 2b0a8c9f5d9d59799203e6030669a576c4802d0d95c1c1dd4dcf23bba7a875ce
 SHA512:
-  metadata.gz: d930b61aec7683e5162fb0b6f4776b960562473506c574162861eefe91d07d898b3aa9efa755ee5e8464938d358efb34f2f0198dc8bb05907578109e6c7bae19
-  data.tar.gz: 176349eac7a9b287dd60f85f1d2c97c78a3580cd6ec235533b4f81380e2060e82ace5c3bfa3fc9fed322d8d26e9f0f6e0876d9362a7930caeca52c1163b28171
+  metadata.gz: '039a873b982321ada9fcfd8cb3f848e46df8786ee2590a075a68580ad4aa5b3bcee638eb47f28a24e88faabf1349215193a02b65d25f377abe3ad091a36f594f'
+  data.tar.gz: 584cea3731b38082c4a1fb078d883c7eb8d61edc5b626d0ef5dc0ead41e9fe5338edbcfc6535f6b9a66e9187580fbcd25b73d68336e76502a3c5f8bb9a6b6e72

data/.travis.yml

@@ -8,9 +8,9 @@ before_script:
 
 matrix:
   include:
-    - rvm: 2.3
     - rvm: 2.4
     - rvm: 2.5
+    - rvm: 2.6
     - rvm: jruby-head
       env: JRUBY_OPTS="--debug -X+O"
     - rvm: ruby-head

data/Gemfile

@@ -1,6 +1,7 @@
 source "https://rubygems.org"
 
-git_source(:github) {|repo_name| "https://github.com/#{repo_name}" }
-
-# Specify your gem's dependencies in benchmark-http.gemspec
 gemspec
+
+group :development do
+	gem 'pry'
+end

data/README.md

@@ -20,6 +20,85 @@ Install it yourself:
 
 You can run `benchmark-http` is a top level tool for invoking specific benchmarks.
 
+### Spider
+
+This benchmark spiders a website and generates some statistics on general access time.
+
+```shell
+$ benchmark-http spider https://www.oriontransfer.co.nz/welcome/index
+HEAD https://www.oriontransfer.co.nz/welcome/index -> HTTP/2.0 404 (unspecified bytes)
+GET https://www.oriontransfer.co.nz/welcome/index (depth = 10)
+GET https://www.oriontransfer.co.nz/welcome/index -> HTTP/2.0 404 (2263 bytes)
+HEAD https://www.oriontransfer.co.nz/products/index -> HTTP/2.0 200 (unspecified bytes)
+GET https://www.oriontransfer.co.nz/products/index (depth = 9)
+HEAD https://www.oriontransfer.co.nz/services/index -> HTTP/2.0 200 (unspecified bytes)
+GET https://www.oriontransfer.co.nz/services/index (depth = 9)
+HEAD https://www.oriontransfer.co.nz/support/index -> HTTP/2.0 200 (unspecified bytes)
+GET https://www.oriontransfer.co.nz/support/index (depth = 9)
+HEAD https://www.oriontransfer.co.nz/support/contact-us -> HTTP/2.0 307 (unspecified bytes)
+Following redirect to https://www.oriontransfer.co.nz/support/contact-us/index...
+HEAD https://www.oriontransfer.co.nz/support/terms-of-service -> HTTP/2.0 200 (unspecified bytes)
+GET https://www.oriontransfer.co.nz/support/terms-of-service (depth = 9)
+GET https://www.oriontransfer.co.nz/products/index -> HTTP/2.0 200 (3469 bytes)
+GET https://www.oriontransfer.co.nz/services/index -> HTTP/2.0 200 (2488 bytes)
+GET https://www.oriontransfer.co.nz/support/index -> HTTP/2.0 200 (2246 bytes)
+HEAD https://www.oriontransfer.co.nz/support/contact-us/index -> HTTP/2.0 200 (unspecified bytes)
+GET https://www.oriontransfer.co.nz/support/contact-us/index (depth = 8)
+GET https://www.oriontransfer.co.nz/support/terms-of-service -> HTTP/2.0 200 (8466 bytes)
+HEAD https://www.oriontransfer.co.nz/products/library-inspector/index -> HTTP/2.0 200 (unspecified bytes)
+GET https://www.oriontransfer.co.nz/products/library-inspector/index (depth = 8)
+HEAD https://www.oriontransfer.co.nz/products/truth-tables/index -> HTTP/2.0 200 (unspecified bytes)
+GET https://www.oriontransfer.co.nz/products/truth-tables/index (depth = 8)
+HEAD https://www.oriontransfer.co.nz/products/fingerprint/index -> HTTP/2.0 200 (unspecified bytes)
+GET https://www.oriontransfer.co.nz/products/fingerprint/index (depth = 8)
+HEAD https://www.oriontransfer.co.nz/services/internet-services -> HTTP/2.0 200 (unspecified bytes)
+GET https://www.oriontransfer.co.nz/services/internet-services (depth = 8)
+HEAD https://www.oriontransfer.co.nz/services/software-development -> HTTP/2.0 200 (unspecified bytes)
+GET https://www.oriontransfer.co.nz/services/software-development (depth = 8)
+HEAD https://www.oriontransfer.co.nz/services/systems-administration -> HTTP/2.0 200 (unspecified bytes)
+GET https://www.oriontransfer.co.nz/services/systems-administration (depth = 8)
+HEAD https://www.oriontransfer.co.nz/services/website-development -> HTTP/2.0 200 (unspecified bytes)
+GET https://www.oriontransfer.co.nz/services/website-development (depth = 8)
+HEAD https://www.oriontransfer.co.nz/support/contact-us/ -> HTTP/2.0 307 (unspecified bytes)
+Following redirect to https://www.oriontransfer.co.nz/support/contact-us/index...
+GET https://www.oriontransfer.co.nz/support/contact-us/index -> HTTP/2.0 200 (3094 bytes)
+GET https://www.oriontransfer.co.nz/products/library-inspector/index -> HTTP/2.0 200 (5592 bytes)
+GET https://www.oriontransfer.co.nz/products/truth-tables/index -> HTTP/2.0 200 (4160 bytes)
+GET https://www.oriontransfer.co.nz/products/fingerprint/index -> HTTP/2.0 200 (4414 bytes)
+GET https://www.oriontransfer.co.nz/services/internet-services -> HTTP/2.0 200 (3362 bytes)
+GET https://www.oriontransfer.co.nz/services/software-development -> HTTP/2.0 200 (3521 bytes)
+GET https://www.oriontransfer.co.nz/services/systems-administration -> HTTP/2.0 200 (2979 bytes)
+GET https://www.oriontransfer.co.nz/services/website-development -> HTTP/2.0 200 (3943 bytes)
+HEAD https://www.oriontransfer.co.nz/_gallery/products/library-inspector/_screenshots/large/Library%20Inspector%20(Libraries).png -> HTTP/2.0 200 (unspecified bytes)
+Unsupported content type: image/png
+HEAD https://www.oriontransfer.co.nz/_gallery/products/library-inspector/_screenshots/large/Library%20Inspector%20(Libraries%20Disassembly).png -> HTTP/2.0 200 (unspecified bytes)
+Unsupported content type: image/png
+HEAD https://www.oriontransfer.co.nz/_gallery/products/library-inspector/_screenshots/large/Library%20Inspector%20(Libraries%20QuickLook).png -> HTTP/2.0 200 (unspecified bytes)
+Unsupported content type: image/png
+HEAD https://www.oriontransfer.co.nz/_gallery/products/library-inspector/_screenshots/large/Library%20Inspector%20(App).png -> HTTP/2.0 200 (unspecified bytes)
+Unsupported content type: image/png
+HEAD https://www.oriontransfer.co.nz/_gallery/products/library-inspector/_screenshots/large/Library%20Inspector%20(App%20Headers).png -> HTTP/2.0 200 (unspecified bytes)
+Unsupported content type: image/png
+HEAD https://www.oriontransfer.co.nz/_gallery/products/truth-tables/_screenshots/large/Reformat%20Expression.png -> HTTP/2.0 200 (unspecified bytes)
+Unsupported content type: image/png
+HEAD https://www.oriontransfer.co.nz/_gallery/products/truth-tables/_screenshots/large/Large%20Tables.png -> HTTP/2.0 200 (unspecified bytes)
+Unsupported content type: image/png
+HEAD https://www.oriontransfer.co.nz/_gallery/products/truth-tables/_screenshots/large/Tutor.png -> HTTP/2.0 200 (unspecified bytes)
+Unsupported content type: image/png
+HEAD https://www.oriontransfer.co.nz/_gallery/products/truth-tables/_screenshots/large/Informative%20Text.png -> HTTP/2.0 200 (unspecified bytes)
+Unsupported content type: image/png
+HEAD https://www.oriontransfer.co.nz/_gallery/products/fingerprint/_screenshots/large/Fingerprint%20(3).png -> HTTP/2.0 200 (unspecified bytes)
+Unsupported content type: image/png
+HEAD https://www.oriontransfer.co.nz/_gallery/products/fingerprint/_screenshots/large/Fingerprint%20(2).png -> HTTP/2.0 200 (unspecified bytes)
+Unsupported content type: image/png
+HEAD https://www.oriontransfer.co.nz/_gallery/products/fingerprint/_screenshots/large/Fingerprint%20(1).png -> HTTP/2.0 200 (unspecified bytes)
+Unsupported content type: image/png
+HEAD https://www.oriontransfer.co.nz/services/training -> HTTP/2.0 200 (unspecified bytes)
+GET https://www.oriontransfer.co.nz/services/training (depth = 7)
+GET https://www.oriontransfer.co.nz/services/training -> HTTP/2.0 200 (2994 bytes)
+14 samples: 13x 200; 1x 404. 15.124294695167547 requests per second. S/D: 35.69ms.
+```
+
 ### Concurrency
 
 This benchmark determines the optimal level of concurrency (maximise throughput while keeping latency to a minimum).

data/benchmark-http.gemspec

@@ -16,7 +16,10 @@ Gem::Specification.new do |spec|
 	spec.require_paths = ["lib"]
 
 	spec.add_dependency("async-io", "~> 1.5")
-	spec.add_dependency("async-http", "~> 0.9")
+	spec.add_dependency("async-http", "~> 0.27.0")
+	spec.add_dependency("async-await")
+	
+	spec.add_dependency("trenni-sanitize")
 	
 	spec.add_dependency('samovar', "~> 1.3")
 

data/lib/benchmark/http/command.rb

@@ -19,6 +19,8 @@
 # THE SOFTWARE.
 
 require_relative 'command/concurrency'
+require_relative 'command/spider'
+
 require_relative 'version'
 require 'samovar'
 
@@ -39,7 +41,8 @@ module Benchmark
 				end
 				
 				nested '<command>',
-					'concurrency' => Concurrency
+					'concurrency' => Concurrency,
+					'spider' => Spider
 				
 				def verbose?
 					@options[:logging] == :verbose

data/lib/benchmark/http/command/spider.rb

@@ -0,0 +1,150 @@
+# Copyright, 2018, by Samuel G. D. Williams. <http://www.codeotaku.com>
+# 
+# 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.
+
+require_relative '../seconds'
+require_relative '../statistics'
+require_relative '../links_filter'
+
+require 'async'
+require 'async/http/client'
+require 'async/http/url_endpoint'
+require 'async/await'
+
+require 'samovar'
+require 'uri'
+
+module Benchmark
+	module HTTP
+		module Command
+			class Spider < Samovar::Command
+				include Async::Await
+				
+				self.description = "Spider a website and report on performance."
+				
+				options do
+					option '-d/--depth <count>', "The number of nested URLs to traverse.", default: 10, type: Integer
+					option '-h/--headers', "Print out the response headers", default: false
+				end
+				
+				many :urls, "One or more hosts to benchmark"
+				
+				def log(method, url, response)
+					puts "#{method} #{url} -> #{response.version} #{response.status} (#{response.body&.length || 'unspecified'} bytes)"
+					
+					response.headers.each do |key, value|
+						puts "\t#{key}: #{value}"
+					end if @options[:headers]
+				end
+				
+				def extract_links(url, response)
+					base = url
+					
+					body = response.read
+					
+					begin
+						filter = LinksFilter.parse(body)
+					rescue
+						Async.logger.error($!)
+						return []
+					end
+					
+					if filter.base
+						base = base + filter.base
+					end
+					
+					filter.links.collect do |href|
+						begin
+							full_url = base + href
+							
+							if full_url.host == url.host && full_url.kind_of?(URI::HTTP)
+								yield full_url
+							end
+						rescue ArgumentError, URI::InvalidURIError
+							puts "Could not fetch #{href}, relative to #{base}."
+						end
+					end.compact
+				end
+				
+				async def fetch(statistics, client, url, depth = @options[:depth], fetched = Set.new)
+					return if fetched.include?(url) or depth == 0
+					
+					fetched << url
+					
+					request_uri = url.request_uri
+					
+					response = timeout(10) do
+						client.head(request_uri)
+					end
+					
+					log("HEAD", url, response)
+					
+					if response.redirection?
+						location = url + response.headers['location']
+						if location.host == url.host
+							puts "Following redirect to #{location}..."
+							return fetch(statistics, client, location, depth-1, fetched).wait
+						else
+							puts "Ignoring redirect to #{location}."
+							return
+						end
+					end
+					
+					content_type = response.headers['content-type']
+					unless content_type&.start_with? 'text/html'
+						puts "Unsupported content type: #{content_type}"
+						return
+					end
+					
+					response = timeout(20) do
+						statistics.measure do
+							client.get(request_uri)
+						end
+					end
+					
+					log("GET", url, response)
+					
+					extract_links(url, response) do |href|
+						fetch(statistics, client, href, depth - 1, fetched)
+					end.each(&:wait)
+				rescue Async::TimeoutError
+					Async.logger.error("Timeout while fetching #{url}")
+				rescue StandardError
+					Async.logger.error($!)
+				end
+				
+				async def invoke(parent)
+					statistics = Statistics.new
+					
+					@urls.each do |url|
+						endpoint = Async::HTTP::URLEndpoint.parse(url)
+						
+						Async::HTTP::Client.open(endpoint, endpoint.protocol, connection_limit: 4) do |client|
+							fetch(statistics, client, endpoint.url).wait
+						end
+					end
+					
+					statistics.print
+					
+					return statistics
+				end
+			end
+		end
+	end
+end

data/lib/benchmark/http/links_filter.rb

@@ -0,0 +1,47 @@
+# Copyright, 2018, by Samuel G. D. Williams. <http://www.codeotaku.com>
+# 
+# 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.
+
+require 'trenni/sanitize'
+
+module Benchmark
+	module HTTP
+		class LinksFilter < Trenni::Sanitize::Filter
+			def initialize(*)
+				super
+				
+				@base = nil
+				@links = []
+			end
+			
+			attr :base
+			attr :links
+			
+			def filter(node)
+				if node.name == 'base'
+					@base = node['href']
+				elsif node.name == 'a'
+					@links << node['href']
+				end
+				
+				node.skip!(TAG)
+			end
+		end
+	end
+end

data/lib/benchmark/http/statistics.rb

@@ -18,23 +18,38 @@
 # OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
 # THE SOFTWARE.
 
+require 'async/clock'
+
 module Benchmark
 	module HTTP
-		class Statistics
-			def initialize(concurrency)
+		class Stopwatch
+			def initialize(concurrency = 0)
 				@samples = []
-				@duration = 0
+				
+				@total_time = 0
+				
+				# The number of currently executing measurements:
+				@count = 0
 				
 				@concurrency = concurrency
+				@start_time = nil
 			end
 			
+			# The individual samples' durations.
 			attr :samples
-			attr :duration
 			
+			# The sequential time of all samples.
+			attr :total_time
+			
+			# The maximum number of executing measurements at any one time.
 			attr :concurrency
 			
+			def duration
+				@samples.sum
+			end
+			
 			def sequential_duration
-				@duration / @concurrency
+				duration / @concurrency
 			end
 			
 			def count
@@ -42,11 +57,11 @@ module Benchmark
 			end
 			
 			def per_second
-				@samples.count.to_f / sequential_duration.to_f
+				@samples.count.to_f / total_time.to_f
 			end
 			
 			def latency
-				@duration.to_f / @samples.count.to_f
+				duration.to_f / count.to_f
 			end
 			
 			def similar?(other, difference = 2.0)
@@ -61,13 +76,17 @@ module Benchmark
 				end
 			end
 			
+			def valid?
+				@samples.count > 1
+			end
+			
 			# Computes Population Variance, σ^2.
 			def variance
-				return nil if @samples.count < 2
-				
-				average = self.average
-				
-				return @samples.map{|n| (n - average)**2}.sum / @samples.count
+				if valid?
+					average = self.average
+					
+					return @samples.map{|n| (n - average)**2}.sum / @samples.count
+				end
 			end
 			
 			# Population Standard Deviation, σ
@@ -83,16 +102,37 @@ module Benchmark
 				end
 			end
 			
+			def add(duration, result = nil)
+				@samples << duration
+			end
+			
 			def measure
-				start_time = Time.now
+				@count += 1
+				
+				if @count > @concurrency
+					@concurrency = @count
+				end
+				
+				start_time = Async::Clock.now
+				
+				unless @start_time
+					@start_time = start_time
+				end
 				
 				result = yield
 				
-				duration = Time.now - start_time
-				@samples << duration
-				@duration += duration
+				end_time = Async::Clock.now
+				
+				self.add(end_time - start_time, result)
 				
 				return result
+			ensure
+				@count -= 1
+				
+				if @count == 0
+					@total_time += end_time - @start_time
+					@start_time = nil
+				end
 			end
 			
 			def sample(confidence_factor, &block)
@@ -105,13 +145,46 @@ module Benchmark
 			end
 			
 			def print(out = STDOUT)
-				out.puts "#{@samples.count} samples. #{1.0 / self.average} per second. S/D: #{standard_deviation}."
+				if self.valid?
+					out.puts "#{@samples.count} samples. #{per_second} requests per second. S/D: #{Seconds[standard_deviation]}."
+				else
+					out.puts "Not enough samples."
+				end
 			end
 			
 			private
 			
 			def confident?(factor)
-				(@samples.count > @concurrency) && self.standard_error < (self.average * factor)
+				if @samples.count > @concurrency
+					return self.standard_error < (self.average * factor)
+				end
+				
+				return false
+			end
+		end
+		
+		class Statistics < Stopwatch
+			def initialize(*)
+				super
+				
+				# The count of the status codes seen in the responses:
+				@responses = Hash.new{|h,k| 0}
+			end
+			
+			def add(duration, result)
+				super
+				
+				@responses[result.status] += 1
+			end
+			
+			def print(out = STDOUT)
+				if valid?
+					counts = @responses.sort.collect{|status, count| "#{count}x #{status}"}.join("; ")
+					
+					out.puts "#{@samples.count} samples: #{counts}. #{per_second.round(2)} requests per second. S/D: #{Seconds[standard_deviation]}."
+				else
+					out.puts "Not enough samples."
+				end
 			end
 		end
 	end

data/lib/benchmark/http/version.rb

@@ -20,6 +20,6 @@
 
 module Benchmark
 	module HTTP
-		VERSION = "0.2.0"
+		VERSION = "0.3.0"
 	end
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: benchmark-http
 version: !ruby/object:Gem::Version
-  version: 0.2.0
+  version: 0.3.0
 platform: ruby
 authors:
 - Samuel Williams
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2018-03-27 00:00:00.000000000 Z
+date: 2018-07-21 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: async-io
@@ -30,14 +30,42 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '0.9'
+        version: 0.27.0
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '0.9'
+        version: 0.27.0
+- !ruby/object:Gem::Dependency
+  name: async-await
+  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: trenni-sanitize
+  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: samovar
   requirement: !ruby/object:Gem::Requirement
@@ -113,6 +141,8 @@ files:
 - lib/benchmark/http.rb
 - lib/benchmark/http/command.rb
 - lib/benchmark/http/command/concurrency.rb
+- lib/benchmark/http/command/spider.rb
+- lib/benchmark/http/links_filter.rb
 - lib/benchmark/http/seconds.rb
 - lib/benchmark/http/statistics.rb
 - lib/benchmark/http/version.rb