Merge pull request #92 from meldsun0/79-passing-data-dir-as-a-command-line-option

Adding --data-path option

Author: meldsun0

core/src/main/java/samba/cli/SambaCommand.java

@@ -3,12 +3,14 @@
 import samba.Samba;
 import samba.config.InvalidConfigurationException;
 import samba.config.SambaConfiguration;
+import samba.config.StorageConfig;
 import samba.network.NetworkType;
 import samba.samba.exceptions.ExceptionUtil;
 import samba.services.discovery.Bootnodes;
 import samba.storage.DatabaseStorageException;
 
 import java.io.PrintWriter;
+import java.nio.file.Path;
 import java.util.List;
 import java.util.Map;
 import java.util.Optional;
@@ -76,6 +78,13 @@ public class SambaCommand implements Callable<Integer> {
       arity = "1")
   private String jsonRpcHost = null;
 
+  @CommandLine.Option(
+      names = {"--data-path"},
+      paramLabel = "<PATH>",
+      description = "The path to Samba data directory",
+      arity = "1")
+  final Path dataPath = StorageConfig.getDefaultSambaDataPath(this);
+
   public SambaCommand(
       final PrintWriter outputWriter,
       final PrintWriter errorWriter,
@@ -112,6 +121,12 @@ protected SambaConfiguration sambaConfiguration() {
               discoveryConfig.networkInterfaces(p2pIps);
             }
           });
