Merge pull request #5076 from guoquanwu/hotfix/unit-test-port-unavailable

fix(test): fix port unavailability when running unit test

Author: tomatoishealthy

framework/src/test/java/org/tron/common/utils/PublicMethod.java

@@ -2,6 +2,8 @@
 
 import com.google.protobuf.ByteString;
 import java.math.BigInteger;
+import java.util.Random;
+
 import org.tron.api.GrpcAPI;
 import org.tron.api.WalletGrpc;
 import org.tron.common.crypto.ECKey;
@@ -102,4 +104,12 @@ public static GrpcAPI.Return broadcastTransaction(
     }
     return response;
   }
+
+  public static int chooseRandomPort(int min, int max) {
+    return new Random().nextInt(max - min + 1) + min;
+  }
+
+  public static int chooseRandomPort() {
+    return new Random().nextInt(65530 - 1024) + 1024;
+  }
 }

framework/src/test/java/org/tron/core/services/filter/LiteFnQueryGrpcInterceptorTest.java

@@ -4,6 +4,8 @@
 import io.grpc.ManagedChannelBuilder;
 import io.grpc.StatusRuntimeException;
 import java.io.File;
+import java.util.concurrent.TimeUnit;
+
 import org.junit.After;
 import org.junit.Assert;
 import org.junit.Before;
@@ -20,6 +22,7 @@
 import org.tron.common.application.ApplicationFactory;
 import org.tron.common.application.TronApplicationContext;
 import org.tron.common.utils.FileUtil;
+import org.tron.common.utils.PublicMethod;
 import org.tron.core.ChainBaseManager;
 import org.tron.core.Constant;
 import org.tron.core.config.DefaultConfig;
