Merge pull request #1 from kuberhealthy/codex/add-github-actions-for-build-and-publish

Add Kuberhealthy Java client and build workflows

Author: integrii

.github/workflows/container-build.yml

@@ -0,0 +1,14 @@
+name: Build container
+
+on:
+  push:
+    branches: [main]
+  pull_request:
+
+jobs:
+  build:
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v4
+      - name: Build example container
+        run: docker build .

.github/workflows/publish.yml

@@ -0,0 +1,23 @@
+name: Publish client
+
+on:
+  release:
+    types: [created]
+
+jobs:
+  publish:
+    runs-on: ubuntu-latest
+    permissions:
+      contents: write
+    steps:
+      - uses: actions/checkout@v4
+      - uses: actions/setup-java@v4
+        with:
+          distribution: temurin
+          java-version: '17'
+      - name: Build jar
+        run: mvn -q package
+      - name: Upload release asset
+        uses: softprops/action-gh-release@v1
+        with:
+          files: target/kuberhealthy-client-*.jar

Dockerfile

@@ -1,9 +1,10 @@
-FROM openjdk:17-jdk-slim AS build
+FROM maven:3.9.5-eclipse-temurin-17 AS build
 WORKDIR /app
-COPY ExampleCheck.java .
-RUN javac ExampleCheck.java
+COPY pom.xml .
+COPY src ./src
+RUN mvn -q package
 
-FROM openjdk:17-jre-slim
+FROM eclipse-temurin:17-jre
 WORKDIR /app
-COPY --from=build /app/ExampleCheck.class .
-ENTRYPOINT ["java", "ExampleCheck"]
+COPY --from=build /app/target/kuberhealthy-client-*.jar app.jar
+ENTRYPOINT ["java", "-cp", "app.jar", "io.kuberhealthy.example.ExampleCheck"]

ExampleCheck.java

@@ -1,23 +1,42 @@
-# Java Client Example
+# Java Client and Example
 
-This directory shows how to write a minimal Java check for [Kuberhealthy](https://github.com/kuberhealthy/kuberhealthy). The `ExampleCheck` program reads the `KH_REPORTING_URL` and `KH_RUN_UUID` environment variables that Kuberhealthy injects into checker pods and posts a JSON status report.
+This repository provides a minimal Java client for reporting check results to [Kuberhealthy](https://github.com/kuberhealthy/kuberhealthy) and an example check that uses it.  The `ExampleCheck` program reads the `KH_REPORTING_URL` and `KH_RUN_UUID` environment variables that Kuberhealthy injects into checker pods and posts a JSON status report.
 
-## Extending the check
+## Using the client library
 
-Add your own logic inside `ExampleCheck.java` before the call to `report`. The file defaults to reporting success and includes commented-out lines that show how to report a failure:
+Applications can depend on the client published to GitHub Packages:
+
+```xml
+<dependency>
+  <groupId>io.kuberhealthy</groupId>
+  <artifactId>kuberhealthy-client</artifactId>
+  <version>0.1.0-SNAPSHOT</version>
+</dependency>
+```
+
+Add `https://maven.pkg.github.com/OWNER/REPO` as a Maven repository and authenticate with a GitHub token that has permission to read packages.
+
+Within your code, create a `KuberhealthyClient` and call `report`:
+
+```java
+import io.kuberhealthy.client.KuberhealthyClient;
+
+KuberhealthyClient client = new KuberhealthyClient(url, uuid);
+client.report(true, "");
+```
+
+## Extending the example check
+
+Add your own logic inside `ExampleCheck.java` before reporting the result.  The file defaults to reporting success and includes commented-out lines that show how to report a failure:
 
 ```java
 // ok = false;
 // error = "something went wrong";
 ```
 
-Call `report` with `ok=true` when the check succeeds or `ok=false` with an error message when it fails.
-
-`report` expects an HTTP 200 response from Kuberhealthy; any other status
-code causes the program to exit with an error so rejected payloads surface
-immediately.
+Call `report` with `ok=true` when the check succeeds or `ok=false` with an error message when it fails.  Non-200 responses from Kuberhealthy cause the program to exit with an error so rejected payloads surface immediately.
 
-## Building and pushing
+## Building and pushing the container
 
 Build and push the container image:
 

README.md

@@ -0,0 +1,14 @@
+<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>
+  <groupId>io.kuberhealthy</groupId>
+  <artifactId>kuberhealthy-client</artifactId>
+  <version>0.1.0-SNAPSHOT</version>
+  <name>Kuberhealthy Java Client</name>
+  <description>Client library and example check for Kuberhealthy</description>
+  <properties>
+    <maven.compiler.source>17</maven.compiler.source>
+    <maven.compiler.target>17</maven.compiler.target>
+  </properties>
+</project>

pom.xml

@@ -0,0 +1,53 @@
+package io.kuberhealthy.client;
+
+import java.io.IOException;
+import java.io.OutputStream;
+import java.net.HttpURLConnection;
+import java.net.URL;
+import java.nio.charset.StandardCharsets;
+
+/**
+ * Minimal client for reporting check results to Kuberhealthy.
+ */
+public class KuberhealthyClient {
+    private final String url;
+    private final String uuid;
+
+    public KuberhealthyClient(String url, String uuid) {
+        this.url = url;
+        this.uuid = uuid;
+    }
+
+    /**
+     * Reports the result of a check to Kuberhealthy.
+     *
+     * @param ok           true if the check succeeded
+     * @param errorMessage error description when ok is false
+     * @throws IOException when the report cannot be delivered
+     */
+    public void report(boolean ok, String errorMessage) throws IOException {
+        String payload = "{\"ok\":true,\"errors\":[]}";
+        if (!ok) {
+            payload = "{\"ok\":false,\"errors\":[\"" + escape(errorMessage) + "\"]}";
+        }
+
+        HttpURLConnection conn = (HttpURLConnection) new URL(url).openConnection();
+        conn.setRequestMethod("POST");
+        conn.setRequestProperty("Content-Type", "application/json");
+        conn.setRequestProperty("kh-run-uuid", uuid);
+        conn.setDoOutput(true);
+
+        try (OutputStream os = conn.getOutputStream()) {
+            os.write(payload.getBytes(StandardCharsets.UTF_8));
+        }
+
+        int code = conn.getResponseCode();
+        if (code != 200) {
+            throw new IOException("unexpected response code: " + code);
+        }
+    }
+
+    private static String escape(String s) {
+        return s.replace("\\", "\\\\").replace("\"", "\\\"");
+    }
+}

src/main/java/io/kuberhealthy/client/KuberhealthyClient.java

@@ -0,0 +1,31 @@
+package io.kuberhealthy.example;
+
+import io.kuberhealthy.client.KuberhealthyClient;
+
+/**
+ * Example check that always reports success to Kuberhealthy.
+ */
+public class ExampleCheck {
+    public static void main(String[] args) throws Exception {
+        String url = System.getenv("KH_REPORTING_URL");
+        String uuid = System.getenv("KH_RUN_UUID");
+
+        if (url == null || url.isEmpty() || uuid == null || uuid.isEmpty()) {
+            System.err.println("KH_REPORTING_URL and KH_RUN_UUID must be set");
+            System.exit(1);
+        }
+
+        // Replace this with your own check logic. If the check passes, leave
+        // ok as true. To report a failure, set ok to false and provide an
+        // error message.
+        boolean ok = true;
+        String error = "";
+
+        // Example: report a failure with an error message
+        // ok = false;
+        // error = "something went wrong";
+
+        KuberhealthyClient client = new KuberhealthyClient(url, uuid);
+        client.report(ok, error);
+    }
+}