test_bench-session 2.1.3.2 → 3.0.0.0.pre.2

data/lib/test_bench/session/controls/exception/raise.rb

@@ -0,0 +1,50 @@
+module TestBench
+  class Session
+    module Controls
+      module Exception
+        module Raise
+          def self.call(exception_class, exception_message, relative: nil)
+            apex_directory = Path::ApexDirectory::Create.()
+
+            if Exception.const_defined?(:SomeNamespace)
+              Exception.send(:remove_const, :SomeNamespace)
+            end
+
+            file_1 = Controls::Path::File::Create.(<<~RUBY, subdirectory: :none, apex_directory:, relative:)
+            #{Controls::Exception}::SomeNamespace.module_exec { def self.some_method = raise #{exception_class}, #{exception_message.inspect}, caller_locations(0, 4) }
+            RUBY
+
+            file_2 = Controls::Path::File::Create.(<<~RUBY, basename: 'some-file', apex_directory:, relative:)
+            module #{Controls::Exception}::SomeNamespace
+              def self.some_other_method = some_method
+            end
+            RUBY
+
+            file_3 = Controls::Path::File::Create.(<<~RUBY, basename: 'some-other-file', apex_directory:, relative:)
+            module #{Controls::Exception}
+              module SomeNamespace
+                def self.yet_another_method = some_other_method
+              end
+            end
+            RUBY
+
+            file_4 = Controls::Path::File::Create.(<<~RUBY, basename: 'some-other-file', subdirectory: :none, apex_directory:, relative:)
+            #{[file_3, file_2, file_1].inspect}.each { |file| load file }
+
+            module #{Controls::Exception}::SomeNamespace
+              def self.origin = yet_another_method; origin
+            end
+            RUBY
+
+            ::Dir.chdir(apex_directory) do
+              load file_4
+            end
+
+          ensure
+            Path::ApexDirectory::Remove.(apex_directory)
+          end
+        end
+      end
+    end
+  end
+end

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

@@ -2,42 +2,76 @@ module TestBench
   class Session
     module Controls
       module Exception
-        def self.example(message: nil, exception_class: nil)
-          message ||= self.message
-          exception_class ||= Example
+        def self.example(exception_message: nil, exception_class: nil, relative: nil)
+          exception_message ||= self.exception_message
+          exception_class ||= self.exception_class
 
-          exception_class.new(message)
+          Raise.(exception_class, exception_message, relative:)
+        rescue exception_class => exception
+          return exception
+        else
+          abort "Unreachable"
         end
 
-        def self.other_example
-          exception_class = OtherExample
+        def self.exception_message
+          "Some exception"
+        end
 
-          example(exception_class:)
+        def self.exception_class
+          SomeException
         end
 
-        def self.random
-          message = Message.random
+        SomeException = Class.new(::Exception)
+        SomeOtherException = Class.new(::Exception)
 
-          example(message:)
-        end
+        Example = self.example
+
+        module Other
+          def self.example
+            Exception.example(exception_message:, exception_class:)
+          end
+
+          def self.exception_message
+            "Some other exception"
+          end
+
+          def self.exception_class
+            SomeOtherException
+          end
 
-        def self.message
-          Message.example
+          Example = self.example
         end
 
-        Example = Class.new(RuntimeError)
-        OtherExample = Class.new(RuntimeError)
+        module Cause
+          def self.example(exception_message: nil, exception_class: nil)
+            exception_message ||= self.exception_message
+            exception_class ||= self.exception_class
 
-        module Message
-          def self.example
-            "Some exception"
+            Raise.(exception_class, exception_message)
+          rescue SomeOtherException
+            exception = Exception.example(exception_message:, exception_class:)
+            return exception
+          else
+            abort "Unreachable"
+          end
+
+          def self.exception_message
+            "Some exception cause"
+          end
+
+          def self.exception_class
+            SomeOtherException
           end
 
-          def self.random
-            suffix = Random.string
+          Example = self.example
+        end
 
-            "#{example} #{suffix}"
+        module AbsolutePaths
+          def self.example
+            Exception.example(relative: false)
           end
+
+          Example = self.example
         end
       end
     end

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

@@ -0,0 +1,41 @@
+module TestBench
+  class Session
+    module Controls
+      module Message
+        def self.example
+          "Some message"
+        end
+
+        module Failure
+          def self.example
+            "Some failure"
+          end
+
+          def self.other_example
+            "Some other failure"
+          end
+        end
+
+        module Error
+          def self.example
+            Exception::Message.example
+          end
+
+          def self.other_example
+            Exception::Message.other_example
+          end
+        end
+
+        module Skip
+          def self.example
+            "Some skipped test or context"
+          end
+
+          def self.other_example
+            "Some other skipped test or context"
+          end
+        end
+      end
+    end
+  end
+end

data/lib/test_bench/session/controls/{time.rb → metadata.rb}

@@ -1,7 +1,7 @@
 module TestBench
   class Session
     module Controls
-      Time = TestBench::Telemetry::Controls::Time
+      Metadata = Telemetry::Metadata
     end
   end
 end

