test_bench-telemetry 2.0.0.0

data/lib/test_bench/telemetry/controls/events/test_finished.rb

@@ -0,0 +1,34 @@
+module TestBench
+  class Telemetry
+    module Controls
+      module Events
+        module TestFinished
+          def self.example(result: nil, title: nil, time: nil)
+            result ||= self.result
+            time ||= self.time
+
+            if title == :none
+              title = nil
+            else
+              title ||= self.title
+            end
+
+            TestBench::Telemetry::Event::TestFinished.new(result, title, time)
+          end
+
+          def self.random
+            result = Result.random
+            title = Title::Test.random
+            time = Time.random
+
+            example(result:, title:, time:)
+          end
+
+          def self.result = Result.example
+          def self.title = Title::Test.example
+          def self.time = Time.example
+        end
+      end
+    end
+  end
+end

data/lib/test_bench/telemetry/controls/events/test_skipped.rb

@@ -0,0 +1,31 @@
+module TestBench
+  class Telemetry
+    module Controls
+      module Events
+        module TestSkipped
+          def self.example(title: nil, time: nil)
+            time ||= self.time
+
+            if title == :none
+              title = nil
+            else
+              title ||= self.title
+            end
+
+            TestBench::Telemetry::Event::TestSkipped.new(title, time)
+          end
+
+          def self.random
+            title = Title::Test.random
+            time = Time.random
+
+            example(title:, time:)
+          end
+
+          def self.title = Title::Test.example
+          def self.time = Time.example
+        end
+      end
+    end
+  end
+end

data/lib/test_bench/telemetry/controls/events/test_started.rb

@@ -0,0 +1,31 @@
+module TestBench
+  class Telemetry
+    module Controls
+      module Events
+        module TestStarted
+          def self.example(title: nil, time: nil)
+            time ||= self.time
+
+            if title == :none
+              title = nil
+            else
+              title ||= self.title
+            end
+
+            TestBench::Telemetry::Event::TestStarted.new(title, time)
+          end
+
+          def self.random
+            title = Title::Test.random
+            time = Time.random
+
+            example(title:, time:)
+          end
+
+          def self.title = Title::Test.example
+          def self.time = Time.example
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,27 @@
+module TestBench
+  class Telemetry
+    module Controls
+      module Events
+        def self.each_example(random: nil, &block)
+          examples(random:).each(&block)
+        end
+
+        def self.examples(random: nil)
+          random ||= false
+
+          if random
+            method_name = :random
+          else
+            method_name = :example
+          end
+
+          controls = TestBench::Telemetry::Event.each_event_type.map do |event_type|
+            const_get(event_type)
+          end
+
+          controls.map(&method_name)
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,19 @@
+module TestBench
+  class Telemetry
+    module Controls
+      module FixtureName
+        def self.example(suffix=nil)
+          suffix = "_#{suffix}" if not suffix.nil?
+
+          "SomeProject::Fixtures::SomeFixture#{suffix}"
+        end
+
+        def self.random
+          suffix = example(Random.string)
+
+          example(suffix)
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,76 @@
+module TestBench
+  class Telemetry
+    module Controls
+      module Handler
+        def self.example(&block)
+          if block.nil?
+            cls = Example
+          else
+            cls = example_class(&block)
+          end
+
+          cls.new
+        end
+
+        def self.example_class(&block)
+          Class.new do
+            include TestBench::Telemetry::Sink::Handler
+
+            if not block.nil?
+              class_exec(&block)
+            end
+          end
+        end
+
+        module Event
+          def self.example(data=nil)
+            data ||= self.data
+
+            Controls::Event.example(data)
+          end
+
+          def self.data = 'some-data'
+
+          def self.other_example
+            Controls::Event::OtherExample.new
+          end
+
+          Example = Controls::Event::Example
+          OtherExample = Controls::Event::OtherExample
+        end
+
+        module Method
+          def self.example(event_type=nil)
+            event_type ||= Event::Example.event_type
+
+            event_type_method_cased = TestBench::Telemetry::Event::Type.method_cased(event_type)
+
+            :"handle_#{event_type_method_cased}"
+          end
+
+          def self.other_example
+            event_type = Event::OtherExample.event_type
+
+            example(event_type)
+          end
+        end
+
+        Example = example_class do
+          attr_accessor :data
+
+          handle Event::Example do |data|
+            self.data = data
+          end
+
+          def handled?(data=nil)
+            if data.nil?
+              !self.data.nil?
+            else
+              data == self.data
+            end
+          end
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,10 @@
+module TestBench
+  class Telemetry
+    module Controls
+      module LineNumber
+        def self.example = 11
+        def self.random = Random.integer
+      end
+    end
+  end
+end

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

