ssm-cli 0.1.3.dev1__tar.gz → 0.1.3.dev2__tar.gz

{ssm_cli-0.1.3.dev1/ssm_cli.egg-info → ssm_cli-0.1.3.dev2}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: ssm-cli
-Version: 0.1.3.dev1
+Version: 0.1.3.dev2
 Summary: CLI tool to help with SSM functionality, aimed at adminstrators
 Author-email: Simon Fletcher <simon.fletcher@lexisnexisrisk.com>
 License: MIT License

{ssm_cli-0.1.3.dev1 → ssm_cli-0.1.3.dev2}/ssm_cli/cli.py

@@ -5,15 +5,10 @@ from rich_argparse import ArgumentDefaultsRichHelpFormatter
 import confclasses
 from ssm_cli.config import CONFIG
 from ssm_cli.xdg import get_log_file, get_conf_file
-from ssm_cli.commands import COMMANDS
+from ssm_cli.commands import COMMANDS, BaseCommand
 from ssm_cli.cli_args import CliArgumentParser, ARGS
 from ssm_cli.aws import AWSAuthError
-from rich.traceback import install
-from rich.console import Console
-
-# Setup rich
-install()
-console = Console()
+from ssm_cli.console import console
 
 # Setup logging
 import logging
@@ -61,7 +56,7 @@ def cli(argv: list = None) -> int:
     
     # Setup is a special case, we cannot load config if we dont have any.
     if ARGS.command == "setup":
-        COMMANDS['setup'].run(ARGS)
+        run_command()
         return 0
     
     try:
@@ -90,3 +85,17 @@ def cli(argv: list = None) -> int:
         return 2
     
     return 0
+
+def run_command():
+    """
+    Run a command, better exceptions and logging
+    """
+    try:
+        COMMANDS[ARGS.command].run()
+    except Exception as e:
+        logger.error(f"Unhandled exception in {ARGS.command}")
+        console.print(f"Unhandled exception, check [link=file://{get_log_file()}]{get_log_file()}[/link] for more information", style="red")
+        console.print(f"Error: {e}", style="red bold")
+        logger.exception(e, stack_info=True, stacklevel=20)
+        return 1
+    return 0

{ssm_cli-0.1.3.dev1 → ssm_cli-0.1.3.dev2}/ssm_cli/cli_args.py

@@ -2,6 +2,7 @@ import argparse
 import sys
 from confclasses import fields, is_confclass
 from ssm_cli.config import CONFIG
+import os
 
 # The long term aim is to move this module into the config module and "bind" config to cli arguments
 # This will need a rethink of where some of the arguments/config come from because right now they are in the commands modules
@@ -104,8 +105,10 @@ class VersionAction(argparse._VersionAction):
             print("session-manager-plugin not found", file=sys.stderr)
             parser.exit(1)
         
+        pkg_dir = os.path.join(os.path.dirname(__file__), "..")
+        pkg_dir = os.path.abspath(pkg_dir)
+        print(f"ssm-cli {version('ssm-cli')} from {pkg_dir}")
         v = sys.version_info
-        print(f"ssm-cli {version('ssm-cli')}")
         print(f"python {v.major}.{v.minor}.{v.micro}")
         print(f"session-manager-plugin {results.stdout.strip()}")
-        parser.exit()
+        parser.exit()

{ssm_cli-0.1.3.dev1 → ssm_cli-0.1.3.dev2}/ssm_cli/commands/base.py

@@ -10,6 +10,7 @@ class BaseCommand(ABC):
     @abstractmethod
     def add_arguments(parser: argparse.ArgumentParser):
         pass
+    
     @abstractmethod
-    def run(args: list, session: boto3.Session):
+    def run(args: list):
         pass

{ssm_cli-0.1.3.dev1 → ssm_cli-0.1.3.dev2}/ssm_cli/commands/list.py

@@ -2,10 +2,9 @@ from ssm_cli.instances import Instances
 from ssm_cli.commands.base import BaseCommand
 from ssm_cli.cli_args import ARGS
 import logging
-from rich.console import Console
 from rich.table import Table
+from ssm_cli.console import console
 
-console = Console()
 logger = logging.getLogger(__name__)
 
 class ListCommand(BaseCommand):

ssm_cli-0.1.3.dev2/ssm_cli/commands/setup.py

