Clean up test suite (#134)

This attempts to simplify tests, and make them generally more usable: - simplifies CI jobs - makefile tweaks, init.sh clean up - small dockerfile, compose, etc. improvements - removes sdk-tester dockerfile, the sdk repo has it - removes redundant test scripts, improve run-tests - simplifies and removes redundant logic in test suite. covers ignored errors - adds logging context, doc updates Co-authored-by: Roy Crihfield <[email protected]> Co-authored-by: Prathamesh Musale <[email protected]> Reviewed-on: https://git.vdb.to/cerc-io/laconicd/pulls/134 Reviewed-by: Thomas E Lackey <[email protected]> Co-authored-by: Prathamesh Musale <[email protected]> Co-committed-by: Prathamesh Musale <[email protected]>
cerc-io · Jan 22, 2024 · 055cfb2 · 055cfb2
1 parent 776799e
commit 055cfb2
Show file tree

Hide file tree

Showing 22 changed files with 193 additions and 381 deletions.
diff --git a/.dockerignore b/.dockerignore
@@ -1,5 +1,7 @@
-# localnet-setup
-localnet-setup
+Dockerfile
 
-# build
-build
+**/node_modules
+init.sh
+
+build
+localnet-setup
diff --git a/.github/CODEOWNERS b/.github/CODEOWNERS
diff --git a/.github/workflows/test.yml b/.github/workflows/test.yml
@@ -59,7 +59,7 @@ jobs:
         run: |
           make test-import
         if: env.GIT_DIFF
-        
+
   test-rpc:
     runs-on: ubuntu-latest
     timeout-minutes: 15
@@ -91,42 +91,41 @@ jobs:
           path: "./laconic-sdk/"
           repository: cerc-io/laconic-sdk
           fetch-depth: 0
-          ref: jest_timeout
+          ref: main
       - name: Environment
         run: ls -tlh && env
-      - name: build containers scripts
+
+      - name: Build laconicd container
         working-directory: tests/sdk_tests
-        run: ./build-laconicd-container.sh && ./build-sdk-test-container.sh
-      - name: start containers
+        run: ./build-laconicd-container.sh
+      - name: Build laconic-sdk container
+        working-directory: laconic-sdk
+        run: ./scripts/build-sdk-test-container.sh
+
+      - name: Start containers
         working-directory: tests/sdk_tests
         run: docker compose up -d
-      - name: run-tests.sh
+      - name: Run tests
         working-directory: tests/sdk_tests
         run: ./run-tests.sh
-      - name: reset containers for auction tests
-        working-directory: tests/sdk_tests
-        if: always()
-        run: docker compose down
-      - name: start auction containers
-        working-directory: tests/sdk_tests
-        run: docker compose -f docker-compose-auctions.yml up -d
-      - name: run-acution-tests.sh
-        working-directory: tests/sdk_tests
-        run: ./run-auction-tests.sh
-      - name: reset containers for nameservice tests
+
+      - name: Start containers (auctions enabled)
         working-directory: tests/sdk_tests
-        if: always()
-        run: docker compose -f docker-compose-auctions.yml down
-      - name: start auction containers
+        env:
+          TEST_AUCTION_ENABLED: true
+        run: docker compose up -d
+      - name: Run auction tests
         working-directory: tests/sdk_tests
-        run: docker compose -f docker-compose-nameservice.yml up -d
-      - name: run-nameservice-expiry-tests.sh
+        run: ./run-tests.sh test:auctions
+
+      - name: Start containers (expiry enabled)
         working-directory: tests/sdk_tests
-        run: ./run-nameservice-expiry-tests.sh
-      - name: reset containers for nameservice tests
+        env:
+          TEST_REGISTRY_EXPIRY: true
+        run: docker compose up -d
+      - name: Run nameservice expiry tests
         working-directory: tests/sdk_tests
-        if: always()
-        run: docker compose -f docker-compose-nameservice.yml down
+        run: ./run-tests.sh test:nameservice-expiry
 
   # integration_tests:
   #   runs-on: ubuntu-latest

diff --git a/Dockerfile b/Dockerfile
@@ -1,14 +1,14 @@
 FROM golang:alpine AS build-env
 
-# Set up dependencies
-ENV PACKAGES git build-base
+# Install dependencies
+RUN apk add --update git build-base linux-headers
 
 # Set working directory for the build
 WORKDIR /go/src/github.com/cerc-io/laconicd
 
-# Install dependencies
-RUN apk add --update $PACKAGES
-RUN apk add linux-headers
+# Cache Go modules
+COPY go.mod go.sum ./
+RUN go mod download
 
 # Add source files
 COPY . .
@@ -21,10 +21,10 @@ FROM alpine:3.17.0
 
 # Install ca-certificates
 RUN apk add --update ca-certificates jq curl
-WORKDIR /
 
 # Copy over binaries from the build-env
 COPY --from=build-env /go/src/github.com/cerc-io/laconicd/build/laconicd /usr/bin/laconicd
 
+WORKDIR /
 # Run laconicd by default
-CMD ["laconicd"]
+ENTRYPOINT ["laconicd"]
diff --git a/Makefile b/Makefile
@@ -72,7 +72,7 @@ ifeq ($(ENABLE_ROCKSDB),true)
   BUILD_TAGS += rocksdb_build
   test_tags += rocksdb_build
 else
-  $(warning RocksDB support is disabled; to build and test with RocksDB support, set ENABLE_ROCKSDB=true)
+  $(info RocksDB support is disabled; to build and test with RocksDB support, set ENABLE_ROCKSDB=true)
 endif
 
 # DB backend selection
@@ -145,7 +145,7 @@ docker-build:
 	# update old container
 	docker rm laconicd || true
 	# create a new container from the latest image
-	docker create --name laconic -t -i cerc-io/laconicd:latest laconicd
+	docker create --name laconic -t -i ${DOCKER_IMAGE}:${DOCKER_TAG} laconicd
 	# move the binaries to the ./build directory
 	mkdir -p ./build/
 	docker cp laconic:/usr/bin/laconicd ./build/
@@ -316,7 +316,7 @@ TEST_TARGETS := test-unit test-unit-cover test-race
 # Test runs-specific rules. To add a new test target, just add
 # a new rule, customise ARGS or TEST_PACKAGES ad libitum, and
 # append the new rule to the TEST_TARGETS list.
-test-unit: ARGS=-timeout=10m -race
+test-unit: ARGS=-timeout=10m -race -test.v
 test-unit: TEST_PACKAGES=$(PACKAGES_UNIT)
 
 test-race: ARGS=-race

diff --git a/init.sh b/init.sh
@@ -5,14 +5,17 @@ CHAINID="laconic_9000-1"
 MONIKER="localtestnet"
 KEYRING="test"
 KEYALGO="eth_secp256k1"
-LOGLEVEL="info"
+LOGLEVEL="${LOGLEVEL:-info}"
 # trace evm
 TRACE="--trace"
 # TRACE=""
 
 if [ "$1" == "clean" ] || [ ! -d "$HOME/.laconicd/data/blockstore.db" ]; then
   # validate dependencies are installed
-  command -v jq > /dev/null 2>&1 || { echo >&2 "jq not installed. More info: https://stedolan.github.io/jq/download/"; exit 1; }
+  command -v jq > /dev/null 2>&1 || {
+    echo >&2 "jq not installed. More info: https://stedolan.github.io/jq/download/"
+    exit 1
+  }
 
   # remove existing daemon and client
   rm -rf $HOME/.laconicd/*
@@ -31,41 +34,46 @@ if [ "$1" == "clean" ] || [ ! -d "$HOME/.laconicd/data/blockstore.db" ]; then
   # Set moniker and chain-id for Ethermint (Moniker can be anything, chain-id must be an integer)
   laconicd init $MONIKER --chain-id $CHAINID
 
+  update_genesis() {
+  jq "$1" $HOME/.laconicd/config/genesis.json > $HOME/.laconicd/config/tmp_genesis.json &&
+    mv $HOME/.laconicd/config/tmp_genesis.json $HOME/.laconicd/config/genesis.json
+  }
+
   # Change parameter token denominations to aphoton
-  cat $HOME/.laconicd/config/genesis.json | jq '.app_state["staking"]["params"]["bond_denom"]="aphoton"' > $HOME/.laconicd/config/tmp_genesis.json && mv $HOME/.laconicd/config/tmp_genesis.json $HOME/.laconicd/config/genesis.json
-  cat $HOME/.laconicd/config/genesis.json | jq '.app_state["crisis"]["constant_fee"]["denom"]="aphoton"' > $HOME/.laconicd/config/tmp_genesis.json && mv $HOME/.laconicd/config/tmp_genesis.json $HOME/.laconicd/config/genesis.json
-  cat $HOME/.laconicd/config/genesis.json | jq '.app_state["gov"]["deposit_params"]["min_deposit"][0]["denom"]="aphoton"' > $HOME/.laconicd/config/tmp_genesis.json && mv $HOME/.laconicd/config/tmp_genesis.json $HOME/.laconicd/config/genesis.json
-  cat $HOME/.laconicd/config/genesis.json | jq '.app_state["mint"]["params"]["mint_denom"]="aphoton"' > $HOME/.laconicd/config/tmp_genesis.json && mv $HOME/.laconicd/config/tmp_genesis.json $HOME/.laconicd/config/genesis.json
+  update_genesis '.app_state["staking"]["params"]["bond_denom"]="aphoton"'
+  update_genesis '.app_state["crisis"]["constant_fee"]["denom"]="aphoton"'
+  update_genesis '.app_state["gov"]["deposit_params"]["min_deposit"][0]["denom"]="aphoton"'
+  update_genesis '.app_state["mint"]["params"]["mint_denom"]="aphoton"'
   # Custom modules
-  cat $HOME/.laconicd/config/genesis.json | jq '.app_state["registry"]["params"]["record_rent"]["denom"]="aphoton"' > $HOME/.laconicd/config/tmp_genesis.json && mv $HOME/.laconicd/config/tmp_genesis.json $HOME/.laconicd/config/genesis.json
-  cat $HOME/.laconicd/config/genesis.json | jq '.app_state["registry"]["params"]["authority_rent"]["denom"]="aphoton"' > $HOME/.laconicd/config/tmp_genesis.json && mv $HOME/.laconicd/config/tmp_genesis.json $HOME/.laconicd/config/genesis.json
-  cat $HOME/.laconicd/config/genesis.json | jq '.app_state["registry"]["params"]["authority_auction_commit_fee"]["denom"]="aphoton"' > $HOME/.laconicd/config/tmp_genesis.json && mv $HOME/.laconicd/config/tmp_genesis.json $HOME/.laconicd/config/genesis.json
-  cat $HOME/.laconicd/config/genesis.json | jq '.app_state["registry"]["params"]["authority_auction_reveal_fee"]["denom"]="aphoton"' > $HOME/.laconicd/config/tmp_genesis.json && mv $HOME/.laconicd/config/tmp_genesis.json $HOME/.laconicd/config/genesis.json
-  cat $HOME/.laconicd/config/genesis.json | jq '.app_state["registry"]["params"]["authority_auction_minimum_bid"]["denom"]="aphoton"' > $HOME/.laconicd/config/tmp_genesis.json && mv $HOME/.laconicd/config/tmp_genesis.json $HOME/.laconicd/config/genesis.json
+  update_genesis '.app_state["registry"]["params"]["record_rent"]["denom"]="aphoton"'
+  update_genesis '.app_state["registry"]["params"]["authority_rent"]["denom"]="aphoton"'
+  update_genesis '.app_state["registry"]["params"]["authority_auction_commit_fee"]["denom"]="aphoton"'
+  update_genesis '.app_state["registry"]["params"]["authority_auction_reveal_fee"]["denom"]="aphoton"'
+  update_genesis '.app_state["registry"]["params"]["authority_auction_minimum_bid"]["denom"]="aphoton"'
 
   if [[ "$TEST_REGISTRY_EXPIRY" == "true" ]]; then
     echo "Setting timers for expiry tests."
 
-    cat $HOME/.laconicd/config/genesis.json | jq '.app_state["registry"]["params"]["record_rent_duration"]="60s"' > $HOME/.laconicd/config/tmp_genesis.json && mv $HOME/.laconicd/config/tmp_genesis.json $HOME/.laconicd/config/genesis.json
-    cat $HOME/.laconicd/config/genesis.json | jq '.app_state["registry"]["params"]["authority_grace_period"]="60s"' > $HOME/.laconicd/config/tmp_genesis.json && mv $HOME/.laconicd/config/tmp_genesis.json $HOME/.laconicd/config/genesis.json
-    cat $HOME/.laconicd/config/genesis.json | jq '.app_state["registry"]["params"]["authority_rent_duration"]="60s"' > $HOME/.laconicd/config/tmp_genesis.json && mv $HOME/.laconicd/config/tmp_genesis.json $HOME/.laconicd/config/genesis.json
+    update_genesis '.app_state["registry"]["params"]["record_rent_duration"]="60s"'
+    update_genesis '.app_state["registry"]["params"]["authority_grace_period"]="60s"'
+    update_genesis '.app_state["registry"]["params"]["authority_rent_duration"]="60s"'
   fi
 
   if [[ "$TEST_AUCTION_ENABLED" == "true" ]]; then
     echo "Enabling auction and setting timers."
 
-    cat $HOME/.laconicd/config/genesis.json | jq '.app_state["registry"]["params"]["authority_auction_enabled"]=true' > $HOME/.laconicd/config/tmp_genesis.json && mv $HOME/.laconicd/config/tmp_genesis.json $HOME/.laconicd/config/genesis.json
-    cat $HOME/.laconicd/config/genesis.json | jq '.app_state["registry"]["params"]["authority_rent_duration"]="60s"' > $HOME/.laconicd/config/tmp_genesis.json && mv $HOME/.laconicd/config/tmp_genesis.json $HOME/.laconicd/config/genesis.json
-    cat $HOME/.laconicd/config/genesis.json | jq '.app_state["registry"]["params"]["authority_grace_period"]="300s"' > $HOME/.laconicd/config/tmp_genesis.json && mv $HOME/.laconicd/config/tmp_genesis.json $HOME/.laconicd/config/genesis.json
-    cat $HOME/.laconicd/config/genesis.json | jq '.app_state["registry"]["params"]["authority_auction_commits_duration"]="60s"' > $HOME/.laconicd/config/tmp_genesis.json && mv $HOME/.laconicd/config/tmp_genesis.json $HOME/.laconicd/config/genesis.json
-    cat $HOME/.laconicd/config/genesis.json | jq '.app_state["registry"]["params"]["authority_auction_reveals_duration"]="60s"' > $HOME/.laconicd/config/tmp_genesis.json && mv $HOME/.laconicd/config/tmp_genesis.json $HOME/.laconicd/config/genesis.json
+    update_genesis '.app_state["registry"]["params"]["authority_auction_enabled"]=true'
+    update_genesis '.app_state["registry"]["params"]["authority_rent_duration"]="60s"'
+    update_genesis '.app_state["registry"]["params"]["authority_grace_period"]="300s"'
+    update_genesis '.app_state["registry"]["params"]["authority_auction_commits_duration"]="60s"'
+    update_genesis '.app_state["registry"]["params"]["authority_auction_reveals_duration"]="60s"'
   fi
 
   # increase block time (?)
-  cat $HOME/.laconicd/config/genesis.json | jq '.consensus_params["block"]["time_iota_ms"]="1000"' > $HOME/.laconicd/config/tmp_genesis.json && mv $HOME/.laconicd/config/tmp_genesis.json $HOME/.laconicd/config/genesis.json
+  update_genesis '.consensus_params["block"]["time_iota_ms"]="1000"'
 
   # Set gas limit in genesis
-  cat $HOME/.laconicd/config/genesis.json | jq '.consensus_params["block"]["max_gas"]="10000000"' > $HOME/.laconicd/config/tmp_genesis.json && mv $HOME/.laconicd/config/tmp_genesis.json $HOME/.laconicd/config/genesis.json
+  update_genesis '.consensus_params["block"]["max_gas"]="10000000"'
 
   # disable produce empty block
   if [[ "$OSTYPE" == "darwin"* ]]; then
@@ -74,28 +82,22 @@ if [ "$1" == "clean" ] || [ ! -d "$HOME/.laconicd/data/blockstore.db" ]; then
       sed -i 's/create_empty_blocks = true/create_empty_blocks = false/g' $HOME/.laconicd/config/config.toml
   fi
 
-  if [[ $1 == "pending" ]]; then
+  if [[ "$1" == "pending" ]]; then
+    alias sed-i="sed -i"
     if [[ "$OSTYPE" == "darwin"* ]]; then
-        sed -i '' 's/create_empty_blocks_interval = "0s"/create_empty_blocks_interval = "30s"/g' $HOME/.laconicd/config/config.toml
-        sed -i '' 's/timeout_propose = "3s"/timeout_propose = "30s"/g' $HOME/.laconicd/config/config.toml
-        sed -i '' 's/timeout_propose_delta = "500ms"/timeout_propose_delta = "5s"/g' $HOME/.laconicd/config/config.toml
-        sed -i '' 's/timeout_prevote = "1s"/timeout_prevote = "10s"/g' $HOME/.laconicd/config/config.toml
-        sed -i '' 's/timeout_prevote_delta = "500ms"/timeout_prevote_delta = "5s"/g' $HOME/.laconicd/config/config.toml
-        sed -i '' 's/timeout_precommit = "1s"/timeout_precommit = "10s"/g' $HOME/.laconicd/config/config.toml
-        sed -i '' 's/timeout_precommit_delta = "500ms"/timeout_precommit_delta = "5s"/g' $HOME/.laconicd/config/config.toml
-        sed -i '' 's/timeout_commit = "5s"/timeout_commit = "150s"/g' $HOME/.laconicd/config/config.toml
-        sed -i '' 's/timeout_broadcast_tx_commit = "10s"/timeout_broadcast_tx_commit = "150s"/g' $HOME/.laconicd/config/config.toml
-    else
-        sed -i 's/create_empty_blocks_interval = "0s"/create_empty_blocks_interval = "30s"/g' $HOME/.laconicd/config/config.toml
-        sed -i 's/timeout_propose = "3s"/timeout_propose = "30s"/g' $HOME/.laconicd/config/config.toml
-        sed -i 's/timeout_propose_delta = "500ms"/timeout_propose_delta = "5s"/g' $HOME/.laconicd/config/config.toml
-        sed -i 's/timeout_prevote = "1s"/timeout_prevote = "10s"/g' $HOME/.laconicd/config/config.toml
-        sed -i 's/timeout_prevote_delta = "500ms"/timeout_prevote_delta = "5s"/g' $HOME/.laconicd/config/config.toml
-        sed -i 's/timeout_precommit = "1s"/timeout_precommit = "10s"/g' $HOME/.laconicd/config/config.toml
-        sed -i 's/timeout_precommit_delta = "500ms"/timeout_precommit_delta = "5s"/g' $HOME/.laconicd/config/config.toml
-        sed -i 's/timeout_commit = "5s"/timeout_commit = "150s"/g' $HOME/.laconicd/config/config.toml
-        sed -i 's/timeout_broadcast_tx_commit = "10s"/timeout_broadcast_tx_commit = "150s"/g' $HOME/.laconicd/config/config.toml
+      alias sed-i="sed -i ''"
     fi
+    sed-i \
+      -e 's/create_empty_blocks_interval = "0s"/create_empty_blocks_interval = "30s"/g' \
+      -e 's/timeout_propose = "3s"/timeout_propose = "30s"/g' \
+      -e 's/timeout_propose_delta = "500ms"/timeout_propose_delta = "5s"/g' \
+      -e 's/timeout_prevote = "1s"/timeout_prevote = "10s"/g' \
+      -e 's/timeout_prevote_delta = "500ms"/timeout_prevote_delta = "5s"/g' \
+      -e 's/timeout_precommit = "1s"/timeout_precommit = "10s"/g' \
+      -e 's/timeout_precommit_delta = "500ms"/timeout_precommit_delta = "5s"/g' \
+      -e 's/timeout_commit = "5s"/timeout_commit = "150s"/g' \
+      -e 's/timeout_broadcast_tx_commit = "10s"/timeout_broadcast_tx_commit = "150s"/g' \
+      $HOME/.laconicd/config/config.toml
   fi
 
   # Allocate genesis accounts (cosmos formatted addresses)
@@ -110,12 +112,19 @@ if [ "$1" == "clean" ] || [ ! -d "$HOME/.laconicd/data/blockstore.db" ]; then
   # Run this to ensure everything worked and that the genesis file is setup correctly
   laconicd validate-genesis
 
-  if [[ $1 == "pending" ]]; then
+  if [[ "$1" == "pending" ]]; then
     echo "pending mode is on, please wait for the first block committed."
   fi
 else
   echo "Using existing database at $HOME/.laconicd.  To replace, run '`basename $0` clean'"
 fi
 
 # Start the node (remove the --pruning=nothing flag if historical queries are not needed)
-laconicd start --pruning=nothing --evm.tracer=json $TRACE --log_level $LOGLEVEL --minimum-gas-prices=0.0001aphoton --json-rpc.api eth,txpool,personal,net,debug,web3,miner --api.enable --gql-server --gql-playground
+laconicd start \
+  --pruning=nothing \
+  --evm.tracer=json $TRACE \
+  --log_level $LOGLEVEL \
+  --minimum-gas-prices=0.0001aphoton \
+  --json-rpc.api eth,txpool,personal,net,debug,web3,miner \
+  --api.enable \
+  --gql-server --gql-playground
diff --git a/proto/vulcanize/registry/v1beta1/registry.proto b/proto/vulcanize/registry/v1beta1/registry.proto
@@ -55,7 +55,7 @@ message Params {
   ];
 }
 
-// Params defines the registry module records
+// Record defines a registry record
 message Record {
   string              id          = 1 [(gogoproto.moretags) = "json:\"id\" yaml:\"id\""];
   string              bond_id     = 2 [(gogoproto.moretags) = "json:\"bondId\" yaml:\"bondId\""];
@@ -68,7 +68,7 @@ message Record {
   string              type        = 9 [(gogoproto.moretags) = "json:\"types\" yaml:\"types\""];
 }
 
-// AuthorityEntry defines the registry module AuthorityEntries
+// AuthorityEntry defines a registry authority
 message AuthorityEntry {
   string        name  = 1;
   NameAuthority entry = 2;
@@ -98,7 +98,7 @@ message NameEntry {
   NameRecord entry = 2;
 }
 
-// NameRecord
+// NameRecord defines a versioned name record
 message NameRecord {
   NameRecordEntry          latest  = 1;
   repeated NameRecordEntry history = 2;

diff --git a/tests/sdk_tests/Dockerfile-sdk b/tests/sdk_tests/Dockerfile-sdk
diff --git a/tests/sdk_tests/build-laconicd-container.sh b/tests/sdk_tests/build-laconicd-container.sh
@@ -1,3 +1,2 @@
 #!/usr/bin/env bash
-docker build -t cerc-io/laconicd:local-test ../../
-
+docker build -t cerc/laconicd:local ../.. --progress=plain
diff --git a/tests/sdk_tests/build-sdk-test-container.sh b/tests/sdk_tests/build-sdk-test-container.sh