Index (doppelganger-api-detector 2.6.0 API)

A C D E F G H L N O P R S T U V W
All Classes and Interfaces|All Packages|Constant Field Values

A

analyze(List<DescribedEndpoint>, List<VerifiedContractTest>, boolean) - Method in class com.arc_e_tect.gradle.doppelganger.detect.ResponseCoverageAnalyzer: Computes the coverage rows for declaredAndImplemented.
apply(Project) - Method in class com.arc_e_tect.gradle.doppelganger.DoppelgangerApiDetectorPlugin

C

com.arc_e_tect.gradle.doppelganger - package com.arc_e_tect.gradle.doppelganger
com.arc_e_tect.gradle.doppelganger.detect - package com.arc_e_tect.gradle.doppelganger.detect
com.arc_e_tect.gradle.doppelganger.progress - package com.arc_e_tect.gradle.doppelganger.progress
com.arc_e_tect.gradle.doppelganger.report - package com.arc_e_tect.gradle.doppelganger.report
com.arc_e_tect.gradle.doppelganger.scan - package com.arc_e_tect.gradle.doppelganger.scan
contractTestCount() - Method in record class com.arc_e_tect.gradle.doppelganger.detect.EndpointResponseCoverage: Returns the value of the contractTestCount record component.
ContractVerificationSource - Interface in com.arc_e_tect.gradle.doppelganger.detect: A pluggable source of "this endpoint's contract is verified" evidence.

D

declaredResponseCodes() - Method in record class com.arc_e_tect.gradle.doppelganger.detect.EndpointResponseCoverage: The declared response codes for this endpoint - a convenience view of DescribedEndpoint.responseCodes().
DEFAULT_CONTRACT_HISTORY_FILE_NAME - Static variable in class com.arc_e_tect.gradle.doppelganger.DoppelgangerApiDetectorExtension: Default name of the persisted contract progress history file.
DEFAULT_CONTRACTS_DIR - Static variable in class com.arc_e_tect.gradle.doppelganger.DoppelgangerApiDetectorExtension: Suggested relative path of the directory searched for Spring Cloud Contract DSL files, shown in the DSL example above.
DEFAULT_CONTROLLER_DIR - Static variable in class com.arc_e_tect.gradle.doppelganger.DoppelgangerApiDetectorExtension: Default relative path of the directory searched for @RestController classes.
DEFAULT_REPORT_FILE_NAME - Static variable in class com.arc_e_tect.gradle.doppelganger.DoppelgangerApiDetectorExtension: Default name of the generated AsciiDoc report file.
DEFAULT_RESPONSE_COVERAGE_HISTORY_FILE_NAME - Static variable in class com.arc_e_tect.gradle.doppelganger.DoppelgangerApiDetectorExtension: Default name of the persisted response coverage history file.
DEFAULT_SCAN_CONTRACTS_REPORT_FILE_NAME - Static variable in class com.arc_e_tect.gradle.doppelganger.DoppelgangerApiDetectorExtension: Default name of the scanContracts task's generated AsciiDoc report file.
DEFAULT_TEST_DIR - Static variable in class com.arc_e_tect.gradle.doppelganger.DoppelgangerApiDetectorExtension: Default relative path of the directory searched for test classes.
Defaults - Search tag in class com.arc_e_tect.gradle.doppelganger.DoppelgangerApiDetectorPlugin: Section
detect(List<MethodCallExpr>) - Static method in class com.arc_e_tect.gradle.doppelganger.scan.StatusCodeDetector: Detects the status code asserted anywhere among calls, or Optional.empty() when none of the recognised shapes are present.
DetectDoppelgangerApisTask - Class in com.arc_e_tect.gradle.doppelganger: Gradle task that compares endpoints both declared in the configured OpenAPI documentation and implemented by scanned @RestController classes against verification evidence collected from the enabled ContractVerificationSources, and writes an AsciiDoc report of every endpoint with no such evidence - the "doppelganger APIs".
DetectDoppelgangerApisTask() - Constructor for class com.arc_e_tect.gradle.doppelganger.DetectDoppelgangerApisTask: Creates the task.
DoppelgangerApiDetectorExtension - Class in com.arc_e_tect.gradle.doppelganger: DSL extension for the Doppelganger API Detector Gradle plugin.
DoppelgangerApiDetectorExtension() - Constructor for class com.arc_e_tect.gradle.doppelganger.DoppelgangerApiDetectorExtension: For use by the Gradle-generated concrete subclass.
DoppelgangerApiDetectorPlugin - Class in com.arc_e_tect.gradle.doppelganger: Gradle plugin that registers the detectDoppelgangerApis task and wires the doppelgangerApiDetector DSL extension into the project.
DoppelgangerApiDetectorPlugin() - Constructor for class com.arc_e_tect.gradle.doppelganger.DoppelgangerApiDetectorPlugin: Creates a new plugin instance.
DoppelgangerApiFinder - Class in com.arc_e_tect.gradle.doppelganger.detect: Determines which endpoints are both declared in the OpenAPI documentation and implemented by a @RestController method, but have no matching verification evidence from any configured ContractVerificationSource - i.e.
DoppelgangerApiFinder() - Constructor for class com.arc_e_tect.gradle.doppelganger.detect.DoppelgangerApiFinder: Creates a new DoppelgangerApiFinder.
DoppelgangerApiReportWriter - Class in com.arc_e_tect.gradle.doppelganger.report: Writes the AsciiDoc doppelganger API report: every endpoint that is declared in the OpenAPI documentation and implemented by a @RestController method, but has no verification evidence from any enabled ContractVerificationSource.
DoppelgangerApiReportWriter() - Constructor for class com.arc_e_tect.gradle.doppelganger.report.DoppelgangerApiReportWriter: Creates a new DoppelgangerApiReportWriter.

