treye-semaphore_test_boosters 2.5.1

data/exe/ex_unit_booster

@@ -0,0 +1,5 @@
+#!/usr/bin/env ruby
+
+require "test_boosters"
+
+exit(TestBoosters::Boosters::ExUnit.new.run)

data/exe/go_test_booster

@@ -0,0 +1,5 @@
+#!/usr/bin/env ruby
+
+require "test_boosters"
+
+exit(TestBoosters::Boosters::GoTest.new.run)

data/exe/minitest_booster

@@ -0,0 +1,5 @@
+#!/usr/bin/env ruby
+
+require "test_boosters"
+
+exit(TestBoosters::Boosters::Minitest.new.run)

data/exe/rspec_booster

@@ -0,0 +1,5 @@
+#!/usr/bin/env ruby
+
+require "test_boosters"
+
+exit(TestBoosters::Boosters::Rspec.new.run)

data/lib/test_boosters.rb

@@ -0,0 +1,28 @@
+require "uri"
+require "optparse"
+require "json"
+require "cucumber_booster_config"
+
+module TestBoosters
+  require "test_boosters/version"
+
+  require "test_boosters/cli_parser"
+  require "test_boosters/logger"
+  require "test_boosters/shell"
+  require "test_boosters/insights_uploader"
+  require "test_boosters/project_info"
+  require "test_boosters/job"
+
+  require "test_boosters/files/distributor"
+  require "test_boosters/files/leftover_files"
+  require "test_boosters/files/split_configuration"
+
+  require "test_boosters/boosters/base"
+  require "test_boosters/boosters/rspec"
+  require "test_boosters/boosters/cucumber"
+  require "test_boosters/boosters/go_test"
+  require "test_boosters/boosters/ex_unit"
+  require "test_boosters/boosters/minitest"
+
+  ROOT_PATH = File.absolute_path(File.dirname(__FILE__) + "/..")
+end

data/lib/test_boosters/boosters/base.rb

@@ -0,0 +1,81 @@
+module TestBoosters
+  module Boosters
+    class Base
+
+      def initialize(file_pattern, split_configuration_path, command)
+        @command = command
+        @file_pattern = file_pattern
+        @split_configuration_path = split_configuration_path
+      end
+
+      # :reek:TooManyStatements
+      def run
+        display_header
+
+        before_job # execute some activities when the before the job starts
+
+        distribution.display_info
+
+        known, leftover = distribution.files_for(job_index)
+
+        if cli_options[:dry_run]
+          show_files_for_dry_run("known", known)
+          show_files_for_dry_run("leftover", leftover)
+          return 0
+        end
+
+        exit_status = TestBoosters::Job.run(@command, known, leftover)
+
+        after_job # execute some activities when the job finishes
+
+        exit_status
+      end
+
+      def show_files_for_dry_run(label, files)
+        if files.empty?
+          puts "[DRY RUN] No #{label} files."
+          return
+        end
+
+        puts "\n[DRY RUN] Running tests for #{label} files:"
+        puts files.map { |file| "- #{file}" }.join("\n")
+      end
+
+      def before_job
+        # Do nothing
+      end
+
+      def after_job
+        # Do nothing
+      end
+
+      def display_header
+        version = "Test Booster v#{TestBoosters::VERSION}"
+        job_info = "Job #{job_index + 1} out of #{job_count}"
+
+        TestBoosters::Shell.display_title("#{version} - #{job_info}")
+      end
+
+      def distribution
+        @distribution ||= TestBoosters::Files::Distributor.new(@split_configuration_path,
+                                                               @file_pattern,
+                                                               job_count)
+      end
+
+      def job_index
+        @job_index ||= cli_options[:job_index] - 1
+      end
+
+      def job_count
+        @job_count ||= cli_options[:job_count]
+      end
+
+      private
+
+      def cli_options
+        @cli_options ||= TestBoosters::CliParser.parse
+      end
+
+    end
+  end
+end

data/lib/test_boosters/boosters/cucumber.rb

@@ -0,0 +1,37 @@
+module TestBoosters
+  module Boosters
+    class Cucumber < Base
+
+      FILE_PATTERN = "features/**/*.feature".freeze
+
+      def initialize
+        super(FILE_PATTERN, split_configuration_path, "bundle exec cucumber")
+      end
+
+      def before_job
+        CucumberBoosterConfig::Injection.new(Dir.pwd, report_path).run
+      end
+
+      def after_job
+        TestBoosters::InsightsUploader.upload("cucumber", report_path)
+      end
+
+      def display_header
+        super
+
+        TestBoosters::ProjectInfo.display_ruby_version
+        TestBoosters::ProjectInfo.display_bundler_version
+        TestBoosters::ProjectInfo.display_cucumber_version
+      end
+
+      def report_path
+        @report_path ||= ENV["REPORT_PATH"] || "#{ENV["HOME"]}/cucumber_report.json"
+      end
+
+      def split_configuration_path
+        ENV["CUCUMBER_SPLIT_CONFIGURATION_PATH"] || "#{ENV["HOME"]}/cucumber_split_configuration.json"
+      end
+
+    end
+  end
+end