@@ -0,0 +1,85 @@
+import argparse
+import paramiko
+from ssm_cli.commands.base import BaseCommand
+from ssm_cli.xdg import get_conf_root, get_conf_file, get_ssh_hostkey, get_log_file
+from ssm_cli.cli_args import ARGS
+from ssm_cli.config import CONFIG
+from confclasses import from_dict, save
+from ssm_cli.console import console
+
+GREY = "grey50"
+
+import logging
+logger = logging.getLogger(__name__)
+
+class SetupCommand(BaseCommand):
+    HELP = "Setups up ssm-cli"
+    
+    def add_arguments(parser):
+        parser.add_argument("--replace-config", action=argparse.BooleanOptionalAction, default=False, help="if we should replace existing config file")
+        parser.add_argument("--replace-hostkey", action=argparse.BooleanOptionalAction, default=False, help="if we should replace existing hostkey file (bare careful with this option)")
+
+    def run():
+        # Create the root config directory
+        root = get_conf_root(False)
+        logger.debug(f"Checking if {root} exists")
+        if root.exists():
+            logger.debug(f"{root} exists")
+            if not root.is_dir():
+                logger.error(f"{root} already exists and is not a directory. Manual cleanup is likely needed.")
+                console.print(f"{root} already exists and is not a directory. Manual cleanup is likely needed.", style="red bold")
+                return
+            console.print(f"{root} - skipping (already exists)", style=GREY)
+        else:
+            root.mkdir(511, True, True)
+            console.print(f"{root} created", style="green")
+
+
+        # Create the config file
+        path = get_conf_file(False)
+        logger.debug(f"Checking if {path} exists")
+        create_config = False
+        if path.exists():
+            logger.debug(f"{path} exists")
+            if ARGS.replace_config:
+                logger.info(f"{path} exists and --replace-config was set, unlink {path}")
+                console.print(f"{path} removing", style="green")
+                path.unlink(True)
+                create_config = True
+        else:
+            logger.debug(f"{path} does not exist")
+            create_config = True
+
+        if create_config:
+            logger.info(f"{path} creating")
+            console.print(f"{path} creating", style="green")
+            from_dict(CONFIG, {})
+
+            CONFIG.group_tag_key = console.input(f"What tag to use to split up the instances \[{CONFIG.group_tag_key}]: ") or CONFIG.group_tag_key
+            console.print(f"Using '{CONFIG.group_tag_key}' as the group tag", style=GREY)
+            logger.info(f"Writing config to {path}")
+
+            with path.open("w+") as f:
+                save(CONFIG, f)
+                console.print(f"{path} created", style="green")
+
+        # Create the ssh hostkey
+        path = get_ssh_hostkey(False)
+        create_key = False
+        if path.exists():
+            logger.debug(f"{path} exists")
+            console.print(f"{path} skipping (already exists)")
+            if ARGS.replace_hostkey:
+                logger.info(f"{path} exists and --replace-hostkey was set, unlink {path}")
+                console.print(f"{path} removing", style="green")
+                path.unlink(True)
+                create_key = True
+        else:
+            logger.debug(f"{path} does not exist")
+            create_key = True
+        
+        if create_key:
+            logger.info(f"{path} creating")
+            host_key = paramiko.RSAKey.generate(1024)
+            host_key.write_private_key_file(path)
+            console.print(f"{path} created")

{ssm_cli-0.1.3.dev1 → ssm_cli-0.1.3.dev2}/ssm_cli/commands/shell.py

@@ -1,13 +1,11 @@
 from ssm_cli.instances import Instances
 from ssm_cli.commands.base import BaseCommand
 from ssm_cli.cli_args import ARGS
+from ssm_cli import console
 
 import logging
 logger = logging.getLogger(__name__)
 
-from rich.console import Console
-
-console = Console()
 
 class ShellCommand(BaseCommand):
     HELP = "Connects to instances"

ssm_cli-0.1.3.dev2/ssm_cli/console.py

@@ -0,0 +1,2 @@
+from rich.console import Console
+console = Console()

{ssm_cli-0.1.3.dev1 → ssm_cli-0.1.3.dev2}/ssm_cli/selectors/tui/__init__.py

@@ -2,6 +2,7 @@ from rich.console import Console
 from rich.live import Live
 from rich.table import Table
 from rich.style import StyleType
+from ssm_cli.console import console
 
 import os
 if os.name == "nt":
@@ -9,8 +10,6 @@ if os.name == "nt":
 else:
     from ssm_cli.selectors.tui.posix import getch, UP, DOWN, CTRL_C, ENTER
 
-console = Console()
-
 class TableWithArrows(Table):
     def __init__(self, *args, **kwargs):
         super().__init__(*args, **kwargs)

{ssm_cli-0.1.3.dev1 → ssm_cli-0.1.3.dev2/ssm_cli.egg-info}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: ssm-cli
-Version: 0.1.3.dev1
+Version: 0.1.3.dev2
 Summary: CLI tool to help with SSM functionality, aimed at adminstrators
 Author-email: Simon Fletcher <simon.fletcher@lexisnexisrisk.com>
 License: MIT License

{ssm_cli-0.1.3.dev1 → ssm_cli-0.1.3.dev2}/ssm_cli.egg-info/SOURCES.txt

