async-rspec 1.14.0 → 1.16.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: f46e5f7273a9f4b02334cb93c5af94692a1be38475e786650ba0bbe18b758bb4
-  data.tar.gz: 03dae4d878f4745f25185afa43712384b7045358492b7c7b403953d407e44210
+  metadata.gz: 34164069084058e87dd043f816b73f6c480d4998d105581213d7eb1e89ce3084
+  data.tar.gz: 46f3d8e14a447fbee85151cb6a3272e361fa287bbabed35805b5b79114916993
 SHA512:
-  metadata.gz: c97bc9bac72f0106c943f02562d5c94a2f4c01044611328a779cd7ee80f8dbac87d8cbfb1c820c7164cd538c4ec5a94a600439817457d30b4b640b65c3fd0986
-  data.tar.gz: 8d2b079fa24d81c270bd44dfad3ad4aed1456b100e03c5298661db9ae7a3a3f12bfc9eee7810416f2c6e5a103e4f38239f80d4ac24595f36b79ff36557ecfe46
+  metadata.gz: c8168f6c7a6846b4aa836417e005575bb4a5fa125a050145aefa4a31039d1909339d73b0227df97858a745dbde447d6fa72f00914dba6a3c511ef5eb4dce9a48
+  data.tar.gz: bdf7b373ce4fcbb11c149a4f3be47a318f508fc02ff57d5775ac01a3874310646b31af49bf5e0bf7a97752b4e0a0878890d3cada5a582b975325b41152412996

data/lib/async/rspec/reactor.rb

@@ -20,10 +20,10 @@
 
 require_relative 'leaks'
 
+require 'kernel/sync'
 require 'kernel/async'
-
 require 'async/reactor'
-require 'async/debug/selector'
+require 'async/task'
 
 module Async
 	module RSpec
@@ -34,13 +34,12 @@ module Async
 			
 			def run_in_reactor(reactor, duration = nil)
 				result = nil
-				
 				timer_task = nil
 				
 				if duration
 					timer_task = reactor.async do |task|
 						# Wait for the timeout, at any point this task might be cancelled if the user code completes:
-						task.annotate("timer task duration=#{duration}")
+						task.annotate("Timer task duration=#{duration}.")
 						task.sleep(duration)
 						
 						# The timeout expired, so generate an error:
@@ -48,30 +47,28 @@ module Async
 						reactor.print_hierarchy(buffer)
 						
 						# Raise an error so it is logged:
-						raise TimeoutError, "run time exceeded duration #{duration}s:\r\n#{buffer.string}"
+						raise TimeoutError, "Run time exceeded duration #{duration}s:\n#{buffer.string}"
 					end
 				end
 				
-				reactor.run do |task|
-					task.annotate(self.class)
+				spec_task = reactor.async do |spec_task|
+					spec_task.annotate("running example")
 					
-					spec_task = task.async do |spec_task|
-						spec_task.annotate("running example")
-						
-						result = yield
-						
-						timer_task&.stop
-						
-						raise Async::Stop
-					end
+					result = yield(spec_task)
 					
-					begin
-						timer_task&.wait
-						spec_task.wait
-					ensure
-						spec_task.stop
-					end
-				end.wait
+					# We are finished, so stop the timer task if it was started:
+					timer_task&.stop
+					
+					# Now stop the entire reactor:
+					raise Async::Stop
+				end
+				
+				begin
+					timer_task&.wait
+					spec_task.wait
+				ensure
+					spec_task.stop
+				end
 				
 				return result
 			end
@@ -79,8 +76,7 @@ module Async
 		
 		::RSpec.shared_context Reactor do
 			include Reactor
-			
-			let(:reactor) {Async::Reactor.new(selector: Async::Debug::Selector.new)}
+			let(:reactor) {@reactor}
 			
 			include_context Async::RSpec::Leaks
 			