data/lib/test_boosters/boosters/ex_unit.rb

@@ -0,0 +1,17 @@
+module TestBoosters
+  module Boosters
+    class ExUnit < Base
+
+      FILE_PATTERN = "test/**/*_test.exs".freeze
+
+      def initialize
+        super(FILE_PATTERN, split_configuration_path, "mix test")
+      end
+
+      def split_configuration_path
+        ENV["EX_UNIT_SPLIT_CONFIGURATION_PATH"] || "#{ENV["HOME"]}/ex_unit_split_configuration.json"
+      end
+
+    end
+  end
+end

data/lib/test_boosters/boosters/go_test.rb

@@ -0,0 +1,17 @@
+module TestBoosters
+  module Boosters
+    class GoTest < Base
+
+      FILE_PATTERN = "**/*/*_test.go".freeze
+
+      def initialize
+        super(FILE_PATTERN, split_configuration_path, "go test")
+      end
+
+      def split_configuration_path
+        ENV["GO_TEST_SPLIT_CONFIGURATION_PATH"] || "#{ENV["HOME"]}/go_test_split_configuration.json"
+      end
+
+    end
+  end
+end

data/lib/test_boosters/boosters/minitest.rb

@@ -0,0 +1,21 @@
+module TestBoosters
+  module Boosters
+    class Minitest < Base
+
+      FILE_PATTERN = "test/**/*_test.rb".freeze
+
+      def initialize
+        super(FILE_PATTERN, split_configuration_path, command)
+      end
+
+      def command
+        "ruby -e 'ARGV.each { |f| require \"./\#{f}\" }'"
+      end
+
+      def split_configuration_path
+        ENV["MINITEST_SPLIT_CONFIGURATION_PATH"] || "#{ENV["HOME"]}/minitest_split_configuration.json"
+      end
+
+    end
+  end
+end

data/lib/test_boosters/boosters/rspec.rb

@@ -0,0 +1,49 @@
+module TestBoosters
+  module Boosters
+    class Rspec < Base
+      def initialize
+        super(file_pattern, split_configuration_path, command)
+      end
+
+      def display_header
+        super
+
+        TestBoosters::ProjectInfo.display_ruby_version
+        TestBoosters::ProjectInfo.display_bundler_version
+        TestBoosters::ProjectInfo.display_rspec_version
+      end
+
+      def after_job
+        TestBoosters::InsightsUploader.upload("rspec", report_path)
+      end
+
+      def command
+        @command ||= "bundle exec rspec #{rspec_options}"
+      end
+
+      def rspec_options
+        @rspec_options ||= begin
+          output_formatter = ENV.fetch("TB_RSPEC_FORMATTER", "documentation")
+          # rubocop:disable LineLength
+          "#{ENV["TB_RSPEC_OPTIONS"]} --format #{output_formatter} --require #{formatter_path} --format SemaphoreFormatter --out #{report_path}"
+        end
+      end
+
+      def report_path
+        @report_path ||= ENV["REPORT_PATH"] || "#{ENV["HOME"]}/rspec_report.json"
+      end
+
+      def split_configuration_path
+        ENV["RSPEC_SPLIT_CONFIGURATION_PATH"] || "#{ENV["HOME"]}/rspec_split_configuration.json"
+      end
+
+      def formatter_path
+        @formatter_path ||= File.join(::TestBoosters::ROOT_PATH, "rspec_formatters/semaphore_rspec3_json_formatter.rb")
+      end
+
+      def file_pattern
+        ENV["TEST_BOOSTERS_RSPEC_TEST_FILE_PATTERN"] || "spec/**/*_spec.rb"
+      end
+    end
+  end
+end

data/lib/test_boosters/cli_parser.rb

