rspec-background-process 0.1.0

data/lib/rspec-background-process/readiness_checks.rb

@@ -0,0 +1,48 @@
+require 'open-uri'
+require 'file-tail'
+require 'retries'
+
+require_relative 'process_pool'
+
+module RSpecBackgroundProcess
+	class ProcessPool
+		class ProcessDefinition
+			def ready_when_log_includes(log_line)
+				ready_test do |instance|
+					log_line = instance.render(log_line)
+
+					# NOTE: log file my not be crated just after process is started (spawned) so we need to retry
+					with_retries(
+						max_tries: 10000,
+						base_sleep_seconds: 0.01,
+						max_sleep_seconds: 0.2,
+						rescue: Errno::ENOENT
+					) do
+						File::Tail::Logfile.tail(instance.log_file, forward: 0, interval: 0.01, max_interval: 1, suspicious_interval: 4) do |line|
+							line.include?(log_line) and break true
+						end
+					end
+				end
+			end
+
+			def ready_when_url_response_status(uri, status = 'OK')
+				ready_test do |instance|
+					_uri = instance.render(uri) # NOTE: new variable (_uri) is needed or strange things happen...
+
+					begin
+						with_retries(
+						max_tries: 10000,
+						base_sleep_seconds: 0.06,
+						max_sleep_seconds: 0.2,
+						rescue: Errno::ECONNREFUSED
+						) do
+							open(_uri).status.last.strip == status and break true
+						end
+					end
+				end
+			end
+		end
+	end
+end
+
+

data/lib/rspec-background-process/refresh_actions.rb

@@ -0,0 +1,15 @@
+require_relative 'process_pool'
+
+module RSpecBackgroundProcess
+	class ProcessPool
+		class ProcessDefinition
+			def refresh_command(command)
+				refresh_action do |instance|
+					_command = instance.render(command)
+					system _command
+				end
+			end
+		end
+	end
+end
+

data/lib/rspec-background-process/server.rb

@@ -0,0 +1,49 @@
+module RSpecBackgroundProcess
+	class ProcessPool
+		class ProcessDefinition
+			def http_port_allocated_form(base_port, port_count = 1)
+				extend RSpecBackgroundProcess::BackgroundProcess::Server, base_port: base_port, port_count: port_count
+			end
+		end
+	end
+
+	class BackgroundProcess
+		module Server
+			def self.extended(mod)
+				mod.allocate_ports
+			end
+
+			def template_variables
+				super.merge(
+					/allocated port (\d)/ => ->(port_no) { allocated_port(port_no) }
+				)
+			end
+
+			def allocate_ports
+				base_port = @options[:base_port] or fail "no base_port option set for #{self}: #{@options}"
+				port_count = @options[:port_count] or fail "no port_count option set for #{self}: #{@options}"
+
+				global_ports = @options[:global_context][:ports] ||= Set[]
+
+				begin
+					@ports = (base_port ... base_port + port_count).to_a
+					base_port += port_count
+				end until (global_ports & @ports).empty?
+
+				@options[:global_context][:ports] = global_ports + @ports
+			end
+
+			def ports
+				@ports
+			end
+
+			def allocated_port(port_no)
+				@ports[port_no.to_i - 1] or fail "no port #{port_no} allocated: #{@ports}"
+			end
+
+			def to_s
+				super + "{ports: #{ports.join(', ')}}"
+			end
+		end
+	end
+end

data/rspec-background-process.gemspec