@@ -38,7 +41,6 @@ public class LiteFnQueryGrpcInterceptorTest {
   private WalletGrpc.WalletBlockingStub blockingStubFull = null;
   private WalletSolidityGrpc.WalletSolidityBlockingStub blockingStubSolidity = null;
   private WalletSolidityGrpc.WalletSolidityBlockingStub blockingStubpBFT = null;
-  private DatabaseGrpc.DatabaseBlockingStub databaseBlockingStub = null;
   private RpcApiService rpcApiService;
   private RpcApiServiceOnSolidity rpcApiServiceOnSolidity;
   private RpcApiServiceOnPBFT rpcApiServiceOnPBFT;
@@ -56,6 +58,9 @@ public class LiteFnQueryGrpcInterceptorTest {
   @Before
   public void init() {
     Args.setParam(new String[]{"-d", dbPath}, Constant.TEST_CONF);
+    Args.getInstance().setRpcPort(PublicMethod.chooseRandomPort());
+    Args.getInstance().setRpcOnSolidityPort(PublicMethod.chooseRandomPort());
+    Args.getInstance().setRpcOnPBFTPort(PublicMethod.chooseRandomPort());
     String fullnode = String.format("%s:%d", Args.getInstance().getNodeDiscoveryBindIp(),
             Args.getInstance().getRpcPort());
     String pBFTNode = String.format("%s:%d", Args.getInstance().getNodeDiscoveryBindIp(),
@@ -71,7 +76,6 @@ public void init() {
     blockingStubSolidity = WalletSolidityGrpc.newBlockingStub(channelFull);
     blockingStubpBFT = WalletSolidityGrpc.newBlockingStub(channelpBFT);
     blockingStubSolidity = WalletSolidityGrpc.newBlockingStub(channelFull);
-    databaseBlockingStub = DatabaseGrpc.newBlockingStub(channelFull);
     rpcApiService = context.getBean(RpcApiService.class);
     rpcApiServiceOnSolidity = context.getBean(RpcApiServiceOnSolidity.class);
     rpcApiServiceOnPBFT = context.getBean(RpcApiServiceOnPBFT.class);
@@ -89,7 +93,13 @@ public void init() {
    * destroy the context.
    */
   @After
-  public void destroy() {
+  public void destroy() throws InterruptedException {
+    if (channelFull != null) {
+      channelFull.shutdown().awaitTermination(5, TimeUnit.SECONDS);
+    }
+    if (channelpBFT != null) {
+      channelpBFT.shutdown().awaitTermination(5, TimeUnit.SECONDS);
+    }
     Args.clearParam();
     appTest.shutdownServices();
     appTest.shutdown();

framework/src/test/java/org/tron/core/services/filter/RpcApiAccessInterceptorTest.java

@@ -22,6 +22,7 @@
 import org.tron.common.application.ApplicationFactory;
 import org.tron.common.application.TronApplicationContext;
 import org.tron.common.utils.FileUtil;
+import org.tron.common.utils.PublicMethod;
 import org.tron.core.Constant;
 import org.tron.core.config.DefaultConfig;
 import org.tron.core.config.args.Args;
@@ -51,6 +52,9 @@ public class RpcApiAccessInterceptorTest {
   @BeforeClass
   public static void init() {
     Args.setParam(new String[] {"-d", dbPath}, Constant.TEST_CONF);
+    Args.getInstance().setRpcPort(PublicMethod.chooseRandomPort());
+    Args.getInstance().setRpcOnSolidityPort(PublicMethod.chooseRandomPort());
+    Args.getInstance().setRpcOnPBFTPort(PublicMethod.chooseRandomPort());
     String fullNode = String.format("%s:%d", Args.getInstance().getNodeDiscoveryBindIp(),
         Args.getInstance().getRpcPort());
     String solidityNode = String.format("%s:%d", Args.getInstance().getNodeDiscoveryBindIp(),

framework/src/test/java/org/tron/program/LiteFullNodeToolTest.java

@@ -1,19 +1,18 @@
 package org.tron.program;
 
-import com.google.protobuf.ByteString;
 import io.grpc.ManagedChannel;
 import io.grpc.ManagedChannelBuilder;
 import java.io.File;
-import java.math.BigInteger;
 import java.nio.file.Paths;
+import java.util.concurrent.TimeUnit;
+
 import org.junit.After;
 import org.junit.Before;
 import org.junit.Rule;
 import org.junit.Test;
 import org.junit.rules.ExpectedException;
 import org.slf4j.Logger;
 import org.slf4j.LoggerFactory;
-import org.tron.api.GrpcAPI;
 import org.tron.api.WalletGrpc;
 import org.tron.common.application.Application;
 import org.tron.common.application.ApplicationFactory;
@@ -23,22 +22,19 @@
 import org.tron.common.utils.FileUtil;
 import org.tron.common.utils.PublicMethod;
 import org.tron.common.utils.Utils;
-import org.tron.core.Wallet;
 import org.tron.core.config.DefaultConfig;
 import org.tron.core.config.args.Args;
 import org.tron.core.services.RpcApiService;
 import org.tron.core.services.interfaceOnSolidity.RpcApiServiceOnSolidity;
-import org.tron.protos.Protocol;
-import org.tron.protos.contract.BalanceContract;
 import org.tron.tool.litefullnode.LiteFullNodeTool;
-import stest.tron.wallet.common.client.utils.TransactionUtils;
 
 public class LiteFullNodeToolTest {
 
   private static final Logger logger = LoggerFactory.getLogger("Test");
 
   private TronApplicationContext context;
   private WalletGrpc.WalletBlockingStub blockingStubFull = null;
+  private ManagedChannel channelFull;
   private Application appTest;
 
   private String databaseDir;
@@ -47,7 +43,7 @@ public class LiteFullNodeToolTest {
   public ExpectedException thrown = ExpectedException.none();
 
 
-  private static final String DB_PATH = "output_lite_fn";
+  private static String dbPath = "output_lite_fn";
 
   /**
    * init logic.
@@ -63,7 +59,7 @@ public void startApp() {
 
     String fullnode = String.format("%s:%d", "127.0.0.1",
             Args.getInstance().getRpcPort());
-    ManagedChannel channelFull = ManagedChannelBuilder.forTarget(fullnode)
+    channelFull = ManagedChannelBuilder.forTarget(fullnode)
             .usePlaintext(true)
             .build();
     blockingStubFull = WalletGrpc.newBlockingStub(channelFull);
@@ -86,59 +82,66 @@ public static void destroy(String dbPath) {
   /**
    * shutdown the fullnode.
    */
-  public void shutdown() {
+  public void shutdown() throws InterruptedException {
+    if (channelFull != null) {
+      channelFull.shutdown().awaitTermination(5, TimeUnit.SECONDS);
+    }
     appTest.shutdownServices();
     appTest.shutdown();
     context.destroy();
   }
 
-  @Before
   public void init() {
-    destroy(DB_PATH); // delete if prev failed
-    Args.setParam(new String[]{"-d", DB_PATH, "-w"}, "config-localtest.conf");
+    destroy(dbPath); // delete if prev failed
+    Args.setParam(new String[]{"-d", dbPath, "-w"}, "config-localtest.conf");
     // allow account root
     Args.getInstance().setAllowAccountStateRoot(1);
+    Args.getInstance().setRpcPort(PublicMethod.chooseRandomPort());
     databaseDir = Args.getInstance().getStorage().getDbDirectory();
     // init dbBackupConfig to avoid NPE
     Args.getInstance().dbBackupConfig = DbBackupConfig.getInstance();
   }
 
   @After
   public void clear() {
-    destroy(DB_PATH);
+    destroy(dbPath);
     Args.clearParam();
+    dbPath = "output_lite_fn";
   }
 
   @Test
-  public void testToolsWithLevelDB() {
+  public void testToolsWithLevelDB() throws InterruptedException {
     logger.info("testToolsWithLevelDB start");
     testTools("LEVELDB", 1);
   }
 
   @Test
-  public void testToolsWithLevelDBV2() {
+  public void testToolsWithLevelDBV2() throws InterruptedException {
     logger.info("testToolsWithLevelDB start");
     testTools("LEVELDB", 2);
   }
 
   @Test
-  public void testToolsWithRocksDB() {
+  public void testToolsWithRocksDB() throws InterruptedException {
     logger.info("testToolsWithRocksDB start");
     testTools("ROCKSDB", 1);
   }
 
-  private void testTools(String dbType, int checkpointVersion) {
+  private void testTools(String dbType, int checkpointVersion)
+      throws InterruptedException {
+    dbPath = String.format("%s_%s_%d", dbPath, dbType, System.currentTimeMillis());
+    init();
     final String[] argsForSnapshot =
         new String[]{"-o", "split", "-t", "snapshot", "--fn-data-path",
-            DB_PATH + File.separator + databaseDir, "--dataset-path",
-            DB_PATH};
+            dbPath + File.separator + databaseDir, "--dataset-path",
+            dbPath};
     final String[] argsForHistory =
         new String[]{"-o", "split", "-t", "history", "--fn-data-path",
-            DB_PATH + File.separator + databaseDir, "--dataset-path",
-            DB_PATH};
+            dbPath + File.separator + databaseDir, "--dataset-path",
+            dbPath};
     final String[] argsForMerge =
-        new String[]{"-o", "merge", "--fn-data-path", DB_PATH + File.separator + databaseDir,
-            "--dataset-path", DB_PATH + File.separator + "history"};
+        new String[]{"-o", "merge", "--fn-data-path", dbPath + File.separator + databaseDir,
+            "--dataset-path", dbPath + File.separator + "history"};
     Args.getInstance().getStorage().setDbEngine(dbType);
     Args.getInstance().getStorage().setCheckpointVersion(checkpointVersion);
     LiteFullNodeTool.setRecentBlks(3);
@@ -149,7 +152,7 @@ private void testTools(String dbType, int checkpointVersion) {
     // stop the node
     shutdown();
     // delete tran-cache
-    FileUtil.deleteDir(Paths.get(DB_PATH, databaseDir, "trans-cache").toFile());
+    FileUtil.deleteDir(Paths.get(dbPath, databaseDir, "trans-cache").toFile());
     // generate snapshot
     LiteFullNodeTool.main(argsForSnapshot);
     // start fullnode
@@ -161,18 +164,18 @@ private void testTools(String dbType, int checkpointVersion) {
     // generate history
     LiteFullNodeTool.main(argsForHistory);
     // backup original database to database_bak
-    File database = new File(Paths.get(DB_PATH, databaseDir).toString());
-    if (!database.renameTo(new File(Paths.get(DB_PATH, databaseDir + "_bak").toString()))) {
+    File database = new File(Paths.get(dbPath, databaseDir).toString());
+    if (!database.renameTo(new File(Paths.get(dbPath, databaseDir + "_bak").toString()))) {
       throw new RuntimeException(
               String.format("rename %s to %s failed", database.getPath(),
-                      Paths.get(DB_PATH, databaseDir).toString()));
+                      Paths.get(dbPath, databaseDir).toString()));
     }
     // change snapshot to the new database
-    File snapshot = new File(Paths.get(DB_PATH, "snapshot").toString());
-    if (!snapshot.renameTo(new File(Paths.get(DB_PATH, databaseDir).toString()))) {
+    File snapshot = new File(Paths.get(dbPath, "snapshot").toString());
+    if (!snapshot.renameTo(new File(Paths.get(dbPath, databaseDir).toString()))) {
       throw new RuntimeException(
               String.format("rename snapshot to %s failed",
-                      Paths.get(DB_PATH, databaseDir).toString()));
+                      Paths.get(dbPath, databaseDir).toString()));
     }
     // start and validate the snapshot
     startApp();