@@ -0,0 +1,87 @@
+module TestBench
+  class Telemetry
+    module Controls
+      module Path
+        def self.example(suffix=nil)
+          suffix = "_#{suffix}" if not suffix.nil?
+
+          "path/to/some_file#{suffix}.rb"
+        end
+
+        module Random
+          def random = example(Controls::Random.string)
+        end
+        extend Random
+
+        module Temporary
+          def self.example(suffix=nil, basename: nil, extension: nil)
+            basename ||= self.basename
+            extension ||= self.extension
+
+            suffix = "-#{suffix}" if not suffix.nil?
+
+            filename = "#{basename}#{suffix}#{extension}"
+
+            File.join('tmp', filename)
+          end
+
+          def self.random(basename: nil, extension: nil)
+            suffix = Controls::Random.string
+
+            example(suffix, basename:, extension:)
+          end
+
+          def self.basename
+            'some-file'
+          end
+
+          def self.extension
+            '.some-ext'
+          end
+        end
+
+        module Absolute
+          extend Random
+
+          def self.example(suffix=nil)
+            path = Path.example(suffix)
+
+            File.join('/', path)
+          end
+
+          module Local
+            extend Random
+
+            def self.example(suffix=nil)
+              path = Path.example(suffix)
+
+              File.join(current_dir, path)
+            end
+
+            def self.current_dir
+              File.join('/home', 'some-user', 'some-working-dir')
+            end
+
+            module Gem
+              extend Random
+
+              def self.example(path=nil)
+                path ||= Path.example
+
+                path = File.join(gems_path, path)
+
+                Local.example(path)
+              end
+
+              def self.gems_path
+                ruby_version = RbConfig::CONFIG['ruby_version']
+
+                "gems/ruby/#{ruby_version}/gems"
+              end
+            end
+          end
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,7 @@
+module TestBench
+  class Telemetry
+    module Controls
+      Random = TestBench::Random.instance
+    end
+  end
+end

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

@@ -0,0 +1,12 @@
+module TestBench
+  class Telemetry
+    module Controls
+      module Result
+        def self.example = pass
+        def self.random = Random.boolean
+        def self.pass = true
+        def self.failure = false
+      end
+    end
+  end
+end

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

@@ -0,0 +1,11 @@
+module TestBench
+  class Telemetry
+    module Controls
+      module Sink
+        def self.example
+          Handler.example
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,76 @@
+module TestBench
+  class Telemetry
+    module Controls
+      module Time
+        def self.example(offset_milliseconds: nil, offset_nanoseconds: nil)
+          if offset_nanoseconds.nil?
+            offset_milliseconds ||= 0
+            offset_nanoseconds = offset_milliseconds * 1_000_000
+          end
+
+          nanoseconds = 111_111_111
+          remaining_offset, additional_nanoseconds = offset_nanoseconds.divmod(1_000_000_000 - nanoseconds)
+          nanoseconds += additional_nanoseconds
+          microseconds = Rational(nanoseconds, 1_000)
+
+          if remaining_offset.zero?
+            seconds = 11
+          else
+            remaining_offset, seconds = remaining_offset.divmod(60)
+          end
+
+          if remaining_offset.zero?
+            minutes = 11
+          else
+            remaining_offset, minutes = remaining_offset.divmod(60)
+          end
+
+          if remaining_offset.zero?
+            hours = 11
+          else
+            remaining_offset, hours = remaining_offset.divmod(24)
+          end
+
+          if remaining_offset.zero?
+            day = 1
+          else
+            remaining_offset, day = remaining_offset.divmod(28)
+            day += 1
+          end
+
+          if remaining_offset.zero?
+            month = 1
+          else
+            remaining_offset, month = remaining_offset.divmod(12)
+            month += 1
+          end
+
+          year = 2000
+          if not remaining_offset.zero?
+            year += remaining_offset
+          end
+
+          ::Time.utc(year, month, day, hours, minutes, seconds, microseconds)
+        end
+
+        def self.random
+          example(offset_nanoseconds: Random.integer)
+        end
+
+        module ISO8601
+          def self.example(time=nil, **arguments)
+            time ||= Time.example(**arguments)
+
+            time.strftime('%Y-%m-%dT%H:%M:%S.%NZ')
+          end
+
+          def self.random(...)
+            time = Time.random
+
+            example(time)
+          end
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,43 @@
+module TestBench
+  class Telemetry
+    module Controls
+      module Title
+        def self.example(suffix=nil, text: nil)
+          suffix = " #{suffix}" if not suffix.nil?
+          text ||= self.text
+
+          "#{text}#{suffix}"
+        end
+
+        def self.text = "Some Title"
+
+        module Random
+          def random = example(Controls::Random.string)
+        end
+        extend Random
+
+        module Test
+          extend Random
+
+          def self.example(suffix=nil)
+            Title.example(suffix, text: example_text)
+          end
+          def self.example_text = "Some test"
+
+          def self.other_example = "Some other test"
+        end
+
+        module Context
+          extend Random
+
+          def self.example(suffix=nil)
+            Title.example(suffix, text: example_text)
+          end
+          def self.example_text = "Some Context"
+
+          def self.other_example = "Some Other Context"
+        end
+      end
+    end
+  end
+end