E

endpoint() - Method in record class com.arc_e_tect.gradle.doppelganger.detect.EndpointResponseCoverage: Returns the value of the endpoint record component.
endpoint() - Method in record class com.arc_e_tect.gradle.doppelganger.detect.VerifiedContractTest: Returns the value of the endpoint record component.
EndpointResponseCoverage - Record Class in com.arc_e_tect.gradle.doppelganger.detect: The scanContracts result for a single endpoint: how many response codes its OpenAPI operation declares, how many contract tests exist for it in total, and - only when includeResponseCoverage is enabled - how many of those tests cover each declared response code.
EndpointResponseCoverage(DescribedEndpoint, int, int, Map<String, Integer>) - Constructor for record class com.arc_e_tect.gradle.doppelganger.detect.EndpointResponseCoverage: Creates an instance of a EndpointResponseCoverage record class.
equals(Object) - Method in record class com.arc_e_tect.gradle.doppelganger.detect.EndpointResponseCoverage: Indicates whether some other object is "equal to" this one.
equals(Object) - Method in record class com.arc_e_tect.gradle.doppelganger.detect.VerifiedContractTest: Indicates whether some other object is "equal to" this one.
equals(Object) - Method in record class com.arc_e_tect.gradle.doppelganger.progress.ResponseCoverageRecord: Indicates whether some other object is "equal to" this one.

F

findDoppelgangers(List<Endpoint>, List<Endpoint>) - Method in class com.arc_e_tect.gradle.doppelganger.detect.DoppelgangerApiFinder: Returns every endpoint in declaredAndImplemented that has no matching entry in verified.
fingerprint() - Method in record class com.arc_e_tect.gradle.doppelganger.progress.ResponseCoverageRecord: Returns the value of the fingerprint record component.
firstCoveredAt() - Method in record class com.arc_e_tect.gradle.doppelganger.progress.ResponseCoverageRecord: Returns the value of the firstCoveredAt record component.
firstDeclaredAt() - Method in record class com.arc_e_tect.gradle.doppelganger.progress.ResponseCoverageRecord: Returns the value of the firstDeclaredAt record component.

G

