Sync documentation of main branch

actions-user · actions-user · commit 82529d2b06e8 · 2025-10-03T02:00:15.000Z
diff --git a/_generated-doc/main/config/quarkus-all-config.adoc b/_generated-doc/main/config/quarkus-all-config.adoc
@@ -13875,7 +13875,7 @@ Environment variable: `+++QUARKUS_KEYCLOAK_DEVSERVICES_IMAGE_NAME+++`
 endif::add-copy-button-to-env-var[]
 --
 |string
-|`+++quay.io/keycloak/keycloak:26.3.4+++`
+|`+++quay.io/keycloak/keycloak:26.4.0+++`
 
 a|icon:lock[title=Fixed at build time] [[quarkus-devservices-keycloak_quarkus-keycloak-devservices-keycloak-x-image]] [.property-path]##link:#quarkus-devservices-keycloak_quarkus-keycloak-devservices-keycloak-x-image[`quarkus.keycloak.devservices.keycloak-x-image`]##
 ifdef::add-copy-button-to-config-props[]
diff --git a/_generated-doc/main/config/quarkus-devservices-keycloak.adoc b/_generated-doc/main/config/quarkus-devservices-keycloak.adoc
@@ -47,7 +47,7 @@ Environment variable: `+++QUARKUS_KEYCLOAK_DEVSERVICES_IMAGE_NAME+++`
 endif::add-copy-button-to-env-var[]
 --
 |string
-|`+++quay.io/keycloak/keycloak:26.3.4+++`
+|`+++quay.io/keycloak/keycloak:26.4.0+++`
 
 a|icon:lock[title=Fixed at build time] [[quarkus-devservices-keycloak_quarkus-keycloak-devservices-keycloak-x-image]] [.property-path]##link:#quarkus-devservices-keycloak_quarkus-keycloak-devservices-keycloak-x-image[`quarkus.keycloak.devservices.keycloak-x-image`]##
 ifdef::add-copy-button-to-config-props[]
diff --git a/_generated-doc/main/config/quarkus-devservices-keycloak_quarkus.keycloak.adoc b/_generated-doc/main/config/quarkus-devservices-keycloak_quarkus.keycloak.adoc
@@ -47,7 +47,7 @@ Environment variable: `+++QUARKUS_KEYCLOAK_DEVSERVICES_IMAGE_NAME+++`
 endif::add-copy-button-to-env-var[]
 --
 |string
-|`+++quay.io/keycloak/keycloak:26.3.4+++`
+|`+++quay.io/keycloak/keycloak:26.4.0+++`
 
 a|icon:lock[title=Fixed at build time] [[quarkus-devservices-keycloak_quarkus-keycloak-devservices-keycloak-x-image]] [.property-path]##link:#quarkus-devservices-keycloak_quarkus-keycloak-devservices-keycloak-x-image[`quarkus.keycloak.devservices.keycloak-x-image`]##
 ifdef::add-copy-button-to-config-props[]
diff --git a/_versions/main/guides/_attributes.adoc b/_versions/main/guides/_attributes.adoc
@@ -18,7 +18,7 @@
 :infinispan-protostream-version: ${infinispan.protostream.version}
 :logstash-image: docker.io/elastic/logstash:9.1.4
 :kibana-image: docker.io/elastic/kibana:9.1.4
-:keycloak-docker-image: quay.io/keycloak/keycloak:26.3.4
+:keycloak-docker-image: quay.io/keycloak/keycloak:26.4.0
 :jandex-version: 3.5.0
 :jandex-gradle-plugin-version: 1.0.0
 :kotlin-version: 2.2.20
