Adding stopwatch tests to ensure speed in tests

Author: Suszyński Krzysztof

puppet-forge-server.gemspec

@@ -51,6 +51,7 @@ Gem::Specification.new do |spec|
   spec.add_development_dependency 'rspec', '~> 3.1'
   spec.add_development_dependency 'rspec-core', '~> 3.1'
   spec.add_development_dependency 'simplecov', '~> 0.11.0'
+  spec.add_development_dependency 'rspec-stopwatch', '~> 0.1.3'
 
   spec.required_ruby_version = '>= 1.9.3'
 end

spec/spec_helper.rb

@@ -16,6 +16,7 @@
 
 require 'rack/test'
 require 'rspec'
+require 'rspec/stopwatch'
 require 'puppet_forge_server'
 
 ENV['RACK_ENV'] = 'test'
@@ -44,7 +45,7 @@ module RSpecMixin
   rescue Gem::LoadError
     # do nothing
   end
-  SimpleCov.formatter = SimpleCov::Formatter::MultiFormatter[*formatters]
+  SimpleCov.formatter = SimpleCov::Formatter::MultiFormatter.new(*formatters)
   SimpleCov.start do
     add_filter "/spec/"
     add_filter "/.vendor/"

spec/unit/http/http_client_spec.rb

@@ -2,6 +2,7 @@
 require 'puppet_forge_server'
 
 describe PuppetForgeServer::Http::HttpClient do
+  # Finding a free port to host mock server
   let(:port) do
     require 'socket'
     server = TCPServer.new('127.0.0.1', 0)
@@ -11,6 +12,7 @@
   end
   let(:uri) { "http://localhost:#{port}/" }
   before(:each) do
+    # Staring a mock server on free port to test network fetching performence
     @server = TCPServer.new('localhost', port)
     @thr = Thread.new do
       loop do
@@ -21,6 +23,7 @@
                      "Content-Length: #{response.bytesize}\r\n" +
                      "Connection: close\r\n"
         socket.print "\r\n"
+        # To simulate network lag
         sleep 0.01
         socket.print response
         socket.close
@@ -33,39 +36,55 @@
   end
   let(:instance) { described_class.new(cache) }
   describe '#download' do
+    let(:load) do
+      Proc.new do
+        # To simulate multiple fetches
+        99.times { instance.download(uri) }
+        instance.download(uri)
+      end
+    end
     subject do
-      99.times { instance.download(uri) }
-      instance.download(uri)
+      load.call
     end
     context 'with 1sec LRU cache' do
       let(:cache) do
         require 'lrucache'
         LRUCache.new(:ttl => 1)
       end
+      it { expect { load.call }.to run_for < 0.01 }
       it { expect(subject).not_to be_nil }
       it { expect(subject).not_to be_closed }
     end
     context 'with default cache' do
       let(:cache) { nil }
+      it { expect { load.call }.to run_for < 0.01 }
       it { expect(subject).not_to be_nil }
       it { expect(subject).not_to be_closed }
     end
   end
   describe '#get' do
+    let(:load) do
+      Proc.new do
+        # To simulate multiple fetches
+        99.times { instance.get(uri) }
+        instance.get(uri)
+      end
+    end
     subject do
-      99.times { instance.get(uri) }
-      instance.get(uri)
+      load.call
     end
     context 'with 1sec LRU cache' do
       let(:cache) do
         require 'lrucache'
         LRUCache.new(:ttl => 1)
       end
       it { expect(subject).to eq('Hello!') }
+      it { expect { load.call }.to run_for < 0.01 }
     end
     context 'with default cache' do
       let(:cache) { nil }
       it { expect(subject).to eq('Hello!') }
+      it { expect { load.call }.to run_for < 0.01 }
     end
   end
 end