Config migration

modAionImpl/src/org/aion/zero/impl/config/CfgAion.java

@@ -65,6 +65,7 @@ public final class CfgAion extends Cfg {
     public CfgAion() {
         this.mode = "aion";
         this.id = UUID.randomUUID().toString();
+        this.keystorePath = null;
         this.net = new CfgNet();
         this.consensus = new CfgConsensusPow();
         this.sync = new CfgSync();
@@ -139,10 +140,10 @@ private void closeFileInputStream(final FileInputStream fis) {
         }
     }
 
-//    /** @implNote the default fork settings is looking for the fork config of the mainnet. */
-//    public void setForkProperties() {
-//        setForkProperties("mainnet", null);
-//    }
+    //    /** @implNote the default fork settings is looking for the fork config of the mainnet. */
+    //    public void setForkProperties() {
+    //        setForkProperties("mainnet", null);
+    //    }
 
     public void setForkProperties(String networkName, File forkFile) {
         Properties properties = new Properties();
@@ -172,9 +173,9 @@ public void setForkProperties(String networkName, File forkFile) {
         }
     }
 
-//    public void setForkProperties(String networkName) {
-//        setForkProperties(networkName, null);
-//    }
+    //    public void setForkProperties(String networkName) {
+    //        setForkProperties(networkName, null);
+    //    }
 
     public void dbFromXML() {
         File cfgFile = getInitialConfigFile();
@@ -307,6 +308,13 @@ public boolean fromXML(File cfgFile) {
             this.setLogDir(log);
         }
 
+        if (keystorePath != null) {
+            File ks = new File(keystorePath);
+            if (ks.isAbsolute()) {
+                this.setKeystoreDir(ks);
+            }
+        }
+
         return shouldWriteBackToFile;
     }
 
@@ -387,6 +395,13 @@ public void toXML(final String[] args, File file) {
             sw.writeCharacters(this.getId());
             sw.writeEndElement();
 
+            if (keystorePath != null) {
+                sw.writeCharacters("\r\n\t");
+                sw.writeStartElement("keystore");
+                sw.writeCharacters(keystorePath);
+                sw.writeEndElement();
+            }
+
             sw.writeCharacters(this.getApi().toXML());
             sw.writeCharacters(this.getNet().toXML());
             sw.writeCharacters(this.getSync().toXML());

modAionImpl/test/org/aion/zero/impl/cli/CliTest.java

@@ -498,15 +498,13 @@ public void testConfig(String[] input, File expectedFile, String expectedPath) {
 
     /** Parameters for testing {@link #testConfig_oldLocation(String[], String)}. */
     @SuppressWarnings("unused")
-    private Object parametersWithConfigForOldLocation() {
+    private Object parametersWithoutMigration() {
         List<Object> parameters = new ArrayList<>();
 
         String[] options = new String[] {"-c", "--config"};
         String expected = MAIN_BASE_PATH.getAbsolutePath();
 
         for (String op : options) {
-            // without parameter
-            parameters.add(new Object[] {new String[] {op}, BASE_PATH});
             // invalid parameter
             parameters.add(new Object[] {new String[] {op, "invalid"}, expected});
             // mainnet as parameter
@@ -530,7 +528,7 @@ private Object parametersWithConfigForOldLocation() {
      * location.
      */
     @Test
-    @Parameters(method = "parametersWithConfigForOldLocation")
+    @Parameters(method = "parametersWithoutMigration")
     public void testConfig_oldLocation(String[] input, String expectedPath) {
         // ensure config exists on disk at expected location for old kernel
         if (!oldConfig.exists()) {
@@ -542,19 +540,69 @@ public void testConfig_oldLocation(String[] input, String expectedPath) {
             Cli.copyRecursively(genesis, oldGenesis);
         }
 
-
         assertThat(cli.call(input, cfg)).isEqualTo(EXIT);
+
+        // the config used it for mainnet, therefore will use the MAIN_BASE_PATH
         assertThat(cfg.getBasePath()).isEqualTo(expectedPath);
+
         assertThat(cfg.getExecConfigFile())
                 .isEqualTo(new File(expectedPath, "config" + File.separator + configFileName));
         assertThat(cfg.getExecGenesisFile())
                 .isEqualTo(new File(expectedPath, "config" + File.separator + genesisFileName));
 
+        // database, keystore & log are absolute and at old location
+        assertThat(cfg.getDatabaseDir()).isEqualTo(new File(expectedPath, "database"));
+        assertThat(cfg.getLogDir()).isEqualTo(new File(expectedPath, "log"));
+        assertThat(cfg.getKeystoreDir()).isEqualTo(new File(expectedPath, "keystore"));
+
         if (verbose) {
             printPaths(cfg);
         }
     }
 
+    /**
+     * Ensures that the { <i>-c</i>, <i>--config</i> } arguments work when using old config
+     * location.
+     */
+    @Test
+    @Parameters({"-c", "--config"})
+    public void testConfig_withMigration(String option) {
+        // ensure config exists on disk at expected location for old kernel
+        if (!oldConfig.exists()) {
+            File configPath = CONFIG_PATH;
+            if (!configPath.exists()) {
+                assertThat(configPath.mkdirs()).isTrue();
+            }
+            cfg.toXML(null, oldConfig);
+            Cli.copyRecursively(genesis, oldGenesis);
+        }
+
+        assertThat(cli.call(new String[] {option}, cfg)).isEqualTo(EXIT);
+
+        // the config used it for mainnet, therefore will use the MAIN_BASE_PATH
+        assertThat(cfg.getBasePath()).isEqualTo(MAIN_BASE_PATH.getAbsolutePath());
+
+        assertThat(cfg.getInitialConfigFile()).isEqualTo(mainnetConfig);
+        assertThat(cfg.getInitialGenesisFile()).isEqualTo(mainnetGenesis);
+
+        assertThat(cfg.getExecConfigFile())
+                .isEqualTo(new File(MAIN_BASE_PATH, "config" + File.separator + configFileName));
+        assertThat(cfg.getExecGenesisFile())
+                .isEqualTo(new File(MAIN_BASE_PATH, "config" + File.separator + genesisFileName));
+
+        // database, keystore & log are absolute and at old location
+        assertThat(cfg.getDatabaseDir()).isEqualTo(new File(BASE_PATH, "database"));
+        assertThat(cfg.getLogDir()).isEqualTo(new File(BASE_PATH, "log"));
+        assertThat(cfg.getKeystoreDir()).isEqualTo(new File(BASE_PATH, "keystore"));
+
+        if (verbose) {
+            printPaths(cfg);
+        }
+
+        // cleanup: resetting the mainnet config to original
+        Cli.copyRecursively(config, mainnetConfig);
+    }
+
     /** Parameters for testing {@link #testInfo(String[], ReturnType, String)}. */
     @SuppressWarnings("unused")
     private Object parametersWithInfo() {
@@ -659,7 +707,7 @@ public void testInfo(String[] input, ReturnType expectedReturn, String expectedP
      */
     @Test
     @Parameters({"-i", "--info"})
-    public void testInfo_oldLocation(String option) {
+    public void testInfoWithMigration(String option) {
         // ensure config exists on disk at expected location for old kernel
         if (!oldConfig.exists()) {
             File configPath = CONFIG_PATH;
@@ -671,7 +719,15 @@ public void testInfo_oldLocation(String option) {
         }
 
         assertThat(cli.call(new String[] {option}, cfg)).isEqualTo(EXIT);
-        assertThat(cfg.getBasePath()).isEqualTo(BASE_PATH);
+        assertThat(cfg.getBasePath()).isEqualTo(MAIN_BASE_PATH.getAbsolutePath());
+
+        // database, keystore & log are absolute and at old location
+        assertThat(cfg.getDatabaseDir()).isEqualTo(new File(BASE_PATH, "database"));
+        assertThat(cfg.getLogDir()).isEqualTo(new File(BASE_PATH, "log"));
+        assertThat(cfg.getKeystoreDir()).isEqualTo(new File(BASE_PATH, "keystore"));
+
+        // cleanup: resetting the mainnet config to original
+        Cli.copyRecursively(config, mainnetConfig);
     }
 
     /**

modBoot/src/org/aion/Aion.java

@@ -191,14 +191,14 @@ public static void main(String args[]) {
                         + filePath[3]
                         + "\n> Genesis write: "
                         + filePath[4]
-                        + "\n> Fork write: "
+                        + "\n> Fork write:    "
                         + filePath[5]
                         + "\n----------------------------------------------------------------------------"
                         + "\n> Config read:   "
                         + filePath[6]
                         + "\n> Genesis read:  "
                         + filePath[7]
-                        + "\n> Fork read:  "
+                        + "\n> Fork read:     "
                         + filePath[8]
                         + "\n----------------------------------------------------------------------------\n\n";
 

modMcf/src/org/aion/mcf/config/Cfg.java

@@ -24,7 +24,6 @@
 
 import com.google.common.annotations.VisibleForTesting;
 import java.io.File;
-import java.io.IOException;
 import javax.xml.stream.XMLStreamException;
 import javax.xml.stream.XMLStreamReader;
 import org.aion.mcf.types.AbstractBlock;
@@ -36,6 +35,8 @@ public abstract class Cfg {
 
     protected String id;
 
+    protected String keystorePath = null;
+
     protected CfgApi api;
 
     protected CfgNet net;
@@ -157,12 +158,13 @@ public void setConsensus(CfgConsensus _consensus) {
     private File baseGenesisFile = null;
     private File baseForkFile = null;
 
-
     // can be absolute in config file OR depend on execution path
     private File logDir = null;
     private File databaseDir = null;
+    private File keystoreDir = null;
     private boolean absoluteLogDir = false;
     private boolean absoluteDatabaseDir = false;
+    private boolean absoluteKeystoreDir = false;
 
     // impact execution path
     private String network = null;
@@ -185,8 +187,10 @@ public void resetInternal() {
         baseForkFile = null;
         logDir = null;
         databaseDir = null;
+        keystoreDir = null;
         absoluteLogDir = false;
         absoluteDatabaseDir = false;
+        absoluteKeystoreDir = false;
         network = null;
         dataDir = null;
         execDir = null;
@@ -205,15 +209,78 @@ protected void initializeConfiguration() {
         baseConfigFile = new File(CONFIG_DIR, configFileName);
         baseGenesisFile = new File(CONFIG_DIR, genesisFileName);
 
-
         if (!baseConfigFile.exists() || !baseGenesisFile.exists()) {
             updateNetworkExecPaths();
         } else {
-            execDir = INITIAL_PATH;
-            execConfigDir = CONFIG_DIR;
-            execConfigFile = baseConfigFile;
-            execGenesisFile = baseGenesisFile;
-            updateStoragePaths();
+            System.out.println("Migrating to the new configuration style for Aion kernels.");
+
+            // reading the old config to get setup
+            this.fromXML(baseConfigFile);
+
+            // determine the network from the read config
+            switch (this.net.getId()) {
+                case 256:
+                    network = "mainnet";
+                    break;
+                case 128:
+                    network = "conquest";
+                    break;
+                case 32:
+                    network = "mastery";
+                    break;
+                default:
+                    network = "custom";
+                    break;
+            }
+
+            // delete old config
+            try {
+                if (!baseConfigFile.delete()) {
+                    System.out.println(
+                            "Unable to delete old configuration file: "
+                                    + baseConfigFile.getAbsolutePath()
+                                    + ". Please do it manually!");
+                }
+            } catch (Exception e) {
+                System.out.println(
+                        "Unable to delete old configuration file: "
+                                + baseConfigFile.getAbsolutePath()
+                                + ". Please do it manually!");
+            }
+
+            // delete old genesis
+            try {
+                if (!baseGenesisFile.delete()) {
+                    System.out.println(
+                            "Unable to delete old genesis file: "
+                                    + baseGenesisFile.getAbsolutePath()
+                                    + ". Please do it manually!");
+                }
+            } catch (Exception e) {
+                System.out.println(
+                        "Unable to delete old genesis file: "
+                                + baseGenesisFile.getAbsolutePath()
+                                + ". Please do it manually!");
+            }
+
+            // using absolute path for database
+            absoluteDatabaseDir = true;
+            databaseDir = new File(INITIAL_PATH, getDb().getPath());
+            getDb().setPath(databaseDir.getAbsolutePath());
+
+            // using absolute path for log
+            absoluteLogDir = true;
+            logDir = new File(INITIAL_PATH, getLog().getLogPath());
+            getLog().setLogPath(logDir.getAbsolutePath());
+
+            // using absolute path for keystore
+            absoluteKeystoreDir = true;
+            keystoreDir = new File(INITIAL_PATH, keystoreDirName);
+            keystorePath = keystoreDir.getAbsolutePath();
+
+            updateNetworkExecPaths();
+
+            this.toXML(new String[] {}, baseConfigFile);
         }
     }
 
@@ -259,6 +326,18 @@ private void updateStoragePaths() {
         } else if (databaseDir == null) {
             databaseDir = new File(getDb().getPath());
         }
+        if (!absoluteKeystoreDir) {
+            if (keystorePath != null) {
+                // absolute paths are set when reading the file
+                // so this must be a relative path
+                keystoreDir = new File(execDir, keystorePath);
+            } else {
+                // path not set so using defaults
+                keystoreDir = new File(execDir, keystoreDirName);
+            }
+        } else if (keystoreDir == null) {
+            keystoreDir = new File(keystorePath);
+        }
     }
 
     /**
@@ -345,8 +424,23 @@ public void setDatabaseDir(File _databaseDirectory) {
         this.absoluteDatabaseDir = true;
     }
 
+    /**
+     * Used to set an absolute path for the keystore directory.
+     *
+     * @param _keystoreDirectory the path to be used for the keystore.
+     */
+    public void setKeystoreDir(File _keystoreDirectory) {
+        this.keystoreDir = _keystoreDirectory;
+        this.absoluteKeystoreDir = true;
+    }
+
     public File getKeystoreDir() {
-        return new File(getExecDir(), keystoreDirName);
+        if (keystoreDir == null) {
+            // was not updated with absolute path
+            keystoreDir =
+                    new File(getExecDir(), keystorePath != null ? keystorePath : keystoreDirName);
+        }
+        return keystoreDir;
     }
 
     /** Returns the configuration directory location for the kernel execution. */