data/lib/test_bench/telemetry/controls.rb

@@ -0,0 +1,40 @@
+require 'test_bench/telemetry/controls/random'
+require 'test_bench/telemetry/controls/time'
+
+require 'test_bench/telemetry/controls/comment'
+require 'test_bench/telemetry/controls/line_number'
+require 'test_bench/telemetry/controls/path'
+require 'test_bench/telemetry/controls/error'
+require 'test_bench/telemetry/controls/result'
+require 'test_bench/telemetry/controls/title'
+require 'test_bench/telemetry/controls/fixture_name'
+require 'test_bench/telemetry/controls/detail_level'
+
+require 'test_bench/telemetry/controls/event'
+
+require 'test_bench/telemetry/controls/events'
+require 'test_bench/telemetry/controls/events/asserted'
+require 'test_bench/telemetry/controls/events/error_raised'
+require 'test_bench/telemetry/controls/events/test_started'
+require 'test_bench/telemetry/controls/events/test_finished'
+require 'test_bench/telemetry/controls/events/test_skipped'
+require 'test_bench/telemetry/controls/events/context_entered'
+require 'test_bench/telemetry/controls/events/context_exited'
+require 'test_bench/telemetry/controls/events/context_skipped'
+require 'test_bench/telemetry/controls/events/commented'
+require 'test_bench/telemetry/controls/events/detail_increased'
+require 'test_bench/telemetry/controls/events/detail_decreased'
+require 'test_bench/telemetry/controls/events/run_started'
+require 'test_bench/telemetry/controls/events/run_finished'
+require 'test_bench/telemetry/controls/events/run_aborted'
+require 'test_bench/telemetry/controls/events/file_entered'
+require 'test_bench/telemetry/controls/events/file_exited'
+require 'test_bench/telemetry/controls/events/fixture_started'
+require 'test_bench/telemetry/controls/events/fixture_finished'
+
+require 'test_bench/telemetry/controls/handler'
+
+require 'test_bench/telemetry/controls/capture_sink/path'
+require 'test_bench/telemetry/controls/capture_sink/record'
+
+require 'test_bench/telemetry/controls/sink'

data/lib/test_bench/telemetry/event/events.rb

@@ -0,0 +1,35 @@
+module TestBench
+  class Telemetry
+    module Event
+      module Events
+        Asserted = Event.define(:result, :path, :line_number)
+
+        ErrorRaised = Event.define(:error_text)
+
+        TestStarted = Event.define(:title)
+        TestFinished = Event.define(:result, :title)
+        TestSkipped = Event.define(:title)
+
+        ContextEntered = Event.define(:title)
+        ContextExited = Event.define(:result, :title)
+        ContextSkipped = Event.define(:title)
+
+        Commented = Event.define(:comment)
+
+        DetailIncreased = Event.define
+        DetailDecreased = Event.define
+
+        RunStarted = Event.define(:random_seed, :executors)
+        RunFinished = Event.define(:result, :random_seed, :executors)
+        RunAborted = Event.define(:random_seed, :executors)
+
+        FileEntered = Event.define(:path, :executor)
+        FileExited = Event.define(:result, :path, :executor)
+
+        FixtureStarted = Event.define(:name)
+        FixtureFinished = Event.define(:result, :name)
+      end
+      include Events
+    end
+  end
+end

