more efExample tests and eof exceptions #550

winsvega · 2024-05-09T10:52:28Z

🗒️ Description

add more eof exceptions and tests from efExample by Ori

🔗 Related Issues

✅ Checklist

All: Set appropriate labels for the changes.
All: Considered squashing commits to improve commit history.
All: Added an entry to CHANGELOG.md.
All: Considered updating the online docs in the ./docs/ directory.
Tests: All converted JSON/YML tests from ethereum/tests have been added to converted-ethereum-tests.txt.
Tests: Included the type and version of evm t8n tool used to locally execute test cases: e.g., ref with commit hash or geth 1.13.1-stable-3f40e65.
Tests: Ran mkdocs serve locally and verified the auto-generated docs for new tests in the Test Case Reference are correctly formatted.

winsvega · 2024-05-15T11:55:29Z

src/ethereum_test_tools/eof/v1/__init__.py

@@ -209,6 +209,9 @@ def list_header(sections: List["Section"]) -> bytes:
        Creates the single code header for all code sections contained in
        the list.
        """
+        if sections[0].skip_header_listing:


this is to allow types section to use skip_header_listing flag

chfast · 2024-05-20T09:05:30Z

tests/prague/eip7692_eof_v1/eip3540_eof_v1/test_example_valid_invalid.py

@@ -384,6 +391,874 @@
            EOFException.UNDEFINED_INSTRUCTION,
            id="jump_jumpdest_fails",
        ),
+        pytest.param(


We discussed with @marioevz and @danceratopz that this array with tests is not great. I don't mind some much the array but maybe it should be a separate test?

But what is bad that we add a ton of sophisticated tests to "example" category.

You should also add test cases to the EOF tracker file.

I personally find it confusing when such an array is stored in another file, but here it is quite transparent

I think the problem is that tests/prague/eip7692_eof_v1/eip3540_eof_v1/test_example_valid_invalid.py contains too many unrelated test cases.

For example it tries to cover many of the deprecated opcodes but not all of them.

We need to break up test_example_valid_invalid into different coherent test functions testing similar things, it's too big, and it makes it difficult to find a specific test case (also no longer an "example", it contains multiple valid tests).

marioevz

Some comments on the readability. I think we should make test cases easier to find in general, with better categorization, and splitting them in files where it makes sense, instead of having everything in one file/function.

marioevz · 2024-05-30T22:28:36Z

src/ethereum_test_tools/exceptions/exceptions.py

@@ -247,6 +247,10 @@ class EOFException(ExceptionBase):
    """
    EOF container missing code section
    """
+    MISSING_DATA_SECTION = auto()


I think this is already in the main branch, so rebasing should remove this.

marioevz · 2024-05-30T22:30:18Z

tests/prague/eip7692_eof_v1/eip3540_eof_v1/test_example_valid_invalid.py

+                name="EOF1I0015",
+                sections=[
+                    Section.Code(
+                        code=Op.SELFDESTRUCT(1) + Op.STOP,


I don't understand the reason why we have two SELFDESTRUCT opcode tests here.

yes likely a copy paste, since the other test is actually testing data section

marioevz · 2024-05-30T22:34:10Z

tests/prague/eip7692_eof_v1/eip3540_eof_v1/test_example_valid_invalid.py

+            "ef000102000100030400010000800001305000ef",
+            EOFException.MISSING_TYPE_HEADER,
+            id="bad_type_section_order_3",
+        ),
    ],
 )
 def test_example_valid_invalid(


I think we should break this function up into different ones to make it easier to find implemented tests, and we can create different functions that really test similar things. E.g. we could make a test_deprecated_opcodes functions and parameterize it to each opcode that is deprecated in EOF (see V1_EOF_DEPRECATED_OPCODES in tests/prague/eip7692_eof_v1/eip3540_eof_v1/opcodes.py, which actually needs an update), and another one for header failures, etc.

Also, I think there's definitely duplicates between this file and file tests/prague/eip7692_eof_v1/eip3540_eof_v1/container.py, which also should be cleaned up, but perhaps in a follow up PR.

marioevz · 2024-05-30T22:34:56Z

tests/prague/eip7692_eof_v1/eip3540_eof_v1/test_section_order.py

+)
+from ethereum_test_tools.eof.v1.constants import NON_RETURNING_SECTION
+
+from .spec import EOF_FORK_NAME


Suggested change

from .spec import EOF_FORK_NAME

from .. import EOF_FORK_NAME

On latest commit in main, this is where the EOF_FORK_NAME is actually defined.

marioevz · 2024-05-30T22:36:07Z

src/ethereum_test_tools/exceptions/exceptions.py

@@ -287,6 +291,10 @@ class EOFException(ExceptionBase):
    """
    EOF container header does not have types section first
    """
+    INVALID_CODE_SECTION_INDEX = auto()


This is ok, but I think that now some tests in the tests/prague/eip7692_eof_v1/eip6206_jumpf/test_jumpf_execution.py should be updated because they no longer fit the EOFException.UNDEFINED_EXCEPTION definition (because their exception is now defined with this change).

winsvega · 2024-06-12T07:55:26Z

this tests will be reworked

winsvega · 2024-10-09T08:00:16Z

I think this all has been implemented 2 times as of now.

winsvega marked this pull request as draft May 9, 2024 10:52

winsvega force-pushed the efExample branch from 15fa3e5 to 3bade1f Compare May 14, 2024 09:29

winsvega added the scope:tests Scope: Test cases label May 14, 2024

winsvega force-pushed the efExample branch 2 times, most recently from 2c68f7c to 5b4320f Compare May 15, 2024 11:53

winsvega marked this pull request as ready for review May 15, 2024 11:54

winsvega commented May 15, 2024

View reviewed changes

winsvega requested a review from marioevz May 16, 2024 10:06

chfast reviewed May 20, 2024

View reviewed changes

winsvega force-pushed the efExample branch from 96941d5 to fb06800 Compare May 22, 2024 13:39

winsvega added 5 commits May 27, 2024 10:59

more efExample tests and eof exceptions

ede650d

convert more efExample ori tests into valid invalid

9376209

eof sections order test

8b3ef6a

fix tox

816ed6a

rebase exceptions

5a2f5b2

winsvega force-pushed the efExample branch from fb06800 to 5a2f5b2 Compare May 27, 2024 09:08

marioevz reviewed May 30, 2024

View reviewed changes

winsvega mentioned this pull request Jun 5, 2024

feat(tests): eof section order tests #592

Merged

7 tasks

winsvega marked this pull request as draft June 12, 2024 07:55

winsvega closed this Oct 9, 2024

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

more efExample tests and eof exceptions #550

more efExample tests and eof exceptions #550

winsvega commented May 9, 2024 •

edited

Loading

winsvega May 15, 2024

chfast May 20, 2024

winsvega May 24, 2024

marioevz May 30, 2024 •

edited

Loading

marioevz left a comment

marioevz May 30, 2024

marioevz May 30, 2024

winsvega Jun 11, 2024

marioevz May 30, 2024

marioevz May 30, 2024

marioevz May 30, 2024

winsvega commented Jun 12, 2024

winsvega commented Oct 9, 2024

more efExample tests and eof exceptions #550

more efExample tests and eof exceptions #550

Conversation

winsvega commented May 9, 2024 • edited Loading

🗒️ Description

🔗 Related Issues

✅ Checklist

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

marioevz May 30, 2024 • edited Loading

Choose a reason for hiding this comment

marioevz left a comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

winsvega commented Jun 12, 2024

winsvega commented Oct 9, 2024

winsvega commented May 9, 2024 •

edited

Loading

marioevz May 30, 2024 •

edited

Loading