diff --git a/_versions/main/guides/hibernate-orm-panache.adoc b/_versions/main/guides/hibernate-orm-panache.adoc
@@ -1164,6 +1164,7 @@ public class PersonRepository implements PanacheRepositoryBase<Person,Integer> {
 
 == Mocking
 
+[[mocking_active_record]]
 === Using the active record pattern
 
 If you are using the active record pattern you cannot use Mockito directly as it does not support mocking static methods,
diff --git a/_versions/main/guides/security-keycloak-authorization.adoc b/_versions/main/guides/security-keycloak-authorization.adoc
@@ -319,7 +319,7 @@ docker run --name keycloak \
   quay.io/keycloak/keycloak:{keycloak.version} \ <1>
   start --hostname-strict=false --https-key-store-file=/etc/keycloak-keystore.jks <2>
 ----
-<1> For `keycloak.version`, ensure the version is `26.3.4` or later.
+<1> For `keycloak.version`, ensure the version is `26.4.0` or later.
 <2> For Keycloak keystore, use the `keycloak-keystore.jks` file located at https://github.com/quarkusio/quarkus-quickstarts/blob/main/security-keycloak-authorization-quickstart/config/keycloak-keystore.jks[quarkus-quickstarts/security-keycloak-authorization-quickstart/config].
 
 .Accessing the Keycloak server
diff --git a/_versions/main/guides/security-oidc-bearer-token-authentication-tutorial.adoc b/_versions/main/guides/security-oidc-bearer-token-authentication-tutorial.adoc
@@ -217,7 +217,7 @@ For more information, see the <<bearer-token-tutorial-keycloak-dev-mode>> sectio
 docker run --name keycloak -e KC_BOOTSTRAP_ADMIN_USERNAME=admin -e KC_BOOTSTRAP_ADMIN_PASSWORD=admin -p 8180:8080 quay.io/keycloak/keycloak:{keycloak.version} start-dev
 ----
 ====
-* Where the `keycloak.version` is set to version `26.3.4` or later.
+* Where the `keycloak.version` is set to version `26.4.0` or later.
 . You can access your Keycloak server at http://localhost:8180[localhost:8180].
 . To access the Keycloak Administration console, log in as the `admin` user by using the following login credentials:
 
diff --git a/_versions/main/guides/security-oidc-code-flow-authentication-tutorial.adoc b/_versions/main/guides/security-oidc-code-flow-authentication-tutorial.adoc
@@ -201,7 +201,7 @@ To start a Keycloak server, use Docker and run the following command:
 docker run --name keycloak -e KC_BOOTSTRAP_ADMIN_USERNAME=admin -e KC_BOOTSTRAP_ADMIN_PASSWORD=admin -p 8180:8080 quay.io/keycloak/keycloak:{keycloak.version} start-dev
 ----
 
-where `keycloak.version` is set to `26.3.4` or later.
+where `keycloak.version` is set to `26.4.0` or later.
 
 You can access your Keycloak Server at http://localhost:8180[localhost:8180].
 
diff --git a/_versions/main/guides/security-openid-connect-client.adoc b/_versions/main/guides/security-openid-connect-client.adoc
@@ -505,7 +505,7 @@ To start a Keycloak Server, you can use Docker and just run the following comman
 docker run --name keycloak -e KC_BOOTSTRAP_ADMIN_USERNAME=admin -e KC_BOOTSTRAP_ADMIN_PASSWORD=admin -p 8180:8080 quay.io/keycloak/keycloak:{keycloak.version} start-dev
 ----
 
-Set `{keycloak.version}` to `26.3.4` or later.
+Set `{keycloak.version}` to `26.4.0` or later.
 
 You can access your Keycloak Server at http://localhost:8180[localhost:8180].
 
diff --git a/_versions/main/guides/security-openid-connect-dev-services.adoc b/_versions/main/guides/security-openid-connect-dev-services.adoc
@@ -247,7 +247,7 @@ For more information, see xref:security-oidc-bearer-token-authentication.adoc#be
 [[keycloak-initialization]]
 === Keycloak initialization
 
-The `quay.io/keycloak/keycloak:26.3.4` image which contains a Keycloak distribution powered by Quarkus is used to start a container by default.
+The `quay.io/keycloak/keycloak:26.4.0` image which contains a Keycloak distribution powered by Quarkus is used to start a container by default.
 `quarkus.keycloak.devservices.image-name` can be used to change the Keycloak image name.
 For example, set it to `quay.io/keycloak/keycloak:19.0.3-legacy` to use a Keycloak distribution powered by WildFly.
 Be aware that a Quarkus-based Keycloak distribution is only available starting from Keycloak `20.0.0`.
diff --git a/_versions/main/guides/testing-components.adoc b/_versions/main/guides/testing-components.adoc
@@ -18,7 +18,7 @@ Therefore, Quarkus provides `QuarkusComponentTestExtension` - a JUnit extension
 Unlike `@QuarkusTest` this extension does not start a full Quarkus application but merely the CDI container and the configuration service.
 You can find more details in the <<lifecycle>> section.
 
-TIP: This extension is available in the `quarkus-junit5-component` dependency.
+TIP: This JUnit extension is available in the `quarkus-junit5-component` dependency.
 
 == Basic example
 
@@ -303,6 +303,101 @@ By default, only the config properties from `application.properties` and propert
 System properties and ENV variables are _not_ included in the test config by default.
 However, you can use `@QuarkusComponentTest#useSystemConfigSources()` or `QuarkusComponentTestExtensionBuilder#useSystemConfigSources()` to configure this behavior.
 
+== Panache entities using the active record pattern
+
+If you are using the active record pattern you cannot easily leverage `Mockito#mockStatic()` to mock static methods declared on `PanacheEntityBase`.
+In a normal Quarkus app, these static methods are automatically overridden in subclasses.
+However, `QuarkusComponentTest` does not start a full Quarkus application.
+Nevertheless, you can use the `quarkus-panache-mock` module which integrates seamlessly with `QuarkusComponentTest`.
+
+Add this dependency to your `pom.xml`:
+
+[source,xml]
+----
+<dependency>
+    <groupId>io.quarkus</groupId>
+    <artifactId>quarkus-panache-mock</artifactId>
+    <scope>test</scope>
+</dependency>
+----
+
+Given this simple entity:
+
+[source,java]
+----
+@Entity
+public class Person extends PanacheEntity {
+
+   public String name;
+   
+   public Person(String name) {
+      this.name = name;
+   }
+
+   public static List<Person> findOrdered() {
+      return find("ORDER BY name").list();
+   }
+}
+----
+
+That is used in a simple bean:
+
+[source,java]
+----
+public class PersonService {
+
+   public List<Person> getPersons(boolen sorted) {
+      if (sorted) {
+         return Person.findOrdered();
+      }
+      return Person.listAll();
+   }
+}
+----
+
+You can write your component test like:
+
+.Nested test
+[source, java]
+----
+import static org.junit.jupiter.api.Assertions.assertEquals;
+
+import jakarta.inject.Inject;
+import io.quarkus.test.component.QuarkusComponentTest;
+import io.quarkus.panache.mock.MockPanacheEntities;
+import org.junit.jupiter.api.Test;
+import org.mockito.Mockito;
+
+@QuarkusComponentTest <1>
+@MockPanacheEntities(Person.class) <2>
+public class PersonServiceTest {
+
+    @Inject
+    PersonService personService; <3>
+    
+    @Test
+    public void testGetPersons() { 
+        Mockito.when(Person.listAll()).thenReturn(List.of(new Person("Tom")));
+        List<Person> list = personService.getPersons(false);
+        assertEquals(1, list.size());
+        assertEquals("Tom", list.get(0).name);
+        
+        Mockito.when(Person.findOrdered()).thenReturn(List.of(new Person("Tom")));
+        list = personService.getPersons(true);
+        assertEquals(1, list.size());
+        assertEquals("Tom", list.get(0).name);
+    }
+
+}
+----
+<1> The `QuarkusComponentTest` annotation registers the JUnit extension.
+<2> `@MockPanacheEntities` installs mocks for the given entity classes. 
+<3> The test injects the component under the test - `PersonService`.
+
+TIP: See also xref:hibernate-orm-panache.adoc#mocking_active_record[Simplified Hibernate ORM with Panache - Using the active record pattern] for more information.
+
+NOTE: Currently, only the integration with Hibernate ORM is supported. Other variants of the Panache API, such as MongoDB and Hibernate Reactive, are not supported yet.
+
 == Mocking CDI Interceptors
 
 If a tested component class declares an interceptor binding then you might need to mock the interception too.