@@ -7,6 +7,7 @@ ssm_cli/aws.py
 ssm_cli/cli.py
 ssm_cli/cli_args.py
 ssm_cli/config.py
+ssm_cli/console.py
 ssm_cli/instances.py
 ssm_cli/xdg.py
 ssm_cli.egg-info/PKG-INFO
@@ -18,11 +19,8 @@ ssm_cli.egg-info/top_level.txt
 ssm_cli/commands/__init__.py
 ssm_cli/commands/base.py
 ssm_cli/commands/list.py
+ssm_cli/commands/setup.py
 ssm_cli/commands/shell.py
-ssm_cli/commands/setup/__init__.py
-ssm_cli/commands/setup/definition.py
-ssm_cli/commands/setup/actions/base.py
-ssm_cli/commands/setup/actions/ssh.py
 ssm_cli/commands/ssh_proxy/__init__.py
 ssm_cli/commands/ssh_proxy/channels.py
 ssm_cli/commands/ssh_proxy/forward.py

ssm_cli-0.1.3.dev1/ssm_cli/commands/setup/__init__.py

@@ -1,28 +0,0 @@
-import argparse
-from ssm_cli.commands.base import BaseCommand
-from ssm_cli.commands.setup.definition import SetupDefinitions
-from confclasses import load
-
-import logging
-logger = logging.getLogger(__name__)
-
-class SetupCommand(BaseCommand):
-    HELP = "Setups up ssm-cli"
-    
-    def add_arguments(parser):
-        parser.add_argument("--replace", action=argparse.BooleanOptionalAction, default=False, help="if we should replace existing")
-        parser.add_argument("--definitions", type=str, help="Path to the definitions file")
-
-    def run(args):
-        logger.info("running setup action")
-
-        definitions = SetupDefinitions()
-        if args.definitions:
-            with open(args.definitions) as f:
-                load(definitions, f)
-            logger.info(f"Loaded definitions from {args.definitions}")
-        else:
-            logger.info("Using default definitions")
-            load(definitions, "")
-
-        definitions.run()

ssm_cli-0.1.3.dev1/ssm_cli/commands/setup/actions/base.py

@@ -1,74 +0,0 @@
-from ssm_cli.commands.setup.definition import action
-from ssm_cli.xdg import get_conf_root, get_conf_file
-from ssm_cli.config import CONFIG
-from confclasses import from_dict, save, load
-import logging
-from rich.text import Text
-
-logger = logging.getLogger(__name__)
-
-@action
-class ConfDirAction:
-    action_name = "base.conf-dir"
-
-    def run(self):
-        root = get_conf_root(False)
-        yield Text(f"Checking for {root}", style="cyan")
-        if not root.exists():
-            yield Text(f"creating directory", style="green")
-            root.mkdir(511, True, True)
-        else:
-            if not root.is_dir():
-                yield Text(f"{root} already exists and is not a directory. Cleanup is likely needed.", style="red")
-                return False
-            yield Text(f"already exists", style="cyan")
-        
-        return True
-
-@action
-class ConfFileAction:
-    action_name = "base.conf-file"
-    action_depends = ["base.conf-dir"]
-
-    group_tag_key: str
-    replace: bool = False
-    
-    def pre(self):
-        path = get_conf_file(False)
-        if path.exists():
-            yield Text(f"Found existing config", style="cyan")
-            if not self.replace:
-                yield Text(f"Pulling in config from {path}", style="cyan")
-                with path.open('r') as file:
-                    load(CONFIG, file)
-            else:
-                yield Text(f"Replacing existing config, so we will use defaults instead", style="cyan")
-                from_dict(CONFIG, {})
-                self.apply_config()
-        else:
-            yield Text(f"No existing config found, so we will use defaults", style="cyan")
-            from_dict(CONFIG, {})
-            self.apply_config()
-
-        return True
-
-    def apply_config(self):
-        if self.group_tag_key:
-            CONFIG.group_tag_key = self.group_tag_key
-        
-    def run(self):
-        path = get_conf_file(False)
-        if path.exists() and not self.replace:
-            yield Text(f"{path} - skipping (already exists)", style="cyan")
-            return True
-
-        try:
-            with path.open("w+") as file:
-                save(CONFIG, file)
-                yield Text(f"{path} - created", style="cyan")
-            return True
-        except Exception as e:
-            logger.error(e)
-            path.unlink(True)
-            yield Text(f"{path} - failed", style="red")
-            return False

ssm_cli-0.1.3.dev1/ssm_cli/commands/setup/actions/ssh.py

