Add snapshot sync test with Tendermint dynamic validator

Author: foriequal0

test/src/e2e.dynval/2/snapshot.test.ts

@@ -0,0 +1,111 @@
+// Copyright 2019 Kodebox, Inc.
+// This file is part of CodeChain.
+//
+// This program is free software: you can redistribute it and/or modify
+// it under the terms of the GNU Affero General Public License as
+// published by the Free Software Foundation, either version 3 of the
+// License, or (at your option) any later version.
+//
+// This program is distributed in the hope that it will be useful,
+// but WITHOUT ANY WARRANTY; without even the implied warranty of
+// MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+// GNU Affero General Public License for more details.
+//
+// You should have received a copy of the GNU Affero General Public License
+// along with this program.  If not, see <https://www.gnu.org/licenses/>.
+
+import * as chai from "chai";
+import { expect } from "chai";
+import * as chaiAsPromised from "chai-as-promised";
+import { SDK } from "codechain-sdk";
+import * as stake from "codechain-stakeholder-sdk";
+import * as fs from "fs";
+import "mocha";
+import * as path from "path";
+
+import mkdirp = require("mkdirp");
+import { validators } from "../../../tendermint.dynval/constants";
+import { PromiseExpect } from "../../helper/promise";
+import { setTermTestTimeout, withNodes } from "../setup";
+
+chai.use(chaiAsPromised);
+
+const SNAPSHOT_CONFIG = `${__dirname}/../../../tendermint.dynval/snapshot-config.yml`;
+const SNAPSHOT_PATH = `${__dirname}/../../../../snapshot/`;
+
+describe("Snapshot for Tendermint with Dynamic Validator", function() {
+    const promiseExpect = new PromiseExpect();
+    const snapshotValidators = validators.slice(0, 3);
+
+    describe("Snapshot", async function() {
+        const { nodes } = withNodes(this, {
+            promiseExpect,
+            overrideParams: {
+                maxNumOfValidators: 3
+            },
+            validators: snapshotValidators.map((signer, index) => ({
+                signer,
+                delegation: 5000,
+                deposit: 10_000_000 - index // tie-breaker
+            })),
+            modify: () => {
+                mkdirp.sync(SNAPSHOT_PATH);
+                const snapshotPath = fs.mkdtempSync(SNAPSHOT_PATH);
+                return {
+                    additionalArgv: [
+                        "--snapshot-path",
+                        snapshotPath,
+                        "--config",
+                        SNAPSHOT_CONFIG
+                    ],
+                    nodeAdditionalProperties: {
+                        snapshotPath
+                    }
+                };
+            }
+        });
+
+        it("should be exist after some time", async function() {
+            const termWaiter = setTermTestTimeout(this, {
+                terms: 1
+            });
+            await termWaiter.waitNodeUntilTerm(nodes[0], {
+                target: 2,
+                termPeriods: 1
+            });
+            const blockNumber = await nodes[0].sdk.rpc.chain.getBestBlockNumber();
+            const termMetadata = await stake.getTermMetadata(
+                nodes[0].sdk,
+                blockNumber
+            );
+
+            expect(termMetadata).not.to.be.null;
+            const {
+                currentTermId,
+                lastTermFinishedBlockNumber
+            } = termMetadata!;
+            expect(currentTermId).to.be.equals(2);
+            expect(lastTermFinishedBlockNumber).to.be.lte(blockNumber);
+
+            const blockHash = (await nodes[0].sdk.rpc.chain.getBlockHash(
+                lastTermFinishedBlockNumber
+            ))!;
+            const stateRoot = (await nodes[0].sdk.rpc.chain.getBlock(
+                blockHash
+            ))!.stateRoot;
+            expect(
+                fs.existsSync(
+                    path.join(
+                        nodes[0].snapshotPath,
+                        blockHash.toString(),
+                        stateRoot.toString()
+                    )
+                )
+            ).to.be.true;
+        });
+    });
+
+    afterEach(async function() {
+        promiseExpect.checkFulfilled();
+    });
+});

test/src/e2e.dynval/setup.ts

@@ -28,17 +28,29 @@ interface ValidatorConfig {
     delegation?: U64Value;
 }
 