generate() - Method in class com.arc_e_tect.gradle.doppelganger.DetectDoppelgangerApisTask: Task action: scans the configured controller directories and OpenAPI documentation to find endpoints both declared and implemented, scans the enabled verification sources, writes the doppelganger API report, and - when DetectDoppelgangerApisTask.getFailOnDoppelganger() is true - fails the build if any doppelganger API was found.
generate() - Method in class com.arc_e_tect.gradle.doppelganger.ScanContractsTask: Task action: scans the same candidate endpoints DetectDoppelgangerApisTask does, but reports response-code and contract-test coverage rather than a pass/fail verdict.
getContractHistoryFile() - Method in class com.arc_e_tect.gradle.doppelganger.DetectDoppelgangerApisTask: File that the persisted contract progress history is read from and, when DetectDoppelgangerApisTask.getUpdateContractHistory() is true, written back to.
getContractHistoryFile() - Method in class com.arc_e_tect.gradle.doppelganger.DoppelgangerApiDetectorExtension: File that the persisted contract progress history is read from and, when DoppelgangerApiDetectorExtension.getUpdateContractHistory() is true, written back to.
getContractHistoryFilePath() - Method in class com.arc_e_tect.gradle.doppelganger.DetectDoppelgangerApisTask: The absolute path of DetectDoppelgangerApisTask.getContractHistoryFile(), tracked as a plain @Input value - not the file's content, which DetectDoppelgangerApisTask.getContractHistoryFile() itself is deliberately excluded from up-to-date checking for.
getContractsDir() - Method in class com.arc_e_tect.gradle.doppelganger.DetectDoppelgangerApisTask: Directory searched for Spring Cloud Contract DSL files when DetectDoppelgangerApisTask.getUseSpringCloudContract() is true.
getContractsDir() - Method in class com.arc_e_tect.gradle.doppelganger.DoppelgangerApiDetectorExtension: Directory searched for Spring Cloud Contract DSL files (*.groovy and *.yml), scanned recursively when DoppelgangerApiDetectorExtension.getUseSpringCloudContract() is true.
getContractsDir() - Method in class com.arc_e_tect.gradle.doppelganger.ScanContractsTask: Directory searched for Spring Cloud Contract DSL files when ScanContractsTask.getUseSpringCloudContract() is true.
getControllerDirs() - Method in class com.arc_e_tect.gradle.doppelganger.DetectDoppelgangerApisTask: Directories to search recursively for @RestController classes.
getControllerDirs() - Method in class com.arc_e_tect.gradle.doppelganger.DoppelgangerApiDetectorExtension: Directories to search recursively for @RestController classes.
getControllerDirs() - Method in class com.arc_e_tect.gradle.doppelganger.ScanContractsTask: Directories to search recursively for @RestController classes.
getExcludeFiles() - Method in class com.arc_e_tect.gradle.doppelganger.DetectDoppelgangerApisTask: External exclusion rule files - see DoppelgangerApiDetectorExtension.getExcludeFiles().
getExcludeFiles() - Method in class com.arc_e_tect.gradle.doppelganger.DoppelgangerApiDetectorExtension: One or more YAML files of exclusion rules, in the same format bundled well-known sets use:
getExcludeFiles() - Method in class com.arc_e_tect.gradle.doppelganger.ScanContractsTask: External exclusion rule files - see DoppelgangerApiDetectorExtension.getExcludeFiles().
getExcludePaths() - Method in class com.arc_e_tect.gradle.doppelganger.DetectDoppelgangerApisTask: Exclusion rule strings - see DoppelgangerApiDetectorExtension.getExcludePaths().
getExcludePaths() - Method in class com.arc_e_tect.gradle.doppelganger.DoppelgangerApiDetectorExtension: Exclusion rule strings, parsed by ExclusionRule.parse(String) - e.g.
getExcludePaths() - Method in class com.arc_e_tect.gradle.doppelganger.ScanContractsTask: Exclusion rule strings - see DoppelgangerApiDetectorExtension.getExcludePaths().
getExcludeWellKnown() - Method in class com.arc_e_tect.gradle.doppelganger.DetectDoppelgangerApisTask: Bundled well-known exclusion set names - see DoppelgangerApiDetectorExtension.getExcludeWellKnown().
getExcludeWellKnown() - Method in class com.arc_e_tect.gradle.doppelganger.DoppelgangerApiDetectorExtension: Names of bundled, well-known exclusion sets to apply - e.g.
getExcludeWellKnown() - Method in class com.arc_e_tect.gradle.doppelganger.ScanContractsTask: Bundled well-known exclusion set names - see DoppelgangerApiDetectorExtension.getExcludeWellKnown().
getFailOnDoppelganger() - Method in class com.arc_e_tect.gradle.doppelganger.DetectDoppelgangerApisTask: Whether the build should fail when doppelganger APIs are found.
getFailOnDoppelganger() - Method in class com.arc_e_tect.gradle.doppelganger.DoppelgangerApiDetectorExtension: Whether the build should fail when doppelganger APIs are found.
getIncludeResponseCoverage() - Method in class com.arc_e_tect.gradle.doppelganger.DoppelgangerApiDetectorExtension: Whether the scanContracts task additionally computes, for every declared response code, how many contract tests cover it.
getIncludeResponseCoverage() - Method in class com.arc_e_tect.gradle.doppelganger.ScanContractsTask: Whether to additionally compute, for every declared response code, how many contract tests cover it.
getOpenApiDir() - Method in class com.arc_e_tect.gradle.doppelganger.DetectDoppelgangerApisTask: Directory where OpenAPI descriptions are stored, tracked so that changes to any document reachable from DetectDoppelgangerApisTask.getRootDocument() invalidate the task's cached result.
getOpenApiDir() - Method in class com.arc_e_tect.gradle.doppelganger.DoppelgangerApiDetectorExtension: Directory where OpenAPI descriptions are stored.
getOpenApiDir() - Method in class com.arc_e_tect.gradle.doppelganger.ScanContractsTask: Directory where OpenAPI descriptions are stored.
getPathResolverHelperMethods() - Method in class com.arc_e_tect.gradle.doppelganger.DetectDoppelgangerApisTask: Helper-method conventions used to resolve indirectly-referenced request paths in contract tests - see DoppelgangerApiDetectorExtension.getPathResolverHelperMethods().
getPathResolverHelperMethods() - Method in class com.arc_e_tect.gradle.doppelganger.DoppelgangerApiDetectorExtension: Static helper-method conventions recognised when resolving a test's request-path argument, each given as "SimpleClassName.methodName" (e.g.
getPathResolverHelperMethods() - Method in class com.arc_e_tect.gradle.doppelganger.ScanContractsTask: Helper-method conventions used to resolve indirectly-referenced request paths in contract tests - see DoppelgangerApiDetectorExtension.getPathResolverHelperMethods().
getPropertyFiles() - Method in class com.arc_e_tect.gradle.doppelganger.DetectDoppelgangerApisTask: Property files used to resolve indirectly-referenced request paths in contract tests - see DoppelgangerApiDetectorExtension.getPropertyFiles().
getPropertyFiles() - Method in class com.arc_e_tect.gradle.doppelganger.DoppelgangerApiDetectorExtension: Property files (.properties, .yml, or .yaml) merged into a single key/value map used to resolve a test's request-path argument when it is not a literal or a literal-initialized constant - specifically, a configured DoppelgangerApiDetectorExtension.getPathResolverHelperMethods() call whose literal argument is a property key, or a field annotated @Value("${key}")/@Value("${key:default}").
getPropertyFiles() - Method in class com.arc_e_tect.gradle.doppelganger.ScanContractsTask: Property files used to resolve indirectly-referenced request paths in contract tests - see DoppelgangerApiDetectorExtension.getPropertyFiles().
getReportDir() - Method in class com.arc_e_tect.gradle.doppelganger.DetectDoppelgangerApisTask: Directory the AsciiDoc report is written to.
getReportDir() - Method in class com.arc_e_tect.gradle.doppelganger.DoppelgangerApiDetectorExtension: Directory the AsciiDoc report is written to.
getReportDir() - Method in class com.arc_e_tect.gradle.doppelganger.ScanContractsTask: Directory the AsciiDoc report is written to.
getReportFileName() - Method in class com.arc_e_tect.gradle.doppelganger.DetectDoppelgangerApisTask: Name of the generated AsciiDoc report file (without path).
getReportFileName() - Method in class com.arc_e_tect.gradle.doppelganger.DoppelgangerApiDetectorExtension: Name of the generated AsciiDoc report file (without path).
getReportFileName() - Method in class com.arc_e_tect.gradle.doppelganger.ScanContractsTask: Name of the generated AsciiDoc report file (without path).
getResponseCoverageHistoryFile() - Method in class com.arc_e_tect.gradle.doppelganger.DoppelgangerApiDetectorExtension: File that the persisted response coverage history is read from and, when DoppelgangerApiDetectorExtension.getUpdateResponseCoverageHistory() is true, written back to.
getResponseCoverageHistoryFile() - Method in class com.arc_e_tect.gradle.doppelganger.ScanContractsTask: File that the persisted response coverage history is read from and, when ScanContractsTask.getUpdateResponseCoverageHistory() is true, written back to.
getResponseCoverageHistoryFilePath() - Method in class com.arc_e_tect.gradle.doppelganger.ScanContractsTask: The absolute path of ScanContractsTask.getResponseCoverageHistoryFile(), tracked as a plain @Input value - see DetectDoppelgangerApisTask.getContractHistoryFilePath().
getRootDocument() - Method in class com.arc_e_tect.gradle.doppelganger.DetectDoppelgangerApisTask: The root OpenAPI document describing the API.
getRootDocument() - Method in class com.arc_e_tect.gradle.doppelganger.DoppelgangerApiDetectorExtension: The root OpenAPI document describing the API.
getRootDocument() - Method in class com.arc_e_tect.gradle.doppelganger.ScanContractsTask: The root OpenAPI document describing the API.
getScanContractsReportFileName() - Method in class com.arc_e_tect.gradle.doppelganger.DoppelgangerApiDetectorExtension: Name of the scanContracts task's generated AsciiDoc report file (without path), written to the same DoppelgangerApiDetectorExtension.getReportDir().
getSystemUnderTestVersion() - Method in class com.arc_e_tect.gradle.doppelganger.DetectDoppelgangerApisTask: Version of the system under test whose @RestController classes were scanned, printed in the generated report as e.g.
getSystemUnderTestVersion() - Method in class com.arc_e_tect.gradle.doppelganger.DoppelgangerApiDetectorExtension: Version of the system under test whose @RestController classes are scanned, printed in the generated report as e.g.
getSystemUnderTestVersion() - Method in class com.arc_e_tect.gradle.doppelganger.ScanContractsTask: Version of the system under test whose @RestController classes were scanned.
getTestDirs() - Method in class com.arc_e_tect.gradle.doppelganger.DetectDoppelgangerApisTask: Directories to search recursively for test classes, scanned by the Spring RestDocs and OpenAPI request validator verification sources when enabled.
getTestDirs() - Method in class com.arc_e_tect.gradle.doppelganger.DoppelgangerApiDetectorExtension: Directories to search recursively for test classes, scanned by the Spring RestDocs and OpenAPI request validator verification sources when enabled.
getTestDirs() - Method in class com.arc_e_tect.gradle.doppelganger.ScanContractsTask: Directories to search recursively for test classes.
getTestDirsUserConfigured() - Method in class com.arc_e_tect.gradle.doppelganger.DetectDoppelgangerApisTask: Whether DetectDoppelgangerApisTask.getTestDirs() holds directories the user actually configured, as opposed to only DoppelgangerApiDetectorExtension.DEFAULT_TEST_DIR applied by DoppelgangerApiDetectorPlugin because the user configured none.
getTestDirsUserConfigured() - Method in class com.arc_e_tect.gradle.doppelganger.ScanContractsTask: See DetectDoppelgangerApisTask.getTestDirsUserConfigured().
getTrackContractHistory() - Method in class com.arc_e_tect.gradle.doppelganger.DetectDoppelgangerApisTask: Whether to persist, across builds, a history of when each endpoint first reached each stage of its contract lifecycle - declared, implemented, verified.
getTrackContractHistory() - Method in class com.arc_e_tect.gradle.doppelganger.DoppelgangerApiDetectorExtension: Whether to persist, across builds, a history of when each endpoint first reached each stage of its contract lifecycle - declared, implemented, verified - keyed by a fingerprint of its HTTP verb and path so the history is shared correctly with Shadow and Mirage API Detector when they're pointed at the same DoppelgangerApiDetectorExtension.getContractHistoryFile().
getTrackResponseCoverageHistory() - Method in class com.arc_e_tect.gradle.doppelganger.DoppelgangerApiDetectorExtension: Whether to persist, across builds, a history of response code coverage - keyed by endpoint fingerprint and response code, tracking a live test-count gauge rather than milestone timestamps.
getTrackResponseCoverageHistory() - Method in class com.arc_e_tect.gradle.doppelganger.ScanContractsTask: Whether to persist, across builds, a history of response code coverage.
getUpdateContractHistory() - Method in class com.arc_e_tect.gradle.doppelganger.DetectDoppelgangerApisTask: Whether DetectDoppelgangerApisTask.getContractHistoryFile() is written back to disk after being updated with the current run's endpoints.
getUpdateContractHistory() - Method in class com.arc_e_tect.gradle.doppelganger.DoppelgangerApiDetectorExtension: Whether DoppelgangerApiDetectorExtension.getContractHistoryFile() is written back to disk after being updated with the current run's endpoints.
getUpdateResponseCoverageHistory() - Method in class com.arc_e_tect.gradle.doppelganger.DoppelgangerApiDetectorExtension: Whether DoppelgangerApiDetectorExtension.getResponseCoverageHistoryFile() is written back to disk after being updated with the current run's coverage.
getUpdateResponseCoverageHistory() - Method in class com.arc_e_tect.gradle.doppelganger.ScanContractsTask: Whether ScanContractsTask.getResponseCoverageHistoryFile() is written back to disk after being updated with the current run's coverage.
getUseOpenApiRequestValidator() - Method in class com.arc_e_tect.gradle.doppelganger.DetectDoppelgangerApisTask: Whether to treat Atlassian OpenAPI request validator usage as verification evidence.
getUseOpenApiRequestValidator() - Method in class com.arc_e_tect.gradle.doppelganger.DoppelgangerApiDetectorExtension: Whether to treat Atlassian OpenAPI request validator usage as verification evidence.
getUseOpenApiRequestValidator() - Method in class com.arc_e_tect.gradle.doppelganger.ScanContractsTask: Whether to treat Atlassian OpenAPI request validator usage as verification evidence.
getUseRestDocs() - Method in class com.arc_e_tect.gradle.doppelganger.DetectDoppelgangerApisTask: Whether to treat Spring RestDocs test methods as verification evidence.
getUseRestDocs() - Method in class com.arc_e_tect.gradle.doppelganger.DoppelgangerApiDetectorExtension: Whether to treat Spring RestDocs test methods as verification evidence: either a spring-restdocs-mockmvc mockMvc.perform(...) call paired with .andDo(document(...)), a spring-restdocs-webtestclient webTestClient.get()/post()/put()/delete()/patch().uri(...).exchange()... chain paired with .consumeWith(document(...)), or a spring-restdocs-restassured .filter(document(...)) paired with a when().get(...)/post(...)/... call.
getUseRestDocs() - Method in class com.arc_e_tect.gradle.doppelganger.ScanContractsTask: Whether to treat Spring RestDocs test methods as verification evidence.
getUseSpringCloudContract() - Method in class com.arc_e_tect.gradle.doppelganger.DetectDoppelgangerApisTask: Whether to treat Spring Cloud Contract DSL files as verification evidence.
getUseSpringCloudContract() - Method in class com.arc_e_tect.gradle.doppelganger.DoppelgangerApiDetectorExtension: Whether to treat Spring Cloud Contract DSL files under DoppelgangerApiDetectorExtension.getContractsDir() as verification evidence.
getUseSpringCloudContract() - Method in class com.arc_e_tect.gradle.doppelganger.ScanContractsTask: Whether to treat Spring Cloud Contract DSL files as verification evidence.

