(20250210) Started working on MikroTik config automation.
This commit is contained in:
@@ -41,7 +41,7 @@ from utils_v2.database.async_mongo_v2 import AsyncMongo
|
||||
from utils_v2.cache.async_redis_cache_v2 import AsyncRedisCache
|
||||
|
||||
# Controllers:
|
||||
from controllers_v2.core.software import CoreSoftwareController
|
||||
from controllers_v2.software.mikrotik.base import MikroTikController
|
||||
|
||||
# To make very controlled API calls:
|
||||
from utils_v2.rest.controllers.async_base import AsyncREST
|
||||
@@ -53,6 +53,10 @@ from models.software.mikrotik.auth import (
|
||||
MikroTikHotspot1000Auth,
|
||||
MikroTikAuthResponse
|
||||
)
|
||||
from models.software.mikrotik.configure import (
|
||||
MikroTikConfigAttemptResponse,
|
||||
MikroTikRollBackAttemptResponse
|
||||
)
|
||||
|
||||
# To work with datatypes:
|
||||
from typing import List, Any
|
||||
@@ -104,13 +108,13 @@ from abc import ABC, abstractmethod
|
||||
# *****************************************************************************************************************
|
||||
|
||||
|
||||
class MikroTikController(CoreSoftwareController, ABC):
|
||||
class AllMikroTikController(MikroTikController):
|
||||
|
||||
# ┏┓┓ ┓┏
|
||||
# ┃ ┃┏┓┏┏ ┃┃┏┓┏┓┏
|
||||
# ┗┛┗┗┻┛┛ ┗┛┗┻┛ ┛
|
||||
|
||||
SERVICE_TYPE = "mikrotik"
|
||||
pass
|
||||
|
||||
# ┏┓
|
||||
# ┃ ┏┓┏┓┏╋┏┓┓┏┏╋┏┓┏┓
|
||||
@@ -121,9 +125,8 @@ class MikroTikController(CoreSoftwareController, ABC):
|
||||
cache: AsyncRedisCache = None,
|
||||
http_client: httpx.AsyncClient = None,
|
||||
alert_url: str = None,
|
||||
base_filter: dict = None,
|
||||
debug: bool = True,
|
||||
debug_prefix: str = "MikroTik (C) | ",
|
||||
debug_prefix: str = "All MikroTik (C) | ",
|
||||
debug_only_errors: bool = True
|
||||
):
|
||||
|
||||
@@ -131,116 +134,28 @@ class MikroTikController(CoreSoftwareController, ABC):
|
||||
This is the foundational controller for all MikroTik services. This is built on top of the core message
|
||||
controller, and, in turn, all individual MikroTik client controllers must be built on top of this.
|
||||
:param cache: The object to use for caching results from database calls.
|
||||
:param http_client: The HTTP client
|
||||
:param base_filter: The basic filter that will be applied to all fetching/updating queries. WARNING: THE BASE
|
||||
FILTER WILL ALWAYS BE APPLIED AUTOMATICALLY. SET THIS UP WISELY.
|
||||
:param http_client: The HTTP client to use to make REST-ful API calls.
|
||||
:param debug: Whether, or not, you would like to print debugging messages:
|
||||
:param debug_prefix: The prefix to print with the debugging messages.
|
||||
:param debug_only_errors: Whether you would like to print only error messages or all messages.
|
||||
:return: None.
|
||||
"""
|
||||
|
||||
# Prepare the combined base filter:
|
||||
mikrotik_filter = {}
|
||||
for k, v in (base_filter or {}).items(): mikrotik_filter[k] = v
|
||||
mikrotik_filter["serviceType"] = self.SERVICE_TYPE
|
||||
|
||||
# Invoke the parent's constructor:
|
||||
CoreSoftwareController.__init__(
|
||||
self,
|
||||
super().__init__(
|
||||
cache = cache,
|
||||
alert_url = alert_url,
|
||||
http_client = http_client,
|
||||
base_filter = mikrotik_filter,
|
||||
base_filter = None,
|
||||
debug = debug,
|
||||
debug_prefix = debug_prefix,
|
||||
debug_only_errors = debug_only_errors
|
||||
)
|
||||
|
||||
# Init a variable in a parent:
|
||||
self._service_type = self.SERVICE_TYPE
|
||||
|
||||
# For controlled REST-ful calls:
|
||||
self._rest = AsyncREST(
|
||||
http_client = http_client,
|
||||
debug = debug,
|
||||
debug_prefix = debug_prefix,
|
||||
debug_only_errors = debug_only_errors
|
||||
)
|
||||
|
||||
# ┓┏ ┓
|
||||
# ┣┫┏┓┃┏┓┏┓┏┓┏
|
||||
# ┛┗┗ ┗┣┛┗ ┛ ┛
|
||||
# ┛
|
||||
|
||||
@staticmethod
|
||||
def get_mikrotik_url(
|
||||
nas_ip: str,
|
||||
path: str,
|
||||
port_no: int | str = None,
|
||||
use_https: bool = True
|
||||
) -> str:
|
||||
|
||||
"""
|
||||
Simply creates the base URL for hitting the MikroTik server.
|
||||
:param nas_ip: The IP address of the MikroTik device.
|
||||
:param path: The path of the REST API to hit.
|
||||
:param port_no: The port no. to hit the MikroTik device on.
|
||||
:param use_https: Whether to use HTTPS, or HTTP.
|
||||
:return: The Base URL string.
|
||||
"""
|
||||
|
||||
base_url = r"https://" if use_https else r"http://"
|
||||
base_url += nas_ip
|
||||
if port_no is not None: base_url += f":{port_no}"
|
||||
base_url += "/rest"
|
||||
if not path.startswith("/"): path = "/" + path
|
||||
return base_url + path
|
||||
|
||||
# ┏┓
|
||||
# ┗┓┓┏┏╋┏┓┏┳┓
|
||||
# ┗┛┗┫┛┗┗ ┛┗┗
|
||||
# ┛
|
||||
|
||||
async def get_system_resource(
|
||||
self,
|
||||
nas_ip: str,
|
||||
username: str,
|
||||
password: str,
|
||||
port_no: int | str = None,
|
||||
use_https: bool = True
|
||||
) -> ApiResponse:
|
||||
|
||||
"""
|
||||
To get a summary of the hardware resources available in the MikroTik device. This also becomes a great way to
|
||||
quickly check if any given device is valid, and up and running.
|
||||
:param nas_ip: The IP address of the MikroTik device.
|
||||
:param username: The username to get access to the MikroTik device.
|
||||
:param password: The password to get access to the MikroTik device.
|
||||
:param port_no: The port no. to hit the MikroTik device on.
|
||||
:param use_https: Whether to use HTTPS, or HTTP.
|
||||
:return: A structured API response.
|
||||
"""
|
||||
|
||||
# Make the API call and return the response:
|
||||
return await self._rest.get(
|
||||
url = self.get_mikrotik_url(
|
||||
nas_ip = nas_ip,
|
||||
path = r"/system/resource",
|
||||
port_no = port_no,
|
||||
use_https = use_https
|
||||
),
|
||||
auth = httpx.BasicAuth(
|
||||
username = username,
|
||||
password = password
|
||||
)
|
||||
)
|
||||
|
||||
# ┏┓ ┓
|
||||
# ┣┫┓┏╋┣┓
|
||||
# ┛┗┗┻┗┛┗
|
||||
|
||||
@abstractmethod
|
||||
async def save_auth(
|
||||
self,
|
||||
sql_conn: AsyncMySQL,
|
||||
@@ -257,7 +172,37 @@ class MikroTikController(CoreSoftwareController, ABC):
|
||||
:return: A structured response to indicate what happened during authorization.
|
||||
"""
|
||||
|
||||
pass
|
||||
raise NotImplementedError
|
||||
|
||||
# ┏┓ ┏•
|
||||
# ┃ ┏┓┏┓╋┓┏┓
|
||||
# ┗┛┗┛┛┗┛┗┗┫
|
||||
# ┛
|
||||
|
||||
async def roll_back(
|
||||
self,
|
||||
mikrotik_auth: MikroTikPPPoE1000Auth | MikroTikHotspot1000Auth
|
||||
) -> MikroTikRollBackAttemptResponse:
|
||||
"""
|
||||
The rolling-back to the original state (as best as possible) in case the configurations fails midway after
|
||||
completing some no. of steps.
|
||||
:param mikrotik_auth: The set of credentials as received from the UI/API.
|
||||
:return: A structured response to indicate what happened during the configuration attempt.
|
||||
"""
|
||||
|
||||
raise NotImplementedError
|
||||
|
||||
async def configure(
|
||||
self,
|
||||
mikrotik_auth: MikroTikPPPoE1000Auth | MikroTikHotspot1000Auth
|
||||
) -> MikroTikConfigAttemptResponse:
|
||||
"""
|
||||
Run the configuration steps for the system.
|
||||
:param mikrotik_auth: The set of credentials as received from the UI/API.
|
||||
:return: A structured response to indicate what happened during the configuration attempt.
|
||||
"""
|
||||
|
||||
raise NotImplementedError
|
||||
|
||||
|
||||
# *****************************************************************************************************************
|
||||
|
||||
Reference in New Issue
Block a user