Merge pull request #131 from jacomago/empty-default-archiver

Allow setting the default archiver to ''

Author: shroffk

src/main/java/org/phoebus/channelfinder/processors/AAChannelProcessor.java

@@ -5,6 +5,7 @@
 import com.fasterxml.jackson.core.JsonProcessingException;
 import com.fasterxml.jackson.core.type.TypeReference;
 import com.fasterxml.jackson.databind.ObjectMapper;
+import org.apache.commons.lang3.StringUtils;
 import org.phoebus.channelfinder.entity.Channel;
 import org.phoebus.channelfinder.entity.Property;
 import org.springframework.beans.factory.annotation.Value;
@@ -70,10 +71,24 @@ public boolean enabled() {
     }
 
     @Override
-    public String processorName() {
-        return "Process " + archivePropertyName + " properties on channels";
+    public String processorInfo() {
+        Map<String, String> processorProperties = Map.of("archiveProperty", archivePropertyName,
+                "archiverProperty", archiverPropertyName,
+                "Archivers", aaURLs.keySet().toString(),
+                "AutoPauseOn", autoPauseOptions.toString()
+        );
+        return "AAChannelProcessor: ProcessProperties " + processorProperties;
     }
 
+    /**
+     * Processes a list of channels through the archiver workflow.
+     * First the status of each pv is checked against the archiver.
+     * If the pv is not being archived and is not paused then the pv will be submitted to be archived.
+     * If the pvStatus auto pause is set, then the pv will be auto pause resumed as well.
+     *
+     * @param channels List of channels
+     * @throws JsonProcessingException If processing archiver responses fail.
+     */
     @Override
     public void process(List<Channel> channels) throws JsonProcessingException {
         if (channels.isEmpty()) {
@@ -140,6 +155,10 @@ private ArchiveAction pickArchiveAction(String archiveStatus, String pvStatus) {
 
     private Map<ArchiveAction, List<ArchivePV>> getArchiveActions(
             Map<String, ArchivePV> archivePVS, String archiverURL) {
+        if (StringUtils.isEmpty(archiverURL)) {
+            return Map.of();
+        }
+
         logger.log(Level.INFO, () -> String.format("Get archiver status in archiver %s", archiverURL));
 
         Map<ArchiveAction, List<ArchivePV>> result = new EnumMap<>(ArchiveAction.class);
@@ -180,7 +199,7 @@ private Map<ArchiveAction, List<ArchivePV>> getArchiveActions(
 
         } catch (JsonProcessingException e) {
             // problem collecting policies from AA, so warn and return empty list
-            logger.log(Level.WARNING, "Could not get AA pv Status list: " + e.getMessage());
+            logger.log(Level.WARNING, () -> "Could not get AA pv Status list: " + e.getMessage());
             return result;
         }
     }
@@ -257,13 +276,16 @@ private void submitAction(String values, String endpoint, String aaURL) {
 
     private Map<String, List<String>> getAAsPolicies(Map<String, String> aaURLs) {
         Map<String, List<String>> result = new HashMap<>();
-        for (String aaAlias : aaURLs.keySet()) {
-            result.put(aaAlias, getAAPolicies(aaURLs.get(aaAlias)));
+        for (Map.Entry<String, String> aa : aaURLs.entrySet()) {
+            result.put(aa.getKey(), getAAPolicies(aa.getValue()));
         }
         return result;
     }
 
     private List<String> getAAPolicies(String aaURL) {
+        if (StringUtils.isEmpty(aaURL)) {
+            return List.of();
+        }
         try {
             String response = client.get()
                     .uri(URI.create(aaURL + POLICY_RESOURCE))

src/main/java/org/phoebus/channelfinder/processors/ChannelProcessor.java

@@ -9,7 +9,7 @@ public interface ChannelProcessor {
 
     boolean enabled();
 
-    String processorName();
+    String processorInfo();
 
     void process(List<Channel> channels) throws JsonProcessingException;
 

src/main/java/org/phoebus/channelfinder/processors/ChannelProcessorManager.java

@@ -55,7 +55,7 @@ public long processorCount() {
 
     @GetMapping("/info")
     public List<String> processorInfo() {
-        return channelProcessorService.getProcessorsNames();
+        return channelProcessorService.getProcessorsInfo();
     }
 
     @PutMapping("/process/all")

src/main/java/org/phoebus/channelfinder/processors/ChannelProcessorService.java

@@ -25,8 +25,8 @@ long getProcessorCount() {
         return channelProcessors.size();
     }
 
-    List<String> getProcessorsNames() {
-        return channelProcessors.stream().map(ChannelProcessor::processorName).collect(Collectors.toList());
+    List<String> getProcessorsInfo() {
+        return channelProcessors.stream().map(ChannelProcessor::processorInfo).collect(Collectors.toList());
     }
 
     /**

src/test/java/org/phoebus/channelfinder/processors/AAChannelProcessorNoDefaultIT.java

@@ -0,0 +1,84 @@
+package org.phoebus.channelfinder.processors;
+
+import com.fasterxml.jackson.core.JsonProcessingException;
+import com.fasterxml.jackson.databind.ObjectMapper;
+import okhttp3.mockwebserver.MockWebServer;
+import org.junit.jupiter.api.AfterEach;
+import org.junit.jupiter.api.BeforeEach;
+import org.junit.jupiter.params.ParameterizedTest;
+import org.junit.jupiter.params.provider.Arguments;
+import org.junit.jupiter.params.provider.MethodSource;
+import org.phoebus.channelfinder.entity.Channel;
+import org.phoebus.channelfinder.entity.Property;
+import org.springframework.beans.factory.annotation.Autowired;
+import org.springframework.boot.test.autoconfigure.web.servlet.WebMvcTest;
+import org.springframework.test.context.TestPropertySource;
+
+import java.io.IOException;
+import java.util.List;
+import java.util.stream.Stream;
+
+import static org.phoebus.channelfinder.processors.AAChannelProcessorIT.activeProperty;
+import static org.phoebus.channelfinder.processors.AAChannelProcessorIT.archiveProperty;
+import static org.phoebus.channelfinder.processors.AAChannelProcessorIT.inactiveProperty;
+import static org.phoebus.channelfinder.processors.AAChannelProcessorIT.paramableAAChannelProcessorTest;
+
+@WebMvcTest(AAChannelProcessor.class)
+@TestPropertySource(locations = "classpath:application_test.properties", properties = "aa.urls:{'default': '','aa': 'http://localhost:17665'}")
+class AAChannelProcessorNoDefaultIT {
+    protected static Property archiverProperty = new Property("archiver", "owner", "aa");
+
+    @Autowired
+    AAChannelProcessor aaChannelProcessor;
+
+    MockWebServer mockArchiverAppliance;
+    ObjectMapper objectMapper;
+
+    private static Stream<Arguments> processNoPauseSource() {
+
+        return Stream.of(
+                Arguments.of(
+                        new Channel("PVNoneActive", "owner", List.of(archiveProperty, activeProperty), List.of()),
+                        "",
+                        "",
+                        ""),
+                Arguments.of(
+                        new Channel("PVNoneActiveArchiver", "owner", List.of(archiveProperty, activeProperty, archiverProperty), List.of()),
+                        "Not being archived",
+                        "archivePV",
+                        "[{\"pv\":\"PVNoneActiveArchiver\"}]")
+        );
+    }
+
+    @BeforeEach
+    void setUp() throws IOException {
+        mockArchiverAppliance = new MockWebServer();
+        mockArchiverAppliance.start(17665);
+
+        objectMapper = new ObjectMapper();
+    }
+
+    @AfterEach
+    void teardown() throws IOException {
+        mockArchiverAppliance.shutdown();
+    }
+
+    @ParameterizedTest
+    @MethodSource("processNoPauseSource")
+    void testProcessNotArchivedActive(
+            Channel channel,
+            String archiveStatus,
+            String archiverEndpoint,
+            String submissionBody)
+            throws JsonProcessingException, InterruptedException {
+        paramableAAChannelProcessorTest(
+                mockArchiverAppliance,
+                objectMapper,
+                aaChannelProcessor,
+                channel,
+                archiveStatus,
+                archiverEndpoint,
+                submissionBody
+                );
+    }
+}