dedupe perChainTestName

ethereum-optimism · Aug 29, 2024 · 4cbf389 · 4cbf389
1 parent 4ebaafc
commit 4cbf389
Show file tree

Hide file tree

Showing 5 changed files with 19 additions and 16 deletions.
diff --git a/validation/common/common.go b/validation/common/common.go
@@ -0,0 +1,12 @@
+package common
+
+import (
+	"fmt"
+	. "github.com/ethereum-optimism/superchain-registry/superchain"
+)
+
+
+// PerChainTestName ensures test can easily be filtered by chain name or chain id using the -run=regex testflag.
+func PerChainTestName(chain *ChainConfig) string {
+	return chain.Name + fmt.Sprintf(" (%d)", chain.ChainID)
+}
diff --git a/validation/genesis/genesis-predeploy_test.go b/validation/genesis/genesis-predeploy_test.go
@@ -15,19 +15,14 @@ import (
 	"strings"
 	"testing"
 
-	"github.com/ethereum-optimism/superchain-registry/superchain"
 	. "github.com/ethereum-optimism/superchain-registry/superchain"
+	. "github.com/ethereum-optimism/superchain-registry/validation/common"
 	"github.com/ethereum/go-ethereum/common"
+
 	"github.com/ethereum/go-ethereum/core"
 	"github.com/stretchr/testify/require"
 )
 
-// TODO deduplicate this
-// perChainTestName ensures test can easily be filtered by chain name or chain id using the -run=regex testflag.
-func perChainTestName(chain *superchain.ChainConfig) string {
-	return chain.Name + fmt.Sprintf(" (%d)", chain.ChainID)
-}
-
 var temporaryOptimismDir string
 
 func TestGenesisPredeploys(t *testing.T) {
@@ -47,7 +42,7 @@ func TestGenesisPredeploys(t *testing.T) {
 
 	for _, chain := range OPChains {
 		if chain.SuperchainLevel == Standard || chain.StandardChainCandidate {
-			t.Run(perChainTestName(chain), func(t *testing.T) {
+			t.Run(PerChainTestName(chain), func(t *testing.T) {
 				// Do not run in parallel
 				testGenesisPredeploys(t, chain)
 			})

diff --git a/validation/promotion_test.go b/validation/promotion_test.go
@@ -4,14 +4,15 @@ import (
 	"testing"
 
 	. "github.com/ethereum-optimism/superchain-registry/superchain"
+	"github.com/ethereum-optimism/superchain-registry/validation/common"
 )
 
 // WARNING: this test must not run along side any other tests, because it mutates global objects.
 // It should be strictly isolated.
 func TestPromotion(t *testing.T) {
 	for _, chain := range OPChains {
 		chain := chain
-		t.Run(perChainTestName(chain), func(t *testing.T) {
+		t.Run(common.PerChainTestName(chain), func(t *testing.T) {
 			t.Parallel()
 			if chain.StandardChainCandidate {
 				// do not allow any test exclusions

diff --git a/validation/utils_test.go b/validation/utils_test.go
@@ -5,16 +5,10 @@ import (
 	"math/big"
 	"testing"
 
-	"github.com/ethereum-optimism/superchain-registry/superchain"
 	"github.com/stretchr/testify/assert"
 	"github.com/stretchr/testify/require"
 )
 
-// perChainTestName ensures test can easily be filtered by chain name or chain id using the -run=regex testflag.
-func perChainTestName(chain *superchain.ChainConfig) string {
-	return chain.Name + fmt.Sprintf(" (%d)", chain.ChainID)
-}
-
 // isBigIntWithinBounds returns true if actual is within bounds, where the bounds are [lower bound, upper bound] and are inclusive.
 var isBigIntWithinBounds = func(actual *big.Int, bounds [2]*big.Int) bool {
 	if (bounds[1].Cmp(bounds[0])) < 0 {

diff --git a/validation/validation_test.go b/validation/validation_test.go
@@ -4,14 +4,15 @@ import (
 	"testing"
 
 	. "github.com/ethereum-optimism/superchain-registry/superchain"
+	"github.com/ethereum-optimism/superchain-registry/validation/common"
 )
 
 func TestValidation(t *testing.T) {
 	// Entry point for validation checks which run
 	// on each OP chain.
 	for _, chain := range OPChains {
 		chain := chain
-		t.Run(perChainTestName(chain), func(t *testing.T) {
+		t.Run(common.PerChainTestName(chain), func(t *testing.T) {
 			t.Parallel()
 			testValidation(t, chain)
 		})