selective-ruby-core 0.1.5-x86_64-linux → 0.1.7-x86_64-linux

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: ced267905bdcf1596a248cdcd2018cd2e628422e2e27aec445311b5d9afd4857
-  data.tar.gz: f4fbeb39edca06a95e3bf982f7b28c612a4d04d0165556ec341aef304eeb5718
+  metadata.gz: 3ee42cddb33203a7cf1604187c67426b3b7f5af1fa0e6fbb0d1516724c3e6c8e
+  data.tar.gz: d58c25995521db66960c51a860a778303bdb5eb5be5d11b81cf00c066d552b26
 SHA512:
-  metadata.gz: 937a82d41f7b323f925d7a5a761a7045617decf18073fd1aedd482a0c613f24adbbbff3ff53e2b2b068d584cfc7da1071f1b101378a4bbb3575a2f625904d58c
-  data.tar.gz: e93d8037c5af50b1d61700b68dea98d368b56db507480831b5b0be4b704b7e2684614571ef9d789f4c04409464e94b965db1676127a8e7368c0fc0e78aa3b1a9
+  metadata.gz: 85d543fc9a3fd71ce55d8968eb4093c327a900841717f23307edc03a0476b7f10df81622edc4133b0d6fd9c7164689cc031d2a68faefc9700819a64026917ccc
+  data.tar.gz: 36648d460cfb7c7e3604d066645571e936ed3a00b2dcfb44326aa399758190a446313e18575f06e3b9ebcb4fb6748982c9dc066f1d8b22863d1fb253a79783a8

data/lib/bin/build_env.sh

@@ -2,26 +2,32 @@
 
 # Detect the platform (only GitHub Actions in this case)
 if [ -n "$GITHUB_ACTIONS" ]; then
-  # Get environment variables
   platform=github_actions
   branch=${SELECTIVE_BRANCH:-${GITHUB_HEAD_REF:-$GITHUB_REF_NAME}}
-  pr_title=$SELECTIVE_PR_TITLE
   target_branch=${SELECTIVE_TARGET_BRANCH:-$GITHUB_BASE_REF}
   actor=$GITHUB_ACTOR
   sha=${SELECTIVE_SHA:-$GITHUB_SHA}
   run_id=${SELECTIVE_RUN_ID:-$GITHUB_RUN_ID}
   run_attempt=${SELECTIVE_RUN_ATTEMPT:-$GITHUB_RUN_ATTEMPT}
-  commit_message=$(git log --format=%s -n 1 $sha)
+  runner_id=$SELECTIVE_RUNNER_ID
+elif [ -n "$CIRCLECI" ]; then
+  platform=circleci
+  branch=${SELECTIVE_BRANCH:-$CIRCLE_BRANCH}
+  target_branch=$SELECTIVE_TARGET_BRANCH
+  actor=${SELECTIVE_ACTOR:-${CIRCLE_USERNAME:-$CIRCLE_PR_USERNAME}}
+  sha=${SELECTIVE_SHA:-$CIRCLE_SHA1}
+  run_id=$SELECTIVE_RUN_ID
+  run_attempt=${SELECTIVE_RUN_ATTEMPT:-$CIRCLE_BUILD_NUM}
+  runner_id=${SELECTIVE_RUNNER_ID:-$CIRCLE_NODE_INDEX}
 else
   platform=$SELECTIVE_PLATFORM
   branch=$SELECTIVE_BRANCH
-  pr_title=$SELECTIVE_PR_TITLE
   target_branch=$SELECTIVE_TARGET_BRANCH
   actor=$SELECTIVE_ACTOR
   sha=$SELECTIVE_SHA
   run_id=$SELECTIVE_RUN_ID
   run_attempt=$SELECTIVE_RUN_ATTEMPT
-  commit_message=$(git log --format=%s -n 1 $sha)
+  runner_id=$SELECTIVE_RUNNER_ID
 fi
 
 # Output the JSON
