test_bench-bootstrap 6.1.1 → 7.0.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 767df4583392029c9c3e454af34c912e19f5225cc643c988d2ea81b0fe0ea32c
-  data.tar.gz: 67b64b8a37af6c351600dd2ca3091eff995ba3e2c35ae7ee50772a4accdab207
+  metadata.gz: bce5dfa1efc3538d7e6aaea169937603a308db3f611afe053e2f582f90fb7341
+  data.tar.gz: 6e846123a4d565e621c86920537a34b330aa389b543b29a49110b1cbe9c6f21c
 SHA512:
-  metadata.gz: 80795f1e607dadb28337d300c6c02c7879a393c4ba8a41d6f8b640df54c2235ef36e9cabc1bc886df5e7bab90b0a70b0dcb05ba44e0db661c1bad5fd3b4482b9
-  data.tar.gz: 6300cbfab8047d96ded07e36227a2b6c1e787c67e017f44ad42ccee592e107231289666866f4efcfd6915274cb137f6eeb759826f2e0f544ffff74c75cd0aee1
+  metadata.gz: 8dd22538adacd762648e0499289b81b2a51236985192059c430de7ac4e9e651ea8de319436e3013b1cce721841e40516d93a361af9f09e9dbbeb0f6e451f31df
+  data.tar.gz: ed43a134a45f23bad998d062c94514035a95e6df45b0a43a483f5b92d1b4e6717f2eb2c825d4dceccb39581d6d50e73e1cae95e2f2d77d23eb8c02ca7c86c36b

data/executables/bench-bootstrap

@@ -0,0 +1,7 @@
+#!/usr/bin/env ruby
+
+require 'test_bench_bootstrap'
+
+exit_code = TestBenchBootstrap::TestBench::Executable.()
+
+exit(exit_code)

data/lib/test_bench_bootstrap/controls.rb

@@ -0,0 +1 @@
+require 'test_bench_bootstrap/test_bench/controls'

data/lib/test_bench_bootstrap/test_bench_bootstrap.rb

@@ -0,0 +1,7 @@
+module TestBenchBootstrap
+  def self.activate
+    TestBenchBootstrap::TestBench.activate
+  end
+
+  Run = TestBenchBootstrap::TestBench::Run
+end

data/lib/test_bench_bootstrap.rb

@@ -0,0 +1,4 @@
+require 'test_bench_bootstrap/import_constants'
+require 'test_bench_bootstrap/test_bench'
+
+require 'test_bench_bootstrap/test_bench_bootstrap'

data/upstream-lib/test_bench_bootstrap/import_constants/controls/namespace.rb

@@ -0,0 +1,84 @@
+module TestBenchBootstrap
+  module ImportConstants
+    module Controls
+      module Namespace
+        def self.example(name: nil, &block)
+          Example
+        end
+
+        module Example
+          module SomeConstant
+          end
+
+          module SomeOtherConstant
+          end
+        end
+
+        module Anonymous
+          def self.example(name: nil, &block)
+            name ||= self.name
+
+            namespace = Module.new
+            namespace.set_temporary_name(name)
+
+            if not block.nil?
+              namespace.module_exec(&block)
+            end
+
+            namespace
+          end
+
+          def self.name
+            'Some Anonymous Module'
+          end
+        end
+
+        module Target
+          def self.example(name: nil, &block)
+            name ||= self.name
+
+            Anonymous.example(name:)
+          end
+
+          def self.name
+            'Some Target Module'
+          end
+        end
+
+        module InheritNamespace
+          def self.example(namespace=nil)
+            namespace ||= Namespace.example
+
+            Anonymous.example(name:) do
+              include namespace
+            end
+          end
+
+          def self.name
+            'Include Namespace'
+          end
+        end
+
+        module AliasNamespace
+          def self.example(namespace=nil, name: nil)
+            namespace ||= Namespace.example
+
+            constant_names = namespace.constants(false)
+
+            Anonymous.example(name:) do
+              constant_names.each do |constant_name|
+                constant = namespace.const_get(constant_name)
+
+                const_set(constant_name, constant)
+              end
+            end
+          end
+
+          def self.name
+            'Alias Namespace'
+          end
+        end
+      end
+    end
+  end
+end

