Wiremock (#2)

Improved code readability and maintainability of BaseWiremock by applying renaming, method extraction, field moving, and constant extraction refactorings.

.editorconfig

@@ -27,3 +27,4 @@ indent_size = 4
 max_line_length = 100
 ij_kotlin_name_count_to_use_star_import = 999
 ij_kotlin_name_count_to_use_star_import_for_members = 999
+ktlint_function_naming_ignore_when_annotated_with = "Test"

.mvn/maven.config

@@ -1,2 +1,3 @@
 -Dkotlin.compiler.incremental=true
+-Dmaven.install.skip=true
 -T12C

Makefile

@@ -1,2 +1,5 @@
 build:
 	mvn clean verify site
+lint:
+	# brew install ktlint
+	ktlint --format

README.md

@@ -1,17 +1,13 @@
-# awesome-kotlin-maven-template
+# Finchly
+## Helper utilities for integration testing
 
-[![Kotlin CI with Maven](https://github.com/kpavlov/awesome-kotlin-maven-template/actions/workflows/maven.yml/badge.svg?branch=main)](https://github.com/kpavlov/awesome-kotlin-maven-template/actions/workflows/maven.yml)
-[![Codacy Badge](https://app.codacy.com/project/badge/Grade/644f664ad05a4a009b299bc24c8be4b8)](https://app.codacy.com/gh/kpavlov/langchain4j-kotlin/dashboard?utm_source=gh&utm_medium=referral&utm_content=&utm_campaign=Badge_grade)
-[![Codacy Coverage](https://app.codacy.com/project/badge/Coverage/644f664ad05a4a009b299bc24c8be4b8)](https://app.codacy.com/gh/kpavlov/langchain4j-kotlin/dashboard?utm_source=gh&utm_medium=referral&utm_content=&utm_campaign=Badge_coverage)
+[![Kotlin CI with Maven](https://github.com/kpavlov/finchly/actions/workflows/maven.yml/badge.svg?branch=main)](https://github.com/kpavlov/finchly/actions/workflows/maven.yml)
+[![Codacy Badge](https://app.codacy.com/project/badge/Grade/3aa0b5847e70494d9795ff98aa14b386)](https://app.codacy.com/gh/kpavlov/langchain4j-kotlin/dashboard?utm_source=gh&utm_medium=referral&utm_content=&utm_campaign=Badge_grade)
+[![Codacy Coverage](https://app.codacy.com/project/badge/Coverage/3aa0b5847e70494d9795ff98aa14b386)](https://app.codacy.com/gh/kpavlov/langchain4j-kotlin/dashboard?utm_source=gh&utm_medium=referral&utm_content=&utm_campaign=Badge_coverage)
 
+![logo](docs/finchly-logo.webp)
 
-## How to run
-
-Create `.env` file in root directory and add your API keys:
-
-```dotenv
-OPENAI_API_KEY=sk-xxxxx
-```
+## How to build
 
 Building project locally:
 ```shell
@@ -22,8 +18,3 @@ or
 make build
 ```
 
-## Acknowledgements
-
-Training data from Project Gutenberg:
-
-- [CAPTAIN BLOOD By Rafael Sabatini](https://www.gutenberg.org/cache/epub/1965/pg1965.txt)

bom/pom.xml

@@ -4,23 +4,23 @@
          xsi:schemaLocation="http://maven.apache.org/POM/4.0.0 http://maven.apache.org/xsd/maven-4.0.0.xsd">
     <modelVersion>4.0.0</modelVersion>
     <parent>
-        <groupId>me.kpavlov.project</groupId>
-        <artifactId>project-aggregator</artifactId>
+        <groupId>me.kpavlov.finchly</groupId>
+        <artifactId>aggregator</artifactId>
         <version>1.0-SNAPSHOT</version>
     </parent>
 
     <artifactId>bom</artifactId>
     <packaging>pom</packaging>
 
-    <name>Project :: BOM</name>
-    <description>Bill of Materials POM for getting full, complete set of compatible versions of LangChain4j modules
+    <name>Finchly :: BOM</name>
+    <description>Bill of Materials POM for getting full, complete set of compatible versions of Finchly modules
     </description>
 
     <dependencyManagement>
         <dependencies>
             <dependency>
                 <groupId>me.kpavlov.project</groupId>
-                <artifactId>core</artifactId>
+                <artifactId>wiremock</artifactId>
                 <version>${project.parent.version}</version>
             </dependency>
         </dependencies>

detekt.yml

@@ -0,0 +1,8 @@
+style:
+  active: true
+  MethodName:
+    active: true
+    ignoreOverriddenFunctions: true
+    excludeAnnotatedMethodsOrClasses:
+      - "org.junit.jupiter.api.Test"
+    ignoreTestFiles: true

parent/pom.xml

@@ -4,14 +4,14 @@
          xsi:schemaLocation="http://maven.apache.org/POM/4.0.0 http://maven.apache.org/xsd/maven-4.0.0.xsd">
     <modelVersion>4.0.0</modelVersion>
 
-    <groupId>me.kpavlov.project</groupId>
+    <groupId>me.kpavlov.finchly</groupId>
     <artifactId>parent</artifactId>
     <version>1.0-SNAPSHOT</version>
     <packaging>pom</packaging>
 
     <name>Project :: Parent POM</name>
     <description>Parent POM for Project modules</description>
-    <url>https://github.com/kpavlov/awesome-kotlin-maven-template</url>
+    <url>https://github.com/kpavlov/finchly</url>
 
     <properties>
         <project.build.sourceEncoding>UTF-8</project.build.sourceEncoding>
@@ -22,10 +22,12 @@
         <java.compiler.release>${java.version}</java.compiler.release>
         <argLine></argLine>
         <!-- Dependencies -->
+        <assertk.versopn>0.28.1</assertk.versopn>
         <kotlinx.version>1.9.0</kotlinx.version>
         <junit.version>5.11.3</junit.version>
         <awaitility.version>4.2.2</awaitility.version>
         <dotenv-kotlin.version>6.4.2</dotenv-kotlin.version>
+        <wiremock.version>3.9.2</wiremock.version>
     </properties>
 
     <repositories>
@@ -36,6 +38,8 @@
     </repositories>
 
     <build>
+        <sourceDirectory>${project.basedir}/src/main/kotlin</sourceDirectory>
+        <testSourceDirectory>${project.basedir}/src/test/kotlin</testSourceDirectory>
         <pluginManagement>
             <plugins>
                 <plugin>
@@ -46,7 +50,6 @@
                     <configuration>
                         <args>
                             <arg>-Xjsr305=strict</arg>
-                            <arg>-Werror</arg>
                         </args>
                     </configuration>
                     <executions>
@@ -156,24 +159,38 @@
                 <version>${kotlinx.version}</version>
                 <scope>test</scope>
             </dependency>
+            <dependency>
+                <groupId>com.willowtreeapps.assertk</groupId>
+                <artifactId>assertk-jvm</artifactId>
+                <version>${assertk.version}</version>
+                <scope>test</scope>
+            </dependency>
+            <dependency>
+                <groupId>com.willowtreeapps.assertk</groupId>
+                <artifactId>assertk-coroutines-jvm</artifactId>
+                <version>${assertk.version}</version>
+                <scope>test</scope>
+            </dependency>
         </dependencies>
     </dependencyManagement>
     <dependencies>
         <dependency>
             <groupId>org.jetbrains.kotlin</groupId>
-            <artifactId>kotlin-test-junit5</artifactId>
-            <scope>test</scope>
+            <artifactId>kotlin-stdlib</artifactId>
+            <version>${kotlin.version}</version>
         </dependency>
+        <!-- Test Dependencies -->
         <dependency>
             <groupId>org.junit.jupiter</groupId>
-            <artifactId>junit-jupiter-params</artifactId>
+            <artifactId>junit-jupiter-api</artifactId>
             <version>${junit.version}</version>
             <scope>test</scope>
         </dependency>
         <dependency>
-            <groupId>org.jetbrains.kotlin</groupId>
-            <artifactId>kotlin-stdlib</artifactId>
-            <version>${kotlin.version}</version>
+            <groupId>com.willowtreeapps.assertk</groupId>
+            <artifactId>assertk-jvm</artifactId>
+            <version>${assertk.versopn}</version>
+            <scope>test</scope>
         </dependency>
     </dependencies>
 

pom.xml

@@ -4,20 +4,29 @@
          xsi:schemaLocation="http://maven.apache.org/POM/4.0.0 http://maven.apache.org/xsd/maven-4.0.0.xsd">
     <modelVersion>4.0.0</modelVersion>
 
-    <groupId>me.kpavlov.project</groupId>
-    <artifactId>project-aggregator</artifactId>
+    <groupId>me.kpavlov.finchly</groupId>
+    <artifactId>aggregator</artifactId>
     <version>1.0-SNAPSHOT</version>
     <packaging>pom</packaging>
     <name>Project :: Aggregator</name>
 
     <modules>
         <module>parent</module>
         <module>bom</module>
-        <module>core</module>
+        <module>wiremock</module>
         <module>reports</module>
     </modules>
 
     <build>
+        <pluginManagement>
+            <plugins>
+                <plugin>
+                    <groupId>org.apache.maven.plugins</groupId>
+                    <artifactId>maven-site-plugin</artifactId>
+                    <version>3.21.0</version>
+                </plugin>
+            </plugins>
+        </pluginManagement>
         <plugins>
             <plugin>
                 <groupId>org.apache.maven.plugins</groupId>

renovate.json5

@@ -8,7 +8,7 @@
   "packageRules": [
     {
       "matchPackageNames": [
-        "me.kpavlov.project"
+        "me.kpavlov.finchly"
       ],
       "enabled": false
     },

reports/pom.xml

@@ -4,24 +4,24 @@
          xsi:schemaLocation="http://maven.apache.org/POM/4.0.0 http://maven.apache.org/xsd/maven-4.0.0.xsd">
     <modelVersion>4.0.0</modelVersion>
     <parent>
-        <groupId>me.kpavlov.project</groupId>
-        <artifactId>project-aggregator</artifactId>
+        <groupId>me.kpavlov.finchly</groupId>
+        <artifactId>aggregator</artifactId>
         <version>1.0-SNAPSHOT</version>
         <relativePath>../pom.xml</relativePath>
     </parent>
 
     <artifactId>reports</artifactId>
     <packaging>pom</packaging>
-    <name>Project :: Reports</name>
+    <name>Finchly :: Reports</name>
 
     <properties>
         <maven.deploy.skip>true</maven.deploy.skip>
     </properties>
 
     <dependencies>
         <dependency>
-            <groupId>me.kpavlov.project</groupId>
-            <artifactId>core</artifactId>
+            <groupId>me.kpavlov.finchly</groupId>
+            <artifactId>wiremock</artifactId>
             <version>${project.parent.version}</version>
         </dependency>
     </dependencies>

wiremock/pom.xml

@@ -0,0 +1,26 @@
+<?xml version="1.0" encoding="UTF-8"?>
+<project xmlns="http://maven.apache.org/POM/4.0.0"
+         xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
+         xsi:schemaLocation="http://maven.apache.org/POM/4.0.0 http://maven.apache.org/xsd/maven-4.0.0.xsd">
+    <modelVersion>4.0.0</modelVersion>
+    <parent>
+        <groupId>me.kpavlov.finchly</groupId>
+        <artifactId>parent</artifactId>
+        <version>1.0-SNAPSHOT</version>
+        <relativePath>../parent/pom.xml</relativePath>
+    </parent>
+
+    <artifactId>wiremock</artifactId>
+    <name>Finchly :: Wiremock</name>
+
+    <dependencies>
+        <!-- https://mvnrepository.com/artifact/org.wiremock/wiremock-standalone -->
+        <dependency>
+            <groupId>org.wiremock</groupId>
+            <artifactId>wiremock-standalone</artifactId>
+            <version>${wiremock.version}</version>
+            <scope>compile</scope>
+        </dependency>
+    </dependencies>
+
+</project>

wiremock/src/main/kotlin/me/kpavlov/finchly/wiremock/BaseWiremock.kt

@@ -0,0 +1,69 @@
+package me.kpavlov.finchly.wiremock
+
+import com.github.tomakehurst.wiremock.WireMockServer
+import com.github.tomakehurst.wiremock.client.VerificationException
+
+/**
+ * Base class for managing a WireMock server instance.
+ *
+ * The server is started upon initialization.
+ * Provides utility methods for managing stub mappings and verifying unmatched requests.
+ *
+ * @param mock The WireMock server instance to manage.
+ */
+public abstract class BaseWiremock(
+    protected val mock: WireMockServer,
+) {
+    init {
+        mock.start()
+    }
+
+    /**
+     * Retrieves the port number on which the WireMock server instance is running.
+     *
+     * @return the port number on which the WireMock server instance is listening.
+     */
+    public fun port(): Int = mock.port()
+
+    /**
+     * Removes a specific stub mapping from the WireMock server.
+     *
+     * @param mapping The stub mapping to remove.
+     */
+    public fun resetStub(mapping: com.github.tomakehurst.wiremock.stubbing.StubMapping) {
+        mock.removeStub(mapping)
+    }
+
+    /**
+     * Resets all the stub mappings in the WireMock server instance.
+     *
+     * This function clears all the stub mappings that have been set up in the WireMock server.
+     * After calling this method, the server will no longer have any of the previously configured stubs.
+     */
+    public fun resetAllStubs() {
+        mock.resetAll()
+    }
+
+    /**
+     * Verifies that there are no unmatched requests for the WireMock server.
+     *
+     * This function checks the WireMock server for any requests that were not matched against
+     * any stub mappings. If there are unmatched requests, it will find near misses and throw an
+     * appropriate `VerificationException`.
+     *
+     * @throws VerificationException if there are unmatched requests or near misses.
+     */
+    public fun verifyNoUnmatchedRequests() {
+        val unmatchedRequests = mock.findAllUnmatchedRequests()
+        if (unmatchedRequests.isEmpty()) {
+            return
+        }
+        println("Unmatched requests: $unmatchedRequests")
+        val nearMisses = mock.findNearMissesForAllUnmatchedRequests()
+        if (nearMisses.isEmpty()) {
+            throw VerificationException.forUnmatchedRequests(unmatchedRequests)
+        } else {
+            throw VerificationException.forUnmatchedNearMisses(nearMisses)
+        }
+    }
+}