docs: add documentation

Co-authored-by: Eduwer Camacaro <[email protected]>
littlehorse-enterprises · Dec 13, 2024 · f66325c · f66325c
1 parent bf8658d
commit f66325c
Show file tree

Hide file tree

Showing 4 changed files with 40 additions and 11 deletions.
diff --git a/test-utils-container/README.md b/test-utils-container/README.md
@@ -1,3 +1,11 @@
-### LH Test
+# LH Test Utils Container
 
-Test framework for LittleHorse applications
+LittleHorse [Testcontainers](https://testcontainers.com/) implementation.
+
+For documentation on how to use this library, please go to [the LittleHorse website](https://littlehorse.dev).
+
+## Local Development
+
+```bash
+./gradlew test-utils-container:publishToMavenLocal -Pversion=<my-version>
+```
diff --git a/test-utils-container/src/main/java/io/littlehorse/container/LittleHorseCluster.java b/test-utils-container/src/main/java/io/littlehorse/container/LittleHorseCluster.java
@@ -12,6 +12,17 @@
 import org.testcontainers.kafka.KafkaContainer;
 import org.testcontainers.utility.DockerImageName;
 
+/**
+ * Example of using:
+ * <blockquote><pre>
+ *     {@code @Container}
+ *     public LittleHorseCluster littleHorseCluster = LittleHorseCluster.newBuilder()
+ *             .withInstances(2)
+ *             .withKafkaImage("apache/kafka-native:latest")
+ *             .withLittlehorseImage("ghcr.io/littlehorse-enterprises/littlehorse/lh-server:master")
+ *             .build();
+ * </pre></blockquote>
+ */
 public class LittleHorseCluster extends GenericContainer<LittleHorseCluster> {
 
     public static final String LHC_API_HOST = "LHC_API_HOST";
@@ -76,8 +87,9 @@ public static LittleHorseClusterBuilder newBuilder() {
 
     /**
      * Return a properties object
-     * Use: new LHConfig(littlehorseContainer.getProperties())
-     *
+     * <p>
+     * Use: {@code new LHConfig(littleHorseCluster.getClientProperties())}
+     * </p>
      * @return Properties with the container configurations
      */
     public Properties getClientProperties() {

diff --git a/test-utils-container/src/main/java/io/littlehorse/container/LittleHorseContainer.java b/test-utils-container/src/main/java/io/littlehorse/container/LittleHorseContainer.java
@@ -10,7 +10,7 @@
 import org.testcontainers.containers.wait.strategy.Wait;
 import org.testcontainers.utility.DockerImageName;
 
-public class LittleHorseContainer extends GenericContainer<LittleHorseContainer> {
+class LittleHorseContainer extends GenericContainer<LittleHorseContainer> {
 
     private static final String LHS_INTERNAL_ADVERTISED_HOST = "LHS_INTERNAL_ADVERTISED_HOST";
     private static final String LHS_INSTANCE_ID = "LHS_INSTANCE_ID";
@@ -30,7 +30,7 @@ public class LittleHorseContainer extends GenericContainer<LittleHorseContainer>
      *
      * @param littlehorseImage Example: "ghcr.io/littlehorse-enterprises/littlehorse/lh-server:latest"
      */
-    public LittleHorseContainer(final String littlehorseImage) {
+    LittleHorseContainer(final String littlehorseImage) {
         this(DockerImageName.parse(littlehorseImage));
     }
 
@@ -39,7 +39,7 @@ public LittleHorseContainer(final String littlehorseImage) {
      *
      * @param littlehorseImage Example: DockerImageName.parse("ghcr.io/littlehorse-enterprises/littlehorse/lh-server:latest")
      */
-    public LittleHorseContainer(final DockerImageName littlehorseImage) {
+    LittleHorseContainer(final DockerImageName littlehorseImage) {
         super(littlehorseImage);
         littlehorseImage.assertCompatibleWith(DEFAULT_IMAGE_NAME);
         this.withExposedPorts(DEFAULT_INTERNAL_PORT)
@@ -135,8 +135,9 @@ public int getApiPort() {
 
     /**
      * Return a properties object.
-     * Use: new LHConfig(littlehorseContainer.getProperties())
-     *
+     * <p>
+     * Use: {@code new LHConfig(littlehorseContainer.getClientProperties())}
+     * </p>
      * @return Properties with the container configurations
      */
     public Properties getClientProperties() {

diff --git a/test-utils/README.md b/test-utils/README.md
@@ -1,3 +1,11 @@
-### LH Test
+# LH Test Utils
 
-Test framework for LittleHorse applications
+Test framework for LittleHorse applications.
+
+For documentation on how to use this library, please go to [the LittleHorse website](https://littlehorse.dev).
+
+## Local Development
+
+```bash
+./gradlew test-utils:publishToMavenLocal -Pversion=<my-version>
+```