Index (mirage-api-detector 4.4.2 API)

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

A

apply(Project) - Method in class com.arc_e_tect.gradle.mirage.MirageApiDetectorPlugin

C

CAUTION - Search tag in class com.arc_e_tect.gradle.mirage.MigrateContractHistoryTask: Section
com.arc_e_tect.gradle.mirage - package com.arc_e_tect.gradle.mirage
com.arc_e_tect.gradle.mirage.detect - package com.arc_e_tect.gradle.mirage.detect
com.arc_e_tect.gradle.mirage.report - package com.arc_e_tect.gradle.mirage.report
com.arc_e_tect.gradle.mirage.scan - package com.arc_e_tect.gradle.mirage.scan

D

DEFAULT_CONTRACT_HISTORY_FILE_NAME - Static variable in class com.arc_e_tect.gradle.mirage.MirageApiDetectorExtension: Default name of the persisted contract progress history file.
DEFAULT_CONTROLLER_DIR - Static variable in class com.arc_e_tect.gradle.mirage.MirageApiDetectorExtension: Default relative path of the directory searched for @RestController classes.
DEFAULT_REPORT_FILE_NAME - Static variable in class com.arc_e_tect.gradle.mirage.MirageApiDetectorExtension: Default name of the generated AsciiDoc report file.
DEFAULT_STUB_DIR - Static variable in class com.arc_e_tect.gradle.mirage.MirageApiDetectorExtension: Default relative path of the directory searched for WireMock stub mapping files.
Defaults - Search tag in class com.arc_e_tect.gradle.mirage.MirageApiDetectorPlugin: Section
DetectMirageApisTask - Class in com.arc_e_tect.gradle.mirage: Gradle task that parses the configured OpenAPI documentation, compares the operations it describes against the endpoints exposed by scanned @RestController classes, and writes an AsciiDoc report of every operation that has no match - the "mirage APIs".
DetectMirageApisTask() - Constructor for class com.arc_e_tect.gradle.mirage.DetectMirageApisTask: Creates the task.

E

endpoint() - Method in record class com.arc_e_tect.gradle.mirage.report.ExcludedMirage: Returns the value of the endpoint record component.
equals(Object) - Method in record class com.arc_e_tect.gradle.mirage.report.ExcludedMirage: Indicates whether some other object is "equal to" this one.
ExcludedMirage - Record Class in com.arc_e_tect.gradle.mirage.report: One mirage API excluded from == Mirage APIs/failOnMirage by a configured exclusion rule, paired with its current-run StubStatus for display in the == Excluded Mirage APIs report section.
ExcludedMirage(DescribedEndpoint, StubStatus) - Constructor for record class com.arc_e_tect.gradle.mirage.report.ExcludedMirage: Creates an instance of a ExcludedMirage record class.

F

findMirages(List<DescribedEndpoint>, List<Endpoint>) - Method in class com.arc_e_tect.gradle.mirage.detect.MirageApiFinder: Returns every endpoint in described that has no matching entry in endpoints.

G

