Dev

.github/workflows/tests.yml

@@ -0,0 +1,46 @@
+name: Lint + Tests
+
+on:
+  push:
+    branches:
+      - '**'
+  pull_request:
+    branches:
+      - '**'
+
+jobs:
+  test:
+    runs-on: ubuntu-22.04
+
+    strategy:
+      fail-fast: false
+      matrix:
+        python-version: ["3.8", "3.9", "3.10", "3.11", "3.12", "3.13"]
+
+    steps:
+      - uses: actions/checkout@v5
+        with:
+          submodules: true
+
+      - name: Set up Python ${{ matrix.python-version }}
+        uses: actions/setup-python@v5
+        with:
+          python-version: ${{ matrix.python-version }}
+
+      - name: Install dependencies
+        run: |
+          python -m pip install --upgrade pip
+          pip install -r requirements.txt
+          pip install ruff pytest pytest-mock
+
+      - name: Run Ruff
+        run: |
+          ruff check
+
+      - name: Build project
+        run: |
+          pip install -U .
+
+      - name: Run pytest
+        run: |
+          pytest --import-mode=append  # to test built package

modules/__init__.py

@@ -3,7 +3,6 @@
 
 from modules.collator import CollatorModule
 from modules.module import MtcModule
-from modules.pool import PoolModule
 from modules.nominator_pool import NominatorPoolModule
 from modules.single_pool import SingleNominatorModule
 from modules.validator import ValidatorModule