data/lib/test_bench/session/controls/path/apex_directory.rb

@@ -0,0 +1,74 @@
+module TestBench
+  class Session
+    module Controls
+      module Path
+        module ApexDirectory
+          def self.example(name=nil)
+            name ||= Name.example
+
+            ::File.expand_path(name, tmpdir)
+          end
+
+          def self.tmpdir
+            ::Dir.tmpdir
+          end
+
+          module Name
+            def self.example
+              'test-automated-session-controls'
+            end
+
+            def self.random
+              "#{example}-#{Random.string}"
+            end
+          end
+
+          module Create
+            def self.call(name=nil)
+              name ||= Name.random
+
+              apex_directory = ApexDirectory.example(name)
+
+              ::Dir.mkdir(apex_directory)
+
+              if ENV.fetch('DEBUG_PATH_CONTROLS', 'off') == 'on'
+                warn "created directory '#{apex_directory}'"
+              end
+
+              apex_directory
+            end
+          end
+
+          module Remove
+            def self.call(apex_directory)
+              remove(apex_directory)
+            end
+
+            def self.remove(directory)
+              ::Dir.each_child(directory) do |entry|
+                absolute_path = ::File.expand_path(entry, directory)
+
+                if ::File.directory?(absolute_path)
+                  subdirectory = absolute_path
+                  remove(subdirectory)
+                else
+                  ::File.unlink(absolute_path)
+
+                  if ENV.fetch('DEBUG_PATH_CONTROLS', 'off') == 'on'
+                    warn "removed '#{absolute_path}'"
+                  end
+                end
+              end
+
+              ::Dir.rmdir(directory)
+
+              if ENV.fetch('DEBUG_PATH_CONTROLS', 'off') == 'on'
+                warn "removed directory '#{directory}'"
+              end
+            end
+          end
+        end
+      end
+    end
+  end
+end

data/lib/test_bench/session/controls/path/file/create.rb

@@ -0,0 +1,111 @@
+module TestBench
+  class Session
+    module Controls
+      module Path
+        module File
+          module Create
+            def self.call(content=nil, basename: nil, extension: nil, directory: nil, subdirectory: nil, apex_directory: nil, relative: nil)
+              if relative.nil?
+                relative = !apex_directory.nil?
+              end
+
+              apex_directory ||= ::Dir.tmpdir
+
+              absolute_path = File.example(basename:, extension:, directory:, subdirectory:, apex_directory:)
+
+              relative_path = absolute_path.delete_prefix(::File.join(apex_directory, ''))
+
+              if relative
+                file_path = relative_path
+              else
+                file_path = absolute_path
+              end
+
+              content ||= "# #{file_path}\n"
+
+              segments = []
+
+              until ['.', '/'].include?(relative_path)
+                segments.unshift(::File.basename(relative_path))
+
+                relative_path = ::File.dirname(relative_path)
+              end
+
+              (1...segments.length).each do |index|
+                directory_segments = segments[...index]
+
+                directory = ::File.join(apex_directory, *directory_segments)
+
+                if not ::File.directory?(directory)
+                  ::Dir.mkdir(directory)
+                end
+              end
+
+              ::File.write(absolute_path, content)
+
+              if ENV.fetch('DEBUG_PATH_CONTROLS', 'off') == 'on'
+                warn "created '#{absolute_path}'"
+              end
+
+              file_path
+            end
+
+            module Exception
+              def self.call(apex_directory: nil)
+                Create.(content, basename:, apex_directory:)
+              end
+
+              def self.basename
+                'some_aborting_file.rb'
+              end
+
+              def self.content
+                <<~RUBY
+                raise #{Controls::Exception}::Example
+                RUBY
+              end
+            end
+
+            module Comment
+              def self.call(text: nil, apex_directory: nil)
+                text ||= self.text
+
+                basename = "write_comment__#{text.gsub(' ', '_')}"
+
+                content = Content.example(text:)
+
+                Create.(content, basename:, apex_directory:)
+              end
+
+              def self.content
+                Content.example
+              end
+
+              def self.basename
+                'some_commenting_file'
+              end
+
+              def self.text
+                Text::Comment.example
+              end
+
+              module Content
+                def self.example(text: nil)
+                  text ||= Comment.text
+
+                  <<~RUBY
+                  comment_text = #{text.inspect}
+
+                  commented = #{Controls::Events::Commented}.example(text: comment_text)
+
+                  Session.instance.record_event(commented)
+                  RUBY
+                end
+              end
+            end
+          end
+        end
+      end
+    end
+  end
+end

data/lib/test_bench/session/controls/path/file.rb

