test_bench-bootstrap 6.1.1 → 7.0.0

data/upstream-lib/test_bench_bootstrap/test_bench/session/controls/telemetry.rb

@@ -0,0 +1,15 @@
+module TestBenchBootstrap
+  module TestBench
+    class Session
+      module Controls
+        module Telemetry
+          Event = TestBench::Telemetry::Controls::Event
+          EventData = TestBench::Telemetry::Controls::EventData
+          Metadata = TestBench::Telemetry::Controls::Event::Metadata
+          Random = TestBench::Telemetry::Controls::Random
+          Sink = TestBench::Telemetry::Controls::Sink
+        end
+      end
+    end
+  end
+end

data/upstream-lib/test_bench_bootstrap/test_bench/session/controls/telemetry_sink.rb

@@ -0,0 +1,37 @@
+module TestBenchBootstrap
+  module TestBench
+    class Session
+      module Controls
+        module TelemetrySink
+          def self.example
+            Telemetry::Sink.example
+          end
+
+          class SetTrace
+            include TestBench::Telemetry::Sink
+
+            attr_accessor :trace_text
+
+            attr_reader :session
+
+            def initialize(session)
+              @session = session
+            end
+
+            def self.register(session)
+              instance = new(session)
+              session.register_telemetry_sink(instance)
+              instance
+            end
+
+            def receive(_event_data)
+              trace_text = session.trace.join
+
+              self.trace_text = trace_text
+            end
+          end
+        end
+      end
+    end
+  end
+end

data/upstream-lib/test_bench_bootstrap/test_bench/session/controls/text.rb

@@ -0,0 +1,33 @@
+module TestBenchBootstrap
+  module TestBench
+    class Session
+      module Controls
+        module Text
+          def self.example
+            "Some text"
+          end
+
+          module Comment
+            def self.example
+              "Some comment"
+            end
+
+            def self.other_example
+              "Some other comment"
+            end
+          end
+
+          module Detail
+            def self.example
+              "Some detail"
+            end
+
+            def self.other_example
+              "Some other detail"
+            end
+          end
+        end
+      end
+    end
+  end
+end

data/upstream-lib/test_bench_bootstrap/test_bench/session/controls/title.rb

@@ -0,0 +1,41 @@
+module TestBenchBootstrap
+  module TestBench
+    class Session
+      module Controls
+        module Title
+          def self.example
+            "Some Title"
+          end
+
+          def self.other_example
+            "Some Other Title"
+          end
+
+          def self.random
+            "#{example} #{Random.string}"
+          end
+
+          module Context
+            def self.example
+              "Some Context"
+            end
+
+            def self.other_example
+              "Some Other Context"
+            end
+          end
+
+          module Test
+            def self.example
+              "Some test"
+            end
+
+            def self.other_example
+              "Some other test"
+            end
+          end
+        end
+      end
+    end
+  end
+end

data/upstream-lib/test_bench_bootstrap/test_bench/session/controls.rb

