test_bench 1.0.0.0 → 1.2.0.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: '0359bdc17397c6a467d757d2c50851ebe475625536e04ebbb2e65b1bb804d3fd'
-  data.tar.gz: 4db8e6a9084c79383349d9eaafd9b88911316174654ce0c26a91e68fff2e6868
+  metadata.gz: afaeab0cc192ef871046e2b2080e87f9ae413a0da8a55e2893e240f76369c87e
+  data.tar.gz: 9cca5db44320b3956cbb8754251703087024411d274e608a2d731ce6c7a2729d
 SHA512:
-  metadata.gz: 2fb8769efb25591f4eb2bbc1c3b1c0a5b185bb5a3853c224ca8998467564023196a0142413f4380d19d9dd26ecd6e5fd93d91f74034a3852dd567b527277266c
-  data.tar.gz: 48252b7032528645d743e4a1f52faaf95f61763c17c6ad4078d1f208610f529a2acff4318f5446efb140df63a9323df3d08b0fdd7c5e56f0824db7af8bcc46cd
+  metadata.gz: 80da06a441f1f3a547a62ee37fbf36f1d6c1c9541bd240c82fc94d7d380da1f6ddf717d6a626c5f50161488dfe4178057e14c59183ad751660bf8627fc322db4
+  data.tar.gz: 42d0355bb4f6c81a1819da5cfffa1fd41ece43b1f1a2e14600e5f52a9ef53f11a10309c792862bef9557bfe62a5e44a644883dda4b427b362fd813f8c2361c0b

data/lib/test_bench.rb

@@ -14,17 +14,17 @@ 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/summary'
+require 'test_bench/output/summary/session'
 
-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/batch_data'
+
+require 'test_bench/output/raw'
+
+require 'test_bench/output/buffer'
+
+require 'test_bench/output/log'
 
-require 'test_bench/output/build'
 require 'test_bench/output'
 
 require 'test_bench/test_bench'

data/lib/test_bench/cli.rb

@@ -1,6 +1,6 @@
 module TestBench
   module CLI
-    def self.call(tests_directory=nil, **runner_args)
+    def self.call(tests_directory=nil, exclude_file_pattern: nil)
       tests_directory ||= Defaults.tests_directory
 
       path_arguments = ParseArguments.()
@@ -11,7 +11,7 @@ module TestBench
         warn "$stdin is a pipe, but no data was written to it; no test files will be run"
       end
 
-      Run.(**runner_args) do |run|
+      Run.(exclude: exclude_file_pattern) do |run|
         if read_stdin
           until $stdin.eof?
             path = $stdin.gets.chomp

data/lib/test_bench/cli/parse_arguments.rb

@@ -62,11 +62,23 @@ module TestBench
           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|
