Merge pull request #45 from britive/progress-bar

Progress bar

Author: twratl

CHANGELOG.md

@@ -2,6 +2,21 @@
 
 All changes to the package starting with v0.3.1 will be logged here.
 
+## v0.9.0 [2023-01-06]
+#### What's New
+* `pybritive checkout` will now report progress of the action by default (if `stdout` is a tty). Can show more verbose output with `--verbose/-v`. Can silence the progress with the already available `--silent\-s` flag.
+#### Enhancements
+* None
+
+#### Bug Fixes
+* None
+
+#### Dependencies
+* `britive~=2.13.0` from `britive~=2.12.4` - checkout progress callback
+
+#### Other
+* None
+
 ## v0.8.0 [2023-01-05]
 #### What's New
 * Ability to store a GCP `gcloud` key file locally so `eval $(pybritive checkout "profile" -m gcloudauth)` will automatically authenticate the user with the gcloud CLI.

requirements.txt

@@ -1,4 +1,4 @@
-britive~=2.12.4
+britive~=2.13.0
 certifi==2022.6.15
 charset-normalizer==2.1.0
 click==8.1.3

setup.cfg

@@ -1,6 +1,6 @@
 [metadata]
 name = pybritive
-version = 0.8.0
+version = 0.9.0
 author = Britive Inc.
 author_email = support@britive.com
 description = A pure Python CLI for Britive
@@ -26,7 +26,7 @@ install_requires =
     toml
     cryptography
     python-dateutil
-    britive>=2.12.4
+    britive>=2.13.0
 
 [options.packages.find]
 where = src

src/pybritive/britive_cli.py

@@ -1,5 +1,4 @@
 import io
-import socket
 from britive.britive import Britive
 from .helpers.config import ConfigManager
 from .helpers.credentials import FileCredentialManager, EncryptedFileCredentialManager
@@ -14,6 +13,7 @@
 from pathlib import Path
 from datetime import datetime
 import os
+import sys
 
 
 default_table_format = 'fancy_grid'
@@ -35,6 +35,8 @@ def __init__(self, tenant_name: str = None, token: str = None, silent: bool = Fa
         self.passphrase = passphrase
         self.federation_provider = federation_provider
         self.credential_manager = None
+        self.verbose_checkout = False
+        self.checkout_progress_previous_message = None
 
     def set_output_format(self, output_format: str):
         self.output_format = self.config.get_output_format(output_format)
@@ -109,6 +111,24 @@ def debug(self, data: object, ignore_silent: bool = False):
         if debug_enabled:
             self.print(data=data, ignore_silent=ignore_silent)
 
+    # will be passed to the britive checkout_by_name progress_func parameter when appropriate
+    def checkout_callback_printer(self, message: str):
+        if self.silent or not sys.stdout.isatty():
+            return
+        if message == 'complete':
+            click.echo('')
+            return
+
+        if self.verbose_checkout:
+            if self.checkout_progress_previous_message != message:
+                newline = '\n' if self.checkout_progress_previous_message else ''
+                self.checkout_progress_previous_message = message
+                click.echo(f'{newline}{message} ', nl=False)
+            else:
+                click.echo('.', nl=False)
+        else:
+            click.echo('.', nl=False)
+
     # will take a list of dicts and print to the screen based on the format specified in the config file
     # dict can only be 1 level deep (no nesting) - caller needs to massage the data accordingly
     def print(self, data: object, ignore_silent: bool = False):
@@ -317,7 +337,8 @@ def _checkout(self, profile_name, env_name, app_name, programmatic, blocktime, m
                 include_credentials=True,
                 wait_time=blocktime,
                 max_wait_time=maxpolltime,
-                justification=justification
+                justification=justification,
+                progress_func=self.checkout_callback_printer  # callback will handle silent, isatty, etc.
             )
         except exceptions.ApprovalRequiredButNoJustificationProvided:
             raise click.ClickException('approval required and no justification provided.')
@@ -349,11 +370,12 @@ def _split_profile_into_parts(self, profile):
         return parts_dict
 
     def checkout(self, alias, blocktime, console, justification, mode, maxpolltime, profile, passphrase,
-                 force_renew, aws_credentials_file, gcloud_key_file):
+                 force_renew, aws_credentials_file, gcloud_key_file, verbose):
         credentials = None
         app_type = None
         credential_process_creds_found = False
         response = None
+        self.verbose_checkout = verbose
 
         if mode == 'awscredentialprocess':
             self.silent = True  # the aws credential process CANNOT output anything other than the expected JSON

src/pybritive/commands/checkout.py

@@ -7,10 +7,10 @@
 @click.command()
 @build_britive
 @britive_options(names='alias,blocktime,console,justification,mode,maxpolltime,silent,force_renew,aws_credentials_file,'
-                       'gcloud_key_file,tenant,token,passphrase,federation_provider')
+                       'gcloud_key_file,verbose,tenant,token,passphrase,federation_provider')
 @click.argument('profile', shell_complete=profile_completer)
 def checkout(ctx, alias, blocktime, console, justification, mode, maxpolltime, silent, force_renew,
-             aws_credentials_file, gcloud_key_file, tenant, token, passphrase, federation_provider, profile):
+             aws_credentials_file, gcloud_key_file,verbose, tenant, token, passphrase, federation_provider, profile):
     """Checkout a profile.
 
     This command takes 1 required argument `PROFILE`. This should be a string representation of the profile
@@ -29,5 +29,6 @@ def checkout(ctx, alias, blocktime, console, justification, mode, maxpolltime, s
         passphrase=passphrase,
         force_renew=force_renew,
         aws_credentials_file=aws_credentials_file,
-        gcloud_key_file=gcloud_key_file
+        gcloud_key_file=gcloud_key_file,
+        verbose=verbose
     )

src/pybritive/options/britive_options.py

@@ -21,6 +21,7 @@
 from ..options.aws_credentials_file import option as aws_credentials_file
 from ..options.federation_provider import option as federation_provider
 from ..options.gcloud_key_file import option as gcloud_key_file
+from ..options.verbose import option as verbose
 
 options_map = {
     'tenant': tenant,
@@ -45,7 +46,8 @@
     'force_renew': force_renew,
     'aws_credentials_file': aws_credentials_file,
     'federation_provider': federation_provider,
-    'gcloud_key_file': gcloud_key_file
+    'gcloud_key_file': gcloud_key_file,
+    'verbose': verbose
 }
 
 

src/pybritive/options/verbose.py

@@ -0,0 +1,11 @@
+import click
+
+
+option = click.option(
+    '--verbose', '-v',
+    default=False,
+    is_flag=True,
+    show_default=True,
+    help='Enable verbose checkout mode.'
+)
+