Files
Bubberstation/tools/validate_dme.py
SkyratBot 51484bf516 [MIRROR] Fixes the dme validator erroring on an error for duplicate lines [MDB IGNORE] (#19066)
Fixes the dme validator erroring on an error for duplicate lines (#73061)

## About The Pull Request

Wouldn't show the actual error due to an error in the throw:
```
Traceback (most recent call last):
  File "P:\goonstation\tools\ci\validate_dme.py", line 92, in <module>
    sorted_lines = sorted(lines, key = functools.cmp_to_key(compare_lines))
                   ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
  File "P:\goonstation\tools\ci\validate_dme.py", line 90, in compare_lines
    raise f"Two lines were exactly the same ({a} vs. {b})"
TypeError: exceptions must derive from BaseException
```

With my change:
```
Traceback (most recent call last):
  File "P:\goonstation\tools\ci\validate_dme.py", line 92, in <module>
    sorted_lines = sorted(lines, key = functools.cmp_to_key(compare_lines))
                   ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
  File "P:\goonstation\tools\ci\validate_dme.py", line 90, in compare_lines
    raise ValueError(f"Two lines were exactly the same ({a} vs. {b})")
ValueError: Two lines were exactly the same (code\serialization.dm vs. code\serialization.dm)
```

I thought about `ImportWarning` but too much work to decide

## Why It's Good For The Game

not broeken

from ur favorite Big Daddy upstream ❤️ 

## Changelog

no

---------

Co-authored-by: ZeWaka <zewakagamer@gmail.com>
Co-authored-by: Mothblocks <35135081+Mothblocks@users.noreply.github.com>
2023-02-02 16:12:39 +00:00

97 lines
2.8 KiB
Python

import fnmatch
import functools
import glob
import sys
reading = False
FORBID_INCLUDE = [
# Included by _unit_test.dm
r'code/modules/unit_tests/[!_]*.dm',
# Included by tgs/includes.dm
r'code/modules/tgs/**/*.dm',
]
lines = []
total = 0
for line in sys.stdin:
total+=1
line = line.strip()
if line == "// BEGIN_INCLUDE":
reading = True
continue
elif line == "// END_INCLUDE":
break
elif not reading:
continue
lines.append(line)
offset = total - len(lines)
print(f"{offset} lines were ignored in output")
fail_no_include = False
code_files = glob.glob("code/**/*.dm", recursive=True) + glob.glob("modular_skyrat/**/*.dm", recursive=True) # SKYRAT EDIT CHANGE
for code_file in code_files: # SKYRAT EDIT CHANGE
dm_path = code_file.replace('/', '\\')
included = f"#include \"{dm_path}\"" in lines
forbid_include = False
for forbid in FORBID_INCLUDE:
if not fnmatch.fnmatch(code_file, forbid):
continue
forbid_include = True
if included:
print(f"{dm_path} should not be included")
print(f"::error file={code_file},line=1,title=DME Validator::File should not be included")
fail_no_include = True
if forbid_include:
continue
if not included:
print(f"{dm_path} is not included")
print(f"::error file={code_file},line=1,title=DME Validator::File is not included")
fail_no_include = True
if fail_no_include:
sys.exit(1)
def compare_lines(a, b):
# Remove initial include as well as the final quotation mark
a = a[len("#include \""):-1].lower()
b = b[len("#include \""):-1].lower()
a_segments = a.split('\\')
b_segments = b.split('\\')
for (a_segment, b_segment) in zip(a_segments, b_segments):
a_is_file = a_segment.endswith(".dm")
b_is_file = b_segment.endswith(".dm")
# code\something.dm will ALWAYS come before code\directory\something.dm
if a_is_file and not b_is_file:
return -1
if b_is_file and not a_is_file:
return 1
# interface\something.dm will ALWAYS come after code\something.dm
if a_segment != b_segment:
return (a_segment > b_segment) - (a_segment < b_segment)
print(f"Two lines were exactly the same ({a} vs. {b})")
sys.exit(1)
sorted_lines = sorted(lines, key = functools.cmp_to_key(compare_lines))
for (index, line) in enumerate(lines):
if sorted_lines[index] != line:
print(f"The include at line {index + offset} is out of order ({line}, expected {sorted_lines[index]})")
print(f"::error file=tgstation.dme,line={index+offset},title=DME Validator::The include at line {index + offset} is out of order ({line}, expected {sorted_lines[index]})")
sys.exit(1)