chore: resolve upstream merge conflicts

Author: cjenkscybercom

README.md

@@ -248,17 +248,18 @@ Create a sonatype account and update the maven settings.xml file with your sonat
 
 **Prepare the release**  
 `mvn release:prepare`  
-In this step will ensure there are no uncommitted changes, ensure the versions number are correct, tag the scm, etc..
-A full list of checks is documented [here](https://maven.apache.org/maven-release/maven-release-plugin/examples/prepare-release.html):
+In this step will ensure there are no uncommitted changes, ensure the versions number are correct, tag the scm, etc.
+A full list of checks is documented [here](https://maven.apache.org/maven-release/maven-release-plugin/examples/prepare-release.html).
 
 **Perform the release**  
-`mvn release:perform`  
-Checkout the release tag, build, sign and push the build binaries to sonatype.
+`mvn -Pdocs release:perform`  
+Checkout the release tag, build, sign and push the build binaries to sonatype. The `docs` profile is needed in order
+to create required javadocs jars.
 
 **Publish**  
 Open the staging repository in [sonatype](https://s01.oss.sonatype.org/#stagingRepositories) and hit the *publish* button
 
 **Note:**
 In order to keep the ant and maven builds in sync, before the prepare:release update the `version` in the 
 dependencies\ant_settings.xml to match the release version number. After the release is completed the `version` should 
-updated to match the next development snapshot version.
+updated to match the next development snapshotData version.

app/3d-viewer/pom.xml

@@ -3,23 +3,23 @@
   <parent>
     <groupId>org.phoebus</groupId>
     <artifactId>app</artifactId>
-    <version>4.7.1-SNAPSHOT</version>
+    <version>4.7.2-SNAPSHOT</version>
   </parent>
   <artifactId>app-3d-viewer</artifactId>
   <dependencies>
     <dependency>
       <groupId>org.phoebus</groupId>
       <artifactId>core-ui</artifactId>
-      <version>4.7.1-SNAPSHOT</version>
+      <version>4.7.2-SNAPSHOT</version>
     </dependency>
     <dependency>
       <groupId>org.phoebus</groupId>
       <artifactId>core-framework</artifactId>
-      <version>4.7.1-SNAPSHOT</version>
+      <version>4.7.2-SNAPSHOT</version>
     </dependency>
     <dependency>
-      <groupId>junit</groupId>
-      <artifactId>junit</artifactId>
+      <groupId>org.junit.jupiter</groupId>
+      <artifactId>junit-jupiter</artifactId>
       <version>${junit.version}</version>
       <scope>test</scope>
     </dependency>

app/3d-viewer/src/test/java/org/phoebus/app/viewer3d/Viewer3dParserDemo.java

@@ -7,19 +7,18 @@
  *******************************************************************************/
 package org.phoebus.app.viewer3d;
 
-import static org.junit.Assert.assertEquals;
-import static org.junit.Assert.assertTrue;
-
-import java.io.ByteArrayInputStream;
-
-import org.junit.Test;
-import org.phoebus.applications.viewer3d.Viewer3d;
-import org.phoebus.applications.viewer3d.Xform;
-
 import javafx.application.Platform;
 import javafx.scene.paint.Color;
 import javafx.scene.paint.PhongMaterial;
 import javafx.scene.shape.Sphere;
+import org.junit.jupiter.api.Test;
+import org.phoebus.applications.viewer3d.Viewer3d;
+import org.phoebus.applications.viewer3d.Xform;
+
+import java.io.ByteArrayInputStream;
+
+import static org.junit.jupiter.api.Assertions.assertEquals;
+import static org.junit.jupiter.api.Assertions.assertTrue;
 
 /** Demo of 3D parser.
  *

app/alarm/Readme.md

@@ -25,9 +25,9 @@ kafka in `/opt/kafka`.
     cd examples
 
     # Use wget, 'curl -O', or web browser to fetch a recent version of kafka
-    wget https://dlcdn.apache.org/kafka/3.2.0/kafka_2.13-3.2.0.tgz
-    tar -vzxf kafka_2.13-3.2.0.tgz
-    ln -s kafka_2.13-3.2.0 kafka
+    wget https://downloads.apache.org/kafka/3.3.1/kafka_2.13-3.3.1.tgz
+    tar vzxf kafka_2.13-3.3.1.tgz
+    ln -s kafka_2.13-3.3.1 kafka
 
 Check `config/zookeeper.properties` and `config/server.properties`.
 By default these contain settings for keeping data in `/tmp/`, which works for initial tests,
@@ -384,6 +384,8 @@ Demos
 `examples/create_alarm_topics.sh Accelerator`
 Run to create the topics used by the following demos.
 
+The demos are part of the test package included in the [app/alarm/model](https://github.com/ControlSystemStudio/phoebus/tree/master/app/alarm/model/src/test/java/org/phoebus/applications/alarm) module
+
 `AlarmConfigProducerDemo`: Run to create demo configuration.
 Loading a demo config with a total of 100000 PVs arranged into several sub and sub-sub sections
 takes less than 5 seconds.

app/alarm/datasource/pom.xml

@@ -3,13 +3,13 @@
   <parent>
     <groupId>org.phoebus</groupId>
     <artifactId>app-alarm</artifactId>
-    <version>4.7.1-SNAPSHOT</version>
+    <version>4.7.2-SNAPSHOT</version>
   </parent>
   <artifactId>app-alarm-datasouce</artifactId>
   <dependencies>
     <dependency>
-      <groupId>junit</groupId>
-      <artifactId>junit</artifactId>
+      <groupId>org.junit.jupiter</groupId>
+      <artifactId>junit-jupiter</artifactId>
       <version>${junit.version}</version>
       <scope>test</scope>
     </dependency>
@@ -22,32 +22,32 @@
     <dependency>
       <groupId>org.phoebus</groupId>
       <artifactId>core-framework</artifactId>
-      <version>4.7.1-SNAPSHOT</version>
+      <version>4.7.2-SNAPSHOT</version>
     </dependency>
     <dependency>
       <groupId>org.phoebus</groupId>
       <artifactId>core-types</artifactId>
-      <version>4.7.1-SNAPSHOT</version>
+      <version>4.7.2-SNAPSHOT</version>
     </dependency>
     <dependency>
       <groupId>org.phoebus</groupId>
       <artifactId>core-pv</artifactId>
-      <version>4.7.1-SNAPSHOT</version>
+      <version>4.7.2-SNAPSHOT</version>
     </dependency>
     <dependency>
       <groupId>org.phoebus</groupId>
       <artifactId>core-util</artifactId>
-      <version>4.7.1-SNAPSHOT</version>
+      <version>4.7.2-SNAPSHOT</version>
     </dependency>
     <dependency>
       <groupId>org.phoebus</groupId>
       <artifactId>core-ui</artifactId>
-      <version>4.7.1-SNAPSHOT</version>
+      <version>4.7.2-SNAPSHOT</version>
     </dependency>
     <dependency>
       <groupId>org.phoebus</groupId>
       <artifactId>app-alarm-model</artifactId>
-      <version>4.7.1-SNAPSHOT</version>
+      <version>4.7.2-SNAPSHOT</version>
     </dependency>
     <dependency>
         <groupId>net.sf.sociaal</groupId>

app/alarm/datasource/src/main/java/org/phoebus/pv/alarm/AlarmContext.java

@@ -16,6 +16,7 @@
 import java.util.Iterator;
 import java.util.List;
 import java.util.Map;
+import java.util.Set;
 import java.util.logging.Level;
 
 import static org.phoebus.pv.alarm.AlarmPVFactory.logger;
@@ -93,6 +94,8 @@ public static synchronized void releasePV(AlarmPV alarmPV)
                 pvs.remove(alarmPV.getInfo().getCompletePath());
             }
         }
+
+        shutdownClientIfPossbile(alarmPV);
     }
 
     public static synchronized void acknowledgePV(AlarmPV alarmPV, boolean ack)
@@ -297,4 +300,36 @@ static String decodedKafaPath(String path)
     {
         return path.replace("\\/","/");
     }
+
+    /**
+     * Shuts down the alarm client, but only if no other alarm PVs in the same
+     * alarm configuration are found in the list of registered PVs.
+     * @param alarmPV Alarm PV
+     */
+    private static void shutdownClientIfPossbile(AlarmPV alarmPV){
+        String config = alarmPV.getInfo().getRoot();
+        if(!remainingPVsInConfig(config)){
+            AlarmClient alarmClient = alarmModels.get(config);
+            if(alarmClient != null){
+                alarmClient.shutdown();
+                alarmModels.remove(config);
+            }
+        }
+    }
+
+    /**
+     * Checks if the list of registered PVs contains any items for the specified
+     * configuration.
+     * @param config An alarm configuration name, i.e. root of the {@link AlarmPV} path.
+     * @return <code>true</code> if additional PVs are found, otherwise <code>false</code>.
+     */
+    private static boolean remainingPVsInConfig(String config){
+        Set<String> pvNames = pvs.keySet();
+        for(String pvName : pvNames){
+            if(pvName.startsWith("/" + config)){
+                return true;
+            }
+        }
+        return false;
+    }
 }

app/alarm/datasource/src/test/java/org/phoebus/pv/alarm/AlarmContextTest.java

@@ -1,8 +1,8 @@
 package org.phoebus.pv.alarm;
 
-import org.junit.Test;
+import org.junit.jupiter.api.Test;
 
-import static org.junit.Assert.assertEquals;
+import static org.junit.jupiter.api.Assertions.assertEquals;
 
 public class AlarmContextTest {
 
@@ -17,9 +17,18 @@ public void testURLEncoding()
         String encodedPathWithColon = "OPR/TEST/SR%3Atest%3Apv";
         String encodedPathWithDelimiterAndColon = "OPR/TEST/sim%3A%2F%2FSR%3Atest%3Apv";
 
-        assertEquals("Failed to encode pv name the delimiter", encodedPathWithDelimiter, AlarmContext.encodedURLPath(pathWithDelimiter));
-        assertEquals("Failed to encode pv name with colon", encodedPathWithColon, AlarmContext.encodedURLPath(pathWithColon));
-        assertEquals("Failed to encode pv name with delimiter and colon", encodedPathWithDelimiterAndColon, AlarmContext.encodedURLPath(pathWithDelimiterAndColon));
+        assertEquals(
+                encodedPathWithDelimiter,
+                AlarmContext.encodedURLPath(pathWithDelimiter),
+                "Failed to encode pv name the delimiter");
+        assertEquals(
+                encodedPathWithColon,
+                AlarmContext.encodedURLPath(pathWithColon),
+                "Failed to encode pv name with colon");
+        assertEquals(
+                encodedPathWithDelimiterAndColon,
+                AlarmContext.encodedURLPath(pathWithDelimiterAndColon),
+                "Failed to encode pv name with delimiter and colon");
     }
 
     @Test
@@ -33,27 +42,20 @@ public void testURLDecoding()
         String encodedPathWithColon = "OPR/TEST/SR%3Atest%3Apv";
         String encodedPathWithDelimiterAndColon = "OPR/TEST/sim%3A%2F%2FSR%3Atest%3Apv";
 
-        assertEquals("Failed to decode pv name the delimiter", pathWithDelimiter, AlarmContext.decodedURLPath(encodedPathWithDelimiter));
-        assertEquals("Failed to decode pv name with colon", pathWithColon, AlarmContext.decodedURLPath(encodedPathWithColon));
-        assertEquals("Failed to decode pv name with delimiter and colon", pathWithDelimiterAndColon, AlarmContext.decodedURLPath(encodedPathWithDelimiterAndColon));
+        assertEquals(
+                pathWithDelimiter,
+                AlarmContext.decodedURLPath(encodedPathWithDelimiter),
+                "Failed to decode pv name the delimiter");
+        assertEquals(
+                pathWithColon,
+                AlarmContext.decodedURLPath(encodedPathWithColon),
+                "Failed to decode pv name with colon");
+        assertEquals(
+                pathWithDelimiterAndColon,
+                AlarmContext.decodedURLPath(encodedPathWithDelimiterAndColon),
+                "Failed to decode pv name with delimiter and colon");
     }
 
-//    @Test
-//    public void testKafkaPathEncoding()
-//    {
-//        String pathWithDelimiter = "OPR/TEST/sim://test";
-//        String pathWithColon = "OPR/TEST/SR:test:pv";
-//        String pathWithDelimiterAndColon = "OPR/TEST/sim://SR:test:pv";
-//
-//        String kafkaPathWithDelimiter = "OPR/TEST/sim:\\/\\/test";
-//        String kafkaPathWithColon = "OPR/TEST/SR:test:pv";
-//        String kafkaPathWithDelimiterAndColon = "OPR/TEST/sim:\\/\\/SR:test:pv";
-//
-//        assertEquals("Failed to encode pv kafka path with delimiter", kafkaPathWithDelimiter, AlarmContext.encodedKafkaPath(pathWithDelimiter));
-//        assertEquals("Failed to encode pv kafka path with colon", kafkaPathWithColon, AlarmContext.encodedKafkaPath(pathWithColon));
-//        assertEquals("Failed to encode pv kafka path with delimiter and colon", kafkaPathWithDelimiterAndColon, AlarmContext.encodedKafkaPath(pathWithDelimiterAndColon));
-//    }
-
     @Test
     public void testKafkaPathDecoding()
     {
@@ -65,8 +67,17 @@ public void testKafkaPathDecoding()
         String encodedPathWithColon = "OPR/TEST/SR:test:pv";
         String encodedPathWithDelimiterAndColon = "OPR/TEST/sim:\\/\\/SR:test:pv";
 
-        assertEquals("Failed to decode pv kafka path the delimiter", pathWithDelimiter, AlarmContext.decodedKafaPath(encodedPathWithDelimiter));
-        assertEquals("Failed to decode pv kafka path with colon", pathWithColon, AlarmContext.decodedKafaPath(encodedPathWithColon));
-        assertEquals("Failed to decode pv kafka path with delimiter and colon", pathWithDelimiterAndColon, AlarmContext.decodedKafaPath(encodedPathWithDelimiterAndColon));
+        assertEquals(
+                pathWithDelimiter,
+                AlarmContext.decodedKafaPath(encodedPathWithDelimiter),
+                "Failed to decode pv kafka path the delimiter");
+        assertEquals(
+                pathWithColon,
+                AlarmContext.decodedKafaPath(encodedPathWithColon),
+                "Failed to decode pv kafka path with colon");
+        assertEquals(
+                pathWithDelimiterAndColon,
+                AlarmContext.decodedKafaPath(encodedPathWithDelimiterAndColon),
+                "Failed to decode pv kafka path with delimiter and colon");
     }
 }