wiremock-grpc-extension for test scope only

.github/workflows/ci.yml

@@ -20,15 +20,15 @@ jobs:
       - name: Setup Ruby
         uses: ruby/setup-ruby@55283cc23133118229fd3f97f9336ee23a179fcf # v1.146.0
         with:
-          ruby-version: '2.7.6' # Not needed with a .ruby-version file
+          ruby-version: '2.7.2' # Not needed with a .ruby-version file
           bundler: '2.4.10'
           bundler-cache: false # runs 'bundle install' and caches installed gems automatically
           cache-version: 3 # Increment this number if you need to re-download cached gems
       - name: Setup Pages
         id: pages
         uses: actions/configure-pages@v3
       - name:  Update RubyGems and Co
-        run: gem update --system
+        run: gem update
       - name: Install Ruby Bundles
         run: bundle install
       - name: Build with Jekyll

.github/workflows/deploy.yaml

@@ -2,8 +2,8 @@ name: Deploy Jekyll site to Pages
 
 on:
   # Runs on pushes targeting the default branch
-  push:
-    branches: ["main"]
+  # push:
+  #   branches: ["main"]
 
   # Allows you to run this workflow manually from the Actions tab
   workflow_dispatch:
@@ -40,7 +40,7 @@ jobs:
         id: pages
         uses: actions/configure-pages@v3
       - name:  Update RubyGems and Co
-        run: gem update --system
+        run: gem update
       - name: Install Ruby Bundles
         run: bundle install
       - name: Build with Jekyll

Gemfile.lock

@@ -108,11 +108,11 @@ GEM
     tzinfo (2.0.6)
       concurrent-ruby (~> 1.0)
     unicode-display_width (2.4.2)
-    wdm (0.1.1)
     webrick (1.8.1)
 
 PLATFORMS
   arm64-darwin-21
+  arm64-darwin-23
   x64-mingw32
   x86_64-linux
 
@@ -126,7 +126,6 @@ DEPENDENCIES
   jemoji
   json (~> 1.8.6)
   nokogiri (>= 1.7.2)
-  wdm (~> 0.1.0)
   webrick (~> 1.7)
 
 BUNDLED WITH

_config.yml

@@ -234,11 +234,11 @@ compress_html:
     ignore:
         envs: development
 
-wiremock_version: 3.3.1
+wiremock_version: 3.6.0
 wiremock_baseline: 3.x
 pageEditPrefix: https://github.com/wiremock/wiremock.org/edit/main/
 
-grpc_extension_version: 0.4.0
+grpc_extension_version: 0.6.0
 
 community_slack:
   join_url: https://slack.wiremock.org/

_data/doc-categories.yml

@@ -26,7 +26,9 @@ java:
     - java-usage
     - configuration
     - running-without-http-server
+    - jetty-12
     - android
+    - pact
 
 stubbing-and-verifying:
   title: Stubbing & Verifying
@@ -40,8 +42,8 @@ stubbing-and-verifying:
     - proxying
     - verifying
 
-templating:
-  title: Templating
+library:
+  title: Mock API Template Library
   link: /docs/mock-api-templates
   pages:
     - mock-api-templates
@@ -59,6 +61,7 @@ protocols:
     - webhooks-and-callbacks
     - grpc
     - solutions/graphql
+    - jwt
     - https
 
 configuration:

_docs/configuration.md

@@ -5,6 +5,8 @@ meta_title: Configuring WireMock in Java | WireMock
 description: Configuring WireMock progammatically in Java.
 ---
 
