Merge pull request #19 from britive/develop

Develop

Author: twratl

docs/index.md

@@ -14,16 +14,13 @@ PyBritive is intended to be used as a CLI application for communicating with the
 
 ## Installation
 
-`pybritive` will be installed via Python `pip`. The package is not available in PyPi at this time, so it will be 
-installed via the published tar balls in the GitHub repo. Determine the most recent version that has been published
-and add the version below.
+`pybritive` will be installed via Python `pip`. 
 
 ~~~bash
-version=x.y.z
-pip install https://github.com/britive/python-cli/releases/download/v$version/pybritive-$version.tar.gz
+pip install pybritive
 ~~~
 
-Or you can always pull the latest version using one of the following commands
+Or you can always pull the latest version directly from Github using one of the following commands.
 
 ~~~
 pip install $(curl -s https://api.github.com/repos/britive/python-cli/releases/latest | jq -r '.assets[] | select(.content_type == "application/x-gzip") | .browser_download_url')

requirements.txt

@@ -1,4 +1,4 @@
-britive~=2.7.1
+britive~=2.8.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.2.2
+version = 0.3.0
 author = Britive Inc.
 author_email = support@britive.com
 description = A pure Python CLI for Britive

src/pybritive/britive_cli.py

@@ -153,10 +153,10 @@ def list_profiles(self, checked_out: bool = False):
         self.login()
         self._set_available_profiles()
         data = []
-        checked_out = [p['papId'] for p in self.b.my_access.list_checked_out_profiles()] if checked_out else []
+        checked_out_profiles = [p['papId'] for p in self.b.my_access.list_checked_out_profiles()] if checked_out else []
 
         for profile in self.available_profiles:
-            if not checked_out or profile['profileId'] in checked_out:
+            if not checked_out or profile['profile_id'] in checked_out_profiles:
                 row = {
                     'Application': profile['app_name'],
                     'Environment': profile['env_name'],
@@ -275,18 +275,12 @@ def __get_cloud_credential_printer(self, app_type, console, mode, profile, silen
 
     def checkin(self, profile):
         self.login()
-        profile = self.config.profile_aliases.get(profile, profile)
-        parts = profile.split('/')
-        if len(parts) != 3:
-            raise click.ClickException('Provided profile string does not have the required 3 parts.')
-        app_name = parts[0]
-        env_name = parts[1]
-        profile_name = parts[2]
+        parts = self._split_profile_into_parts(profile)
 
         self.b.my_access.checkin_by_name(
-            profile_name=profile_name,
-            environment_name=env_name,
-            application_name=app_name
+            profile_name=parts['profile'],
+            environment_name=parts['env'],
+            application_name=parts['app']
         )
 
     def _checkout(self, profile_name, env_name, app_name, programmatic, blocktime, maxpolltime, justification):
@@ -311,6 +305,19 @@ def _checkout(self, profile_name, env_name, app_name, programmatic, blocktime, m
     def _should_check_force_renew(app, force_renew, console):
         return app in ['AWS', 'AWS Standalone'] and force_renew and not console
 
+
+    def _split_profile_into_parts(self, profile):
+        profile_real = self.config.profile_aliases.get(profile, profile)
+        parts = profile_real.split('/')
+        if len(parts) != 3:
+            raise click.ClickException('Provided profile string does not have the required 3 parts.')
+        parts_dict = {
+            'app': parts[0],
+            'env': parts[1],
+            'profile': parts[2]
+        }
+        return parts_dict
+
     def checkout(self, alias, blocktime, console, justification, mode, maxpolltime, profile, passphrase,
                  force_renew, aws_credentials_file):
         credentials = None
@@ -335,16 +342,13 @@ def checkout(self, alias, blocktime, console, justification, mode, maxpolltime,
                 else:
                     credential_process_creds_found = True
 
-        profile_real = self.config.profile_aliases.get(profile, profile)
-        parts = profile_real.split('/')
-        if len(parts) != 3:
-            raise click.ClickException('Provided profile string does not have the required 3 parts.')
+        parts = self._split_profile_into_parts(profile)
 
         # create this params once so we can use it multiple places
         params = {
-            'profile_name': parts[2],
-            'env_name': parts[1],
-            'app_name': parts[0],
+            'profile_name': parts['profile'],
+            'env_name': parts['env'],
+            'app_name': parts['app'],
             'programmatic': False if console else True,
             'blocktime': blocktime,
             'maxpolltime': maxpolltime,
@@ -504,6 +508,28 @@ def cache_clear():
     def configure_update(self, section, field, value):
         self.config.update(section=section, field=field, value=value)
 
+    def request_submit(self, profile, justification):
+        self.login()
+        parts = self._split_profile_into_parts(profile)
+
+        self.b.my_access.request_approval_by_name(
+            profile_name=parts['profile'],
+            environment_name=parts['env'],
+            application_name=parts['app'],
+            block_until_disposition=False,
+            justification=justification
+        )
+
+    def request_withdraw(self, profile):
+        self.login()
+        parts = self._split_profile_into_parts(profile)
+
+        self.b.my_access.withdraw_approval_request_by_name(
+            profile_name=parts['profile'],
+            environment_name=parts['env'],
+            application_name=parts['app']
+        )
+
 
 
 

src/pybritive/cli_interface.py

@@ -9,6 +9,7 @@
 from .commands.checkin import checkin as command_checkin
 from .commands.secret import secret as group_secret
 from .commands.cache import cache as group_cache
+from .commands.request import request as group_request
 import sys
 
 # sys.tracebacklimit = 0
@@ -39,6 +40,7 @@ def cli(version):
 cli.add_command(command_checkin)
 cli.add_command(group_secret)
 cli.add_command(group_cache)
+cli.add_command(group_request)
 
 
 if __name__ == "__main__":

src/pybritive/commands/request.py

@@ -0,0 +1,48 @@
+import click
+from ..helpers.build_britive import build_britive
+from ..options.britive_options import britive_options
+from ..completers.profile import profile_completer
+
+@click.group()
+def request():
+    """Provides functionality related to requesting approval to checkout a profile."""
+    pass
+
+
+@request.command()
+@build_britive
+@britive_options(names='justification,tenant,token,passphrase')
+@click.argument('profile', shell_complete=profile_completer)
+def submit(ctx, justification, tenant, token, passphrase, profile):
+    """Submit a request to checkout a profile.
+
+    Only applicable for profiles which require approval. This command will NOT block/wait until the request is
+    approved or rejected. If you want to wait for the request to be approved, run the `checkout` command which will
+    wait until the request is approved and then checkout the profile.
+
+    This command takes 1 required argument `PROFILE`. This should be a string representation of the profile
+    that should be checked out. Format is `application name/environment name/profile name`.
+    """
+
+    ctx.obj.britive.request_submit(
+        profile=profile,
+        justification=justification
+    )
+
+
+@request.command()
+@build_britive
+@britive_options(names='tenant,token,passphrase')
+@click.argument('profile', shell_complete=profile_completer)
+def withdraw(ctx, tenant, token, passphrase, profile):
+    """Withdraw a request to checkout a profile.
+
+    Only applicable for profiles which require approval.
+
+    This command takes 1 required argument `PROFILE`. This should be a string representation of the profile
+    that should be checked out. Format is `application name/environment name/profile name`.
+    """
+
+    ctx.obj.britive.request_withdraw(
+        profile=profile
+    )