Refactor Runner to support run all tests in parallel with a summary table

Author: hoppergee

Gemfile.lock

@@ -2,18 +2,24 @@ PATH
   remote: .
   specs:
     matrixeval-ruby (0.1.0)
+      concurrent-ruby
       rainbow (~> 3.1)
+      terminal-table
 
 GEM
   remote: https://rubygems.org/
   specs:
     byebug (11.1.3)
+    concurrent-ruby (1.1.9)
     minitest (5.15.0)
     minitest-focus (1.3.1)
       minitest (>= 4, < 6)
     mocha (1.13.0)
     rainbow (3.1.1)
     rake (13.0.6)
+    terminal-table (3.0.2)
+      unicode-display_width (>= 1.1.1, < 3)
+    unicode-display_width (2.1.0)
 
 PLATFORMS
   x86_64-darwin-19

lib/matrixeval/ruby/command_line.rb

@@ -39,7 +39,7 @@ def seperator_index
       end
 
       def seperator_commands
-        ['rake', 'rspec', 'bundle']
+        ['rake', 'rspec', 'bundle', 'bash']
       end
 
     end

lib/matrixeval/ruby/config.rb

@@ -45,6 +45,10 @@ def exclusions
           YAML["exclude"] || []
         end
 
+        def parallel_workers
+          YAML["parallel_workers"] || "number_of_processors"
+        end
+
       end
     end
   end

lib/matrixeval/ruby/docker_compose.rb

@@ -13,8 +13,6 @@ def initialize(context)
 
       def run(arguments)
         forward_arguments = arguments.join(" ")
-        puts Rainbow("[ MatrixEval ] ").blue.bright + Rainbow(" #{context.name} ").white.bright.bg(:blue)
-        puts Rainbow("[ MatrixEval ] Run \"#{forward_arguments}\"").blue.bright
 
         system(
           <<~DOCKER_COMPOSE_COMMAND

lib/matrixeval/ruby/runner.rb

@@ -3,6 +3,8 @@
 require 'fileutils'
 require 'matrixeval/ruby/config'
 require 'matrixeval/ruby/command_line'
+require "concurrent/utility/processor_counter"
+require 'terminal-table'
 
 module Matrixeval
   module Ruby
@@ -13,35 +15,147 @@ def start(argv)
         end
       end
 
-      attr_reader :argv
+      attr_reader :argv, :command
 
       def initialize(argv)
         @argv = argv
+        @command = CommandLine.new(argv)
       end
 
       def start
-        command = CommandLine.new(argv)
         if command.init?
-          Config::YAML.create
-          Gitignore.update
+          init
+        elsif command.all?
+          run_all_contexts
         else
-          Config::YAML.create
-          DockerCompose::YAML.create
-          GemfileLocks.create
-          Gitignore.update
-
-          if command.all?
-            Context.all.each do |context|
-              docker_compose = DockerCompose.new(context)
-              docker_compose.run(command.rest_arguments)
-            end
-          else
-            context = Context.find_by_command_options!(command.context_options)
+          run_a_specific_context
+        end
+      ensure
+        turn_on_stty_opost
+      end
+
+      private
+
+      def init
+        Config::YAML.create
+        Gitignore.update
+      end
+
+      def run_all_contexts
+        Config::YAML.create
+        DockerCompose::YAML.create
+        GemfileLocks.create
+        Gitignore.update
+
+        if workers_count == 1
+          run_all_contexts_sequentially
+        else
+          run_all_contexts_in_parallel
+        end
+      end
+
+      def run_all_contexts_sequentially
+        Context.all.each do |context|
+          puts Rainbow("[ MatrixEval ] ").blue.bright + Rainbow(" #{context.name} ").white.bright.bg(:blue)
+          puts Rainbow("[ MatrixEval ] Run \"#{command.rest_arguments.join(" ")}\"").blue.bright
+
+          docker_compose = DockerCompose.new(context)
+          success = docker_compose.run(command.rest_arguments)
+
+          matrixeval_results << [context, !!success]
+        end
+
+        report
+      end
+
+      def run_all_contexts_in_parallel
+        parallel do |contexts|
+          Thread.current[:matrixeval_results] = []
 
+          contexts.each do |context|
             docker_compose = DockerCompose.new(context)
-            docker_compose.run(command.rest_arguments)
+            success = docker_compose.run(command.rest_arguments)
+
+            Thread.current[:matrixeval_results] << [context, !!success]
           end
         end
+
+        report
+      end
+
+      def run_a_specific_context
+        Config::YAML.create
+        DockerCompose::YAML.create
+        GemfileLocks.create
+        Gitignore.update
+
+        context = Context.find_by_command_options!(command.context_options)
+
+        puts Rainbow("[ MatrixEval ] ").blue.bright + Rainbow(" #{context.name} ").white.bright.bg(:blue)
+        puts Rainbow("[ MatrixEval ] Run \"#{command.rest_arguments.join(" ")}\"").blue.bright
+
+        docker_compose = DockerCompose.new(context)
+        docker_compose.run(command.rest_arguments)
+      end
+
+      def report
+        turn_on_stty_opost
+
+        table = Terminal::Table.new(title: Rainbow("MatrixEval").blue.bright + " Summary", alignment: :center) do |table|
+
+          table.add_row(Config.vectors.map(&:key) + ['result'])
+          table.add_separator 
+
+          matrixeval_results.each do |context, success|
+            success_cell = [success ? Rainbow('Success').green : Rainbow('Failed').red]
+            row = (context.variants.map(&:key) + success_cell).map do |value|
+              { value: value, alignment: :center }
+            end
+
+            table.add_row row
+          end
+
+        end
+
+        puts table
+      end
+
+      def parallel
+        contexts = Context.all
+
+        contexts.each_slice(contexts.count / workers_count) do |sub_contexts|
+          threads << Thread.new do
+            yield sub_contexts
+          end
+        end
+
+        threads.each(&:join)
+
+        threads.each do |thread|
+          matrixeval_results += thread[:matrixeval_results]
+        end
+      end
+
+      def threads
+        @threads ||= []
+      end
+
+      def matrixeval_results
+        @matrixeval_results ||= []
+      end
+
+      def workers_count
+        count = if Config.parallel_workers == "number_of_processors"
+          Concurrent.physical_processor_count
+        else
+          Integer(Config.parallel_workers)
+        end
+
+        [count, 1].max
+      end
+
+      def turn_on_stty_opost
+        system("stty opost")
       end
 
     end

lib/matrixeval/ruby/templates/matrixeval.yml

@@ -1,5 +1,6 @@
 version: 0.1
 target: ruby
+parallel_workers: number_of_processors
 matrix:
   ruby:
     variants:

matrixeval-ruby.gemspec

@@ -31,6 +31,8 @@ Gem::Specification.new do |spec|
 
   # Uncomment to register a new dependency of your gem
   spec.add_dependency "rainbow", "~> 3.1"
+  spec.add_dependency "concurrent-ruby"
+  spec.add_dependency "terminal-table"
 
   # For more information and examples about making a new gem, checkout our
   # guide at: https://bundler.io/guides/creating_gem.html

test/matrixeval/ruby/runner_test.rb

@@ -42,6 +42,7 @@ def test_start_with_existing_config_file
       file.puts(<<~MATRIXEVAL_YAML
         version: 0.1
         target: ruby
+        parallel_workers: 1
         matrix:
           ruby:
             variants: