mirror of
https://github.com/isledecomp/isle.git
synced 2025-10-23 00:14:22 +00:00
1ae3b07dc2
* First commit of order tool * More flexible match on module name. Bugfix on blank_or_comment * Report inexact offset comments in verbose mode. Bugfix for exact regex * Refactor checkorder into reusable isledecomp module * Find bad comments in one pass, add awareness of TEMPLATE * Refactor of state machine to prepare for reccmp integration * Use isledecomp lib in reccmp * Build isledecomp in GH actions, fix mypy complaint * Ensure unit test cpp files will be ignored by reccmp * Allow multiple offset markers, pep8 cleanup * Remove unused variable * Code style, remove unneeded module and TODO * Final renaming and type hints * Fix checkorder issues, add GH action and enforce (#2) * Fix checkorder issues * Add GH action * Test error case * Works * Fixes --------- Co-authored-by: Christian Semmler <mail@csemmler.com>
114 lines
3.7 KiB
Python
114 lines
3.7 KiB
Python
import pytest
|
|
from collections import namedtuple
|
|
from typing import List
|
|
from isledecomp.parser.util import (
|
|
is_blank_or_comment,
|
|
match_offset_comment,
|
|
is_exact_offset_comment,
|
|
distinct_by_module,
|
|
)
|
|
|
|
|
|
blank_or_comment_param = [
|
|
(True, ''),
|
|
(True, '\t'),
|
|
(True, ' '),
|
|
(False, '\tint abc=123;'),
|
|
(True, '// OFFSET: LEGO1 0xdeadbeef'),
|
|
(True, ' /* Block comment beginning'),
|
|
(True, 'Block comment ending */ '),
|
|
|
|
# TODO: does clang-format have anything to say about these cases?
|
|
(False, 'x++; // Comment folows'),
|
|
(False, 'x++; /* Block comment begins'),
|
|
]
|
|
|
|
|
|
@pytest.mark.parametrize('expected, line', blank_or_comment_param)
|
|
def test_is_blank_or_comment(line: str, expected: bool):
|
|
assert is_blank_or_comment(line) is expected
|
|
|
|
|
|
offset_comment_samples = [
|
|
# (can_parse: bool, exact_match: bool, line: str)
|
|
# Should match both expected modules with optional STUB marker
|
|
(True, True, '// OFFSET: LEGO1 0xdeadbeef'),
|
|
(True, True, '// OFFSET: LEGO1 0xdeadbeef STUB'),
|
|
(True, True, '// OFFSET: ISLE 0x12345678'),
|
|
(True, True, '// OFFSET: ISLE 0x12345678 STUB'),
|
|
|
|
# No trailing spaces allowed
|
|
(True, False, '// OFFSET: LEGO1 0xdeadbeef '),
|
|
(True, False, '// OFFSET: LEGO1 0xdeadbeef STUB '),
|
|
|
|
# Must have exactly one space between elements
|
|
(True, False, '//OFFSET: ISLE 0xdeadbeef'),
|
|
(True, False, '// OFFSET:ISLE 0xdeadbeef'),
|
|
(True, False, '// OFFSET: ISLE 0xdeadbeef'),
|
|
(True, False, '// OFFSET: ISLE 0xdeadbeef'),
|
|
(True, False, '// OFFSET: ISLE 0xdeadbeef'),
|
|
(True, False, '// OFFSET: ISLE 0xdeadbeef STUB'),
|
|
|
|
# Must have 0x prefix for hex number
|
|
(True, False, '// OFFSET: ISLE deadbeef'),
|
|
|
|
# Offset, module name, and STUB must be uppercase
|
|
(True, False, '// offset: ISLE 0xdeadbeef'),
|
|
(True, False, '// offset: isle 0xdeadbeef'),
|
|
(True, False, '// OFFSET: LEGO1 0xdeadbeef stub'),
|
|
|
|
# Hex string must be lowercase
|
|
(True, False, '// OFFSET: ISLE 0xDEADBEEF'),
|
|
|
|
# TODO: How flexible should we be with matching the module name?
|
|
(True, True, '// OFFSET: OMNI 0x12345678'),
|
|
(True, True, '// OFFSET: LEG01 0x12345678'),
|
|
(True, False, '// OFFSET: hello 0x12345678'),
|
|
|
|
# Not close enough to match
|
|
(False, False, '// OFFSET: ISLE0x12345678'),
|
|
(False, False, '// OFFSET: 0x12345678'),
|
|
(False, False, '// LEGO1: 0x12345678'),
|
|
|
|
# Hex string shorter than 8 characters
|
|
(True, True, '// OFFSET: LEGO1 0x1234'),
|
|
|
|
# TODO: These match but shouldn't.
|
|
# (False, False, '// OFFSET: LEGO1 0'),
|
|
# (False, False, '// OFFSET: LEGO1 0x'),
|
|
]
|
|
|
|
|
|
@pytest.mark.parametrize('match, exact, line', offset_comment_samples)
|
|
def test_offset_match(line: str, match: bool, exact):
|
|
did_match = match_offset_comment(line) is not None
|
|
assert did_match is match
|
|
|
|
|
|
@pytest.mark.parametrize('match, exact, line', offset_comment_samples)
|
|
def test_exact_offset_comment(line: str, exact: bool, match):
|
|
assert is_exact_offset_comment(line) is exact
|
|
|
|
|
|
# Helper for the next test: cut down version of OffsetMatch
|
|
MiniOfs = namedtuple('MiniOfs', ['module', 'value'])
|
|
|
|
distinct_by_module_samples = [
|
|
# empty set
|
|
([], []),
|
|
# same module name
|
|
([MiniOfs('TEST', 123), MiniOfs('TEST', 555)],
|
|
[MiniOfs('TEST', 123)]),
|
|
# same module name, case-insensitive
|
|
([MiniOfs('test', 123), MiniOfs('TEST', 555)],
|
|
[MiniOfs('test', 123)]),
|
|
# duplicates, non-consecutive
|
|
([MiniOfs('test', 123), MiniOfs('abc', 111), MiniOfs('TEST', 555)],
|
|
[MiniOfs('test', 123), MiniOfs('abc', 111)]),
|
|
]
|
|
|
|
|
|
@pytest.mark.parametrize('sample, expected', distinct_by_module_samples)
|
|
def test_distinct_by_module(sample: List[MiniOfs], expected: List[MiniOfs]):
|
|
assert distinct_by_module(sample) == expected
|