paraspec 0.0.1 → 0.0.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 709786de26ffdac4d238bb0a1c531a654b7183386b0f85f0c523e74958f66f33
-  data.tar.gz: aa00e1665689abead274c8259a1ab55e1fc049b9e16029723e8c19269248d884
+  metadata.gz: 76dfd75abb077976992e37c9934206e610f652f8f7d88564bcfdd9356cf473e1
+  data.tar.gz: 5d08c00a5d951348ba228bb94509158ddae389b21e0e500b011cbdb6aa379a52
 SHA512:
-  metadata.gz: 70f1e59627cc4d63ae6653b0f945831d9d7abac73cc998c76b1f8c36100e5b1a1f4578731c091904086a159be9ff4d3a16f24702f7847eb46cffac2c39947d4b
-  data.tar.gz: 06d5f5746820455ebe7fc0d440cc8f335a8c8ca6177a5d1a36afc0691d0854a9b2df31eb27b87726470be35139e7fdece0d2315e3bbbec07966ba4e7a0ae7801
+  metadata.gz: e04a18244f08e43e84a9a610405fa6972820f658b84ba67e81a954fd5635873aba6e53ddef8277985d124dbcb6ec6055e5dfbe7f51930c92e314c44078869aeb
+  data.tar.gz: 8b7ef16dee8bb3506442cb8a7b761dbb91929881acd74c4369203f390381de0a3902d59341ce58eb23fa41684754bbd911bb8f67b3ba8a80eddd3fa379689aa4

data/README.md

@@ -10,7 +10,7 @@ back to the master and requests the next test until there are no more left.
 This producer/consumer architecture enables a number of features:
 
 1. The worker load is naturally balanced. If a worker happens to come across
-a slow test, the other workers keep chugging away at faster tests.
+a slow test, the other workers keep chugging away at the remaining tests.
 2. Tests defined in a single file can be executed by multiple workers,
 since paraspec operates on a test by test basis and not on a file by file basis.
 3. Standard output and error streams can be[*] captured and grouped on a
@@ -19,12 +19,31 @@ This output capture can be performed for output generated by C extensions
 as well as plain Ruby code.
 4. Test results are seamlessly integrated by the master, such that
 a parallel run produces a single progress bar with Fuubar across all workers.
+5. Test grouping: paraspec can[**] group the tests by file, top level example
+group, bottom level example group and individually by examples.
+Larger groupings reduce overhead but limit concurrency.
+Smaller groupings have more overhead but higher concurrency.
+6. Paraspec is naturally resilient to worker failure. If a worker dies
+for any reason the remaining tests get automatically redistributed among
+the remaining workers. It is also possible, in theory, to provision
+additional workers when a test run is already in progress, though this feature
+is not currently on the roadmap.
 
 [*] This feature is not yet implemented.
 
+[**] Currently only grouping by bottom level example group is implemented.
+
 ## Usage
 
-For a test suite with no external dependencies, using paraspec is
+Add paraspec to your Gemfile:
+
+    gem 'paraspec'
+
+This is necessary because paraspec has its own dependencies and loads
+the application being tested into its environment, hence both paraspec's
+and application's dependencies need to exist in the same Bundler environment.
+
+Then, for a test suite with no external dependencies, using paraspec is
 trivially easy. Just run:
 
     paraspec
@@ -39,7 +58,8 @@ To pass options to rspec, for example to filter examples to run:
     paraspec -- spec/my_spec.rb
 
 For a test suite with external dependencies, paraspec sets the
-`TEST_ENV_NUMBER` environment variable, like
+`TEST_ENV_NUMBER` environment variable to an integer starting from 1
+corresponding to the worker number, like
 [parallel_tests](https://github.com/grosser/parallel_tests) does.
 The test suite can then configure itself differently in each worker.
 
@@ -88,6 +108,23 @@ The debugging output is turned on with `-d`/`--debug` option:
     paraspec -d ipc     # IPC requests and responses
     paraspec -d perf    # timing & performance information
 
+## Caveats
+
+The master and workers need to all define the same example groups and
+examples, otherwise a worker may retrieve an example group from the master
+that it is unable to run. RSpec provides a way to define tests conditionally
+via `if:` and `unless:` options on contexts and examples, and if this
+functionality is used it is important to make sure that all workers are
+configured identically (especially if such conditional configuration is
+dependent on external resources such as a network server).
+
+Paraspec will check workers' example groups and examples for equality
+with master and will raise an error if there is a mismatch.
+
+## Known Issues
+
+Aborting a test run with Ctrl-C can leave the workers still running.
+
 ## Bugs & Patches
 
 Please report via issues and pull requests.

data/lib/paraspec/version.rb

@@ -1,3 +1,3 @@
 module Paraspec
-  VERSION = '0.0.1'
+  VERSION = '0.0.2'
 end

data/lib/paraspec/worker_runner.rb

@@ -40,8 +40,10 @@ module Paraspec
       return if examples.empty?
       # It is important to run the entire world here because if
       # a particular example group is run, before/after :all hooks
-      # aren't always run
-      RSpec.world.ordered_example_groups.each do |group|
+      # aren't always run.
+      # And "the entire world" means our complete list of example groups,
+      # not RSpec.world.ordered_example_groups which are top level only!
+      RSpecFacade.all_example_groups.each do |group|
         group.reset_memoized
       end
       # Hack to not run examples from each group each time I want to run

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: paraspec
 version: !ruby/object:Gem::Version
-  version: 0.0.1
+  version: 0.0.2
 platform: ruby
 authors:
 - Oleg Pudeyev
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2018-08-03 00:00:00.000000000 Z
+date: 2018-08-04 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rspec-core
@@ -119,5 +119,5 @@ rubyforge_project:
 rubygems_version: 2.7.3
 signing_key: 
 specification_version: 4
-summary: paraspec-0.0.1
+summary: paraspec-0.0.2
 test_files: []