@@ -88,11 +84,17 @@ module Async
 				duration = example.metadata.fetch(:timeout, 10)
 				
 				begin
-					run_in_reactor(reactor, duration) do
-						example.run
+					Sync do |task|
+						@reactor = task.reactor
+						
+						task.annotate(self.class)
+						
+						run_in_reactor(@reactor, duration) do
+							example.run
+						end
+					ensure
+						@reactor = nil
 					end
-				ensure
-					reactor.close
 				end
 			end
 		end

data/lib/async/rspec/ssl.rb

@@ -41,8 +41,8 @@ module Async
 		
 		::RSpec.shared_context SSL::CertificateAuthority do
 			# This key size is generally considered insecure, but it's fine for testing.
-			let(:certificate_authority_key) {OpenSSL::PKey::RSA.new(1024)}
-			let(:certificate_authority_name) {OpenSSL::X509::Name.parse("O=Test/CN=localhost")}
+			let(:certificate_authority_key) {OpenSSL::PKey::RSA.new(2048)}
+			let(:certificate_authority_name) {OpenSSL::X509::Name.parse("O=TestCA/CN=localhost")}
 
 			# The certificate authority is used for signing and validating the certificate which is used for communciation:
 			let(:certificate_authority) do
@@ -83,7 +83,7 @@ module Async
 			include_context SSL::CertificateAuthority
 			
 			# The private key to use on the server side:
-			let(:key) {OpenSSL::PKey::RSA.new(1024)}
+			let(:key) {OpenSSL::PKey::RSA.new(2048)}
 			let(:certificate_name) {OpenSSL::X509::Name.parse("O=Test/CN=localhost")}
 
 			# The certificate used for actual communication:
@@ -115,7 +115,7 @@ module Async
 			
 			let(:keys) do
 				Hash[
-					hosts.collect{|name| [name, OpenSSL::PKey::RSA.new(1024)]}
+					hosts.collect{|name| [name, OpenSSL::PKey::RSA.new(2048)]}
 				]
 			end
 			
@@ -177,8 +177,8 @@ module Async
 			include_context SSL::CertificateAuthority
 			
 			# The private key to use on the server side:
-			let(:key) {OpenSSL::PKey::RSA.new(1024)}
-			let(:invalid_key) {OpenSSL::PKey::RSA.new(1024)}
+			let(:key) {OpenSSL::PKey::RSA.new(2048)}
+			let(:invalid_key) {OpenSSL::PKey::RSA.new(2048)}
 			let(:certificate_name) {OpenSSL::X509::Name.parse("O=Test/CN=localhost")}
 
 			# The certificate used for actual communication:

data/lib/async/rspec/version.rb

@@ -20,6 +20,6 @@
 
 module Async
 	module RSpec
-		VERSION = "1.14.0"
+		VERSION = "1.16.1"
 	end
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: async-rspec
 version: !ruby/object:Gem::Version
-  version: 1.14.0
+  version: 1.16.1
 platform: ruby
 authors:
 - Samuel Williams
-autorequire: 
+autorequire:
 bindir: bin
 cert_chain: []
-date: 2019-12-10 00:00:00.000000000 Z
+date: 2021-07-17 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rspec
@@ -25,7 +25,7 @@ dependencies:
       - !ruby/object:Gem::Version
         version: '3.0'
 - !ruby/object:Gem::Dependency
-  name: rspec-memory
+  name: rspec-files
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
@@ -39,7 +39,7 @@ dependencies:
       - !ruby/object:Gem::Version
         version: '1.0'
 - !ruby/object:Gem::Dependency
-  name: rspec-files
+  name: rspec-memory
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
@@ -56,18 +56,18 @@ dependencies:
   name: async
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
-        version: '1.24'
+        version: '0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
-        version: '1.24'
+        version: '0'
 - !ruby/object:Gem::Dependency
