Merge pull request #20 from Nuix/github_packaging

JuicyDragon · web-flow · commit 629a9ed42167 · 2023-09-06T15:40:55.000-07:00
GitHub packaging
diff --git a/IntelliJ/build.gradle.kts b/IntelliJ/build.gradle.kts
@@ -1,9 +1,10 @@
 plugins {
     id("java")
+    id("maven-publish")
 }
 
-group = "com.nuix.engine-baseline"
-version = "9.10"
+group = "com.nuix.innovation"
+version = "Nuix9.10-v1.1.0"
 
 val sourceCompatibility = 11
 val targetCompatibility = 11
@@ -20,6 +21,24 @@ val engineLibDir = "${nuixEngineDirectory}\\lib"
 val engineBinDir = "${nuixEngineDirectory}\\bin"
 val engineBinX86Dir = "${nuixEngineDirectory}\\bin\\x86"
 
+publishing {
+    repositories {
+        maven {
+            name = "GitHubPackages"
+            url = uri("https://maven.pkg.github.com/nuix/nuix-java-engine-baseline")
+            credentials {
+                username = project.findProperty("gpr.user") as String? ?: System.getenv("GITHUB_USERNAME")
+                password = project.findProperty("gpr.key") as String? ?: System.getenv("GITHUB_TOKEN")
+            }
+        }
+    }
+    publications {
+        register<MavenPublication>("gpr") {
+            from(components["java"])
+        }
+    }
+}
+
 repositories {
     mavenCentral()
 }
diff --git a/IntelliJ/settings.gradle.kts b/IntelliJ/settings.gradle.kts
@@ -1,2 +1,2 @@
-rootProject.name = "Nuix-Java-Engine-Baseline"
+rootProject.name = "enginewrapper"
 
diff --git a/IntelliJ/src/main/java/com/nuix/innovation/enginewrapper/LicenseResolver.java b/IntelliJ/src/main/java/com/nuix/innovation/enginewrapper/LicenseResolver.java
@@ -1,4 +1,4 @@
-package com.nuix.enginebaseline;
+package com.nuix.innovation.enginewrapper;
 
 import lombok.NonNull;
 import nuix.engine.Engine;
diff --git a/IntelliJ/src/main/java/com/nuix/innovation/enginewrapper/NuixDiagnostics.java b/IntelliJ/src/main/java/com/nuix/innovation/enginewrapper/NuixDiagnostics.java
@@ -1,4 +1,4 @@
-package com.nuix.enginebaseline;
+package com.nuix.innovation.enginewrapper;
 
 import java.io.File;
 import java.lang.management.ManagementFactory;
diff --git a/IntelliJ/src/main/java/com/nuix/innovation/enginewrapper/NuixEngine.java b/IntelliJ/src/main/java/com/nuix/innovation/enginewrapper/NuixEngine.java
@@ -1,4 +1,4 @@
-package com.nuix.enginebaseline;
+package com.nuix.innovation.enginewrapper;
 
 import com.google.common.base.Suppliers;
 import nuix.ThirdPartyDependency;
@@ -777,4 +777,8 @@ public void close() throws Exception {
             log = null;
         }
     }
+
+    public void showConfidentialValuesInLog(boolean enabled) {
+        System.setProperty("nuix.log.confidential.showValues", String.valueOf(enabled));
+    }
 }
diff --git a/IntelliJ/src/main/java/com/nuix/innovation/enginewrapper/NuixLicenseFeaturesLogger.java b/IntelliJ/src/main/java/com/nuix/innovation/enginewrapper/NuixLicenseFeaturesLogger.java
@@ -1,4 +1,4 @@
-package com.nuix.enginebaseline;
+package com.nuix.innovation.enginewrapper;
 
 import nuix.Licence;
 import nuix.LicenceProperties;
diff --git a/IntelliJ/src/main/java/com/nuix/innovation/enginewrapper/NuixLicenseResolver.java b/IntelliJ/src/main/java/com/nuix/innovation/enginewrapper/NuixLicenseResolver.java
@@ -1,4 +1,4 @@
-package com.nuix.enginebaseline;
+package com.nuix.innovation.enginewrapper;
 
 import lombok.NonNull;
 import nuix.LicenceProperties;
