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

Add bindings test to Sanctuary #1159

Merged
merged 7 commits into from
Nov 28, 2024

Conversation

ggiraldez
Copy link
Contributor

This PR adds a step to Sanctuary testing to exercise bindings. We now also consider a Sanctuary test to fail if any of the references found in it cannot be resolved to one (or possibly more) definitions.

This also includes a small binding rules fix to avoid crashing if we find a Solidity source file with an assembly block that has a YulPath with more than one identifier (eg. a member access like x.slot). This is properly tested in #1149, but without it running Sanctuary tests will crash since there are contracts with the aforementioned contents.

Sanctuary bundles all dependencies in the same source file, so all imports
should resolve to the same, sole file.
This happens when there is special member access in some Yul identifier (like
`x.slot` or `x.offset`). I think this issue was introduced when unreserving the
`address` keyword since that changed the structure of `YulPath`. There is a
proper test case in NomicFoundation#1149 already, but without this fix running Sanctuary with
existing rules crashes.
@ggiraldez ggiraldez requested a review from a team as a code owner November 25, 2024 19:24
Copy link

changeset-bot bot commented Nov 25, 2024

⚠️ No Changeset found

Latest commit: 58b8f91

Merging this PR will not cause a version bump for any packages. If these changes should not result in a new version, you're good to go. If these changes should result in a version bump, you need to add a changeset.

This PR includes no changesets

When changesets are added to this PR, you'll see the packages that this PR includes changesets for and the associated semver types

Click here to learn what changesets are, and how to add one.

Click here if you're a maintainer who wants to add a changeset to this PR

Copy link
Contributor

@OmarTawfik OmarTawfik left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Left a couple of non-blocking questions. Mainly this: #1159 (comment)

@ggiraldez ggiraldez force-pushed the sanctuary-bindings-testing branch from d748a16 to 58b8f91 Compare November 26, 2024 21:40
@ggiraldez ggiraldez requested a review from OmarTawfik November 26, 2024 21:56
@ggiraldez ggiraldez added this pull request to the merge queue Nov 28, 2024
Merged via the queue into NomicFoundation:main with commit 6cb6190 Nov 28, 2024
1 check passed
@ggiraldez ggiraldez deleted the sanctuary-bindings-testing branch November 28, 2024 17:33
github-merge-queue bot pushed a commit that referenced this pull request Dec 2, 2024
I found this additional required fix after merging #1159. This is so
bindings can be processed for files with using directives on mapping
types without crashing. We want to merge this before #1149 to get a
meaningful baseline before those fixes are applied.
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.

2 participants