Index (doppelganger-api-detector 0.0.1 API)

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

A

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.report - package com.arc_e_tect.gradle.doppelganger.report
com.arc_e_tect.gradle.doppelganger.scan - package com.arc_e_tect.gradle.doppelganger.scan
ContractVerificationSource - Interface in com.arc_e_tect.gradle.doppelganger.detect: A pluggable source of "this endpoint's contract is verified" evidence.

D

DEFAULT_CONTRACTS_DIR - Static variable in class com.arc_e_tect.gradle.doppelganger.DoppelgangerApiDetectorExtension: Default relative path of the directory searched for Spring Cloud Contract DSL files.
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_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
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.

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.

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.
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.
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.
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.
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.
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.
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).
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.
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.
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.
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.
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 (a mockMvc.perform(...) call paired with .andDo(document(...))) 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.

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.

R

RestDocsScanner - Class in com.arc_e_tect.gradle.doppelganger.scan: ContractVerificationSource for Spring RestDocs: a test method whose call chain contains a mockMvc.perform(get(...)/post(...)/put(...)/delete(...)/patch(...)) call and also includes .andDo(document(...)) somewhere in the same method body.
RestDocsScanner() - Constructor for class com.arc_e_tect.gradle.doppelganger.scan.RestDocsScanner: Creates a new RestDocsScanner.

S

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.
SpringCloudContractScanner - Class in com.arc_e_tect.gradle.doppelganger.scan: ContractVerificationSource for Spring Cloud Contract: declarative contract DSL files under src/test/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.

T

TASK_NAME - Static variable in class com.arc_e_tect.gradle.doppelganger.DoppelgangerApiDetectorPlugin: Name of the Gradle task registered by this plugin.

U

Usage - Search tag in class com.arc_e_tect.gradle.doppelganger.DoppelgangerApiDetectorPlugin: Section

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.

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