NMS-17074: Refactor fileutils to separate library

OpenNMS · Jan 28, 2025 · f47ccb0 · f47ccb0
1 parent 3c58d8b
commit f47ccb0
Show file tree

Hide file tree

Showing 12 changed files with 73 additions and 4 deletions.
diff --git a/container/features/src/main/resources/features-core.xml b/container/features/src/main/resources/features-core.xml
@@ -351,7 +351,7 @@ org.jolokia.authMode=jaas
         <feature>commons-codec</feature>
         <feature version="${guavaOsgiVersion}" prerequisite="true">guava</feature>
         <feature>scv-api</feature>
-        <bundle>mvn:org.opennms.core/org.opennms.core.lib/${project.version}</bundle>
+        <bundle dependency="true">mvn:org.opennms.core/org.opennms.core.fileutils/${project.version}</bundle>
         <bundle>mvn:org.opennms.features.scv/org.opennms.features.scv.jceks-impl/${project.version}</bundle>
     </feature>
 

diff --git a/container/features/src/main/resources/features-sentinel.xml b/container/features/src/main/resources/features-sentinel.xml
@@ -142,6 +142,7 @@
         <bundle>mvn:org.opennms.features.flows.classification.engine/org.opennms.features.flows.classification.engine.api/${project.version}</bundle>
         <bundle>mvn:org.opennms.features.flows.classification.engine/org.opennms.features.flows.classification.engine.impl/${project.version}</bundle>
         <bundle>mvn:org.opennms.features.flows/org.opennms.features.flows.elastic/${project.version}</bundle>
+        <bundle dependency="true">mvn:org.opennms.core/org.opennms.core.fileutils/${project.version}</bundle>
         <bundle>mvn:org.opennms.features.flows/org.opennms.features.flows.processing/${project.version}</bundle>
         <bundle>wrap:mvn:org.freemarker/freemarker/${freemarkerVersion}$Bundle-SymbolicName=org.freemarker&amp;Bundle-Version=${freemarkerVersion}</bundle>
         <bundle>mvn:org.opennms.core/org.opennms.core.cache/${project.version}</bundle>

diff --git a/container/features/src/main/resources/features.xml b/container/features/src/main/resources/features.xml
@@ -1017,6 +1017,7 @@
         <bundle>mvn:org.opennms.features.telemetry/org.opennms.features.telemetry.api/${project.version}</bundle>
         <bundle>mvn:org.opennms.features.telemetry/org.opennms.features.telemetry.common/${project.version}</bundle>
         <bundle>mvn:org.opennms.features.telemetry/org.opennms.features.telemetry.listeners/${project.version}</bundle>
+        <bundle dependency="true">mvn:org.opennms.core/org.opennms.core.fileutils/${project.version}</bundle>
         <bundle>mvn:org.opennms.features.telemetry.protocols/org.opennms.features.telemetry.protocols.adapters/${project.version}</bundle>
         <bundle>mvn:org.opennms.features.telemetry/org.opennms.features.telemetry.shell/${project.version}</bundle>
     </feature>
@@ -1157,6 +1158,7 @@
         <bundle>mvn:org.freemarker/freemarker/${freemarkerVersion}</bundle>
         <bundle>mvn:org.opennms.features.flows.classification.engine/org.opennms.features.flows.classification.engine.impl/${project.version}</bundle>
         <bundle>mvn:org.opennms.features.flows/org.opennms.features.flows.elastic/${project.version}</bundle>
+        <bundle dependency="true">mvn:org.opennms.core/org.opennms.core.fileutils/${project.version}</bundle>
         <bundle>mvn:org.opennms.features.flows/org.opennms.features.flows.processing/${project.version}</bundle>
         <bundle>mvn:org.opennms.features.flows/org.opennms.features.flows.kafka-persistence/${project.version}</bundle>
         <bundle>mvn:org.opennms.core/org.opennms.core.cache/${project.version}</bundle>