@@ -0,0 +1,40 @@
+module TestBench
+  class Session
+    module Controls
+      module Path
+        module File
+          def self.example(basename: nil, extension: nil, directory: nil, subdirectory: nil, apex_directory: nil)
+            basename ||= self.basename
+            extension ||= self.extension
+
+            filename = "#{basename}#{extension}"
+
+            Path.example(name: filename, directory:, subdirectory:, apex_directory:)
+          end
+
+          def self.basename
+            'some-file'
+          end
+
+          def self.extension
+            '.rb'
+          end
+
+          def self.other_example
+            Other.example
+          end
+
+          module Other
+            def self.example(apex_directory: nil)
+              File.example(basename:, apex_directory:)
+            end
+
+            def self.basename
+              'some-other-file'
+            end
+          end
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,85 @@
+module TestBench
+  class Session
+    module Controls
+      module Path
+        def self.example(name: nil, directory: nil, subdirectory: nil, apex_directory: nil)
+          if apex_directory.nil?
+            Relative.example(name:, directory:, subdirectory:)
+          else
+            Absolute.example(name:, directory:, subdirectory:, apex_directory:)
+          end
+        end
+
+        def self.name
+          'some-entry'
+        end
+
+        def self.directory
+          'some-dir'
+        end
+
+        def self.subdirectory
+          'some-subdir'
+        end
+
+        def self.other_example
+          Other.example
+        end
+
+        module Other
+          def self.example(apex_directory: nil)
+            Path.example(name:, directory:, subdirectory:, apex_directory:)
+          end
+
+          def self.name
+            'some-other-entry'
+          end
+
+          def self.directory
+            'some-other-dir'
+          end
+
+          def self.subdirectory
+            'some-other-subdir'
+          end
+        end
+
+        module Absolute
+          def self.example(name: nil, directory: nil, subdirectory: nil, apex_directory: nil)
+            apex_directory ||= self.apex_directory
+
+            relative_path = Relative.example(name:, directory:, subdirectory:)
+
+            ::File.join(apex_directory, relative_path)
+          end
+
+          def self.apex_directory
+            '/'
+          end
+        end
+
+        module Relative
+          def self.example(name: nil, directory: nil, subdirectory: nil)
+            name ||= Path.name
+
+            if directory == :none
+              directory = nil
+            else
+              directory ||= Path.directory
+            end
+
+            if subdirectory == :none
+              subdirectory = nil
+            elsif not directory.nil?
+              subdirectory ||= Path.subdirectory
+            end
+
+            segments = [directory, subdirectory, name].compact
+
+            ::File.join(*segments)
+          end
+        end
+      end
+    end
+  end
+end

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

@@ -1,7 +1,7 @@
 module TestBench
   class Session
     module Controls
-      Random = TestBench::Output::Controls::Random
+      Random = Telemetry::Random
     end
   end
 end

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

@@ -3,19 +3,11 @@ module TestBench
     module Controls
       module Result
         def self.example
-          pass
+          Session::Result.passed
         end
 
-        def self.pass
-          true
-        end
-
-        def self.failure
-          false
-        end
-
-        def self.random
-          Random.boolean
+        def self.other_example
+          Session::Result.failed
         end
       end
     end

data/lib/test_bench/session/controls/{events/event_data.rb → sequence.rb}

@@ -1,8 +1,10 @@
 module TestBench
   class Session
     module Controls
-      module Events
-        EventData = Telemetry::Controls::Event::EventData
+      module Sequence
+        def self.example
+          11
+        end
       end
     end
   end

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

@@ -0,0 +1,90 @@
+module TestBench
+  class Session
+    module Controls
+      module Status
+        def self.example
+          Relative.example
+        end
+
+        module Passed
+          def self.example
+            Session::Status.new(
+              test_sequence: Sequence.example,
+              failure_sequence: 0,
+              error_sequence: 0,
+              skip_sequence: 0
+            )
+          end
+        end
+
+        module Failed
+          def self.example
+            Session::Status.new(
+              test_sequence: Sequence.example,
+              failure_sequence: Sequence.example,
+              error_sequence: 0,
+              skip_sequence: 0
+            )
+          end
+        end
+
+        module None
+          def self.example
+            Session::Status.new(
+              test_sequence: 0,
+              failure_sequence: 0,
+              error_sequence: 0,
+              skip_sequence: 0
+            )
+          end
+        end
+
+        module Aborted
+          def self.example
+            Session::Status.new(
+              test_sequence: Sequence.example,
+              failure_sequence: Sequence.example,
+              error_sequence: Sequence.example,
+              skip_sequence: 0
+            )
+          end
+        end
+
+        module Incomplete
+          def self.example
+            Session::Status.new(
+              test_sequence: Sequence.example,
+              failure_sequence: 0,
+              error_sequence: 0,
+              skip_sequence: Sequence.example
+            )
+          end
+        end
+
+        module Relative
+          def self.example
+            Session::Status.new(
+              test_sequence: 1,
+              failure_sequence: 11,
+              error_sequence: 111,
+              skip_sequence: 1111
+            )
+          end
+
+          def self.reference
+            Session::Status.new(
+              test_sequence: 0,
+              failure_sequence: 1,
+              error_sequence: 11,
+              skip_sequence: 111
+            )
+          end
+
+          def self.result
+            Session::Result.aborted
+          end
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,13 @@
+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

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

@@ -1,7 +1,35 @@
 module TestBench
   class Session
     module Controls
-      TelemetrySink = Telemetry::Controls::Sink
+      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