serverwatcher 5.27__tar.gz → 5.27.2__tar.gz

{serverwatcher-5.27/src/serverwatcher.egg-info → serverwatcher-5.27.2}/PKG-INFO

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

{serverwatcher-5.27 → serverwatcher-5.27.2}/pyproject.toml

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

{serverwatcher-5.27 → serverwatcher-5.27.2}/src/serverwatcher/configclasses/config.py

@@ -56,3 +56,18 @@ class fallbacks:
 
     clear_terminal = True
     handle_keyboard_interrupt = True
+
+
+class rules:
+    panel_url = "required"
+    panel_api_key = "required"
+    server_id = "required"
+    server_domain = "required"
+    bridge_token = "required"
+
+    timezone = "recommended"
+    panel_name = "recommended"
+    server_port = "recommended"
+    bridge_port = "recommended"
+
+    # everything else defaults to optional

{serverwatcher-5.27 → serverwatcher-5.27.2}/src/serverwatcher/configclasses/messages.py

@@ -33,6 +33,7 @@ class MessagesConfig:
     status_check: str = 'logging.status_check'
     validation_fail: str = 'logging.validation_fail'
     validation_ok: str = 'logging.validation_ok'
+    sampling_start: str = 'logging.sampling_start'
     shutdown: str = 'logging.shutdown'
     immediate_restart: str = 'logging.immediate_restart'
     no_restart: str = 'logging.no_restart'
@@ -88,6 +89,7 @@ class fallbacks:
     status_check = 'Checking server status...'
     validation_fail = 'Validation FAILED.'
     validation_ok = 'All validation checks succeeded.'
+    sampling_start = 'Starting sampling process...'
     shutdown = 'Shutting down ServerWatcher.'
     immediate_restart = 'Restarting immediately.'
     no_restart = 'The server does not need to restart.'
@@ -113,3 +115,6 @@ class fallbacks:
     server_back_online = 'Server is back online!'
     server_back_online_log = 'ServerWatcher successfully restarted the server.'
     server_failed_restart = 'Server failed to restart!'
+
+class rules:
+    pass

{serverwatcher-5.27 → serverwatcher-5.27.2}/src/serverwatcher/configclasses/watcher.py

@@ -68,3 +68,32 @@ class fallbacks:
     restart_wait_seconds = 30
     restart_timeout = 120
     restart_online_interval = 2
+
+
+class rules:
+    threshold_ram = "required"
+    threshold_cpu = "required"
+    threshold_uptime = "required"
+    threshold_tps = "required"
+
+    restart_wait_seconds = "required"
+    restart_timeout = "required"
+    restart_online_interval = "required"
+
+    watch_interval = "recommended"
+    sample_duration = "recommended"
+    sample_interval = "recommended"
+    sample_outlier_drop = "recommended"
+    threshold_min_uptime = "recommended"
+    threshold_low_gap = "recommended"
+    snap_minutes = "recommended"
+    low_gap_minutes = "recommended"
+    high_gap_minutes = "recommended"
+
+    weight_restart_soon = "optional"
+    weight_ram = "optional"
+    weight_cpu = "optional"
+    weight_uptime = "optional"
+    weight_tps = "optional"
+    weight_low_uptime = "optional"
+    weight_per_player = "optional"

{serverwatcher-5.27 → serverwatcher-5.27.2}/src/serverwatcher/defaultconfigs/messages.yaml

@@ -51,6 +51,7 @@ logging:
   status_check: 'Checking server status...'
   validation_fail: 'Validation FAILED.'
   validation_ok: 'All validation checks succeeded.'
+  sampling_start: 'Starting sampling process...'
   shutdown: 'Shutting down ServerWatcher.'
   immediate_restart: 'Restarting immediately.'
   no_restart: 'The server does not need to restart.'

serverwatcher-5.27.2/src/serverwatcher/validator.py

