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

docs: fix readme test docs, and add test comments to makefile #225

Merged
merged 3 commits into from
Jan 8, 2025
Merged

Conversation

litt3
Copy link
Collaborator

@litt3 litt3 commented Jan 8, 2025

  • These doc updates are being made in advance of the next proxy release

@litt3 litt3 self-assigned this Jan 8, 2025
Signed-off-by: litt3 <[email protected]>
@samlaf
Copy link
Collaborator

samlaf commented Jan 8, 2025

@litt3 guessing this is no longer a draft given that you requested reviews?

Copy link
Collaborator

@samlaf samlaf left a comment

Choose a reason for hiding this comment

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

LGTM. unsure about the naming e2e-test though, left a comment. But don't want to block the release for a small thing like this, so approving.


### Holesky
End-to-end (E2E) tests can be ran via `make e2e-test`. These tests use the [op-e2e](https://github.com/ethereum-optimism/optimism/tree/develop/op-e2e) framework for asserting correct interaction behaviors with batch submission and state derivation.
Copy link
Collaborator

Choose a reason for hiding this comment

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

Why did we switch from calling the make target optimism-test to e2e-test? I'm guessing these e2e test also test some nitro stuff? If not, should we just change the name back to test-optimism-integration? cc @epociask

Copy link
Collaborator

Choose a reason for hiding this comment

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

we initially had a separate entry-point (i.e, OP env flag) for these tests independent of the other E2E tests. Now e2e-test is a superset of optimism-test

Copy link
Collaborator

Choose a reason for hiding this comment

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

test some nitro stuff

Nop we currently don't do any E2E nitro tests in proxy directly. Could be worth exploring in the future

Copy link
Collaborator

Choose a reason for hiding this comment

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

let's also add an additional section specifying that these tests also assert E2E client <-> server interactions using simple/op clients

Copy link
Collaborator Author

Choose a reason for hiding this comment

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

Added verbatim c5d6f0d

@litt3 litt3 marked this pull request as ready for review January 8, 2025 19:35
Copy link
Collaborator

@ethenotethan ethenotethan left a comment

Choose a reason for hiding this comment

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

Nice - just one comment 🙏🏻


### Holesky
End-to-end (E2E) tests can be ran via `make e2e-test`. These tests use the [op-e2e](https://github.com/ethereum-optimism/optimism/tree/develop/op-e2e) framework for asserting correct interaction behaviors with batch submission and state derivation.
Copy link
Collaborator

Choose a reason for hiding this comment

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

let's also add an additional section specifying that these tests also assert E2E client <-> server interactions using simple/op clients

@litt3 litt3 requested a review from ethenotethan January 8, 2025 20:16
Copy link
Collaborator

@ethenotethan ethenotethan left a comment

Choose a reason for hiding this comment

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

LGTM

@litt3 litt3 merged commit 0fb5ae8 into main Jan 8, 2025
9 checks passed
@litt3 litt3 deleted the test-info branch January 8, 2025 21:31
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.

3 participants