test_bench 1.0.0.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: '0359bdc17397c6a467d757d2c50851ebe475625536e04ebbb2e65b1bb804d3fd'
+  data.tar.gz: 4db8e6a9084c79383349d9eaafd9b88911316174654ce0c26a91e68fff2e6868
+SHA512:
+  metadata.gz: 2fb8769efb25591f4eb2bbc1c3b1c0a5b185bb5a3853c224ca8998467564023196a0142413f4380d19d9dd26ecd6e5fd93d91f74034a3852dd567b527277266c
+  data.tar.gz: 48252b7032528645d743e4a1f52faaf95f61763c17c6ad4078d1f208610f529a2acff4318f5446efb140df63a9323df3d08b0fdd7c5e56f0824db7af8bcc46cd

data/lib/test_bench.rb

@@ -0,0 +1,37 @@
+require 'optionparser'
+
+require 'test_bench/fixture'
+
+require 'test_bench/environment/boolean'
+
+require 'test_bench/output/writer'
+require 'test_bench/output/writer/sgr'
+require 'test_bench/output/writer/substitute'
+require 'test_bench/output/writer/dependency'
+
+require 'test_bench/output/timer'
+require 'test_bench/output/timer/substitute'
+
+require 'test_bench/output/print_error'
+
+require 'test_bench/output/summary/run/print'
+require 'test_bench/output/summary/run'
+require 'test_bench/output/summary/error'
+
+require 'test_bench/output/levels/none'
+require 'test_bench/output/levels/summary'
+require 'test_bench/output/levels/failure'
+require 'test_bench/output/levels/debug'
+require 'test_bench/output/levels/pass'
+
+require 'test_bench/output/build'
+require 'test_bench/output'
+
+require 'test_bench/test_bench'
+require 'test_bench/deactivation_variants'
+
+require 'test_bench/run'
+require 'test_bench/run/substitute'
+
+require 'test_bench/cli/parse_arguments'
+require 'test_bench/cli'

data/lib/test_bench/cli.rb

@@ -0,0 +1,43 @@
+module TestBench
+  module CLI
+    def self.call(tests_directory=nil, **runner_args)
+      tests_directory ||= Defaults.tests_directory
+
+      path_arguments = ParseArguments.()
+
+      read_stdin = $stdin.stat.pipe?
+
+      if read_stdin && $stdin.eof?
+        warn "$stdin is a pipe, but no data was written to it; no test files will be run"
+      end
+
+      Run.(**runner_args) do |run|
+        if read_stdin
+          until $stdin.eof?
+            path = $stdin.gets.chomp
+
+            next if path.empty?
+
+            run.path(path)
+          end
+        end
+
+        if path_arguments.empty?
+          unless read_stdin
+            run.path(tests_directory)
+          end
+        else
+          path_arguments.each do |path|
+            run.path(path)
+          end
+        end
+      end
+    end
+
+    module Defaults
+      def self.tests_directory
+        ENV.fetch('TEST_BENCH_TESTS_DIRECTORY', 'test/automated')
+      end
+    end
+  end
+end

data/lib/test_bench/cli/parse_arguments.rb