@@ -0,0 +1,43 @@
+require 'test_bench_bootstrap/test_bench/telemetry/controls'
+
+require 'test_bench_bootstrap/test_bench/session/controls/telemetry'
+
+require 'test_bench_bootstrap/test_bench/session/controls/event'
+require 'test_bench_bootstrap/test_bench/session/controls/metadata'
+require 'test_bench_bootstrap/test_bench/session/controls/random'
+require 'test_bench_bootstrap/test_bench/session/controls/result'
+require 'test_bench_bootstrap/test_bench/session/controls/sequence'
+require 'test_bench_bootstrap/test_bench/session/controls/status'
+require 'test_bench_bootstrap/test_bench/session/controls/telemetry_sink'
+
+require 'test_bench_bootstrap/test_bench/session/controls/path'
+require 'test_bench_bootstrap/test_bench/session/controls/path/apex_directory'
+require 'test_bench_bootstrap/test_bench/session/controls/path/file'
+require 'test_bench_bootstrap/test_bench/session/controls/path/file/create'
+
+require 'test_bench_bootstrap/test_bench/session/controls/exception/raise'
+require 'test_bench_bootstrap/test_bench/session/controls/exception'
+require 'test_bench_bootstrap/test_bench/session/controls/exception/message'
+
+require 'test_bench_bootstrap/test_bench/session/controls/backtrace'
+require 'test_bench_bootstrap/test_bench/session/controls/backtrace/location'
+
+require 'test_bench_bootstrap/test_bench/session/controls/text'
+require 'test_bench_bootstrap/test_bench/session/controls/message'
+require 'test_bench_bootstrap/test_bench/session/controls/title'
+
+require 'test_bench_bootstrap/test_bench/session/controls/comment_disposition'
+
+require 'test_bench_bootstrap/test_bench/session/controls/events/failed'
+require 'test_bench_bootstrap/test_bench/session/controls/events/aborted'
+require 'test_bench_bootstrap/test_bench/session/controls/events/skipped'
+require 'test_bench_bootstrap/test_bench/session/controls/events/commented'
+require 'test_bench_bootstrap/test_bench/session/controls/events/detailed'
+require 'test_bench_bootstrap/test_bench/session/controls/events/test_started'
+require 'test_bench_bootstrap/test_bench/session/controls/events/test_finished'
+require 'test_bench_bootstrap/test_bench/session/controls/events/context_started'
+require 'test_bench_bootstrap/test_bench/session/controls/events/context_finished'
+require 'test_bench_bootstrap/test_bench/session/controls/events/file_queued'
+require 'test_bench_bootstrap/test_bench/session/controls/events/file_executed'
+require 'test_bench_bootstrap/test_bench/session/controls/events/file_not_found'
+require 'test_bench_bootstrap/test_bench/session/controls/events'

data/upstream-lib/test_bench_bootstrap/test_bench/session/defaults.rb

@@ -0,0 +1,17 @@
+module TestBenchBootstrap
+  module TestBench
+    class Session
+      module Defaults
+        def self.strict
+          disabled_value = 'off'
+
+          env_strict = ENV.fetch('TEST_BENCH_STRICT', disabled_value)
+
+          disabled = env_strict == disabled_value
+
+          !disabled
+        end
+      end
+    end
+  end
+end

data/upstream-lib/test_bench_bootstrap/test_bench/session/events.rb

@@ -0,0 +1,24 @@
+module TestBenchBootstrap
+  module TestBench
+    class Session
+      module Events
+        Failed = Telemetry::Event.define(:message)
+        Aborted = Telemetry::Event.define(:message, :location)
+        Skipped = Telemetry::Event.define(:message)
+
+        Commented = Telemetry::Event.define(:text, :disposition)
+        Detailed = Telemetry::Event.define(:text, :disposition)
+
+        TestStarted = Telemetry::Event.define(:title)
+        TestFinished = Telemetry::Event.define(:title, :result)
+
+        ContextStarted = Telemetry::Event.define(:title)
+        ContextFinished = Telemetry::Event.define(:title, :result)
+
+        FileQueued = Telemetry::Event.define(:file)
+        FileExecuted = Telemetry::Event.define(:file, :result)
+        FileNotFound = Telemetry::Event.define(:file)
+      end
+    end
+  end
+end

data/upstream-lib/test_bench_bootstrap/test_bench/session/exception/format_backtrace/substitute.rb

@@ -0,0 +1,34 @@
+module TestBenchBootstrap
+  module TestBench
+    class Session
+      module Exception
+        class FormatBacktrace
+          module Substitute
+            def self.build
+              FormatBacktrace.new
+            end
+
+            class FormatBacktrace
+              attr_accessor :location
+              alias :set_location :location=
+
+              def exceptions
+                @exceptions ||= []
+              end
+
+              def call(exception)
+                exceptions << exception
+
+                location
+              end
+
+              def formatted?(exception)
+                exceptions.include?(exception)
+              end
+            end
+          end
+        end
+      end
+    end
+  end
+end

data/upstream-lib/test_bench_bootstrap/test_bench/session/exception/format_backtrace.rb

