Module: OpenapiFirst::Test::Coverage

Defined in:
lib/openapi_first/test/coverage.rb,
lib/openapi_first/test/coverage/plan.rb,
lib/openapi_first/test/coverage/route_task.rb,
lib/openapi_first/test/coverage/request_task.rb,
lib/openapi_first/test/coverage/response_task.rb,
lib/openapi_first/test/coverage/terminal_formatter.rb

Overview

The Coverage module is about tracking request and response validation to assess if all parts of the API description have been tested. Currently it does not care about unknown requests that are not part of any API description.

Defined Under Namespace

Classes: Plan, TerminalFormatter

Constant Summary collapse

Result = 
Data.define(:plans, :coverage)
RouteTask = 
Data.define(:path, :request_method, :requests, :responses) do
  def finished?
    requests.all?(&:finished?) && responses.all?(&:finished?)
  end
end

Class Method Summary collapse

Class Method Details

.reset ⇒ Object

Clear current coverage run



38
39
40
 
# File 'lib/openapi_first/test/coverage.rb', line 38

def reset
  @current_run = nil
end

.result ⇒ Object 



50
51
52
 
# File 'lib/openapi_first/test/coverage.rb', line 50

def result
  Result.new(plans:, coverage:)
end

.start ⇒ Object 



16
17
18
19
20
21
22
23
24
25
26
27
28
29
 
# File 'lib/openapi_first/test/coverage.rb', line 16

def start
  @after_request_validation = lambda do |validated_request, oad|
    track_request(validated_request, oad)
  end

  @after_response_validation = lambda do |validated_response, request, oad|
    track_response(validated_response, request, oad)
  end

  OpenapiFirst.configure do |config|
    config.after_request_validation(&@after_request_validation)
    config.after_response_validation(&@after_response_validation)
  end
end

.stop ⇒ Object 



31
32
33
34
35
 
# File 'lib/openapi_first/test/coverage.rb', line 31

def stop
  configuration = OpenapiFirst.configuration
  configuration.hooks[:after_request_validation].delete(@after_request_validation)
  configuration.hooks[:after_response_validation].delete(@after_response_validation)
end

.track_request(request, oad) ⇒ Object 



42
43
44
 
# File 'lib/openapi_first/test/coverage.rb', line 42

def track_request(request, oad)
  current_run[oad.filepath].track_request(request)
end

.track_response(response, _request, oad) ⇒ Object 



46
47
48
 
# File 'lib/openapi_first/test/coverage.rb', line 46

def track_response(response, _request, oad)
  current_run[oad.filepath].track_response(response)
end