test_bench-session 2.1.3.2 → 3.0.0.0.pre.2

data/lib/test_bench/session/substitute.rb

@@ -6,68 +6,109 @@ module TestBench
       end
 
       class Session < Session
-        attr_accessor :result
-
         def sink
-          @sink ||= Sink.new
+          @sink ||= Sink.build(trace)
+        end
+
+        attr_accessor :record_file_not_found
+
+        def record_file_not_found!
+          self.record_file_not_found = true
         end
-        attr_writer :sink
 
         def self.build
           instance = new
 
+          sink = instance.sink
+
           telemetry = instance.telemetry
-          telemetry.register(instance.sink)
+          telemetry.register(sink)
 
           instance
         end
 
-        def one_passing_test_finished_event?(*, **)
-          one_test_finished_event?(*, result: true, **)
+        def executed?(...)
+          isolate.executed?(...)
         end
-        alias :one_test_passed? :one_passing_test_finished_event?
 
-        def one_passing_test_finished_event(*, **)
-          one_test_finished_event(*, result: true, **)
+        def file_not_found?(_file_path)
+          record_file_not_found ? true : false
         end
-        alias :one_passing_test :one_passing_test_finished_event
 
-        def any_passing_test_finished_event?(*, **)
-          any_test_finished_event?(*, result: true, **)
+        def one_passed_test_finished_event?(*, **)
+          result = Result.passed
+
+          one_test_finished_event?(*, **, result:)
         end
-        alias :passing_test_finished_event? :any_passing_test_finished_event?
-        alias :test_passed? :passing_test_finished_event?
+        alias :one_test_passed? :one_passed_test_finished_event?
+
+        def one_passed_test_finished_event(*, **)
+          result = Result.passed
 
-        def passing_test_finished_events(*, **)
-          test_finished_events(*, result: true, **)
+          one_test_finished_event(*, **, result:)
         end
-        alias :passing_tests :passing_test_finished_events
+        alias :one_passed_test :one_passed_test_finished_event
 
-        def one_failing_test_finished_event?(*, **)
-          one_test_finished_event?(*, result: false, **)
+        def any_passed_test_finished_event?(*, **)
+          result = Result.passed
+
+          any_test_finished_event?(*, **, result:)
         end
-        alias :one_test_failed? :one_failing_test_finished_event?
+        alias :any_test_passed? :any_passed_test_finished_event?
+        alias :test_passed? :any_test_passed?
+
+        def passed_test_finished_events(*, **)
+          result = Result.passed
 
-        def one_failing_test_finished_event(*, **)
-          one_test_finished_event(*, result: false, **)
+          test_finished_events(*, **, result:)
         end
-        alias :one_failing_test :one_failing_test_finished_event
+        alias :passed_tests :passed_test_finished_events
+
+        def one_failed_test_finished_event?(*, **)
+          result = Result.failed
 
-        def any_failing_test_finished_event?(*, **)
-          any_test_finished_event?(*, result: false, **)
+          one_test_finished_event?(*, **, result:)
         end
-        alias :failing_test_finished_event? :any_failing_test_finished_event?
-        alias :test_failed? :failing_test_finished_event?
+        alias :one_test_failed? :one_failed_test_finished_event?
 
-        def failing_test_finished_events(*, **)
-          test_finished_events(*, result: false, **)
+        def one_failed_test_finished_event(*, **)
+          result = Result.failed
+
+          one_test_finished_event(*, **, result:)
         end
-        alias :failing_tests :failing_test_finished_events
+        alias :one_failed_test :one_failed_test_finished_event
+
+        def any_failed_test_finished_event?(*, **)
+          result = Result.failed
 
-        Events.each_type do |event_type|
-          event_name = TestBench::Telemetry::Event::EventName.get(event_type)
+          any_test_finished_event?(*, **, result:)
+        end
+        alias :any_test_failed? :any_failed_test_finished_event?
+        alias :test_failed? :any_test_failed?
 
