added timeout to database config, refactorings

Author: TomBlock

CHANGES.md

@@ -7,6 +7,7 @@
 * added option for IngestionTool to update already existing entries
 * changed database to use relative archive paths and added migration tool
 * updated SLSTR reader to allow switching geo-coding source between tie-point/pixel
+* added database timeout to configuration
 
 ### Updates from version 1.5.4 to 1.5.5
 * updated to use SNAP version 8.0.9 / S3TBX version 8.0.6

MMS_Manual_v_1_5.pdf

@@ -43,7 +43,8 @@ abstract class AbstractDriver implements Driver {
     Connection connection;
 
     @Override
-    public void open(BasicDataSource dataSource) throws SQLException {
+    public void open(DatabaseConfig databaseConfig) throws SQLException {
+        final BasicDataSource dataSource = databaseConfig.getDataSource();
         try {
             final java.sql.Driver driverClass = (java.sql.Driver) Class.forName(dataSource.getDriverClassName()).newInstance();
             DriverManager.registerDriver(driverClass);

core/src/main/java/com/bc/fiduceo/db/AbstractDriver.java

@@ -21,10 +21,12 @@
 package com.bc.fiduceo.db;
 
 import org.apache.commons.dbcp2.BasicDataSource;
+import org.esa.snap.core.util.StringUtils;
 
 import java.io.File;
 import java.io.FileInputStream;
 import java.io.IOException;
+import java.sql.SQLException;
 import java.util.Properties;
 
 public class DatabaseConfig {
@@ -60,4 +62,26 @@ public BasicDataSource getDataSource() {
 
         return dataSource;
     }
+
+    public void setDataSource(BasicDataSource dataSource) {
+        final String driverClassName = dataSource.getDriverClassName();
+        final String url = dataSource.getUrl();
+        final String username = dataSource.getUsername();
+        final String password = dataSource.getPassword();
+        if (StringUtils.isNullOrEmpty(driverClassName) |
+                StringUtils.isNullOrEmpty(url) |
+                StringUtils.isNullOrEmpty(username) |
+                password == null) {
+            throw new IllegalArgumentException("incomplete database configuration");
+        }
+        properties.setProperty("driverClassName", driverClassName);
+        properties.setProperty("url", url);
+        properties.setProperty("username", username);
+        properties.setProperty("password", password);
+    }
+
+    public int getTimeoutInSeconds() {
+        final String timeout = properties.getProperty("timeout", "120");
+        return Integer.parseInt(timeout);
+    }
 }

core/src/main/java/com/bc/fiduceo/db/DatabaseConfig.java

@@ -240,7 +240,7 @@ private void initialize(CommandLine commandLine) throws IOException, SQLExceptio
         final SystemConfig systemConfig = SystemConfig.loadFrom(confDirPath.toFile());
         final GeometryFactory geometryFactory = new GeometryFactory(systemConfig.getGeometryLibraryType());
 
-        storage = Storage.create(databaseConfig.getDataSource(), geometryFactory);
+        storage = Storage.create(databaseConfig, geometryFactory);
         if (!storage.isInitialized()) {
             storage.initialize();
         }

core/src/main/java/com/bc/fiduceo/db/DbMaintenanceTool.java

@@ -25,7 +25,6 @@
 import com.bc.fiduceo.core.SatelliteObservation;
 import com.bc.fiduceo.core.Sensor;
 import com.bc.fiduceo.geometry.GeometryFactory;
-import org.apache.commons.dbcp2.BasicDataSource;
 
 import java.sql.SQLException;
 import java.util.List;
@@ -42,7 +41,7 @@ public interface Driver {
 
     void setGeometryFactory(GeometryFactory geometryFactory);
 
-    void open(BasicDataSource dataSource) throws SQLException;
+    void open(DatabaseConfig databaseConfig) throws SQLException;
 
     boolean isInitialized() throws SQLException;
 
@@ -55,7 +54,7 @@ public interface Driver {
     void insert(SatelliteObservation satelliteObservation) throws SQLException;
 
     void update(SatelliteObservation satelliteObservation) throws SQLException;
-    
+
     AbstractBatch updatePathBatch(SatelliteObservation satelliteObservation, String newPath, AbstractBatch batch) throws SQLException;
 
     void commitBatch(AbstractBatch batch) throws SQLException;

core/src/main/java/com/bc/fiduceo/db/Driver.java

@@ -66,15 +66,18 @@ public String getUrlPattern() {
     }
 
     @Override
-    public void open(BasicDataSource dataSource) {
+    public void open(DatabaseConfig databaseConfig) throws SQLException {
+        final BasicDataSource dataSource = databaseConfig.getDataSource();
         final String address = parseAddress(dataSource.getUrl());
         final String port = parsePort(dataSource.getUrl());
         final ServerAddress serverAddress = new ServerAddress(address, Integer.parseInt(port));
 
+        final int timeoutInMillis = databaseConfig.getTimeoutInSeconds() * 1000;
+
         final MongoClientOptions clientOptions = MongoClientOptions.builder().
-                connectTimeout(120000).
-                socketTimeout(120000).
-                serverSelectionTimeout(120000).build();
+                connectTimeout(timeoutInMillis).
+                socketTimeout(timeoutInMillis).
+                serverSelectionTimeout(timeoutInMillis).build();
 
         final String username = dataSource.getUsername();
         final String password = dataSource.getPassword();

core/src/main/java/com/bc/fiduceo/db/MongoDbDriver.java

@@ -52,7 +52,8 @@ public void setGeometryFactory(GeometryFactory geometryFactory) {
     }
 
     @Override
-    public void open(BasicDataSource dataSource) throws SQLException {
+    public void open(DatabaseConfig databaseConfig) throws SQLException {
+        final BasicDataSource dataSource = databaseConfig.getDataSource();
         try {
             final java.sql.Driver driverClass = (java.sql.Driver) Class.forName(dataSource.getDriverClassName()).newInstance();
             DriverManager.registerDriver(driverClass);
@@ -64,8 +65,8 @@ public void open(BasicDataSource dataSource) throws SQLException {
         final Properties properties = new Properties();
         properties.put("user", dataSource.getUsername());
         properties.put("password", dataSource.getPassword());
-        properties.put("loginTimeout", "120");
-        properties.put("connectTimeout", "120");
+        properties.put("loginTimeout", databaseConfig.getTimeoutInSeconds());
+        properties.put("connectTimeout", databaseConfig.getTimeoutInSeconds());
 
         connection = DriverManager.getConnection(url, properties);
         connection.setAutoCommit(false);

core/src/main/java/com/bc/fiduceo/db/PostGISDriver.java

@@ -34,8 +34,8 @@ public class Storage {
 
     private Driver driver;
 
-    public static Storage create(BasicDataSource dataSource, GeometryFactory geometryFactory) throws SQLException {
-        return new Storage(dataSource, geometryFactory);
+    public static Storage create(DatabaseConfig databaseConfig, GeometryFactory geometryFactory) throws SQLException {
+        return new Storage(databaseConfig, geometryFactory);
     }
 
     public void close() throws SQLException {
@@ -88,10 +88,10 @@ public int insert(Sensor sensor) throws SQLException {
         return driver.insert(sensor);
     }
 
-    private Storage(BasicDataSource dataSource, GeometryFactory geometryFactory) throws SQLException {
-        driver = createDriver(dataSource);
+    private Storage(DatabaseConfig databaseConfig, GeometryFactory geometryFactory) throws SQLException {
+        driver = createDriver(databaseConfig.getDataSource());
         driver.setGeometryFactory(geometryFactory);
-        driver.open(dataSource);
+        driver.open(databaseConfig);
     }
 
     public boolean isAlreadyRegistered(QueryParameter queryParameter) throws SQLException {

core/src/main/java/com/bc/fiduceo/db/Storage.java

@@ -31,10 +31,9 @@
 import java.io.File;
 import java.io.IOException;
 import java.io.PrintWriter;
+import java.sql.SQLException;
 
-import static org.junit.Assert.assertEquals;
-import static org.junit.Assert.assertNotNull;
-import static org.junit.Assert.fail;
+import static org.junit.Assert.*;
 
 @RunWith(IOTestRunner.class)
 public class DatabaseConfigTest {
@@ -54,7 +53,7 @@ public void tearDown() {
     }
 
     @Test
-    public void testLoadAndGetDataSource() throws IOException {
+    public void testLoadAndGetDataSource() throws IOException, SQLException {
         final File databaseConfigFile = TestUtil.createFileInTestDir("database.properties");
 
         final PrintWriter printWriter = new PrintWriter(databaseConfigFile);
@@ -74,6 +73,35 @@ public void testLoadAndGetDataSource() throws IOException {
         assertEquals("pass-word", dataSource.getPassword());
     }
 
+    @Test
+    public void testLoadAndGetTimeout() throws IOException {
+        final File databaseConfigFile = TestUtil.createFileInTestDir("database.properties");
+
+        final PrintWriter printWriter = new PrintWriter(databaseConfigFile);
+        printWriter.write("timeout = 654");
+        printWriter.close();
+
+        databaseConfig.loadFrom(testDirectory);
+
+        assertEquals(654, databaseConfig.getTimeoutInSeconds());
+    }
+
+    @Test
+    public void testLoadAndGetTimeout_default() throws IOException {
+        final File databaseConfigFile = TestUtil.createFileInTestDir("database.properties");
+
+        final PrintWriter printWriter = new PrintWriter(databaseConfigFile);
+        printWriter.write("driverClassName = driver-class\n");
+        printWriter.write("url = database-url\n");
+        printWriter.write("username = user-name\n");
+        printWriter.write("password = pass-word");
+        printWriter.close();
+
+        databaseConfig.loadFrom(testDirectory);
+
+        assertEquals(120, databaseConfig.getTimeoutInSeconds());
+    }
+
     @Test
     public void testLoad_throwsWhenFileNotPresent() throws IOException {
         try {
@@ -84,7 +112,7 @@ public void testLoad_throwsWhenFileNotPresent() throws IOException {
     }
 
     @Test
-    public void testGetDatasource_throwsWhenNotLoaded() {
+    public void testGetDatasource_throwsWhenNotLoaded() throws SQLException {
         try {
             databaseConfig.getDataSource();
             fail("RuntimeException expected");