Class: TestBench::Session

Inherits:
Object
  • Object
show all
Defined in:
lib/test_bench/session/trace.rb,
lib/test_bench/session/events.rb,
lib/test_bench/session/result.rb,
lib/test_bench/session/status.rb,
lib/test_bench/session/isolate.rb,
lib/test_bench/session/session.rb,
lib/test_bench/session/defaults.rb,
lib/test_bench/session/substitute.rb,
lib/test_bench/session/controls/path.rb,
lib/test_bench/session/controls/text.rb,
lib/test_bench/session/controls/event.rb,
lib/test_bench/session/controls/title.rb,
lib/test_bench/session/controls/events.rb,
lib/test_bench/session/controls/random.rb,
lib/test_bench/session/controls/result.rb,
lib/test_bench/session/controls/status.rb,
lib/test_bench/session/substitute/sink.rb,
lib/test_bench/session/controls/message.rb,
lib/test_bench/session/controls/metadata.rb,
lib/test_bench/session/controls/sequence.rb,
lib/test_bench/session/controls/backtrace.rb,
lib/test_bench/session/controls/exception.rb,
lib/test_bench/session/controls/path/file.rb,
lib/test_bench/session/controls/telemetry.rb,
lib/test_bench/session/isolate/substitute.rb,
lib/test_bench/session/controls/events/failed.rb,
lib/test_bench/session/controls/events/aborted.rb,
lib/test_bench/session/controls/events/skipped.rb,
lib/test_bench/session/controls/telemetry_sink.rb,
lib/test_bench/session/controls/events/detailed.rb,
lib/test_bench/session/controls/exception/raise.rb,
lib/test_bench/session/controls/events/commented.rb,
lib/test_bench/session/controls/path/file/create.rb,
lib/test_bench/session/controls/exception/message.rb,
lib/test_bench/session/exception/format_backtrace.rb,
lib/test_bench/session/controls/backtrace/location.rb,
lib/test_bench/session/controls/events/file_queued.rb,
lib/test_bench/session/controls/comment_disposition.rb,
lib/test_bench/session/controls/events/test_started.rb,
lib/test_bench/session/controls/path/apex_directory.rb,
lib/test_bench/session/controls/events/file_executed.rb,
lib/test_bench/session/controls/events/test_finished.rb,
lib/test_bench/session/controls/events/file_not_found.rb,
lib/test_bench/session/controls/events/context_started.rb,
lib/test_bench/session/controls/events/context_finished.rb,
lib/test_bench/session/exception/format_backtrace/substitute.rb

Direct Known Subclasses

Substitute::Session

Defined Under Namespace

Modules: Controls, Defaults, Events, Exception, Result, Substitute Classes: Isolate, Status, Trace

Constant Summary collapse

Failure = 
Class.new(RuntimeError)
ExecutionBreak = 
Object.new
Abort =

Remove when no longer in use - Nathan, Tue Jul 15 2025

ExecutionBreak

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Instance Attribute Details

#assertion_sequence ⇒ Object 



35
36
37
 
# File 'lib/test_bench/session/session.rb', line 35

def assertion_sequence
  @assertion_sequence ||= 0
end

#format_backtrace ⇒ Object 



15
16
17
 
# File 'lib/test_bench/session/session.rb', line 15

def format_backtrace
  @format_backtrace ||= Exception::FormatBacktrace::Substitute.build
end

#isolate ⇒ Object 



20
21
22
 
# File 'lib/test_bench/session/session.rb', line 20

def isolate
  @isolate ||= Isolate::Substitute.build
end

#status ⇒ Object 



25
26
27
 
# File 'lib/test_bench/session/session.rb', line 25

def status
  @status ||= Status.initial
end

#telemetry ⇒ Object 



10
11
12
 
# File 'lib/test_bench/session/session.rb', line 10

def telemetry
  @telemetry ||= Telemetry::Substitute.build
end

#trace ⇒ Object 



30
31
32
 
# File 'lib/test_bench/session/session.rb', line 30

def trace
  @trace ||= Trace.new
end

Class Method Details

.build(apex_directory: nil) ⇒ Object 



40
41
42
43
44
45
46
47
48
 
# File 'lib/test_bench/session/session.rb', line 40

def self.build(apex_directory: nil)
  instance = new

  Telemetry.configure(instance)
  Exception::FormatBacktrace.configure(instance)
  Isolate.configure(instance, apex_directory:)

  instance
end

.configure(receiver, session: nil, attr_name: nil) ⇒ Object 



54
55
56
57
58
59
 
# File 'lib/test_bench/session/session.rb', line 54

def self.configure(receiver, session: nil, attr_name: nil)
  session ||= instance
  attr_name ||= :session

  receiver.public_send(:"#{attr_name}=", session)
end

.establish(session) ⇒ Object 



61
62
63
 
# File 'lib/test_bench/session/session.rb', line 61

def self.establish(session)
  @instance = session
end

.instance ⇒ Object 



50
51
52
 
# File 'lib/test_bench/session/session.rb', line 50

def self.instance
  @instance ||= build
end

.register_telemetry_sink(telemetry_sink) ⇒ Object 



65
66
67
 
# File 'lib/test_bench/session/session.rb', line 65

def self.register_telemetry_sink(telemetry_sink)
  instance.register_telemetry_sink(telemetry_sink)
end

Instance Method Details

#assert(value, failure_message) ⇒ Object 



73
74
75
76
77
78
79
 
# File 'lib/test_bench/session/session.rb', line 73

def assert(value, failure_message)
  self.assertion_sequence += 1

  if not value
    raise Failure, failure_message
  end
end

#close ⇒ Object 



69
70
71
 
# File 'lib/test_bench/session/session.rb', line 69

def close
  isolate.stop
end

#comment(text, disposition = nil) ⇒ Object 



81
82
83
 
# File 'lib/test_bench/session/session.rb', line 81

def comment(text, disposition=nil)
  record_event(Events::Commented.build(text, disposition))
end

#context(title = nil, &block) ⇒ Object 



105
106
107
108
109
110
111
 
# File 'lib/test_bench/session/session.rb', line 105

def context(title=nil, &block)
  record_event(Events::ContextStarted.build(title))

  pending_context_finished_event = Events::ContextFinished.build(title)

  evaluate(pending_context_finished_event, &block)
end

#detail(text, disposition = nil) ⇒ Object 



85
86
87
 
# File 'lib/test_bench/session/session.rb', line 85

def detail(text, disposition=nil)
  record_event(Events::Detailed.build(text, disposition))
end

#evaluate(pending_event, &block) ⇒ Object 



206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
 
# File 'lib/test_bench/session/session.rb', line 206

def evaluate(pending_event, &block)
  previous_status = status.dup

  result = nil

  catch(ExecutionBreak) do
    block.(self)

  rescue Failure => failure
    message = failure.message
    record_event(Events::Failed.build(message))

  rescue ::Exception => exception
    aborted_recorded = status.error_sequence > previous_status.error_sequence

    if not aborted_recorded
      location = format_backtrace.(exception)

      message = exception.detailed_message

      record_event(Events::Aborted.build(message, location))
    end

    raise exception

  ensure
    result = status.result(previous_status, pending_event)

    pending_event.result = result
    record_event(pending_event)
  end

  result
end

#execute(file_path) ⇒ Object 



117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
 
# File 'lib/test_bench/session/session.rb', line 117

def execute(file_path)
  if file_not_found?(file_path)
    record_event(Events::FileNotFound.build(file_path))
    return
  end

  record_event(Events::FileQueued.build(file_path))

  pended_event = Events::FileExecuted.build(file_path, result)

  evaluate(pended_event) do
    isolate.(file_path) do |event_data|
      record_event(event_data)
    end
  end
end

#file_not_found?(file_path) ⇒ Boolean

Returns:

  • (Boolean) 


134
135
136
 
# File 'lib/test_bench/session/session.rb', line 134

def file_not_found?(file_path)
  !File.exist?(file_path)
end

#inspect(raw: nil) ⇒ Object 



142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
 
# File 'lib/test_bench/session/session.rb', line 142

def inspect(raw: nil)
  if raw
    return super()
  end

  telemetry_placeholder = Struct.new(:inspect).new("(not inspected)")

  original_telemetry = self.telemetry

  self.telemetry = telemetry_placeholder

  begin
    super()

  ensure
    self.telemetry = original_telemetry
  end
end

#register_telemetry_sink(telemetry_sink) ⇒ Object 



138
139
140
 
# File 'lib/test_bench/session/session.rb', line 138

def register_telemetry_sink(telemetry_sink)
  telemetry.register(telemetry_sink)
end

#result(previous_status = nil) ⇒ Object 



202
203
204
 
# File 'lib/test_bench/session/session.rb', line 202

def result(previous_status=nil)
  status.result(previous_status)
end

#skip(message = nil) ⇒ Object 



113
114
115
 
# File 'lib/test_bench/session/session.rb', line 113

def skip(message=nil)
  record_event(Events::Skipped.build(message))
end

#test(title = nil, &block) ⇒ Object 



89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
 
# File 'lib/test_bench/session/session.rb', line 89

def test(title=nil, &block)
  record_event(Events::TestStarted.build(title))

  pending_test_finished_event = Events::TestFinished.build(title)

  evaluate(pending_test_finished_event) do
    previous_sequence = self.assertion_sequence

    block.()

    if self.assertion_sequence == previous_sequence
      raise Failure, "Test didn't perform an assertion"
    end
  end
end

#update(event_or_event_data) ⇒ Object Also known as: record_event 



161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
 
# File 'lib/test_bench/session/session.rb', line 161

def update(event_or_event_data)
  case event_or_event_data
  in Telemetry::Event => event

  in Telemetry::EventData => event_data
    event_type = event_data.type
    event_class = Events.const_get(event_type, false)

    event = Telemetry::Event::Import.(event_data, event_class)
  end

  case event
  when Events::ContextStarted, Events::TestStarted
    title = event.title

    if not title.nil?
      trace.push(title)
    end

  when Events::Commented, Events::Detailed
    trace.push(event.text)
  end

  telemetry.record(event)

  status.update(event)

  case event
  when Events::Commented, Events::Detailed
    trace.pop

  when Events::ContextFinished, Events::TestFinished
    title = event.title

    if not title.nil?
      trace.pop
    end
  end
end