data/upstream-lib/test_bench_bootstrap/import_constants/controls.rb

@@ -0,0 +1 @@
+require 'test_bench_bootstrap/import_constants/controls/namespace'

data/upstream-lib/test_bench_bootstrap/import_constants/import_constants.rb

@@ -0,0 +1,46 @@
+module TestBenchBootstrap
+  module ImportConstants
+    Error = Class.new(RuntimeError)
+
+    def self.included(target_namespace)
+      target_namespace.extend(Macro)
+    end
+
+    def self.call(source_namespace, target_namespace=nil, as: nil)
+      target_namespace ||= Object
+      alias_name = as
+
+      if not alias_name.nil?
+        if target_namespace.const_defined?(alias_name, false)
+          raise Error, "#{target_namespace}::#{alias_name} is already defined"
+        end
+
+        alias_module = Module.new
+        ImportConstants.(source_namespace, alias_module)
+
+        target_namespace.const_set(alias_name, alias_module)
+
+      else
+        inherit = false
+        constants = source_namespace.constants(inherit)
+
+        constants.each do |constant_name|
+          constant = source_namespace.const_get(constant_name)
+
+          if target_namespace.const_defined?(constant_name, false)
+            if warn?
+              warn "#{source_namespace}::#{constant_name} is not imported into #{target_namespace}. It is already defined."
+            end
+            next
+          end
+
+          target_namespace.const_set(constant_name, constant)
+        end
+      end
+    end
+
+    def self.warn?
+      ENV.fetch('IMPORT_CONSTANTS_WARNING', 'on') == 'on'
+    end
+  end
+end

data/upstream-lib/test_bench_bootstrap/import_constants/macro.rb

@@ -0,0 +1,10 @@
+module TestBenchBootstrap
+  module ImportConstants
+    module Macro
+      def import_constants_macro(source_namespace, as: nil)
+        ImportConstants.(source_namespace, self, as:)
+      end
+      alias :import_constants :import_constants_macro
+    end
+  end
+end

data/upstream-lib/test_bench_bootstrap/import_constants.rb

@@ -0,0 +1,2 @@
+require 'test_bench_bootstrap/import_constants/macro'
+require 'test_bench_bootstrap/import_constants/import_constants'

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

@@ -0,0 +1,7 @@
+module TestBenchBootstrap
+  module TestBench
+    module Controls
+      TelemetrySink = Session::Controls::TelemetrySink
+    end
+  end
+end

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

@@ -0,0 +1,3 @@
+require 'test_bench_bootstrap/test_bench/executable/controls'
+
+require 'test_bench_bootstrap/test_bench/controls/telemetry_sink.rb'

data/upstream-lib/test_bench_bootstrap/test_bench/executable/controls/path.rb

@@ -0,0 +1,9 @@
+module TestBenchBootstrap
+  module TestBench
+    class Executable
+      module Controls
+        Path = Run::Path
+      end
+    end
+  end
+end

data/upstream-lib/test_bench_bootstrap/test_bench/executable/controls/random.rb

@@ -0,0 +1,9 @@
+module TestBenchBootstrap
+  module TestBench
+    class Executable
+      module Controls
+        Random = Run::Random
+      end
+    end
+  end
+end

data/upstream-lib/test_bench_bootstrap/test_bench/executable/controls/run.rb

@@ -0,0 +1,12 @@
+module TestBenchBootstrap
+  module TestBench
+    class Executable
+      module Controls
+        module Run
+          Path = TestBench::Run::Controls::Path
+          Random = TestBench::Run::Controls::Random
+        end
+      end
+    end
+  end
+end

data/upstream-lib/test_bench_bootstrap/test_bench/executable/controls/standard_input.rb