H

hashCode() - Method in record class com.arc_e_tect.gradle.doppelganger.detect.EndpointResponseCoverage: Returns a hash code value for this object.
hashCode() - Method in record class com.arc_e_tect.gradle.doppelganger.detect.VerifiedContractTest: Returns a hash code value for this object.
hashCode() - Method in record class com.arc_e_tect.gradle.doppelganger.progress.ResponseCoverageRecord: Returns a hash code value for this object.

L

lastSeenAt() - Method in record class com.arc_e_tect.gradle.doppelganger.progress.ResponseCoverageRecord: Returns the value of the lastSeenAt record component.
load(File) - Method in class com.arc_e_tect.gradle.doppelganger.progress.ResponseCoverageHistoryStore: Loads the response coverage history from file.

N

NAME - Static variable in class com.arc_e_tect.gradle.doppelganger.DoppelgangerApiDetectorExtension: Extension DSL block name, i.e.

O

OpenApiRequestValidatorScanner - Class in com.arc_e_tect.gradle.doppelganger.scan: ContractVerificationSource for the Atlassian OpenAPI request validator: a test method whose call chain contains either .filter(new OpenApiValidationFilter(...)) (REST Assured style) or a direct .validateRequest(...) / .validateResponse(...) call, paired with a REST-Assured-style request built via given()...when()...get(...) calls in the same method.
OpenApiRequestValidatorScanner() - Constructor for class com.arc_e_tect.gradle.doppelganger.scan.OpenApiRequestValidatorScanner: Creates a new OpenApiRequestValidatorScanner that resolves no configured helper-method calls or @Value-annotated fields.
OpenApiRequestValidatorScanner(PropertyResolutionContext) - Constructor for class com.arc_e_tect.gradle.doppelganger.scan.OpenApiRequestValidatorScanner: Creates a new OpenApiRequestValidatorScanner that additionally resolves a request-builder call's path argument against propertyResolutionContext when it is a configured helper-method call or an @Value-annotated field, in addition to the literal/literal-initialized-constant shapes LiteralPathResolver always resolves.
OpenApiServerBasePath - Class in com.arc_e_tect.gradle.doppelganger.scan: Resolves the path portion of an OpenAPI root document's first servers[].url entry, e.g.

