Refactored code to be more concise

This commit is contained in:
Firq 2024-07-06 00:16:41 +02:00
parent d79a01cfb1
commit 58aea47921
Signed by: Firq
GPG key ID: 3ACC61C8CEC83C20
13 changed files with 64 additions and 46 deletions

View file

@ -1,7 +0,0 @@
from ...models import Command
from .descriptors import mapping
commands: dict[str, Command] = {}
for descriptor in mapping:
commands.update({ descriptor.cmd: descriptor })

View file

@ -0,0 +1,4 @@
from ...models import Command
from .mappings import mapping
commands: dict[str, Command] = { c.cmd: c for c in mapping }

View file

@ -4,15 +4,18 @@ from getpass import getpass
from ...models import Credentials from ...models import Credentials
from ...service import storage from ...service import storage
from ...service.communicate import DockgeConnection from ...service.communicate import DockgeConnection
from ..utils import stack_formatter, status_formatter, generic_formatter, get_credential_parser from ..utils import stack_formatter, status_formatter, generic_formatter, credential_parser_factory
class ExecutionCommands(): class FunctionBindings():
""" """
Helper class that provides all the static methods in an organized way Helper class that provides all the static methods in an organized way
This is an abstraction layer of the CLI, as those functions only do little preprocessing before calling the actural DockgeConnection This is an abstraction layer of the CLI, as those functions only do little preprocessing before calling the actural DockgeConnection
""" """
@staticmethod @staticmethod
def __setup(): def __setup():
"""
Creates a connection and logs into Dockge
"""
con = DockgeConnection() con = DockgeConnection()
con.connect_and_login() con.connect_and_login()
return con return con
@ -37,7 +40,7 @@ class ExecutionCommands():
login command binding login command binding
""" """
if len(extra_args) > 0: if len(extra_args) > 0:
credentials = get_credential_parser().parse_args(extra_args, namespace=Credentials) credentials = credential_parser_factory().parse_args(extra_args, namespace=Credentials)
storage.put("username", credentials.username, encoded=True) storage.put("username", credentials.username, encoded=True)
storage.put("password", credentials.password, encoded=True) storage.put("password", credentials.password, encoded=True)
return return
@ -64,7 +67,7 @@ class ExecutionCommands():
""" """
list command binding list command binding
""" """
con = ExecutionCommands.__setup() con = FunctionBindings.__setup()
stack_formatter(con.list_stacks()) stack_formatter(con.list_stacks())
con.disconnect() con.disconnect()
@ -75,7 +78,7 @@ class ExecutionCommands():
""" """
if extra_args is None: if extra_args is None:
raise ValueError raise ValueError
con = ExecutionCommands.__setup() con = FunctionBindings.__setup()
status_formatter(con.list_stack(extra_args[0])) status_formatter(con.list_stack(extra_args[0]))
con.disconnect() con.disconnect()
@ -86,7 +89,7 @@ class ExecutionCommands():
""" """
if extra_args is None: if extra_args is None:
raise ValueError raise ValueError
con = ExecutionCommands.__setup() con = FunctionBindings.__setup()
generic_formatter(con.restart(extra_args[0])) generic_formatter(con.restart(extra_args[0]))
con.disconnect() con.disconnect()
@ -97,7 +100,7 @@ class ExecutionCommands():
""" """
if extra_args is None: if extra_args is None:
raise ValueError raise ValueError
con = ExecutionCommands.__setup() con = FunctionBindings.__setup()
generic_formatter(con.update(extra_args[0])) generic_formatter(con.update(extra_args[0]))
con.disconnect() con.disconnect()
@ -108,7 +111,7 @@ class ExecutionCommands():
""" """
if extra_args is None: if extra_args is None:
raise ValueError raise ValueError
con = ExecutionCommands.__setup() con = FunctionBindings.__setup()
generic_formatter(con.stop(extra_args[0])) generic_formatter(con.stop(extra_args[0]))
con.disconnect() con.disconnect()
@ -119,7 +122,7 @@ class ExecutionCommands():
""" """
if extra_args is None: if extra_args is None:
raise ValueError raise ValueError
con = ExecutionCommands.__setup() con = FunctionBindings.__setup()
generic_formatter(con.start(extra_args[0])) generic_formatter(con.start(extra_args[0]))
con.disconnect() con.disconnect()
@ -130,7 +133,7 @@ class ExecutionCommands():
""" """
if extra_args is None: if extra_args is None:
raise ValueError raise ValueError
con = ExecutionCommands.__setup() con = FunctionBindings.__setup()
generic_formatter(con.down(extra_args[0])) generic_formatter(con.down(extra_args[0]))
con.disconnect() con.disconnect()