@@ -0,0 +1,96 @@
+# Generated by jeweler
+# DO NOT EDIT THIS FILE DIRECTLY
+# Instead, edit Jeweler::Tasks in Rakefile, and run 'rake gemspec'
+# -*- encoding: utf-8 -*-
+
+Gem::Specification.new do |s|
+  s.name = "rspec-background-process"
+  s.version = "0.1.0"
+
+  s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
+  s.authors = ["Jakub Pastuszek"]
+  s.date = "2014-09-29"
+  s.description = "RSpec and Cucumber DSL that allows definition of processes with their arguments, working directory, time outs, port numbers etc. and start/stop them during test runs. Processes with same definitions can pooled and reused between example runs to save time on startup/shutdown. Pooling supports process number limiting with LRU to limit memory used."
+  s.email = "jpastuszek@gmail.com"
+  s.extra_rdoc_files = [
+    "LICENSE.txt",
+    "README.rdoc"
+  ]
+  s.files = [
+    ".document",
+    ".rspec",
+    "Gemfile",
+    "Gemfile.lock",
+    "LICENSE.txt",
+    "README.rdoc",
+    "Rakefile",
+    "VERSION",
+    "lib/rspec-background-process.rb",
+    "lib/rspec-background-process/background_process.rb",
+    "lib/rspec-background-process/background_process_helpers.rb",
+    "lib/rspec-background-process/process_pool.rb",
+    "lib/rspec-background-process/readiness_checks.rb",
+    "lib/rspec-background-process/refresh_actions.rb",
+    "lib/rspec-background-process/server.rb",
+    "rspec-background-process.gemspec",
+    "spec/background_process_helpers_spec.rb",
+    "spec/background_process_spec.rb",
+    "spec/features/cwd_spec.rb",
+    "spec/features/dead_detection_spec.rb",
+    "spec/features/exec_and_loading_spec.rb",
+    "spec/features/pool_lru_spec.rb",
+    "spec/features/ready_test_spec.rb",
+    "spec/features/refresh_spec.rb",
+    "spec/features/reuse_spec.rb",
+    "spec/features/server_spec.rb",
+    "spec/features/variables_replacement_spec.rb",
+    "spec/process_definition_spec.rb",
+    "spec/spec_helper.rb",
+    "spec/support/test_die",
+    "spec/support/test_http_server",
+    "spec/support/test_process",
+    "spec/support/test_slow_die"
+  ]
+  s.homepage = "http://github.com/jpastuszek/rspec-background-process"
+  s.licenses = ["MIT"]
+  s.require_paths = ["lib"]
+  s.rubygems_version = "1.8.23"
+  s.summary = "RSpec and Cucumber DSL library that helps managing background processes during test runs"
+
+  if s.respond_to? :specification_version then
+    s.specification_version = 3
+
+    if Gem::Version.new(Gem::VERSION) >= Gem::Version.new('1.2.0') then
+      s.add_development_dependency(%q<faraday>, [">= 0.8"])
+      s.add_development_dependency(%q<rspec>, ["~> 3.1"])
+      s.add_development_dependency(%q<jeweler>, ["~> 1.8.4"])
+      s.add_development_dependency(%q<bundler>, ["~> 1.0"])
+      s.add_development_dependency(%q<daemon>, ["~> 1.2"])
+      s.add_development_dependency(%q<micromachine>, ["~> 1.1"])
+      s.add_development_dependency(%q<rufus-lru>, ["~> 1.0"])
+      s.add_development_dependency(%q<file-tail>, ["~> 1.0"])
+      s.add_development_dependency(%q<retries>, ["~> 0.0.5"])
+    else
+      s.add_dependency(%q<faraday>, [">= 0.8"])
+      s.add_dependency(%q<rspec>, ["~> 3.1"])
+      s.add_dependency(%q<jeweler>, ["~> 1.8.4"])
+      s.add_dependency(%q<bundler>, ["~> 1.0"])
+      s.add_dependency(%q<daemon>, ["~> 1.2"])
+      s.add_dependency(%q<micromachine>, ["~> 1.1"])
+      s.add_dependency(%q<rufus-lru>, ["~> 1.0"])
+      s.add_dependency(%q<file-tail>, ["~> 1.0"])
+      s.add_dependency(%q<retries>, ["~> 0.0.5"])
+    end
+  else
+    s.add_dependency(%q<faraday>, [">= 0.8"])
+    s.add_dependency(%q<rspec>, ["~> 3.1"])
+    s.add_dependency(%q<jeweler>, ["~> 1.8.4"])
+    s.add_dependency(%q<bundler>, ["~> 1.0"])
+    s.add_dependency(%q<daemon>, ["~> 1.2"])
+    s.add_dependency(%q<micromachine>, ["~> 1.1"])
+    s.add_dependency(%q<rufus-lru>, ["~> 1.0"])
+    s.add_dependency(%q<file-tail>, ["~> 1.0"])
+    s.add_dependency(%q<retries>, ["~> 0.0.5"])
+  end
+end
+

data/spec/background_process_helpers_spec.rb