@@ -0,0 +1,168 @@
+module TestBench
+  module CLI
+    class ParseArguments
+      Error = Class.new(RuntimeError)
+
+      attr_reader :argv
+
+      def env
+        @env ||= {}
+      end
+      attr_writer :env
+
+      def output_device
+        @output_device ||= StringIO.new
+      end
+      attr_writer :output_device
+
+      def initialize(argv)
+        @argv = argv
+      end
+
+      def self.build(argv=nil, env: nil)
+        argv ||= ::ARGV
+        env ||= ::ENV
+
+        instance = new(argv)
+        instance.output_device = Output::Writer::Defaults.device
+        instance.env = env
+        instance
+      end
+
+      def self.call(argv=nil, env: nil)
+        instance = build(argv, env: env)
+        instance.()
+      end
+
+      def call
+        option_parser.parse(argv)
+      end
+
+      def option_parser
+        @option_parser ||= OptionParser.new do |parser|
+          parser.banner = "Usage: #{self.class.program_name} [options] [paths]"
+
+          parser.separator('')
+          parser.separator("Informational Options")
+
+          parser.on('-h', '--help', "Print this help message and exit successfully") do
+            output_device.puts(parser.help)
+
+            exit(true)
+          end
+
+          parser.on('-V', '--version', "Print version and exit successfully") do
+            output_device.puts <<~TEXT
+            test-bench (#{self.class.program_name}) version #{self.class.version}
+            TEXT
+
+            exit(true)
+          end
+
+          parser.separator('')
+          parser.separator("Configuration Options")
+
+          parser.on('-a', '--[no-]abort-on-error', %{Exit immediately after any test failure or error (Default: #{Session::Defaults.abort_on_error ? 'on' : 'off'})}) do |abort_on_error|
+            env['TEST_BENCH_ABORT_ON_ERROR'] = abort_on_error ? 'on' : 'off'
+          end
+
+          parser.on('-x', '--[no-]exclude PATTERN', %{Do not execute test files matching PATTERN (Default: #{Run::Defaults.exclude_file_pattern.inspect})}) do |pattern_text|
+            if pattern_text == false
+              pattern_text = self.none_pattern
+            end
+
+            assure_pattern(pattern_text)
+
+            env['TEST_BENCH_EXCLUDE_FILE_PATTERN'] = pattern_text
+          end
+
+          parser.on('-o', '--[no-]omit-backtrace PATTERN', %{Omit backtrace frames matching PATTERN (Default: #{Output::PrintError::Defaults.omit_backtrace_pattern.inspect})}) do |pattern_text|
+            if pattern_text == false
+              pattern_text = self.none_pattern
+            end
+
+            assure_pattern(pattern_text)
+
+            env['TEST_BENCH_OMIT_BACKTRACE_PATTERN'] = pattern_text
+          end
+
+          parser.on('-l', '--output-level [none|summary|failure|pass|debug]', %{Sets output level (Default: #{Output::Build::Defaults.level})}) do |level_text|
+            level = level_text.to_sym
+
+            Output::Build.assure_level(level)
+
+            env['TEST_BENCH_OUTPUT_LEVEL'] = level_text
+          end
+
+          parser.on('-s', '--output-styling [on|off|detect]', %{Render output coloring and font styling escape codes (Default: #{Output::Writer::Defaults.styling_setting})}) do |styling_text|
+            styling_text ||= 'on'
+
+            styling_setting = styling_text.to_sym
+
+            Output::Writer.assure_styling_setting(styling_setting)
+
+            env['TEST_BENCH_OUTPUT_STYLING'] = styling_text
+          end
+
+          parser.on('-p', '--[no-]permit-deactivated-tests', %{Do not fail the test run if there are deactivated tests or contexts, e.g. _test or _context (Default: #{!DeactivationVariants::Defaults.fail_session ? 'on' : 'off'})}) do |permit_deactivated_tests|
+            env['TEST_BENCH_FAIL_DEACTIVATED_TESTS'] = !permit_deactivated_tests ? 'on' : 'off'
+          end
+
+          parser.on('-r', '--[no-]reverse-backtraces', %{Reverse order of backtraces when printing errors (Default: #{Output::PrintError::Defaults.reverse_backtraces ? 'on' : 'off'})}) do |reverse_backtraces|
+            env['TEST_BENCH_REVERSE_BACKTRACES'] = reverse_backtraces ? 'on' : 'off'
+          end
+
+          parser.separator(<<~TEXT)
+
+          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, a default path (#{Defaults.tests_directory}) is scanned for test files.
+
+          The following environment variables can also control execution:
+
+          #{parser.summary_indent}TEST_BENCH_ABORT_ON_ERROR          Same as -a or --abort-on-error
+          #{parser.summary_indent}TEST_BENCH_EXCLUDE_FILE_PATTERN    Same as -x or --exclude-file-pattern
+          #{parser.summary_indent}TEST_BENCH_OMIT_BACKTRACE_PATTERN  Same as -o or --omit-backtrace-pattern
+          #{parser.summary_indent}TEST_BENCH_OUTPUT_LEVEL            Same as -l or --output-level
+          #{parser.summary_indent}TEST_BENCH_OUTPUT_STYLING          Same as -s or --output-styling
+          #{parser.summary_indent}TEST_BENCH_FAIL_DEACTIVATED_TESTS  Opposite of -p or --permit-deactivated-tests
+          #{parser.summary_indent}TEST_BENCH_REVERSE_BACKTRACES      Same as -r or --reverse-backtraces
+
+          TEXT
+
+          parser.separator(<<~TEXT)
+          Finally, the VERBOSE environment variable can set the output level to debug. If given, VERBOSE will take precedence over TEST_BENCH_OUTPUT_STYLING.
+
+          TEXT
+        end
+      end
+
+      def assure_pattern(pattern_text)
+        Regexp.new(pattern_text)
+      rescue RegexpError
+        raise Error, "Invalid regular expression pattern (Pattern: #{pattern_text.inspect})"
+      end
+
+      def none_pattern
+        /\z./
+      end
+
+      def self.program_name
+        $PROGRAM_NAME
+      end
+
+      def self.version
+        if defined?(Gem)
+          spec = Gem.loaded_specs['test_bench']
+        end
+
+        spec&.version || '(unknown)'
+      end
+
+      module Defaults
+        def self.tests_directory
+          ENV.fetch('TEST_BENCH_TESTS_DIRECTORY', 'test/automated')
+        end
+      end
+    end
+  end
+end

data/lib/test_bench/controls.rb

@@ -0,0 +1,22 @@
+require 'securerandom'
+
+require 'test_bench/fixture/controls'
+
+require 'test_bench/controls/caller_location'
+require 'test_bench/controls/depth'
+require 'test_bench/controls/device'
+require 'test_bench/controls/directory'
+require 'test_bench/controls/error'
+require 'test_bench/controls/fixture'
+require 'test_bench/controls/path'
+require 'test_bench/controls/pattern'
+require 'test_bench/controls/result'
+require 'test_bench/controls/test_file'
+require 'test_bench/controls/time'
+
+require 'test_bench/controls/output/escape_code'
+require 'test_bench/controls/output/newline_character'
+require 'test_bench/controls/output/styling'
+require 'test_bench/controls/output/print_error'
+require 'test_bench/controls/output/summary/run'
+require 'test_bench/controls/output/summary/error'

data/lib/test_bench/controls/caller_location.rb

@@ -0,0 +1,5 @@
+module TestBench
+  module Controls
+    CallerLocation = TestBench::Fixture::Controls::CallerLocation
+  end
+end

data/lib/test_bench/controls/depth.rb

@@ -0,0 +1,21 @@
+module TestBench
+  module Controls
+    module Depth
+      def self.example
+        Nested.example
+      end
+
+      module Nested
+        def self.example
+          2
+        end
+      end
+
+      module Outermost
+        def self.example
+          0
+        end
+      end
+    end
+  end
+end

data/lib/test_bench/controls/device.rb

@@ -0,0 +1,27 @@
+module TestBench
+  module Controls
+    module Device
+      def self.example
+        Interactive.example
+      end
+
+      module Interactive
+        def self.example
+          device = Non.example
+
+          def device.tty?
+            true
+          end
+
+          device
+        end
+
+        module Non
+          def self.example
+            StringIO.new
+          end
+        end
+      end
+    end
+  end
+end

data/lib/test_bench/controls/directory.rb

@@ -0,0 +1,15 @@
+module TestBench
+  module Controls
+    module Directory
+      def self.example
+        Dir.mktmpdir
+      end
+
+      module NonExistent
+        def self.example
+          "/tmp/#{SecureRandom.hex(7)}"
+        end
+      end
+    end
+  end
+end

data/lib/test_bench/controls/error.rb

@@ -0,0 +1,35 @@
+module TestBench
+  module Controls
+    Error = TestBench::Fixture::Controls::Error
+
+    module Error
+      module Text
+        def self.example(message=nil, indentation_depth: nil)
+          indentation_depth ||= 0
+
+          indent = '  ' * indentation_depth
+
+          error = Error.example(message)
+
+          <<~TEXT
+          #{indent}#{error.backtrace[0]}: #{error.message} (#{error.class.name})
+          \t#{indent}from #{error.backtrace[1]}
+          \t#{indent}from #{error.backtrace[2]}
+          TEXT
+        end
+
+        module Assertion
+          def self.example(caller_location: nil)
+            caller_location ||= CallerLocation.example
+
+            assertion_failure = TestBench::Fixture::AssertionFailure.build(caller_location)
+
+            <<~TEXT
+            #{assertion_failure.backtrace[0]}: #{assertion_failure.message} (#{assertion_failure.class.name})
+            TEXT
+          end
+        end
+      end
+    end
+  end
+end

data/lib/test_bench/controls/fixture.rb

@@ -0,0 +1,29 @@
+module TestBench
+  module Controls
+    module Fixture
+      def self.example(output=nil, error_policy: nil)
+        error_policy ||= self.error_policy
+
+        fixture = Example.new
+
+        TestBench::Fixture::ErrorPolicy.configure(fixture.test_session, policy: error_policy)
+
+        unless output.nil?
+          fixture.test_session.output = output
+        end
+
+        fixture
+      end
+
+      def self.example_class(&block)
+        TestBench::Fixture::Controls::Fixture.example_class(&block)
+      end
+
+      def self.error_policy
+        :rescue
+      end
+
+      Example = example_class
+    end
+  end
+end

data/lib/test_bench/controls/output/escape_code.rb

@@ -0,0 +1,23 @@
+module TestBench
+  module Controls
+    module Output
+      module EscapeCode
+        def self.example
+          '1'
+        end
+
+        module ID
+          def self.example
+            :bold
+          end
+
+          module Unknown
+            def self.example
+              :unknown
+            end
+          end
+        end
+      end
+    end
+  end
+end