Quarkus makes it very easy these days to develop robust and clean applications. But how about testing?<\/p>\n
In this tutorial, we’ll take a close look at how a Quarkus application can be tested<\/strong>. We’ll explore the testing possibilities offered by Quarkus and present concepts like dependency management and injection, mocking, profile configuration, and more specific things like Quarkus annotations and testing a native executable<\/strong>.<\/p>\n Let’s start from the basic Quarkus project configured in our previous Guide to QuarkusIO<\/a>.<\/p>\n First, we’ll add the quarkus-reasteasy-jackson<\/a>, quarkus-hibernate-orm-panache<\/a>, quarkus-jdbc-h2<\/a>, quarkus-junit5-mockito<\/a>, and quarkus-test-h2<\/a> Maven dependencies:<\/p>\n Next, let’s create our domain entity:<\/p>\n We continue by adding a simple Panache repository, with a method to search for books:<\/p>\n Now, let’s write a LibraryService <\/em>to hold any business logic:<\/p>\n And finally, let’s expose our service functionality through HTTP by creating a LibraryResource<\/em>:<\/p>\n Before writing any tests, let’s make sure we have some books in our repository. With Quarkus, we can use the CDI @Alternative<\/em> mechanism to provide a custom bean implementation for our tests<\/strong>. Let’s create a TestBookRepository<\/em> that extends BookRepository<\/em>:<\/p>\n We place this alternative bean in our test<\/em> package, and because of the @Priority(1)<\/em> and @Alternative<\/em> annotations, we’re sure any test will pick it up over the actual BookRepository<\/em> implementation. This is one way we can provide a global mock that all our Quarkus tests<\/strong> can use. We’ll explore more narrow-focused mocks shortly, but now, let’s move on to creating our first test.<\/p>\n Let’s begin by creating a simple REST-assured integration test:<\/p>\n This test, annotated with @QuarkusTest,<\/em> first starts the Quarkus application<\/strong> and then performs a series of HTTP requests against our resource’s endpoint.<\/p>\n Now, let’s make use of some Quarkus mechanisms to try and further improve our test.<\/p>\n Instead of hard-coding the path of our HTTP endpoint, let’s inject the resource URL:<\/p>\n And then, let’s use it in our requests:<\/p>\n Or, without using Rest-assured, let’s simply open a connection to the injected URL and test the response:<\/p>\n As we can see, @TestHTTPResource <\/em>URL injection gives us an easy and flexible way of accessing our endpoint.<\/p>\n Let’s take this further and configure our endpoint using the Quarkus provided @TestHTTPEndpoint<\/em> annotation:<\/p>\n This way, if we ever decide to change the path of the LibraryResource<\/em>, the test will pick up the correct path without us having to touch it.<\/p>\n @TestHTTPEndpoint <\/em>can also be applied at the class level, in which case REST-assured will automatically prefix all requests with the Path<\/em><\/strong> of the LibraryResource<\/em>:<\/p>\n When it comes to dependency injection, in Quarkus tests, we can use @Inject<\/em> for any required dependency<\/strong>. Let’s see this in action by creating a test for our LibraryService<\/em>:<\/p>\n Now, let’s try to test our Panache BookRepository<\/em>:<\/p>\n But when we run our test, it fails. That’s because it requires running within the context of a transaction<\/strong> and there is none active. This can be fixed simply by adding @Transactional<\/em> to the test class. Or, if we prefer, we can define our own stereotype to bundle both @QuarkusTest<\/em> and @Transactional. <\/em>Let’s do this by creating the @QuarkusTransactionalTest<\/em> annotation:<\/p>\n Now, let’s apply it to our test:<\/p>\n As we can see, because Quarkus tests are full CDI beans<\/strong>, we can take advantage of all the CDI benefits like dependency injection, transactional contexts, and CDI interceptors.<\/p>\n Mocking is a critical aspect of any testing effort. As we’ve already seen above, Quarkus tests can make use of the CDI @Alternative<\/em> mechanism. Let’s now dive deeper into the mocking capabilities Quarkus has to offer.<\/p>\n As a slight simplification of the @Alternative<\/em> approach<\/strong>, we can use the @Mock<\/em> stereotype annotation. This bundles together the @Alternative<\/em> and @Primary(1)<\/em> annotations.<\/p>\n If we don’t want to have a globally defined mock, but would rather have our mock only within the scope of one test<\/strong>, we can use @QuarkusMock<\/em>:<\/p>\n Let’s simplify things a bit and use the Quarkus @InjectMock <\/em>annotation instead of @QuarkusMock<\/em><\/strong>:<\/p>\n If we’re only interested in spying and not replacing bean behavior, we can use the provided @InjectSpy<\/em> annotation:<\/p>\n We might want to run our tests in different configurations<\/strong>. For this, Quarkus offers the concept of a test profile<\/strong>. Let’s create a test that runs against a different database engine using a customized version of our BookRepository<\/em>, and that will also expose our HTTP resources at a different path from the one already configured.<\/p>\n For this, we start by implementing a QuarkusTestProfile<\/em>:<\/p>\n Let’s now configure our application.properties<\/em> by adding a custom-profile<\/em> config property that will change our H2 storage from memory to file:<\/p>\n Finally, with all the resources and configuration in place, let’s write our test:<\/p>\n As we can see from the @TestProfile<\/em> annotation, this test will use the CustomTestProfile<\/em>. <\/em>It will make HTTP requests to the custom endpoint overridden in the profile’s getConfigOverrides<\/em> method. Moreover, it will use the alternative book repository implementation configured in the getEnabledAlternatives<\/em> method. And finally, by using the custom-profile <\/em>defined in getConfigProfile<\/em>, it will persist data in a file rather than memory.<\/p>\n One thing to note is that Quarkus will shut down and then restart with the new profile before this test is executed<\/strong>. This adds some time as the shutdown\/restart happens, but it’s the price to be paid for the extra flexibility.<\/p>\n Quarkus offers the possibility to test native executables. Let’s create a native image test:<\/p>\n And now, by running:<\/p>\n We’ll see the native image being built and the tests running against it.<\/p>\n The @NativeImageTest <\/em>annotation instructs Quarkus to run this test against the native image, while the @QuarkusTestResource <\/em>will start an H2 instance into a separate process before the test begins. The latter is needed for running tests against native executables as the database engine is not embedded into the native image.<\/p>\n The @QuarkusTestResource<\/em> annotation can also be used to start custom services, like Testcontainers, for example. All we need to do is implement the QuarkusTestResourceLifecycleManager<\/em> interface and annotate our test with:<\/p>\n You will need a GraalVM for building the native image<\/a>.<\/p>\n Also, take notice that, at the moment, injection does not work with native image testing. The only thing that runs natively is the Quarkus application, not the test itself<\/strong>.<\/p>\n In this article, we saw how Quarkus offers excellent support for testing<\/strong> our application. From simple things like dependency management, injection, and mocking, to more complex aspects like configuration profiles and native images, Quarkus provides us with many tools to create powerful and clean tests.<\/p>\n As always, the complete code is available over on GitHub<\/a>.<\/p>\n The post Testing Quarkus Applications<\/a> first appeared on Baeldung<\/a>.<\/p>\n Learn how to write clean and powerful unit and integration tests for Quarkus applications.<\/p>\n The post Testing Quarkus Applications<\/a> first appeared on Baeldung<\/a>.<\/p>\n2. Setup<\/h2>\n
<dependency>\r\n <groupId>io.quarkus<\/groupId>\r\n <artifactId>quarkus-resteasy-jackson<\/artifactId>\r\n<\/dependency>\r\n<dependency>\r\n <groupId>io.quarkus<\/groupId>\r\n <artifactId>quarkus-hibernate-orm-panache<\/artifactId>\r\n<\/dependency>\r\n<dependency>\r\n <groupId>io.quarkus<\/groupId>\r\n <artifactId>quarkus-jdbc-h2<\/artifactId>\r\n<\/dependency>\r\n<dependency>\r\n <groupId>io.quarkus<\/groupId>\r\n <artifactId>quarkus-junit5-mockito<\/artifactId>\r\n<\/dependency>\r\n<dependency>\r\n <groupId>io.quarkus<\/groupId>\r\n <artifactId>quarkus-test-h2<\/artifactId>\r\n<\/dependency><\/code><\/pre>\npublic class Book extends PanacheEntity {\r\n private String title;\r\n private String author;\r\n}<\/code><\/pre>\npublic class BookRepository implements PanacheRepository {\r\n public Stream<Book> findBy(String query) {\r\n return find(\"author like :query or title like :query\", with(\"query\", \"%\"+query+\"%\")).stream();\r\n }\r\n}<\/code><\/pre>\npublic class LibraryService {\r\n public Set<Book> find(String query) {\r\n if (query == null) {\r\n return bookRepository.findAll().stream().collect(toSet());\r\n }\r\n return bookRepository.findBy(query).collect(toSet());\r\n }\r\n}<\/code><\/pre>\n@Path(\"\/library\")\r\npublic class LibraryResource {\r\n @GET\r\n @Path(\"\/book\")\r\n public Set findBooks(@QueryParam(\"query\") String query) {\r\n return libraryService.find(query);\r\n }\r\n}<\/code><\/pre>\n3. @Alternative<\/em> Implementations<\/h2>\n
@Priority(1)\r\n@Alternative\r\n@ApplicationScoped\r\npublic class TestBookRepository extends BookRepository {\r\n @PostConstruct\r\n public void init() {\r\n persist(new Book(\"Dune\", \"Frank Herbert\"),\r\n new Book(\"Foundation\", \"Isaac Asimov\"));\r\n }\r\n}<\/code><\/pre>\n4. HTTP Integration Test<\/h2>\n
@QuarkusTest\r\nclass LibraryResourceIntegrationTest {\r\n @Test\r\n void whenGetBooksByTitle_thenBookShouldBeFound() {\r\n given().contentType(ContentType.JSON).param(\"query\", \"Dune\")\r\n .when().get(\"\/library\/book\")\r\n .then().statusCode(200)\r\n .body(\"size()\", is(1))\r\n .body(\"title\", hasItem(\"Dune\"))\r\n .body(\"author\", hasItem(\"Frank Herbert\"));\r\n }\r\n}<\/code><\/pre>\n4.1. URL Injection With @TestHTTPResource<\/em><\/h3>\n
@TestHTTPResource(\"\/library\/book\")\r\nURL libraryEndpoint;<\/code><\/pre>\ngiven().param(\"query\", \"Dune\")\r\n .when().get(libraryEndpoint)\r\n .then().statusCode(200);<\/code><\/pre>\n@Test\r\nvoid whenGetBooks_thenBooksShouldBeFound() throws IOException {\r\n assertTrue(IOUtils.toString(libraryEndpoint.openStream(), defaultCharset()).contains(\"Asimov\"));\r\n}<\/code><\/pre>\n4.2. @TestHTTPEndpoint<\/em><\/h3>\n
@TestHTTPEndpoint(LibraryResource.class)\r\n@TestHTTPResource(\"book\")\r\nURL libraryEndpoint;<\/code><\/pre>\n@QuarkusTest\r\n@TestHTTPEndpoint(LibraryResource.class)\r\nclass LibraryHttpEndpointIntegrationTest {\r\n @Test\r\n void whenGetBooks_thenShouldReturnSuccessfully() {\r\n given().contentType(ContentType.JSON)\r\n .when().get(\"book\")\r\n .then().statusCode(200);\r\n }\r\n}<\/code><\/pre>\n5. Context and Dependency Injection<\/h2>\n
@QuarkusTest\r\nclass LibraryServiceIntegrationTest {\r\n @Inject\r\n LibraryService libraryService;\r\n @Test\r\n void whenFindByAuthor_thenBookShouldBeFound() {\r\n assertFalse(libraryService.find(\"Frank Herbert\").isEmpty());\r\n }\r\n}<\/code><\/pre>\nclass BookRepositoryIntegrationTest {\r\n @Inject\r\n BookRepository bookRepository;\r\n @Test\r\n void givenBookInRepository_whenFindByAuthor_thenShouldReturnBookFromRepository() {\r\n assertTrue(bookRepository.findBy(\"Herbert\").findAny().isPresent());\r\n }\r\n}<\/code><\/pre>\n@QuarkusTest\r\n@Stereotype\r\n@Transactional\r\n@Target(ElementType.TYPE)\r\n@Retention(RetentionPolicy.RUNTIME)\r\npublic @interface QuarkusTransactionalTest {\r\n}<\/code><\/pre>\n@QuarkusTransactionalTest\r\nclass BookRepositoryIntegrationTest<\/code><\/pre>\n6. Mocking<\/h2>\n
6.1. @Mock<\/em><\/h3>\n
6.2. @QuarkusMock<\/em><\/h3>\n
@QuarkusTest\r\nclass LibraryServiceQuarkusMockUnitTest {\r\n @Inject\r\n LibraryService libraryService;\r\n @BeforeEach\r\n void setUp() {\r\n BookRepository mock = Mockito.mock(TestBookRepository.class);\r\n Mockito.when(mock.findBy(\"Asimov\"))\r\n .thenReturn(Arrays.stream(new Book[] {\r\n new Book(\"Foundation\", \"Isaac Asimov\"),\r\n new Book(\"I Robot\", \"Isaac Asimov\")}));\r\n QuarkusMock.installMockForType(mock, BookRepository.class);\r\n }\r\n @Test\r\n void whenFindByAuthor_thenBooksShouldBeFound() {\r\n assertEquals(2, libraryService.find(\"Asimov\").size());\r\n }\r\n}<\/code><\/pre>\n6.3. @InjectMock<\/em><\/h3>\n
@QuarkusTest\r\nclass LibraryServiceInjectMockUnitTest {\r\n @Inject\r\n LibraryService libraryService;\r\n @InjectMock\r\n BookRepository bookRepository;\r\n @BeforeEach\r\n void setUp() {\r\n when(bookRepository.findBy(\"Frank Herbert\"))\r\n .thenReturn(Arrays.stream(new Book[] {\r\n new Book(\"Dune\", \"Frank Herbert\"),\r\n new Book(\"Children of Dune\", \"Frank Herbert\")}));\r\n }\r\n @Test\r\n void whenFindByAuthor_thenBooksShouldBeFound() {\r\n assertEquals(2, libraryService.find(\"Frank Herbert\").size());\r\n }\r\n}<\/code><\/pre>\n6.4. @InjectSpy<\/em><\/h3>\n
@QuarkusTest\r\nclass LibraryResourceInjectSpyIntegrationTest {\r\n @InjectSpy\r\n LibraryService libraryService;\r\n @Test\r\n void whenGetBooksByAuthor_thenBookShouldBeFound() {\r\n given().contentType(ContentType.JSON).param(\"query\", \"Asimov\")\r\n .when().get(\"\/library\/book\")\r\n .then().statusCode(200);\r\n verify(libraryService).find(\"Asimov\");\r\n }\r\n}<\/code><\/pre>\n7. Test Profiles<\/h2>\n
public class CustomTestProfile implements QuarkusTestProfile {\r\n @Override\r\n public Map<String, String> getConfigOverrides() {\r\n return Collections.singletonMap(\"quarkus.resteasy.path\", \"\/custom\");\r\n }\r\n @Override\r\n public Set<Class<?>> getEnabledAlternatives() {\r\n return Collections.singleton(TestBookRepository.class);\r\n }\r\n @Override\r\n public String getConfigProfile() {\r\n return \"custom-profile\";\r\n }\r\n}<\/code><\/pre>\n%custom-profile.quarkus.datasource.jdbc.url = jdbc:h2:file:.\/testdb<\/code><\/code><\/pre>\n@QuarkusTest\r\n@TestProfile(CustomBookRepositoryProfile.class)\r\nclass CustomLibraryResourceManualTest {\r\n public static final String BOOKSTORE_ENDPOINT = \"\/custom\/library\/book\";\r\n @Test\r\n void whenGetBooksGivenNoQuery_thenAllBooksShouldBeReturned() {\r\n given().contentType(ContentType.JSON)\r\n .when().get(BOOKSTORE_ENDPOINT)\r\n .then().statusCode(200)\r\n .body(\"size()\", is(2))\r\n .body(\"title\", hasItems(\"Foundation\", \"Dune\"));\r\n }\r\n}<\/code><\/pre>\n8. Testing Native Executables<\/h2>\n
@NativeImageTest\r\n@QuarkusTestResource(H2DatabaseTestResource.class)\r\nclass NativeLibraryResourceIT extends LibraryHttpEndpointIntegrationTest {\r\n}<\/code><\/pre>\nmvn verify -Pnative<\/code><\/pre>\n@QuarkusTestResource(OurCustomResourceImpl.class)<\/code><\/pre>\n9. Conclusion<\/h2>\n
<\/p>\n
![](\"https:\/\/assets.feedblitz.com\/i\/fblike20.png\")
<\/a> ![](\"https:\/\/assets.feedblitz.com\/i\/googleplus20.png\")
<\/a> ![](\"https:\/\/assets.feedblitz.com\/i\/pinterest20.png\")
<\/a> ![](\"https:\/\/assets.feedblitz.com\/i\/twitter20.png\")
<\/a> ![](\"https:\/\/assets.feedblitz.com\/i\/email20.png\")
<\/a> ![](\"https:\/\/assets.feedblitz.com\/i\/rss20.png\")
<\/a> ![](\"https:\/\/assets.feedblitz.com\/i\/comments20.png\")
<\/a> ![](\"https:\/\/assets.feedblitz.com\/i\/commentsrss20.png\")
<\/a> <\/div>\n\n![\\\"IT\u96fb\u8166\u88dc\u7fd2](\\\"http:\/\/itteacheritfreelance.hk\/test\/wordpress\/wp-content\/uploads\/2016\/05\/logo2-2.png\\\"){kind=logo}
\r\nwww.itsec.hk<\/a>
\r\nwww.itsec.vip<\/a>
\r\nwww.itseceu.uk<\/a>
<\/p>","protected":false},"excerpt":{"rendered":"<\/a> <\/a> <\/a> <\/a> <\/a> <\/a> <\/a> <\/a> <\/div>\n<\/div>","protected":false},"author":214,"featured_media":0,"comment_status":"open","ping_status":"closed","sticky":false,"template":"","format":"standard","meta":{"slim_seo":{"title":"Testing Quarkus Applications - ITTeacherITFreelance.hk","description":"Learn how to write clean and powerful unit and integration tests for Quarkus applications. The post Testing Quarkus Applications first appeared on Baeldung . &n"},"footnotes":""},"categories":[6],"tags":[],"_links":{"self":[{"href":"https:\/\/itteacheritfreelance.hk\/wordpress\/index.php\/wp-json\/wp\/v2\/posts\/64355"}],"collection":[{"href":"https:\/\/itteacheritfreelance.hk\/wordpress\/index.php\/wp-json\/wp\/v2\/posts"}],"about":[{"href":"https:\/\/itteacheritfreelance.hk\/wordpress\/index.php\/wp-json\/wp\/v2\/types\/post"}],"author":[{"embeddable":true,"href":"https:\/\/itteacheritfreelance.hk\/wordpress\/index.php\/wp-json\/wp\/v2\/users\/214"}],"replies":[{"embeddable":true,"href":"https:\/\/itteacheritfreelance.hk\/wordpress\/index.php\/wp-json\/wp\/v2\/comments?post=64355"}],"version-history":[{"count":8,"href":"https:\/\/itteacheritfreelance.hk\/wordpress\/index.php\/wp-json\/wp\/v2\/posts\/64355\/revisions"}],"predecessor-version":[{"id":68254,"href":"https:\/\/itteacheritfreelance.hk\/wordpress\/index.php\/wp-json\/wp\/v2\/posts\/64355\/revisions\/68254"}],"wp:attachment":[{"href":"https:\/\/itteacheritfreelance.hk\/wordpress\/index.php\/wp-json\/wp\/v2\/media?parent=64355"}],"wp:term":[{"taxonomy":"category","embeddable":true,"href":"https:\/\/itteacheritfreelance.hk\/wordpress\/index.php\/wp-json\/wp\/v2\/categories?post=64355"},{"taxonomy":"post_tag","embeddable":true,"href":"https:\/\/itteacheritfreelance.hk\/wordpress\/index.php\/wp-json\/wp\/v2\/tags?post=64355"}],"curies":[{"name":"wp","href":"https:\/\/api.w.org\/{rel}","templated":true}]}}