P

path() - Method in record class com.arc_e_tect.gradle.doppelganger.progress.ResponseCoverageRecord: Returns the value of the path record component.

R

removedAt() - Method in record class com.arc_e_tect.gradle.doppelganger.progress.ResponseCoverageRecord: Returns the value of the removedAt record component.
resolve(File) - Static method in class com.arc_e_tect.gradle.doppelganger.scan.OpenApiServerBasePath: Resolves rootDocument's first server URL's path component, normalised via PathTemplates.normalize(String).
responseCode() - Method in record class com.arc_e_tect.gradle.doppelganger.progress.ResponseCoverageRecord: Returns the value of the responseCode record component.
ResponseCoverageAnalyzer - Class in com.arc_e_tect.gradle.doppelganger.detect: Computes, for every endpoint both declared in the OpenAPI documentation and implemented by a @RestController method, how many contract tests exist for it and - only when requested - how many of those tests cover each of its declared response codes.
ResponseCoverageAnalyzer() - Constructor for class com.arc_e_tect.gradle.doppelganger.detect.ResponseCoverageAnalyzer: Creates a new ResponseCoverageAnalyzer.
ResponseCoverageHistoryStore - Class in com.arc_e_tect.gradle.doppelganger.progress: Reads and writes ResponseCoverageRecords as newline-delimited JSON (NDJSON), one record per line, sorted by ResponseCoverageRecord.fingerprint() so that git diffs of the persisted file are minimal and stable - the same hand-rolled, dependency-free approach api-detector-core's ContractHistoryStore uses for the cross-plugin contract progress history.
ResponseCoverageHistoryStore() - Constructor for class com.arc_e_tect.gradle.doppelganger.progress.ResponseCoverageHistoryStore: Creates a new ResponseCoverageHistoryStore.
ResponseCoverageHistoryUpdater - Class in com.arc_e_tect.gradle.doppelganger.progress: Produces the next ResponseCoverageRecord map to persist, from the previously persisted map and this run's EndpointResponseCoverage rows - the response-coverage counterpart of api-detector-core's ContractHistoryUpdater.
ResponseCoverageHistoryUpdater() - Constructor for class com.arc_e_tect.gradle.doppelganger.progress.ResponseCoverageHistoryUpdater: Creates a new ResponseCoverageHistoryUpdater.
ResponseCoverageRecord - Record Class in com.arc_e_tect.gradle.doppelganger.progress: Persisted, per-endpoint-and-response-code history of contract test coverage, keyed by <endpoint fingerprint>-<response code> (see ResponseCoverageHistoryUpdater).
ResponseCoverageRecord(String, HttpVerb, String, String, int, Instant, Instant, Instant, Instant) - Constructor for record class com.arc_e_tect.gradle.doppelganger.progress.ResponseCoverageRecord: Creates an instance of a ResponseCoverageRecord record class.
ResponseCoverageTableWriter - Class in com.arc_e_tect.gradle.doppelganger.report: Writes the == Response Coverage Over Time AsciiDoc table section for the scanContracts report, from a loaded/advanced ResponseCoverageRecord history map.
ResponseCoverageTableWriter() - Constructor for class com.arc_e_tect.gradle.doppelganger.report.ResponseCoverageTableWriter: Creates a new ResponseCoverageTableWriter.
RestDocsScanner - Class in com.arc_e_tect.gradle.doppelganger.scan: ContractVerificationSource for Spring RestDocs, recognising three independent call-chain shapes for the same underlying convention - a request-builder call paired with a document(...) call somewhere in the same method body: spring-restdocs-mockmvc: mockMvc.perform(get(...)/post(...)/put(...)/ delete(...)/patch(...)) together with .andDo(document(...)). spring-restdocs-webtestclient: webTestClient.get()/post()/put()/ delete()/patch().uri(...).exchange()...consumeWith(document(...)) - the HTTP verb comes from the request-builder method and the path from the uri(...) call. spring-restdocs-restassured: given(...).filter(document(...))... when().get(...)/post(...)/put(...)/delete(...)/patch(...) - the verb call directly scoped on a call named when.
RestDocsScanner() - Constructor for class com.arc_e_tect.gradle.doppelganger.scan.RestDocsScanner: Creates a new RestDocsScanner that strips no base path from captured paths.
RestDocsScanner(String) - Constructor for class com.arc_e_tect.gradle.doppelganger.scan.RestDocsScanner: Creates a new RestDocsScanner that strips basePathToStrip - typically resolved via OpenApiServerBasePath.resolve(java.io.File) - from the leading segments of every path it captures, when present.
RestDocsScanner(String, PropertyResolutionContext) - Constructor for class com.arc_e_tect.gradle.doppelganger.scan.RestDocsScanner: Creates a new RestDocsScanner that additionally resolves a request-builder call's path argument against propertyResolutionContext when it is a configured helper-method call or an @Value-annotated field, in addition to the literal/ literal-initialized-constant shapes LiteralPathResolver always resolves.