+<div class="cloud-callout"><a href="https://www.wiremock.io?utm_source=oss-docs&utm_medium=oss-docs&utm_campaign=cloud-callouts-configuration&utm_id=cloud-callouts&utm_term=cloud-callouts-configuration" target="_BLANK">Centralize and scale your API mocks with WireMock Cloud.</a></div>
+
 Both `WireMockServer` and the `WireMockRule` take a configuration builder as the parameter to their constructor e.g.
 
 ```java
@@ -98,6 +100,20 @@ WireMock uses the trust store for three purposes:
 3. As a proxy, WireMock will trust a target server if it presents a public
    certificate in this trust store
 
+
+## HTTP/2 configuration
+
+HTTP/2 can be disabled separately for plain text (HTTP) and TLS (HTTPS):
+
+```java
+// Disable HTTP/2 over HTTP
+.http2PlainDisabled(true);
+
+// Disable HTTP/2 over HTTPS
+.http2TlsDisabled(true);
+```
+
+
 ## Proxy settings
 
 ```java
@@ -130,6 +146,11 @@ WireMock uses the trust store for three purposes:
 
 // The type of the CA key store
 .caKeystoreType("JKS")
+
+// Which proxy encodings to proxy through to the target if the request contains an Accept-Encoding header
+// By default this is null, which means the header is sent to the target unchanged
+// If there is an Accept-Encoding header on the request, and it does not contain any of the supported proxy encodings, the header is not sent to the target.
+.withSupportedProxyEncodings("gzip", "deflate")
 ```
 
 ## File locations

_docs/download-and-installation.md

@@ -4,17 +4,18 @@ title: Download and Installation
 meta_title: "How to Download and Install WireMock"
 toc_rank: 13
 description: >
-    WireMock is available as a standalone service (for Docker of Java), Java library
-    and integrations for modern languages and technology stacks.
-redirect_from: 
-    - "/download.html"
-    - "/download/"
-    - "/downloads.html"
-    - "/downloads/"
-    - "/docs/download.html"
-    - "/docs/download/"
+  WireMock is available as a standalone service (for Docker of Java), Java library
+  and integrations for modern languages and technology stacks.
+redirect_from:
+  - "/download.html"
+  - "/download/"
+  - "/downloads.html"
+  - "/downloads/"
+  - "/docs/download.html"
+  - "/docs/download/"
 ---
 
+<div class="cloud-callout"><a href="https://www.wiremock.io?utm_source=oss-docs&utm_medium=oss-docs&utm_campaign=cloud-callouts-install&utm_id=cloud-callouts&utm_term=cloud-callouts-install" target="_BLANK">To create publicly hosted mock APIs without anything to install, learn more about WireMock Cloud.</a></div>
 
 ## Download options
 
@@ -58,7 +59,7 @@ docker run -it --rm -p 8080:8080 --name wiremock \
 
 {% endcodetab %}
 
-{% codetab Gradle Groovy %}
+{% codetab Gradle %}
 
 ```groovy
 testImplementation "org.wiremock:wiremock-standalone:{{ site.wiremock_version }}"

_docs/extending-wiremock.md

@@ -7,6 +7,8 @@ redirect_from: "/extending-wiremock.html"
 description: You can register the extension programmatically via its class name, class or an instance
 ---
 
+<div class="cloud-callout"><a href="https://www.wiremock.io?utm_source=oss-docs&utm_medium=oss-docs&utm_campaign=cloud-callouts-extending&utm_id=cloud-callouts&utm_term=cloud-callouts-extending" target="_BLANK">Chaos testing, RBAC, dynamic state and more with WireMock Cloud.</a></div>
+
 WireMock can be customised via a variety of extension points.
 
 Each extension point is defined by an interface that extends from `Extension` and extension implementations are loaded at startup time.
@@ -26,6 +28,10 @@ At present, the following extension interfaces are available:
 
 The interfaces in this list ending with `V2` supercede deprecated equivalents with an older, more restrictive interface. Additionally `ServeEventListener` deprecates `PostServeAction`.
 
+As of WireMock version `3.6.0`, the `Extension` interface has two new lifecycle methods called `start()` and `stop()`. 
+The `start()` method is called on each extension when the WireMock server first starts (just before the stub mappings 
+are loaded) and the `stop()` method is called when the server is stopped. This allows extensions to perform any
+initialisation or cleanup tasks.
 
 ## Registering Extensions
 

_docs/extensibility/adding-template-model-data.md

