Distribution settings (CLI + Gradle plugin)¶

Both the CLI and Gradle plugin ship the same "distribution" wiring from distribution-bundle. They use TestGenerationRunner.withDefaults, which applies shared defaults and then merges user configuration and overrides.

Default wiring¶

Modules¶

• TemplateGeneratorModule (template generator)
• PatternSupportModule (pattern-based values and rules)

Module settings extraction¶

• PatternModuleSettingsExtractor reads testGenerationSettings.patternGeneration into PatternGenerationOptions.

Default settings¶

DistributionDefaults.settings() inserts the pattern provider before plain-string in the example-value provider order, so pattern-based example generation is enabled by default.

Configuration sources and precedence¶

1. YAML config file (configFile) is loaded with GeneratorConfigLoader.
2. CLI flags or Gradle properties are applied as overrides (TestGeneratorOverrides).
3. Overrides win over config values; missing values fall back to defaults.

Module settings extraction happens before core settings parsing, so patternGeneration is available when modules are created.

Top-level settings¶

testGenerationSettings¶

Core settings for test case generation behavior.

Budget controls¶

Output options¶

When enabled, each test suite includes a "Test Valid Case" entry representing a valid request with all required parameters populated. The expected status code is the first 2xx response defined in the OpenAPI spec (e.g., 200, 201, 204).

This is a baseline positive check (one valid case per operation), not a generator for multiple valid permutations.

Example:

testGenerationSettings:
    includeValidCase: true

Security¶

Example:

testGenerationSettings:
    validSecurityValues:
        ApiKeyAuth: "my-api-key"
        BearerAuth: "Bearer eyJ..."

Include configuration¶

Accepted shapes:

• "/path": ["GET", "POST"] (explicit list)
• "/path": "GET" (single method shorthand)

Behavior:

• Empty config → all operations are included (no filtering).
• Path keys match exactly (no globbing). Use * as a wildcard path to match all paths.
• Method matching is case-insensitive (methods are normalized to uppercase).
• Use * as a wildcard method to match all methods for a path.
• Exact path entries take precedence over the wildcard path:
• When "/users": ["GET"] exists, wildcard path methods (like "*": ["POST"]) are not additive for "/users".
• Paths that are not present in the OpenAPI spec are ignored and logged as warnings.

Example:

testGenerationSettings:
    includeOperations:
        "/users/{userId}": [ "GET" ]
        "/orders": [ "POST" ]
        "*": [ "OPTIONS" ]

Ignore configuration¶

ignoreTestCases is hierarchical:

• Path level: "/internal": "*" ignores all operations under that path.
• Operation level: "/users": { "DELETE": "*" } ignores all test cases for that method.
• Test-case level: "/users": { "GET": ["Missed Required Query Parameter page"] } ignores exact test case names only.

Wildcards and matching:

• Path keys match exactly (no globbing). Use * as a wildcard path to apply rules to all paths.
• Method keys are case-insensitive (methods are normalized to uppercase).
• Wildcard path rules merge with path-specific rules; wildcard method entries win on key collisions.
• The *:*:* pattern is forbidden, ignored, and logged as a warning.
• If all test cases for an operation are filtered out, the operation is recorded as "not tested" in the generation report summary.

Performance:

• Path-level ("/path": "*") and operation-level ("/path": { "GET": "*" }) ignores are applied before generation.
• Test-case-name ignores ("/path": { "GET": ["..."] }) are applied after suite generation.
• Use includeOperations when you want inclusion-based targeting and predictable performance on large specs.

Example:

testGenerationSettings:
    ignoreTestCases:
        "/internal": "*"  # Skip all tests for /internal
        "/pets/{petId}":
            "GET":
                - "Missing required path param: petId"
        "*":
            "OPTIONS": "*"
    ignoreSchemaValidationRules:
        - "art.galushko.openapi.testgen.rules.schema.OutOfMinimumLengthStringSchemaValidationRule"

Basic test data overrides¶

testGenerationSettings.exampleValues¶

Configuration for schema-derived example value generation.

Note: These flags affect request/parameter example generation. Response expectedBody uses response defaults (includeOptionalExampleProperties = true, includeWriteOnly = false, useSchemaExampleFallback = true); maxExampleDepth still applies.

Default provider order:

providers:
    - enum
    - const
    - uuid
    - email
    - date
    - date-time
    - pattern      # Added by distribution (before plain-string)
    - plain-string
    - number
    - boolean

Provider-specific settings¶

uuid¶

email¶

date¶

dateTime¶

plainString¶

Example:

testGenerationSettings:
    exampleValues:
        providers:
            - enum
            - const
            - pattern
            - plain-string
        maxExampleDepth: 15
        includeOptionalExampleProperties: true
        includeWriteOnly: false
        useSchemaExampleFallback: true
        uuid:
            template: "test-uuid-%s"
        email:
            template: "test%[email protected]"
        date:
            startDate: "2024-01-01"

testGenerationSettings.patternGeneration¶

Configuration for regex pattern-based value generation (provided by pattern-support module).

Example:

testGenerationSettings:
    patternGeneration:
        defaultMinLength: 5
        spaceChars: " \t"

Generator options¶

Generator options are generator-specific and live under the top-level generatorOptions key (YAML) / generatorOptions property (Gradle) / --generator-option (CLI).

See:

• Reference: Generator options
• How-to: Template generator
• How-to: Test-suite-writer

Gradle-only settings¶

Complete YAML example¶

specFile: "src/test/resources/openapi.yaml"
outputDir: "./build/generated/openapi-tests"
generator: "template"
generatorOptions:
    templateSet: restassured-java
    templateVariables:
        package: com.example.generated
        baseUrl: http://localhost:8080

testGenerationSettings:
    # Budget controls
    maxSchemaDepth: 50
    maxMergedSchemaDepth: 50
    maxSchemaCombinations: 100
    maxTestCasesPerOperation: 1000
    maxErrors: 100
    errorMode: COLLECT_ALL

    # Security
    validSecurityValues:
        ApiKeyAuth: "test-api-key"
        BearerAuth: "Bearer test-token"

    # Ignore configuration
    ignoreTestCases:
        "/health": "*"
    ignoreSchemaValidationRules: [ ]
    ignoreAuthValidationRules: [ ]

    # Example value settings
    exampleValues:
        providers:
            - enum
            - const
            - uuid
            - email
            - date
            - date-time
            - pattern
            - plain-string
            - number
            - boolean
        maxExampleDepth: 50

    # Pattern generation (from pattern-support module)
    patternGeneration:
        defaultMinLength: 3

alwaysWriteTests: false
logLevel: INFO

Related docs¶

• Distribution-bundle module
• CLI reference
• Gradle plugin reference
• Budget controls
• Ignore rules how-to
• Include operations
• Security values how-to