-  name: covered
+  name: async-io
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
@@ -95,34 +95,25 @@ dependencies:
       - !ruby/object:Gem::Version
         version: '0'
 - !ruby/object:Gem::Dependency
-  name: rake
+  name: covered
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
-        version: '10.0'
+        version: '0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
-        version: '10.0'
-description: 
+        version: '0'
+description:
 email:
-- samuel.williams@oriontransfer.co.nz
 executables: []
 extensions: []
 extra_rdoc_files: []
 files:
-- ".editorconfig"
-- ".gitignore"
-- ".rspec"
-- ".travis.yml"
-- Gemfile
-- README.md
-- Rakefile
-- async-rspec.gemspec
 - lib/async/rspec.rb
 - lib/async/rspec/buffer.rb
 - lib/async/rspec/leaks.rb
@@ -132,9 +123,10 @@ files:
 - lib/async/rspec/ssl.rb
 - lib/async/rspec/version.rb
 homepage: https://github.com/socketry/async-rspec
-licenses: []
+licenses:
+- MIT
 metadata: {}
-post_install_message: 
+post_install_message:
 rdoc_options: []
 require_paths:
 - lib
@@ -149,8 +141,8 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.0.6
-signing_key: 
+rubygems_version: 3.2.22
+signing_key:
 specification_version: 4
 summary: Helpers for writing specs against the async gem.
 test_files: []

data/.editorconfig

@@ -1,6 +0,0 @@
-root = true
-
-[*]
-indent_style = tab
-indent_size = 2
-

data/.gitignore

@@ -1,13 +0,0 @@
-/.bundle/
-/.yardoc
-/Gemfile.lock
-/_yardoc/
-/coverage/
-/doc/
-/pkg/
-/spec/reports/
-/tmp/
-
-# rspec failure tracking
-.rspec_status
-.covered.db

data/.rspec

@@ -1,3 +0,0 @@
---format documentation
---warnings
---require spec_helper

data/.travis.yml

@@ -1,18 +0,0 @@
-language: ruby
-cache: bundler
-
-matrix:
-  include:
-    - rvm: 2.4
-    - rvm: 2.5
-    - rvm: 2.6
-    - rvm: 2.6
-      env: COVERAGE=BriefSummary,Coveralls
-    - rvm: ruby-head
-    - rvm: jruby-head
-      env: JRUBY_OPTS="--debug -X+O"
-    - rvm: truffleruby
-  allow_failures:
-    - rvm: ruby-head
-    - rvm: jruby-head
-    - rvm: truffleruby

data/Gemfile

@@ -1,10 +0,0 @@
-source 'https://rubygems.org'
-
-# Specify your gem's dependencies in async-rspec.gemspec
-gemspec
-
-# gem "async", path: "../async"
-
-group :test do
-	gem "ruby-prof", git: "https://github.com/ruby-prof/ruby-prof"
-end

data/README.md

