registry-conformance

module

v1.64.3 Latest Latest Go to latest Published: Aug 3, 2026 License: MIT

README ¶

registry-conformance

Hacking on registry-conformance

Preparing your Environment

Follow the developer setup guide at https://gitlab.com/gitlab-com/gl-infra/common-ci-tasks/-/blob/main/docs/developer-setup.md.
Clone this project
Run scripts/prepare-dev-env.sh

Directories ¶

?	: This menu
/	: Search site
f or F	: Jump to
y or Y	: Canonical URL

Path	Synopsis
cmd
conformance command Command conformance is the registry-conformance binary entry-point.	Command conformance is the registry-conformance binary entry-point.
internal
cli Package cli holds the command-line surface for registry-conformance: flag definitions, subcommands, and the input-layer resolution that happens before pkg/conformance.Config is constructed.	Package cli holds the command-line surface for registry-conformance: flag definitions, subcommands, and the input-layer resolution that happens before pkg/conformance.Config is constructed.
fuzzcoverage Package fuzzcoverage holds a repository-level guard test ensuring the hand-maintained go_fuzz matrix in .gitlab-ci.yml actively fuzzes every Go fuzz target in the tree.	Package fuzzcoverage holds a repository-level guard test ensuring the hand-maintained go_fuzz matrix in .gitlab-ci.yml actively fuzzes every Go fuzz target in the tree.
report Package report owns the output-layer renderers and the redacting slog handler.	Package report owns the output-layer renderers and the redacting slog handler.
pkg
client/maven Package maven provides the Maven registry client the conformance suite uses to exercise the Maven protocol: the `Client` constructor, the `HTTPError` envelope, the maven-metadata.xml operations, and the checksum sidecar surface (`GetChecksum`, `PutChecksum`, and the `ChecksumAlgorithm` type with its four constants).	Package maven provides the Maven registry client the conformance suite uses to exercise the Maven protocol: the `Client` constructor, the `HTTPError` envelope, the maven-metadata.xml operations, and the checksum sidecar surface (`GetChecksum`, `PutChecksum`, and the `ChecksumAlgorithm` type with its four constants).
client/npm Package npm provides the npm registry client used by the conformance suite.	Package npm provides the npm registry client used by the conformance suite.
client/npm/internal/npmstub command Command npmstub is a real `npm` binary used as a test fixture by pkg/client/npm's Executor tests; TestMain compiles it as "npm" onto the test PATH.	Command npmstub is a real `npm` binary used as a test fixture by pkg/client/npm's Executor tests; TestMain compiles it as "npm" onto the test PATH.
client/oci Package oci provides the OCI distribution registry client used by the conformance suite.	Package oci provides the OCI distribution registry client used by the conformance suite.
conformance Package conformance defines the shared result and configuration vocabulary used by the conformance runner and per-format modules.	Package conformance defines the shared result and configuration vocabulary used by the conformance runner and per-format modules.
conformance/cliexec Package cliexec provides the concrete Executor that implements the conformance.CLIExecutor contract: it resolves an external driver binary on PATH, pins the driver version at construction time, and invokes the driver through real exec.CommandContext with the fixed invocation contract from S04 §CLI drivers (closed env allow-list, RunOpts.Dir working directory, RunOpts.Stdin policy, argv prefixing with the resolved binary path, a SIGTERM→5s→SIGKILL grace window, 16 KiB capture caps with 4 KiB tail truncation, and argv/stream scrubbing of secret-bearing values).	Package cliexec provides the concrete Executor that implements the conformance.CLIExecutor contract: it resolves an external driver binary on PATH, pins the driver version at construction time, and invokes the driver through real exec.CommandContext with the fixed invocation contract from S04 §CLI drivers (closed env allow-list, RunOpts.Dir working directory, RunOpts.Stdin policy, argv prefixing with the resolved binary path, a SIGTERM→5s→SIGKILL grace window, 16 KiB capture caps with 4 KiB tail truncation, and argv/stream scrubbing of secret-bearing values).
conformance/cliexec/internal/echodriver command Command echodriver is a test fixture for pkg/conformance/cliexec.	Command echodriver is a test fixture for pkg/conformance/cliexec.
conformance/internal/catalogparse Package catalogparse parses a per-format catalog markdown document (the byte contents of one docs/catalog/<format>.md file) into the set of slug values whose Status is not "optional".	Package catalogparse parses a per-format catalog markdown document (the byte contents of one docs/catalog/<format>.md file) into the set of slug values whose Status is not "optional".
conformance/internal/inventorytest Package inventorytest holds the catalog-inventory guard helpers shared by the maven, npm, and oci format packages.	Package inventorytest holds the catalog-inventory guard helpers shared by the maven, npm, and oci format packages.
conformance/internal/testfake Package testfake provides shared test fixtures for the pkg/conformance test suite.	Package testfake provides shared test fixtures for the pkg/conformance test suite.
conformance/maven Package maven provides the Maven format implementation of the conformance Module interface defined in S04 §Module interface (§432-464).	Package maven provides the Maven format implementation of the conformance Module interface defined in S04 §Module interface (§432-464).
conformance/maven/internal/fixture Package fixture builds the Maven artifacts every release-publish test ships: a POM, a settings.xml, a synthetic JAR, and a maven-metadata.xml document for either metadata level.	Package fixture builds the Maven artifacts every release-publish test ships: a POM, a settings.xml, a synthetic JAR, and a maven-metadata.xml document for either metadata level.
conformance/maven/internal/mvnfake command Command mvnfake is a test fixture for pkg/conformance/maven's cliExec wrapper.	Command mvnfake is a test fixture for pkg/conformance/maven's cliExec wrapper.
conformance/npm Package npm provides the npm format implementation of the conformance Module interface defined in S04 §Module interface (§432-464).	Package npm provides the npm format implementation of the conformance Module interface defined in S04 §Module interface (§432-464).
conformance/npm/internal/fixture Package fixture holds internal, driver-only fixture builders for pkg/conformance/npm.	Package fixture holds internal, driver-only fixture builders for pkg/conformance/npm.
conformance/oci Package oci provides the OCI format implementation of the conformance Module interface defined in S04 §Module interface (§432-464).	Package oci provides the OCI format implementation of the conformance Module interface defined in S04 §Module interface (§432-464).
conformance/oci/internal/cranefake command Command cranefake is a test fixture for pkg/conformance/oci's cliExec wrapper.	Command cranefake is a test fixture for pkg/conformance/oci's cliExec wrapper.
conformance/oci/internal/fixture Package fixture builds the synthetic OCI artifacts every push test ships: a config blob, zero or more layer blobs (as gzipped tarballs), an optional subject descriptor, and an image manifest referencing them (S07 OCI plan §Research Findings / Manifest, config, and blob fixtures).	Package fixture builds the synthetic OCI artifacts every push test ships: a config blob, zero or more layer blobs (as gzipped tarballs), an optional subject descriptor, and an image manifest referencing them (S07 OCI plan §Research Findings / Manifest, config, and blob fixtures).
conformance/redact Package redact implements the field-name, content-scan, and argv scrubbing primitives that enforce S04 §Security Considerations: secret-bearing values must be replaced with the literal sentinel "[REDACTED]" before any log entry, failure-detail field, or captured argv element can reach a consumer.	Package redact implements the field-name, content-scan, and argv scrubbing primitives that enforce S04 §Security Considerations: secret-bearing values must be replaced with the literal sentinel "[REDACTED]" before any log entry, failure-detail field, or captured argv element can reach a consumer.