generate() - Method in class com.arc_e_tect.gradle.mirage.DetectMirageApisTask: Task action: loads the configured OpenAPI documentation, scans the configured controller directories - and, when DetectMirageApisTask.getScanMocks() is true, additionally the configured WireMock stub directories - and writes the mirage API report.
getBasePath() - Method in class com.arc_e_tect.gradle.mirage.DetectMirageApisTask: The base path to strip from every path found under DetectMirageApisTask.getStubDirs() before comparing it against the OpenAPI documentation, used only when DetectMirageApisTask.getScanMocks() is true.
getBasePath() - Method in class com.arc_e_tect.gradle.mirage.MirageApiDetectorExtension: The base path to strip from every path found under MirageApiDetectorExtension.getStubDirs() and MirageApiDetectorExtension.getStubSourceDirs() before comparing it against the OpenAPI documentation, used only when MirageApiDetectorExtension.getScanMocks() is true.
getContractHistoryFile() - Method in class com.arc_e_tect.gradle.mirage.DetectMirageApisTask: File that the persisted contract progress history is read from and, when DetectMirageApisTask.getUpdateContractHistory() is true, written back to.
getContractHistoryFile() - Method in class com.arc_e_tect.gradle.mirage.MigrateContractHistoryTask: The legacy-format contract history file to migrate in place.
getContractHistoryFile() - Method in class com.arc_e_tect.gradle.mirage.MirageApiDetectorExtension: File that the persisted contract progress history is read from and, when MirageApiDetectorExtension.getUpdateContractHistory() is true, written back to.
getContractHistoryFilePath() - Method in class com.arc_e_tect.gradle.mirage.DetectMirageApisTask: The absolute path of DetectMirageApisTask.getContractHistoryFile(), tracked as a plain @Input value - not the file's content, which DetectMirageApisTask.getContractHistoryFile() itself is deliberately excluded from up-to-date checking for.
getControllerDirs() - Method in class com.arc_e_tect.gradle.mirage.DetectMirageApisTask: Directories to search recursively for @RestController classes.
getControllerDirs() - Method in class com.arc_e_tect.gradle.mirage.MigrateContractHistoryTask: Directories to search recursively for @RestController classes, used to determine which legacy records currently have real-implementation evidence.
getControllerDirs() - Method in class com.arc_e_tect.gradle.mirage.MirageApiDetectorExtension: Directories to search recursively for @RestController classes, used to determine which OpenAPI operations are implemented - and thus which are reported as mirage APIs.
getExcludeFiles() - Method in class com.arc_e_tect.gradle.mirage.DetectMirageApisTask: External exclusion rule files - see MirageApiDetectorExtension.getExcludeFiles().
getExcludeFiles() - Method in class com.arc_e_tect.gradle.mirage.MirageApiDetectorExtension: One or more YAML files of exclusion rules, in the same format bundled well-known sets use:
getExcludePaths() - Method in class com.arc_e_tect.gradle.mirage.DetectMirageApisTask: Exclusion rule strings - see MirageApiDetectorExtension.getExcludePaths().
getExcludePaths() - Method in class com.arc_e_tect.gradle.mirage.MirageApiDetectorExtension: Exclusion rule strings, parsed by ExclusionRule.parse(String) - e.g.
getExcludeWellKnown() - Method in class com.arc_e_tect.gradle.mirage.DetectMirageApisTask: Bundled well-known exclusion set names - see MirageApiDetectorExtension.getExcludeWellKnown().
getExcludeWellKnown() - Method in class com.arc_e_tect.gradle.mirage.MirageApiDetectorExtension: Names of bundled, well-known exclusion sets to apply - e.g.
getFailOnMirage() - Method in class com.arc_e_tect.gradle.mirage.DetectMirageApisTask: Whether the build should fail when mirage APIs are found.
getFailOnMirage() - Method in class com.arc_e_tect.gradle.mirage.MirageApiDetectorExtension: Whether the build should fail when mirage APIs are found.
getOpenApiDir() - Method in class com.arc_e_tect.gradle.mirage.DetectMirageApisTask: Directory where OpenAPI descriptions are stored, tracked so that changes to any document reachable from DetectMirageApisTask.getRootDocument() invalidate the task's cached result.
getOpenApiDir() - Method in class com.arc_e_tect.gradle.mirage.MirageApiDetectorExtension: Directory where OpenAPI descriptions are stored.
getReportDir() - Method in class com.arc_e_tect.gradle.mirage.DetectMirageApisTask: Directory the AsciiDoc report is written to.
getReportDir() - Method in class com.arc_e_tect.gradle.mirage.MirageApiDetectorExtension: Directory the AsciiDoc report is written to.
getReportFileName() - Method in class com.arc_e_tect.gradle.mirage.DetectMirageApisTask: Name of the generated AsciiDoc report file (without path).
getReportFileName() - Method in class com.arc_e_tect.gradle.mirage.MirageApiDetectorExtension: Name of the generated AsciiDoc report file (without path).
getRootDocument() - Method in class com.arc_e_tect.gradle.mirage.DetectMirageApisTask: The root OpenAPI document describing the API.
getRootDocument() - Method in class com.arc_e_tect.gradle.mirage.MirageApiDetectorExtension: The root OpenAPI document describing the API.
getScanMocks() - Method in class com.arc_e_tect.gradle.mirage.DetectMirageApisTask: Whether to additionally scan WireMock stub mapping files under DetectMirageApisTask.getStubDirs() for stub evidence, recorded into contract history/the report alongside DetectMirageApisTask.getControllerDirs()'s real implementation evidence.
getScanMocks() - Method in class com.arc_e_tect.gradle.mirage.MirageApiDetectorExtension: Whether to additionally scan WireMock stub mapping files under MirageApiDetectorExtension.getStubDirs() for stub evidence, alongside MirageApiDetectorExtension.getControllerDirs()'s real implementation evidence.
getStubDirs() - Method in class com.arc_e_tect.gradle.mirage.DetectMirageApisTask: Directories to search recursively for WireMock stub mapping files, scanned for stub evidence when DetectMirageApisTask.getScanMocks() is true.
getStubDirs() - Method in class com.arc_e_tect.gradle.mirage.MigrateContractHistoryTask: Directories to search recursively for WireMock stub mapping files, used to determine which legacy records currently have stub evidence.
getStubDirs() - Method in class com.arc_e_tect.gradle.mirage.MirageApiDetectorExtension: Directories to search recursively for WireMock stub mapping files (*.json), scanned for stub evidence when MirageApiDetectorExtension.getScanMocks() is true.
getStubSourceDirs() - Method in class com.arc_e_tect.gradle.mirage.DetectMirageApisTask: Directories to search recursively for Java source files that create WireMock stubs programmatically at test run time, scanned for stub evidence when DetectMirageApisTask.getScanMocks() is true - see MirageApiDetectorExtension.getStubSourceDirs().
getStubSourceDirs() - Method in class com.arc_e_tect.gradle.mirage.MirageApiDetectorExtension: Directories to search recursively for Java source files that create WireMock stubs programmatically at test run time - e.g.
getSystemUnderTestVersion() - Method in class com.arc_e_tect.gradle.mirage.DetectMirageApisTask: 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.mirage.MirageApiDetectorExtension: Version of the system under test whose @RestController classes are scanned, printed in the generated report as e.g.
getTrackContractHistory() - Method in class com.arc_e_tect.gradle.mirage.DetectMirageApisTask: 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.mirage.MirageApiDetectorExtension: 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 Doppelganger API Detector when they're pointed at the same MirageApiDetectorExtension.getContractHistoryFile().
getUpdateContractHistory() - Method in class com.arc_e_tect.gradle.mirage.DetectMirageApisTask: Whether DetectMirageApisTask.getContractHistoryFile() is written back to disk after being updated with the current run's endpoints.
getUpdateContractHistory() - Method in class com.arc_e_tect.gradle.mirage.MirageApiDetectorExtension: Whether MirageApiDetectorExtension.getContractHistoryFile() is written back to disk after being updated with the current run's endpoints.