@@ -38,7 +37,7 @@ class Setting:
 
 SETTINGS = {
     'stake': Setting('validator', None, 'Stake amount'),
-    'stakePercent': Setting('validator', 99, 'Stake percent if `stake` is null'),
+    'stakePercent': Setting('validator', 100, 'Stake percent if `stake` is null'),
     'isSlashing': Setting('validator', None, 'Create complaints to validators'),
     'validatorWalletName': Setting('validator', 'wallet_001', 'Validator\'s wallet name'),
     'maxFactor': Setting('validator', None, 'Param send to Elector. if null will be taken from 17 config param'),

modules/alert_bot.py

@@ -4,7 +4,8 @@
 
 from modules.module import MtcModule
 from mypylib.mypylib import get_timestamp, print_table, color_print
-from mytoncore import get_hostname, signed_int_to_hex64
+from mytoncore.utils import get_hostname, signed_int_to_hex64
+from mytonctrl.console_cmd import add_command, check_usage_one_arg, check_usage_two_args
 from mytonctrl.utils import timestamp2utcdatetime
 
 
@@ -333,15 +334,15 @@ def _is_alert_active(self, alert_name: str) -> bool:
         return self.get_alert_from_db(alert_name).get('active', False)
 
     def enable_alert(self, args):
-        if len(args) != 1:
-            raise Exception("Usage: enable_alert <alert_name>")
+        if not check_usage_one_arg("enable_alert", args):
+            return
         alert_name = args[0]
         self.set_alert_enabled(alert_name, True)
         color_print("enable_alert - {green}OK{endc}")
 
     def disable_alert(self, args):
-        if len(args) != 1:
-            raise Exception("Usage: disable_alert <alert_name>")
+        if not check_usage_one_arg("disable_alert", args):
+            return
         alert_name = args[0]
         self.set_alert_enabled(alert_name, False)
         color_print("disable_alert - {green}OK{endc}")
@@ -360,8 +361,8 @@ def test_alert(self, args):
         self.send_message('Test alert')
 
     def setup_alert_bot(self, args):
-        if len(args) != 2:
-            raise Exception("Usage: setup_alert_bot <bot_token> <chat_id>")
+        if not check_usage_two_args("setup_alert_bot", args):
+            return
         self.token = args[0]
         self.chat_id = args[1]
         init_alerts()
@@ -373,7 +374,7 @@ def setup_alert_bot(self, args):
             color_print("setup_alert_bot - {green}OK{endc}")
         except Exception as e:
             self.local.add_log(f"Error while sending welcome message: {e}", "error")
-            self.local.add_log(f"If you want the bot to write to a multi-person chat group, make sure the bot is added to that chat group. If it is not - do it and run the command `setup_alert_bot <bot_token> <chat_id>` again.", "info")
+            self.local.add_log("If you want the bot to write to a multi-person chat group, make sure the bot is added to that chat group. If it is not - do it and run the command `setup_alert_bot <bot_token> <chat_id>` again.", "info")
             color_print("setup_alert_bot - {red}Error{endc}")
 
     def send_welcome_message(self):
@@ -602,8 +603,8 @@ def check_status(self):
         self.local.try_function(self.check_online_collators)
 
     def add_console_commands(self, console):
-        console.AddItem("enable_alert", self.enable_alert, self.local.translate("enable_alert_cmd"))
-        console.AddItem("disable_alert", self.disable_alert, self.local.translate("disable_alert_cmd"))
-        console.AddItem("list_alerts", self.print_alerts, self.local.translate("list_alerts_cmd"))
-        console.AddItem("test_alert", self.test_alert, self.local.translate("test_alert_cmd"))
-        console.AddItem("setup_alert_bot", self.setup_alert_bot, self.local.translate("setup_alert_bot_cmd"))
+        add_command(self.local, console, "enable_alert", self.enable_alert)
+        add_command(self.local, console, "disable_alert", self.disable_alert)
+        add_command(self.local, console, "list_alerts", self.print_alerts)
+        add_command(self.local, console, "test_alert", self.test_alert)
+        add_command(self.local, console, "setup_alert_bot", self.setup_alert_bot)

modules/backups.py

@@ -2,23 +2,27 @@
 import shutil
 import subprocess
 import time
+from typing import Optional
 
 from modules.module import MtcModule
-from mypylib.mypylib import color_print, ip2int, run_as_root, parse, MyPyClass
+from mytonctrl.console_cmd import add_command, check_usage_args_min_max_len
+from mypylib.mypylib import color_print, ip2int, run_as_root, parse
 from mytoncore.utils import get_package_resource_path
 from mytonctrl.utils import get_current_user, pop_user_from_args
 from mytoninstaller.config import get_own_ip
 
 
 class BackupModule(MtcModule):
 
-    def create_keyring(self, dir_name):
+    def create_keyring(self, dir_name: str):
         keyring_dir = dir_name + '/keyring'
         self.ton.validatorConsole.Run(f'exportallprivatekeys {keyring_dir}')
 
     def create_tmp_ton_dir(self):
         result = self.ton.validatorConsole.Run("getconfig")
         text = parse(result, "---------", "--------")
+        if text is None:
+            raise Exception("Could not get config from validator-console")
         dir_name = self.ton.tempDir + f'/ton_backup_{int(time.time() * 1000)}'
         dir_name_db = dir_name + '/db'
         os.makedirs(dir_name_db)
@@ -28,15 +32,14 @@ def create_tmp_ton_dir(self):
         return dir_name
 
     @staticmethod
-    def run_create_backup(args, user: str = None):
+    def run_create_backup(args, user: Optional[str] = None):
         if user is None:
             user = get_current_user()
         with get_package_resource_path('mytonctrl', 'scripts/create_backup.sh') as backup_script_path:
             return subprocess.run(["bash", backup_script_path, "-u", user] + args, timeout=5)
 
     def create_backup(self, args):
-        if len(args) > 3:
-            color_print("{red}Bad args. Usage:{endc} create_backup [filename] [-u <user>]")
+        if not check_usage_args_min_max_len("create_backup", args, 0, 3):
             return
         tmp_dir = self.create_tmp_ton_dir()
         command_args = ["-m", self.ton.local.buffer.my_work_dir, "-t", tmp_dir]
@@ -51,23 +54,21 @@ def create_backup(self, args):
             color_print("create_backup - {red}Error{endc}")
         shutil.rmtree(tmp_dir)
         return process.returncode
-    # end define
 
     @staticmethod
-    def run_restore_backup(args, user: str = None):
+    def run_restore_backup(args, user: Optional[str] = None):
         if user is None:
             user = get_current_user()
         with get_package_resource_path('mytonctrl', 'scripts/restore_backup.sh') as restore_script_path:
             return run_as_root(["bash", restore_script_path, "-u", user] + args)
 
     def restore_backup(self, args):
-        if len(args) == 0 or len(args) > 5:
-            color_print("{red}Bad args. Usage:{endc} restore_backup <filename> [-y] [--skip-create-backup] [-u <user>]")
+        if not check_usage_args_min_max_len('restore_backup', args, 1, 5):
             return
         user = pop_user_from_args(args)
         if '-y' not in args:
             res = input(
-                f'This action will overwrite existing configuration with contents of backup archive, please make sure that donor node is not in operation prior to this action. Proceed [y/n]')
+                'This action will overwrite existing configuration with contents of backup archive, please make sure that donor node is not in operation prior to this action. Proceed [y/n]')
             if res.lower() != 'y':
                 print('aborted.')
                 return
@@ -79,8 +80,8 @@ def restore_backup(self, args):
             print('Before proceeding, mtc will create a backup of current configuration.')
             try:
                 self.create_backup([])
-            except:
-                color_print("{red}Could not create backup{endc}")
+            except Exception as e:
+                color_print(f"{{red}}Could not create backup: {e}{{endc}}")
 
         ip = str(ip2int(get_own_ip()))
         command_args = ["-m", self.ton.local.buffer.my_work_dir, "-n", args[0], "-i", ip]
@@ -94,8 +95,7 @@ def restore_backup(self, args):
             self.local.exit()
         else:
             color_print("restore_backup - {red}Error{endc}")
-    # end define
 
     def add_console_commands(self, console):
-        console.AddItem("create_backup", self.create_backup, self.local.translate("create_backup_cmd"))
-        console.AddItem("restore_backup", self.restore_backup, self.local.translate("restore_backup_cmd"))
+        add_command(self.local, console, "create_backup", self.create_backup)
+        add_command(self.local, console, "restore_backup", self.restore_backup)