View file

@ -1,6 +1,6 @@
from typing import List from typing import List
from ...models import Command from ...models import Command
from .bindings import ExecutionCommands from .functions import FunctionBindings
mapping: List[Command] = [ mapping: List[Command] = [
Command( Command(
@ -8,83 +8,83 @@ mapping: List[Command] = [
description="Sets and gets the URI of the dockge instance. Remove any unnecessary subdomains/protocols from the URI", description="Sets and gets the URI of the dockge instance. Remove any unnecessary subdomains/protocols from the URI",
args=1, args=1,
optional=True, optional=True,
bind=ExecutionCommands.host func=FunctionBindings.host
), ),
Command( Command(
cmd="login", cmd="login",
description="Logs into a given dockge account, either with an interactive dialogue or by passing --user and --password", description="Logs into a given dockge account, either with an interactive dialogue or by passing --user and --password",
args=2, args=2,
optional=True, optional=True,
bind=ExecutionCommands.login func=FunctionBindings.login
), ),
Command( Command(
cmd="logout", cmd="logout",
description="Removes the credentials from the local storage.", description="Removes the credentials from the local storage.",
args=0, args=0,
optional=False, optional=False,
bind=ExecutionCommands.logout func=FunctionBindings.logout
), ),
Command( Command(
cmd="list", cmd="list",
description="Lists all available stacks with their status", description="Lists all available stacks with their status",
args=0, args=0,
optional=False, optional=False,
bind=ExecutionCommands.list func=FunctionBindings.list
), ),
Command( Command(
cmd="status", cmd="status",
description="Returns the status of one stack", description="Returns the status of one stack",
args=1, args=1,
optional=False, optional=False,
bind=ExecutionCommands.status func=FunctionBindings.status
), ),
Command( Command(
cmd="restart", cmd="restart",
description="Restarts a given stack", description="Restarts a given stack",
args=1, args=1,
optional=False, optional=False,
bind=ExecutionCommands.restart func=FunctionBindings.restart
), ),
Command( Command(
cmd="start", cmd="start",
description="Starts a given stack", description="Starts a given stack",
args=1, args=1,
optional=False, optional=False,
bind=ExecutionCommands.start func=FunctionBindings.start
), ),
Command( Command(
cmd="stop", cmd="stop",
description="Stops a given stack", description="Stops a given stack",
args=1, args=1,
optional=False, optional=False,
bind=ExecutionCommands.stop func=FunctionBindings.stop
), ),
Command( Command(
cmd="down", cmd="down",
description="Stop & Downs a given stack", description="Stop & Downs a given stack",
args=1, args=1,
optional=False, optional=False,
bind=ExecutionCommands.down func=FunctionBindings.down
), ),
Command( Command(
cmd="update", cmd="update",
description="Updates a stack", description="Updates a stack",
args=1, args=1,
optional=False, optional=False,
bind=ExecutionCommands.update func=FunctionBindings.update
), ),
Command( Command(
cmd="exit", cmd="exit",
description="Exits the CLI - this will reset all settings, including credentials and host", description="Exits the CLI - this will reset all settings, including credentials and host",
args=0, args=0,
optional=False, optional=False,
bind=ExecutionCommands.exit func=FunctionBindings.exit
), ),
Command( Command(
cmd="help", cmd="help",
description="Displays helping hints for commands", description="Displays helping hints for commands",
args=1, args=1,
optional=True, optional=True,
bind=ExecutionCommands.help func=FunctionBindings.help
) )
] ]

View file

@ -3,7 +3,7 @@ import sys
from .. import __version__ from .. import __version__
from ..models import Arguments from ..models import Arguments
from .commandprovider.factory import commands from .commands import commands
def parse_arguments(): def parse_arguments():
""" """

View file

@ -1,4 +1,4 @@
from .commandprovider.factory import commands from .commands import commands
def display_help(extra_args): def display_help(extra_args):
""" """
@ -32,4 +32,4 @@ def run(command, args):
display_help(args) display_help(args)
return return
c.bind(args) c.func(args)

View file

@ -2,7 +2,7 @@ import argparse
from tabulate import tabulate from tabulate import tabulate
from ..models import StackStatus from ..models import StackStatus
def get_credential_parser(): def credential_parser_factory():
""" """
Creates a new parser for login credentials Creates a new parser for login credentials
""" """
@ -23,7 +23,7 @@ def stack_formatter(stacks):
table, headers = [], ["Stackname", "Status"] table, headers = [], ["Stackname", "Status"]
for key, val in stacks["stackList"].items(): for key, val in stacks["stackList"].items():
table.append([key, StackStatus(val['status']).name]) table.append([key, StackStatus(val['status']).name.lower()])
print(tabulate(table, headers=headers, tablefmt="github"), "\n") print(tabulate(table, headers=headers, tablefmt="github"), "\n")

View file

@ -1,3 +1,3 @@
from .codes import StackStatus from .codes import StackStatus
from .commands import Command from .command import Command
from .parser import Arguments, Credentials from .parser import Arguments, Credentials

View file

@ -2,9 +2,8 @@ from enum import Enum
class StackStatus(Enum): class StackStatus(Enum):
""" """
mapping codes for status vs text mapping for plaintext vs statuscode
""" """
# pylint: disable=invalid-name INACTIVE = 1
inactive = 1 RUNNING = 3
running = 3 EXITED = 4
exited = 4

View file

@ -6,7 +6,7 @@ class Command(BaseModel):
Basic command structure for the CLI to automatically generate valid commands Basic command structure for the CLI to automatically generate valid commands
""" """
cmd: str cmd: str
bind: Callable func: Callable
args: int args: int
optional: bool optional: bool
description: str description: str

View file

@ -32,7 +32,7 @@ class DockgeConnection:
def _init_events(self): def _init_events(self):
@self._sio.event @self._sio.event
def connect(): def connect():
self.connect() self.login()
print("Connected!") print("Connected!")
@self._sio.event @self._sio.event
@ -70,10 +70,11 @@ class DockgeConnection:
""" """
Connect to the websocket Connect to the websocket
""" """
# Dockge uses Socket.io for the websockets, so this URI and params are always the same
self._sio.connect(f"https://{self._host}/socket.io/", transports=['websocket']) self._sio.connect(f"https://{self._host}/socket.io/", transports=['websocket'])
self.connect() self.login()
def connect(self): def login(self):
""" """
Log into dockge using basicauth Log into dockge using basicauth
Retries 5 times when timeouts occur Retries 5 times when timeouts occur
@ -84,6 +85,11 @@ class DockgeConnection:
data = None data = None
retry, count = True, 0 retry, count = True, 0
if not storage.exists("username"):
raise ValueError("Missing username")
if not storage.exists("password"):
raise ValueError("Missing password")
while retry and count < 5: while retry and count < 5:
try: try:
data = self._sio.call( data = self._sio.call(
@ -91,7 +97,7 @@ class DockgeConnection:
{ {
"username": storage.get("username", encoded=True), "username": storage.get("username", encoded=True),
"password": storage.get("password", encoded=True), "password": storage.get("password", encoded=True),
"token":"" "token": ""
}, },
timeout=5 timeout=5
) )

View file

@ -16,6 +16,19 @@ def fileexists():
with open(_file, 'a', encoding="utf-8"): with open(_file, 'a', encoding="utf-8"):
os.utime(_file, None) os.utime(_file, None)
def exists(key: str) -> bool:
"""
Checks if a given key exists in the storage file
"""
if not _file.exists():
return False
with open(_file, "r", encoding="utf-8") as file:
content: dict[str, str] = yaml.load(file, Loader=yaml.SafeLoader)
return key in content
def put(key: str, value: str, encoded=False): def put(key: str, value: str, encoded=False):
""" """
Puts a given value with a given key into the storage file Puts a given value with a given key into the storage file