+      builder.storage(
+          storageConfig -> {
+            if (dataPath != null) {
+              storageConfig.dataPath(dataPath);
+            }
+          });
       builder.jsonRpc(
           jsonRpc -> {
             if (jsonRpcPort != null) {
@@ -121,6 +136,7 @@ protected SambaConfiguration sambaConfiguration() {
               jsonRpc.setHost(jsonRpcHost);
             }
           });
+
       if (unsafePrivateKey != null) {
         builder.secretKey(unsafePrivateKey);
       }

core/src/main/java/samba/config/SambaConfiguration.java

@@ -18,20 +18,23 @@ public class SambaConfiguration {
   private final MetricsConfig metricsConfig;
   private final PortalRestApiConfig portalRestApiConfig;
   private final DiscoveryConfig discoveryConfig;
-  private final JsonRpcConfiguration jsonRpcConfigurationn;
+  private final StorageConfig storageConfig;
+  private final JsonRpcConfiguration jsonRpcConfiguration;
 
   private final SECP256K1.SecretKey secretKey;
 
   private SambaConfiguration(
       final MetricsConfig metricsConfig,
       final PortalRestApiConfig portalRestApiConfig,
       final DiscoveryConfig discoveryConfig,
-      final JsonRpcConfiguration jsonRpcConfigurationn,
+      final JsonRpcConfiguration jsonRpcConfiguration,
+      final StorageConfig storageConfig,
       final SECP256K1.SecretKey secretKey) {
     this.metricsConfig = metricsConfig;
     this.portalRestApiConfig = portalRestApiConfig;
-    this.jsonRpcConfigurationn = jsonRpcConfigurationn;
     this.discoveryConfig = discoveryConfig;
+    this.jsonRpcConfiguration = jsonRpcConfiguration;
+    this.storageConfig = storageConfig;
     this.secretKey = secretKey;
   }
 
@@ -51,19 +54,24 @@ public DiscoveryConfig getDiscoveryConfig() {
     return discoveryConfig;
   }
 
+  public StorageConfig getStorageConfig() {
+    return storageConfig;
+  }
+
   public SECP256K1.SecretKey getSecreteKey() {
     return secretKey;
   }
 
   public JsonRpcConfiguration getJsonRpcConfigurationn() {
-    return jsonRpcConfigurationn;
+    return jsonRpcConfiguration;
   }
 
   public static class Builder {
     private final MetricsConfig.MetricsConfigBuilder metricsConfigBuilder = MetricsConfig.builder();
     private final PortalRestApiConfig.PortalRestApiConfigBuilder portalRestApiConfigBuilder =
         PortalRestApiConfig.builder();
     private final DiscoveryConfig.Builder discoveryConfigBuilder = DiscoveryConfig.builder();
+    private final StorageConfig.Builder storageConfigBuilder = StorageConfig.builder();
     private final JsonRpcConfiguration jsonRpcConfiguration =
         JsonRpcConfiguration
             .createDefault(); // TODO change this once JsonConfiguration is turned into a builder
@@ -82,6 +90,7 @@ public SambaConfiguration build() {
           portalRestApiConfigBuilder.build(),
           discoveryConfigBuilder.build(),
           jsonRpcConfiguration, // TODO change this once JsonConfiguration is turned into a builder
+          storageConfigBuilder.build(),
           secretKey.get());
     }
 
@@ -113,6 +122,11 @@ public Builder jsonRpc(final Consumer<JsonRpcConfiguration> jsonRpcConfiguration
       return this;
     }
 
+    public Builder storage(final Consumer<StorageConfig.Builder> storageConfigConsumer) {
+      storageConfigConsumer.accept(storageConfigBuilder);
+      return this;
+    }
+
     public Builder secretKey(final String secretKey) {
       checkNotNull(secretKey);
       final Bytes32 secretKeyInBytes = Bytes32.fromHexString(secretKey);

core/src/main/java/samba/config/StorageConfig.java

@@ -1,15 +1,92 @@
 package samba.config;
 
+import static com.google.common.base.Preconditions.checkNotNull;
+
+import java.io.File;
+import java.io.IOException;
+import java.nio.file.FileAlreadyExistsException;
+import java.nio.file.Files;
+import java.nio.file.InvalidPathException;
+import java.nio.file.Path;
+import java.nio.file.Paths;
+
+import org.slf4j.Logger;
+import org.slf4j.LoggerFactory;
+import picocli.CommandLine;
+
 public class StorageConfig {
 
-  public static final long DEFAULT_STORAGE_FREQUENCY = 2048L;
-  private final long dataStorageFrequency;
+  public static final String DEFAULT_DATA_DIR_PATH = "./build/data";
+  private static String SAMBA_HOME_PROPERTY_NAME = "samba.home";
+
+  private final Path dataPath;
+  private static final Logger LOG = LoggerFactory.getLogger(StorageConfig.class);
+
+  public StorageConfig(final Path dataPath) {
+    this.dataPath = dataPath;
+  }
+
+  public static Builder builder() {
+    return new Builder();
+  }
+
+  public static Path getDefaultSambaDataPath(final Object command) {
+    final String sambaHomeProperty = System.getProperty(SAMBA_HOME_PROPERTY_NAME);
+    final Path sambaHome;
+    if (sambaHomeProperty != null) {
+      try {
+        sambaHome = Paths.get(sambaHomeProperty);
+      } catch (final InvalidPathException e) {
+        throw new CommandLine.ParameterException(
+            new CommandLine(command),
+            String.format(
+                "Unable to define default data directory from %s property.",
+                SAMBA_HOME_PROPERTY_NAME),
+            e);
+      }
+    } else {
+      try {
+        final String path = new File(DEFAULT_DATA_DIR_PATH).getCanonicalPath();
+        sambaHome = Paths.get(path);
+      } catch (final IOException e) {
+        throw new CommandLine.ParameterException(
+            new CommandLine(command), "Unable to create default data directory.");
+      }
+    }
+    try {
+      Files.createDirectories(sambaHome);
+    } catch (final FileAlreadyExistsException e) {
+      throw new CommandLine.ParameterException(
+          new CommandLine(command),
+          String.format("%s: already exists and is not a directory.", sambaHome.toAbsolutePath()),
+          e);
+    } catch (final Exception e) {
+      throw new CommandLine.ParameterException(
+          new CommandLine(command),
+          String.format("Error creating directory %s.", sambaHome.toAbsolutePath()),
+          e);
+    }
+    return sambaHome;
+  }
 
-  public StorageConfig(final long dataStorageFrequency) {
-    this.dataStorageFrequency = dataStorageFrequency;
+  public Path getDataPath() {
+    return this.dataPath;
   }
 
-  public long getDataStorageFrequency() {
-    return dataStorageFrequency;
+  public static class Builder {
+
+    private Path dataPath;
+
+    private Builder() {}
+
+    public StorageConfig build() {
+      return new StorageConfig(dataPath);
+    }
+
+    public Builder dataPath(final Path dataPath) {
+      checkNotNull(dataPath);
+      this.dataPath = dataPath;
+      return this;
+    }
   }
 }

core/src/main/java/samba/services/PortalNodeMainService.java

@@ -39,7 +39,6 @@
 import samba.services.utp.UTPManager;
 import samba.storage.HistoryRocksDB;
 
-import java.nio.file.Paths;
 import java.util.HashMap;
 import java.util.Map;
 import java.util.Optional;
@@ -181,7 +180,8 @@ private void initHistoryNetwork() {
     this.historyNetwork =
         new HistoryNetwork(
             this.discoveryService,
-            HistoryRocksDB.create(metricsSystem, Paths.get("samba/db")),
+            HistoryRocksDB.create(
+                metricsSystem, sambaConfiguration.getStorageConfig().getDataPath()),
             this.utpManager);
   }