rspec-queue 0.0.1 → 0.0.2.pre

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 319bf2ca5d1e26a5b75074f4e9594952039902eb
-  data.tar.gz: 612368ada57548012cc91b984213b3e4efc03663
+  metadata.gz: 485ab2b5b93e916e15048e8111a2b4a21d0eb155
+  data.tar.gz: ac930cd0eee512063ac081ce9838215222fe950c
 SHA512:
-  metadata.gz: ece6e605b3422b756212204d680ff0c7230dcd1e30eacfb15fc230cbd3515e181da24241109b7daf31538bbc720cf798c1ac2dda8da5f1981bbb08db2f0e0d15
-  data.tar.gz: ebfd73bc88ab2ae4f0df7ce770c5f492140a0b9f2480eb89c62b3f0c69fc7fcd79de0f485d730bd8e846a94364c5cda01d1e61e3cf101109e530325c3381d0ed
+  metadata.gz: 4ff29ed27220bbb918cd53d4854406e753b6e0c73c1f841ddf0a48f506e84b3b651837cd846df2d142c2316f3e28f5d4a1e3555ee7f0cd25315df3ebc5e0cecb
+  data.tar.gz: c3c971f13c03a963aad682c988f104a7c5a84b5cbeef93661bf0f0286691ac8bd97c442ac535f269ecd08291fb69b92f9a7a24af86d517c1a29f75194fc79bc8

data/lib/rspec_queue/configuration.rb

@@ -0,0 +1,36 @@
+require 'singleton'
+
+module RSpecQueue
+  class Configuration
+    include Singleton
+
+    attr_accessor :after_worker_spawn_block
+    attr_accessor :server_socket
+
+    def self.after_worker_spawn(&block)
+      self.instance.after_worker_spawn_block = block
+    end
+
+    def self.call_after_worker_spawn_hooks(index)
+      self.instance.after_worker_spawn_block.call(index) if self.instance.after_worker_spawn_block
+    end
+
+    def worker_count
+      @worker_count ||= [env_queue_workers || cpu_count - 1, 1].max
+    end
+
+    private
+
+    def env_queue_workers
+      ENV['RSPEC_QUEUE_WORKERS'].to_i if ENV['RSPEC_QUEUE_WORKERS']
+    end
+
+    def cpu_count
+      num_cpus = if `uname`.chomp == "Darwin"
+        `/usr/sbin/sysctl -n hw.ncpu`.to_i
+      else
+        `grep processor /proc/cpuinfo | wc -l`.to_i
+      end
+    end
+  end
+end

data/lib/rspec_queue/formatter.rb

@@ -0,0 +1,80 @@
+require 'rspec/core/formatters'
+require 'rspec_queue/configuration'
+
+# A custom formatter used for our parallel test suite
+module RSpecQueue
+  class Formatter < RSpec::Core::Formatters::ProgressFormatter
+    RSpec::Core::Formatters.register self, :example_failed, :example_pending, :dump_summary, :dump_pending, :dump_failures
+
+    def initialize(output)
+      super
+      @output = output
+      @failed_examples = []
+    end
+
+    def example_failed(failure)
+      @failed_examples << failure.example
+      @output.puts failure.fully_formatted(@failed_examples.size)
+    end
+
+    def example_pending(pending)
+      @output.puts "\nPending: #{RSpec::Core::Formatters::ConsoleCodes.wrap(pending.example.metadata[:execution_result].pending_message, :yellow)}"
+      @output.puts "  #{RSpec::Core::Formatters::ConsoleCodes.wrap(pending.example.metadata[:location], :cyan)}\n"
+    end
+
+    def dump_summary(summary)
+      colorizer = RSpec::Core::Formatters::ConsoleCodes
+
+      results_output = [
+        "Finished in #{summary.formatted_duration}",
+        "(files took #{summary.formatted_load_time} to load)",
+        "#{summary.colorized_totals_line}"
+      ].join("\n")
+
+      slowest_examples = summary.examples.sort_by { |e| e[:run_time] }.reverse[0..4]
+      slowest_example_output = formatted_slowest_examples(slowest_examples, summary.duration, colorizer)
+
+      summary_output = [
+        results_output,
+        "Top 5 slowest examples:",
+        slowest_example_output
+      ].join("\n")
+
+      @output.puts summary_output
+    end
+
+    def dump_failures(_summary)
+      # no-op because we already printed failures once
+    end
+
+    def dump_pending(_notification)
+      # no-op because we already printed failures once
+    end
+
+    private
+
+    def formatted_slowest_examples(slowest_examples, total_duration, colorizer)
+      slowest_examples.map { |e|
+        location = colorizer.wrap(e[:location], colorizer.console_code_for(:yellow))
+        impact_on_build = run_time_impact(e[:run_time], total_duration, colorizer)
+        example_information = colorizer.wrap("took #{e[:run_time].round(2)}s, impact on build time is", colorizer.console_code_for(:cyan))
+        "#{location} #{example_information} #{impact_on_build}"
+      }.join("\n")
+    end
+
+    def cpu_count
+      RSpecQueue::Configuration.instance.worker_count
+    end
+
+    def run_time_impact(example_run_time, total_duration, colorizer)
+      overall_impact_in_seconds = (example_run_time / cpu_count).round(2)
+      percentage_of_run_time = (example_run_time / (total_duration * cpu_count) * 100).round(1)
+
+      if overall_impact_in_seconds == Float::INFINITY
+        "negligible"
+      else
+        colorizer.wrap("#{overall_impact_in_seconds}s (#{percentage_of_run_time}%)", colorizer.console_code_for(:white))
+      end
+    end
+  end
+end

