Helper functions for debugging OCI conformance tests.

This module provides utilities for inspecting and debugging OCI (Open Container Initiative) conformance tests. It allows for runtime inspection of request details and process state, and provides a way to set up debugging breakpoints during test execution of specific tests so you don't have to breakpoint through hundreds of unrelated requests.

Usage

The module is primarily used in conjunction with OCI conformance tests. When a request includes the x-oci-conformance-test header, the inspector will track the request and enable debugging capabilities.

Add a x-oci-conformance-test header to the request to enable debugging in the appropriate Distribution Spec (example: 02 Push Test):

req.SetHeader("x-oci-conformance-test", g.CurrentSpecReport().FullText())

In elixir, put an OCI.Inspector.inspect/2 call in your plug pipeline to enable debugging. When a header comes through for inspection, the proccess dictionary will be populated with the request id and the test name to enable granular breakpointing by specific HTTP requests, not just line number.

def call(conn, %{registry: registry}) do
  conn =
    conn
    |> put_private(:oci_registry, registry)
    |> authenticate()
    |> OCI.Inspector.inspect("after:authenticate/1")
end

Put a debugger at the line of code you want to breakpoint and pass in the binding(), the breakpoint will only trigger for the specific HTTP request.

def verify_digest(data, digest) do
  OCI.Inspector.pry(binding())
  # ... code
end

Features

• Request inspection with detailed logging
• Process state tracking
• Runtime debugging capabilities
• Test case identification