S

save(File, Collection<ResponseCoverageRecord>) - Method in class com.arc_e_tect.gradle.doppelganger.progress.ResponseCoverageHistoryStore: Writes records to file as NDJSON, sorted by ResponseCoverageRecord.fingerprint(), overwriting any existing content.
scan(File) - Method in interface com.arc_e_tect.gradle.doppelganger.detect.ContractVerificationSource: Scans rootDir recursively and returns every endpoint this source found verification evidence for.
scan(File) - Method in class com.arc_e_tect.gradle.doppelganger.scan.OpenApiRequestValidatorScanner: Scans rootDir recursively and returns every endpoint this source found verification evidence for.
scan(File) - Method in class com.arc_e_tect.gradle.doppelganger.scan.RestDocsScanner: Scans rootDir recursively and returns every endpoint this source found verification evidence for.
scan(File) - Method in class com.arc_e_tect.gradle.doppelganger.scan.SpringCloudContractScanner: Scans rootDir recursively and returns every endpoint this source found verification evidence for.
SCAN_CONTRACTS_TASK_NAME - Static variable in class com.arc_e_tect.gradle.doppelganger.DoppelgangerApiDetectorPlugin: Name of the contract-coverage-scanning Gradle task registered by this plugin.
ScanContractsReportWriter - Class in com.arc_e_tect.gradle.doppelganger.report: Writes the AsciiDoc scanContracts report: for every endpoint both declared in the OpenAPI documentation and implemented by a @RestController method, its declared response codes and contract test count, plus - when includeResponseCoverage was enabled - a per-response-code test count breakdown.
ScanContractsReportWriter() - Constructor for class com.arc_e_tect.gradle.doppelganger.report.ScanContractsReportWriter: Creates a new ScanContractsReportWriter.
ScanContractsTask - Class in com.arc_e_tect.gradle.doppelganger: Gradle task that, for every endpoint both declared in the configured OpenAPI documentation and implemented by a @RestController method, reports how many response codes its operation declares and how many contract tests exist for it - and, when DoppelgangerApiDetectorExtension.getIncludeResponseCoverage() is enabled, how many of those tests cover each declared response code.
ScanContractsTask() - Constructor for class com.arc_e_tect.gradle.doppelganger.ScanContractsTask: Creates the task.
scanWithStatusCodes(File) - Method in interface com.arc_e_tect.gradle.doppelganger.detect.ContractVerificationSource: Scans rootDir recursively, same as ContractVerificationSource.scan(File), but additionally reports the HTTP status code each piece of evidence was detected to assert, when a source is able to determine one.
scanWithStatusCodes(File) - Method in class com.arc_e_tect.gradle.doppelganger.scan.OpenApiRequestValidatorScanner: Scans rootDir recursively, same as ContractVerificationSource.scan(File), but additionally reports the HTTP status code each piece of evidence was detected to assert, when a source is able to determine one.
scanWithStatusCodes(File) - Method in class com.arc_e_tect.gradle.doppelganger.scan.RestDocsScanner: Scans rootDir recursively, same as ContractVerificationSource.scan(File), but additionally reports the HTTP status code each piece of evidence was detected to assert, when a source is able to determine one.
scanWithStatusCodes(File) - Method in class com.arc_e_tect.gradle.doppelganger.scan.SpringCloudContractScanner: Scans rootDir recursively, same as ContractVerificationSource.scan(File), but additionally reports the HTTP status code each piece of evidence was detected to assert, when a source is able to determine one.
SpringCloudContractScanner - Class in com.arc_e_tect.gradle.doppelganger.scan: ContractVerificationSource for Spring Cloud Contract: declarative contract DSL files under src/testContract/resources/contracts/**/*.groovy (and .yml), read structurally for method '...' and url '...' / urlPath '...' entries.
SpringCloudContractScanner() - Constructor for class com.arc_e_tect.gradle.doppelganger.scan.SpringCloudContractScanner: Creates a new SpringCloudContractScanner.
statusCode() - Method in record class com.arc_e_tect.gradle.doppelganger.detect.VerifiedContractTest: Returns the value of the statusCode record component.
StatusCodeDetector - Class in com.arc_e_tect.gradle.doppelganger.scan: Best-effort detection of the HTTP status code a test method asserts, from the same List<MethodCallExpr> a ContractVerificationSource AST scanner already collects for that method - not exhaustive, since a test can assert a response's status in ways this cannot recognise (a variable, a helper method, a custom matcher); such tests still count towards an endpoint's overall contract test count, they simply contribute no evidence to any specific response code's count.