@@ -5,7 +5,7 @@ meta_title: Adding Template Model Data
 description: Adding extra elements to the template model during request processing
 ---
 
-Extensions that implement the `TemplateHelperProviderExtension` interface provide additional Handlebars helpers to the templating system:
+Extensions that implement the `TemplateModelDataProviderExtension` interface provide additional model elements to the templating system:
 
 ```java
 new WireMockServer(.extensions(

_docs/extensibility/filtering-requests.md

@@ -5,6 +5,8 @@ meta_title: Filtering and Modifying Requests
 description: Filtering and modifying requests via extensions
 ---
 
+<div class="cloud-callout"><a href="https://www.wiremock.io?utm_source=oss-docs&utm_medium=oss-docs&utm_campaign=cloud-callouts-filtering&utm_id=cloud-callouts&utm_term=cloud-callouts-filtering" target="_BLANK">If you need to protect your mock APIs with Enterprise-grade security options, learn about WireMock Cloud.</a></div>
+
 Requests to both stubs and the admin API can be intercepted and either modified or halted with an immediate response.
 This supports a number of use cases including: authentication, URL rewriting and request header injection.
 

_docs/getting-started.md

@@ -18,6 +18,7 @@ At the moment, we provide the following quick starts for beginners:
 
 - [API Mocking with Java and JUnit 4](../quickstart/java-junit)
 - [Downloading and Installing WireMock](../download-and-installation)
+- [Using WireMock with Jetty 12](../jetty-12)
 
 <!-- TODO: Add standalone in Docker -->
 

_docs/grpc.md

@@ -32,7 +32,7 @@ Add the extension JAR dependency to your project:
 Gradle:
 
 ```gradle
-implementation 'org.wiremock:wiremock-grpc-extension:{{ site.grpc_extension_version }}'
+testImplementation 'org.wiremock:wiremock-grpc-extension:{{ site.grpc_extension_version }}'
 ```
 
 Maven:
@@ -42,6 +42,7 @@ Maven:
     <groupId>org.wiremock</groupId>
     <artifactId>wiremock-grpc-extension</artifactId>
     <version>{{ site.grpc_extension_version }}</version>
+    <scope>test</scope>
 </dependency>
 ```
 
@@ -174,4 +175,4 @@ gRPC stubs are defined using WireMock's standard JSON format. Requests should al
 
 ## More Demos
 
