Improve test legibility (#388)

* use gotestsum test runner for validation checks

color coded output with summary at the end

* flatten out test nesting

* use CHAIN_ID in justfile

* use gotestsum everywhere in justfile

* install gotestsum globally in CI

Author: geoknee

.circleci/config.yml

@@ -55,6 +55,9 @@ jobs:
     steps:
       - checkout
       - install-just
+      - run:
+          name: Install gotestsum
+          command: go install gotest.tools/gotestsum@latest
       - run:
           # need foundry to execute 'cast call' within add-chain script
           name: Install foundry

justfile

@@ -29,20 +29,20 @@ test-all: test-add-chain test-superchain test-validation
 test-add-chain:
 	# We separate the first test from the rest because it generates artifacts
 	# Which need to exist before the remaining tests run.
-	go test ./add-chain/... -run TestAddChain_Main -v
-	go test ./add-chain/... -run '[^TestAddChain_Main]' -v
+	TEST_DIRECTORY=./add-chain go run gotest.tools/gotestsum@latest --format testname -- -run TestAddChain_Main
+	TEST_DIRECTORY=./add-chain go run gotest.tools/gotestsum@latest --format testname -- -run '[^TestAddChain_Main]'
 
 # Test all Go code in the superchain module
 test-superchain:
-	go test ./superchain/... -v
+	TEST_DIRECTORY=./superchain go run gotest.tools/gotestsum@latest --format testname
 
 # Test all Go code in the validation module
-test-validation:
-	go test ./validation/... -v
+test-validation: clean-add-chain
+	TEST_DIRECTORY=./validation go run gotest.tools/gotestsum@latest --format testname
 
 # Run validation checks for chains with a name or chain ID matching the supplied regex, example: just validate 10
-validate CHAIN:
-	go test ./validation/... -v -run=TestValidation/{{CHAIN}}
+validate CHAIN_ID:
+	TEST_DIRECTORY=./validation go run gotest.tools/gotestsum@latest --format testname -- -run=TestValidation/{{CHAIN_ID}}
 
 # Clean test files generated by the add-chain tooling
 clean-add-chain:

validation/validation_test.go

@@ -19,23 +19,16 @@ func TestValidation(t *testing.T) {
 }
 
 func testValidation(t *testing.T, chain *ChainConfig) {
-	t.Run("Universal Checks", func(t *testing.T) {
-		testUniversal(t, chain)
-	})
-
-	t.Run("Standard Chain", func(t *testing.T) {
-		if chain.SuperchainLevel != Standard {
-			t.Skip("Chain excluded from this check (NOT a Standard Chain)")
-		}
-		testStandard(t, chain)
-	})
+	testUniversal(t, chain)
 
-	t.Run("Standard or Standard Candidate Chain", func(t *testing.T) {
-		if !chain.StandardChainCandidate && chain.SuperchainLevel != Standard {
-			t.Skip("Chain excluded from this check (NOT a Standard or a Standard Candidate Chain)")
-		}
+	if chain.SuperchainLevel == Standard ||
+		(chain.SuperchainLevel == Frontier && chain.StandardChainCandidate) {
 		testStandardCandidate(t, chain)
-	})
+	}
+
+	if chain.SuperchainLevel == Standard {
+		testStandard(t, chain)
+	}
 }
 
 // testUniversal should be applied to each chain in the registry
@@ -60,18 +53,17 @@ func testUniversal(t *testing.T, chain *ChainConfig) {
 
 // testStandardCandidate applies to Standard and Standard Candidate Chains.
 func testStandardCandidate(t *testing.T, chain *ChainConfig) {
-	t.Run("Standard Config Params", func(t *testing.T) {
-		t.Run("Data Availability", func(t *testing.T) { testDataAvailability(t, chain) })
-		t.Run("Resource Config", func(t *testing.T) { testResourceConfig(t, chain) })
-		t.Run("L2OO Params", func(t *testing.T) { testL2OOParams(t, chain) })
-		t.Run("Gas Limit", func(t *testing.T) { testGasLimit(t, chain) })
-		t.Run("GPO Params", func(t *testing.T) { testGasPriceOracleParams(t, chain) })
-		t.Run("Superchain Config", func(t *testing.T) { testSuperchainConfig(t, chain) })
-	})
-	t.Run("Standard Config Roles", func(t *testing.T) {
-		t.Run("L1 Security Config", func(t *testing.T) { testL1SecurityConfig(t, chain.ChainID) })
-		t.Run("L2 Security Config", func(t *testing.T) { testL2SecurityConfig(t, chain) })
-	})
+	// Standard Config Params
+	t.Run("Data Availability", func(t *testing.T) { testDataAvailability(t, chain) })
+	t.Run("Resource Config", func(t *testing.T) { testResourceConfig(t, chain) })
+	t.Run("L2OO Params", func(t *testing.T) { testL2OOParams(t, chain) })
+	t.Run("Gas Limit", func(t *testing.T) { testGasLimit(t, chain) })
+	t.Run("GPO Params", func(t *testing.T) { testGasPriceOracleParams(t, chain) })
+	t.Run("Superchain Config", func(t *testing.T) { testSuperchainConfig(t, chain) })
+	// Standard Config Roles
+	t.Run("L1 Security Config", func(t *testing.T) { testL1SecurityConfig(t, chain.ChainID) })
+	t.Run("L2 Security Config", func(t *testing.T) { testL2SecurityConfig(t, chain) })
+	// Standard Contract Versions
 	t.Run("Standard Contract Versions", func(t *testing.T) {
 		testContractsMatchATag(t, chain)
 	})