-export function withNodes(
+interface NodePropertyModifier<T> {
+    additionalArgv: string[];
+    nodeAdditionalProperties: T;
+}
+
+export function withNodes<T>(
     suite: Suite,
     options: {
         promiseExpect: PromiseExpect;
         validators: ValidatorConfig[];
         overrideParams?: Partial<typeof defaultParams>;
         onBeforeEnable?: (nodes: CodeChain[]) => Promise<void>;
+        modify?: (signer: Signer, index: number) => NodePropertyModifier<T>;
     }
 ) {
-    const nodes: CodeChain[] = [];
-    const { overrideParams = {} } = options;
+    const nodes: (CodeChain & T)[] = [];
+    const {
+        overrideParams = {},
+        modify = () => ({
+            additionalArgv: [],
+            nodeAdditionalProperties: {} as T
+        })
+    } = options;
     const initialParams = {
         ...defaultParams,
         ...overrideParams
@@ -51,7 +63,8 @@ export function withNodes(
         nodes.length = 0;
         const newNodes = await createNodes({
             ...options,
-            initialParams
+            initialParams,
+            modify
         });
         nodes.push(...newNodes);
     });
@@ -84,14 +97,15 @@ export function findNode(nodes: CodeChain[], signer: Signer) {
     );
 }
 
-async function createNodes(options: {
+async function createNodes<T>(options: {
     promiseExpect: PromiseExpect;
     validators: ValidatorConfig[];
     initialParams: typeof defaultParams;
     onBeforeEnable?: (nodes: CodeChain[]) => Promise<void>;
-}): Promise<CodeChain[]> {
+    modify: (signer: Signer, index: number) => NodePropertyModifier<T>;
+}): Promise<(CodeChain & T)[]> {
     const chain = `${__dirname}/../scheme/tendermint-dynval.json`;
-    const { promiseExpect, validators, initialParams } = options;
+    const { promiseExpect, validators, initialParams, modify } = options;
 
     const initialNodes: CodeChain[] = [];
     const initialValidators = [
@@ -113,20 +127,24 @@ async function createNodes(options: {
         });
     }
 
-    const nodes: CodeChain[] = [];
+    const nodes: (CodeChain & T)[] = [];
     for (let i = 0; i < validators.length; i++) {
         const { signer: validator } = validators[i];
-        nodes[i] = new CodeChain({
+        const modifier = modify(validator, i);
+        const node = new CodeChain({
             chain,
             argv: [
                 "--engine-signer",
                 validator.platformAddress.value,
                 "--password-path",
                 `test/tendermint.dynval/${validator.platformAddress.value}/password.json`,
-                "--force-sealing"
+                "--force-sealing",
+                ...modifier.additionalArgv
             ],
             additionalKeysPath: `tendermint.dynval/${validator.platformAddress.value}/keys`
         });
+
+        nodes[i] = Object.assign(node, modifier.nodeAdditionalProperties);
         nodes[i].setSigner(validator);
     }
     let bootstrapFailed = false;

test/tendermint.dynval/snapshot-config.yml

@@ -0,0 +1,61 @@
+[codechain]
+quiet = false
+base_path = "."
+chain = "solo"
+
+[mining]
+mem_pool_mem_limit = 4 # MB
+mem_pool_size = 32768
+mem_pool_fee_bump_shift = 3 # 12.5%
+allow_create_shard = false
+notify_work = []
+force_sealing = false
+reseal_on_txs = "all"
+reseal_min_period = 0
+reseal_max_period = 120000
+no_reseal_timer = false
+work_queue_size = 20
+allowed_past_gap = 30000
+allowed_future_gap = 5000
+
+[network]
+disable = false
+interface = "0.0.0.0"
+port = 3485
+max_peers = 30
+min_peers = 10
+bootstrap_addresses = []
+sync = true
+transaction_relay = true
+discovery = true
+discovery_type = "unstructured"
+discovery_refresh = 60000
+discovery_bucket_size = 10
+# whitelist_path = "whitelist.txt"
+# blacklist_path = "blacklist.txt"
+
+[rpc]
+disable = false
+interface = "127.0.0.1"
+port = 8080
+
+[ipc]
+disable = false
+path = "/tmp/jsonrpc.ipc"
+
+[ws]
+disable = false
+interface = "127.0.0.1"
+port = 8081
+max_connections = 100
+
+[snapshot]
+disable = false
+path = "snapshot"
+
+[stratum]
+disable = false
+port = 8008
+
+[email_alarm]
+disable = true