Skip to content

test only relevant packages for subnet-evm #4345

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 6 commits into from
Oct 1, 2025
Merged

test only relevant packages for subnet-evm #4345

Changes from all commits
Commits
Show all changes
6 commits
Select commit Hold shift + click to select a range
9867c0c
use only relevant package to subnet-evm
ceyonur Sep 25, 2025
7726b74
add comment
ceyonur Sep 26, 2025
172ef82
Update imports_test.go
ceyonur Sep 26, 2025
d112959
Update imports_test.go
ceyonur Sep 26, 2025
b509767
clarify comment
ceyonur Sep 26, 2025
87cd08f
add comments
ceyonur Sep 26, 2025
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
21 changes: 15 additions & 6 deletions tests/imports_test.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -12,16 +12,25 @@ import (
"github.com/ava-labs/avalanchego/utils/packages"
)

// TestMustNotImport tests that we do not import certain packages (like coreth's customtypes package) that would configure libevm globals.
// Libevm panics if a package tries to register a custom type or extra after the globals have been configured (re-registration).
// E2E test packages are used both from Subnet-EVM and Coreth.
// Registering the libevm globals here in these packages does not necessarily break avalanchego e2e testing, but Subnet-EVM (or Coreth) E2E testing.
// So any illegal use here will only be a problem once Subnet-EVM or Coreth bumps the avalanchego version, breaking the release cycles of
// AvalancheGo and other repositories.
// Transitory imports are also checked with packages.GetDependencies.
func TestMustNotImport(t *testing.T) {
require := require.New(t)

// These packages configure libevm globally by registering custom types and extras.
illegalPaths := []string{
"github.com/ava-labs/coreth/params",
"github.com/ava-labs/coreth/plugin/evm/customtypes",
}
mustNotImport := map[string][]string{
// Importing these packages configures libevm globally. This must not be
// done to support both coreth and subnet-evm.
"tests/...": {
"github.com/ava-labs/coreth/params",
"github.com/ava-labs/coreth/plugin/evm/customtypes",
},
"tests/": illegalPaths,
"tests/antithesis/": illegalPaths,
"tests/fixture/...": illegalPaths,
}
for packageName, forbiddenImports := range mustNotImport {
packagePath := path.Join("github.com/ava-labs/avalanchego", packageName)
Expand Down