rspec-multiprocess_runner 0.3.0 → 0.4.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 4d891049e0122f0b95c00eab92191c798e68d533
-  data.tar.gz: 7ddbae3e691ed2ab6d2121e7a362ea61a279e680
+  metadata.gz: 520007bffb4a964152f9126341c18e31ddfacf1e
+  data.tar.gz: 3cb996f53ea6a3d9b1e34f7c6d55847f9db3c9a6
 SHA512:
-  metadata.gz: e8fe6572977652575bb0d8073222f65a0cd0b1c696b2ee2ce51bd9e2d6133d4c749610c094956f7f1c27e0b3942a3297858563f2c86d30d6c412f3f196f358b4
-  data.tar.gz: def29fc93cb9a4e822bf08c7f16a923d701b2b74959625db36933001abce6000e3fd8f6e3930f1d5b4dd0bf8b57e8e99a9af5dd9716abf11566b1dfc4d789ccb
+  metadata.gz: 363f45289a698a62ee9789c7429e6821239f58047d920b753531e306d847eac2806477a968b49fd6c06bc2aa5ec481a73036fb7d298859d63a005beba0dd1348
+  data.tar.gz: 8e5e26062ce94dfbbd635f5a1bfbe7fcf936fdc526d6d3786dc2753aef6c3423dc758a436daffb9db80a5e0971c82b58a73bdfdd4e821d0ccf8e2aa887691e03

data/CHANGELOG.md