T

TASK_NAME - Static variable in class com.arc_e_tect.gradle.doppelganger.DoppelgangerApiDetectorPlugin: Name of the doppelganger-detection Gradle task registered by this plugin.
testCount() - Method in record class com.arc_e_tect.gradle.doppelganger.progress.ResponseCoverageRecord: Returns the value of the testCount record component.
testCountByResponseCode() - Method in record class com.arc_e_tect.gradle.doppelganger.detect.EndpointResponseCoverage: Returns the value of the testCountByResponseCode record component.
toString() - Method in record class com.arc_e_tect.gradle.doppelganger.detect.EndpointResponseCoverage: Returns a string representation of this record class.
toString() - Method in record class com.arc_e_tect.gradle.doppelganger.detect.VerifiedContractTest: Returns a string representation of this record class.
toString() - Method in record class com.arc_e_tect.gradle.doppelganger.progress.ResponseCoverageRecord: Returns a string representation of this record class.

U

untrackedTestCount() - Method in record class com.arc_e_tect.gradle.doppelganger.detect.EndpointResponseCoverage: Returns the value of the untrackedTestCount record component.
update(Map<String, ResponseCoverageRecord>, List<EndpointResponseCoverage>, Instant) - Method in class com.arc_e_tect.gradle.doppelganger.progress.ResponseCoverageHistoryUpdater: Computes the updated history map to persist.
UPDATE_CONTRACT_HISTORY_OVERRIDE_PROPERTY - Static variable in class com.arc_e_tect.gradle.doppelganger.DoppelgangerApiDetectorExtension: Name of the Gradle project property that overrides DoppelgangerApiDetectorExtension.getUpdateContractHistory() from the command line for every project in the build, e.g.
UPDATE_RESPONSE_COVERAGE_HISTORY_OVERRIDE_PROPERTY - Static variable in class com.arc_e_tect.gradle.doppelganger.DoppelgangerApiDetectorExtension: Name of the Gradle project property that overrides DoppelgangerApiDetectorExtension.getUpdateResponseCoverageHistory() from the command line for every project in the build, e.g.
Usage - Search tag in class com.arc_e_tect.gradle.doppelganger.DoppelgangerApiDetectorPlugin: Section

