From 0b04611f849ee030eaf759d48011a53e0656c158 Mon Sep 17 00:00:00 2001
From: Contrabang <91113370+Contrabang@users.noreply.github.com>
Date: Sun, 5 May 2024 15:53:31 -0400
Subject: [PATCH] Adds CI for SQL versions (#25226)

* wow

* LETS GO

* e

* epic, LGTM

* spacing

* wow
---
 .github/workflows/ci.yml       |   1 +
 tools/ci/verify_sql_version.py | 106 +++++++++++++++++++++++++++++++++
 2 files changed, 107 insertions(+)
 create mode 100644 tools/ci/verify_sql_version.py

diff --git a/.github/workflows/ci.yml b/.github/workflows/ci.yml
index 25df92cd348..31e4675cccb 100644
--- a/.github/workflows/ci.yml
+++ b/.github/workflows/ci.yml
@@ -49,6 +49,7 @@ jobs:
           python tools/ci/illegal_dme_files.py ${GITHUB_WORKSPACE}
           python tools/ci/define_sanity.py
           python tools/ci/restrict_file_types.py
+          python tools/ci/verify_sql_version.py
           python -m tools.ci.check_icon_conflicts
           python -m tools.ci.check_icon_dupenames
           python -m tools.maplint.source --github
diff --git a/tools/ci/verify_sql_version.py b/tools/ci/verify_sql_version.py
new file mode 100644
index 00000000000..19c262c4d66
--- /dev/null
+++ b/tools/ci/verify_sql_version.py
@@ -0,0 +1,106 @@
+import os
+import re
+import sys
+import time
+from collections import namedtuple
+import tomllib
+from typing import Tuple, Union
+from pathlib import Path
+
+RED = "\033[0;31m"
+GREEN = "\033[0;32m"
+BLUE = "\033[0;34m"
+NC = "\033[0m"  # No Color
+
+def print_error(message: str, filename: str = None):
+    if os.getenv("GITHUB_ACTIONS") == "true": # We're on github, output in a special format.
+        if filename != None:
+            print(f"::error file={filename},title=SQL Version mismatch::{filename}: {RED}{message}{NC}")
+        else:
+            print(f"::error title=SQL Version mismatch:: {RED}{message}{NC}")
+    else:
+        if filename != None:
+            print(f"{filename}: {RED}{message}{NC}")
+        else:
+            print(f"ERROR: {RED}{message}{NC}")
+
+def get_sql_folder_version() -> Tuple[Union[str, None], int]:
+    folder_path = Path("SQL/updates")
+    highest_file = None
+    highest_version = 0
+    all_versions = [0]
+
+    for file_path in folder_path.iterdir():
+        if file_path.is_file():
+            filename = file_path.name
+            search_result = re.search(r"(\d+)-(\d+)\.", filename)
+            if search_result is None:
+                continue
+            old_version = int(search_result.group(1))
+            new_version = int(search_result.group(2))
+            if (old_version + 1) != new_version:
+                print_error(f"Missing SQL version update detected, {old_version}-{new_version}.sql should be {old_version}-{old_version+1}.sql")
+            if new_version > highest_version:
+                highest_version = new_version
+                highest_file = filename
+            all_versions.append(new_version)
+
+    for num in range(highest_version):
+        if num not in all_versions:
+            print_error(f"Missing SQL update for version {num}")
+
+    return highest_file, highest_version
+
+if __name__ == "__main__":
+    print("verify_sql_version started")
+
+    exit_code = 0
+    start = time.time()
+
+    config_path = "./config/example/config.toml"
+    define_path = "./code/__DEFINES/misc_defines.dm"
+    if os.path.exists(config_path):
+        with open(config_path, "rb") as config:
+            config_data = tomllib.load(config)
+        if not ("database_configuration" in config_data):
+            print_error(f"File containing config doesn't have a database_configuration section.", config_path)
+            exit_code = 1
+        elif "sql_version" in config_data["database_configuration"]:
+            config_sql = config_data["database_configuration"]["sql_version"]
+        else:
+            print_error(f"No default SQL version set in {config_path}.", config_path)
+            exit_code = 1
+    else:
+        print_error(f"File containing config the SQL version does not exist ({config_path}).")
+        exit_code = 1
+
+    if os.path.exists(define_path):
+        with open(define_path, "r") as define:
+            define_data = define.read()
+        if search_result := re.search(r"#define SQL_VERSION (\d+)", define_data):
+            define_sql = int(search_result.group(1))
+        else:
+            print_error(f"No byond define for SQL found in {define_path}.", define_path)
+            exit_code = 1
+    else:
+        print_error(f"File containing the byond define for the SQL version does not exist ({define_path}).")
+        exit_code = 1
+
+    updates_file, updates_folder_sql = get_sql_folder_version()
+
+    if updates_folder_sql <= 0 or not isinstance(updates_folder_sql, int) or updates_file is None:
+        print_error("Failed to find a proper updates folder SQL version.")
+        exit_code = 1
+    elif(exit_code == 0):
+        if config_sql != updates_folder_sql:
+            print_error(f"Updates file SQL version ({updates_folder_sql}) does not match the config SQL version ({config_sql}).", config_path)
+            exit_code = 1
+        if define_sql != updates_folder_sql:
+            print_error(f"Updates file SQL version ({updates_folder_sql}) does not match the byond define SQL version ({define_sql}).", define_path)
+            exit_code = 1
+
+    end = time.time()
+    print(f"verify_sql_version tests completed in {end - start:.2f}s\n")
+
+    sys.exit(exit_code)
+