-          event_class = Events.const_get(event_type, false)
+        def failed_test_finished_events(*, **)
+          result = Result.failed
+
+          test_finished_events(*, **, result:)
+        end
+        alias :failed_tests :failed_test_finished_events
+
+        [
+          Events::Failed,
+          Events::Aborted,
+          Events::Skipped,
+          Events::Commented,
+          Events::Detailed,
+          Events::TestStarted,
+          Events::TestFinished,
+          Events::ContextStarted,
+          Events::ContextFinished,
+          Events::FileQueued,
+          Events::FileExecuted,
+          Events::FileNotFound
+        ].each do |event_class|
+
+          event_name = event_class.event_name
 
           module_eval(<<~RUBY, __FILE__, __LINE__)
           def one_#{event_name}_event?(...)
@@ -89,29 +130,27 @@ module TestBench
           RUBY
         end
 
-        alias :failure? :failed_event?
-        alias :one_failure? :one_failed_event?
-
-        alias :test? :test_finished_event?
-        alias :one_test? :one_test_finished_event?
-
-        alias :context? :context_finished_event?
-        alias :one_context? :one_context_finished_event?
-
-        alias :comment? :commented_event?
+        alias :comment? :any_commented_event?
         alias :one_comment? :one_commented_event?
-
-        alias :detail? :detailed_event?
+        alias :detail? :any_detailed_event?
         alias :one_detail? :one_detailed_event?
 
-        alias :fixture? :fixture_finished_event?
-        alias :one_fixture? :one_fixture_finished_event?
+        def one_event?(...)
+          sink.one_event?(...)
+        end
 
-        def one_event?(...) = sink.one_event?(...)
-        def one_event(...) = sink.one_event(...)
-        def any_event?(...) = sink.any_event?(...)
+        def any_event?(...)
+          sink.any_event?(...)
+        end
         alias :event? :any_event?
-        def events(...) = sink.events(...)
+
+        def one_event(...)
+          sink.one_event(...)
+        end
+
+        def events(...)
+          sink.events(...)
+        end
       end
     end
   end

data/lib/test_bench/session/trace.rb

@@ -0,0 +1,51 @@
+module TestBench
+  class Session
+    class Trace
+      include Enumerable
+
+      def entries
+        @entries ||= []
+      end
+      attr_writer :entries
+
+      def push(entry)
+        entries.push(entry)
+      end
+
+      def pop
+        entries.pop
+      end
+
+      def match?(*context_titles, compare_text)
+        if compare_text != entries.last
+          return false
+        end
+
+        context_title_iterator = entries[0...-1].to_enum
+
+        context_titles.all? do |context_title|
+          title = context_title_iterator.next until title == context_title
+
+          true
+
+        rescue StopIteration
+          false
+        end
+      end
+
+      def each(...)
+        entries.each(...)
+      end
+
+      def join(delimiter=nil)
+        delimiter ||= self.class.join_delimiter
+
+        entries.join(delimiter)
+      end
+
+      def self.join_delimiter
+        ' :: '
+      end
+    end
+  end
+end

data/lib/test_bench/session.rb

@@ -1,22 +1,22 @@
-require 'test_bench/output'
+require 'test_bench/telemetry'
+
+require 'test_bench/session/defaults'
+
+require 'test_bench/session/result'
+
+require 'test_bench/session/exception/format_backtrace'
+require 'test_bench/session/exception/format_backtrace/substitute'
 
 require 'test_bench/session/events'
 
-require 'test_bench/session/session'
+require 'test_bench/session/trace'
 
-require 'test_bench/session/substitute/path'
-require 'test_bench/session/substitute/sink'
-require 'test_bench/session/substitute'
+require 'test_bench/session/status'
 
-require 'test_bench/session/projection'
+require 'test_bench/session/isolate'
+require 'test_bench/session/isolate/substitute'
 