@@ -0,0 +1,31 @@
+module TestBenchBootstrap
+  module TestBench
+    class Executable
+      module Controls
+        module StandardInput
+          module Create
+            def self.call(*paths)
+              if paths.empty?
+                paths = Path.examples
+              end
+
+              content = <<~TEXT
+              #{paths.join("\n")}
+              TEXT
+
+              file = Session::Controls::Path::File::Create.(content)
+
+              ::File.open(file, 'r')
+            end
+
+            def self.contents
+              <<~TEXT
+              #{Path.example}
+              TEXT
+            end
+          end
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,8 @@
+require 'test_bench_bootstrap/test_bench/run/controls'
+
+require 'test_bench_bootstrap/test_bench/executable/controls/run'
+
+require 'test_bench_bootstrap/test_bench/executable/controls/path'
+require 'test_bench_bootstrap/test_bench/executable/controls/random'
+
+require 'test_bench_bootstrap/test_bench/executable/controls/standard_input'

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

@@ -0,0 +1,15 @@
+module TestBenchBootstrap
+  module TestBench
+    class Executable
+      module Defaults
+        def self.path
+          ENV.fetch('TEST_BENCH_DEFAULT_TEST_PATH', 'test/automated')
+        end
+
+        def self.program_name
+          $PROGRAM_NAME || 'bench'
+        end
+      end
+    end
+  end
+end

data/upstream-lib/test_bench_bootstrap/test_bench/executable/executable.rb

@@ -0,0 +1,61 @@
+module TestBenchBootstrap
+  module TestBench
+    class Executable
+      def run
+        @run ||= Run::Substitute.build
+      end
+      attr_writer :run
+
+      def arguments
+        @arguments ||= []
+      end
+      attr_writer :arguments
+
+      def stdin
+        @stdin ||= STDIN
+      end
+      attr_writer :stdin
+
+      def self.build(arguments=nil, env: nil)
+        instance = new
+
+        arguments = ParseArguments.(arguments, env:)
+        instance.arguments = arguments
+
+        Run.configure(instance)
+
+        instance
+      end
+
+      def self.call(arguments=nil, env: nil)
+        instance = build(arguments, env:)
+        instance.()
+      end
+
+      def call
+        result = run.() do
+          if not stdin.tty?
+            until stdin.eof?
+              path = stdin.gets(chomp: true)
+
+              next if path.empty?
+
+              run << path
+            end
+          end
+
+          arguments.each do |path|
+            run << path
+          end
+
+          if not run.ran?
+            run << Defaults.path
+          end
+        end
+
+        exit_code = result ? 0 : 1
+        exit_code
+      end
+    end
+  end
+end

data/upstream-lib/test_bench_bootstrap/test_bench/executable/parse_arguments.rb

