cli options, fixes

2025-10-29 17:50:23 +00:00 · 2021-01-09 12:02:51 +01:00
parent 9bc16cf08f
commit 16261bf827
21 changed files with 239 additions and 99 deletions
--- a/mktxp/cli/config/_mktxp.conf
+++ b/mktxp/cli/config/_mktxp.conf
@@ -13,3 +13,7 @@

 [MKTXP]
    port = 49090
+    socket_timeout = 2
+    initial_delay_on_failure = 120
+    max_delay_on_failure = 900
+    delay_inc_div = 5
--- a/mktxp/cli/config/config.py
+++ b/mktxp/cli/config/config.py
@@ -33,7 +33,8 @@ class MKTXPConfigKeys:
    PASSWD_KEY = 'password'

    SSL_KEY = 'use_ssl'
-    SSL_CERTIFICATE = 'ssl_certificate'
+    NO_SSL_CERTIFICATE = 'no_ssl_certificate'
+    SSL_CERTIFICATE_VERIFY = 'ssl_certificate_verify'

    FE_DHCP_KEY = 'dhcp'
    FE_DHCP_LEASE_KEY = 'dhcp_lease'    
@@ -46,6 +47,12 @@ class MKTXPConfigKeys:
    FE_CAPSMAN_KEY = 'capsman'
    FE_CAPSMAN_CLIENTS_KEY = 'capsman_clients'

+    MKTXP_SOCKET_TIMEOUT = 'socket_timeout'    
+    MKTXP_SOCKET_TIMEOUT = 'socket_timeout'   
+    MKTXP_INITIAL_DELAY = 'initial_delay_on_failure'
+    MKTXP_MAX_DELAY = 'max_delay_on_failure'
+    MKTXP_INC_DIV = 'delay_inc_div'
+
    # UnRegistered entries placeholder
    NO_ENTRIES_REGISTERED = 'NoEntriesRegistered'

@@ -53,15 +60,21 @@ class MKTXPConfigKeys:
    ROUTERBOARD_NAME = 'routerboard_name'
    ROUTERBOARD_ADDRESS = 'routerboard_address'

-    # Default ports
+    # Default values
    DEFAULT_API_PORT = 8728
    DEFAULT_API_SSL_PORT = 8729
-    DEFAULT_MKTXP_PORT = 49090 
+    DEFAULT_MKTXP_PORT = 49090
+    DEFAULT_MKTXP_SOCKET_TIMEOUT = 2
+    DEFAULT_MKTXP_INITIAL_DELAY = 120
+    DEFAULT_MKTXP_MAX_DELAY = 900
+    DEFAULT_MKTXP_INC_DIV = 5

-    BOOLEAN_KEYS = [ENABLED_KEY, SSL_KEY, SSL_CERTIFICATE,  
+    BOOLEAN_KEYS = (ENABLED_KEY, SSL_KEY, NO_SSL_CERTIFICATE, SSL_CERTIFICATE_VERIFY, 
                      FE_DHCP_KEY, FE_DHCP_LEASE_KEY, FE_DHCP_POOL_KEY, FE_INTERFACE_KEY, 
-                      FE_MONITOR_KEY, FE_ROUTE_KEY, FE_WIRELESS_KEY, FE_WIRELESS_CLIENTS_KEY, FE_CAPSMAN_KEY, FE_CAPSMAN_CLIENTS_KEY]
+                      FE_MONITOR_KEY, FE_ROUTE_KEY, FE_WIRELESS_KEY, FE_WIRELESS_CLIENTS_KEY, FE_CAPSMAN_KEY, FE_CAPSMAN_CLIENTS_KEY)
+    
    STR_KEYS = [HOST_KEY, USER_KEY, PASSWD_KEY]
+    INT_KEYS = [PORT_KEY, MKTXP_SOCKET_TIMEOUT, MKTXP_INITIAL_DELAY, MKTXP_MAX_DELAY, MKTXP_INC_DIV]

    # MKTXP config entry nane
    MKTXP_CONFIG_ENTRY_NAME = 'MKTXP'