-require 'test_bench/session/output/writer'
-require 'test_bench/session/output/writer/defaults'
-require 'test_bench/session/output/writer/substitute'
-require 'test_bench/session/output/writer/buffer/interactive/viewport'
-require 'test_bench/session/output/writer/buffer/interactive'
-require 'test_bench/session/output/writer/buffer'
-require 'test_bench/session/output'
-require 'test_bench/session/output/get'
+require 'test_bench/session/session'
 
-require 'test_bench/session/store'
+require 'test_bench/session/substitute/sink'
+require 'test_bench/session/substitute'

metadata

@@ -1,17 +1,15 @@
 --- !ruby/object:Gem::Specification
 name: test_bench-session
 version: !ruby/object:Gem::Version
-  version: 2.1.3.2
+  version: 3.0.0.0.pre.2
 platform: ruby
 authors:
-- Nathan Ladd
-autorequire:
+- Brightworks Digital
 bindir: bin
 cert_chain: []
-date:
 dependencies:
 - !ruby/object:Gem::Dependency
-  name: test_bench-output
+  name: test_bench-telemetry
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
@@ -25,7 +23,7 @@ dependencies:
       - !ruby/object:Gem::Version
         version: '0'
 - !ruby/object:Gem::Dependency
-  name: test_bench-isolated
+  name: test_bench-bootstrap
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
@@ -38,8 +36,12 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: '0'
-description:
-email: nathanladd+github@gmail.com
+description: 'TestBench::Session implements the core testing mechanisms of TestBench:
+  tests, contexts, comments, assertions, and test file execution. Sessions also maintain
+  the pass/fail status of the test run. A diagnostic substitute session is also included
+  that records session telemetry so that test abstractions built using TestBench (called
+  "Fixtures") can observed and tested in isolation.'
+email: development@bright.works
 executables: []
 extensions: []
 extra_rdoc_files: []
@@ -47,64 +49,71 @@ files:
 - lib/test_bench
 - lib/test_bench/session
 - lib/test_bench/session/controls
-- lib/test_bench/session/controls/comment.rb
-- lib/test_bench/session/controls/detail.rb
+- lib/test_bench/session/controls/backtrace
+- lib/test_bench/session/controls/backtrace/location.rb
+- lib/test_bench/session/controls/backtrace.rb
+- lib/test_bench/session/controls/comment_disposition.rb
 - lib/test_bench/session/controls/event.rb
 - lib/test_bench/session/controls/events
+- lib/test_bench/session/controls/events/aborted.rb
 - lib/test_bench/session/controls/events/commented.rb
 - lib/test_bench/session/controls/events/context_finished.rb
-- lib/test_bench/session/controls/events/context_skipped.rb
 - lib/test_bench/session/controls/events/context_started.rb
 - lib/test_bench/session/controls/events/detailed.rb
-- lib/test_bench/session/controls/events/event_data.rb
 - lib/test_bench/session/controls/events/failed.rb
-- lib/test_bench/session/controls/events/fixture_finished.rb
-- lib/test_bench/session/controls/events/fixture_started.rb
+- lib/test_bench/session/controls/events/file_executed.rb
+- lib/test_bench/session/controls/events/file_not_found.rb
+- lib/test_bench/session/controls/events/file_queued.rb
+- lib/test_bench/session/controls/events/skipped.rb
 - lib/test_bench/session/controls/events/test_finished.rb
-- lib/test_bench/session/controls/events/test_skipped.rb
 - lib/test_bench/session/controls/events/test_started.rb
 - lib/test_bench/session/controls/events.rb
+- lib/test_bench/session/controls/exception
+- lib/test_bench/session/controls/exception/message.rb
+- lib/test_bench/session/controls/exception/raise.rb
 - lib/test_bench/session/controls/exception.rb