@@ -0,0 +1,49 @@
+module TestBoosters
+  module CliParser
+    module_function
+
+    # :reek:TooManyStatements
+    # :reek:NestedIterators
+    # :reek:DuplicateMethodCall
+    def parse
+      options = {}
+
+      parser = OptionParser.new do |opts|
+        opts.on(
+          "--thread INDEX",
+          "[DEPRECATED] Use the '--job' option instead"
+        ) do |parameter|
+          puts "[DEPRECATION WARNING] The '--thread' parameter is deprecated. Please use '--job' instead."
+
+          options.merge!(parse_job_params(parameter))
+        end
+
+        opts.on(
+          "--job INDEX",
+          "The job index and number of total jobs. e.g. --job 4/32"
+        ) do |parameter|
+          options.merge!(parse_job_params(parameter))
+        end
+
+        opts.on(
+          "--dry-run",
+          "Only print the files that will be run for this job index"
+        ) do |parameter|
+          options.merge!(:dry_run => parameter)
+        end
+      end
+
+      parser.parse!
+
+      options
+    end
+
+    # parses input like '1/32' and outputs { :job_index => 1, :job_count => 32 }
+    def parse_job_params(input_parameter)
+      job_index, job_count, _rest = input_parameter.split("/")
+
+      { :job_index => job_index.to_i, :job_count => job_count.to_i }
+    end
+
+  end
+end

data/lib/test_boosters/files/distributor.rb

@@ -0,0 +1,45 @@
+module TestBoosters
+  module Files
+
+    #
+    # Distributes test files based on split configuration, file pattern, and their file size
+    #
+    class Distributor
+
+      def initialize(split_configuration_path, file_pattern, job_count)
+        @split_configuration_path = split_configuration_path
+        @file_pattern = file_pattern
+        @job_count = job_count
+      end
+
+      def display_info
+        puts "Split configuration present: #{split_configuration.present? ? "yes" : "no"}"
+        puts "Split configuration valid: #{split_configuration.valid? ? "yes" : "no"}"
+        puts "Split configuration file count: #{split_configuration.all_files.size}"
+      end
+
+      def files_for(job_index)
+        known    = all_files & split_configuration.files_for_job(job_index)
+        leftover = leftover_files.select(:index => job_index, :total => @job_count)
+
+        [known, leftover]
+      end
+
+      def all_files
+        @all_files ||= Dir[@file_pattern].sort
+      end
+
+      private
+
+      def leftover_files
+        @leftover_files ||= TestBoosters::Files::LeftoverFiles.new(all_files - split_configuration.all_files)
+      end
+
+      def split_configuration
+        @split_configuration ||= TestBoosters::Files::SplitConfiguration.new(@split_configuration_path)
+      end
+
+    end
+
+  end
+end

data/lib/test_boosters/files/leftover_files.rb

@@ -0,0 +1,42 @@
+module TestBoosters
+  module Files
+    class LeftoverFiles
+
+      attr_reader :files
+
+      def initialize(files)
+        @files = files
+      end
+
+      def select(options = {})
+        index = options.fetch(:index)
+        total = options.fetch(:total)
+
+        file_distribution(total)[index]
+      end
+
+      private
+
+      def file_distribution(job_count)
+        # create N empty boxes
+        jobs = Array.new(job_count) { [] }
+
+        # distribute files in Round Robin fashion
+        sorted_files_by_file_size.each.with_index do |file, index|
+          jobs[index % job_count] << file
+        end
+
+        jobs
+      end
+
+      def sorted_files_by_file_size
+        @sorted_files_by_file_size ||= existing_files.sort_by { |file| -File.size(file) }
+      end
+
+      def existing_files
+        @existing_files ||= @files.select { |file| File.file?(file) }
+      end
+
+    end
+  end
+end

data/lib/test_boosters/files/split_configuration.rb

@@ -0,0 +1,68 @@
+module TestBoosters
+  module Files
+    class SplitConfiguration
+
+      Job = Struct.new(:files)
+
+      def initialize(path)
+        @path = path
+        @valid = true
+      end
+
+      def present?
+        File.exist?(@path)
+      end
+
+      def valid?
+        jobs # try to load data into memory
+
+        @valid
+      end
+
+      def all_files
+        @all_files ||= jobs.map(&:files).flatten.sort
+      end
+
+      def files_for_job(job_index)
+        job = jobs[job_index]
+
+        job ? job.files : []
+      end
+
+      def jobs
+        @jobs ||= present? ? load_data : []
+      end
+
+      private
+
+      # :reek:TooManyStatements
+      def load_data
+        @valid = false
+
+        content = JSON.parse(File.read(@path)).map do |raw_job|
+          files = raw_job.fetch("files").sort
+
+          TestBoosters::Files::SplitConfiguration::Job.new(files)
+        end
+
+        @valid = true
+
+        content
+      rescue TypeError, KeyError => ex
+        log_error("Split Configuration has invalid structure", ex)
+
+        []
+      rescue JSON::ParserError => ex
+        log_error("Split Configuration is not parsable", ex)
+
+        []
+      end
+
+      def log_error(message, exception)
+        TestBoosters::Logger.error(message)
+        TestBoosters::Logger.error(exception.inspect)
+      end
+
+    end
+  end
+end