@@ -70,12 +83,15 @@ class MKTXPConfigKeys:
 class ConfigEntry:
    MKTXPEntry = namedtuple('MKTXPEntry', [MKTXPConfigKeys.ENABLED_KEY, MKTXPConfigKeys.HOST_KEY, MKTXPConfigKeys.PORT_KEY, 
                         MKTXPConfigKeys.USER_KEY, MKTXPConfigKeys.PASSWD_KEY, 
-                         MKTXPConfigKeys.SSL_KEY, MKTXPConfigKeys.SSL_CERTIFICATE, 
+                         MKTXPConfigKeys.SSL_KEY, MKTXPConfigKeys.NO_SSL_CERTIFICATE, MKTXPConfigKeys.SSL_CERTIFICATE_VERIFY,
                         
                         MKTXPConfigKeys.FE_DHCP_KEY, MKTXPConfigKeys.FE_DHCP_LEASE_KEY, MKTXPConfigKeys.FE_DHCP_POOL_KEY, MKTXPConfigKeys.FE_INTERFACE_KEY, 
                         MKTXPConfigKeys.FE_MONITOR_KEY, MKTXPConfigKeys.FE_ROUTE_KEY, MKTXPConfigKeys.FE_WIRELESS_KEY, MKTXPConfigKeys.FE_WIRELESS_CLIENTS_KEY,
                         MKTXPConfigKeys.FE_CAPSMAN_KEY, MKTXPConfigKeys.FE_CAPSMAN_CLIENTS_KEY
                         ])