data/lib/rspec_queue/server.rb

@@ -0,0 +1,81 @@
+module RSpecQueue
+  class Server
+
+    def initialize
+      @server = UNIXServer.open(socket_path)
+    end
+
+    def dispatch(example_group_hash, report)
+      example_group_keys = example_group_hash.keys
+
+      while (example_group_keys.count > 0 || worker_uuids.count > 0) do
+        begin
+          socket = @server.accept
+          message = socket.gets.to_s.strip
+
+          case message
+          when "REGISTER"
+            worker_uid = generate_worker_uid
+            register_worker(worker_uid)
+            socket.puts worker_uid
+
+          when "GET_WORK"
+            if example_group_keys.count > 0
+              socket.puts example_group_keys.shift
+            else
+              socket.puts "SHUT_DOWN"
+            end
+
+          when "FINISH"
+            socket.puts "GET_UUID"
+            uuid = socket.gets.to_s.strip
+
+            worker_uuids.delete(uuid)
+
+            socket.puts "GET_RESULTS"
+            results = socket.gets.to_s.strip
+
+            json_results = JSON.parse(results, symbolize_names: true)
+
+            examples = json_results.select { |e| e[:status] == "passed" }
+            failed_examples = json_results.select { |e| e[:status] == "failed" }
+            pending_examples = json_results.select { |e| e[:status] == "pending" }
+
+            report.examples.push(*examples)
+            report.failed_examples.push(*failed_examples)
+            report.pending_examples.push(*pending_examples)
+
+          else
+            puts("unsupported: #{message}")
+          end
+        ensure
+          socket.close
+        end
+      end
+    end
+
+    def close
+      @server.close
+      FileUtils.rm socket_path
+    end
+
+    def register_worker(uid)
+      worker_uuids << uid
+    end
+
+    def worker_uuids
+      @worker_uuids ||= []
+    end
+
+    def socket_path
+      "/tmp/rspec-queue-server-#{Process.pid}.sock"
+    end
+
+    private
+
+    def generate_worker_uid
+      @uid_index ||= 0
+      "#{SecureRandom.uuid}/#{Process.pid}/worker/#{@uid_index += 1}"
+    end
+  end
+end

data/lib/rspec_queue/server_runner.rb

@@ -0,0 +1,42 @@
+require 'rspec/core'
+require 'rspec_queue/configuration'
+require 'rspec_queue/server'
+require 'rspec_queue/worker'
+
+module RSpecQueue
+  class ServerRunner < RSpec::Core::Runner
+    def run_specs(example_groups)
+      example_group_hash = example_groups.map { |example_group|
+        [example_group.id, example_group]
+      }.to_h
+
+      # start the server, so we are ready to accept connections from workers
+      server = RSpecQueue::Server.new
+      worker_pids = []
+
+      RSpecQueue::Configuration.instance.worker_count.times do |i|
+        env = {
+          "RSPEC_QUEUE_WORKER_ID" => i.to_s,
+          "RSPEC_QUEUE_SERVER_ADDRESS" => server.socket_path,
+        }
+
+        worker_pids << spawn(env, "rspec-queue-worker", *ARGV)
+      end
+
+      reporter = @configuration.reporter
+
+      reporter.report(0) do |report|
+        @configuration.with_suite_hooks do
+          server.dispatch(example_group_hash, report)
+          [report.failed_examples.count, 1].min # exit status
+        end
+      end
+    ensure
+      server.close
+
+      worker_pids.each do |pid|
+        Process.kill("TERM", pid)
+      end
+    end
+  end
+end

data/lib/rspec_queue/worker.rb

@@ -0,0 +1,60 @@
+require 'json'
+
+module RSpecQueue
+  class Worker
+    def initialize
+      @server_socket = ENV["RSPEC_QUEUE_SERVER_ADDRESS"]
+
+      socket = UNIXSocket.open(@server_socket)
+      socket.puts "REGISTER"
+
+      @uuid = socket.gets.to_s.strip
+    end
+
+    def has_work?
+      socket = UNIXSocket.open(@server_socket)
+      socket.puts "GET_WORK"
+      message = socket.gets.to_s.strip
+
+      if message == "SHUT_DOWN"
+        false
+      else
+        @example_group_key = message
+      end
+    end
+
+    def current_example
+      @example_group_key
+    end
+
+    def finish(reporter)
+      socket = UNIXSocket.open(@server_socket)
+      socket.puts "FINISH"
+
+      message = socket.gets.to_s.strip
+
+      if (message == "GET_UUID")
+        socket.puts @uuid
+      else
+        puts "warn"
+      end
+
+      message = socket.gets.to_s.strip
+
+      # serialize the rspec reporter results back to the server
+      if (message == "GET_RESULTS")
+        results = reporter.examples.map { |e|
+          {
+            location: e.metadata[:location],
+            status: e.metadata[:execution_result].status,
+            run_time: e.metadata[:execution_result].run_time
+          }
+        }
+
+        socket.puts results.to_json
+      else
+        puts "warn"
+      end
+    end
+  end
+end

data/lib/rspec_queue/worker_runner.rb

@@ -0,0 +1,32 @@
+require 'rspec/core'
+require 'rspec_queue/configuration'
+require 'rspec_queue/worker'
+
+module RSpecQueue
+  class WorkerRunner < RSpec::Core::Runner
+    def run_specs(example_groups)
+      example_group_hash = example_groups.map { |example_group|
+        [example_group.id, example_group]
+      }.to_h
+
+      RSpecQueue::Configuration.instance.server_socket = ENV["RSPEC_QUEUE_SERVER_ADDRESS"]
+      RSpecQueue::Configuration.call_after_worker_spawn_hooks(ENV["RSPEC_QUEUE_WORKER_ID"])
+
+      worker = RSpecQueue::Worker.new
+
+      reporter = @configuration.reporter
+
+      while(worker.has_work?)
+        # can we pass in a custom reporter which instantly reports back
+        # to the server?
+        example_group_hash[worker.current_example].run(reporter)
+      end
+
+        # report the results of the examples run to the master process
+      worker.finish(reporter)
+
+    ensure
+      Process.exit
+    end
+  end
+end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: rspec-queue
 version: !ruby/object:Gem::Version
-  version: 0.0.1
+  version: 0.0.2.pre
 platform: ruby
 authors:
 - ''
@@ -24,20 +24,6 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: '3.0'
-- !ruby/object:Gem::Dependency
-  name: pry-nav
-  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: 
 executables:
@@ -48,6 +34,12 @@ extra_rdoc_files: []
 files:
 - bin/rspec-queue
 - bin/rspec-queue-worker
+- lib/rspec_queue/configuration.rb
+- lib/rspec_queue/formatter.rb
+- lib/rspec_queue/server.rb
+- lib/rspec_queue/server_runner.rb
+- lib/rspec_queue/worker.rb
+- lib/rspec_queue/worker_runner.rb
 homepage: 
 licenses: []
 metadata: {}
@@ -62,9 +54,9 @@ required_ruby_version: !ruby/object:Gem::Requirement
       version: '0'
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
-  - - ">="
+  - - ">"
     - !ruby/object:Gem::Version
-      version: '0'
+      version: 1.3.1
 requirements: []
 rubyforge_project: 
 rubygems_version: 2.4.5