diff --git a/IntelliJ/src/main/java/com/nuix/innovation/enginewrapper/NuixVersion.java b/IntelliJ/src/main/java/com/nuix/innovation/enginewrapper/NuixVersion.java
@@ -1,4 +1,4 @@
-package com.nuix.enginebaseline;
+package com.nuix.innovation.enginewrapper;
 
 import java.util.regex.Pattern;
 
diff --git a/IntelliJ/src/main/java/com/nuix/innovation/enginewrapper/RubyScriptRunner.java b/IntelliJ/src/main/java/com/nuix/innovation/enginewrapper/RubyScriptRunner.java
@@ -1,4 +1,4 @@
-package com.nuix.enginebaseline;
+package com.nuix.innovation.enginewrapper;
 
 import org.apache.commons.io.FileUtils;
 import org.apache.commons.lang3.exception.ExceptionUtils;
@@ -13,7 +13,6 @@
 import java.io.IOException;
 import java.io.InputStream;
 import java.io.Writer;
-import java.util.HashMap;
 import java.util.Map;
 import java.util.function.BiConsumer;
 import java.util.function.Consumer;
diff --git a/IntelliJ/src/main/java/com/nuix/innovation/enginewrapper/ThrowCapableConsumer.java b/IntelliJ/src/main/java/com/nuix/innovation/enginewrapper/ThrowCapableConsumer.java
@@ -1,4 +1,4 @@
-package com.nuix.enginebaseline;
+package com.nuix.innovation.enginewrapper;
 
 /***
  * An interface similar to {@link java.util.function.Consumer}, but allows for throwing checked exceptions.
diff --git a/IntelliJ/src/test/java/BasicTests.java b/IntelliJ/src/test/java/BasicTests.java
@@ -1,4 +1,4 @@
-import com.nuix.enginebaseline.NuixEngine;
+import com.nuix.innovation.enginewrapper.NuixEngine;
 import nuix.*;
 import org.junit.jupiter.api.Test;
 
diff --git a/IntelliJ/src/test/java/CommonTestFunctionality.java b/IntelliJ/src/test/java/CommonTestFunctionality.java
@@ -1,5 +1,5 @@
-import com.nuix.enginebaseline.NuixEngine;
-import com.nuix.enginebaseline.NuixLicenseResolver;
+import com.nuix.innovation.enginewrapper.NuixEngine;
+import com.nuix.innovation.enginewrapper.NuixLicenseResolver;
 import org.apache.commons.io.FileUtils;
 import org.junit.jupiter.api.AfterAll;
 import org.junit.jupiter.api.BeforeAll;
diff --git a/IntelliJ/src/test/java/ExampleUsingText.java b/IntelliJ/src/test/java/ExampleUsingText.java
@@ -1,4 +1,4 @@
-import com.nuix.enginebaseline.NuixEngine;
+import com.nuix.innovation.enginewrapper.NuixEngine;
 import nuix.*;
 import org.junit.jupiter.api.Test;
 
diff --git a/IntelliJ/src/test/java/RubyScriptRunnerTests.java b/IntelliJ/src/test/java/RubyScriptRunnerTests.java
@@ -1,7 +1,6 @@
-import com.nuix.enginebaseline.NuixEngine;
-import com.nuix.enginebaseline.RubyScriptRunner;
+import com.nuix.innovation.enginewrapper.NuixEngine;
+import com.nuix.innovation.enginewrapper.RubyScriptRunner;
 import nuix.Utilities;
-import org.jruby.embed.internal.BiVariableMap;
 import org.junit.jupiter.api.Test;
 
 import java.io.File;
diff --git a/README.MD b/README.MD
@@ -138,6 +138,94 @@ Some things to note:
 - The class path entries are delimited with a semicolon (`;`).
 - The *last argument* is the fully qualified name (package and class name) of the class containing the entry point we are running.
 
+# Gradle Package Dependency
+
+Just want to make use of the wrapper?  You can add the wrapper classes as a dependency to your own Gradle project.
+
+You will need to generate a [personal access token](https://docs.github.com/en/authentication/keeping-your-account-and-data-secure/managing-your-personal-access-tokens) with at least the permission `read:packages`.  Place this token in the environment variable `GITHUB_TOKEN`.  Place your GitHub username in the environment variable `GITHUB_USERNAME`.  You can also supply the username and token by other means if you wish (see below), but the environment variables mentioned above should work with the Gradle code below.
+
+The you will need to merge the following into your project's `build.gradle.kts` file:
+
+```kotlin
+// Directory containing Nuix Engine release
+val nuixEngineDirectory: String = System.getenv("NUIX_ENGINE_DIR")
+println("NUIX_ENGINE_DIR: ${nuixEngineDirectory}")
+if (nuixEngineDirectory.isEmpty()) {
+    throw InvalidUserDataException("Please populate the environment variable 'NUIX_ENGINE_DIR' with directory containing a Nuix Engine release")
+}
+
+val engineLibDir = "${nuixEngineDirectory}\\lib"
+println("engineLibDir: ${engineLibDir}")
+
+repositories {
+    mavenCentral()
+
+    // Resolve GitHub username and access token
+    val github_username = project.findProperty("gpr.user") as String? ?: System.getenv("GITHUB_USERNAME")
+    val github_token = project.findProperty("gpr.key") as String? ?: System.getenv("GITHUB_TOKEN")
+
+    // Link to repository so package can be resolved
+    maven {
+        url = uri("https://maven.pkg.github.com/nuix/nuix-java-engine-baseline")
+        credentials {
+            username = github_username
+            password = github_token
+        }
+    }
+}
+
+dependencies {
+    // Engine wrapper as dependency
+    implementation("com.nuix.innovation:enginewrapper:Nuix9.10-v1.+")
+
+    // Test run-time engine release lib dir
+    testImplementation(fileTree(baseDir = engineLibDir) {
+        include("*.jar")
+    })
+}
+
+// Function to perform some configuration of test environment when tests are ran
+fun configureTestEnvironment(test: Test) {
+    // Engine runtime temp directory
+    val nuixTempDirectory = findProperty("tempDir") ?: "${System.getenv("LOCALAPPDATA")}\\Temp\\Nuix"
+
+    // Args passed to JVM running tests
+    test.jvmArgs(
+            "--add-exports=java.base/jdk.internal.loader=ALL-UNNAMED",
+            "-Xmx4G",
+            "-Djava.io.tmpdir=\"${nuixTempDirectory}\"",
+    )
+
+    // Configure ENV vars for JVM tests run in
+    test.setEnvironment(
+            // Add our engine release's bin and bin/x86 to PATH
+            Pair("PATH", "${System.getenv("PATH")};${nuixEngineDirectory}\\bin;${nuixEngineDirectory}\\bin\\x86"),
+
+            // Forward ENV username and password
+            Pair("NUIX_USERNAME", System.getenv("NUIX_USERNAME")),
+            Pair("NUIX_PASSWORD", System.getenv("NUIX_PASSWORD")),
+
+            // Forward LOCALAPPDATA and APPDATA
+            Pair("LOCALAPPDATA", System.getenv("LOCALAPPDATA")),
+            Pair("APPDATA", System.getenv("APPDATA")),
+
+            // We need to make sure we set these so workers will properly resolve temp dir
+            // (when using a worker based operation via EngineWrapper).
+            Pair("TEMP", nuixTempDirectory),
+            Pair("TMP", nuixTempDirectory),
+
+            Pair("NUIX_ENGINE_DIR", nuixEngineDirectory)
+    )
+}
+
+// Ensure that tests are ran by JUnit and that test environment gets configured
+tasks.test {
+    dependsOn(tasks.findByName("copyJarsToEngine"))
+    useJUnitPlatform()
+    configureTestEnvironment(this)
+}
+```
+
 # Where to Get Help
 
 Having trouble getting things up and running?  Here are several places you can seek assistance:

Original file line number	Diff line number	Diff line change
`@@ -1,2 +1,2 @@`
`1`		`-rootProject.name = "Nuix-Java-Engine-Baseline"`
	`1`	`+rootProject.name = "enginewrapper"`
`2`	`2`
Original file line number	Diff line number	Diff line change
`@@ -1,4 +1,4 @@`
`1`		`-package com.nuix.enginebaseline;`
	`1`	`+package com.nuix.innovation.enginewrapper;`
`2`	`2`
`3`	`3`	`import lombok.NonNull;`
`4`	`4`	`import nuix.engine.Engine;`