-For more see the [standalone demo project](https://github.com/wiremock/wiremock-grpc-demos/tree/main/standalone).
+For more see the [standalone demo project](https://github.com/wiremock/wiremock-grpc-demos/tree/main/standalone).

_docs/https.md

@@ -1,7 +1,7 @@
 ---
 layout: docs
-title: Serving HTTPs
-meta_title: Using WireMock with HTTPs using self-signed or custom certificates | WireMock
+title: Serving HTTPS
+meta_title: Using WireMock with HTTPS using self-signed or custom certificates | WireMock
 redirect_from: "/https.html"
 description: WireMock can optionally accept requests over HTTPS. By default it will serve its own self-signed TLS certificate.
 ---
@@ -76,4 +76,4 @@ HTTP port with a client that's expecting HTTPS (i.e. has `https://` in the URL).
 `org.apache.hc.core5.http.NoHttpResponseException: The target server failed to respond`: Could mean you've tried to connect to the HTTPS port with a
 client expecting HTTP.
 
-`javax.net.ssl.SSLHandshakeException: sun.security.validator.ValidatorException: PKIX path building failed: sun.security.provider.certpath.SunCertPathBuilderException: unable to find valid certification path to requested target`: You are using WireMock's default (self-signed) TLS certificate or another certificate that isn't signed by a CA. In this case you need to specifically configure your HTTP client to trust the certificate being presented, or to trust all certificates. Here is an example of [how to do this with the Apache HTTP client](https://github.com/tomakehurst/wiremock/blob/{{ site.wiremock_version }}/src/main/java/com/github/tomakehurst/wiremock/http/HttpClientFactory.java).
+`javax.net.ssl.SSLHandshakeException: sun.security.validator.ValidatorException: PKIX path building failed: sun.security.provider.certpath.SunCertPathBuilderException: unable to find valid certification path to requested target`: You are using WireMock's default (self-signed) TLS certificate or another certificate that isn't signed by a CA. In this case you need to specifically configure your HTTP client to trust the certificate being presented, or to trust all certificates. Here is an example of [how to do this with the Apache HTTP client](https://github.com/wiremock/wiremock/blob/3.4.2/src/main/java/com/github/tomakehurst/wiremock/http/HttpClientFactory.java#L207).

_docs/jetty-12.md

@@ -0,0 +1,62 @@
+---
+layout: docs
+title: "Using WireMock with Jetty 12"
+meta_title: Using WireMock with Jetty 12 | WireMock
+description: WireMock ships with Jetty 11 by default but fully supports Jetty 12 as well.
+---
+
+WireMock ships with Jetty 11 by default but fully supports Jetty 12 as well with a new module `wiremock-jetty12`. In this tutorial we are going to see how Wiremock could be configured to use Jetty 12.
+
+## Prerequisites
+
+- Java 17
+- Maven or Gradle, recent versions
+- A Java project, based on Maven or Gradle
+
+## Add WireMock Dependency to your project
+
+{% codetabs %}
+
+{% codetab Maven %}
+
+```xml
+<dependency>
+    <groupId>org.wiremock</groupId>
+    <artifactId>wiremock-jetty12</artifactId>
+    <version>{{ site.wiremock_version }}</version>
+    <scope>test</scope>
+</dependency>
+```
+
+{% endcodetab %}
+
+{% codetab Gradle %}
+
+```groovy
+testImplementation "org.wiremock:wiremock-jetty12:{{ site.wiremock_version }}"
+```
+
+{% endcodetab %}
+
+{% endcodetabs %}
+
+## Limitations
+
+There are few limitations that usage of Jetty 12 is imposing with respect to stubbing behavior.
+
+- status message will not be returned to the client even if set by the stub explicitly
+    ```java
+        stubFor(get("/my/resource")
+            .willReturn(status(400)
+                .withStatusMessage("ERROR")));
+
+        URI uri = URI.create(wireMockRule.url("/my/resource"));
+        HttpURLConnection connection = (HttpURLConnection) uri.toURL ().openConnection ();
+        connection.setRequestMethod ("GET");
+
+        assertThat(connection.getResponseCode()).isEqualTo(400);
+        assertThat(connection.getResponseMessage()).isEqualTo("Bad Request"); /* the status message is not returned */
+    ```
+- when using multipart form data, the body is not decoded into plain text in case of `base64` (or other encodings) 
+
+- serving files from configured file locations always ends up with redirect when folder (without trailing `/`) is requested

_docs/junit-jupiter.md

@@ -79,6 +79,18 @@ public class HttpsFixedPortDeclarativeWireMockTest {
 }
 ```
 
+### Enabling Extension Scanning
+
+When [extending WireMock via service loading](extending-wiremock.md#extension-registration-via-service-loading), it may
+be helpful to have WireMock scan for extensions automatically via the `extensionScanningEnabled` parameter.
+
+```java
+@WireMockTest(extensionScanningEnabled = true)
+public class ExtensionScanningDeclarativeWireMockTest {
+    ...
+}
+```
+
 ## Advanced usage - programmatic
 
 Invoking the extension programmatically with `@RegisterExtension` allows you to run any number of WireMock instances and provides full control

_docs/jwt.md

@@ -0,0 +1,10 @@
+---
+layout: docs
+title: JSON Web Tokens (JWT)
+meta_title: JSON Web Tokens
+description: Generating JWTs and JWKSs
+---
+
+The JWT extension provides support for generating JWTs and corresponding JSON Web Key Sets (JWKS) in stub responses via response templating.
+
+For details see [the project's README](https://github.com/wiremock/wiremock-jwt-extension/blob/main/README.md).