H

hashCode() - Method in record class com.arc_e_tect.gradle.mirage.report.ExcludedMirage: Returns a hash code value for this object.

M

migrate() - Method in class com.arc_e_tect.gradle.mirage.MigrateContractHistoryTask: Task action: loads MigrateContractHistoryTask.getContractHistoryFile() as the legacy 9-field format, re-scans MigrateContractHistoryTask.getControllerDirs() and MigrateContractHistoryTask.getStubDirs(), reconstructs every record per the rules documented on this class, backs up the original file, and writes the migrated result back to the same path in the current 10-field format.
MIGRATE_CONTRACT_HISTORY_TASK_NAME - Static variable in class com.arc_e_tect.gradle.mirage.MirageApiDetectorPlugin: Name of the contract history migration task registered by this plugin.
MigrateContractHistoryTask - Class in com.arc_e_tect.gradle.mirage: Gradle task that migrates MigrateContractHistoryTask.getContractHistoryFile() from the pre-stubbedAt 9-field NDJSON format to the current 10-field format, by re-scanning the currently configured MigrateContractHistoryTask.getControllerDirs() and MigrateContractHistoryTask.getStubDirs() to work out, for every legacy record that has implementedAt set, whether that evidence should now count as a real implementation, a WireMock stub, both, or neither.
MigrateContractHistoryTask() - Constructor for class com.arc_e_tect.gradle.mirage.MigrateContractHistoryTask: Creates the task.
MirageApiDetectorExtension - Class in com.arc_e_tect.gradle.mirage: DSL extension for the Mirage API Detector Gradle plugin.
MirageApiDetectorExtension() - Constructor for class com.arc_e_tect.gradle.mirage.MirageApiDetectorExtension: For use by the Gradle-generated concrete subclass.
MirageApiDetectorPlugin - Class in com.arc_e_tect.gradle.mirage: Gradle plugin that registers the detectMirageApis task and wires the mirageApiDetector DSL extension into the project.
MirageApiDetectorPlugin() - Constructor for class com.arc_e_tect.gradle.mirage.MirageApiDetectorPlugin: Creates a new plugin instance.
MirageApiFinder - Class in com.arc_e_tect.gradle.mirage.detect: Determines which DescribedEndpoints collected from the OpenAPI documentation have no matching controller Endpoint, i.e.
MirageApiFinder() - Constructor for class com.arc_e_tect.gradle.mirage.detect.MirageApiFinder: Creates a new MirageApiFinder.
MirageApiReportWriter - Class in com.arc_e_tect.gradle.mirage.report: Writes the AsciiDoc mirage API report: every OpenAPI operation that has no matching @RestController implementation.
MirageApiReportWriter() - Constructor for class com.arc_e_tect.gradle.mirage.report.MirageApiReportWriter: Creates a new MirageApiReportWriter.

