Skip to content
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.

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

EVM Engineering: properly apply test name checks #12800

Open
3 tasks done
smartcontracts opened this issue Nov 3, 2024 · 0 comments
Open
3 tasks done

EVM Engineering: properly apply test name checks #12800

smartcontracts opened this issue Nov 3, 2024 · 0 comments
Assignees

Comments

@smartcontracts
Copy link
Contributor

smartcontracts commented Nov 3, 2024

We have a Go script that checks that test names follow a specific convention that can be found here. The conventions in this script are also described in STYLE_GUIDE.md. However, many tests break this convention because the script was never actually enabled in CI after being introduced. Simply run just lint-forge-tests-check to see this.

We would like to apply this naming convention properly to all tests. We need to follow a multi-step process to achieve this task:

  • Update the script to have an exclude list variable that excludes every test file where the check currently fails
  • Enable the script in CI as part of contracts-bedrock-checks as well as part of just check inside the justfile
  • Clean up the test files over a number of PRs that remove that test file from the exclusion list and fix the test format

Also, let's rename the go script from scripts/checks/names to scripts/checks/test-names since it's more clear.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
Status: In Review
Development

No branches or pull requests

2 participants