{"id":425,"date":"2024-06-03T22:04:33","date_gmt":"2024-06-03T21:04:33","guid":{"rendered":"https:\/\/www.xn--javaeinfacherklrt-4qb.de\/?p=425"},"modified":"2024-06-26T22:08:11","modified_gmt":"2024-06-26T21:08:11","slug":"tests-fuer-http-clients-erstellen-mit-der-wiremock-java-library","status":"publish","type":"post","link":"https:\/\/www.xn--javaeinfacherklrt-4qb.de\/?p=425","title":{"rendered":"Tests f\u00fcr HTTP-Clients erstellen mit der WireMock-Java-Library"},"content":{"rendered":"\n

In der modernen Softwareentwicklung ist das Testen ein wesentlicher Bestandteil des Entwicklungsprozesses. Tests stellen sicher, dass der Code wie erwartet funktioniert und erm\u00f6glichen eine kontinuierliche Integration und Bereitstellung. Ein h\u00e4ufiges Szenario beim Testen ist die Notwendigkeit, externe APIs zu simulieren, um die Abh\u00e4ngigkeiten zu isolieren und wiederholbare Tests durchzuf\u00fchren. Hier kommt WireMock ins Spiel.<\/p>\n\n\n\n

WireMock ist eine flexible und leistungsstarke Java-Bibliothek, die speziell entwickelt wurde, um HTTP-APIs zu simulieren. Mit WireMock k\u00f6nnen Entwickler Mock-Server erstellen, die HTTP-Anfragen entgegennehmen und vorher definierte Antworten zur\u00fcckgeben. Dies erm\u00f6glicht es, das Verhalten externer Dienste nachzubilden, ohne auf die tats\u00e4chlichen Dienste zugreifen zu m\u00fcssen.<\/p>\n\n\n\n

Installation und Einrichtung<\/h2>\n\n\n\n

Um WireMock in einem Java-Projekt zu verwenden, m\u00fcssen die entsprechenden Abh\u00e4ngigkeiten in die Projektdatei eingef\u00fcgt werden. In einem Maven-Projekt f\u00fcgen wir folgende Dependency in die pom.xml<\/code>-Datei ein:<\/p>\n\n\n

<dependency<\/span>><\/span>\n    <groupId<\/span>><\/span>com.github.tomakehurst<\/groupId<\/span>><\/span>\n    <artifactId<\/span>><\/span>wiremock-jre8<\/artifactId<\/span>><\/span>\n    <version<\/span>><\/span>2.32.0<\/version<\/span>><\/span>\n    <scope<\/span>><\/span>test<\/scope<\/span>><\/span>\n<\/dependency<\/span>><\/span><\/code><\/span>Code-Sprache:<\/span> HTML, XML<\/span> (<\/span>xml<\/span>)<\/span><\/small><\/pre>\n\n\n
F\u00fcr Gradle-Projekte wird die Dependency in die build.gradle<\/code>-Datei eingef\u00fcgt:<\/p>\n\n\n
testImplementation 'com.github.tomakehurst:wiremock-jre8:2.32.0'<\/span><\/code><\/span>Code-Sprache:<\/span> JavaScript<\/span> (<\/span>javascript<\/span>)<\/span><\/small><\/pre>\n\n\n
Nach dem Hinzuf\u00fcgen der Abh\u00e4ngigkeiten k\u00f6nnen wir mit der Verwendung von WireMock in unseren Tests beginnen.<\/p>\n\n\n\n
Grundlegende Verwendung<\/h2>\n\n\n\n
Um WireMock in einem Test zu verwenden, m\u00fcssen wir einen WireMock-Server starten, Anfragen und Antworten konfigurieren und den Server anschlie\u00dfend stoppen. Ein einfacher JUnit-Test mit WireMock k\u00f6nnte wie folgt aussehen:<\/p>\n\n\n
import<\/span> com.github.tomakehurst.wiremock.WireMockServer;\nimport<\/span> com.github.tomakehurst.wiremock.client.WireMock;\nimport<\/span> com.github.tomakehurst.wiremock.core.WireMockConfiguration;\nimport<\/span> org.junit.jupiter.api.AfterEach;\nimport<\/span> org.junit.jupiter.api.BeforeEach;\nimport<\/span> org.junit.jupiter.api.Test;\n\nimport<\/span> static<\/span> com.github.tomakehurst.wiremock.client.WireMock.aResponse;\nimport<\/span> static<\/span> com.github.tomakehurst.wiremock.client.WireMock.equalTo;\nimport<\/span> static<\/span> com.github.tomakehurst.wiremock.client.WireMock.get;\nimport<\/span> static<\/span> com.github.tomakehurst.wiremock.client.WireMock.urlEqualTo;\nimport<\/span> static<\/span> org.junit.jupiter.api.Assertions.assertEquals;\n\npublic class<\/span> WireMockTest<\/span> <\/span>{\n\n    private WireMockServer wireMockServer;\n\n    @BeforeEach\n    public void<\/span> setup() {\n        wireMockServer = new<\/span> WireMockServer(WireMockConfiguration.options().port(8080<\/span>));\n        wireMockServer.start();\n        WireMock.configureFor(\"localhost\"<\/span>, 8080<\/span>);\n    }\n\n    @AfterEach\n    public void<\/span> teardown() {\n        wireMockServer.stop();\n    }\n\n    @Test\n    public void<\/span> testGetEndpoint() {\n        wireMockServer.stubFor(get<\/span>(urlEqualTo(\"\/api\/test\"))\n            .willReturn(aResponse()\n                .withStatus(200)\n                .withHeader(\"Content-Type\", \"application\/json\")\n                .withBody(\"{\\\"message\\\":\\\"Hello, World!\\\"}\"<\/span>)));\n\n        \/\/ Hier w\u00fcrde der tats\u00e4chliche HTTP-Client auf den WireMock-Server zugreifen<\/span>\n        String<\/span> response = sendHttpRequest(\"http:\/\/localhost:8080\/api\/test\"<\/span>);\n\n        assertEquals(\"{\\\"message\\\":\\\"Hello, World!\\\"}\"<\/span>, response);\n    }\n\n    private String<\/span> sendHttpRequest(String<\/span> url) {\n        \/\/ Methode zum Senden einer HTTP-Anfrage und R\u00fcckgabe der Antwort als String<\/span>\n        \/\/ Dies k\u00f6nnte beispielsweise mit HttpClient, RestTemplate oder einer anderen HTTP-Client-Bibliothek erfolgen<\/span>\n        return<\/span> \"\"<\/span>; \/\/ Dummy-R\u00fcckgabe f\u00fcr das Beispiel<\/span>\n    }\n}<\/code><\/span>Code-Sprache:<\/span> JavaScript<\/span> (<\/span>javascript<\/span>)<\/span><\/small><\/pre>\n\n\n
Erkl\u00e4rung des Codes<\/h3>\n\n\n\n
    \n
  1. Setup und Teardown<\/strong>:\n
      \n
    • In der setup<\/code>-Methode wird ein WireMock-Server auf Port 8080 gestartet.<\/li>\n\n\n\n
    • Die teardown<\/code>-Methode stoppt den Server nach jedem Test.<\/li>\n\n\n\n
    • WireMock.configureFor(\"localhost\", 8080)<\/code> konfiguriert WireMock, um auf Anfragen an localhost:8080<\/code> zu reagieren.<\/li>\n<\/ul>\n<\/li>\n\n\n\n
    • Stubbing von Anfragen<\/strong>:\n
        \n
      • wireMockServer.stubFor(get(urlEqualTo(\"\/api\/test\"))<\/code> definiert, dass eine GET-Anfrage an \/api\/test<\/code> eine vorgegebene Antwort zur\u00fcckgibt.<\/li>\n\n\n\n
      • willReturn(aResponse().withStatus(200).withHeader(\"Content-Type\", \"application\/json\").withBody(\"{\\\"message\\\":\\\"Hello, World!\\\"}\"))<\/code> spezifiziert die Antwort, einschlie\u00dflich Statuscode, Header und Body.<\/li>\n<\/ul>\n<\/li>\n\n\n\n
      • Senden einer HTTP-Anfrage<\/strong>:\n
          \n
        • Die Methode sendHttpRequest<\/code> simuliert das Senden einer HTTP-Anfrage. In einem realen Szenario w\u00fcrde dies durch eine HTTP-Client-Bibliothek wie HttpClient<\/code> oder RestTemplate<\/code> erfolgen.<\/li>\n<\/ul>\n<\/li>\n<\/ol>\n\n\n\n
          Erweiterte Funktionen<\/h2>\n\n\n\n
          WireMock bietet eine Vielzahl von erweiterten Funktionen, die \u00fcber einfache Stub-Anfragen hinausgehen. Dazu geh\u00f6ren:<\/p>\n\n\n\n
          Anfragen-Verifizierung<\/h3>\n\n\n\n
          Neben dem Stubbing k\u00f6nnen wir auch \u00fcberpr\u00fcfen, ob bestimmte Anfragen w\u00e4hrend des Tests gesendet wurden:<\/p>\n\n\n
          @Test\npublic<\/span> void testRequestVerification() {\n    wireMockServer.stubFor(get(urlEqualTo(\"\/api\/verify\"<\/span>))\n        .willReturn(aResponse().withStatus(200<\/span>)));\n\n    sendHttpRequest(\"http:\/\/localhost:8080\/api\/verify\"<\/span>);\n\n    WireMock.verify(WireMock.getRequestedFor(urlEqualTo(\"\/api\/verify\"<\/span>)));\n}<\/code><\/span>Code-Sprache:<\/span> PHP<\/span> (<\/span>php<\/span>)<\/span><\/small><\/pre>\n\n\n
          Dynamische Antworten<\/h3>\n\n\n\n
          WireMock unterst\u00fctzt auch dynamische Antworten, die auf den eingehenden Anfragen basieren:<\/p>\n\n\n
          wireMockServer.stubFor(get(urlPathEqualTo(\"\/api\/resource\"<\/span>))\n    .withQueryParam(\"id\"<\/span>, equalTo(\"123\"<\/span>))\n    .willReturn(aResponse()\n        .withStatus(200<\/span>)\n        .withBody(\"{\\\"resource\\\":\\\"123\\\"}\"<\/span>)));<\/code><\/span>Code-Sprache:<\/span> PHP<\/span> (<\/span>php<\/span>)<\/span><\/small><\/pre>\n\n\n
          Simulieren von Verz\u00f6gerungen und Fehlern<\/h3>\n\n\n\n
          Um Netzwerkbedingungen oder Fehler zu simulieren, kann WireMock Verz\u00f6gerungen und verschiedene Fehlerarten einf\u00fcgen:<\/p>\n\n\n
          wireMockServer.stubFor(get(urlEqualTo(\"\/api\/timeout\"<\/span>))\n    .willReturn(aResponse()\n        .withFixedDelay(3000<\/span>) \/\/ 3 Sekunden Verz\u00f6gerung<\/span>\n        .withStatus(200<\/span>)\n        .withBody(\"Delayed response\"<\/span>)));\n\nwireMockServer.stubFor(get(urlEqualTo(\"\/api\/error\"<\/span>))\n    .willReturn(aResponse()\n        .withStatus(500<\/span>) \/\/ Interner Serverfehler<\/span>\n        .withBody(\"Internal Server Error\"<\/span>)));<\/code><\/span>Code-Sprache:<\/span> PHP<\/span> (<\/span>php<\/span>)<\/span><\/small><\/pre>\n\n\n
          Verwendung in verschiedenen Testframeworks<\/h2>\n\n\n\n
          WireMock l\u00e4sst sich nahtlos in verschiedene Testframeworks wie JUnit und TestNG integrieren. Hier ist ein Beispiel f\u00fcr die Verwendung mit JUnit 5:<\/p>\n\n\n
          import<\/span> com.github.tomakehurst.wiremock.junit5.WireMockExtension;\nimport<\/span> org.junit.jupiter.api.extension.RegisterExtension;\nimport<\/span> org.junit.jupiter.api.Test;\n\nimport<\/span> static<\/span> com.github.tomakehurst.wiremock.client.WireMock.*;\nimport<\/span> static<\/span> org.junit.jupiter.api.Assertions.assertEquals;\n\npublic class<\/span> WireMockJUnit5Test<\/span> <\/span>{\n\n    @RegisterExtension\n    static<\/span> WireMockExtension wireMockExtension = WireMockExtension.newInstance()\n        .options(WireMockConfiguration.wireMockConfig().port(8080<\/span>))\n        .build();\n\n    @Test\n    public void<\/span> testWithExtension() {\n        stubFor(get<\/span>(urlEqualTo(\"\/api\/extension\"))\n            .willReturn(aResponse()\n                .withStatus(200)\n                .withBody(\"Hello from extension!\")));\n\n        String response = sendHttpRequest(\"http:\/\/localhost:8080\/api\/extension\");\n\n        assertEquals(\"Hello from extension!\", response);\n    }\n\n    private String sendHttpRequest(String url) {\n        \/\/ Methode zum Senden einer HTTP-Anfrage und R\u00fcckgabe der Antwort als String<\/span>\n        return<\/span> \"\"<\/span>; \/\/ Dummy-R\u00fcckgabe f\u00fcr das Beispiel<\/span>\n    }\n}<\/code><\/span>Code-Sprache:<\/span> JavaScript<\/span> (<\/span>javascript<\/span>)<\/span><\/small><\/pre>\n\n\n
          Fazit<\/h2>\n\n\n\n
          WireMock ist ein unverzichtbares Werkzeug f\u00fcr Entwickler, die zuverl\u00e4ssige und wiederholbare Tests f\u00fcr ihre Anwendungen erstellen m\u00f6chten. Durch die M\u00f6glichkeit, externe HTTP-Dienste zu simulieren, k\u00f6nnen Tests isoliert und unabh\u00e4ngig von externen Systemen durchgef\u00fchrt werden. Dies f\u00fchrt zu stabileren und aussagekr\u00e4ftigeren Testergebnissen.<\/p>\n\n\n\n
          Mit den vielf\u00e4ltigen Funktionen von WireMock, einschlie\u00dflich der M\u00f6glichkeit, Anfragen zu stubben, zu verifizieren und dynamische Antworten zu erstellen, bietet die Bibliothek eine umfassende L\u00f6sung f\u00fcr das Testen von HTTP-Clients und API-Integrationen. Ob in einfachen Unit-Tests oder komplexen Integrationstests, WireMock erleichtert das Testen und tr\u00e4gt zur Qualit\u00e4tssicherung in der Softwareentwicklung bei.<\/p>\n","protected":false},"excerpt":{"rendered":"
          In der modernen Softwareentwicklung ist das Testen ein wesentlicher Bestandteil des Entwicklungsprozesses. Tests stellen sicher, dass der Code wie erwartet funktioniert und erm\u00f6glichen eine kontinuierliche Integration und Bereitstellung. Ein h\u00e4ufiges Szenario beim Testen ist die Notwendigkeit, externe APIs zu simulieren, um die Abh\u00e4ngigkeiten zu isolieren und wiederholbare Tests durchzuf\u00fchren. Hier kommt WireMock ins Spiel. WireMock […]<\/p>\n","protected":false},"author":1,"featured_media":0,"comment_status":"open","ping_status":"open","sticky":false,"template":"","format":"standard","meta":{"footnotes":""},"categories":[4],"tags":[],"class_list":["post-425","post","type-post","status-publish","format-standard","hentry","category-plain_java"],"_links":{"self":[{"href":"https:\/\/www.xn--javaeinfacherklrt-4qb.de\/index.php?rest_route=\/wp\/v2\/posts\/425","targetHints":{"allow":["GET"]}}],"collection":[{"href":"https:\/\/www.xn--javaeinfacherklrt-4qb.de\/index.php?rest_route=\/wp\/v2\/posts"}],"about":[{"href":"https:\/\/www.xn--javaeinfacherklrt-4qb.de\/index.php?rest_route=\/wp\/v2\/types\/post"}],"author":[{"embeddable":true,"href":"https:\/\/www.xn--javaeinfacherklrt-4qb.de\/index.php?rest_route=\/wp\/v2\/users\/1"}],"replies":[{"embeddable":true,"href":"https:\/\/www.xn--javaeinfacherklrt-4qb.de\/index.php?rest_route=%2Fwp%2Fv2%2Fcomments&post=425"}],"version-history":[{"count":1,"href":"https:\/\/www.xn--javaeinfacherklrt-4qb.de\/index.php?rest_route=\/wp\/v2\/posts\/425\/revisions"}],"predecessor-version":[{"id":426,"href":"https:\/\/www.xn--javaeinfacherklrt-4qb.de\/index.php?rest_route=\/wp\/v2\/posts\/425\/revisions\/426"}],"wp:attachment":[{"href":"https:\/\/www.xn--javaeinfacherklrt-4qb.de\/index.php?rest_route=%2Fwp%2Fv2%2Fmedia&parent=425"}],"wp:term":[{"taxonomy":"category","embeddable":true,"href":"https:\/\/www.xn--javaeinfacherklrt-4qb.de\/index.php?rest_route=%2Fwp%2Fv2%2Fcategories&post=425"},{"taxonomy":"post_tag","embeddable":true,"href":"https:\/\/www.xn--javaeinfacherklrt-4qb.de\/index.php?rest_route=%2Fwp%2Fv2%2Ftags&post=425"}],"curies":[{"name":"wp","href":"https:\/\/api.w.org\/{rel}","templated":true}]}}