Switch to click for argument parsing and output (#162)

Author: borrrden

.github/workflows/python_verify.yml

@@ -3,15 +3,19 @@ on:
   push:
     branches:
       - main
-    paths: &paths
-      - 'client/smoke-tests/**'
+    paths:
+      - 'client/smoke_tests/**'
       - 'client/src/**'
       - 'environment/**'
       - 'tests/**'
   pull_request:
     branches:
       - "**"
-    paths: *paths
+    paths:
+      - 'client/smoke_tests/**'
+      - 'client/src/**'
+      - 'environment/**'
+      - 'tests/**'
 
 jobs:
   mypy:

.github/workflows/verify_python.sh

@@ -2,9 +2,10 @@
 
 python3 -m venv venv
 source ./venv/bin/activate
+pip install --upgrade pip
 pip install mypy
 pip install pytest pytest-asyncio
-pip install types-requests types-Deprecated types-tqdm types-paramiko types-netifaces types-psutil types-termcolor
+pip install types-requests types-Deprecated types-tqdm types-paramiko types-netifaces types-psutil click
 pip install ./client
 echo "Checking tests files..."
 python -m mypy tests --exclude=venv

environment/aws/common/docker.py

@@ -3,6 +3,8 @@
 from pathlib import Path
 from typing import List, Optional
 
+import click
+
 from environment.aws.common.output import header
 
 
@@ -130,14 +132,14 @@ def start_container(
 
     if container_check.stdout.strip() != "":
         if container_check.stdout.startswith("Up"):
-            print(f"{name} already running, returning...")
+            click.echo(f"{name} already running, returning...")
             return
 
-        print(f"Restarting existing {name} container...")
+        click.echo(f"Restarting existing {name} container...")
         subprocess.run(["docker", "start", name], check=False, env=env)
         return
 
-    print(f"Starting new {name} container...")
+    click.echo(f"Starting new {name} container...")
     args = [
         "docker",
         "run",

environment/aws/common/io.py

@@ -21,10 +21,13 @@
 import zipfile
 from pathlib import Path
 
+import click
 import paramiko
 from requests import Response
 from tqdm import tqdm
 
+LIGHT_GRAY = (128, 128, 128)
+
 
 def download_progress_bar(response: Response, output_path: Path) -> None:
     """
@@ -83,14 +86,14 @@ def zip_directory(input: Path, output: Path) -> None:
     if not input.exists():
         raise RuntimeError(f"{input} does not exist...")
 
-    print("Zipping...")
+    click.echo("Zipping...")
     with zipfile.ZipFile(output, "w", zipfile.ZIP_DEFLATED) as zipf:
         for root, _, files in os.walk(input):
             for file in tqdm(files, desc="Zipping"):
                 file_path = Path(root) / file
                 zipf.write(file_path, file_path.relative_to(input))
 
-    print("Done")
+    click.echo("Done")
 
 
 def unzip_directory(input: Path, output: Path) -> None:
@@ -128,7 +131,7 @@ def unzip_directory(input: Path, output: Path) -> None:
                 if perm:
                     extracted_path.chmod(perm)
 
-    print("Done")
+    click.echo("Done")
 
 
 def tar_directory(input: Path, output: Path) -> None:
@@ -145,14 +148,14 @@ def tar_directory(input: Path, output: Path) -> None:
     if not input.exists():
         raise RuntimeError(f"{input} does not exist...")
 
-    print("Compressing")
+    click.echo("Compressing")
     with tarfile.open(output, "w:gz") as tar:
         for root, _, files in os.walk(input):
             for file in tqdm(files, desc="Archiving"):
                 file_path = Path(root) / file
                 tar.add(file_path, arcname=file_path.relative_to(input))
 
-    print("Done")
+    click.echo("Done")
 
 
 def untar_directory(input: Path, output: Path) -> None:
@@ -169,7 +172,7 @@ def untar_directory(input: Path, output: Path) -> None:
     if not input.exists():
         raise RuntimeError(f"{input} does not exist...")
 
-    print("Extracting")
+    click.echo("Extracting")
     with tarfile.open(input, "r:gz") as tar:
         for member in tqdm(tar.getmembers(), desc="Extracting"):
             tar.extract(member, path=output)
@@ -179,4 +182,4 @@ def untar_directory(input: Path, output: Path) -> None:
             if member.mode and not member.islnk() and not member.issym():
                 extracted_path.chmod(member.mode)
 
-    print("Done")
+    click.echo("Done")

environment/aws/common/output.py

@@ -6,7 +6,7 @@
         Print a green text header that makes the message very obvious
 """
 
-from termcolor import colored
+import click
 
 
 def header(text: str) -> None:
@@ -18,6 +18,7 @@ def header(text: str) -> None:
     Args:
         text (str): The text to print
     """
-    print()
-    print(colored(f"=== {text} ===", "green"))
-    print()
+
+    click.echo()
+    click.secho(f"=== {text} ===", fg="green")
+    click.echo()

environment/aws/lb_setup/setup_load_balancers.py

@@ -21,15 +21,15 @@
 from pathlib import Path
 from typing import List, Optional
 
+import click
 import paramiko
-from termcolor import colored
 
 from environment.aws.common.docker import (
     check_aws_key_checking,
     get_ec2_hostname,
     start_container,
 )
-from environment.aws.common.io import sftp_progress_bar
+from environment.aws.common.io import LIGHT_GRAY, sftp_progress_bar
 from environment.aws.common.output import header
 from environment.aws.topology_setup.setup_topology import TopologyConfig
 
@@ -56,15 +56,15 @@ def remote_exec(
 
     _, stdout, stderr = ssh.exec_command(command, get_pty=True)
     for line in iter(stdout.readline, ""):
-        print(colored(f"[{current_ssh}] {line}", "light_grey"), end="")
+        click.secho(f"[{current_ssh}] {line}", fg=LIGHT_GRAY, nl=False)  # type: ignore
 
     exit_status = stdout.channel.recv_exit_status()
     if fail_on_error and exit_status != 0:
-        print(stderr.read().decode())
+        click.secho(stderr.read().decode(), fg="red")
         raise Exception(f"Command '{command}' failed with exit status {exit_status}")
 
     header("Done!")
-    print()
+    click.echo()
 
 
 def create_nginx_config(upstreams: List[str]) -> None:

environment/aws/logslurp_setup/setup_logslurp.py

@@ -21,15 +21,15 @@
 from pathlib import Path
 from typing import Optional
 
+import click
 import paramiko
-from termcolor import colored
 
 from environment.aws.common.docker import (
     check_aws_key_checking,
     get_ec2_hostname,
     start_container,
 )
-from environment.aws.common.io import sftp_progress_bar
+from environment.aws.common.io import LIGHT_GRAY, sftp_progress_bar
 from environment.aws.common.output import header
 from environment.aws.topology_setup.setup_topology import TopologyConfig
 
@@ -56,15 +56,15 @@ def remote_exec(
 
     _, stdout, stderr = ssh.exec_command(command, get_pty=True)
     for line in iter(stdout.readline, ""):
-        print(colored(f"[{current_ssh}] {line}", "light_grey"), end="")
+        click.secho(f"[{current_ssh}] {line}", fg=LIGHT_GRAY, nl=False)  # type: ignore
 
     exit_status = stdout.channel.recv_exit_status()
     if fail_on_error and exit_status != 0:
-        print(stderr.read().decode())
+        click.secho(stderr.read().decode(), fg="red")
         raise Exception(f"Command '{command}' failed with exit status {exit_status}")
 
     header("Done!")
-    print()
+    click.echo()
 
 
 def main(topology: TopologyConfig, private_key: Optional[str] = None) -> None:

environment/aws/requirements.txt

@@ -2,6 +2,7 @@ bcrypt==4.2.1
 certifi==2024.12.14
 cffi==1.17.1
 charset-normalizer==3.4.1
+click==8.1.8
 colorama==0.4.6
 cryptography==44.0.0
 idna==3.10
@@ -12,6 +13,5 @@ pycparser==2.22
 PyNaCl==1.5.0
 requests==2.32.3
 tdqm==0.0.1
-termcolor==2.5.0
 tqdm==4.67.1
 urllib3==2.3.0

environment/aws/server_setup/setup_server.py

@@ -22,10 +22,10 @@
 from pathlib import Path
 from typing import Optional
 
+import click
 import paramiko
-from termcolor import colored
 
-from environment.aws.common.io import sftp_progress_bar
+from environment.aws.common.io import LIGHT_GRAY, sftp_progress_bar
 from environment.aws.common.output import header
 from environment.aws.topology_setup.setup_topology import TopologyConfig
 
@@ -52,15 +52,15 @@ def remote_exec(
 
     _, stdout, stderr = ssh.exec_command(command)
     for line in iter(stdout.readline, ""):
-        print(colored(f"[{current_ssh}] {line}", "light_grey"), end="")
+        click.secho(f"[{current_ssh}] {line}", fg=LIGHT_GRAY, nl=False)  # type: ignore
 
     exit_status = stdout.channel.recv_exit_status()
     if fail_on_error and exit_status != 0:
-        print(stderr.read().decode())
+        click.secho(stderr.read().decode(), fg="red")
         raise Exception(f"Command '{command}' failed with exit status {exit_status}")
 
     header("Done!")
-    print()
+    click.echo()
 
 
 def setup_node(

environment/aws/sgw_setup/setup_sgw.py

@@ -37,12 +37,12 @@
 from pathlib import Path
 from typing import Dict, Final, Optional, cast
 
+import click
 import paramiko
 import requests
-from termcolor import colored
 from tqdm import tqdm
 
-from environment.aws.common.io import sftp_progress_bar
+from environment.aws.common.io import LIGHT_GRAY, sftp_progress_bar
 from environment.aws.common.output import header
 from environment.aws.topology_setup.setup_topology import TopologyConfig
 
@@ -174,7 +174,10 @@ def download_sgw_package(download_info: SgwDownloadInfo) -> None:
                     size = f.write(chunk)
                     bar.update(size)
     else:
-        print(f"File {download_info.local_filename} already exists, skipping download.")
+        click.secho(
+            f"File {download_info.local_filename} already exists, skipping download.",
+            fg="yellow",
+        )
 
 
 def setup_config(server_hostname: str) -> None:
@@ -219,15 +222,15 @@ def remote_exec(
 
     _, stdout, stderr = ssh.exec_command(command, get_pty=True)
     for line in iter(stdout.readline, ""):
-        print(colored(f"[{current_ssh}] {line}", "light_grey"), end="")
+        click.secho(f"[{current_ssh}] {line}", fg=LIGHT_GRAY, nl=False)  # type: ignore
 
     exit_status = stdout.channel.recv_exit_status()
     if fail_on_error and exit_status != 0:
-        print(stderr.read().decode())
+        click.secho(stderr.read().decode(), fg="red")
         raise Exception(f"Command '{command}' failed with exit status {exit_status}")
 
     header("Done!")
-    print()
+    click.echo()
 
 
 def setup_server(
@@ -242,9 +245,9 @@ def setup_server(
         sgw_info (SgwDownloadInfo): The download information for Sync Gateway.
     """
     if sgw_info.is_release:
-        print(f"Setting up server {hostname} with SGW {sgw_info.version}")
+        click.echo(f"Setting up server {hostname} with SGW {sgw_info.version}")
     else:
-        print(
+        click.echo(
             f"Setting up server {hostname} with SGW {sgw_info.version}-{sgw_info.build_no}"
         )