@@ -0,0 +1,114 @@
+module TestBenchBootstrap
+  module TestBench
+    class Session
+      module Exception
+        class FormatBacktrace
+          def omit_patterns
+            @omit_patterns ||= []
+          end
+          attr_writer :omit_patterns
+
+          def apex_directory
+            @apex_directory ||= ::Dir.pwd
+          end
+          attr_writer :apex_directory
+
+          attr_accessor :styling
+          alias :styling? :styling
+
+          def self.build
+            instance = new
+
+            omit_patterns = Defaults.omit_patterns
+            instance.omit_patterns = omit_patterns
+
+            styling = Defaults.styling
+            instance.styling = styling
+
+            instance
+          end
+
+          def self.configure(receiver, attr_name: nil)
+            attr_name ||= :format_backtrace
+
+            instance = build
+            receiver.public_send(:"#{attr_name}=", instance)
+          end
+
+          def call(exception)
+            if styling?
+              omitted_text = "\e[2;3m*omitted*\e[23;22m"
+            else
+              omitted_text = "*omitted*"
+            end
+
+            backtrace = []
+
+            original_frame = exception.backtrace_locations.first.to_s
+            backtrace << original_frame
+
+            omitting = false
+
+            exception.backtrace_locations[1..-1].each do |backtrace_location|
+              if omit?(backtrace_location)
+                if not omitting
+                  backtrace << omitted_text
+                end
+
+                omitting = true
+              else
+                omitting = false
+              end
+
+              if not omitting
+                backtrace << backtrace_location.to_s
+              end
+            end
+
+            apex_directory_prefix = ::File.join(apex_directory, '')
+
+            backtrace.each do |backtrace_location_text|
+              backtrace_location_text.delete_prefix!(apex_directory_prefix)
+            end
+
+            exception.set_backtrace(backtrace)
+
+            if exception.cause
+              self.(exception.cause)
+            end
+
+            location = exception.backtrace_locations.find do |backtrace_location|
+              !omit?(backtrace_location)
+            end
+
+            location ||= exception.backtrace_locations.first
+
+            location = "#{location.path}:#{location.lineno}"
+            location.delete_prefix!(apex_directory_prefix)
+            location
+          end
+
+          def omit?(backtrace_location)
+            backtrace_path = backtrace_location.path
+
+            omit_patterns.any? do |omit_pattern|
+              ::File.fnmatch?(omit_pattern, backtrace_path, ::File::FNM_EXTGLOB)
+            end
+          end
+
+          module Defaults
+            def self.omit_patterns
+              env_omit_backtrace_pattern = ENV.fetch('TEST_BENCH_OMIT_BACKTRACE_PATTERN', '')
+
+              env_omit_backtrace_pattern.split(':')
+            end
+
+            def self.styling
+              ::Exception.to_tty?
+            end
+          end
+        end
+      end
+    end
+  end
+end

data/upstream-lib/test_bench_bootstrap/test_bench/session/isolate/substitute.rb

@@ -0,0 +1,45 @@
+module TestBenchBootstrap
+  module TestBench
+    class Session
+      class Isolate
+        module Substitute
+          def self.build
+            Isolate.new
+          end
+
+          class Isolate
+            def file_paths
+              @file_paths ||= []
+            end
+            attr_writer :file_paths
+
+            def events
+              @events ||= []
+            end
+            attr_writer :events
+            alias :set_events :events=
+
+            attr_accessor :stopped
+            def stopped?
+              stopped ? true : false
+            end
+
+            def call(file_path, &block)
+              file_paths << file_path
+
+              events.each(&block)
+            end
+
+            def stop
+              self.stopped = true
+            end
+
+            def executed?(file_path)
+              file_paths.include?(file_path)
+            end
+          end
+        end
+      end
+    end
+  end
+end

data/upstream-lib/test_bench_bootstrap/test_bench/session/isolate.rb