@@ -0,0 +1,271 @@
+module TestBenchBootstrap
+  module TestBench
+    class Executable
+      class ParseArguments
+        Error = Class.new(RuntimeError)
+
+        def writer
+          @writer ||= Output::Writer::Substitute.build
+        end
+        attr_writer :writer
+
+        def env
+          @env ||= {}
+        end
+        attr_writer :env
+
+        def non_switch_arguments
+          @non_switch_arguments ||= []
+        end
+
+        attr_reader :raw_arguments
+
+        def initialize(raw_arguments)
+          @raw_arguments = raw_arguments
+        end
+
+        def self.build(arguments=nil, env: nil)
+          arguments ||= ::ARGV
+          env ||= ::ENV
+
+          instance = new(arguments)
+
+          instance.env = env
+
+          Output::Writer.configure(instance)
+
+          instance
+        end
+
+        def self.call(arguments=nil, env: nil)
+          instance = build(arguments, env:)
+          instance.()
+        end
+
+        def call
+          loop do
+            switch = next_switch
+
+            case switch
+            when '--', nil
+              break
+
+            when '-a', '--abort-on-failure'
+              env['TEST_BENCH_ABORT_ON_FAILURE'] = 'on'
+
+            when '-x', '--exclude'
+              exclude_pattern = require_next_argument(switch)
+
+              env['TEST_BENCH_EXCLUDE_FILE_PATTERN'] = [
+                env['TEST_BENCH_EXCLUDE_FILE_PATTERN'],
+                exclude_pattern
+              ].compact.join(':')
+            when '-X', '--no-exclude'
+              env['TEST_BENCH_EXCLUDE_FILE_PATTERN'] = ''
+
+            when '-s', '--strict'
+              env['TEST_BENCH_STRICT'] = 'on'
+            when '-S', '--no-strict'
+              env['TEST_BENCH_STRICT'] = 'off'
+
+            when '-r', '--require'
+              library = require_next_argument(switch)
+              require(library)
+            when '-I', '--include'
+              load_path = require_next_argument(switch)
+              if not $LOAD_PATH.include?(load_path)
+                $LOAD_PATH << load_path
+              end
+
+            when '--random-seed'
+              seed = require_next_argument(switch)
+              env['TEST_BENCH_RANDOM_SEED'] = seed
+
+            when '-b', '--omit-backtrace'
+              omit_pattern = require_next_argument(switch)
+
+              env['TEST_BENCH_OMIT_BACKTRACE_PATTERN'] = [
+                env['TEST_BENCH_OMIT_BACKTRACE_PATTERN'],
+                omit_pattern
+              ].compact.join(':')
+
+            when '-d', '--detail'
+              env['TEST_BENCH_OUTPUT_DETAIL'] = 'on'
+            when '-D', '--no-detail'
+              env['TEST_BENCH_OUTPUT_DETAIL'] = 'off'
+
+            when '--device'
+              device = require_next_argument(switch)
+              env['TEST_BENCH_OUTPUT_DEVICE'] = device
+
+            when '-l', '--output-level'
+              output_level = require_next_argument(switch)
+              env['TEST_BENCH_OUTPUT_LEVEL'] = output_level
+            when '-q', '--quiet'
+              env['TEST_BENCH_OUTPUT_LEVEL'] = 'not-passing'
+
+            when '-o', '--output-styling'
+              env['TEST_BENCH_OUTPUT_STYLING'] = 'on'
+            when '-O', '--no-output-styling'
+              env['TEST_BENCH_OUTPUT_STYLING'] = 'off'
+
+            when '--no-summary'
+              env['TEST_BENCH_OUTPUT_SUMMARY'] = 'off'
+
+            when '-h', '--help'
+              writer.write(<<~TEXT)
+  Usage: #{Defaults.program_name} [options] [paths]
+
+  Informational Options:
+    Help:
+        -h, --help
+            Print this help message and exit immediately
+
+  Execution Options:
+    Abort On Failure:
+        -a, --abort-on-failure
+            Stops execution if a test fails or a test file aborts
+
+    Exclude File Patterns:
+        -x, --exclude PATTERN
+            Exclude test files that match PATTERN
+            If multiple --exclude arguments are supplied, then files that match any will be excluded
+        -X, --no-exclude
+            Don't exclude any files
+        Default: '*_init.rb'
+
+    Strict:
+        -s, --strict
+            Prohibit skipped tests and contexts, and require at least one test to be performed
+        -S, --no-strict
+            Relax strictness
+        Default: non strict, unless TEST_BENCH_STRICT is set to 'on'
+
+    Require Library:
+        -r, --require LIBRARY
+            Require LIBRARY before running any files
+        -I, --include DIR
+            Add DIR to the load path
+
+    Random Seed:
+        --random-seed SEED
+            Pseudorandom number seed
+
+  Output Options:
+    Backtrace Formatting:
+        -b, --omit-backtrace PATTERN
+            Omits backtrace frames that match PATTERN
+            If multiple --omit-backtrace arguments are supplied, then frames that match any will be omitted
+
+    Detail:
+        -d, --detail
+            Always show details
+        -D, --no-detail
+            Never show details
+        Default: print details when their surrounding context failed, unless TEST_DETAIL is set to 'on' or 'off'
+
+    Device:
+        --device DEVICE
+            stderr: redirect output to standard error
+            null: don't write any output
+        Default: stdout
+
+    Verbosity:
+        -l, --output-level LEVEL
+            all: print output from every file
+            not-passing: print output from files that skip tests and contexts or don't perform any tests
+            failure: print output only from files that failed or aborted
+            abort: print output only from file that aborted
+        -q, --quiet
+            Sets output verbosity level to 'not-passing'
+        Default: all
+
+    Styling:
+        -o, --output-styling
+            Enable output text styling
+        -O, --no-output-styling
+            Disable output text styling
+        Default: enabled if the output device is an interactive terminal
+
+    Summary:
+        --no-summary
+            Don't print summary after running files
+
+  Paths to test files (and directories containing test files) can be given after any command line arguments or via STDIN (or both).
+
+  If no paths are given, the directory '#{Defaults.path}' is scanned for test files.
+
+  The following environment variables can also control execution:
+
+    TEST_BENCH_ABORT_ON_FAILURE           See --abort-on-failure
+    TEST_BENCH_EXCLUDE_FILE_PATTERN       See --exclude
+    TEST_BENCH_OUTPUT_SUMMARY             See --no-summary
+    TEST_BENCH_STRICT                     See --strict
+    TEST_BENCH_RANDOM_SEED                See --random-seed
+    TEST_BENCH_FILTER_BACKTRACE_PATTERN   See --filter-backtrace
+    TEST_BENCH_OUTPUT_DETAIL              See --detail
+    TEST_BENCH_OUTPUT_DEVICE              See --device
+    TEST_BENCH_OUTPUT_LEVEL               See --output-level
+    TEST_BENCH_OUTPUT_STYLING             See --output-styling
+    TEST_BENCH_DEFAULT_TEST_PATH          Specifies default path
+
+              TEXT
+              exit(true)
+
+            else
+              raise Error, "Incorrect switch #{switch}"
+            end
+          end
+
+          remaining_arguments
+        end
+
+        def remaining_arguments
+          non_switch_arguments + raw_arguments
+        end
+        alias :arguments :remaining_arguments
+
+        def require_next_argument(switch_text)
+          argument = next_argument
+
+          if argument.nil?
+            raise Error, "Switch #{switch_text} requires an argument"
+          end
+
+          argument
+        end
+
+        def next_argument
+          next_argument = raw_arguments.shift
+
+          if next_argument.nil?
+            nil
+          elsif switch?(next_argument)
+            raw_arguments.unshift(next_argument)
+            nil
+          else
+            next_argument
+          end
+        end
+
+        def next_switch
+          until raw_arguments.empty?
+            argument = raw_arguments.shift
+
+            if switch?(argument)
+              return argument
+            end
+
+            non_switch_arguments << argument
+          end
+
+          nil
+        end
+
+        def switch?(argument)
+          argument.start_with?('-')
+        end
+      end
+    end
+  end
+end

