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

feat: common core for contracts Go check scripts #13134

Merged
merged 1 commit into from
Dec 2, 2024

Conversation

smartcontracts
Copy link
Contributor

Introduces a new common base framework for writing contracts check scripts in Go. Many of the check scripts basically do the exact same logic of somehow parsing either the interfaces or the artifact files. Goal of this small project is to make the process of writing new checks easier and more reliable.

We demonstrate this framework in action by porting the test-names script to use this new framework.

@smartcontracts smartcontracts requested review from a team as code owners November 27, 2024 22:30
@smartcontracts smartcontracts requested a review from Inphi November 27, 2024 22:30
@smartcontracts smartcontracts force-pushed the sc/common-check-core branch 2 times, most recently from d281ee0 to 958a813 Compare November 27, 2024 22:36
Copy link

codecov bot commented Nov 27, 2024

Codecov Report

Attention: Patch coverage is 67.69231% with 42 lines in your changes missing coverage. Please review.

Project coverage is 44.28%. Comparing base (601af96) to head (8a9d520).
Report is 31 commits behind head on develop.

Files with missing lines Patch % Lines
...es/contracts-bedrock/scripts/checks/common/util.go 72.00% 14 Missing and 7 partials ⚠️
...ontracts-bedrock/scripts/checks/test-names/main.go 61.81% 21 Missing ⚠️
Additional details and impacted files
@@             Coverage Diff             @@
##           develop   #13134      +/-   ##
===========================================
- Coverage    44.55%   44.28%   -0.27%     
===========================================
  Files          799      804       +5     
  Lines        71845    72447     +602     
===========================================
+ Hits         32009    32083      +74     
- Misses       37230    37753     +523     
- Partials      2606     2611       +5     
Flag Coverage Δ
cannon-go-tests-32 61.85% <ø> (-2.02%) ⬇️
cannon-go-tests-64 56.72% <ø> (-1.66%) ⬇️

Flags with carried forward coverage won't be shown. Click here to find out more.

Files with missing lines Coverage Δ
op-chain-ops/solc/types.go 0.00% <ø> (ø)
...es/contracts-bedrock/scripts/checks/common/util.go 72.00% <72.00%> (ø)
...ontracts-bedrock/scripts/checks/test-names/main.go 73.75% <61.81%> (ø)

... and 22 files with indirect coverage changes

Introduces a new common base framework for writing contracts
check scripts in Go. Many of the check scripts basically do the
exact same logic of somehow parsing either the interfaces or the
artifact files. Goal of this small project is to make the process
of writing new checks easier and more reliable.

We demonstrate this framework in action by porting the test-names
script to use this new framework.
@mslipper mslipper added this pull request to the merge queue Dec 2, 2024
Merged via the queue into develop with commit a2b1a7e Dec 2, 2024
45 checks passed
@mslipper mslipper deleted the sc/common-check-core branch December 2, 2024 20:05
sigma pushed a commit that referenced this pull request Dec 19, 2024
Introduces a new common base framework for writing contracts
check scripts in Go. Many of the check scripts basically do the
exact same logic of somehow parsing either the interfaces or the
artifact files. Goal of this small project is to make the process
of writing new checks easier and more reliable.

We demonstrate this framework in action by porting the test-names
script to use this new framework.
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

4 participants