@MockRepo

A mock Maven repository that serves content from a local directory structure with specific file patterns.

Fields:

• source (required) - The directory containing the mock repository content
• cloneTo (optional) - Clone the source to a specific directory (useful for directory-based archives)
• cloneClean (optional) - Ensure the cloneTo folder is cleaned before every run (default: false)
• lazyArchiver (optional) - Set to false to archive directories at startup, or true to archive when used (default: false)
• transformDirectiveSource (optional) - Set the name of the mechanism to transform files in case of a directory based archive. Possible values: metadata (default: null)

Example:

@MockRepositoryManager(
    mockRepos = @MockRepo(
        source = @Directory("src/it/mrm/repository"),
        cloneTo = @Directory("target/mock-repo"),
        cloneClean = true,
        lazyArchiver = false,
        transformDirectiveSource = MetadataTransformDirectiveFactory.class)
    )
)

Supported File Patterns:

The mockRepo recognizes the following file patterns in the source directory:

• **/*.pom - Maven POM files
• **/*-{classifier}.{type} - Artifacts with classifiers (e.g., mojo-parent-10-site.xml)
• **/*.{archiver extension} - Directory archives using the GAV from the corresponding POM
• **/*-{classifier}.{archiver extension} - Directory archives with classifiers
• archetype-catalog.xml - Archetype catalog

Supported archiver extensions include: jar, zip, tar.gz, tgz, tar.xz, and other formats supported by Plexus Archiver.

Supported TransformDirectiveSource:

• MetadataTransformDirectiveFactory.class - Put a file called .mrm-transform.properties in the root of an archive directory (e.g. artifactId-1.0.0.jar/.mrm-transform.properties). This file supports the following entries

  • [input].targetName = [output]
  • [input].contentTransformers = javaToClass

  The javaToClass currently supports transforming module-info.java, only including [open]* module MODULENAME and requires [static|transitive]* MODULENAME.

@LocalRepo

A locally stored Maven repository that serves content from a directory on the filesystem.

Fields:

• source (required) - The directory containing the local repository (standard Maven repository layout)

Example:

@MockRepositoryManager(
    localRepos = @LocalRepo(
        source = @Directory("src/it/resources/local-repo/repositories")
    )
)

Use Cases:

• Using an existing local repository as a test repository
• Combining with other repository types to provide additional artifacts

@HostedRepo

A repository used for distribution management that accepts uploaded artifacts (writable repository).

Parameters:

• target (required) - The directory where uploaded files will be stored

Example:

@MockRepositoryManager(
		hostedRepos = @HostedRepo(
				target = @Directory("target/hosted-repo")
		)
)

Use Cases:

• Testing artifact deployment
• Testing distribution management configuration
• Verifying that artifacts are correctly uploaded

Note: This repository type is writable, unlike the other repository types which are read-only.

@RemoteArtifactSystem

A remoteArtifactSystem serves content from remote repositories.

Fields:

• cacheDirectory (required) - The directory where uploaded files will be stored

• repositories (required) - The remote repositories to use when trying to locate an artifact

Example:

@MockRepositoryManager(
        remoteArtifactSystem =
                @RemoteArtifactSystem(
                        cacheDirectory = @Directory("target/remote-repositories"),
                        repositories =
                                @RemoteRepo(
                                        id = "central",
                                        type = "default",
                                        url = "https://repo.maven.apache.org/maven2")))

Use Cases:

This is useful for providing access to Maven Central and other remote repositories during integration tests.