From bd86114dc63fe5da93def5b102b1d025e03e763a Mon Sep 17 00:00:00 2001
From: carrot <149851+lopcode@users.noreply.github.com>
Date: Sun, 11 Aug 2024 19:20:32 +0100
Subject: [PATCH] Add samples and validation to prepare for releases

---
 .editorconfig                                 |  9 +++
 .github/workflows/checks.yml                  |  9 ++-
 .run/ImFfm.run.xml                            | 13 ++--
 .../main/java/app/photofox/imffm/ImFfm.java   | 52 --------------
 run_samples.sh                                | 12 ++++
 sample/build.gradle.kts                       | 62 ++++++++++++++++
 sample/src/main/kotlin/imffm/ImFfm.kt         | 52 ++++++++++++++
 .../main/kotlin/imffm/ResizeImageSample.kt    | 70 +++++++++++++++++++
 .../src/main/kotlin/imffm/RunnableSample.kt   | 11 +++
 sample/src/main/resources/.gitkeep            |  0
 settings.gradle.kts                           |  3 +-
 11 files changed, 230 insertions(+), 63 deletions(-)
 create mode 100644 .editorconfig
 delete mode 100644 core/src/main/java/app/photofox/imffm/ImFfm.java
 create mode 100755 run_samples.sh
 create mode 100644 sample/build.gradle.kts
 create mode 100644 sample/src/main/kotlin/imffm/ImFfm.kt
 create mode 100644 sample/src/main/kotlin/imffm/ResizeImageSample.kt
 create mode 100644 sample/src/main/kotlin/imffm/RunnableSample.kt
 create mode 100644 sample/src/main/resources/.gitkeep

diff --git a/.editorconfig b/.editorconfig
new file mode 100644
index 0000000..8a7eb1e
--- /dev/null
+++ b/.editorconfig
@@ -0,0 +1,9 @@
+root = true
+
+[*.{kt,kts}]
+ktlint_code_style = ktlint_official
+ktlint_standard_multiline-expression-wrapping = disabled
+ktlint_standard_chain-method-continuation = disabled
+ktlint_standard_function-signature = disabled
+ktlint_standard_function-expression-body = disabled
+max_line_length = 120
\ No newline at end of file
diff --git a/.github/workflows/checks.yml b/.github/workflows/checks.yml
index ac12b44..d2e600c 100644
--- a/.github/workflows/checks.yml
+++ b/.github/workflows/checks.yml
@@ -26,4 +26,11 @@ jobs:
           gradle-version: 8.9
 
       - name: Run checks
-        run: ./gradlew build check shadowJar
\ No newline at end of file
+        run: ./gradlew build check shadowJar
+
+# todo: disabled whilst investigating libvips
+#      - name: Run samples
+#        run: |
+#          sudo apt install imagemagick
+#          magick --version
+#          ./run_samples.sh
\ No newline at end of file
diff --git a/.run/ImFfm.run.xml b/.run/ImFfm.run.xml
index ba1ee0d..0fe96ad 100644
--- a/.run/ImFfm.run.xml
+++ b/.run/ImFfm.run.xml
@@ -1,17 +1,12 @@
 <component name="ProjectRunConfigurationManager">
-  <configuration default="false" name="ImFfm" type="Application" factoryName="Application" nameIsGenerated="true">
+  <configuration default="false" name="ImFfm" type="JetRunConfigurationType" nameIsGenerated="true">
     <envs>
       <env name="DYLD_LIBRARY_PATH" value="native_libs" />
     </envs>
-    <option name="MAIN_CLASS_NAME" value="app.photofox.imffm.ImFfm" />
-    <module name="im-ffm.core" />
+    <option name="MAIN_CLASS_NAME" value="imffm.ImFfm" />
+    <module name="im-ffm.sample.main" />
+    <shortenClasspath name="NONE" />
     <option name="VM_PARAMETERS" value="--enable-native-access=ALL-UNNAMED" />
-    <extension name="coverage">
-      <pattern>
-        <option name="PATTERN" value="app.photofox.imffm.*" />
-        <option name="ENABLED" value="true" />
-      </pattern>
-    </extension>
     <method v="2">
       <option name="Make" enabled="true" />
     </method>