@@ -1,21 +0,0 @@
-from ssm_cli.commands.setup.definition import action
-from ssm_cli.xdg import get_ssh_hostkey
-import paramiko
-from rich.text import Text
-
-
-@action
-class SshHostKeyGenAction:
-    action_name = "ssh.host-keygen"
-    action_depends = ["base.conf-dir"]
-
-    def run(self):
-        path = get_ssh_hostkey(False)
-        if path.exists():
-            yield Text(f"{path} - skipping (already exists)", style="cyan")
-        else:
-            host_key = paramiko.RSAKey.generate(1024)
-            host_key.write_private_key_file(path)
-            yield Text(f"{path} - created", style="cyan")
-
-        return True

ssm_cli-0.1.3.dev1/ssm_cli/commands/setup/definition.py

@@ -1,125 +0,0 @@
-from typing import List
-from confclasses import confclass, unused, from_dict
-import traceback
-import logging
-from confclasses.exceptions import ConfclassesMissingValueError
-from rich.console import Console, Group
-from rich.panel import Panel
-from rich.text import Text
-from rich.tree  import Tree
-from rich.prompt import Prompt
-from rich.live import Live
-
-console = Console()
-logger = logging.getLogger(__name__)
-
-# 2 sets of defaults in this file, inside each action and in the SetupDefinitions default values, as sometimes it makes sense to have different defaults
-# - The default in the action classes are for when the action is defined in a definitions file but no value is provided for that attribute
-# - The default in the SetupDefinitions is for when the definitions file is not provided
-
-# decorator to register the actions, saves having to do it manually. Lets also add confclasses here, saves space
-actions = {}
-modules = set()
-def action(cls=None):
-    def wrap(cls):
-        cls = confclass(cls)
-        actions[cls.action_name] = cls
-        modules.add(cls.__module__)
-        return cls
-    return wrap(cls) if cls else wrap
-
-@confclass
-class SetupDefinition:
-    action: str
-
-@confclass
-class SetupDefinitions:
-    definitions: List[SetupDefinition] = [
-        {"action": "base.conf-dir"},
-        {"action": "base.conf-file", "merge": True},
-        {"action": "ssh.host-keygen"},
-    ]
-
-    def __post_init__(self):
-        self.execution_plan = []
-
-    def get_action_cls(self, name: str):
-        module = name.split(".")[0]
-        if module not in modules:
-            __import__(f"{__package__}.actions.{module}", fromlist=[module])
-            modules.add(module)
-        
-        return actions[name]
-
-    def add_definition_to_plan(self, name: str, tree: Tree, indent=1):
-        if name in self.execution_plan:
-            return
-
-        action_cls = self.get_action_cls(name)
-
-        for dep in getattr(action_cls, "action_depends", []):
-            self.add_definition_to_plan(dep, tree=tree.add(f"{dep}"), indent=indent+1)
-
-        self.execution_plan.append(name)
-
-    def make_action(self, name: str, args: dict):
-        try:
-            action = self.get_action_cls(name)()
-            from_dict(action, args)
-            return action
-        except ConfclassesMissingValueError as e:
-            if len(e.missing) > 2:
-                raise Exception(f"Nested missing values are not supported") from e
-            missing_key = e.missing[1]
-            value = Prompt.ask(f"[yellow]{name} requires user input for '{missing_key}'[/yellow]")
-            args[missing_key] = value
-            return self.make_action(name, args)
-
-    def panel_wrapper(self, title: str, func: callable):
-        log = []
-        panel = Panel(Text("Pending..."), title=title, style="cyan")
-        with Live(panel, console=console, refresh_per_second=4) as live:
-            gen = func()
-            try:
-                while True:
-                    log.append(next(gen))
-                    panel.renderable = Group(*log)
-                    live.update(panel)
-            except StopIteration as e:
-                success = e.value  # <- final return value
-                panel.title += "Success" if success else "Failed"
-                panel.style = "bold green" if success else "bold red"
-                live.update(panel)
-                return success
-
-    def run(self):
-        action_args = {}
-        dependency = Tree("Setup Actions", style="cyan")
-        panel = Panel(dependency, title="Building Dependency Tree for Setup")
-        for definition in self.definitions:
-            item = dependency.add(f"{definition.action}")
-            self.add_definition_to_plan(definition.action, tree=item)
-            action_args[definition.action] = unused(definition)
-        console.print(panel)
-
-        execution_plan = []
-        text = Text()
-        panel = Panel(text, title="Execution Order")
-        for idx, action_name in enumerate(self.execution_plan):
-            text.append(f"\n[{idx}] {action_name}", style="cyan")
-            action = self.make_action(action_name, action_args.get(action_name, {}))
-            execution_plan.append(action)
-            if hasattr(action, "pre"):
-                if not self.panel_wrapper(
-                    title=f"Pre {action.action_name}",
-                    func=action.pre
-                ):
-                    break
-        console.print(panel)
-
-        for action in execution_plan:
-            if not self.panel_wrapper(
-                title=action.action_name,
-                func=action.run
-            ):
-                break