@@ -0,0 +1,52 @@
+import sys
+from dataclasses import fields
+
+from hungerlib import utils, loadConfig, Validator
+
+from serverwatcher.configclasses.config import GlobalConfig
+from serverwatcher.configclasses.messages import MessagesConfig
+from serverwatcher.configclasses.watcher import WatcherConfig
+
+
+utils.clearTerminal()
+
+# You can customize messages here if you want
+v = Validator()
+
+
+def validate_global_config(c):
+    for f in fields(GlobalConfig):
+        if not f.name.startswith("__"):
+            v.check_field(c, f.name)
+
+
+def validate_watcher_config(c):
+    for f in fields(WatcherConfig):
+        if not f.name.startswith("__"):
+            v.check_field(c, f.name)
+
+
+def validate_messages_config(c):
+    for f in fields(MessagesConfig):
+        if not f.name.startswith("__"):
+            v.check_field(c, f.name)
+
+
+def validate_all():
+    config = loadConfig(GlobalConfig)
+    messages = loadConfig(MessagesConfig)
+    watcher = loadConfig(WatcherConfig)
+
+    v.validate_key_types(config, GlobalConfig)
+    v.validate_key_types(messages, MessagesConfig)
+    v.validate_key_types(watcher, WatcherConfig)
+
+    validate_global_config(config)
+    validate_watcher_config(watcher)
+    validate_messages_config(messages)
+
+    return v.run(config, messages, watcher)
+
+
+if __name__ == '__main__':
+    validate_all()

{serverwatcher-5.27 → serverwatcher-5.27.2}/src/serverwatcher/watcher.py

@@ -93,6 +93,10 @@ class ServerWatcher:
 
         self.tz = ZoneInfo(self.config.timezone)
 
+    def clearTerminal(self):
+        if self.config.clear_terminal:
+            utils.clearTerminal()
+
     def shutdown(self):
         self.router.info(self.messages.shutdown)
         raise SystemExit
@@ -165,8 +169,9 @@ class ServerWatcher:
             self.router.error(self.messages.validation_fail)
             self.shutdown()
 
+        self.router.info(self.messages.sampling_start)
         self.server.refresh()
-        snap = utils.Snapshot(self.server, duration=self.watcherconfig.sample_duration, interval=self.watcher_config.sample_interval, drop_outliers=self.watcher_config.sample_outlier_drop, gb=True)
+        snap = utils.Snapshot(self.server, duration=self.watcherconfig.sample_duration, interval=self.watcherconfig.sample_interval, drop_outliers=self.watcherconfig.sample_outlier_drop, gb=True)
 
         pro = 0
         anti = 0
@@ -245,15 +250,13 @@ class ServerWatcher:
         if self.config.handle_keyboard_interrupt:
             try:
                 while True:
-                    if self.config.clear_terminal:
-                        utils.clearTerminal()
+                    self.clearTerminal()
                     self.evaluate()
                     time.sleep(self.watcherconfig.watch_interval)
             except KeyboardInterrupt:
                 self.shutdown()
         else:
             while True:
-                if self.config.clear_terminal:
-                    utils.clearTerminal()
+                self.clearTerminal()
                 self.evaluate()
                 time.sleep(self.watcherconfig.watch_interval)

{serverwatcher-5.27 → serverwatcher-5.27.2/src/serverwatcher.egg-info}/PKG-INFO

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

serverwatcher-5.27/src/serverwatcher/validator.py

