centralcli 7.2.0__tar.gz → 7.2.3__tar.gz

{centralcli-7.2.0 → centralcli-7.2.3}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.1
 Name: centralcli
-Version: 7.2.0
+Version: 7.2.3
 Summary: A CLI for interacting with Aruba Central (Cloud Management Platform).  Facilitates bulk imports, exports, reporting.  A handy tool if you have devices managed by Aruba Central.
 Home-page: https://github.com/Pack3tL0ss/central-api-cli
 License: MIT

{centralcli-7.2.0 → centralcli-7.2.3}/centralcli/__init__.py

@@ -194,15 +194,16 @@ if "--capture-raw" in sys.argv:  # captures raw responses into a flat file for l
 central = CentralApi(config.account)
 Cache.set_config(config)
 cache = Cache(central)
-CacheDevice.set_db(cache.DevDB)
-CacheInvDevice.set_db(cache.InvDB)
-CacheGroup.set_db(cache.GroupDB)
-CacheSite.set_db(cache.SiteDB)
-CacheClient.set_db(cache.ClientDB, cache=cache)
-CacheLabel.set_db(cache.LabelDB)
-CachePortal.set_db(cache.PortalDB)
-CacheTemplate.set_db(cache.TemplateDB)
-CacheMpskNetwork.set_db(cache.MpskDB)
+if config.valid:
+    CacheDevice.set_db(cache.DevDB)
+    CacheInvDevice.set_db(cache.InvDB)
+    CacheGroup.set_db(cache.GroupDB)
+    CacheSite.set_db(cache.SiteDB)
+    CacheClient.set_db(cache.ClientDB, cache=cache)
+    CacheLabel.set_db(cache.LabelDB)
+    CachePortal.set_db(cache.PortalDB)
+    CacheTemplate.set_db(cache.TemplateDB)
+    CacheMpskNetwork.set_db(cache.MpskDB)
 cli = CLICommon(config.account, cache, central, raw_out=raw_out)
 
 # allow singular form and common synonyms for the defined show commands

{centralcli-7.2.0 → centralcli-7.2.3}/centralcli/cache.py

@@ -464,6 +464,10 @@ class CachePortal(CentralObject):
     def __rich__(self) -> str:
         return f'[bright_green]Portal Profile[/]:[bright_green]{self.name}[/]|[cyan]{self.id}[/]'
 
+    @property
+    def help_text(self):
+        return render.rich_capture(self.__rich__())
+
 
 class CacheTemplate(CentralObject):
     db: Table | None = None
@@ -560,6 +564,12 @@ class CacheClient(CentralObject):
     def __rich__(self) -> str:
         return f'[bright_green]Client[/]:[cyan]{self.name}[/]|({utils.color([self.type, self.ip, self.mac, self.connected_name],  "green_yellow", sep="|")}|s[green_yellow]{self.site})[/]'
 
+    @property
+    def help_text(self) -> str:
+        return render.rich_capture(
+            f"[bright_green]{self.name}[/]|[cyan]{self.mac}[/]|[bright_green]{self.ip}[/]|[cyan]{f's:{self.site}' if self.site else f'g:{self.group}'}[/]|[dark_olive_green2]{self.connected_name}[/]"
+        )
+
 
 class CacheMpskNetwork(CentralObject):
     db: Table | None = None
@@ -1349,9 +1359,9 @@ class Cache:
             match = [m for m in match if m.name not in args]
             for m in sorted(match, key=lambda i: i.name):
                 if m.name.startswith(incomplete):
-                    out += [tuple([m.name, m.id])]
+                    out += [tuple([m.name, m.help_text])]
                 elif m.id.startswith(incomplete):
-                    out += [tuple([m.id, m.name])]
+                    out += [tuple([m.id, m.help_text])]
                 else:
                     out += [tuple([m.name, m.help_text])]  # failsafe, shouldn't hit
 
@@ -1959,19 +1969,18 @@ class Cache:
             # remove clients that are already on the command line
             match = [m for m in match if m.name not in args]
             for c in sorted(match, key=lambda i: i.name):
