-
Notifications
You must be signed in to change notification settings - Fork 12
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
- Loading branch information
Showing
6 changed files
with
242 additions
and
245 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -1,57 +1,57 @@ | ||
| ## Quarkus - WireMock | ||
| [](https://github.com/quarkiverse/quarkus-wiremock/actions/workflows/build.yml) | ||
| [](https://opensource.org/licenses/Apache-2.0) | ||
| <!-- ALL-CONTRIBUTORS-BADGE:START - Do not remove or modify this section --> | ||
| [](#contributors-) | ||
| <!-- ALL-CONTRIBUTORS-BADGE:END --> | ||
|
|
||
| ## Description | ||
|
|
||
| Quarkus [WireMock](https://wiremock.org) extension for tests and local development. | ||
|
|
||
| ## Compatibility | ||
|
|
||
| This Quarkus ``WireMock`` extension provides different version streams. | ||
|
|
||
| | WireMock extension | Quarkus Platform | WireMock | Documentation | | ||
| |---------------------|------------------|----------|---------------------------------------------------------------------------------------------------------------------| | ||
| | 0.x.x | 2.16.x.Final | 2.35.x | [Quarkiverse Docs - Wiremock (0.x)](https://quarkiverse.github.io/quarkiverse-docs/quarkus-wiremock/0.x/index.html) | | ||
| | 1.x.x (coming soon) | 3.2.x (LTS) | 3.x | [Quarkiverse Docs - Wiremock (dev)](https://quarkiverse.github.io/quarkiverse-docs/quarkus-wiremock/dev/index.html) | | ||
|
|
||
| ## Development instructions | ||
|
|
||
|
|
||
| ### Module description | ||
|
|
||
| | Module | Description | | ||
| |------------------|----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| | ||
| | deployment | The deployment module is used during the augmentation phase of the build and contains the major logic to configure and ramp-up ``WireMock`` as a ``DevService``. In addition, this module also contains test classes to test basic ``DevService`` functionality. | | ||
| | runtime | This is the module the application's developer will add as application dependency to enable ``WireMock`` as a ``DevService``. For this extension the runtime module is almost empty since everything will happen at build time (please refer to the deployment module). | | ||
| | test | This module can be used during test execution to retrieve a reference of the running ``WireMock`` instance managed by the ``DevService``. This is quite helpful when a developer wants to describe the ``WireMock`` behavior programmatically. For more details please refer to the documentation. | | ||
| | integration-test | Contains Quarkus tests to verify the proper functionality of the extension. This module uses the ``WireMock`` extension in a way how a business application would use it. | | ||
| | docs | Project documentation happens via [Asciidoctor](https://asciidoctor.org/) for content and [Antora](https://antora.org/) for navigation. The resulting documentation will be published to [Quarkiverse Docs](https://docs.quarkiverse.io/). | | ||
|
|
||
| ## Contributors ✨ | ||
|
|
||
| Thanks goes to these wonderful people ([emoji key](https://allcontributors.org/docs/en/emoji-key)): | ||
|
|
||
| <!-- ALL-CONTRIBUTORS-LIST:START - Do not remove or modify this section --> | ||
| <!-- prettier-ignore-start --> | ||
| <!-- markdownlint-disable --> | ||
| <table> | ||
| <tbody> | ||
| <tr> | ||
| <td align="center" valign="top" width="14.28%"><a href="https://github.com/Spanjer1"><img src="https://avatars.githubusercontent.com/u/40360503?v=4?s=100" width="100px;" alt="Spanjer1"/><br /><sub><b>Spanjer1</b></sub></a><br /><a href="https://github.com/quarkiverse/quarkus-wiremock/commits?author=Spanjer1" title="Code">💻</a> <a href="#maintenance-Spanjer1" title="Maintenance">🚧</a></td> | ||
| <td align="center" valign="top" width="14.28%"><a href="https://techspace.de"><img src="https://avatars.githubusercontent.com/u/3606282?v=4?s=100" width="100px;" alt="Christian Berger"/><br /><sub><b>Christian Berger</b></sub></a><br /><a href="https://github.com/quarkiverse/quarkus-wiremock/commits?author=chberger" title="Code">💻</a> <a href="#maintenance-chberger" title="Maintenance">🚧</a></td> | ||
| <td align="center" valign="top" width="14.28%"><a href="https://wjglerum.nl"><img src="https://avatars.githubusercontent.com/u/7404187?v=4?s=100" width="100px;" alt="Willem Jan Glerum"/><br /><sub><b>Willem Jan Glerum</b></sub></a><br /><a href="https://github.com/quarkiverse/quarkus-wiremock/commits?author=wjglerum" title="Code">💻</a></td> | ||
| </tr> | ||
| </tbody> | ||
| </table> | ||
|
|
||
| <!-- markdownlint-restore --> | ||
| <!-- prettier-ignore-end --> | ||
|
|
||
| <!-- ALL-CONTRIBUTORS-LIST:END --> | ||
|
|
||
| This project follows the [all-contributors](https://github.com/all-contributors/all-contributors) specification. | ||
| Contributions of any kind welcome! | ||
| ## Quarkus - WireMock | ||
| [](https://github.com/quarkiverse/quarkus-wiremock/actions/workflows/build.yml) | ||
| [](https://opensource.org/licenses/Apache-2.0) | ||
| <!-- ALL-CONTRIBUTORS-BADGE:START - Do not remove or modify this section --> | ||
| [](#contributors-) | ||
| <!-- ALL-CONTRIBUTORS-BADGE:END --> | ||
|
|
||
| ## Description | ||
|
|
||
| Quarkus [WireMock](https://wiremock.org) extension for tests and local development. | ||
|
|
||
| ## Compatibility | ||
|
|
||
| This Quarkus ``WireMock`` extension provides different version streams. | ||
|
|
||
| | WireMock extension | Quarkus Platform | WireMock | Documentation | | ||
| |---------------------|------------------|----------|---------------------------------------------------------------------------------------------------------------------| | ||
| | 0.x.x | 2.16.x.Final | 2.35.x | [Quarkiverse Docs - Wiremock (0.x)](https://quarkiverse.github.io/quarkiverse-docs/quarkus-wiremock/0.x/index.html) | | ||
| | 1.x.x (coming soon) | 3.2.x (LTS) | 3.x | [Quarkiverse Docs - Wiremock (dev)](https://quarkiverse.github.io/quarkiverse-docs/quarkus-wiremock/dev/index.html) | | ||
|
|
||
| ## Development instructions | ||
|
|
||
|
|
||
| ### Module description | ||
|
|
||
| | Module | Description | | ||
| |------------------|----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| | ||
| | deployment | The deployment module is used during the augmentation phase of the build and contains the major logic to configure and ramp-up ``WireMock`` as a ``DevService``. In addition, this module also contains test classes to test basic ``DevService`` functionality. | | ||
| | runtime | This is the module the application's developer will add as application dependency to enable ``WireMock`` as a ``DevService``. For this extension the runtime module is almost empty since everything will happen at build time (please refer to the deployment module). | | ||
| | test | This module can be used during test execution to retrieve a reference of the running ``WireMock`` instance managed by the ``DevService``. This is quite helpful when a developer wants to describe the ``WireMock`` behavior programmatically. For more details please refer to the documentation. | | ||
| | integration-test | Contains Quarkus tests to verify the proper functionality of the extension. This module uses the ``WireMock`` extension in a way how a business application would use it. | | ||
| | docs | Project documentation happens via [Asciidoctor](https://asciidoctor.org/) for content and [Antora](https://antora.org/) for navigation. The resulting documentation will be published to [Quarkiverse Docs](https://docs.quarkiverse.io/). | | ||
|
|
||
| ## Contributors ✨ | ||
|
|
||
| Thanks goes to these wonderful people ([emoji key](https://allcontributors.org/docs/en/emoji-key)): | ||
|
|
||
| <!-- ALL-CONTRIBUTORS-LIST:START - Do not remove or modify this section --> | ||
| <!-- prettier-ignore-start --> | ||
| <!-- markdownlint-disable --> | ||
| <table> | ||
| <tbody> | ||
| <tr> | ||
| <td align="center" valign="top" width="14.28%"><a href="https://github.com/Spanjer1"><img src="https://avatars.githubusercontent.com/u/40360503?v=4?s=100" width="100px;" alt="Spanjer1"/><br /><sub><b>Spanjer1</b></sub></a><br /><a href="https://github.com/quarkiverse/quarkus-wiremock/commits?author=Spanjer1" title="Code">💻</a> <a href="#maintenance-Spanjer1" title="Maintenance">🚧</a></td> | ||
| <td align="center" valign="top" width="14.28%"><a href="https://techspace.de"><img src="https://avatars.githubusercontent.com/u/3606282?v=4?s=100" width="100px;" alt="Christian Berger"/><br /><sub><b>Christian Berger</b></sub></a><br /><a href="https://github.com/quarkiverse/quarkus-wiremock/commits?author=chberger" title="Code">💻</a> <a href="#maintenance-chberger" title="Maintenance">🚧</a></td> | ||
| <td align="center" valign="top" width="14.28%"><a href="https://wjglerum.nl"><img src="https://avatars.githubusercontent.com/u/7404187?v=4?s=100" width="100px;" alt="Willem Jan Glerum"/><br /><sub><b>Willem Jan Glerum</b></sub></a><br /><a href="https://github.com/quarkiverse/quarkus-wiremock/commits?author=wjglerum" title="Code">💻</a></td> | ||
| </tr> | ||
| </tbody> | ||
| </table> | ||
|
|
||
| <!-- markdownlint-restore --> | ||
| <!-- prettier-ignore-end --> | ||
|
|
||
| <!-- ALL-CONTRIBUTORS-LIST:END --> | ||
|
|
||
| This project follows the [all-contributors](https://github.com/all-contributors/all-contributors) specification. | ||
| Contributions of any kind welcome! |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -1,10 +1,10 @@ | ||
| { | ||
| "request": { | ||
| "method": "GET", | ||
| "url": "/wiremock" | ||
| }, | ||
| "response": { | ||
| "status": 200, | ||
| "body": "Everything was just fine!" | ||
| } | ||
| { | ||
| "request": { | ||
| "method": "GET", | ||
| "url": "/wiremock" | ||
| }, | ||
| "response": { | ||
| "status": 200, | ||
| "body": "Everything was just fine!" | ||
| } | ||
| } |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -1,3 +1,3 @@ | ||
| :project-version: 0.0.2 | ||
|
|
||
| :project-version: 0.0.2 | ||
|
|
||
| :examples-dir: ./../examples/ |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -1,90 +1,90 @@ | ||
| :summaryTableId: quarkus-wiremock | ||
| [.configuration-legend] | ||
| icon:lock[title=Fixed at build time] Configuration property fixed at build time - All other configuration properties are overridable at runtime | ||
| [.configuration-reference.searchable, cols="80,.^10,.^10"] | ||
| |=== | ||
|
|
||
| h|[[quarkus-wiremock_configuration]]link:#quarkus-wiremock_configuration[Configuration property] | ||
|
|
||
| h|Type | ||
| h|Default | ||
|
|
||
| a|icon:lock[title=Fixed at build time] [[quarkus-wiremock_quarkus.wiremock.devservices.enabled]]`link:#quarkus-wiremock_quarkus.wiremock.devservices.enabled[quarkus.wiremock.devservices.enabled]` | ||
|
|
||
| [.description] | ||
| -- | ||
| If DevServices has been explicitly enabled or disabled. DevServices is generally enabled by default, unless there is an existing configuration present. | ||
|
|
||
| ifdef::add-copy-button-to-env-var[] | ||
| Environment variable: env_var_with_copy_button:+++QUARKUS_WIREMOCK_DEVSERVICES_ENABLED+++[] | ||
| endif::add-copy-button-to-env-var[] | ||
| ifndef::add-copy-button-to-env-var[] | ||
| Environment variable: `+++QUARKUS_WIREMOCK_DEVSERVICES_ENABLED+++` | ||
| endif::add-copy-button-to-env-var[] | ||
| --|boolean | ||
| |`true` | ||
|
|
||
| a|icon:lock[title=Fixed at build time] [[quarkus-wiremock_quarkus.wiremock.devservices.service-name]]`link:#quarkus-wiremock_quarkus.wiremock.devservices.service-name[quarkus.wiremock.devservices.service-name]` | ||
|
|
||
| [.description] | ||
| -- | ||
| Name of the WireMock Dev Service. | ||
|
|
||
| ifdef::add-copy-button-to-env-var[] | ||
| Environment variable: env_var_with_copy_button:+++QUARKUS_WIREMOCK_DEVSERVICES_SERVICE_NAME+++[] | ||
| endif::add-copy-button-to-env-var[] | ||
| ifndef::add-copy-button-to-env-var[] | ||
| Environment variable: `+++QUARKUS_WIREMOCK_DEVSERVICES_SERVICE_NAME+++` | ||
| endif::add-copy-button-to-env-var[] | ||
| --|string | ||
| |`wiremock-server` | ||
|
|
||
|
|
||
| a|icon:lock[title=Fixed at build time] [[quarkus-wiremock_quarkus.wiremock.devservices.port]]`link:#quarkus-wiremock_quarkus.wiremock.devservices.port[quarkus.wiremock.devservices.port]` | ||
|
|
||
| [.description] | ||
| -- | ||
| Optional fixed port the dev service will listen to. | ||
|
|
||
| ifdef::add-copy-button-to-env-var[] | ||
| Environment variable: env_var_with_copy_button:+++QUARKUS_wiremock_DEVSERVICES_PORT+++[] | ||
| endif::add-copy-button-to-env-var[] | ||
| ifndef::add-copy-button-to-env-var[] | ||
| Environment variable: `+++QUARKUS_WIREMOCK_DEVSERVICES_PORT+++` | ||
| endif::add-copy-button-to-env-var[] | ||
| --|int | ||
| |8089 | ||
|
|
||
| a|icon:lock[title=Fixed at build time] [[quarkus-wiremock_quarkus.wiremock.devservices.reload]]`link:#quarkus-wiremock_quarkus.wiremock.devservices.reload[quarkus.wiremock.devservices.reload]` | ||
|
|
||
| [.description] | ||
| -- | ||
| Restart WireMock whenever Quarkus is reloaded. Otherwise, whenever files are changed in the `files-mapping` location you would need to manually | ||
| reload Quarkus. | ||
|
|
||
| ifdef::add-copy-button-to-env-var[] | ||
| Environment variable: env_var_with_copy_button:+++QUARKUS_WIREMOCK_DEVSERVICES_RELOAD+++[] | ||
| endif::add-copy-button-to-env-var[] | ||
| ifndef::add-copy-button-to-env-var[] | ||
| Environment variable: `+++QUARKUS_WIREMOCK_DEVSERVICES_RELOAD+++` | ||
| endif::add-copy-button-to-env-var[] | ||
| --|boolean | ||
| |`false` | ||
|
|
||
| a|icon:lock[title=Fixed at build time] [[quarkus-wiremock_quarkus.wiremock.devservices.files-mapping]]`link:#quarkus-wiremock_quarkus.wiremock.devservices.files-mapping[quarkus.wiremock.devservices.files-mapping]` | ||
|
|
||
| [.description] | ||
| -- | ||
| Path to root dir with `mappings` and `__files` folders. | ||
|
|
||
| ifdef::add-copy-button-to-env-var[] | ||
| Environment variable: env_var_with_copy_button:+++QUARKUS_WIREMOCK_DEVSERVICES_FILES_MAPPING+++[] | ||
| endif::add-copy-button-to-env-var[] | ||
| ifndef::add-copy-button-to-env-var[] | ||
| Environment variable: `+++QUARKUS_WIREMOCK_DEVSERVICES_FILES_MAPPING+++` | ||
| endif::add-copy-button-to-env-var[] | ||
| --|string | ||
| |`src/test/resources` | ||
|
|
||
|
|
||
| :summaryTableId: quarkus-wiremock | ||
| [.configuration-legend] | ||
| icon:lock[title=Fixed at build time] Configuration property fixed at build time - All other configuration properties are overridable at runtime | ||
| [.configuration-reference.searchable, cols="80,.^10,.^10"] | ||
| |=== | ||
|
|
||
| h|[[quarkus-wiremock_configuration]]link:#quarkus-wiremock_configuration[Configuration property] | ||
|
|
||
| h|Type | ||
| h|Default | ||
|
|
||
| a|icon:lock[title=Fixed at build time] [[quarkus-wiremock_quarkus.wiremock.devservices.enabled]]`link:#quarkus-wiremock_quarkus.wiremock.devservices.enabled[quarkus.wiremock.devservices.enabled]` | ||
|
|
||
| [.description] | ||
| -- | ||
| If DevServices has been explicitly enabled or disabled. DevServices is generally enabled by default, unless there is an existing configuration present. | ||
|
|
||
| ifdef::add-copy-button-to-env-var[] | ||
| Environment variable: env_var_with_copy_button:+++QUARKUS_WIREMOCK_DEVSERVICES_ENABLED+++[] | ||
| endif::add-copy-button-to-env-var[] | ||
| ifndef::add-copy-button-to-env-var[] | ||
| Environment variable: `+++QUARKUS_WIREMOCK_DEVSERVICES_ENABLED+++` | ||
| endif::add-copy-button-to-env-var[] | ||
| --|boolean | ||
| |`true` | ||
|
|
||
| a|icon:lock[title=Fixed at build time] [[quarkus-wiremock_quarkus.wiremock.devservices.service-name]]`link:#quarkus-wiremock_quarkus.wiremock.devservices.service-name[quarkus.wiremock.devservices.service-name]` | ||
|
|
||
| [.description] | ||
| -- | ||
| Name of the WireMock Dev Service. | ||
|
|
||
| ifdef::add-copy-button-to-env-var[] | ||
| Environment variable: env_var_with_copy_button:+++QUARKUS_WIREMOCK_DEVSERVICES_SERVICE_NAME+++[] | ||
| endif::add-copy-button-to-env-var[] | ||
| ifndef::add-copy-button-to-env-var[] | ||
| Environment variable: `+++QUARKUS_WIREMOCK_DEVSERVICES_SERVICE_NAME+++` | ||
| endif::add-copy-button-to-env-var[] | ||
| --|string | ||
| |`wiremock-server` | ||
|
|
||
|
|
||
| a|icon:lock[title=Fixed at build time] [[quarkus-wiremock_quarkus.wiremock.devservices.port]]`link:#quarkus-wiremock_quarkus.wiremock.devservices.port[quarkus.wiremock.devservices.port]` | ||
|
|
||
| [.description] | ||
| -- | ||
| Optional fixed port the dev service will listen to. | ||
|
|
||
| ifdef::add-copy-button-to-env-var[] | ||
| Environment variable: env_var_with_copy_button:+++QUARKUS_wiremock_DEVSERVICES_PORT+++[] | ||
| endif::add-copy-button-to-env-var[] | ||
| ifndef::add-copy-button-to-env-var[] | ||
| Environment variable: `+++QUARKUS_WIREMOCK_DEVSERVICES_PORT+++` | ||
| endif::add-copy-button-to-env-var[] | ||
| --|int | ||
| |8089 | ||
|
|
||
| a|icon:lock[title=Fixed at build time] [[quarkus-wiremock_quarkus.wiremock.devservices.reload]]`link:#quarkus-wiremock_quarkus.wiremock.devservices.reload[quarkus.wiremock.devservices.reload]` | ||
|
|
||
| [.description] | ||
| -- | ||
| Restart WireMock whenever Quarkus is reloaded. Otherwise, whenever files are changed in the `files-mapping` location you would need to manually | ||
| reload Quarkus. | ||
|
|
||
| ifdef::add-copy-button-to-env-var[] | ||
| Environment variable: env_var_with_copy_button:+++QUARKUS_WIREMOCK_DEVSERVICES_RELOAD+++[] | ||
| endif::add-copy-button-to-env-var[] | ||
| ifndef::add-copy-button-to-env-var[] | ||
| Environment variable: `+++QUARKUS_WIREMOCK_DEVSERVICES_RELOAD+++` | ||
| endif::add-copy-button-to-env-var[] | ||
| --|boolean | ||
| |`false` | ||
|
|
||
| a|icon:lock[title=Fixed at build time] [[quarkus-wiremock_quarkus.wiremock.devservices.files-mapping]]`link:#quarkus-wiremock_quarkus.wiremock.devservices.files-mapping[quarkus.wiremock.devservices.files-mapping]` | ||
|
|
||
| [.description] | ||
| -- | ||
| Path to root dir with `mappings` and `__files` folders. | ||
|
|
||
| ifdef::add-copy-button-to-env-var[] | ||
| Environment variable: env_var_with_copy_button:+++QUARKUS_WIREMOCK_DEVSERVICES_FILES_MAPPING+++[] | ||
| endif::add-copy-button-to-env-var[] | ||
| ifndef::add-copy-button-to-env-var[] | ||
| Environment variable: `+++QUARKUS_WIREMOCK_DEVSERVICES_FILES_MAPPING+++` | ||
| endif::add-copy-button-to-env-var[] | ||
| --|string | ||
| |`src/test/resources` | ||
|
|
||
|
|
||
| |=== |
Oops, something went wrong.