new(tests): Add exhaustive EOF stack underflow tests (#1378)

Author: chfast

tests/osaka/eip7692_eof_v1/eip5450_stack/test_code_validation.py

@@ -2,18 +2,19 @@
 
 import itertools
 from enum import Enum, auto, unique
-from typing import Tuple
+from typing import Generator, Tuple
 
 import pytest
 
 from ethereum_test_exceptions.exceptions import EOFException
 from ethereum_test_tools import EOFTestFiller
 from ethereum_test_tools.eof.v1 import Container, Section
 from ethereum_test_tools.vm.opcode import Opcodes as Op
-from ethereum_test_types.eof.v1.constants import NON_RETURNING_SECTION
+from ethereum_test_types.eof.v1.constants import MAX_OPERAND_STACK_HEIGHT, NON_RETURNING_SECTION
 from ethereum_test_vm.bytecode import Bytecode
 
 from .. import EOF_FORK_NAME
+from ..eip3540_eof_v1.test_all_opcodes_in_container import valid_eof_opcodes
 
 REFERENCE_SPEC_GIT_PATH = "EIPS/eip-5450.md"
 REFERENCE_SPEC_VERSION = "f20b164b00ae5553f7536a6d7a83a0f254455e09"
@@ -433,3 +434,54 @@ def test_rjumps_jumpf_nonreturning(
         possible_exceptions.append(EOFException.INVALID_NON_RETURNING_FLAG)
 
     eof_test(container=Container(sections=sections), expect_exception=possible_exceptions or None)
+
+
+def gen_stack_underflow_params() -> Generator[Tuple[Op, int], None, None]:
+    """Generate parameters for stack underflow tests."""
+    for op in sorted(valid_eof_opcodes):
+        if op.min_stack_height == 0:
+            continue
+        if op in (Op.EOFCREATE, Op.RETURNCODE):
+            continue
+        yield op, 0
+        if op.min_stack_height > 1:
+            yield op, op.min_stack_height - 1
+
+
+@pytest.mark.parametrize("spread", [0, 1, MAX_OPERAND_STACK_HEIGHT])
+@pytest.mark.parametrize("op,stack_height", gen_stack_underflow_params())
+def test_all_opcodes_variadic_stack_underflow(
+    eof_test: EOFTestFiller, op: Op, stack_height: int, spread: int
+):
+    """
+    Test EOF validation failing due to stack overflow
+    caused by the specific instruction `op`.
+    There is similar non-variadic test variant in test_all_opcodes_stack_underflow().
+    """
+    code = Bytecode()
+
+    # Check if the op increases the stack height (e.g. DUP instructions).
+    # We need to leave space for this increase not to cause stack overflow.
+    stack_height_increase = max(op.pushed_stack_items - op.popped_stack_items, 0)
+    # Cap the spread if it would exceed the maximum stack height.
+    spread = min(spread, MAX_OPERAND_STACK_HEIGHT - (stack_height + stack_height_increase))
+    # Create a range stack height of 0-spread.
+    code = Op.RJUMPI[spread](Op.CALLVALUE) + Op.PUSH0 * spread
+
+    # Create the desired stack height.
+    code += Op.PUSH0 * stack_height
+
+    if op.has_data_portion():
+        code += op[0]  # produce required imm bytes
+    else:
+        code += op
+
+    if not op.terminating:
+        code += Op.STOP
+
+    eof_test(
+        container=Container(
+            sections=[Section.Code(code)],
+            validity_error=EOFException.STACK_UNDERFLOW,
+        )
+    )

tests/osaka/eip7692_eof_v1/eof_tracker.md

@@ -237,10 +237,10 @@
 
 #### Stack underflow
 
-- [ ] Stack underflows (ethereum/tests: ./src/EOFTestsFiller/efExample/validInvalidFiller.yml )
+- [x] Stack underflows ([`tests/osaka/eip7692_eof_v1/eip5450_stack/test_code_validation.py::test_all_opcodes_variadic_stack_underflow`](./eip5450_stack/test_code_validation/test_all_opcodes_variadic_stack_underflow.md))
 - [x] Stack underflow with enough items available in caller stack - can't dig into caller frame ([`tests/osaka/eip7692_eof_v1/eip4750_functions/test_code_validation.py::test_eof_validity`](./eip4750_functions/test_code_validation/test_eof_validity.md))
-- [ ] Stack underflow in variable stack segment, only min underflow (ethereum/tests: src/EOFTestsFiller/efStack/underflow_variable_stack_Copier.json)
-- [ ] Stack underflow in variable stack segment, both min and max underflow (ethereum/tests: src/EOFTestsFiller/efStack/underflow_variable_stack_Copier.json)
+- [x] Stack underflow in variable stack segment, only min underflow ([`tests/osaka/eip7692_eof_v1/eip5450_stack/test_code_validation.py::test_all_opcodes_variadic_stack_underflow`](./eip5450_stack/test_code_validation/test_all_opcodes_variadic_stack_underflow.md))
+- [x] Stack underflow in variable stack segment, both min and max underflow ([`tests/osaka/eip7692_eof_v1/eip5450_stack/test_code_validation.py::test_all_opcodes_variadic_stack_underflow`](./eip5450_stack/test_code_validation/test_all_opcodes_variadic_stack_underflow.md))
 
 #### CALLF