Documentation
¶
Overview ¶
Package framework is the root package for the API platform integration test framework.
Implementation is organized into actor, components, topology, runtime, cleanup, and utility subpackages. Catalog packages provide product-specific component definitions.
See ../README.md and ../docs/migration-tasks.md.
Source Files
Directories
¶
| Path | Synopsis |
|---|---|
|
Package actor defines identities used by integration-test scenarios.
|
Package actor defines identities used by integration-test scenarios. |
|
Package assets resolves the repository-relative files the engine reads.
|
Package assets resolves the repository-relative files the engine reads. |
|
Package builder validates and executes source-image build plans declared by catalog components.
|
Package builder validates and executes source-image build plans declared by catalog components. |
|
Package catalog provides the concrete component registry used by suites.
|
Package catalog provides the concrete component registry used by suites. |
|
a2aagent
Package a2aagent declares the A2A trip-planner component: a real A2A 1.0 agent built on the reference SDK, serving both HTTP bindings and a public Agent Card.
|
Package a2aagent declares the A2A trip-planner component: a real A2A 1.0 agent built on the reference SDK, serving both HTTP bindings and a public Agent Card. |
|
aiworkspace
Package aiworkspace declares the AI Workspace component: its image, build inputs, Compose wiring, and environment, for use in framework block topologies.
|
Package aiworkspace declares the AI Workspace component: its image, build inputs, Compose wiring, and environment, for use in framework block topologies. |
|
apiportal
Package apiportal declares the API Portal component: its image, build inputs, Compose wiring, and environment, for use in framework block topologies.
|
Package apiportal declares the API Portal component: its image, build inputs, Compose wiring, and environment, for use in framework block topologies. |
|
browser
Package browser declares the headless-browser component used by UI suites, including the Playwright image and its version-match check against the module.
|
Package browser declares the headless-browser component used by UI suites, including the Playwright image and its version-match check against the module. |
|
cloudconsole
Package cloudconsole defines the externally hosted APIP cloud target used by the cloud integration-test runners.
|
Package cloudconsole defines the externally hosted APIP cloud target used by the cloud integration-test runners. |
|
infrastructure
Package infrastructure declares shared dependency components, such as Redis, that product components rely on but that no single product owns.
|
Package infrastructure declares shared dependency components, such as Redis, that product components rely on but that no single product owns. |
|
platformapi
Package platformapi declares the Platform API component: its image, build inputs, Compose wiring, and environment, for use in framework block topologies.
|
Package platformapi declares the Platform API component: its image, build inputs, Compose wiring, and environment, for use in framework block topologies. |
|
platformgateway
Package platformgateway declares the platform gateway component: its image, build inputs, Compose wiring, coverage environment, and service wiring, for use in framework block topologies.
|
Package platformgateway declares the platform gateway component: its image, build inputs, Compose wiring, coverage environment, and service wiring, for use in framework block topologies. |
|
shared
Package shared provides catalog helpers common to every product component: image resolution, source-version lookup, and control-plane PKI material.
|
Package shared provides catalog helpers common to every product component: image resolution, source-version lookup, and control-plane PKI material. |
|
testbench
Package testbench declares the testbench mock-service component: its image, Compose wiring, and per-service endpoints, for use in framework block topologies.
|
Package testbench declares the testbench mock-service component: its image, Compose wiring, and per-service endpoints, for use in framework block topologies. |
|
tlsbackend
Package tlsbackend declares the component that serves the HTTPS backends the gateway's outbound mutual TLS is tested against.
|
Package tlsbackend declares the component that serves the HTTPS backends the gateway's outbound mutual TLS is tested against. |
|
Package cleanup tracks resources created by a test runner and removes them during scenario and runner teardown.
|
Package cleanup tracks resources created by a test runner and removes them during scenario and runner teardown. |
|
Package components defines component types, definitions, registries, and running component instances used by the test framework.
|
Package components defines component types, definitions, registries, and running component instances used by the test framework. |
|
Package coverage collects and isolates Go, Node/V8, and source-level Istanbul browser coverage artifacts produced by framework test blocks.
|
Package coverage collects and isolates Go, Node/V8, and source-level Istanbul browser coverage artifacts produced by framework test blocks. |
|
Package logcapture streams every container's stdout/stderr in a block into one combined, interleaved log file for the block's whole lifetime, so a scenario failure has the product's own logs available, not only the client-side symptom.
|
Package logcapture streams every container's stdout/stderr in a block into one combined, interleaved log file for the block's whole lifetime, so a scenario failure has the product's own logs available, not only the client-side symptom. |
|
Package runtime manages networks, databases, containers, Compose stacks, readiness, and the lifecycle of resolved test blocks.
|
Package runtime manages networks, databases, containers, Compose stacks, readiness, and the lifecycle of resolved test blocks. |
|
Package suiterun runs a declarative suite from a Go test binary.
|
Package suiterun runs a declarative suite from a Go test binary. |
|
Package topology defines, loads, resolves, selects, and validates suite topologies.
|
Package topology defines, loads, resolves, selects, and validates suite topologies. |
|
util
|
|
|
a2ax
Package a2ax drives A2A agents through the official Go A2A SDK and reports what each call returned in framework-owned types.
|
Package a2ax drives A2A agents through the official Go A2A SDK and reports what each call returned in framework-owned types. |
|
httpx
Package httpx provides shared HTTP clients and response publication for test steps.
|
Package httpx provides shared HTTP clients and response publication for test steps. |
|
retry
Package retry owns every deadline-bounded wait in the suites.
|
Package retry owns every deadline-bounded wait in the suites. |
|
tcontext
Package tcontext carries block- and runner-scoped test state through context.Context.
|
Package tcontext carries block- and runner-scoped test state through context.Context. |
|
testpki
Package testpki generates the certificate fixtures mutual TLS scenarios present and pool: authorities, intermediates, client leaves and gateway identities, each addressed by a fixture name.
|
Package testpki generates the certificate fixtures mutual TLS scenarios present and pool: authorities, intermediates, client leaves and gateway identities, each addressed by a fixture name. |
|
unique
Package unique generates collision-resistant names, contexts, and other test-owned identifiers, so parallel runners never collide on a shared literal.
|
Package unique generates collision-resistant names, contexts, and other test-owned identifiers, so parallel runners never collide on a shared literal. |
Click to show internal directories.
Click to hide internal directories.