@@ -0,0 +1,159 @@
+module TestBenchBootstrap
+  module TestBench
+    class Session
+      class Isolate
+        def subprocess_sequence
+          @subprocess_sequence ||= 0
+        end
+        attr_writer :subprocess_sequence
+
+        def apex_directory
+          @apex_directory ||= ::Dir.pwd
+        end
+        attr_writer :apex_directory
+
+        attr_accessor :subprocess_id
+
+        attr_accessor :telemetry_reader
+        attr_accessor :file_path_writer
+
+        def self.build(apex_directory: nil)
+          instance = new
+          instance.apex_directory = apex_directory
+          instance
+        end
+
+        def self.configure(receiver, apex_directory: nil, attr_name: nil)
+          attr_name ||= :isolate
+
+          instance = build(apex_directory:)
+          receiver.public_send(:"#{attr_name}=", instance)
+        end
+
+        def call(file_path, &probe)
+          case status
+          when Status.stopping
+            stop
+            start
+          when Status.stopped
+            start
+          end
+
+          file_path_writer.puts(file_path)
+
+          loop do
+            event_data_text = telemetry_reader.gets
+
+            event_data = Telemetry::EventData.load(event_data_text)
+
+            if Isolated === event_data
+              executed_file_path, result = event_data.data
+
+              if executed_file_path == file_path
+                if result == Result.aborted
+                  stop!
+                end
+
+                break
+              else
+                next
+              end
+            end
+
+            probe.(event_data)
+          end
+        end
+
+        def start
+          file_path_reader, file_path_writer = IO.pipe
+          telemetry_reader, telemetry_writer = IO.pipe
+
+          subprocess_id = fork do
+            file_path_writer.close
+            telemetry_reader.close
+
+            ::Dir.chdir(apex_directory)
+
+            session = Session.build
+
+            telemetry_sink = Telemetry::Sink::File.new(telemetry_writer)
+            session.register_telemetry_sink(telemetry_sink)
+
+            Session.establish(session)
+
+            while file_path = file_path_reader.gets(chomp: true)
+              pending_event = Isolated.build(file_path)
+
+              absolute_file_path = ::File.expand_path(file_path)
+
+              session.evaluate(pending_event) do
+                load(absolute_file_path)
+              end
+            end
+
+          ensure
+            # Ensure any exception raised by the subprocess is likely to be printed after the session's test output
+            one_millisecond = 0.001
+            sleep(one_millisecond)
+          end
+
+          telemetry_writer.close
+          file_path_reader.close
+
+          self.subprocess_id = subprocess_id
+          self.subprocess_sequence += 1
+
+          self.telemetry_reader = telemetry_reader
+          self.file_path_writer = file_path_writer
+
+          subprocess_id
+        end
+
+        def stop
+          stop!
+
+          if subprocess_id.nil?
+            return nil
+          end
+
+          subprocess_status = ::Process::Status.wait(subprocess_id)
+
+          self.subprocess_id = nil
+
+          subprocess_status.exitstatus
+        end
+
+        def stop!
+          telemetry_reader&.close
+          file_path_writer&.close
+        end
+
+        def status
+          if subprocess_id.nil?
+            Status.stopped
+          elsif telemetry_reader.closed? && file_path_writer.closed?
+            Status.stopping
+          else
+            Status.active
+          end
+        end
+
+        Isolated = Telemetry::Event.define(:file, :result)
+
+        module Status
+          def self.active
+            :active
+          end
+
+          def self.stopping
+            :stopping
+          end
+
+          def self.stopped
+            :stopped
+          end
+        end
+      end
+    end
+  end
+end

data/upstream-lib/test_bench_bootstrap/test_bench/session/result.rb

@@ -0,0 +1,44 @@
+module TestBenchBootstrap
+  module TestBench
+    class Session
+      module Result
+        extend self
+
+        def self.resolve(result, strict: nil)
+          if strict.nil?
+            strict = Defaults.strict
+          end
+
+          case result
+          in "passed"
+            true
+          in "failed" | "aborted"
+            false
+          in "none" | "incomplete"
+            !strict
+          end
+        end
+
+        def passed
+          "passed"
+        end
+
+        def failed
+          "failed"
+        end
+
+        def none
+          "none"
+        end
+
+        def aborted
+          "aborted"
+        end
+
+        def incomplete
+          "incomplete"
+        end
+      end
+    end
+  end
+end