data/upstream-lib/test_bench_bootstrap/test_bench/executable.rb

@@ -0,0 +1,7 @@
+require 'test_bench_bootstrap/test_bench/run'
+
+require 'test_bench_bootstrap/test_bench/executable/defaults'
+
+require 'test_bench_bootstrap/test_bench/executable/parse_arguments'
+
+require 'test_bench_bootstrap/test_bench/executable/executable'

data/upstream-lib/test_bench_bootstrap/test_bench/fixture/build.rb

@@ -0,0 +1,41 @@
+module TestBenchBootstrap
+  module TestBench
+    module Fixture
+      module Build
+        Error = ::Class.new(RuntimeError)
+
+        def self.call(fixture_class, *, test_session: nil, **, &)
+          assure_fixture(fixture_class)
+
+          if fixture_class.respond_to?(:build)
+            constructor = :build
+          else
+            constructor = :new
+          end
+
+          fixture = fixture_class.public_send(constructor, *, **, &)
+
+          Session.configure(
+            fixture,
+            session: test_session,
+            attr_name: :test_session
+          )
+
+          fixture
+        end
+
+        def self.assure_fixture(fixture_class)
+          is_class = fixture_class.instance_of?(::Class)
+          if not is_class
+            raise Error, "Not a class (Class: #{fixture_class})"
+          end
+
+          is_fixture_class = fixture_class.included_modules.include?(Fixture)
+          if not is_fixture_class
+            raise Error, "Not a fixture class (Class: #{fixture_class})"
+          end
+        end
+      end
+    end
+  end
+end

data/upstream-lib/test_bench_bootstrap/test_bench/fixture/controls/comment_style.rb

@@ -0,0 +1,9 @@
+module TestBenchBootstrap
+  module TestBench
+    module Fixture
+      module Controls
+        CommentStyle = Output::CommentStyle
+      end
+    end
+  end
+end