diff --git a/core/fileutils/pom.xml b/core/fileutils/pom.xml
@@ -0,0 +1,50 @@
+<?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>org.opennms</groupId>
+        <artifactId>org.opennms.core</artifactId>
+        <version>34.0.0-SNAPSHOT</version>
+    </parent>
+
+    <groupId>org.opennms.core</groupId>
+    <artifactId>org.opennms.core.fileutils</artifactId>
+    <packaging>bundle</packaging>
+    <name>OpenNMS :: Core :: File Utils</name>
+    <build>
+        <plugins>
+            <plugin>
+                <groupId>org.apache.felix</groupId>
+                <artifactId>maven-bundle-plugin</artifactId>
+                <extensions>true</extensions>
+                <configuration>
+                    <instructions>
+                        <Bundle-RequiredExecutionEnvironment>JavaSE-1.8</Bundle-RequiredExecutionEnvironment>
+                        <Bundle-SymbolicName>${project.artifactId}</Bundle-SymbolicName>
+                        <Bundle-Version>${project.version}</Bundle-Version>
+                    </instructions>
+                </configuration>
+            </plugin>
+        </plugins>
+    </build>
+
+    <dependencies>
+        <dependency>
+            <groupId>org.slf4j</groupId>
+            <artifactId>slf4j-api</artifactId>
+        </dependency>
+        <dependency>
+            <groupId>junit</groupId>
+            <artifactId>junit</artifactId>
+            <scope>test</scope>
+        </dependency>
+        <dependency>
+            <groupId>org.awaitility</groupId>
+            <artifactId>awaitility</artifactId>
+            <scope>test</scope>
+        </dependency>
+    </dependencies>
+
+</project>
diff --git a/...ms/core/fileutils/FileUpdateCallback.java → ...ms/core/fileutils/FileUpdateCallback.java b/...ms/core/fileutils/FileUpdateCallback.java → ...ms/core/fileutils/FileUpdateCallback.java
diff --git a/...nms/core/fileutils/FileUpdateWatcher.java → ...nms/core/fileutils/FileUpdateWatcher.java b/...nms/core/fileutils/FileUpdateWatcher.java → ...nms/core/fileutils/FileUpdateWatcher.java
diff --git a/...core/fileutils/FileUpdateWatcherTest.java → ...core/fileutils/FileUpdateWatcherTest.java b/...core/fileutils/FileUpdateWatcherTest.java → ...core/fileutils/FileUpdateWatcherTest.java
@@ -21,7 +21,6 @@
  */
 package org.opennms.core.fileutils;
 
-import static org.awaitility.Awaitility.await;
 import static java.util.concurrent.TimeUnit.SECONDS;
 
 import java.io.BufferedWriter;
@@ -30,6 +29,7 @@
 import java.io.IOException;
 import java.util.concurrent.atomic.AtomicBoolean;
 
+import org.awaitility.Awaitility;
 import org.junit.Assume;
 import org.junit.Before;
 import org.junit.Rule;
@@ -75,7 +75,7 @@ public void testFileUpdateWatcher() throws IOException {
         BufferedWriter writer = new BufferedWriter(new FileWriter(testFile));
         writer.write(hello);
         writer.close();
-        await().atMost(5, SECONDS).pollDelay(0, SECONDS).pollInterval(2, SECONDS)
+        Awaitility.await().atMost(5, SECONDS).pollDelay(0, SECONDS).pollInterval(2, SECONDS)
         .untilTrue(reloadCalled);
         fileWatcher.destroy();
     }

diff --git a/core/pom.xml b/core/pom.xml
@@ -61,5 +61,6 @@
     <module>tracing</module>
     <module>grpc</module>
     <module>encrypt-util</module>
+      <module>fileutils</module>
   </modules>
 </project>
diff --git a/features/flows/processing/pom.xml b/features/flows/processing/pom.xml
@@ -57,6 +57,11 @@
       <artifactId>org.opennms.core.cache</artifactId>
       <version>${project.version}</version>
     </dependency>
+    <dependency>
+      <groupId>org.opennms.core</groupId>
+      <artifactId>org.opennms.core.fileutils</artifactId>
+      <version>${project.version}</version>
+    </dependency>
     <dependency>
       <groupId>org.opennms.features.flows.classification.engine</groupId>
       <artifactId>org.opennms.features.flows.classification.engine.api</artifactId>

diff --git a/features/scv/jceks-impl/pom.xml b/features/scv/jceks-impl/pom.xml
@@ -40,7 +40,7 @@
         </dependency>
         <dependency>
             <groupId>org.opennms.core</groupId>
-            <artifactId>org.opennms.core.lib</artifactId>
+            <artifactId>org.opennms.core.fileutils</artifactId>
             <version>${project.version}</version>
         </dependency>
         <dependency>

diff --git a/features/telemetry/protocols/adapters/pom.xml b/features/telemetry/protocols/adapters/pom.xml
@@ -68,6 +68,11 @@
       <artifactId>org.opennms.core.sysprops</artifactId>
       <version>${project.version}</version>
     </dependency>
+    <dependency>
+      <groupId>org.opennms.core</groupId>
+      <artifactId>org.opennms.core.fileutils</artifactId>
+      <version>${project.version}</version>
+    </dependency>
     <dependency>
       <groupId>org.opennms.features.collection</groupId>
       <artifactId>org.opennms.features.collection.thresholding.impl</artifactId>

diff --git a/opennms-base-assembly/pom.xml b/opennms-base-assembly/pom.xml
@@ -859,6 +859,11 @@
       <artifactId>org.opennms.features.topology.persistence.impl</artifactId>
       <version>${project.version}</version>
     </dependency>
+    <dependency>
+      <groupId>org.opennms.core</groupId>
+      <artifactId>org.opennms.core.fileutils</artifactId>
+      <version>${project.version}</version>
+    </dependency>
     <dependency>
       <groupId>org.opennms.core.ipc.rpc</groupId>
       <artifactId>org.opennms.core.ipc.rpc.jms-impl</artifactId>