+    _MKTXPEntry = namedtuple('_MKTXPEntry', [MKTXPConfigKeys.PORT_KEY, MKTXPConfigKeys.MKTXP_SOCKET_TIMEOUT, 
+                                            MKTXPConfigKeys.MKTXP_INITIAL_DELAY, MKTXPConfigKeys.MKTXP_MAX_DELAY, MKTXPConfigKeys.MKTXP_INC_DIV])
+

 class OSConfig(metaclass = ABCMeta):
    ''' OS-related config
@@ -139,7 +155,7 @@ class MKTXPConfigHandler:
        ''' (Force-)Read conf data from disk
        '''
        self.config = ConfigObj(self.usr_conf_data_path)
-        self.mktxp_config = ConfigObj(self.mktxp_conf_path)
+        self._config = ConfigObj(self.mktxp_conf_path)

    def _create_os_path(self, os_path, resource_path):
        if not os.path.exists(os_path):
@@ -190,37 +206,55 @@ class MKTXPConfigHandler:
    def entry(self, entry_name):
        ''' Given an entry name, reads and returns the entry info
        '''
-        entry_reader = self._entry_reader(entry_name)
+        entry_reader = self.entry_reader(entry_name)
        return ConfigEntry.MKTXPEntry(**entry_reader)

-    def mktxp_port(self):
-        if self.mktxp_config.get(MKTXPConfigKeys.MKTXP_CONFIG_ENTRY_NAME) and \
-                self.mktxp_config[MKTXPConfigKeys.MKTXP_CONFIG_ENTRY_NAME].get(MKTXPConfigKeys.PORT_KEY):
-                return self.mktxp_config[MKTXPConfigKeys.MKTXP_CONFIG_ENTRY_NAME].as_int(MKTXPConfigKeys.PORT_KEY)        
-        return MKTXPConfigKeys.DEFAULT_MKTXP_PORT
+    def _entry(self):
+        ''' MKTXP internal config entry
+        '''
+        _entry_reader = self._entry_reader()
+        return ConfigEntry._MKTXPEntry(**_entry_reader)
+

    # Helpers
-    def _entry_reader(self, entry_name):
-        entry = {}
+    def entry_reader(self, entry_name):
+        entry_reader = {}
        for key in MKTXPConfigKeys.BOOLEAN_KEYS:
            if self.config[entry_name].get(key):
-                entry[key] = self.config[entry_name].as_bool(key)
+                entry_reader[key] = self.config[entry_name].as_bool(key)
            else:
-                entry[key] = False
+                entry_reader[key] = False

        for key in MKTXPConfigKeys.STR_KEYS:
-            entry[key] = self.config[entry_name][key]
+            entry_reader[key] = self.config[entry_name][key]

        # port
        if self.config[entry_name].get(MKTXPConfigKeys.PORT_KEY):
-            entry[MKTXPConfigKeys.PORT_KEY] = self.config[entry_name].as_int(MKTXPConfigKeys.PORT_KEY)
+            entry_reader[MKTXPConfigKeys.PORT_KEY] = self.config[entry_name].as_int(MKTXPConfigKeys.PORT_KEY)
        else:
-            if entry[MKTXPConfigKeys.SSL_KEY]:
-                entry[MKTXPConfigKeys.PORT_KEY] = MKTXPConfigKeys.DEFAULT_API_SSL_PORT
-            else:
-                entry[MKTXPConfigKeys.PORT_KEY] = MKTXPConfigKeys.DEFAULT_API_PORT
+            entry_reader[MKTXPConfigKeys.PORT_KEY] = self._default_value_for_key(MKTXPConfigKeys.SSL_KEY, entry_reader[MKTXPConfigKeys.SSL_KEY])

-        return entry
+        return entry_reader
+
+    def _entry_reader(self):
+        _entry_reader = {}
+        entry_name = MKTXPConfigKeys.MKTXP_CONFIG_ENTRY_NAME
+        for key in MKTXPConfigKeys.INT_KEYS:
+            if self._config[entry_name].get(key):
+                _entry_reader[key] = self._config[entry_name].as_int(key)
+            else:
+                _entry_reader[key] = self._default_value_for_key(key)
+        return _entry_reader
+
+    def _default_value_for_key(self, key, value = None):
+        return {
+                MKTXPConfigKeys.SSL_KEY: lambda value: MKTXPConfigKeys.DEFAULT_API_SSL_PORT if value else MKTXPConfigKeys.DEFAULT_API_PORT,
+                MKTXPConfigKeys.PORT_KEY: lambda value: MKTXPConfigKeys.DEFAULT_MKTXP_PORT,
+                MKTXPConfigKeys.MKTXP_SOCKET_TIMEOUT: lambda value: MKTXPConfigKeys.DEFAULT_MKTXP_SOCKET_TIMEOUT,
+                MKTXPConfigKeys.MKTXP_INITIAL_DELAY: lambda value: MKTXPConfigKeys.DEFAULT_MKTXP_INITIAL_DELAY,
+                MKTXPConfigKeys.MKTXP_MAX_DELAY: lambda value: MKTXPConfigKeys.DEFAULT_MKTXP_MAX_DELAY,
+                MKTXPConfigKeys.MKTXP_INC_DIV: lambda value: MKTXPConfigKeys.DEFAULT_MKTXP_INC_DIV
+                }[key](value)


 # Simplest possible Singleton impl
--- a/mktxp/cli/config/mktxp.conf
+++ b/mktxp/cli/config/mktxp.conf
@@ -11,18 +11,19 @@
 ## GNU General Public License for more details.


-[SampleRouter]
-    enabled = False
-
-    hostname = localhost
-    port = 8728
-
-    username = user
+[Sample-Router]
+    enabled = False         # turns metrics collection for this RouterOS device on / off
+    
+    hostname = localhost    # RouterOS IP address
+    port = 8728             # RouterOS IP Port
+    
+    username = username     # RouterOS user, needs to have 'read' and 'api' permissions
    password = password
-
-    use_ssl = False
-    ssl_certificate = False
-
+    
+    use_ssl = False                 # enables connection via API-SSL servis
+    no_ssl_certificate = False      # enables API_SSL connect without router SSL certificate
+    ssl_certificate_verify = False  # turns SSL certificate verification on / off
+    
    dhcp = True
    dhcp_lease = True
    pool = True
@@ -32,4 +33,6 @@
    wireless = True
    wireless_clients = True
    capsman = True
-    capsman_clients = True
+    capsman_clients = True
+
+    
--- a/mktxp/cli/dispatch.py
+++ b/mktxp/cli/dispatch.py
@@ -72,8 +72,10 @@ class MKTXPDispatcher:


    def show_entries(self, args):
-        if args['configpath']:
-            print(f'MKTX config path: {config_handler.usr_conf_data_path}')
+        if args['config']:
+            print(f'MKTXP data config: {config_handler.usr_conf_data_path}')
+            print(f'MKTXP internal config: {config_handler.mktxp_conf_path}')
+
        else:
            for entryname in config_handler.registered_entries():
                if args['entry_name'] and entryname != args['entry_name']:
--- a/mktxp/cli/options.py
+++ b/mktxp/cli/options.py
@@ -101,8 +101,8 @@ class MKTXPOptionsParser:
                                        description = 'Displays MKTXP config router entries',
                                        formatter_class=MKTXPHelpFormatter)
        self._add_entry_name(show_parser, registered_only = True, required = False, help = "Config entry name")
-        show_parser.add_argument('-cp', '--configpath', dest='configpath',
-                                        help = "Shows MKTXP config file path",
+        show_parser.add_argument('-cfg', '--config', dest='config',
+                                        help = "Shows MKTXP config files paths",
                                        action = 'store_true')

        # Add command
@@ -137,7 +137,7 @@ class MKTXPOptionsParser:
        optional_args_group.add_argument('-ssl', '--use-ssl', dest='use_ssl',
                help = "Connect via RouterOS api-ssl service",
                action = 'store_true')
-        optional_args_group.add_argument('-ssl-cert', '--use-ssl-certificate', dest='ssl_certificate',
+        optional_args_group.add_argument('-no-ssl-cert', '--no-ssl-certificate', dest='no_ssl_certificate',
                help = "Connect with configured RouterOS SSL ceritficate",
                action = 'store_true')