@@ -0,0 +1,32 @@
+require_relative 'spec_helper'
+
+describe BackgroundProcessHelpers, with: :background_process do
+	describe '#process_pool' do
+		it 'should provide singleton pool object ' do
+			expect {
+				process_pool
+			}.not_to change {
+				process_pool
+			}
+		end
+	end
+
+	describe '#background_process' do
+		it 'should allow specifying executable to run' do
+			process = background_process('features/support/test_process')
+			expect(process.instance.command).to include 'features/support/test_process'
+		end
+
+		describe 'load option' do
+			it 'when set to true will change instance type to LoadedBackgroundProcess' do
+				process = background_process('features/support/test_process', load: true)
+				expect(process.instance).to be_a RSpecBackgroundProcess::LoadedBackgroundProcess
+			end
+		end
+
+		it 'should return process definition' do
+			process = background_process('features/support/test_process')
+			expect(process).to be_a RSpecBackgroundProcess::ProcessPool::ProcessDefinition
+		end
+	end
+end

data/spec/background_process_spec.rb

@@ -0,0 +1,90 @@
+require_relative 'spec_helper'
+
+describe RSpecBackgroundProcess::BackgroundProcess, subject: :instance do
+	describe 'running' do
+		it '#command should represent command to be executed' do
+			expect(subject.command).to include 'test_process'
+		end
+
+		it '#start should spawn the process by calling #spawn' do
+			expect(subject).to receive(:spawn).once.and_return([0, Thread.new{}])
+			subject.start
+		end
+
+		it '#stop should stop the process by sending TERM signal' do
+			expect(subject).to receive(:spawn).once.and_return([0, Thread.new{sleep 0.1}])
+			subject.start
+
+			expect(Process).to receive(:kill).once.with('TERM', kind_of(Numeric))
+			subject.stop
+		end
+
+		it '#restart should stop and then start the process' do
+			expect(subject).to receive(:spawn).once.and_return([0, Thread.new{sleep 0.1}])
+			subject.start
+
+			expect(subject).to receive(:spawn).once.and_return([1, Thread.new{sleep 0.1}])
+			expect(Process).to receive(:kill).once.with('TERM', kind_of(Numeric))
+
+			expect {
+				subject.restart
+			}.to change {
+				subject.pid
+			}.from(0).to(1)
+		end
+
+		describe 'related predicates' do
+			it '#pid should be integer when process is running and nil otherwise' do
+				expect(subject.pid).to be_nil
+
+				expect(subject).to receive(:spawn).once.and_return([42, Thread.new{sleep 0.1}])
+				subject.start
+
+				expect(subject.pid).to be_a(Integer).and eq(42)
+
+				expect(Process).to receive(:kill).once.with('TERM', kind_of(Numeric))
+				subject.stop
+				expect(subject.pid).to be_nil
+			end
+
+			it '#running? should be true when process is running' do
+				expect(subject).not_to be_running
+				expect(subject).to receive(:spawn).once.and_return([42, Thread.new{sleep 0.1}])
+				subject.start
+				expect(subject).to be_running
+			end
+
+			it '#dead? should be true when process exited but was not stopped by us' do
+				expect(subject).not_to be_dead
+				expect(subject).to receive(:spawn).once.and_return([42, Thread.new{sleep 0.1}])
+				subject.start
+				expect(subject).not_to be_dead
+
+				expect(Process).to receive(:kill).once.with('TERM', kind_of(Numeric))
+				subject.stop
+				expect(subject).not_to be_dead
+
+				expect(subject).to receive(:spawn).once.and_return([42, Thread.new{}])
+				subject.start
+				sleep 0.2
+				expect(subject).to be_dead
+			end
+		end
+	end
+
+	describe 'readiness', subject: :process do
+		it 'instance #wait_ready should call readiness block with self as argument' do
+			expect { |b|
+				subject.ready_test do |*args|
+					b.to_proc.call(*args)
+					# need to return true
+					true
+				end
+				instance = subject.instance
+				expect(instance).to receive(:spawn).once.and_return([42, Thread.new{sleep 0.1}])
+				instance.start
+				instance.wait_ready
+			}.to yield_with_args(RSpecBackgroundProcess::BackgroundProcess)
+		end
+	end
+end

data/spec/features/cwd_spec.rb