@@ -29,12 +35,13 @@ cat <<EOF
   {
     "platform": "$platform",
     "branch": "$branch",
-    "pr_title": "$pr_title",
+    "pr_title": "$SELECTIVE_PR_TITLE",
     "target_branch": "$target_branch",
     "actor": "$actor",
     "sha": "$sha",
     "run_id": "$run_id",
     "run_attempt": "$run_attempt",
-    "commit_message": "$commit_message"
+    "commit_message": "$(git log --format=%s -n 1 $sha)",
+    "runner_id": "$runner_id"
   }
 EOF

data/lib/bin/file_correlation_collector.sh

@@ -0,0 +1,141 @@
+#!/bin/bash
+
+# The first argument is the number of commits to process
+branch=$1
+num_commits=$2
+
+# Initialize an associative array to hold the files to check
+declare -A files_to_check
+
+# Populate the array with the script arguments, starting from the second argument
+for file in "${@:3}"
+do
+  files_to_check["$file"]=1
+done
+
+# Get a list of all commit hashes, in reverse order
+all_commits=$(git log origin/$branch --no-merges --format=%H --reverse -n $num_commits)
+
+# Initialize an associative array to store the test files
+declare -A test_files
+declare -A uncorrelated_test_files
+
+# Initialize an array to store the files changed in the previous commit
+prev_changed_files=()
+
+# For each commit...
+for commit in $all_commits
+do
+  # Get a list of all files that were changed in the current commit
+  files=$(git diff-tree --no-commit-id --name-only -r $commit)
+
+  declare -A correlated_test_files
+
+  # # For each file in the list of files changed in the previous commit...
+  for file in "${prev_changed_files[@]}"
+  do
+    # If the file is in the list of files to check...
+    if [[ ${files_to_check[$file]} ]]; then
+      # For each file...
+      for test_file in $files
+      do
+        # If the file is in the test/ directory and ends with _test.rb...
+        if [[ $test_file == spec/*_spec.rb ]]
+        then
+          # Increment the count in the associative array
+          test_files["$file|$test_file"]=$((test_files["$file|$test_file"]+1))
+          # Add the test file to the correlated_test_files array
+          correlated_test_files["$test_file"]=1
+        fi
+      done
+    fi
+  done
+
+  # For each file in the list of files changed in the current commit...
+  for file in $files
+  do
+    # If the file is in the list of files to check...
+    if [[ ${files_to_check[$file]} ]]; then
+      # For each file...
+      for test_file in $files
+      do
+        # If the file is in the test/ directory and ends with _test.rb...
+        if [[ $test_file == spec/*_spec.rb ]]
+        then
+          # Increment the count in the associative array
+          test_files["$file|$test_file"]=$((test_files["$file|$test_file"]+1))
+          # Add the test file to the correlated_test_files array
+          correlated_test_files["$test_file"]=1
+        fi
+      done
+    fi
+  done
+
+  # For each file...
+  for test_file in $files
+  do
+    # If the file is in the test/ directory and ends with _test.rb...
+    if [[ $test_file == spec/*_spec.rb ]]
+    then
+      # If the test file is not correlated to any of the files to check in the current commit...
+      if [[ -z ${correlated_test_files[$test_file]} ]]
+      then
+        # Increment the count in the associative array
+        uncorrelated_test_files["$test_file"]=$((uncorrelated_test_files["$test_file"]+1))
+      fi
+    fi
+  done
+
+  # Clear the correlated_test_files array for the next commit
+  unset correlated_test_files
+
+  # Store the list of files changed in this commit for the next iteration
+  prev_changed_files=($files)
+done
+
+# OUTPUT
+
+# Initialize an associative array to hold the JSON strings for each file
+declare -A file_jsons
+
+# Add the test_files to the file_jsons associative array
+for key in "${!test_files[@]}"
+do
+  file=${key%|*}
+  test_file=${key#*|}
+  count=${test_files[$key]}
+  # Append to the JSON string for this file
+  file_jsons["$file"]+="\"$test_file\": $count,"
+done
+
+# Initialize an empty string for the test_files JSON
+correlated_files_json=""
+
+# Add the file_jsons to the correlated_files_json string
+for file in "${!file_jsons[@]}"
+do
+  # Remove the trailing comma from the JSON string for this file
+  file_json=${file_jsons[$file]%?}
+  # Append to the correlated_files_json string
+  correlated_files_json+="\"$file\": { $file_json },"
+done
+
+# Remove the trailing comma from the correlated_files_json string
+correlated_files_json=${correlated_files_json%?}
+
+# Initialize an empty string for the uncorrelated_test_files JSON
+uncorrelated_files_json=""
+
+# Add the uncorrelated_test_files to the uncorrelated_files_json string
+for key in "${!uncorrelated_test_files[@]}"
+do
+  count=${uncorrelated_test_files[$key]}
+  # Append to the uncorrelated_files_json string
+  uncorrelated_files_json+="\"$key\": $count,"
+done
+
+# Remove the trailing comma from the uncorrelated_files_json string
+uncorrelated_files_json=${uncorrelated_files_json%?}
+
+# Output the JSON
+echo "{ \"correlated_files\": { $correlated_files_json }, \"uncorrelated_files\": { $uncorrelated_files_json } }"

data/lib/selective/ruby/core/controller.rb

@@ -1,26 +1,25 @@
 require "logger"
 require "uri"
-require "json"
 require "fileutils"
-require "open3"
 
 module Selective
   module Ruby
     module Core
       class Controller
+        include Helper
         @@selective_suppress_reporting = false
 
         def initialize(runner, debug: false, log: false)
           @debug = debug
           @runner = runner
           @retries = 0
-          @runner_id = safe_filename(ENV.fetch("SELECTIVE_RUNNER_ID", generate_runner_id))
+          @runner_id = safe_filename(get_runner_id)
           @logger = init_logger(log)
         end
 
         def start(reconnect: false)
           @pipe = NamedPipe.new("/tmp/#{runner_id}_2", "/tmp/#{runner_id}_1")
-          @transport_pid = spawn_transport_process(reconnect ? transport_url + "&reconnect=true" : transport_url)
+          @transport_pid = spawn_transport_process(reconnect: reconnect)
 
           handle_termination_signals(transport_pid)
           wait_for_connectivity
@@ -51,9 +50,14 @@ module Selective
 
         private
 
-        attr_reader :runner, :pipe, :transport_pid, :retries, :logger, :runner_id
+        attr_reader :runner, :pipe, :transport_pid, :retries, :logger, :runner_id, :diff
 
-        BUILD_ENV_SCRIPT_PATH = "../../../bin/build_env.sh".freeze
+        def get_runner_id
+          runner_id = build_env.delete("runner_id")
+          return generate_runner_id if runner_id.nil? || runner_id.empty?
+
+          runner_id
+        end
 
         def init_logger(enabled)
           if enabled
@@ -70,9 +74,7 @@ module Selective
             response = JSON.parse(message, symbolize_names: true)
 
             @logger.info("Received Command: #{response}")
-            next if handle_command(response)
-
-            break
+            break if handle_command(response) == :break
           end
         end
 
@@ -97,7 +99,7 @@ module Selective
           "selgen-#{SecureRandom.hex(4)}"
         end
 
-        def transport_url
+        def transport_url(reconnect: false)
           @transport_url ||= begin
             api_key = ENV.fetch("SELECTIVE_API_KEY")
             host = ENV.fetch("SELECTIVE_HOST", "wss://app.selective.ci")
@@ -113,9 +115,16 @@ module Selective
               "run_id" => run_id,
               "run_attempt" => run_attempt,
               "api_key" => api_key,
-              "runner_id" => runner_id
+              "runner_id" => runner_id,
+              "language" => "ruby",
+              "core_version" => Selective::Ruby::Core::VERSION,
+              "framework" => runner.framework,
+              "framework_version" => runner.framework_version,
+              "framework_wrapper_version" => runner.wrapper_version,
             }.merge(metadata: build_env.to_json)
 
+            prams[:reconnect] = true if reconnect
+
             query_string = URI.encode_www_form(params)
 
             "#{host}/transport/websocket?#{query_string}"
@@ -124,15 +133,14 @@ module Selective
 
         def build_env
           @build_env ||= begin
-            result = `#{Pathname.new(__dir__) + BUILD_ENV_SCRIPT_PATH}`
+            result = `#{File.join(ROOT_GEM_PATH, "lib", "bin", "build_env.sh")}`
             JSON.parse(result)
           end
         end
 
-        def spawn_transport_process(url)
-          root_path = Gem.loaded_specs["selective-ruby-core"].full_gem_path
-          transport_path = File.join(root_path, "lib", "bin", "transport")
-          get_transport_path = File.join(root_path, "bin", "get_transport")
+        def spawn_transport_process(reconnect: false)
+          transport_path = File.join(ROOT_GEM_PATH, "lib", "bin", "transport")
+          get_transport_path = File.join(ROOT_GEM_PATH, "bin", "get_transport")
 
           # The get_transport script is not released with the gem, so this
           # code is intended for development/CI purposes.
@@ -147,7 +155,7 @@ module Selective
             end
           end
 
-          Process.spawn(transport_path, url, runner_id).tap do |pid|
+          Process.spawn(transport_path, transport_url(reconnect: reconnect), runner_id).tap do |pid|
             Process.detach(pid)
           end
         end
@@ -211,154 +219,99 @@ module Selective
           # Process already gone noop
         end
 
-        def handle_command(response)
-          case response[:command]
-          when "print_notice"
-            print_notice(response[:message])
-          when "test_manifest"
-            handle_test_manifest
-          when "run_test_cases"
-            handle_run_test_cases(response[:test_case_ids])
-          when "remove_failed_test_case_result"
-            handle_remove_failed_test_case_result(response[:test_case_id])
-          when "reconnect"
-            handle_reconnect
-          when "print_message"
-            handle_print_message(response[:message])
-          when "close"
-            handle_close(response[:exit_status])
-            # This return is here for the sake of test where
-            # we cannot exit but we need to break the loop
-            return false
-          else
-            raise "Unknown command received: #{response[:command]}" if debug?
-          end
+        def handle_command(data)
+          send("handle_#{data[:command]}", data)
+        rescue NoMethodError
+          raise "Unknown command received: #{data[:command]}" if debug?
+        end
 
-          true
+        def handle_print_notice(data)
+          print_notice(data[:message])
         end
 
-        def handle_reconnect
+        def handle_reconnect(_data)
           kill_transport
           pipe.reset!
           start(reconnect: true)
         end
 
-        def handle_test_manifest
+        def handle_test_manifest(_data)
           self.class.restore_reporting!
           @logger.info("Sending Response: test_manifest")
           data = {test_cases: runner.manifest["examples"]}
-          data[:modified_test_files] = modified_test_files unless modified_test_files.nil?
+          num_commits = build_env["num_commits"] || 1000
+          if (diff = get_diff(num_commits))
+            data[:modified_test_files] = modified_test_files(diff)
+            data[:correlated_files] = correlated_files(diff, num_commits)
+          end
           write({type: "test_manifest", data: data})
         end
 
-        def handle_run_test_cases(test_cases)
-          runner.run_test_cases(test_cases, method(:test_case_callback))
+        def handle_run_test_cases(data)
+          runner.run_test_cases(data[:test_case_ids], method(:test_case_callback))
         end
 
-        def test_case_callback(test_case)
-          @logger.info("Sending Response: test_case_result: #{test_case[:id]}")
-          write({type: "test_case_result", data: test_case})
-        end
-
-        def handle_remove_failed_test_case_result(test_case_id)
-          runner.remove_failed_test_case_result(test_case_id)
+        def handle_remove_failed_test_case_result(data)
+          runner.remove_failed_test_case_result(data[:test_case_id])
         end
 
-        def modified_test_files
-          @modified_test_files ||= begin
-            target_branch = build_env["target_branch"]
-            return [] if target_branch.nil? || target_branch.empty?
-
-            output, status = Open3.capture2e("git diff #{target_branch} --name-only")
-
-            if status.success?
-              output.split("\n").filter do |f|
-                f.match?(/^#{runner.base_test_path}/)
-              end
-            end
-          end
+        def handle_print_message(data)
+          print_warning(data[:message])
         end
 
-        def handle_print_message(message)
-          print_warning(message)
-        end
-
-        def handle_close(exit_status = nil)
+        def handle_close(data)
+          exit_status = data[:exit_status]
           self.class.restore_reporting!
           runner.finish unless exit_status.is_a?(Integer)
 
           kill_transport
           pipe.delete_pipes
           exit(exit_status || runner.exit_status)
+          # This :break is here for the sake of test where
+          # we cannot exit but we need to break the loop
+          :break
         end
 
-        def debug?
-          @debug
+        def correlated_files(diff, num_commits)
+          Selective::Ruby::Core::FileCorrelator.new(diff, num_commits, build_env["target_branch"]).correlate
         end
 
-        def safe_filename(filename)
-          filename
-            .gsub(/[\/\\:*?"<>|\n\r]+/, '_')
-            .gsub(/^\.+|\.+$/, '')
-            .strip[0, 255]
+        def test_case_callback(test_case)
+          @logger.info("Sending Response: test_case_result: #{test_case[:id]}")
+          write({type: "test_case_result", data: test_case})
         end
 
-        def with_error_handling(include_header: true)
-          yield
-        rescue => e
-          raise e if debug?
-          header = <<~TEXT
-            An error occurred. Please rerun with --debug
-            and contact support at https://selective.ci/support
-          TEXT
-
-          unless @banner_displayed
-            header = <<~TEXT
-              #{banner}
-
-              #{header}
-            TEXT
+        def modified_test_files(diff)
+          @modified_test_files ||= begin
+            diff.filter do |f|
+              f.match?(/^#{runner.base_test_path}/)
+            end
           end
-
-          puts_indented <<~TEXT
-            \e[31m
-            #{header if include_header}
-            #{e.message}
-            \e[0m
-          TEXT
-
-          exit 1
         end
 
-        def print_warning(message)
-          puts_indented <<~TEXT
-            \e[33m
-            #{message}
-            \e[0m
-          TEXT
-        end
+        def get_diff(num_commits)
+          target_branch = build_env["target_branch"]
+          return [] if target_branch.nil? || target_branch.empty?
 
-        def print_notice(message)
-          puts_indented <<~TEXT
-            #{banner}
-            #{message}
-          TEXT
-        end
+          Open3.capture2e("git fetch origin #{target_branch} --depth=#{num_commits}").then do |output, status|
+            unless status.success?
+              print_warning "Selective was unable to fetch the target branch. This may result in a sub-optimal test order. If the issue persists, please contact support. The output was:\n\n#{output}"
+              return []
+            end
+          end
 
-        def puts_indented(text)
-          puts text.gsub(/^/, "  ")
+          Open3.capture2e("git diff origin/#{target_branch} --name-only").then do |output, status|
+            if status.success?
+              output.split("\n")
+            else
+              print_warning "Selective was unable to diff with the target branch. This may result in a sub-optimal test order. If the issue persists, please contact support. The output was:\n\n#{output}"
+              []
+            end
+          end
         end
 
-        def banner
-          @banner_displayed = true
-          <<~BANNER
-             ____       _           _   _
-            / ___|  ___| | ___  ___| |_(_)_   _____
-            \\___ \\ / _ \\ |/ _ \\/ __| __| \\ \\ / / _ \\
-             ___) |  __/ |  __/ (__| |_| |\\ V /  __/
-            |____/ \\___|_|\\___|\\___|\\__|_| \\_/ \\___|
-            ________________________________________
-          BANNER
+        def debug?
+          @debug
         end
       end
     end

data/lib/selective/ruby/core/file_correlator.rb

@@ -0,0 +1,38 @@
+module Selective
+  module Ruby
+    module Core
+      class FileCorrelator
+        include Helper
+
+        class FileCorrelatorError < StandardError; end
+
+        FILE_CORRELATION_COLLECTOR_PATH = File.join(ROOT_GEM_PATH, "lib", "bin", "file_correlation_collector.sh")
+
+        def initialize(diff, num_commits, target_branch)
+          @diff = diff
+          @num_commits = num_commits
+          @target_branch = target_branch
+        end
+
+        def correlate
+          JSON.parse(get_correlated_files, symbolize_names: true)
+        rescue FileCorrelatorError, JSON::ParserError
+          print_warning "Selective was unable to correlate the diff to test files. This may result in a sub-optimal test order. If the issue persists, please contact support."
+        end
+
+        private
+
+        attr_reader :diff, :num_commits, :target_branch
+
+        def get_correlated_files
+          Open3.capture2e("#{FILE_CORRELATION_COLLECTOR_PATH} #{target_branch} #{num_commits} #{diff.join(" ")}").then do |output, status|
+
+            raise FileCorrelatorError unless status.success?
+
+            output
+          end
+        end
+      end
+    end
+  end
+end

data/lib/selective/ruby/core/helper.rb

@@ -0,0 +1,76 @@
+module Selective
+  module Ruby
+    module Core
+      module Helper
+        def safe_filename(filename)
+          filename
+            .gsub(/[\/\\:*?"<>|\n\r]+/, '_')
+            .gsub(/^\.+|\.+$/, '')
+            .strip[0, 255]
+        end
+
+        def with_error_handling(include_header: true)
+          yield
+        rescue => e
+          raise e if debug?
+          header = <<~TEXT
+            An error occurred. Please rerun with --debug
+            and contact support at https://selective.ci/support
+          TEXT
+
+          unless $selective_banner_displayed
+            header = <<~TEXT
+              #{banner}
+
+              #{header}
+            TEXT
+          end
+
+          puts_indented <<~TEXT
+            \e[31m
+            #{header if include_header}
+            #{e.message}
+            \e[0m
+          TEXT
+
+          exit 1
+        end
+
+        def print_warning(message)
+          puts_indented <<~TEXT
+            \e[33m
+            #{message}
+            \e[0m
+          TEXT
+        end
+
+        def print_notice(message)
+          puts_indented <<~TEXT
+            #{banner unless $selective_banner_displayed}
+            #{message}
+          TEXT
+        end
+
+        def puts_indented(text)
+          puts text.gsub(/^/, "  ")
+        end
+
+        def banner
+          Helper.banner
+        end
+
+        def self.banner
+          $selective_banner_displayed = true
+          <<~BANNER
+             ____       _           _   _
+            / ___|  ___| | ___  ___| |_(_)_   _____
+            \\___ \\ / _ \\ |/ _ \\/ __| __| \\ \\ / / _ \\
+             ___) |  __/ |  __/ (__| |_| |\\ V /  __/
+            |____/ \\___|_|\\___|\\___|\\__|_| \\_/ \\___|
+            ________________________________________
+          BANNER
+        end
+      end
+    end
+  end
+end

data/lib/selective/ruby/core/version.rb

@@ -3,7 +3,7 @@
 module Selective
   module Ruby
     module Core
-      VERSION = "0.1.5"
+      VERSION = "0.1.7"
     end
   end
 end

data/lib/selective-ruby-core.rb

@@ -1,6 +1,9 @@
 # frozen_string_literal: true
 
 require "zeitwerk"
+require "json"
+require "open3"
+require "#{__dir__}/selective/ruby/core/version"
 
 loader = Zeitwerk::Loader.for_gem(warn_on_extra_files: false)
 loader.ignore("#{__dir__}/selective-ruby-core.rb")
@@ -12,6 +15,8 @@ module Selective
     module Core
       class Error < StandardError; end
 
+      ROOT_GEM_PATH = Gem.loaded_specs["selective-ruby-core"].full_gem_path
+
       @@available_runners = {}
 
       def self.register_runner(name, runner_class)

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: selective-ruby-core
 version: !ruby/object:Gem::Version
-  version: 0.1.5
+  version: 0.1.7
 platform: x86_64-linux
 authors:
 - Benjamin Wood
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2023-12-08 00:00:00.000000000 Z
+date: 2024-01-05 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: zeitwerk
@@ -41,9 +41,12 @@ files:
 - Rakefile
 - exe/selective
 - lib/bin/build_env.sh
+- lib/bin/file_correlation_collector.sh
 - lib/bin/transport
 - lib/selective-ruby-core.rb
 - lib/selective/ruby/core/controller.rb
+- lib/selective/ruby/core/file_correlator.rb
+- lib/selective/ruby/core/helper.rb
 - lib/selective/ruby/core/named_pipe.rb
 - lib/selective/ruby/core/version.rb
 homepage: https://www.selective.ci