Merge pull request 'sonar_qf' (#6) from sonar_qf into develop

Reviewed-on: https://gitea.intranda.com/goobi-viewer/goobi-viewer-connector/pulls/6

Author: janvonde

goobi-viewer-connector/src/main/java/io/goobi/viewer/connector/utils/Configuration.java

@@ -29,8 +29,6 @@
 import org.apache.commons.configuration2.builder.ReloadingFileBasedConfigurationBuilder;
 import org.apache.commons.configuration2.builder.fluent.Parameters;
 import org.apache.commons.configuration2.convert.DefaultListDelimiterHandler;
-import org.apache.commons.configuration2.event.Event;
-import org.apache.commons.configuration2.event.EventListener;
 import org.apache.commons.configuration2.ex.ConfigurationException;
 import org.apache.commons.configuration2.ex.ConversionException;
 import org.apache.commons.configuration2.tree.ImmutableNode;
@@ -70,7 +68,6 @@ public final class Configuration {
      *
      * @param configPath a {@link java.lang.String} object.
      */
-    @SuppressWarnings({ "unchecked", "rawtypes" })
     public Configuration(String configPath) {
         // Load default configuration
         builder =
@@ -88,13 +85,7 @@ public Configuration(String configPath) {
                 logger.error(e.getMessage(), e);
             }
             builder.addEventListener(ConfigurationBuilderEvent.CONFIGURATION_REQUEST,
-                    new EventListener() {
-
-                        @Override
-                        public void onEvent(Event event) {
-                            builder.getReloadingController().checkForReloading(null);
-                        }
-                    });
+                    event -> builder.getReloadingController().checkForReloading(null));
         } else {
             logger.error("Default Connector configuration file not found: {}; Base path is {}",
                     builder.getFileHandler().getFile().getAbsoluteFile(),
@@ -117,13 +108,7 @@ public void onEvent(Event event) {
                 logger.error("{} ({})", e.getMessage(), fileLocal.getAbsolutePath(), e);
             }
             builderLocal.addEventListener(ConfigurationBuilderEvent.CONFIGURATION_REQUEST,
-                    new EventListener() {
-
-                        @Override
-                        public void onEvent(Event event) {
-                            builderLocal.getReloadingController().checkForReloading(null);
-                        }
-                    });
+                    event -> builderLocal.getReloadingController().checkForReloading(null));
         }
     }
 
@@ -820,4 +805,14 @@ private static List<Metadata> getMetadataForTemplate(HierarchicalConfiguration u
 
         return ret;
     }
+
+    /**
+     * Overrides values in the config file (for unit test purposes).
+     *
+     * @param property Property path (e.g. "accessConditions.fullAccessForLocalhost")
+     * @param value New value to set
+     */
+    public void overrideValue(String property, Object value) {
+        getConfig().setProperty(property, value);
+    }
 }

goobi-viewer-connector/src/main/java/io/goobi/viewer/connector/utils/SolrSearchIndex.java