@@ -1,130 +0,0 @@
-# Async::RSpec
-
-Provides useful `RSpec.shared_context`s for testing code that builds on top of [async].
-
-[async]: https://github.com/socketry/async
-
-[![Build Status](https://secure.travis-ci.org/socketry/async-rspec.svg)](http://travis-ci.org/socketry/async-rspec)
-[![Code Climate](https://codeclimate.com/github/socketry/async-rspec.svg)](https://codeclimate.com/github/socketry/async-rspec)
-[![Coverage Status](https://coveralls.io/repos/socketry/async-rspec/badge.svg)](https://coveralls.io/r/socketry/async-rspec)
-
-## Installation
-
-Add this line to your application's Gemfile:
-
-```ruby
-gem 'async-rspec'
-```
-
-And then execute:
-
-	$ bundle
-
-Or install it yourself as:
-
-	$ gem install async-rspec
-	
-Finally, add this require statement to the top of `spec/spec_helper.rb`
-
-```ruby
-require 'async/rspec'
-```
-
-## Usage
-
-### Async Reactor
-
-Many specs need to run within a reactor. A shared context is provided which includes all the relevant bits, including the above leaks checks. If your spec fails to run in less than 10 seconds, an `Async::TimeoutError` raises to prevent your test suite from hanging.
-
-```ruby
-require 'async/io'
-
-RSpec.describe Async::IO do
-	include_context Async::RSpec::Reactor
-	
-	let(:pipe) {IO.pipe}
-	let(:input) {Async::IO::Generic.new(pipe.first)}
-	let(:output) {Async::IO::Generic.new(pipe.last)}
-	
-	it "should send and receive data within the same reactor" do
-		message = nil
-		
-		output_task = reactor.async do
-			message = input.read(1024)
-		end
-		
-		reactor.async do
-			output.write("Hello World")
-		end
-		
-		output_task.wait
-		expect(message).to be == "Hello World"
-		
-		input.close
-		output.close
-	end
-end
-```
-
-### Changing Timeout
-
-You can change the timeout by specifying it as an option:
-
-```ruby
-RSpec.describe MySlowThing, timeout: 60 do
-	# ...
-end
-```
-
-### File Descriptor Leaks
-
-Leaking sockets and other kinds of IOs are a problem for long running services. `Async::RSpec::Leaks` tracks all open sockets both before and after the spec. If any are left open, a `RuntimeError` is raised and the spec fails.
-
-```ruby
-RSpec.describe "leaky ios" do
-	include_context Async::RSpec::Leaks
-	
-	# The following fails:
-	it "leaks io" do
-		@input, @output = IO.pipe
-	end
-end
-```
-
-In some cases, the Ruby garbage collector will close IOs. In the above case, it's possible that just writing `IO.pipe` will not leak as Ruby will garbage collect the resulting IOs immediately. It's still incorrect to not close IOs, so don't depend on this behaviour.
-
-### Allocations
-
-This functionality was moved to [`rspec-memory`](https://github.com/socketry/rspec-memory).
-
-## Contributing
-
-1. Fork it
-2. Create your feature branch (`git checkout -b my-new-feature`)
-3. Commit your changes (`git commit -am 'Add some feature'`)
-4. Push to the branch (`git push origin my-new-feature`)
-5. Create new Pull Request
-
-## License
-
-Released under the MIT license.
-
-Copyright, 2017, by [Samuel G. D. Williams](http://www.codeotaku.com/samuel-williams).
-
-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.

data/Rakefile

@@ -1,6 +0,0 @@
-require "bundler/gem_tasks"
-require "rspec/core/rake_task"
-
-RSpec::Core::RakeTask.new(:test)
-
-task :default => :test

data/async-rspec.gemspec

@@ -1,29 +0,0 @@
-# coding: utf-8
-require_relative 'lib/async/rspec/version'
-
-Gem::Specification.new do |spec|
-	spec.name          = "async-rspec"
-	spec.version       = Async::RSpec::VERSION
-	spec.authors       = ["Samuel Williams"]
-	spec.email         = ["samuel.williams@oriontransfer.co.nz"]
-
-	spec.summary       = "Helpers for writing specs against the async gem."
-	spec.homepage      = "https://github.com/socketry/async-rspec"
-
-	spec.files         = `git ls-files -z`.split("\x0").reject do |f|
-		f.match(%r{^(test|spec|features)/})
-	end
-	
-	spec.require_paths = ["lib"]
-	
-	spec.add_dependency "rspec", "~> 3.0"
-	spec.add_dependency "rspec-memory", "~> 1.0"
-	spec.add_dependency "rspec-files", "~> 1.0"
-	
-	# Since we test the shared contexts, we need some bits of async:
-	spec.add_development_dependency "async", "~> 1.24"
-	
-	spec.add_development_dependency "covered"
-	spec.add_development_dependency "bundler"
-	spec.add_development_dependency "rake", "~> 10.0"
-end