Moved files, refactored calls, added credentials warning

dockge_cli/.gitignore

@@ -1 +0,0 @@
-.temp/*

dockge_cli/client/commandprovider/factory.py

@@ -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  })

dockge_cli/client/commands/__init__.py

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

dockge_cli/client/commands/functions.py

@@ -4,15 +4,18 @@ from getpass import getpass
 from ...models import Credentials
 from ...service import storage
 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
     This is an abstraction layer of the CLI, as those functions only do little preprocessing before calling the actural DockgeConnection
     """
     @staticmethod
     def __setup():
+        """
+        Creates a connection and logs into Dockge
+        """
         con = DockgeConnection()
         con.connect_and_login()
         return con
@@ -36,8 +39,9 @@ class ExecutionCommands():
         """
         login command binding
         """
+        print(f"WARNING! These credentials will be saved unencrypted in {storage._file.absolute()}")
         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("password", credentials.password, encoded=True)
             return
@@ -64,7 +68,7 @@ class ExecutionCommands():
         """
         list command binding
         """
-        con = ExecutionCommands.__setup()
+        con = FunctionBindings.__setup()
         stack_formatter(con.list_stacks())
         con.disconnect()
 
@@ -73,9 +77,7 @@ class ExecutionCommands():
         """
         status command binding
         """
-        if extra_args is None:
-            raise ValueError
-        con = ExecutionCommands.__setup()
+        con = FunctionBindings.__setup()
         status_formatter(con.list_stack(extra_args[0]))
         con.disconnect()
 
@@ -84,9 +86,7 @@ class ExecutionCommands():
         """
         restart command binding
         """
-        if extra_args is None:
-            raise ValueError
-        con = ExecutionCommands.__setup()
+        con = FunctionBindings.__setup()
         generic_formatter(con.restart(extra_args[0]))
         con.disconnect()
 
@@ -95,9 +95,7 @@ class ExecutionCommands():
         """
         update command binding
         """
-        if extra_args is None:
-            raise ValueError
-        con = ExecutionCommands.__setup()
+        con = FunctionBindings.__setup()
         generic_formatter(con.update(extra_args[0]))
         con.disconnect()
 
@@ -106,9 +104,7 @@ class ExecutionCommands():
         """
         stop command binding
         """
-        if extra_args is None:
-            raise ValueError
-        con = ExecutionCommands.__setup()
+        con = FunctionBindings.__setup()
         generic_formatter(con.stop(extra_args[0]))
         con.disconnect()
 
@@ -117,9 +113,7 @@ class ExecutionCommands():
         """
         start command binding
         """
-        if extra_args is None:
-            raise ValueError
-        con = ExecutionCommands.__setup()
+        con = FunctionBindings.__setup()
         generic_formatter(con.start(extra_args[0]))
         con.disconnect()
 
@@ -128,9 +122,7 @@ class ExecutionCommands():
         """
         down command binding
         """
-        if extra_args is None:
-            raise ValueError
-        con = ExecutionCommands.__setup()
+        con = FunctionBindings.__setup()
         generic_formatter(con.down(extra_args[0]))
         con.disconnect()
 

dockge_cli/client/commands/mappings.py

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

dockge_cli/client/parser.py

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

dockge_cli/client/run.py

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

dockge_cli/client/utils.py

@@ -2,7 +2,7 @@ import argparse
 from tabulate import tabulate
 from ..models import StackStatus
 
-def get_credential_parser():
+def credential_parser_factory():
     """
     Creates a new parser for login credentials
     """
@@ -23,7 +23,7 @@ def stack_formatter(stacks):
 
     table, headers = [], ["Stackname", "Status"]
     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")
 

dockge_cli/models/__init__.py

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

dockge_cli/models/codes.py

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

dockge_cli/models/command.py

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

dockge_cli/service/.gitignore

@@ -0,0 +1 @@
+.storage/*

dockge_cli/service/communicate.py

@@ -32,7 +32,7 @@ class DockgeConnection:
     def _init_events(self):
         @self._sio.event
         def connect():
-            self.connect()
+            self.login()
             print("Connected!")
 
         @self._sio.event
@@ -70,10 +70,11 @@ class DockgeConnection:
         """
         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.connect()
+        self.login()
 
-    def connect(self):
+    def login(self):
         """
         Log into dockge using basicauth
         Retries 5 times when timeouts occur
@@ -84,6 +85,11 @@ class DockgeConnection:
         data = None
         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:
             try:
                 data = self._sio.call(
@@ -91,7 +97,7 @@ class DockgeConnection:
                     {
                         "username": storage.get("username", encoded=True),
                         "password": storage.get("password", encoded=True),
-                        "token":""
+                        "token": ""
                     },
                     timeout=5
                 )

dockge_cli/service/storage.py

@@ -3,28 +3,44 @@ import pathlib
 import base64
 import yaml
 
-_storagepath = pathlib.Path(__file__).parents[1] / ".temp"
+_storagepath = pathlib.Path(__file__).parent / ".storage"
+_storagepath.mkdir(exist_ok=True, parents=True)
 _file = _storagepath / "storage.yaml"
 
-_storagepath.mkdir(exist_ok=True, parents=True)
-
-def fileexists():
+def create_file_when_missing():
     """
     Checks if storage file does exist, creates it when necessary
     """
+    if _file.exists():
+        return
+    with open(_file, 'a', encoding="utf-8"):
+        os.utime(_file, None)
+
+def exists(key: str) -> bool:
+    """
+    Checks if a given key exists in the storage file
+    """
     if not _file.exists():
-        with open(_file, 'a', encoding="utf-8"):
-            os.utime(_file, None)
+        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):
     """
     Puts a given value with a given key into the storage file
     Encodes the data as base64 when encoded is set to true
     """
-    fileexists()
-    with open(_file, "r+", encoding="utf-8") as file:
+    if not _file.exists():
+        create_file_when_missing()
+
+    with open(_file, "r", encoding="utf-8") as file:
         content: dict[str, str] = yaml.load(file, Loader=yaml.SafeLoader) or {}
         content.update({ key: str(base64.b64encode(value.encode()), "utf-8") if encoded else value })
+
     with open(_file, "w+", encoding="utf-8") as file:
         yaml.dump(content, file, Dumper=yaml.SafeDumper)
 
@@ -32,10 +48,13 @@ def remove(key: str):
     """
     Removed a given key from the storage file
     """
-    fileexists()
+    if not _file.exists():
+        create_file_when_missing()
+
     with open(_file, "r", encoding="utf-8") as file:
         content: dict[str, str] = yaml.load(file, Loader=yaml.SafeLoader) or {}
         content.pop(key, None)
+
     with open(_file, "w+", encoding="utf-8") as file:
         yaml.dump(content, file, Dumper=yaml.SafeDumper)
 
@@ -47,9 +66,11 @@ def get(key: str, encoded=False):
     value: str | None = None
     if not _file.exists():
         return None
+
     with open(_file, "r", encoding="utf-8") as file:
         content: dict[str, str] = yaml.load(file, Loader=yaml.SafeLoader)
         value = content.get(key, None)
+
     if value is None:
         return None
     return base64.b64decode(value.encode()).decode() if encoded else value
@@ -58,4 +79,6 @@ def clear():
     """
     Deletes the storage file
     """
+    if not _file.exists():
+        return
     _file.unlink()

pyproject.toml

@@ -1,6 +1,6 @@
 [project]
 name = "dockge_cli"
-version = "0.1.0-c.2"
+version = "0.1.0-c.3"
 dependencies = [
     "pyyaml~=6.0.1",
     "pydantic~=2.8.0",