@@ -69,7 +69,7 @@ public class SolrSearchIndex {
     private long lastPing = 0;
 
     private SolrClient client;
-    private final boolean testMode;
+    private boolean testMode;
 
     /**
      * <p>
@@ -94,6 +94,9 @@ public SolrSearchIndex(SolrClient client, boolean testMode) {
 
     /**
      * Checks whether the server's configured URL matches that in the config file. If not, a new server instance is created.
+     * 
+     * @should create new client if solr url changed
+     * @should ping server if last ping too old
      */
     public void checkReloadNeeded() {
         if (testMode || !(client instanceof Http2SolrClient)) {
@@ -648,4 +651,49 @@ public Map<Integer, String> getFulltextFileNames(String pi) throws SolrServerExc
 
         return Collections.emptyMap();
     }
+
+    /**
+     * Getter for tests.
+     * 
+     * @return the lastPing
+     */
+    long getLastPing() {
+        return lastPing;
+    }
+
+    /**
+     * Setter for tests.
+     * 
+     * @param lastPing the lastPing to set
+     */
+    void setLastPing(long lastPing) {
+        this.lastPing = lastPing;
+    }
+
+    /**
+     * Getter for tests.
+     * 
+     * @return the client
+     */
+    SolrClient getClient() {
+        return client;
+    }
+
+    /**
+     * Getter for tests.
+     * 
+     * @return the testMode
+     */
+    boolean isTestMode() {
+        return testMode;
+    }
+
+    /**
+     * Setter for tests.
+     * 
+     * @param testMode the testMode to set
+     */
+    void setTestMode(boolean testMode) {
+        this.testMode = testMode;
+    }
 }

goobi-viewer-connector/src/test/java/io/goobi/viewer/connector/AbstractSolrEnabledTest.java

@@ -26,15 +26,15 @@
  */
 public abstract class AbstractSolrEnabledTest extends AbstractTest {
 
-    private static final String SOLR_TEST_URL = "https://viewer-testing-index.goobi.io/solr/collection1";
+    public static final String SOLR_TEST_URL = "https://viewer-testing-index.goobi.io/solr/collection1";
 
     @BeforeAll
     public static void setUpClass() throws Exception {
         AbstractTest.setUpClass();
     }
 
     @BeforeEach
-    public void setUp() throws Exception {
+    public void setUp() {
         SolrClient client = SolrSearchIndex.getNewSolrClient(SOLR_TEST_URL);
         DataManager.getInstance().injectSearchIndex(new SolrSearchIndex(client, true));
     }

goobi-viewer-connector/src/test/java/io/goobi/viewer/connector/utils/ConfigurationTest.java

@@ -22,6 +22,7 @@
 import org.junit.jupiter.api.Assertions;
 import org.junit.jupiter.api.Test;
 
+import io.goobi.viewer.connector.AbstractSolrEnabledTest;
 import io.goobi.viewer.connector.AbstractTest;
 import io.goobi.viewer.connector.DataManager;
 import io.goobi.viewer.connector.oai.enums.Metadata;
@@ -131,7 +132,7 @@ void getEseTypes_shouldReturnAllValues() {
      */
     @Test
     void getIndexUrl_shouldReturnCorrectValue() {
-        Assertions.assertEquals("http://localhost:8080/solr", DataManager.getInstance().getConfiguration().getIndexUrl());
+        Assertions.assertEquals(AbstractSolrEnabledTest.SOLR_TEST_URL, DataManager.getInstance().getConfiguration().getIndexUrl());
     }
 
     /**

goobi-viewer-connector/src/test/java/io/goobi/viewer/connector/utils/SolrSearchIndexTest.java

@@ -21,6 +21,7 @@
 
 import org.apache.logging.log4j.LogManager;
 import org.apache.logging.log4j.Logger;
+import org.apache.solr.client.solrj.SolrClient;
 import org.apache.solr.client.solrj.response.QueryResponse;
 import org.apache.solr.common.SolrDocument;
 import org.junit.jupiter.api.Assertions;
@@ -36,6 +37,34 @@ class SolrSearchIndexTest extends AbstractSolrEnabledTest {
     /** Logger for this class. */
     private static final Logger logger = LogManager.getLogger(SolrSearchIndexTest.class);
 
+    /**
+     * @see SolrSearchIndex#checkReloadNeeded()
+     * @verifies create new client if solr url changed
+     */
+    @Test
+    void checkReloadNeeded_shouldCreateNewClientIfSolrUrlChanged() {
+        SolrSearchIndex index = DataManager.getInstance().getSearchIndex();
+        index.setTestMode(false);
+        SolrClient oldClient = index.getClient();
+        Assertions.assertEquals(oldClient, index.getClient());
+        DataManager.getInstance().getConfiguration().overrideValue("solr.solrUrl", "http://localhost:8080/solr");
+        index.checkReloadNeeded();
+        Assertions.assertNotEquals(oldClient, index.getClient());
+    }
+
+    /**
+     * @see SolrSearchIndex#checkReloadNeeded()
+     * @verifies ping server if last ping too old
+     */
+    @Test
+    void checkReloadNeeded_shouldPingServerIfLastPingTooOld() {
+        SolrSearchIndex index = DataManager.getInstance().getSearchIndex();
+        index.setTestMode(false);
+        Assertions.assertEquals(0, index.getLastPing());
+        index.checkReloadNeeded();
+        Assertions.assertNotEquals(0, index.getLastPing());
+    }
+
     /**
      * @see SolrSearchIndex#getSets(String)
      * @verifies return all values

goobi-viewer-connector/src/test/resources/config_oai.test.xml

@@ -43,7 +43,7 @@
 		<!-- Anzahl der Treffer pro Seite -->
 		<hitsPerToken>23</hitsPerToken>
 		<!-- URL zum Index -->
-		<solrUrl>http://localhost:8080/solr</solrUrl>
+		<solrUrl>https://viewer-testing-index.goobi.io/solr/collection1</solrUrl>
 	</solr>
 	<oaiFolder>src/test/resources/oai/</oaiFolder>
 	<!-- Verzeichnis in dem die resumtionToken gespeichert werden -->