+          parser.on('-a', '--[no-]abort-on-error', %{Exit immediately after any test failure or error (Default: #{TestBench::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|
+          parser.on('-d', '--[no-]detail [DETAIL]', %{Always show (or hide) details (Default: #{Output::Raw::Defaults.detail})}) do |detail|
+            if detail.nil?
+              detail = 'on'
+            elsif detail == true
+              detail = 'on'
+            elsif detail == false
+              detail = 'off'
+            end
+
+            env['TEST_BENCH_DETAIL'] = detail
+          end
+
+          parser.on('-x', '--[no-]exclude PATTERN', %{Do not execute test files matching PATTERN (Default: #{Run::Defaults.exclude_pattern.inspect})}) do |pattern_text|
             if pattern_text == false
               pattern_text = self.none_pattern
             end
@@ -76,6 +88,14 @@ module TestBench
             env['TEST_BENCH_EXCLUDE_FILE_PATTERN'] = pattern_text
           end
 
+          parser.on('-l', '--log-level LEVEL', %{Set the internal logging level to LEVEL (Default: #{Output::Log::Defaults.level})}) do |level_text|
+            level = level_text.to_sym
+
+            Fixture::Output::Log.assure_level(level)
+
+            env['TEST_BENCH_LOG_LEVEL'] = level_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
@@ -86,25 +106,17 @@ module TestBench
             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|
+          parser.on('-s', '--output-styling [on|off|detect]', %{Render output coloring and font styling escape codes (Default: #{Output::Writer::Defaults.styling})}) do |styling_text|
             styling_text ||= 'on'
 
-            styling_setting = styling_text.to_sym
+            styling = styling_text.to_sym
 
-            Output::Writer.assure_styling_setting(styling_setting)
+            Output::Writer.assure_styling_setting(styling)
 
             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|
+          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: #{!TestBench::Defaults.fail_deactivated_tests ? 'on' : 'off'})}) do |permit_deactivated_tests|
             env['TEST_BENCH_FAIL_DEACTIVATED_TESTS'] = !permit_deactivated_tests ? 'on' : 'off'
           end
 
@@ -112,6 +124,10 @@ module TestBench
             env['TEST_BENCH_REVERSE_BACKTRACES'] = reverse_backtraces ? 'on' : 'off'
           end
 
+          parser.on('-v', '--[no-]verbose', %{Increase output verbosity (Default: #{Output::Raw::Defaults.verbose ? 'on' : 'off'})}) do |verbose|
+            env['TEST_BENCH_VERBOSE'] = verbose ? '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).
@@ -120,17 +136,14 @@ module TestBench
           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_DETAIL                  Same as -d or --detail
           #{parser.summary_indent}TEST_BENCH_EXCLUDE_FILE_PATTERN    Same as -x or --exclude-file-pattern
+          #{parser.summary_indent}TEST_BENCH_LOG_LEVEL               Same as -l or --log-level
           #{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.
+          #{parser.summary_indent}TEST_BENCH_VERBOSE                 Same as -v or --reverse-backtraces
 
           TEXT
         end

data/lib/test_bench/controls.rb

@@ -18,5 +18,9 @@ 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/exercise'
+require 'test_bench/controls/output/summary/session'
 require 'test_bench/controls/output/summary/error'
+require 'test_bench/controls/output/batch_data'
+require 'test_bench/controls/output/detail_setting'
+require 'test_bench/controls/output/log_level'

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

@@ -0,0 +1,52 @@
+module TestBench
+  module Controls
+    module Output
+      module BatchData
+        def self.example(result: nil, depth: nil)
+          result = self.result if result.nil?
+          depth ||= self.depth
+
+          TestBench::Output::BatchData.new(result, depth)
+        end
+
+        def self.result
+          Pass.result
+        end
+
+        def self.depth
+          1
+        end
+
+        module Pass
+          def self.example(depth: nil)
+            BatchData.example(result: result, depth: depth)
+          end
+
+          def self.result
+            Result::Pass.example
+          end
+        end
+
+        module Failure
+          def self.example(depth: nil)
+            BatchData.example(result: result, depth: depth)
+          end
+
+          def self.result
+            Result::Failure.example
+          end
+        end
+
+        module Toplevel
+          def self.example(result: nil)
+            BatchData.example(depth: depth, result: result)
+          end
+
+          def self.depth
+            0
+          end
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,29 @@
+module TestBench
+  module Controls
+    module Output
+      module DetailSetting
+        def self.example
+          failure
+        end
+
+        def self.failure
+          :failure
+        end
+
+        def self.on
+          :on
+        end
+
+        def self.off
+          :off
+        end
+
+        module Invalid
+          def self.example
+            :not_a_detail_setting
+          end
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,7 @@
+module TestBench
+  module Controls
+    module Output
+      Exercise = TestBench::Fixture::Controls::Output::Exercise
+    end
+  end
+end

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

@@ -0,0 +1,7 @@
+module TestBench
+  module Controls
+    module Output
+      LogLevel = TestBench::Fixture::Controls::Output::Log::Level
+    end
+  end
+end

data/lib/test_bench/controls/output/summary/error.rb

@@ -3,22 +3,6 @@ module TestBench
     module Output
       module Summary
         module Error
-          def self.example(writer: nil)
-            error_summary = Example.new
-            error_summary.writer = writer unless writer.nil?
-            error_summary
-          end
-
-          class Example
-            include TestBench::Fixture::Output
-            include TestBench::Output::Summary::Error
-
-            TestBench::Fixture::Output.instance_methods.each do |method|
-              define_method(method) do |*|
-              end
-            end
-          end
-
           module Text
             def self.example
               <<~TEXT

data/lib/test_bench/controls/output/summary/session.rb

@@ -0,0 +1,20 @@
+module TestBench
+  module Controls
+    module Output
+      module Summary
+        module Session
+          module Text
+            def self.example
+              <<~TEXT
+              Finished running 0 files
+              Ran 0 tests in 0.000s (0.0 tests/second)
+              0 passed, 0 skipped, 0 failed, 0 total errors
+
+              TEXT
+            end
+          end
+        end
+      end
+    end
+  end
+end

data/lib/test_bench/controls/pattern.rb

@@ -1,8 +1,12 @@
 module TestBench
   module Controls
     module Pattern
-      def self.example
-        /#{text}/
+      def self.example(text=nil)
+        text ||= self.text
+
+        escaped_text = Regexp.escape(text)
+
+        Regexp.new(escaped_text)
       end
 
       def self.text

data/lib/test_bench/controls/time.rb

@@ -55,6 +55,24 @@ module TestBench
             "1.111s"
           end
         end
+
+        module PerSecond
+          def self.example
+            elapsed_time = Elapsed.example
+
+            Rational(ocurrences, elapsed_time)
+          end
+
+          def self.ocurrences
+            1
+          end
+
+          module Text
+            def self.example
+              "0.9"
+            end
+          end
+        end
       end
     end
   end

data/lib/test_bench/deactivation_variants.rb

@@ -1,21 +1,11 @@
 module TestBench
   module DeactivationVariants
     def _context(title=nil, &block)
-      test_session.fail! if Defaults.fail_session
-
       context(title)
     end
 
     def _test(title=nil, &block)
-      test_session.fail! if Defaults.fail_session
-
       test(title)
     end
-
-    module Defaults
-      def self.fail_session
-        Environment::Boolean.fetch('TEST_BENCH_FAIL_DEACTIVATED_TESTS', true)
-      end
-    end
   end
 end

data/lib/test_bench/output.rb

@@ -1,7 +1,19 @@
 module TestBench
   module Output
-    def self.build(**args)
-      Build.(**args)
+    def self.build(log_level: nil, writer: nil, device: nil, styling: nil, **buffer_output_args)
+      summary = Summary.build(writer: writer, device: device, styling: styling)
+
+      log_output = Log.build(level: log_level)
+
+      writer = summary.writer
+
+      buffer_output = Buffer.build(writer: writer, **buffer_output_args)
+
+      Fixture::Output::Multiple.build(
+        log_output,
+        buffer_output,
+        summary
+      )
     end
 
     Substitute = Fixture::Output::Substitute

data/lib/test_bench/output/batch_data.rb

@@ -0,0 +1,17 @@
+module TestBench
+  module Output
+    BatchData = Struct.new(:result, :depth) do
+      def passed?
+        result
+      end
+
+      def failed?
+        !result
+      end
+
+      def toplevel?
+        depth.zero?
+      end
+    end
+  end
+end

data/lib/test_bench/output/buffer.rb

@@ -0,0 +1,112 @@
+module TestBench
+  module Output
+    class Buffer < Fixture::Output::Capture
+      attr_accessor :writer
+
+      def raw_output
+        @raw_output ||= Raw.new
+      end
+      attr_writer :raw_output
+
+      def stack
+        @stack ||= []
+      end
+
+      def self.build(verbose: nil, detail: nil, omit_backtrace_pattern: nil, reverse_backtraces: nil, writer: nil, device: nil, styling: nil)
+        instance = new
+
+        raw_output = Raw.configure(instance, verbose: verbose, detail: detail, omit_backtrace_pattern: omit_backtrace_pattern, reverse_backtraces: reverse_backtraces, writer: writer, device: device, styling: styling)
+
+        instance.writer = raw_output.writer
+
+        instance
+      end
+
+      def exit_context(*)
+        super
+
+        flush unless buffering?
+      end
+
+      def finish_test(*)
+        super
+
+        flush unless buffering?
+      end
+
+      def finish_fixture(*)
+        super
+
+        flush unless buffering?
+      end
+
+      def new_record(signal, data)
+        record = Record.new(signal, data)
+
+        case signal
+        when :enter_context, :start_test, :start_fixture
+          start_batch(record)
+
+        when :exit_context, :finish_test, :finish_fixture
+          result = record.data.last
+
+          finish_batch(record, result)
+        end
+
+        record
+      end
+
+      def start_batch(record)
+        record.start_batch(stack_depth)
+
+        stack.push(record)
+      end
+
+      def finish_batch(final_record, result)
+        first_record = stack.pop
+
+        batch_data = first_record.batch_data
+        batch_data.result = result
+
+        final_record.batch_data = first_record.batch_data
+      end
+
+      def flush
+        records.each do |record|
+          record.forward(raw_output)
+        end
+
+        records.clear
+      end
+
+      def buffering?
+        stack_depth.nonzero?
+      end
+
+      def stack_depth
+        stack.length
+      end
+
+      class Record < Fixture::Output::Capture::Record
+        attr_accessor :batch_data
+
+        def forward(raw_output)
+          return super if batch_data.nil?
+
+          raw_output.public_send(signal, *data, batch_data: batch_data)
+        end
+
+        def start_batch(depth)
+          batch_data = Output::BatchData.new
+          batch_data.depth = depth
+
+          self.batch_data = batch_data
+        end
+
+        def finish_batch(result)
+          batch_data.result = result
+        end
+      end
+    end
+  end
+end