data/lib/test_bench/telemetry/event/serialization.rb

@@ -0,0 +1,143 @@
+module TestBench
+  class Telemetry
+    module Event
+      module Serialization
+        Error = Class.new(RuntimeError)
+
+        def self.dump(event)
+          event_type = event.event_type.to_s
+
+          data = String.new(encoding: 'BINARY')
+
+          data << event_type
+
+          event.values.each do |value|
+            data << "\t"
+            data << dump_value(value)
+          end
+
+          data << "\r\n"
+          data
+        end
+
+        def self.dump_value(value)
+          case value
+          when NilClass
+            ''
+          when Time
+            value.strftime('%Y-%m-%dT%H:%M:%S.%NZ')
+          when String
+            value.dump
+          when Integer
+            value.to_s
+          when TrueClass, FalseClass
+            value.to_s
+          end
+        end
+
+        def self.load(data, event_namespace)
+          match_data = Pattern.match(data)
+          if match_data.nil?
+            raise Error, "Cannot deserialize #{data.inspect}"
+          end
+
+          event_type = match_data['event_type'].to_sym
+          if not event_namespace.const_defined?(event_type, false)
+            raise Error, "Unknown event type #{event_type.inspect}"
+          end
+
+          values = match_data['values'].split("\t").map do |value_data|
+            load_value(value_data)
+          end
+
+          event_class = event_namespace.const_get(event_type, false)
+          event_class.new(*values)
+        end
+
+        def self.load_value(value_data)
+          match_data = Pattern.match_value(value_data)
+
+          if match_data['nil']
+            nil
+          elsif match_data['time']
+            year = match_data['year'].to_i
+            month = match_data['month'].to_i
+            day = match_data['day'].to_i
+            hour = match_data['hour'].to_i
+            minute = match_data['minute'].to_i
+            second = match_data['second'].to_i
+
+            nanosecond = match_data['nanosecond'].to_i
+            usec = Rational(nanosecond, 1_000)
+
+            Time.utc(year, month, day, hour, minute, second, usec)
+          elsif match_data['string']
+            value_data.undump
+          elsif match_data['integer']
+            Integer(value_data)
+          elsif match_data['true']
+            true
+          elsif match_data['false']
+            false
+          end
+        end
+
+        module Pattern
+          def self.match(data)
+            event.match(data)
+          end
+
+          def self.match_value(value_data)
+            pattern = %r{\A#{value}\z}
+
+            pattern.match(value_data)
+          end
+
+          def self.event
+            %r{\A#{event_type}\t#{values}\r\n\z}
+          end
+
+          def self.event_type
+            %r{(?<event_type>[A-Z][[:alpha:]]+)}
+          end
+
+          def self.values
+            %r{(?<values>#{value}(?:\t#{value})*)}
+          end
+
+          def self.value
+            %r{#{self.nil}|#{time}|#{string}|#{integer}|#{boolean}}
+          end
+
+          def self.nil
+            %r{(?<nil>(?=[\n\t])?)}
+          end
+
+          def self.time
+            year = %r{(?<year>[[:digit:]]{4})}
+            month = %r{(?<month>[[:digit:]]{2})}
+            day = %r{(?<day>[[:digit:]]{2})}
+            hour = %r{(?<hour>[[:digit:]]{2})}
+            minute = %r{(?<minute>[[:digit:]]{2})}
+            second = %r{(?<second>[[:digit:]]{2})}
+            nanosecond = %r{(?<nanosecond>[[:digit:]]{9})}
+
+            %r{(?<time>#{year}-#{month}-#{day}T#{hour}:#{minute}:#{second}\.#{nanosecond}Z)}
+          end
+
+          def self.string
+            %r{(?<string>".*")}
+          end
+
+          def self.integer
+            %r{(?<integer>[[:digit:]]+)}
+          end
+
+          def self.boolean
+            %r{(?<true>true)|(?<false>false)}
+          end
+        end
+      end
+    end
+  end
+end