-- lib/test_bench/session/controls/failure.rb
-- lib/test_bench/session/controls/fixture.rb
-- lib/test_bench/session/controls/output
-- lib/test_bench/session/controls/output/detail.rb
-- lib/test_bench/session/controls/output.rb
-- lib/test_bench/session/controls/process_id.rb
+- lib/test_bench/session/controls/message.rb
+- lib/test_bench/session/controls/metadata.rb
+- lib/test_bench/session/controls/path
+- lib/test_bench/session/controls/path/apex_directory.rb
+- lib/test_bench/session/controls/path/file
+- lib/test_bench/session/controls/path/file/create.rb
+- lib/test_bench/session/controls/path/file.rb
+- lib/test_bench/session/controls/path.rb
 - lib/test_bench/session/controls/random.rb
 - lib/test_bench/session/controls/result.rb
-- lib/test_bench/session/controls/substitute
-- lib/test_bench/session/controls/substitute/path.rb
+- lib/test_bench/session/controls/sequence.rb
+- lib/test_bench/session/controls/status.rb
+- lib/test_bench/session/controls/telemetry.rb
 - lib/test_bench/session/controls/telemetry_sink.rb
-- lib/test_bench/session/controls/time.rb
+- lib/test_bench/session/controls/text.rb
 - lib/test_bench/session/controls/title.rb
 - lib/test_bench/session/controls.rb
+- lib/test_bench/session/defaults.rb
 - lib/test_bench/session/events.rb
-- lib/test_bench/session/output
-- lib/test_bench/session/output/get.rb
-- lib/test_bench/session/output/writer
-- lib/test_bench/session/output/writer/buffer
-- lib/test_bench/session/output/writer/buffer/interactive
-- lib/test_bench/session/output/writer/buffer/interactive/viewport.rb
-- lib/test_bench/session/output/writer/buffer/interactive.rb
-- lib/test_bench/session/output/writer/buffer.rb
-- lib/test_bench/session/output/writer/defaults.rb
-- lib/test_bench/session/output/writer/substitute.rb
-- lib/test_bench/session/output/writer.rb
-- lib/test_bench/session/output.rb
-- lib/test_bench/session/projection.rb
+- lib/test_bench/session/exception
+- lib/test_bench/session/exception/format_backtrace
+- lib/test_bench/session/exception/format_backtrace/substitute.rb
+- lib/test_bench/session/exception/format_backtrace.rb
+- lib/test_bench/session/isolate
+- lib/test_bench/session/isolate/substitute.rb
+- lib/test_bench/session/isolate.rb
+- lib/test_bench/session/result.rb
 - lib/test_bench/session/session.rb
-- lib/test_bench/session/store.rb
+- lib/test_bench/session/status.rb
 - lib/test_bench/session/substitute
-- lib/test_bench/session/substitute/path.rb
 - lib/test_bench/session/substitute/sink.rb
 - lib/test_bench/session/substitute.rb
+- lib/test_bench/session/trace.rb
 - lib/test_bench/session.rb
-homepage: https://github.com/test-bench/test-bench-session
+homepage: http://test-bench.software
 licenses:
 - MIT
-metadata: {}
-post_install_message:
+metadata:
+  homepage_uri: http://test-bench.software
+  source_code_uri: https://github.com/test-bench-demo/test-bench-session
+  allowed_push_host: https://rubygems.org
+  namespace: TestBench::Session
 rdoc_options: []
 require_paths:
 - lib
@@ -119,8 +128,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.5.9
-signing_key:
+rubygems_version: 3.6.9
 specification_version: 4
-summary: Test session for TestBench
+summary: Core test automation state machine for TestBench
 test_files: []

data/lib/test_bench/session/controls/comment.rb

