fix, refactor: debugged circular class ref via refactor & renaming

This commit is contained in:
2026-01-03 15:53:10 -05:00
parent 46d04d7c88
commit d46a10191b

212
anodes.py
View File

@@ -5,14 +5,15 @@ Library of classes modeling Ansible nodes or their types.
from pathlib import Path, PurePath from pathlib import Path, PurePath
from typing import TypeAlias as Neotype from typing import TypeAlias as Neotype
from typing import TypedDict as Dict from typing import TypedDict as Dict
from typing import Never, Union, Literal from typing import Never, Union, Literal, Required
from collections.abc import Callable from collections.abc import Callable
from custtypes import ExecutedPath, IdlePath from custtypes import ExecutedPath, IdlePath
from enum import Enum from enum import Enum
from softman import Software, SoftPathGroup, SoftScope from softman import Software, SoftPathGroup, SoftScope, _Apps
from whereami import USER_PATH, PROJ_ROOT from whereami import USER_PATH, PROJ_ROOT
from ansible_vault import Vault from ansible_vault import Vault
from cerberus import Validator as constrain_by from cerberus import Validator as constrain_by
from random import choice
class ControlNode: class ControlNode:
__user_path: ExecutedPath = USER_PATH __user_path: ExecutedPath = USER_PATH
@@ -27,7 +28,7 @@ class ControlNode:
PurePath(str(__user_path), ".local", "share") PurePath(str(__user_path), ".local", "share")
) )
def __init__(self, ansible_proj_root: ExecutedPath | None): def __init__(self, ansible_proj_root: ExecutedPath | None = None):
if ansible_proj_root is not None: if ansible_proj_root is not None:
self.__proj_root = ansible_proj_root self.__proj_root = ansible_proj_root
self.proj_roles: tuple[IdlePath] | list[IdlePath] = ( self.proj_roles: tuple[IdlePath] | list[IdlePath] = (
@@ -36,7 +37,9 @@ class ControlNode:
) )
self.role_data: tuple[IdlePath] | list[IdlePath] = ( self.role_data: tuple[IdlePath] | list[IdlePath] = (
PurePath(str(self.proj_roles[0]), "files"), PurePath(str(self.proj_roles[0]), "files"),
PurePath(str(self.proj_roles[0]), "templates") PurePath(str(self.proj_roles[0]), "templates"),
PurePath(str(self.proj_roles[1]), "files"),
PurePath(str(self.proj_roles[1]), "templates")
) )
self.invvar_data: tuple[IdlePath] | list[IdlePath] = ( self.invvar_data: tuple[IdlePath] | list[IdlePath] = (
PurePath(str(self.__proj_root), "group_vars"), PurePath(str(self.__proj_root), "group_vars"),
@@ -56,21 +59,34 @@ class ControlNode:
return self.__conf_paths return self.__conf_paths
@property @property
def conf_paths(self) -> ExecutedPath: def data_paths(self) -> ExecutedPath:
return self.__data_paths return self.__data_paths
class Softs(Enum): class Softs(Enum):
OpenSSH = "ssh" ssh = 0
userSSHParams = Dict("userSSHParams", { userSSHSubParams = {
"username": Required[str],
"paths": Software._Apps,
"keys": {
"available": Required[tuple[ExecutedPath]], "available": Required[tuple[ExecutedPath]],
"selected": Required[ExecutedPath | list[ExecutedPath] | int | list[int]], "selected": Required[ExecutedPath | list[ExecutedPath] | int | list[int]],
"authorized": ExecutedPath | list[ExecutedPath] | int | list[int], "authorized": ExecutedPath | list[ExecutedPath] | int | list[int],
"used": ExecutedPath | list[ExecutedPath] | int | list[int] "used": ExecutedPath | list[ExecutedPath] | int | list[int]
}, }
__user_ssh_keys = {
"available": tuple(),
"selected": [0, 1],
"authorized": 1,
"used": 0
}
def userSSHInit(self, username: str = "root", paths: _Apps | None = None, keys: userSSHSubParams = __user_ssh_keys, password: str = "password123", fate: Literal["disposal", "retention"] = "disposal"):
self.username = username
self.paths = paths
self.keys = keys
self.password = password
self.fate = fate
userSSHParams = Dict("userSSHParams", {
"username": Required[str],
"paths": _Apps,
"keys": __user_ssh_keys,
"password": Required[str], "password": Required[str],
"fate": Literal["disposal", "retention"] "fate": Literal["disposal", "retention"]
}, total=False) }, total=False)
@@ -84,37 +100,27 @@ __user_ssh_input = {
"used": 0 "used": 0
}, },
"password": "password123", "password": "password123",
"fate": "disposal" "fate": "disposal",\
"__init__": userSSHInit
} }
# @TODO remove unpacking of '__user_ssh_input' userSSH = type("userSSH", (), __user_ssh_input)
userSSH = type("userSSH", (), **__user_ssh_input)
vps_schema = { vpsSchema = Dict("vpsSchema", {
"fqdn": {"type": "string"}, "fqdn": Required[str],
"vps_service": { "vps_service": {
"type": "dict", "exists": Required[bool],
"schema": { "password": Required[str],
"exists": {"type": "boolean"}, "api_key": Required[str],
"password": {"type": "string"}, "type": Required[Literal["linode"]],
"api_key": {"type": "string"}, "region": Literal["us-east"],
"type": { "ssh_authorized_keys": list[IdlePath | ExecutedPath | str],
"type": "string", "ssh_private_key_paths": list[IdlePath | ExecutedPath | str],
"anyof": ["linode"] "ssh_private_key_path_pref": int,
"root_fate": Required[Literal["disposal","retention"]],
"ssh_motd_script_basenames": list[str]
}, },
"region": { "keywords": list[str]
"type": "string", }, total=False)
"anyof": ["us-east"]
},
"ssh_authorized_keys": {"type": "list"},
"root_fate": {
"type": "string",
"anyof": ["disposal", "retention"]
}
}
},
"keywords": {"type": "list"}
}
vps_schema = constrain_by(vps_schema)
class VirtualPrivateServers(Enum): class VirtualPrivateServers(Enum):
Linode = 0 Linode = 0
@@ -123,7 +129,7 @@ class RemoteNode:
# __user_path = # __user_path =
_fqdn: str | None = None _fqdn: str | None = None
def __init__(self, cnode: ControlNode, api_key: str, password: str, name: str, service: VirtualPrivateServers = VirtualPrivateServers.Linode.name, keywords: list[str] | None = None): def __init__(self, cnode: ControlNode, api_key: str, password: str, name: str, service: VirtualPrivateServers = VirtualPrivateServers.Linode.name, region: Literal["us-east"] | None = None, keywords: list[str] | None = None):
self.root: dict = dict() self.root: dict = dict()
self.root["username"]: str = "root" self.root["username"]: str = "root"
vault = Vault(password) vault = Vault(password)
@@ -132,13 +138,13 @@ class RemoteNode:
app_input = { app_input = {
SoftPathGroup.CONFIG.name: { SoftPathGroup.CONFIG.name: {
SoftScope.PERSONAL.name: PurePath(str(cnode.user_path), ("." + Softs.OpenSSH)) SoftScope.PERSONAL.name: PurePath(str(cnode.user_path), ("." + Softs.ssh.name))
}, },
SoftPathGroup.DATA.name: { SoftPathGroup.DATA.name: {
SoftScope.GLOBAL.name: PurePath(str(cnode.conf_paths[0]), "update-motd.d") SoftScope.GLOBAL.name: PurePath(str(cnode.conf_paths[0]), "update-motd.d")
} }
} }
self.root["software"].declare(Softs.OpenSSH, **app_input) self.root["software"].declare(Softs.ssh.name, **app_input)
self._fqdn = name self._fqdn = name
self.root["software"]._fqdn = name self.root["software"]._fqdn = name
@@ -153,6 +159,11 @@ class RemoteNode:
self.keywords = keywords self.keywords = keywords
self._api_key: str | None = api_key self._api_key: str | None = api_key
self.service = service self.service = service
self.region = region
self.__authkeys_selected = False
self.__usedkeys_selected = False
self.__keys_selected = False
self.__finalized_keys = False
def set_region(self, name: Literal["us-east"] = "us-east") -> None: def set_region(self, name: Literal["us-east"] = "us-east") -> None:
self.region = name self.region = name
@@ -179,7 +190,7 @@ class RemoteNode:
self.keywords: list = [] self.keywords: list = []
self.keywords += list(name) self.keywords += list(name)
def import_keys(self, key_basenames: str | tuple[str], match_sort: tuple[Callable, bool] = (lambda e: e, False)): def import_keys(self, key_basenames: str | tuple[str], match_sort: tuple[Callable, bool] = (lambda e: e.stem, False)):
keyfiles: list[ExecutedPath] | list[None] | None = list() keyfiles: list[ExecutedPath] | list[None] | None = list()
if isinstance(key_basenames, tuple): if isinstance(key_basenames, tuple):
for basename in key_basenames: for basename in key_basenames:
@@ -196,10 +207,10 @@ class RemoteNode:
keyfiles = updated_keyfiles keyfiles = updated_keyfiles
self.ssh.paths = self.root["software"].ssh self.ssh.paths = self.root["software"].ssh
self.ssh.keys["available"] = tuple(keyfiles.sort(reverse = match_sort[1], key = match_sort[0])) self.ssh.keys["available"] = tuple(sorted(keyfiles, key=match_sort[0], reverse=match_sort[1]))
def show_keys(self, which: Literal["authorized", "used", "available", "selected"] = "available") -> tuple[tuple, str]: def show_keys(self, which: Literal["authorized", "used", "available", "selected"] = "available", kformat = object) -> tuple[tuple, str]:
delimiters: str | tuple = "{}" delimiters: str | tuple = "[]"
gap: Callable[[bool], str | None] = lambda b: " " if b else "" gap: Callable[[bool], str | None] = lambda b: " " if b else ""
sep_format: str = "{0}" sep_format: str = "{0}"
sep: Callable[[str, bool], str] = lambda s, b: sep_format.format(s) + gap(b) sep: Callable[[str, bool], str] = lambda s, b: sep_format.format(s) + gap(b)
@@ -235,17 +246,34 @@ class RemoteNode:
stringified_keyfiles = list(map(lambda t: label(t[0], True) + str(t[1]), enumerate(keyfiles))) stringified_keyfiles = list(map(lambda t: label(t[0], True) + str(t[1]), enumerate(keyfiles)))
stringified_keyfiles = sep(",", True).join(stringified_keyfiles) stringified_keyfiles = sep(",", True).join(stringified_keyfiles)
stringified_keyfiles = delimiters[0:len(delimiters)] + stringified_keyfiles[:(len(stringified_keyfiles) - 2)] + delimiters[1:] stringified_keyfiles = delimiters[0] + stringified_keyfiles[:(len(stringified_keyfiles) - 2)] + delimiters[1:]
return (tuple(keyfiles), stringified_keyfiles) if kformat == str:
result = stringified_keyfiles
elif kformat == list:
result = keyfiles
elif kformat == tuple:
result = tuple(keyfiles)
elif kformat == object:
result = (tuple(keyfiles), stringified_keyfiles)
print(result)
return result
def pick_keys(self, source: Literal["authorized", "used", "available", "selected"] = "available", *selections: int | ExecutedPath | str) -> list[ExecutedPath] | Never: def pick_keys(self, source: Literal["authorized", "used", "available", "selected"] = "available", *selections: int | ExecutedPath | str) -> list[ExecutedPath] | Never:
keyfiles = self.ssh.keys[source] keyfiles = self.ssh.keys[source]
# print(keyfiles)
if keyfiles is None:
raise TypeError
elif isinstance(keyfiles, (tuple, list)) and len(keyfiles) < 1:
raise ValueError
authlist = [] authlist = []
if source == "available" or source == "selected": if source == "available":
for s in selections: for s in selections:
if isinstance(s, int): if isinstance(s, int):
# print(s)
authlist.append(keyfiles[s]) authlist.append(keyfiles[s])
elif isinstance(s, ExecutedPath): elif isinstance(s, ExecutedPath):
path_set = set([s]) path_set = set([s])
@@ -262,32 +290,73 @@ class RemoteNode:
if s in kf_strs: if s in kf_strs:
authlist.append(Path(s)) authlist.append(Path(s))
if source == "available":
self.ssh.keys["selected"] = authlist self.ssh.keys["selected"] = authlist
return self.ssh.keys["selected"] self.__keys_selected = True
elif source == "selected": result = self.ssh.keys["selected"]
self.ssh.keys["authorized"] = authlist if source == "selected":
return self.ssh.keys["authorized"] privkeys = list()
pubkeys = list()
count = 1
for s in selections:
if isinstance(s, int):
# print(s)
if count % 2 == 0:
pubkeys.append(keyfiles[s])
else:
privkeys.append(keyfiles[s])
elif isinstance(s, ExecutedPath):
path_set = set([s])
kf_set = set(keyfiles)
overlap = kf_set & path_set
if overlap is not None and len(overlap) > 0:
if count % 2 == 0:
pubkeys.append(list(overlap)[0])
else:
privkeys.append(list(overlap)[0])
else:
continue
elif isinstance(s, str):
kf_strs = list(map(lambda p: str(p), keyfiles))
if s in kf_strs:
if count % 2 == 0:
pubkeys.append(Path(s))
else:
privkeys.append(Path(s))
count += 1
self.ssh.keys["authorized"] = pubkeys
self.ssh.keys["used"] = privkeys
self.__authkeys_selected = True
self.__usedkeys_selected = True
result = (self.ssh.keys["authorized"], self.ssh.keys["used"])
elif source == "authorized": elif source == "authorized":
for s in selections: for s in selections:
if isinstance(s, int): if isinstance(s, int):
authlist.append(keyfiles[s]) if self.ssh.keys["selected"][s] in keyfiles:
authlist.append(self.ssh.keys["selected"][s])
elif isinstance(s, ExecutedPath): elif isinstance(s, ExecutedPath):
for p in keyfiles: for p in self.ssh.keys["selected"]:
if str(s) in str(p): if str(s) in str(p) and str(s) in list(map(lambda p: str(p), keyfiles)):
authlist.append(p) authlist.append(p)
else: else:
continue continue
elif isinstance(s, str): elif isinstance(s, str):
for p in keyfiles: for p in self.ssh.keys["selected"]:
if s in str(p): if s in str(p) and s in list(map(lambda p: str(p), keyfiles)):
authlist.append(p) authlist.append(p)
else: else:
continue continue
self.ssh.keys["used"] = authlist self.ssh.keys["used"] = authlist
return self.ssh.keys["used"] self.__usedkeys_selected = True
result = self.ssh.keys["used"]
self.__finalized_keys = self.__keys_selected and self.__authkeys_selected and self.__usedkeys_selected
return result
# @TODO test and debug below 'RemoteNode' method
def remove_keys(self, source: Literal["authorized", "used", "available", "selected"] = "available", *selections: int | ExecutedPath | str) -> list[ExecutedPath] | Never: def remove_keys(self, source: Literal["authorized", "used", "available", "selected"] = "available", *selections: int | ExecutedPath | str) -> list[ExecutedPath] | Never:
keyfiles = self.ssh.keys[source] keyfiles = self.ssh.keys[source]
@@ -324,9 +393,18 @@ class RemoteNode:
return self.ssh.keys return self.ssh.keys
def itemize(self): def itemize(self):
model = dict() model: dict | vpsSchema = dict()
vault_api = Vault(self._api_key) vault_api = Vault(self._api_key)
vault_pass = Vault(self.ssh.password) vault_pass = Vault(self.ssh.password)
# print(self.ssh.keys["selected"])
if not self.__keys_selected:
self.pick_keys("available", *self.ssh.keys["selected"])
self.pick_keys("selected", self.ssh.keys["authorized"], self.ssh.keys["used"])
# self.pick_keys("selected", self.ssh.keys["used"])
authorized_keys = list(map(lambda p: p.read_text(), self.ssh.keys["authorized"]))
used_keys = list(map(lambda p: str(p), self.ssh.keys["used"]))
model["fqdn"] = self._fqdn model["fqdn"] = self._fqdn
model["vps_service"] = { model["vps_service"] = {
@@ -335,10 +413,16 @@ class RemoteNode:
"api_key": vault_api.dump(self._api_key), "api_key": vault_api.dump(self._api_key),
"type": self.service.lower(), "type": self.service.lower(),
"region": self.region, "region": self.region,
"ssh_authorized_keys": self.ssh.keys["authorized"], "ssh_authorized_keys": authorized_keys,
"root_fate": self.ssh.fate "ssh_private_key_paths": used_keys,
"ssh_private_key_path_pref": choice(list(range(len(used_keys)))),
"root_fate": self.ssh.fate,
"ssh_motd_script_basenames": []
} }
model["keywords"] = self.keywords model["keywords"] = self.keywords
if vps_schema.validate(model):
return model return model
rnode = RemoteNode(ControlNode(), "dfsfsd", "sdgsadh", "test.io", VirtualPrivateServers.Linode.name, "us-east", ["meh"])
rnode.import_keys("*ed25519*sukaato_*yubikey.p[up][bk]", (lambda e: e.stem, True))
rnode.show_keys(kformat=tuple)
print(rnode.itemize())