@@ -1,3 +1,9 @@
+# 0.4.0
+
+* Change TEST_ENV_NUMBER values to match parallel_tests (#10)
+* Allow for environment-variable-based defaults for worker count and first-is-1
+  in `multirspec` (like #10, improving compatibility with parallel_tests)
+
 # 0.3.0
 
 * Require a filename for the `--log-failing-files` option (#9)

data/README.md

@@ -4,13 +4,14 @@ This gem provides a mechanism for running a suite of RSpec tests in multiple
 processes on the same machine, potentially allowing substantial performance
 improvements.
 
-It differs from `parallel-tests` in that it uses a coordinator process to manage
+It differs from `parallel_tests` in that it uses a coordinator process to manage
 the workers, hand off work to them, and receive results. This means it can
 dynamically balance the workload among the processors. It also means it can
 provide consolidated results in the console.
 
-It does follow parallel-tests' `TEST_ENV_NUMBER` convention so it's easy to
-switch.
+It follows parallel_tests' environment variable conventions so it's easy to
+use them together. (E.g., parallel_tests has a very nice set of rake tasks
+for setting up parallel environments.)
 
 ## Benefits
 
@@ -35,7 +36,6 @@ switch.
 * Intermediate-quality code. Happy path works, and workers are
   managed/restarted, but:
   * There's no test coverage of the runner itself, only auxiliaries.
-  * Does not handle the coordinator process dying (e.g., from `^C`).
 
 ## Installation
 
@@ -107,6 +107,40 @@ Create a coordinator and tell it to run:
     )
     coordinator.run
 
+… but you are probably better off using the command line interface.
+
+## Runtime environment
+
+### `TEST_ENV_NUMBER`
+
+This runner provides each worker with a environment number so that you can
+segment access to resources (databases, etc). For convenience, it follows the
+same convention as `parallel_tests`.
+
+* The environment number is provided as an environment variable named `TEST_ENV_NUMBER`
+* The first environment number is `""` and subsequent ones are integers (`"2"`, `"3"`, etc.)
+
+Like `parallel_tests` 2.3 and later, `multirspec` supports a `--first-is-1`
+argument which makes the first environment number `"1"` instead. Use this to
+have your multiprocess runs be isolated from the environment used in tests you
+run normally, allowing you to to TDD while a long-running multiprocess run
+continues in the background.
+
+### Behavior options
+
+All options are available via the `multirspec` command line interface. A couple
+may alternatively be set in the calling environment.
+
+* Worker count: instead of providing `-w 5`, set `PARALLEL_TEST_PROCESSORS="5"` or
+  `MULTIRSPEC_WORKER_COUNT="5"` in the environment. If both `-w` and one of these
+  vars is set, the value passed to `-w` will win.
+* First-is-1: instead of providing `--first-is-1`, set
+  `PARALLEL_TEST_FIRST_IS_1="true"` or `MULTIRSPEC_FIRST_IS_1="true"` in the
+  environment.
+
+These environment variables only apply to the CLI and rake task. If you
+directly invoke `RSpec::MultiprocessRunner::Coordinator#run`, they are ignored.
+
 ## Contributing
 
 Bug reports and pull requests are welcome on GitHub at https://github.com/cdd/rspec-multiprocess_runner.

data/exe/multirspec

@@ -12,6 +12,7 @@ coordinator = RSpec::MultiprocessRunner::Coordinator.new(
   {
     file_timeout_seconds: options.file_timeout_seconds,
     example_timeout_seconds: options.example_timeout_seconds,
+    test_env_number_first_is_1: options.first_is_1,
     rspec_options: options.rspec_options,
     log_failing_files: options.log_failing_files
   }

data/lib/rspec/multiprocess_runner/command_line_options.rb

@@ -6,15 +6,19 @@ module RSpec::MultiprocessRunner
   # @private
   class CommandLineOptions
     attr_accessor :worker_count, :file_timeout_seconds, :example_timeout_seconds,
-      :rspec_options, :explicit_files_or_directories, :pattern, :log_failing_files
+      :rspec_options, :explicit_files_or_directories, :pattern, :log_failing_files,
+      :first_is_1
+
+    DEFAULT_WORKER_COUNT = 3
 
     def initialize
-      self.worker_count = 3
+      self.worker_count = default_worker_count
       self.file_timeout_seconds = nil
       self.example_timeout_seconds = 15
       self.pattern = "**/*_spec.rb"
       self.log_failing_files = nil
       self.rspec_options = []
+      self.first_is_1 = default_first_is_1
     end
 
     def parse(command_line_args, error_stream=$stderr)
@@ -52,6 +56,20 @@ module RSpec::MultiprocessRunner
 
     private
 
+    def default_worker_count
+      from_env = ENV['MULTIRSPEC_WORKER_COUNT'] || ENV['PARALLEL_TEST_PROCESSORS']
+      if from_env
+        from_env.to_i
+      else
+        DEFAULT_WORKER_COUNT
+      end
+    end
+
+    def default_first_is_1
+      from_env = ENV['MULTIRSPEC_FIRST_IS_1'] || ENV['PARALLEL_TEST_FIRST_IS_1']
+      %w(true 1).include?(from_env)
+    end
+
     def help_requested!
       @help_requested = true
     end
@@ -92,6 +110,10 @@ module RSpec::MultiprocessRunner
           self.log_failing_files = filename
         end
 
+        parser.on("--first-is-1", "Use \"1\" for the first worker's TEST_ENV_NUMBER (instead of \"\")#{" (enabled in environment)" if first_is_1}") do
+          self.first_is_1 = true
+        end
+
         parser.on_tail("-h", "--help", "Prints this help") do
           help_requested!
         end

data/lib/rspec/multiprocess_runner/coordinator.rb

@@ -8,6 +8,7 @@ module RSpec::MultiprocessRunner
       @worker_count = worker_count
       @file_timeout_seconds = options[:file_timeout_seconds]
       @example_timeout_seconds = options[:example_timeout_seconds]
+      @test_env_number_first_is_1 = options[:test_env_number_first_is_1]
       @log_failing_files = options[:log_failing_files]
       @rspec_options = options[:rspec_options]
       @spec_files = sort_files(files)
@@ -145,7 +146,8 @@ module RSpec::MultiprocessRunner
           n,
           file_timeout_seconds: @file_timeout_seconds,
           example_timeout_seconds: @example_timeout_seconds,
-          rspec_options: @rspec_options
+          rspec_options: @rspec_options,
+          test_env_number_first_is_1: @test_env_number_first_is_1
         )
         @workers << new_worker
         new_worker.start

data/lib/rspec/multiprocess_runner/rake_task.rb

@@ -37,6 +37,9 @@ module RSpec::MultiprocessRunner
     # before killing it. Defaults to 15.
     attr_accessor :example_timeout_seconds
 
+    # If true, set TEST_ENV_NUMBER="1" for the first worker (instead of "")
+    attr_accessor :first_is_1
+
     # Whether or not to fail Rake when an error occurs (typically when
     # examples fail). Defaults to `true`.
     attr_accessor :fail_on_error
@@ -108,6 +111,9 @@ module RSpec::MultiprocessRunner
       if file_timeout_seconds
         cmd_parts << '--file-timeout' << file_timeout_seconds.to_s
       end
+      if first_is_1
+        cmd_parts << '--first-is-1'
+      end
       if pattern
         cmd_parts << '--pattern' << pattern
       end

data/lib/rspec/multiprocess_runner/version.rb

@@ -1,5 +1,5 @@
 module RSpec
   module MultiprocessRunner
-    VERSION = "0.3.0"
+    VERSION = "0.4.0"
   end
 end

data/lib/rspec/multiprocess_runner/worker.rb

@@ -35,6 +35,7 @@ module RSpec::MultiprocessRunner
       @rspec_arguments = (options[:rspec_options] || []) + ["--format", ReportingFormatter.to_s]
       @example_timeout_seconds = options[:example_timeout_seconds]
       @file_timeout_seconds = options[:file_timeout_seconds]
+      @test_env_number_first_is_1 = options[:test_env_number_first_is_1]
       @example_results = []
 
       # Use a single configuration and world across all individual runs
@@ -55,6 +56,14 @@ module RSpec::MultiprocessRunner
       end
     end
 
+    def test_env_number
+      if environment_number == 1 && !@test_env_number_first_is_1
+        ""
+      else
+        environment_number.to_s
+      end
+    end
+
     ##
     # Forks the worker process. In the parent, returns the PID.
     def start
@@ -65,7 +74,7 @@ module RSpec::MultiprocessRunner
       else
         @coordinator_socket.close
         @pid = Process.pid
-        ENV["TEST_ENV_NUMBER"] = environment_number.to_s
+        ENV["TEST_ENV_NUMBER"] = test_env_number
 
         # reset TERM handler so that
         # - the coordinator's version (if any) is not executed twice

data/rspec-multiprocess_runner.gemspec

@@ -23,4 +23,5 @@ Gem::Specification.new do |spec|
   spec.add_development_dependency "bundler", "~> 1.10"
   spec.add_development_dependency "rake", "~> 10.0"
   spec.add_development_dependency "rspec"
+  spec.add_development_dependency "stub_env"
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: rspec-multiprocess_runner
 version: !ruby/object:Gem::Version
-  version: 0.3.0
+  version: 0.4.0
 platform: ruby
 authors:
 - Rhett Sutphin
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2016-01-15 00:00:00.000000000 Z
+date: 2016-01-21 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rspec-core
@@ -72,6 +72,20 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: '0'
+- !ruby/object:Gem::Dependency
+  name: stub_env
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
 description: 
 email:
 - rhett@detailedbalance.net