N

NAME - Static variable in class com.arc_e_tect.gradle.mirage.MirageApiDetectorExtension: Extension DSL block name, i.e.
NOT_SCANNED - Enum constant in enum class com.arc_e_tect.gradle.mirage.report.StubStatus: scanMocks was disabled, so no stub evidence was gathered this run.
NOT_STUBBED - Enum constant in enum class com.arc_e_tect.gradle.mirage.report.StubStatus: scanMocks was enabled but no matching stub mapping was found this run.

S

scan(File) - Method in class com.arc_e_tect.gradle.mirage.scan.WireMockJavaDslScanner: Scans every .java file under rootDir, recursively, for stubFor(...) calls shaped as described in the class documentation.
scan(File) - Method in class com.arc_e_tect.gradle.mirage.scan.WireMockStubScanner: Scans every .json file under rootDir, recursively, for the stubbed method and URL.
STUBBED - Enum constant in enum class com.arc_e_tect.gradle.mirage.report.StubStatus: A matching WireMock stub mapping was found this run.
stubStatus() - Method in record class com.arc_e_tect.gradle.mirage.report.ExcludedMirage: Returns the value of the stubStatus record component.
StubStatus - Enum Class in com.arc_e_tect.gradle.mirage.report: An excluded mirage's current-run WireMock stub status, shown in the == Excluded Mirage APIs report section.

T

TASK_NAME - Static variable in class com.arc_e_tect.gradle.mirage.MirageApiDetectorPlugin: Name of the Gradle task registered by this plugin.
toString() - Method in record class com.arc_e_tect.gradle.mirage.report.ExcludedMirage: Returns a string representation of this record class.

U

UPDATE_CONTRACT_HISTORY_OVERRIDE_PROPERTY - Static variable in class com.arc_e_tect.gradle.mirage.MirageApiDetectorExtension: Name of the Gradle project property that overrides MirageApiDetectorExtension.getUpdateContractHistory() from the command line for every project in the build, e.g.
Usage - Search tag in class com.arc_e_tect.gradle.mirage.MirageApiDetectorPlugin: Section

V

valueOf(String) - Static method in enum class com.arc_e_tect.gradle.mirage.report.StubStatus: Returns the enum constant of this class with the specified name.
values() - Static method in enum class com.arc_e_tect.gradle.mirage.report.StubStatus: Returns an array containing the constants of this enum class, in the order they are declared.

W

WireMockJavaDslScanner - Class in com.arc_e_tect.gradle.mirage.scan: Scans Java source files for WireMock's fluent Java stub-registration DSL, e.g.:
WireMockJavaDslScanner() - Constructor for class com.arc_e_tect.gradle.mirage.scan.WireMockJavaDslScanner: Creates a new WireMockJavaDslScanner.
WireMockStubScanner - Class in com.arc_e_tect.gradle.mirage.scan: Scans WireMock stub mapping files (*.json) for the request each one stubs, treating every stubbed request as an implemented endpoint.
WireMockStubScanner() - Constructor for class com.arc_e_tect.gradle.mirage.scan.WireMockStubScanner: Creates a new WireMockStubScanner.
write(File, int, List<DescribedEndpoint>, String) - Method in class com.arc_e_tect.gradle.mirage.report.MirageApiReportWriter: Writes the report to outputFile, creating its parent directory if necessary.
write(File, int, List<DescribedEndpoint>, String, List<String>, Map<String, ContractProgressRecord>) - Method in class com.arc_e_tect.gradle.mirage.report.MirageApiReportWriter: Writes the report to outputFile, creating its parent directory if necessary.
write(File, int, List<DescribedEndpoint>, String, Map<String, ContractProgressRecord>) - Method in class com.arc_e_tect.gradle.mirage.report.MirageApiReportWriter: Writes the report to outputFile, creating its parent directory if necessary.
write(File, int, List<DescribedEndpoint>, List<ExcludedMirage>, String, List<String>, Map<String, ContractProgressRecord>) - Method in class com.arc_e_tect.gradle.mirage.report.MirageApiReportWriter: Writes the report to outputFile, creating its parent directory if necessary.

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