Add adb config get command (#632)

* add config command 'get'

* error on unset variables by default

* formatting

* filter elements in get using the common element RE

* merge env key support from ls

* formatting

* name will be empty if using --from-json, move test.

* formatting

Author: drewaogle

aperturedb/Configuration.py

@@ -51,9 +51,12 @@ def __ssl_mode(self) -> str:
 
         return mode
 
+    def auth_mode(self) -> str:
+        return "token" if self.token is not None else "password"
+
     def __repr__(self) -> str:
         mode = "REST" if self.use_rest else "TCP"
-        auth_mode = "token" if self.token is not None else "password"
+        auth_mode = self.auth_mode()
         return f"[{self.host}:{self.port} as {self.username} using {mode} with SSL={self.__ssl_mode()} auth={auth_mode}]"
 
     def deflate(self) -> list:

aperturedb/cli/configure.py

@@ -10,6 +10,13 @@
 import aperturedb.cli.keys as keys
 from aperturedb.Configuration import Configuration
 from aperturedb.CommonLibrary import _create_configuration_from_json, __create_connector
+import re
+
+
+# alnum for first character, then anum with - or _ for rest. Max Length 64
+CONFIG_NAME_RE = re.compile(
+    r'^([a-zA-Z0-9]([a-zA-Z0-9-_]){0,63})'
+)
 
 
 class ObjEncoder(json.JSONEncoder):
@@ -85,11 +92,7 @@ def get_configurations(file: str):
     return configs, active
 
 
-@app.command()
-def ls(log_to_console: bool = True):
-    """
-    List the configurations with their details.
-    """
+def get_all_configs():
     all_configs = {}
     for as_global in [True, False]:
         config_path = _config_file_path(as_global)
@@ -114,6 +117,24 @@ def ls(log_to_console: bool = True):
                 all_configs["environment"] = {}
             all_configs["environment"][env_key] = config
             all_configs["active"] = f"env:{env_key}"
+    return all_configs
+
+
+def get_active_config(all_configs):
+    active = all_configs["active"]
+    if active.startswith("env:"):
+        return all_configs["environment"][active[4:]]
+    else:
+        return all_configs["local"][active] if "locan" in all_configs and active in all_configs["local"] \
+            else all_configs["global"][active]
+
+
+@app.command()
+def ls(log_to_console: bool = True):
+    """
+    List the configurations with their details.
+    """
+    all_configs = get_all_configs()
 
     if "global" in all_configs or "local" in all_configs:
         if "global" in all_configs and len(all_configs["global"]) == 0 \
@@ -214,6 +235,10 @@ def check_for_overwrite(name):
         name = name if name is not None else gen_config.name
 
     else:
+        if not CONFIG_NAME_RE.match(name):
+            console.log(
+                f"Configuration name {name} must be alphanumerical with dashes of 1-64 characters in length", style="bold yellow")
+            raise typer.Exit(code=2)
         if interactive:
             if name is None:
                 name = typer.prompt(
@@ -395,3 +420,75 @@ def get_key(name: Annotated[str, typer.Argument(
             check_configured(as_global=True, show_error=True)
 
     print(f"{user_key}")
+
+
+@app.command()
+def get(
+        tag: Annotated[str, typer.Argument(help="Tag of information to get")],
+        ignore_unset: Annotated[bool, typer.Option(help="ignore unsetl")] = False):
+    """
+    Retrieve detail of a config.
+    """
+
+    all_configs = get_all_configs()
+    used_config = None
+    remaining = ""
+    if tag[0] == ".":
+        used_config = get_active_config(all_configs)
+        remaining = tag
+    else:
+        # match config name to config element seperator: .
+        m = re.match(f"{CONFIG_NAME_RE.pattern}\\.", tag)
+        if len(m.groups()) < 1 or len(m.groups(0)) == 0:
+            console.log(f"Configuration name {tag} is invalid")
+            raise typer.Exit(code=2)
+        else:
+            name = m.group(1)
+            has_local = "local" in all_configs
+            if (has_local and not name in all_configs["local"]) or \
+                    not name in all_configs["global"]:
+                console.log(f"No Configuration {name}")
+                raise typer.Exit(code=2)
+            else:
+                used_config = all_configs["local"][name] \
+                    if has_local and name in all_configs["local"] \
+                    else all_configs["global"][name]
+                remaining = tag[len(name):]
+
+    if remaining[0] != ".":
+        console.log(
+            f"Cannot create configuration data to retrieve from {remaining}")
+        raise typer.Exit(code=2)
+    else:
+        # match config name to end of string
+        m = re.match(f"{CONFIG_NAME_RE.pattern}$", remaining[1:])
+        if len(m.groups()) < 1 or len(m.groups(0)) == 0:
+            console.log(f"Configuration item {remaining[1:]} is invalid")
+            raise typer.Exit(code=2)
+        else:
+            config_item = m.group(0)
+            print_ok = True
+
+            # check if attribut exists or is valid to print.
+            if not config_item in dir(used_config):
+                print_ok = False
+            else:
+                attrib = getattr(used_config, config_item)
+                # we allow only retreiving string, int or bool values from the
+                # Configuration.
+                allowed_types = [str, int, bool, type(None)]
+                allowed_commands = ["auth_mode"]
+                if config_item in allowed_commands:
+                    attrib = attrib()
+                elif not any([isinstance(attrib, allowed_type) for allowed_type in allowed_types]):
+                    print_ok = False
+
+            if print_ok:
+                if attrib is None and not ignore_unset:
+                    console.log(f"Configuration Item {config_item} is unset")
+                    raise typer.Exit(code=2)
+                else:
+                    print(attrib)
+            else:
+                console.log(f"No Configuration Item {config_item}")
+                raise typer.Exit(code=2)