-                if c.name.startswith(incomplete):
-                    out += c.help_text
+                if c.name.lower().startswith(incomplete.lower()):
+                    out += [(c.name, c.help_text)]
                 elif c.mac.strip(":.-").lower().startswith(incomplete.strip(":.-")):
-                    out += c.help_text
+                    out += [(c.mac, c.help_text)]
                 elif c.ip.startswith(incomplete):
-                    out += c.help_text
+                    out += [(c.ip, c.help_text)]
                 else:
                     # failsafe, shouldn't hit
-                    out += (c.help_text[0], f'{c.help_text[1]} FailSafe Match')
+                    out += [(c.name, f'{c.help_text} FailSafe Match')]
 
-
-        for c in out:  # TODO completion behavior has changed.  This works-around issue bash doesn't complete past 00: and zsh treats each octet as a dev name when : is used.
-            yield c[0].replace(":", "-"), c[1]
+        for c in out:
+            yield c[0].replace(":", "-"), c[1]  # TODO completion behavior has changed.  This works-around issue bash doesn't complete past 00: and zsh treats each octet as a dev name when : is used.
 
     def event_log_completion(
         self,
@@ -2324,14 +2333,14 @@ class Cache:
             bool: _description_
         """
         _start_time = time.perf_counter()
-        if data:
+        if data is not None:
             with econsole.status(f":arrows_clockwise:  Updating [dark_olive_green2]{db.name}[/] Cache: [cyan]{len(data)}[/] records."):
                 if truncate:
                     db.truncate()
                 db_res = db.insert_multiple([dict(d) for d in data])  # Converts any TinyDB.Documents to dict as that has unexpected results.
                 return self.verify_db_action(db, expected=len(data), response=db_res, elapsed=round(time.perf_counter() - _start_time, 2))
 
-        doc_ids = utils.listify(doc_ids)
+        doc_ids = utils.listify(doc_ids) or []
         with econsole.status(f":wastebasket:  [red]Removing[/]] [cyan]{len(doc_ids)}[/] records from [dark_olive_green2]{db.name}[/] cache."):
             db_res = db.remove(doc_ids=doc_ids)
             return self.verify_db_action(db, expected=len(doc_ids), response=db_res, remove=True, elapsed=round(time.perf_counter() - _start_time, 2))

{centralcli-7.2.0 → centralcli-7.2.3}/centralcli/cliupdate.py

@@ -3,29 +3,34 @@
 
 from pathlib import Path
 import sys
-from typing import List, Union
+from typing import TYPE_CHECKING, List, Union
 # from typing import List
 import typer
 from rich import print
 from rich.console import Console
+from rich.text import Text
 from jinja2 import FileSystemLoader, Environment
 import yaml
 
 # Detect if called from pypi installed package or via cloned github repo (development)
 try:
-    from centralcli import utils, cli, caas, cleaner, BatchRequest, log
+    from centralcli import utils, cli, cleaner, BatchRequest, log
 except (ImportError, ModuleNotFoundError) as e:
     pkg_dir = Path(__file__).absolute().parent
     if pkg_dir.name == "centralcli":
         sys.path.insert(0, str(pkg_dir.parent))
-        from centralcli import utils, cli, caas, cleaner, BatchRequest, log
+        from centralcli import utils, cli, cleaner, BatchRequest, log
     else:
         print(pkg_dir.parts)
         raise e
 
-from centralcli.constants import IdenMetaVars, DevTypes, GatewayRole, state_abbrev_to_pretty
-from centralcli import CentralObject
+from .constants import IdenMetaVars, DevTypes, GatewayRole, state_abbrev_to_pretty
+from . import render
 from .cache import CacheTemplate
+from .caas import CaasAPI
+
+if TYPE_CHECKING:
+    from .cache import CacheDevice, CacheGroup
 
 
 SPIN_TXT_AUTH = "Establishing Session with Aruba Central API Gateway..."
@@ -277,7 +282,6 @@ def generate_template(template_file: Union[Path, str], var_file: Union[Path, str
 @app.command("config")
 def config_(
     group_dev: str = cli.arguments.group_dev,
-    # TODO collect multi-line input as option to paste in config
     cli_file: Path = typer.Argument(..., help="File containing desired config/template in CLI format.", exists=True, autocompletion=lambda incomplete: tuple(), show_default=False,),
     var_file: Path = typer.Argument(None, help="File containing variables for j2 config template.", exists=True, autocompletion=lambda incomplete: tuple(), show_default=False,),
     do_gw: bool = typer.Option(None, "--gw", help="Update group level config for gateways."),
@@ -289,18 +293,12 @@ def config_(
 ) -> None:
     """Update group or device level config (ap or gw).
     """
-    group_dev: CentralObject = cli.cache.get_identifier(group_dev, qry_funcs=["group", "dev"], device_type=["ap", "gw"])
+    group_dev: CacheDevice | CacheGroup = cli.cache.get_identifier(group_dev, qry_funcs=["group", "dev"], device_type=["ap", "gw"])
     config_out = utils.generate_template(cli_file, var_file=var_file)
     cli_cmds = utils.validate_config(config_out)
 
-    # TODO render.py module with helper function to return styled rule/line
-    console = Console(record=True, emoji=False)
-    console.begin_capture()
-    console.rule("Configuration to be sent")
-    console.print("\n".join([f"[green]{line}[/green]" for line in cli_cmds]))
-    console.rule()
-    console.print(f"\nUpdating {'group' if group_dev.is_group else group_dev.generic_type.upper()} [cyan]{group_dev.name}[/]")
-    _msg = console.end_capture()
+    output = render.output(cli_cmds)
+    output = Text.from_ansi(output.tty)
 
     if group_dev.is_group:
         device = None
@@ -313,7 +311,7 @@ def config_(
         if device and device.generic_type != "gw":
             cli.exit(f"Invalid input: --gw option conflicts with {device.name} which is an {device.generic_type}")
         use_caas = True
-        caasapi = caas.CaasAPI(central=cli.central)  # XXX Burried import
+        caasapi = CaasAPI(central=cli.central)
         node_iden = group_dev.name if group_dev.is_group else group_dev.mac
     elif do_ap or (device and device.generic_type == "ap"):
         if device and device.generic_type != "ap":
@@ -321,7 +319,10 @@ def config_(
         use_caas = False
         node_iden = group_dev.name if group_dev.is_group else group_dev.serial
 
-    typer.echo(_msg)
+    cli.console.rule("Configuration to be sent")
+    cli.console.print(output, emoji=False)
+    cli.console.rule()
+    cli.console.print(f"\nUpdating {'group' if group_dev.is_group else group_dev.generic_type.upper()} [cyan]{group_dev.name}[/]")
     if cli.confirm(yes):
         if use_caas:
             resp = cli.central.request(caasapi.send_commands, node_iden, cli_cmds)
@@ -329,8 +330,7 @@ def config_(
         else:
             # FIXME this is OK for group level ap config , for AP this method is not valid
             if group_dev.is_dev:
-                print("Not Implemented yet for AP device level updates")
-                raise typer.Exit(1)
+                cli.exit("Not Implemented yet for AP device level updates")
             resp = cli.central.request(cli.central.replace_ap_config, node_iden, cli_cmds)
             cli.display_results(resp, tablefmt="action")
 

{centralcli-7.2.0 → centralcli-7.2.3}/pyproject.toml

@@ -1,6 +1,6 @@
 [tool.poetry]
 name = "centralcli"
-version = "7.2.0"
+version = "7.2.3"
 description = "A CLI for interacting with Aruba Central (Cloud Management Platform).  Facilitates bulk imports, exports, reporting.  A handy tool if you have devices managed by Aruba Central."
 license = "MIT"
 authors = ["Wade Wells (Pack3tL0ss) <wade@consolepi.org>"]