@@ -1,121 +0,0 @@
-import sys
-from dataclasses import fields
-
-from hungerlib import utils, loadConfig, Validator
-
-from serverwatcher.configclasses.config import GlobalConfig
-from serverwatcher.configclasses.messages import MessagesConfig
-from serverwatcher.configclasses.watcher import WatcherConfig
-
-
-utils.clearTerminal()
-v = Validator()
-
-
-def validate_global_config(config):
-    c = config
-
-    # timezone
-    v.check_field(c, "timezone")
-    if c.timezone == "":
-        v.errors.append('timezone: must not be empty')
-
-    # panel
-    v.check_field(c, "panel_name")
-    v.check_field(c, "panel_url", allow_fallback=False)
-    v.check_field(c, "panel_api_key", allow_fallback=False)
-
-    if c.panel_url and not (c.panel_url.startswith("http://") or c.panel_url.startswith("https://")):
-        v.errors.append(f'panel_url: must start with "http://" or "https://" (got "{c.panel_url}")')
-
-    if c.panel_api_key and not c.panel_api_key.startswith("ptlc_"):
-        v.errors.append(f'panel_api_key: must be a valid Pterodactyl client API key (got "{c.panel_api_key}")')
-    if c.panel_api_key and c.panel_api_key.startswith("plta_"):
-        v.errors.append(f'panel_api_key: should not be an application key (got "{c.panel_api_key}")')
-
-    # server
-    v.check_field(c, "server_name")
-    v.check_field(c, "server_id", allow_fallback=False)
-    v.check_field(c, "server_domain", allow_fallback=False)
-    v.check_field(c, "server_port")
-
-    if c.server_domain and (c.server_domain.startswith("http://") or c.server_domain.startswith("https://")):
-        v.errors.append(f'server_domain: must not contain protocol (got "{c.server_domain}")')
-
-    if c.server_port is not None and not (1 <= c.server_port <= 65535):
-        v.errors.append(f'server_port: must be 1–65535 (got "{c.server_port}")')
-
-    # hungerbridge
-    v.check_field(c, "bridge_token", allow_fallback=False)
-    v.check_field(c, "bridge_port")
-    if c.bridge_port is not None and not (1 <= c.bridge_port <= 65535):
-        v.errors.append(f'bridge_port: must be 1–65535 (got "{c.bridge_port}")')
-
-    # logger
-    for key in [
-        "enable_logging", "logger_name", "log_path",
-        "info_prefix", "warn_prefix", "error_prefix"
-    ]:
-        v.check_field(c, key)
-
-    # terminal
-    v.check_field(c, "clear_terminal")
-    v.check_field(c, "handle_keyboard_interrupt")
-
-
-def validate_watcher_config(watcherconfig):
-    c = watcherconfig
-    raw = c.raw
-    fb = c.fallbacks
-
-    if c.restart_wait_seconds <= 0:
-        v.errors.append(f'restart_wait_seconds: must be > 0 (got {c.restart_wait_seconds})')
-
-    if c.threshold_cpu <= 0:
-        v.errors.append(f'threshold_cpu: must be > 0 (got {c.threshold_cpu})')
-
-    if c.threshold_ram <= 0:
-        v.errors.append(f'threshold_ram: must be > 0 (got {c.threshold_ram})')
-
-    if c.threshold_tps <= 0 or c.threshold_tps > 20:
-        v.errors.append(f'threshold_tps: must be 1–20 (got "{c.threshold_tps}")')
-
-    if raw.snap_minutes is None:
-        v.warnings.append(f'snap_minutes: key does not exist, using fallback "{fb.snap_minutes}"')
-
-    if not isinstance(c.snap_minutes, list) or not c.snap_minutes:
-        v.errors.append(f'snap_minutes: must be a non-empty list of minute marks (got {c.snap_minutes!r})')
-    else:
-        bad = [m for m in c.snap_minutes if not isinstance(m, int) or not (0 <= m <= 59)]
-        if bad:
-            v.errors.append(f'snap_minutes: all values must be integers 0–59 (bad values: {bad})')
-
-
-def validate_messages_config(messages):
-    pass # may add validation later
-    # for f in fields(MessagesConfig):
-    #     if f.name.startswith("__"):
-    #         continue
-    #     value = getattr(messages, f.name)
-    #     if not isinstance(value, str) or value.strip() == "":
-    #         v.errors.append(f'MessagesConfig.{f.name}: must be a non-empty string')
-
-
-def validate_all():
-    config = loadConfig(GlobalConfig)
-    messages = loadConfig(MessagesConfig)
-    watcherconfig = loadConfig(WatcherConfig)
-
-    v.validate_key_types(config, GlobalConfig)
-    v.validate_key_types(messages, MessagesConfig)
-    v.validate_key_types(watcherconfig, WatcherConfig)
-
-    validate_global_config(config)
-    validate_watcher_config(watcherconfig)
-    validate_messages_config(messages)
-
-    return v.run(config, messages, watcherconfig)
-
-
-if __name__ == '__main__':
-    validate_all()