serverwatcher 2.2.4__tar.gz → 3.0__tar.gz

{serverwatcher-2.2.4/src/serverwatcher.egg-info → serverwatcher-3.0}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: serverwatcher
-Version: 2.2.4
+Version: 3.0
 Summary: A HungerLib-powered Minecraft server automation engine.
 Author: iFamished
 License: MIT

{serverwatcher-2.2.4 → serverwatcher-3.0}/pyproject.toml

@@ -7,7 +7,7 @@ build-backend = "setuptools.build_meta"
 
 [project]
 name = "serverwatcher"
-version = "2.2.4"
+version = "3.0"
 description = "A HungerLib-powered Minecraft server automation engine."
 readme = "README.md"
 requires-python = ">=3.10"

{serverwatcher-2.2.4 → serverwatcher-3.0}/src/serverwatcher/__init__.py

@@ -9,6 +9,7 @@ except PackageNotFoundError:
 from .watcher import ServerWatcher
 from .config import WatcherConfig
 from .messages import WatcherMessages
+from .schema import validate_config_schema, validate_messages_schema
 
 
 __all__ = [
@@ -16,4 +17,6 @@ __all__ = [
     'ServerWatcher',
     'WatcherConfig',
     'WatcherMessages',
+    'validate_config_schema',
+    'validate_messages_schema',
 ]

{serverwatcher-2.2.4 → serverwatcher-3.0}/src/serverwatcher/config.py

@@ -31,3 +31,9 @@ class WatcherConfig:
     restart_wait_seconds: int = 45
     restart_online_timeout: int = 120
     restart_online_interval: int = 2
+
+    # logger / misc
+    logger_name_template: str = "ServerWatcher-{server_name}"
+    log_path: str = "/home/container/logs/"
+    console_backspaces: int = 8
+    timezone: str = "America/Chicago"

serverwatcher-3.0/src/serverwatcher/schema.py

@@ -0,0 +1,45 @@
+from typing import Dict, Any, List
+
+from hungerlib.addons import validate_required_keys
+
+
+def validate_config_schema(raw: Dict[str, Any]) -> list[str]:
+    errors: List[str] = []
+
+    # top-level sections
+    errors += validate_required_keys(raw, ["panel", "origin", "server", "watcher"], "root")
+
+    panel = raw.get("panel", {})
+    origin = raw.get("origin", {})
+    server = raw.get("server", {})
+    watcher = raw.get("watcher", {})
+
+    errors += validate_required_keys(panel, ["name", "url", "api_key"], "panel")
+    errors += validate_required_keys(origin, ["server_id"], "origin")
+    errors += validate_required_keys(
+        server,
+        ["name", "server_id", "domain", "port", "rcon_port", "rcon_password", "tps_command"],
+        "server",
+    )
+
+    # simple sanity checks (optional but nice)
+    if "port" in server and not isinstance(server["port"], int):
+        errors.append("[server] 'port' must be an integer")
+    if "rcon_port" in server and not isinstance(server["rcon_port"], int):
+        errors.append("[server] 'rcon_port' must be an integer")
+
+    # watcher numeric sanity
+    if "ram_threshold" in watcher and watcher["ram_threshold"] <= 0:
+        errors.append("[watcher] 'ram_threshold' must be > 0")
+    if "cpu_threshold" in watcher and watcher["cpu_threshold"] <= 0:
+        errors.append("[watcher] 'cpu_threshold' must be > 0")
+
+    return errors
+
+
+def validate_messages_schema(raw: Dict[str, Any]) -> list[str]:
+    # you can make this as strict as you want; for now just ensure prefix exists
+    errors: List[str] = []
+    if "prefix" not in raw:
+        errors.append("[messages] Missing required key: 'prefix'")
+    return errors

{serverwatcher-2.2.4 → serverwatcher-3.0}/src/serverwatcher/watcher.py

@@ -12,11 +12,17 @@ from hungerlib.addons import (
     runCountdownEvents,
     ensure_yaml,
     load_yaml,
-    map_to_dataclass
+    map_to_dataclass,
+    write_default_yaml,
 )
 
 from .config import WatcherConfig
 from .messages import WatcherMessages
+from .schema import validate_config_schema, validate_messages_schema
+
+
+CONFIG_PATH = "config.yaml"
+MESSAGES_PATH = "messages.yaml"
 
 
 DEFAULT_CONFIG = {
@@ -38,38 +44,98 @@ DEFAULT_CONFIG = {
         "tps_command": "ticks",
     },
     "watcher": {},
-    "messages": {},
+}
+
+
+DEFAULT_MESSAGES = {
+    "prefix": "<aqua>[Server Watcher]",
+    "broadcast_restart_at": "{prefix} The server will restart at {time} CDT.",
+    "broadcast_minute": {
+        120: "{prefix} Restart in 2 hours!",
+        60: "{prefix} Restart in 1 hour!",
+        45: "{prefix} Restart in 45 minutes!",
+        30: "{prefix} Restart in 30 minutes!",
+        15: "{prefix} Restart in 15 minutes!",
+        5: "{prefix} Restart in 5 minutes!",
+        1: "{prefix} Restart in 1 minute!",
+    },
+    "broadcast_second": {
+        s: "{prefix} Restart in " + str(s) + " seconds!"
+        for s in range(10, 0, -1)
+    },
+    "log_start": "ServerWatcher is running!",
+    "log_validation_fail": "Validation FAILED. Make sure you set up config.yaml.",
+    "log_validation_ok": "All validation checks succeeded.",
+    "log_immediate_restart": "Restarting immediately.",
+    "log_no_restart": "The server does not need to restart.",
+    "log_scheduled": "Restart needed, but anti-restart factors outweigh it.",
+    "log_gap_low": "Gap {gap}. Scheduling restart in 2 hours.",
+    "log_gap_high": "Gap {gap}. Scheduling restart in 1 hour.",
+    "reason_restart_soon": "The server is set to restart soon",
+    "reason_ram": "RAM usage ({ram}) is higher than {threshold} GB",
+    "reason_cpu": "CPU usage ({cpu}) is higher than {threshold}%",
+    "reason_uptime": "Uptime {uptime} exceeds {threshold}h",
+    "reason_tps": "TPS {tps} is lower than {threshold}",
+    "reason_low_uptime": "Uptime {uptime} is shorter than 30m",
+    "reason_players": "There {verb} {count} {plural} online",
 }
 
 
 class ServerWatcher:
-    def __init__(self, config_path: str = "config.yaml"):
-        # ensure config exists, then load it
+    @staticmethod
+    def generate_default_files(
+        config_path: str = CONFIG_PATH,
+        messages_path: str = MESSAGES_PATH,
+        overwrite: bool = False,
+    ):
+        write_default_yaml(config_path, DEFAULT_CONFIG, overwrite=overwrite)
+        write_default_yaml(messages_path, DEFAULT_MESSAGES, overwrite=overwrite)
+
+    def __init__(
+        self,
+        config_path: str = CONFIG_PATH,
+        messages_path: str = MESSAGES_PATH,
+    ):
+        # ensure files exist
         ensure_yaml(config_path, DEFAULT_CONFIG)
-        raw = load_yaml(config_path)
-
-        # map watcher + messages sections into your dataclasses
-        self.cfg: WatcherConfig = map_to_dataclass(raw.get("watcher", {}), WatcherConfig)
+        ensure_yaml(messages_path, DEFAULT_MESSAGES)
+
+        # load raw YAML
+        raw_config = load_yaml(config_path)
+        raw_messages = load_yaml(messages_path)
+
+        # validate schemas
+        config_errors = validate_config_schema(raw_config)
+        messages_errors = validate_messages_schema(raw_messages)
+        all_errors = config_errors + messages_errors
+        if all_errors:
+            msg = "Configuration errors:\n" + "\n".join(f"- {e}" for e in all_errors)
+            raise ValueError(msg)
+
+        # map watcher + messages into dataclasses
+        self.cfg: WatcherConfig = map_to_dataclass(
+            raw_config.get("watcher", {}), WatcherConfig
+        )
         self.msg: WatcherMessages = map_to_dataclass(
-            raw.get("messages", {}), WatcherMessages
+            raw_messages, WatcherMessages
         )
 
         # panel / origin / server wiring from YAML
-        p = raw["panel"]
+        p = raw_config["panel"]
         self.panel = Panel(
             name=p["name"],
             url=p["url"],
             api_key=p["api_key"],
         )
 
-        o = raw["origin"]
+        o = raw_config["origin"]
         self.origin = GenericServer(
             name="Origin",
             panel=self.panel,
             server_id=o["server_id"],
         )
 
-        s = raw["server"]
+        s = raw_config["server"]
         self.server = MinecraftServer(
             name=s["name"],
             panel=self.panel,
@@ -81,13 +147,18 @@ class ServerWatcher:
             tpsCommand=s["tps_command"],
         )
 
+        # logger now fully configurable
+        logger_name = self.cfg.logger_name_template.format(server_name=s["name"])
         self.log = HungerLogger(
-            name=f"ServerWatcher-{s['name']}",
+            name=logger_name,
             server=self.server,
-            log_path="/home/container/logs/",
-            console_backspaces=8,
+            log_path=self.cfg.log_path,
+            console_backspaces=self.cfg.console_backspaces,
         )
 
+        # timezone
+        self.tz = ZoneInfo(self.cfg.timezone)
+
     def fmt(self, template: str, **kwargs):
         return template.format(prefix=self.msg.prefix, **kwargs)
 
@@ -119,11 +190,11 @@ class ServerWatcher:
         info = snapSchedule(minimumMinutes=minutes)
         scheduled = info["scheduled"]
 
-        cst = scheduled.astimezone(ZoneInfo("America/Chicago"))
-        time_in_cdt = cst.strftime("%I:%M %p")
+        local_time = scheduled.astimezone(self.tz)
+        time_str = local_time.strftime("%I:%M %p")
 
         self.server.sendBroadcast(
-            self.fmt(self.msg.broadcast_restart_at, time=time_in_cdt)
+            self.fmt(self.msg.broadcast_restart_at, time=time_str)
         )
 
         minute_callbacks = {

{serverwatcher-2.2.4 → serverwatcher-3.0/src/serverwatcher.egg-info}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: serverwatcher
-Version: 2.2.4
+Version: 3.0
 Summary: A HungerLib-powered Minecraft server automation engine.
 Author: iFamished
 License: MIT

{serverwatcher-2.2.4 → serverwatcher-3.0}/src/serverwatcher.egg-info/SOURCES.txt

@@ -4,6 +4,7 @@ pyproject.toml
 src/serverwatcher/__init__.py
 src/serverwatcher/config.py
 src/serverwatcher/messages.py
+src/serverwatcher/schema.py
 src/serverwatcher/watcher.py
 src/serverwatcher.egg-info/PKG-INFO
 src/serverwatcher.egg-info/SOURCES.txt