V

verb() - Method in record class com.arc_e_tect.gradle.doppelganger.progress.ResponseCoverageRecord: Returns the value of the verb record component.
VerifiedContractTest - Record Class in com.arc_e_tect.gradle.doppelganger.detect: A single piece of contract verification evidence, together with the HTTP status code it was detected to assert - the richer counterpart of a plain Endpoint produced by ContractVerificationSource.scanWithStatusCodes(java.io.File).
VerifiedContractTest(Endpoint, String) - Constructor for record class com.arc_e_tect.gradle.doppelganger.detect.VerifiedContractTest: Creates an instance of a VerifiedContractTest record class.

W

write(File, int, List<Endpoint>, String) - Method in class com.arc_e_tect.gradle.doppelganger.report.DoppelgangerApiReportWriter: Writes the report to outputFile, creating its parent directory if necessary.
write(File, int, List<Endpoint>, String, List<String>, Map<String, ContractProgressRecord>) - Method in class com.arc_e_tect.gradle.doppelganger.report.DoppelgangerApiReportWriter: Writes the report to outputFile, creating its parent directory if necessary.
write(File, int, List<Endpoint>, String, Map<String, ContractProgressRecord>) - Method in class com.arc_e_tect.gradle.doppelganger.report.DoppelgangerApiReportWriter: Writes the report to outputFile, creating its parent directory if necessary.
write(File, int, List<Endpoint>, List<Endpoint>, String, List<String>, Map<String, ContractProgressRecord>) - Method in class com.arc_e_tect.gradle.doppelganger.report.DoppelgangerApiReportWriter: Writes the report to outputFile, creating its parent directory if necessary.
write(File, List<EndpointResponseCoverage>, boolean, String, List<String>, Map<String, ResponseCoverageRecord>) - Method in class com.arc_e_tect.gradle.doppelganger.report.ScanContractsReportWriter: Writes the report to outputFile, creating its parent directory if necessary.
write(PrintWriter, Map<String, ResponseCoverageRecord>) - Method in class com.arc_e_tect.gradle.doppelganger.report.ResponseCoverageTableWriter: Writes the == Response Coverage Over Time section to writer, or nothing at all when history is empty.

A C D E F G H L N O P R S T U V W
All Classes and Interfaces|All Packages|Constant Field Values