CTX-5430: Coretex configuration centralization refactor.

coretex/__init__.py

@@ -22,7 +22,7 @@
 
 # Internal - not for outside use
 from ._logger import _initializeDefaultLogger, _initializeCLILogger
-from .configuration import isCliRuntime
+from .utils import isCliRuntime
 
 
 if isCliRuntime():

coretex/cli/commands/login.py

@@ -17,25 +17,26 @@
 
 import click
 
-from ..modules.user import configUser
-from ..modules.ui import clickPrompt, stdEcho, successEcho
-from ...configuration import loadConfig, saveConfig, isUserConfigured
+from ..modules import user, ui
+from ...configuration import UserConfiguration, InvalidConfiguration, ConfigurationNotFound
 
 
 @click.command()
 def login() -> None:
-    config = loadConfig()
-    if isUserConfigured(config):
-        if not clickPrompt(
-            f"User already logged in with username {config['username']}.\nWould you like to log in with a different user (Y/n)?",
+    try:
+        userConfig = UserConfiguration.load()
+        if not ui.clickPrompt(
+            f"User already logged in with username {userConfig.username}.\nWould you like to log in with a different user (Y/n)?",
             type = bool,
             default = True,
             show_default = False
         ):
             return
 
-    stdEcho("Please enter your credentials:")
-    configUser(config)
-    saveConfig(config)
+    except (ConfigurationNotFound, InvalidConfiguration):
+        pass
 
-    successEcho(f"User {config['username']} successfully logged in.")
+    ui.stdEcho("Please enter your credentials:")
+    userConfig = user.configUser()
+    userConfig.save()
+    ui.successEcho(f"User {userConfig.username} successfully logged in.")

coretex/cli/commands/model.py

@@ -2,9 +2,12 @@
 
 import click
 
-from ..modules import project_utils, user, utils, ui
+from ..modules import ui
+from ..modules.project_utils import getProject
+from ..modules.user import initializeUserSession
+from ..modules.utils import onBeforeCommandExecute
 from ...entities import Model
-from ...configuration import loadConfig
+from ...configuration import UserConfiguration
 
 
 @click.command()
@@ -13,12 +16,12 @@
 @click.option("-p", "--project", type = str, required = False, default = None)
 @click.option("-a", "--accuracy", type = click.FloatRange(0, 1), required = False, default = 1)
 def create(name: str, path: str, project: Optional[str], accuracy: float) -> None:
-    config = loadConfig()
+    userConfig = UserConfiguration.load()
 
     # If project was provided used that, otherwise get the one from config
     # If project that was provided does not exist prompt user to create a new
     # one with that name
-    ctxProject = project_utils.getProject(project, config)
+    ctxProject = getProject(project, userConfig)
     if ctxProject is None:
         return
 
@@ -32,7 +35,7 @@ def create(name: str, path: str, project: Optional[str], accuracy: float) -> Non
 
 
 @click.group()
-@utils.onBeforeCommandExecute(user.initializeUserSession)
+@onBeforeCommandExecute(initializeUserSession)
 def model() -> None:
     pass
 

coretex/cli/commands/node.py

@@ -19,59 +19,60 @@
 
 import click
 
+from ..modules import ui
 from ..modules import node as node_module
-from ..modules.ui import clickPrompt, stdEcho, successEcho, errorEcho, previewConfig
-from ..modules.update import NodeStatus, getNodeStatus, activateAutoUpdate
-from ..modules.utils import onBeforeCommandExecute, checkEnvironment
+from ..modules.node import NodeStatus
 from ..modules.user import initializeUserSession
-from ...configuration import loadConfig, saveConfig, isNodeConfigured
+from ..modules.utils import onBeforeCommandExecute, checkEnvironment
+from ..modules.update import activateAutoUpdate, getNodeStatus
 from ...utils import docker
+from ...configuration import UserConfiguration, NodeConfiguration, InvalidConfiguration, ConfigurationNotFound
 
 
 @click.command()
 @click.option("--image", type = str, help = "Docker image url")
 @onBeforeCommandExecute(node_module.initializeNodeConfiguration)
 def start(image: Optional[str]) -> None:
-    config = loadConfig()
+    nodeConfig = NodeConfiguration.load()
 
     if node_module.isRunning():
-        if not clickPrompt(
+        if not ui.clickPrompt(
             "Node is already running. Do you wish to restart the Node? (Y/n)",
             type = bool,
             default = True,
             show_default = False
         ):
             return
 
-        node_module.stop(config.get("nodeId", node_module.fetchNodeId(config["nodeName"])))
+        node_module.stop(nodeConfig.id)
 
     if node_module.exists():
         node_module.clean()
 
+
     if image is not None:
-        config["image"] = image  # store forced image (flagged) so we can run autoupdate afterwards
-        saveConfig(config)
+        nodeConfig.image = image  # store forced image (flagged) so we can run autoupdate afterwards
+        nodeConfig.save()
 
-    dockerImage = config["image"]
+    dockerImage = nodeConfig.image
 
     if node_module.shouldUpdate(dockerImage):
         node_module.pull(dockerImage)
 
-    node_module.start(dockerImage, config)
+    node_module.start(dockerImage, nodeConfig)
     docker.removeDanglingImages(node_module.getRepoFromImageUrl(dockerImage), node_module.getTagFromImageUrl(dockerImage))
-
     activateAutoUpdate()
 
 
 @click.command()
 def stop() -> None:
-    config = loadConfig()
+    nodeConfig = NodeConfiguration.load()
 
     if not node_module.isRunning():
-        errorEcho("Node is already offline.")
+        ui.errorEcho("Node is already offline.")
         return
 
-    node_module.stop(config.get("nodeId", node_module.fetchNodeId(config["nodeName"])))
+    node_module.stop(nodeConfig.id)
 
 
 @click.command()
@@ -80,95 +81,101 @@ def stop() -> None:
 @onBeforeCommandExecute(node_module.initializeNodeConfiguration)
 def update(autoAccept: bool, autoDecline: bool) -> None:
     if autoAccept and autoDecline:
-        errorEcho("Only one of the flags (\"-y\" or \"-n\") can be used at the same time.")
+        ui.errorEcho("Only one of the flags (\"-y\" or \"-n\") can be used at the same time.")
         return
 
-    config = loadConfig()
-    dockerImage = config["image"]
-
-    nodeStatus = getNodeStatus()
+    nodeConfig = NodeConfiguration.load()
+    nodeStatus = node_module.getNodeStatus()
 
     if nodeStatus == NodeStatus.inactive:
-        errorEcho("Node is not running. To update Node you need to start it first.")
+        ui.errorEcho("Node is not running. To update Node you need to start it first.")
         return
 
     if nodeStatus == NodeStatus.reconnecting:
-        errorEcho("Node is reconnecting. Cannot update now.")
+        ui.errorEcho("Node is reconnecting. Cannot update now.")
         return
 
     if nodeStatus == NodeStatus.busy and not autoAccept:
         if autoDecline:
             return
 
-        if not clickPrompt(
+        if not ui.clickPrompt(
             "Node is busy, do you wish to terminate the current execution to perform the update? (Y/n)",
             type = bool,
             default = True,
             show_default = False
         ):
             return
 
-        node_module.stop(config.get("nodeId", node_module.fetchNodeId(config["nodeName"])))
+        node_module.stop(nodeConfig.id)
 
-    if not node_module.shouldUpdate(dockerImage):
-        successEcho("Node is already up to date.")
+    if not node_module.shouldUpdate(nodeConfig.image):
+        ui.successEcho("Node is already up to date.")
         return
 
-    stdEcho("Updating node...")
-    node_module.pull(dockerImage)
+    ui.stdEcho("Fetching latest node image...")
+    node_module.pull(nodeConfig.image)
 
     if getNodeStatus() == NodeStatus.busy and not autoAccept:
         if autoDecline:
             return
 
-        if not clickPrompt(
+        if not ui.clickPrompt(
             "Node is busy, do you wish to terminate the current execution to perform the update? (Y/n)",
             type = bool,
             default = True,
             show_default = False
         ):
             return
 
-    node_module.stop(config.get("nodeId", node_module.fetchNodeId(config["nodeName"])))
+    node_module.stop(nodeConfig.id)
 
-    stdEcho("Updating node...")
-    node_module.start(dockerImage, config)
-    docker.removeDanglingImages(node_module.getRepoFromImageUrl(dockerImage), node_module.getTagFromImageUrl(dockerImage))
+    ui.stdEcho("Updating node...")
+    node_module.start(nodeConfig.image, nodeConfig)
 
+    docker.removeDanglingImages(
+        node_module.getRepoFromImageUrl(nodeConfig.image),
+        node_module.getTagFromImageUrl(nodeConfig.image)
+    )
     activateAutoUpdate()
 
 
 @click.command()
-@click.option("--verbose", is_flag = True, help = "Configure node settings manually.")
-def config(verbose: bool) -> None:
-    config = loadConfig()
-
+@click.option("--advanced", is_flag = True, help = "Configure node settings manually.")
+def config(advanced: bool) -> None:
     if node_module.isRunning():
-        if not clickPrompt(
+        if not ui.clickPrompt(
             "Node is already running. Do you wish to stop the Node? (Y/n)",
             type = bool,
             default = True,
             show_default = False
         ):
-            errorEcho("If you wish to reconfigure your node, use coretex node stop commands first.")
+            ui.errorEcho("If you wish to reconfigure your node, use coretex node stop commands first.")
             return
 
-        node_module.stop(config.get("nodeId", node_module.fetchNodeId(config["nodeName"])))
+        try:
+            nodeConfig = NodeConfiguration.load()
+            node_module.stop(nodeConfig.id)
+        except (ConfigurationNotFound, InvalidConfiguration):
+            node_module.stop()
 
-    if isNodeConfigured(config):
-        if not clickPrompt(
+    try:
+        nodeConfig = NodeConfiguration.load()
+        if not ui.clickPrompt(
             "Node configuration already exists. Would you like to update? (Y/n)",
             type = bool,
             default = True,
             show_default = False
         ):
             return
+    except (ConfigurationNotFound, InvalidConfiguration):
+        pass
 
-    node_module.configureNode(config, verbose)
-    saveConfig(config)
-    previewConfig(config)
+    nodeConfig = node_module.configureNode(advanced)
+    nodeConfig.save()
+    ui.previewNodeConfig(nodeConfig)
 
-    successEcho("Node successfully configured.")
+    ui.successEcho("Node successfully configured.")
     activateAutoUpdate()
 
 

coretex/cli/commands/project.py

@@ -19,10 +19,12 @@
 
 import click
 
-from ..modules import ui, project_utils, utils, user
+from ..modules import ui, project_utils
+from ..modules.user import initializeUserSession
+from ..modules.utils import onBeforeCommandExecute
 from ...entities import Project, ProjectVisibility
 from ...networking import RequestFailedError
-from ...configuration import loadConfig
+from ...configuration import UserConfiguration
 
 
 @click.command()
@@ -31,10 +33,11 @@
 @click.option("--description", "-d", type = str, help = "Project description")
 def create(name: Optional[str], projectType: Optional[int], description: Optional[str]) -> None:
     project = project_utils.createProject(name, projectType, description)
+    userConfig = UserConfiguration.load()
 
     selectNewProject = ui.clickPrompt("Do you want to select the new project as default? (Y/n)", type = bool, default = True)
     if selectNewProject:
-        project_utils.selectProject(project.id)
+        userConfig.selectProject(project.id)
         ui.successEcho(f"Project \"{project.name}\" successfully selected.")
 
 
@@ -43,8 +46,8 @@ def create(name: Optional[str], projectType: Optional[int], description: Optiona
 @click.option("--name", "-n", type = str, help = "New Project name")
 @click.option("--description", "-d", type = str, help = "New Project description")
 def edit(project: Optional[str], name: Optional[str], description: Optional[str]) -> None:
-    config = loadConfig()
-    defaultProjectId = config.get("projectId")
+    userConfiguration = UserConfiguration.load()
+    defaultProjectId = userConfiguration.projectId
     if defaultProjectId is None and project is None:
         ui.errorEcho(f"To use edit command you need to specifiy project name using \"--project\" or \"-p\" flag, or you can select default project using \"coretex project select\" command.")
         return
@@ -73,24 +76,25 @@ def edit(project: Optional[str], name: Optional[str], description: Optional[str]
 @click.argument("name", type = str)
 def select(name: str) -> None:
     project: Optional[Project] = None
+    userConfig = UserConfiguration.load()
 
     ui.progressEcho("Validating project...")
 
     try:
         project = Project.fetchOne(name = name)
         ui.successEcho(f"Project \"{name}\" selected successfully!")
-        project_utils.selectProject(project.id)
+        userConfig.selectProject(project.id)
     except ValueError:
         ui.errorEcho(f"Project \"{name}\" not found.")
         project = project_utils.promptProjectCreate("Do you want to create a project with that name?", name)
         if project is None:
             return
 
-        project_utils.selectProject(project.id)
+        userConfig.selectProject(project.id)
 
 
 @click.group()
-@utils.onBeforeCommandExecute(user.initializeUserSession)
+@onBeforeCommandExecute(initializeUserSession)
 def project() -> None:
     pass