diff --git a/core/src/main/java/app/photofox/imffm/ImFfm.java b/core/src/main/java/app/photofox/imffm/ImFfm.java
deleted file mode 100644
index 4228bbc..0000000
--- a/core/src/main/java/app/photofox/imffm/ImFfm.java
+++ /dev/null
@@ -1,52 +0,0 @@
-package app.photofox.imffm;
-
-import java.lang.foreign.Arena;
-import java.lang.foreign.MemorySegment;
-
-import static app.photofox.imffm.generated.MagickWand_h.*;
-
-public class ImFfm {
-
-    public static void main(String[] args) {
-        try (var arena = Arena.ofConfined()) {
-            resizeImageSample(arena);
-            // intentionally throws
-        }
-    }
-
-    private static void resizeImageSample(Arena arena) {
-        // https://imagemagick.org/MagickWand/resize.htm
-
-        MagickWandGenesis();
-
-        MemorySegment wand = NewMagickWand();
-        // Read the image - all you need to do is change "logo:" to some other
-        // filename to have this resize and, if necessary, convert a different file
-        MagickReadImage(wand, arena.allocateFrom("logo:"));
-
-        // Get the image's width and height
-        long width = MagickGetImageWidth(wand);
-        long height = MagickGetImageHeight(wand);
-
-        // Cut them in half but make sure they don't underflow
-        if((width /= 2) < 1) width = 1;
-        if((height /= 2) < 1) height = 1;
-
-        // Resize the image using the Lanczos filter
-        // The blur factor is a "double", where > 1 is blurry, < 1 is sharp
-        // I haven't figured out how you would change the blur parameter of MagickResizeImage
-        // on the command line so I have set it to its default of one.
-        MagickResizeImage(wand, width, height, LanczosFilter());
-
-        // Set the compression quality to 95 (high quality = low compression)
-        MagickSetImageCompressionQuality(wand, 95);
-
-        /* Write the new image */
-        MagickWriteImage(wand, arena.allocateFrom("logo_resize.jpg"));
-
-        /* Clean up */
-        DestroyMagickWand(wand);
-
-        MagickWandTerminus();
-    }
-}
diff --git a/run_samples.sh b/run_samples.sh
new file mode 100755
index 0000000..2c0869d
--- /dev/null
+++ b/run_samples.sh
@@ -0,0 +1,12 @@
+#!/usr/bin/env bash
+set -eou pipefail
+
+echo "building samples..."
+./gradlew sample:clean sample:shadowJar
+
+if [[ "$OSTYPE" == "darwin"* ]]; then
+  export DYLD_LIBRARY_PATH=native_libs
+fi
+
+echo "running samples..."
+java -jar sample/build/libs/sample-all.jar
\ No newline at end of file
diff --git a/sample/build.gradle.kts b/sample/build.gradle.kts
new file mode 100644
index 0000000..84fd9f5
--- /dev/null
+++ b/sample/build.gradle.kts
@@ -0,0 +1,62 @@
+@file:Suppress("UnstableApiUsage")
+
+import org.gradle.api.tasks.testing.logging.TestExceptionFormat
+import org.gradle.api.tasks.testing.logging.TestLogEvent
+
+plugins {
+    kotlin("jvm") version "2.0.10"
+    id("com.github.johnrengelman.shadow") version "8.1.1"
+    application
+}
+
+repositories {
+    mavenCentral()
+}
+
+dependencies {
+    implementation(project(":core"))
+    implementation(platform("org.slf4j:slf4j-bom:2.0.16"))
+    implementation("org.slf4j:slf4j-api")
+    implementation("org.slf4j:slf4j-simple")
+}
+
+java {
+    toolchain {
+        languageVersion.set(JavaLanguageVersion.of(22))
+    }
+}
+
+testing {
+    suites {
+        val test by getting(JvmTestSuite::class) {
+            useKotlinTest("2.0.0")
+            testType = TestSuiteType.UNIT_TEST
+        }
+    }
+}
+
+tasks.withType<Test> {
+    testLogging {
+        events = TestLogEvent.values().toSet() - TestLogEvent.STARTED
+        exceptionFormat = TestExceptionFormat.FULL
+    }
+    environment(mapOf("DYLD_LIBRARY_PATH" to "native_libs"))
+    outputs.upToDateWhen { false }
+}
+
+tasks.withType<JavaExec>().configureEach {
+    environment(mapOf("DYLD_LIBRARY_PATH" to "native_libs"))
+    javaLauncher.set(project.javaToolchains.launcherFor(java.toolchain))
+}
+
+tasks.withType<Jar>().configureEach {
+    manifest {
+        attributes("Enable-Native-Access" to "ALL-UNNAMED")
+    }
+}
+
+application {
+    mainClass = "imffm.ImFfm"
+    applicationDefaultJvmArgs = listOf("--enable-native-access=ALL-UNNAMED")
+    // todo: figure out how to set DYLD_LIBRARY_PATH here
+}
\ No newline at end of file
diff --git a/sample/src/main/kotlin/imffm/ImFfm.kt b/sample/src/main/kotlin/imffm/ImFfm.kt
new file mode 100644
index 0000000..615f3b4
--- /dev/null
+++ b/sample/src/main/kotlin/imffm/ImFfm.kt
@@ -0,0 +1,52 @@
+package imffm
+
+import org.slf4j.LoggerFactory
+import java.lang.foreign.Arena
+import java.nio.file.Files
+import java.nio.file.Paths
+import java.util.Locale
+import kotlin.system.exitProcess
+
+object ImFfm {
+
+    val logger = LoggerFactory.getLogger(ImFfm::class.java)
+
+    @JvmStatic
+    fun main(args: Array<String>) {
+        val samples = listOf(
+            ResizeImageSample
+        )
+        val sampleParentRunPath = Paths.get("sample_run")
+        if (Files.exists(sampleParentRunPath)) {
+            logger.info("clearing sample run directory at path \"$sampleParentRunPath\"")
+            sampleParentRunPath.toFile().deleteRecursively()
+        }
+        Files.deleteIfExists(sampleParentRunPath)
+        Files.createDirectory(sampleParentRunPath)
+
+        Arena.ofConfined().use { arena ->
+            samples.forEach { sample ->
+                logger.info("running sample \"${sample.name}\"...")
+                val sampleDirectoryName = makeSampleDirectoryName(sample.name)
+                val sampleRunPath = sampleParentRunPath.resolve(sampleDirectoryName)
+                Files.createDirectory(sampleRunPath)
+
+                sample.run(arena, sampleRunPath)
+                val validationResult = sample.validate(sampleRunPath)
+                if (validationResult.isFailure) {
+                    logger.error("validation failed ❌", validationResult.exceptionOrNull())
+                    exitProcess(1)
+                }
+                logger.info("validation succeeded ✅")
+            }
+        }
+        logger.info("all samples ran successfully 🎉")
+        exitProcess(0)
+    }
+
+    private fun makeSampleDirectoryName(original: String): String {
+        return original
+            .replace(oldValue = " ", "_")
+            .lowercase(Locale.ENGLISH)
+    }
+}
diff --git a/sample/src/main/kotlin/imffm/ResizeImageSample.kt b/sample/src/main/kotlin/imffm/ResizeImageSample.kt
new file mode 100644
index 0000000..ec82264
--- /dev/null
+++ b/sample/src/main/kotlin/imffm/ResizeImageSample.kt
@@ -0,0 +1,70 @@
+package imffm
+
+import app.photofox.imffm.generated.MagickWand_h.*
+import java.io.File
+import java.lang.foreign.Arena
+import java.nio.file.Files
+import java.nio.file.Path
+import java.nio.file.Paths
+import kotlin.io.path.absolutePathString
+
+// https://imagemagick.org/MagickWand/resize.htm
+object ResizeImageSample : RunnableSample {
+
+    override val name = "Image resizing"
+
+    override fun run(arena: Arena, workingDirectory: Path) {
+        MagickWandGenesis()
+
+        val wand = NewMagickWand()
+        // Read the image - all you need to do is change "logo:" to some other
+        // filename to have this resize and, if necessary, convert a different file
+        MagickReadImage(wand, arena.allocateFrom("logo:"))
+
+        // Get the image's width and height
+        var width = MagickGetImageWidth(wand)
+        var height = MagickGetImageHeight(wand)
+
+        // Cut them in half but make sure they don't underflow
+        width = (width / 2).coerceAtLeast(1)
+        height = (height / 2).coerceAtLeast(1)
+
+        // Resize the image using the Lanczos filter
+        // The blur factor is a "double", where > 1 is blurry, < 1 is sharp
+        // I haven't figured out how you would change the blur parameter of MagickResizeImage
+        // on the command line so I have set it to its default of one.
+        MagickResizeImage(wand, width, height, LanczosFilter())
+
+        // Set the compression quality to 95 (high quality = low compression)
+        MagickSetImageCompressionQuality(wand, 95)
+
+        /* Write the new image */
+        val resizedImagePath = workingDirectory.resolve("logo_resize.jpg")
+        MagickWriteImage(wand, arena.allocateFrom(resizedImagePath.absolutePathString()))
+
+        /* Clean up */
+        DestroyMagickWand(wand)
+
+        MagickWandTerminus()
+    }
+
+    override fun validate(workingDirectory: Path): Result<Unit> {
+        val resizedImagePath = workingDirectory.resolve("logo_resize.jpg")
+        if (!Files.exists(resizedImagePath)) {
+            return Result.failure(
+                RuntimeException("expected file does not exist")
+            )
+        }
+        val minSizeKb = 20
+        val maxSizeKb = 40
+        return runCatching {
+            Files.size(resizedImagePath) / 1000.0
+        }.map { size ->
+            if (size < minSizeKb || size > maxSizeKb) {
+                return Result.failure(
+                    RuntimeException("image out of bounds (min $minSizeKb, max $maxSizeKb, actual $size")
+                )
+            }
+        }
+    }
+}
diff --git a/sample/src/main/kotlin/imffm/RunnableSample.kt b/sample/src/main/kotlin/imffm/RunnableSample.kt
new file mode 100644
index 0000000..71af6be
--- /dev/null
+++ b/sample/src/main/kotlin/imffm/RunnableSample.kt
@@ -0,0 +1,11 @@
+package imffm
+
+import java.lang.foreign.Arena
+import java.nio.file.Path
+
+interface RunnableSample {
+
+    val name: String
+    fun run(arena: Arena, workingDirectory: Path)
+    fun validate(workingDirectory: Path): Result<Unit>
+}
diff --git a/sample/src/main/resources/.gitkeep b/sample/src/main/resources/.gitkeep
new file mode 100644
index 0000000..e69de29
diff --git a/settings.gradle.kts b/settings.gradle.kts
index a2aa7ab..8e87e76 100644
--- a/settings.gradle.kts
+++ b/settings.gradle.kts
@@ -12,4 +12,5 @@ plugins {
 }
 
 rootProject.name = "im-ffm"
-include("core")
+include("core", "sample")
+include("sample")