@@ -0,0 +1,51 @@
+require_relative '../spec_helper'
+
+def process_cwd_from_log(log)
+	log.readlines.grep(/^cwd:/).first.split(': ', 2).last.match(/'(.*)'/).captures.first.strip || fail('cannot extract cwd from log')
+end
+
+feature 'auto managing current working directory', subject: :process_ready_variables do
+	scenario 'processes by default run in own different directory' do
+		instance1 = subject.start.wait_ready
+		instance2 = subject.with{|p| p.argument 'blah'}.start.wait_ready
+
+		# reported cwd
+		expect(instance1.working_directory.to_s).not_to eq(instance2.working_directory.to_s)
+
+		# actual cwd
+		expect(process_cwd_from_log(instance1.log_file)).to eq(instance1.working_directory.realpath.to_s)
+		expect(process_cwd_from_log(instance2.log_file)).to eq(instance2.working_directory.realpath.to_s)
+	end
+end
+
+feature 'process current working directory does not affect test current directory', subject: :process_ready_variables do
+	scenario 'master process current working directory unchanged over instance start' do
+		expect {
+			subject.start.wait_ready
+		}.not_to change {
+			Dir.pwd
+		}
+
+		# reported cwd
+		expect(subject.instance.working_directory.to_s).not_to eq(Dir.pwd)
+
+		# actual cwd
+		expect(process_cwd_from_log(subject.instance.log_file)).to eq(subject.instance.working_directory.realpath.to_s)
+	end
+end
+
+feature 'current working directory can be configured to custom directory', subject: :process_ready_variables do
+	let :test_dir do
+		Pathname.new(Dir.pwd) + 'tmp'
+	end
+
+	scenario 'setting current working directory to test directory' do
+		instance = subject.with{|p| p.working_directory test_dir}.start.wait_ready
+
+		# reported cwd
+		expect(instance.working_directory.to_s).to eq(test_dir.to_s)
+
+		# actual cwd
+		expect(process_cwd_from_log(instance.log_file)).to eq(instance.working_directory.realpath.to_s)
+	end
+end

data/spec/features/dead_detection_spec.rb

@@ -0,0 +1,81 @@
+require_relative '../spec_helper'
+
+feature 'background process is marked as dead if it exits before stop was called', subject: :dying_process do
+	scenario 'running dieing process renders it marked as dead' do
+		instance = subject.start
+		expect(instance).not_to be_dead
+
+		# git it some time to spawn and exit
+		sleep 0.5
+		expect(instance).to be_dead
+	end
+end
+
+feature 'dead instance should not be usable any more', subject: :dying_process do
+	scenario 'trying to #start dead instance' do
+		instance = subject.start
+
+		# git it some time to spawn and exit
+		sleep 0.5
+
+		expect {
+			instance.start
+		}.to raise_error RSpecBackgroundProcess::BackgroundProcess::StateError, /can't start when in state: dead/
+	end
+
+	scenario 'trying to #stop or #restart dead instance' do
+		instance = subject.start
+
+		# git it some time to spawn and exit
+		sleep 0.5
+
+		expect {
+			instance.stop
+		}.to raise_error RSpecBackgroundProcess::BackgroundProcess::StateError, /can't stop when in state: dead/
+
+		expect {
+			instance.restart
+		}.to raise_error RSpecBackgroundProcess::BackgroundProcess::StateError, /can't stop when in state: dead/
+	end
+
+	scenario 'trying to #wait_ready on dead instance' do
+		instance = subject.start
+
+		# git it some time to spawn and exit
+		sleep 0.5
+
+		expect {
+			instance.wait_ready
+		}.to raise_error RSpecBackgroundProcess::BackgroundProcess::StateError, /can't wait ready when in state: dead/
+	end
+end
+
+feature 'detecting instance death wile waiting for it to become ready', subject: :slowly_dying_process do
+	context 'with log file based check' do
+		scenario 'instance dying while we wait for it to become ready' do
+			subject.ready_when_log_includes 'bye'
+
+			instance = subject.start
+
+			expect {
+				instance.wait_ready
+			}.to raise_error RSpecBackgroundProcess::BackgroundProcess::ProcessExitedError, /exited with exit code: 0/
+
+			expect(instance).to be_dead
+		end
+	end
+
+	context 'with URL based check' do
+		scenario 'instance dying while we wait for it to become ready' do
+			subject.ready_when_url_response_status 'http://localhost:1234/health_check', 'OK'
+
+			instance = subject.start
+
+			expect {
+				instance.wait_ready
+			}.to raise_error RSpecBackgroundProcess::BackgroundProcess::ProcessExitedError, /exited with exit code: 0/
+
+			expect(instance).to be_dead
+		end
+	end
+end