@@ -1,105 +0,0 @@
-module TestBench
-  class Session
-    module Controls
-      module Comment
-        module Text
-          def self.example
-            "Some comment"
-          end
-
-          def self.random
-            Random.example
-          end
-
-          module Random
-            def self.example(suffix=nil, text: nil)
-              suffix ||= self.suffix
-              text ||= Text.example
-
-              "#{text} #{suffix}"
-            end
-
-            def self.suffix
-              Controls::Random.string
-            end
-          end
-
-          module MultipleLines
-            def self.example(lines=nil)
-              lines ||= self.lines
-
-              text = String.new
-
-              lines.map do |line|
-                text << line
-                text << "\n"
-              end
-
-              text
-            end
-
-            def self.random
-              Random.example
-            end
-
-            def self.lines
-              [
-                "Some comment",
-                "Some other comment",
-                "Yet another comment"
-              ]
-            end
-
-            module Random
-              def self.example(suffix=nil)
-                suffix ||= Text::Random.suffix
-
-                lines = MultipleLines.lines.map do |line|
-                  Text::Random.example(suffix, text: line)
-                end
-
-                MultipleLines.example(lines)
-              end
-            end
-          end
-        end
-
-        module Heading
-          def self.example(text: nil)
-            text ||= self.text
-
-            "#{text}:"
-          end
-
-          def self.random
-            Random.example
-          end
-
-          def self.text
-            "Some Comment Heading"
-          end
-
-          module Random
-            def self.example(suffix=nil)
-              suffix ||= Controls::Random.string
-
-              text = "#{Heading.text} #{suffix}"
-
-              Heading.example(text:)
-            end
-          end
-        end
-
-        module Quote
-          def self.example
-            true
-          end
-
-          def self.random
-            Random.boolean
-          end
-        end
-      end
-    end
-  end
-end

data/lib/test_bench/session/controls/detail.rb

@@ -1,91 +0,0 @@
-module TestBench
-  class Session
-    module Controls
-      module Detail
-        module Text
-          def self.example
-            "Some detail"
-          end
-
-          def self.random
-            Random.example
-          end
-
-          module Random
-            def self.example(suffix=nil, text: nil)
-              text ||= Text.example
-
-              Comment::Text::Random.example(suffix, text:)
-            end
-          end
-
-          module MultipleLines
-            def self.example(lines=nil)
-              lines ||= self.lines
-
-              Comment::Text::MultipleLines.example(lines)
-            end
-
-            def self.random
-              Random.example
-            end
-
-            def self.lines
-              [
-                "Some detail",
-                "Some other detail",
-                "Yet another detail"
-              ]
-            end
-
-            module Random
-              def self.example(suffix=nil)
-                suffix ||= Comment::Text::Random.suffix
-
-                lines = MultipleLines.lines.map do |line|
-                  Text::Random.example(suffix, text: line)
-                end
-              end
-            end
-          end
-        end
-
-        module Heading
-          def self.example(text: nil)
-            text ||= self.text
-
-            "#{text}:"
-          end
-
-          def self.random
-            Random.example
-          end
-
-          def self.text
-            "Some Detail Heading"
-          end
-
-          module Random
-            def self.example(suffix=nil)
-              suffix ||= Controls::Random.string
-
-              text = "#{Heading.text} #{suffix}"
-
-              Heading.example(text:)
-            end
-          end
-        end
-
-        module Quote
-          def self.example
-            true
-          end
-
-          def self.random
-            Random.boolean
-          end
-        end
-      end
-    end
-  end
-end

data/lib/test_bench/session/controls/events/context_skipped.rb

@@ -1,47 +0,0 @@
-module TestBench
-  class Session
-    module Controls
-      module Events
-        module ContextSkipped
-          extend EventData
-
-          def self.example(title: nil, process_id: nil, time: nil)
-            title ||= self.title
-            process_id ||= self.process_id
-            time ||= self.time
-
-            Session::Events::ContextSkipped.build(title, process_id:, time:)
-          end
-
-          def self.random
-            Random.example
-          end
-
-          def self.title
-            Title::Context.example
-          end
-
-          def self.process_id
-            ProcessID.example
-          end
-
-          def self.time
-            Time.example
-          end
-
-          module Random
-            extend EventData
-
-            def self.example(title: nil, process_id: nil, time: nil)
-              process_id ||= ProcessID.random
-              time ||= Time.random
-              title ||= Title::Context.random
-
-              ContextSkipped.example(title:, process_id:, time:)
-            end
-          end
-        end
-      end
-    end
-  end
-end