Merge pull request #27 from britive/develop

v0.5.0

Author: twratl

CHANGELOG.md

@@ -2,6 +2,22 @@
 
 All changes to the package starting with v0.3.1 will be logged here.
 
+## v0.5.0 [2022-10-11]
+#### What's New
+* None
+
+#### Enhancements
+* Allow for non `*.britive-app.com` tenants. Default to `britive-app.com` if no valid URL is provided (for backwards compatibility)
+
+#### Bug Fixes
+* None
+
+#### Dependencies
+* `britive~=2.10.0` from `britive~=2.9.0`
+
+#### Other
+* None
+
 ## v0.4.1 [2022-09-30]
 #### What's New
 * None

docs/index.md

@@ -48,12 +48,15 @@ who may have access to an EA and GA tenant.
 
 ## Tenant Selection Logic
 
+Given the URL `https://example.britive-app.com` used to access your Britive tenant, tenant value can be provided in a number of formats.
+
+1. `example`
+2. `example.britive-app.com`
+3. `https://example.britive-app.com`
+
 There are numerous ways to provide the CLI with the Britive tenant that should be used. The below list is the
 order of operations for determining the tenant.
 
-The tenant excludes `.britive-app.com`. Just include the leftmost part.
-Example: `example.britive-app.com` will have a tenant name in the CLI of `example`.
-
 1. Value retrieved from CLI option/flag `--tenant/-t`
 2. Value retrieved from environment variable `BRITIVE_TENANT`
 3. Value retrieved from `~/.britive/pybritive.config` global variable `default_tenant`

requirements.txt

@@ -1,4 +1,4 @@
-britive~=2.9.0
+britive~=2.10.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.4.1
+version = 0.5.0
 author = Britive Inc.
 author_email = support@britive.com
 description = A pure Python CLI for Britive

src/pybritive/britive_cli.py

@@ -1,6 +1,5 @@
 import io
-import time
-
+import socket
 from britive.britive import Britive
 from .helpers.config import ConfigManager
 from .helpers.credentials import FileCredentialManager, EncryptedFileCredentialManager
@@ -36,6 +35,22 @@ def __init__(self, tenant_name: str = None, token: str = None, silent: bool = Fa
     def set_output_format(self, output_format: str):
         self.output_format = self.config.get_output_format(output_format)
 
+    # it is preferable to do this in the sdk as a static method
+    # as this will eliminate the duplicate code
+    def parse_tenant(self):
+        domain = self.tenant_name.replace('https://', '').replace('http://', '')  # remove scheme
+        domain = domain.split('/')[0]  # remove any paths as they will not be needed
+        try:
+            socket.gethostbyname_ex(domain)  # if success then a full domain was provided
+            return domain
+        except socket.gaierror:  # assume just the tenant name was provided (originally the only supported method)
+            domain = f'{self.tenant_name}.britive-app.com'
+            try:
+                socket.gethostbyname_ex(domain)  # validate the hostname is real
+                return domain
+            except socket.gaierror:
+                raise Exception(f'Invalid tenant provided: {self.tenant_name}')
+
     def set_credential_manager(self):
         if self.credential_manager:
             return
@@ -97,7 +112,7 @@ def logout(self):
         if self.token:
             raise click.ClickException('Logout not available when using an API token.')
         self.login()
-        self.b.delete(f'https://{self.tenant_name}.britive-app.com/api/auth')
+        self.b.delete(f'https://{self.parse_tenant()}/api/auth')
         self._cleanup_credentials()
 
     # will take a list of dicts and print to the screen based on the format specified in the config file

src/pybritive/commands/configure.py

@@ -42,7 +42,7 @@ def tenant(ctx, configure_tenant, configure_alias, output_format, configure_prom
                 type=output_format_choices
             )
 
-    if not tenant_name  or len(tenant_name.strip()) == 0:
+    if not tenant_name or len(tenant_name.strip()) == 0:
         raise click.ClickException('Tenant Name not provided.')
     if not alias:
         alias = tenant_name

src/pybritive/helpers/config.py

@@ -97,7 +97,6 @@ def load(self, force=False):
         self.profile_aliases = self.config.get('profile-aliases', {})
         self.loaded = True
 
-
     def get_tenant(self):
         # load up the config - doing it here instead of __init__ for the configure commands since config won't
         # yet exist and we don't want to error
@@ -141,10 +140,7 @@ def save(self):
 
     def save_tenant(self, tenant: str, alias: str = None, output_format: str = None):
         self.load()
-        tenant = tenant.replace('.britive-app.com', '')
-        if alias:
-            alias = alias.replace('.britive-app.com', '')
-        else:
+        if not alias:
             alias = tenant
         if f'tenant-{alias}' not in self.config.keys():
             self.config[f'tenant-{alias}'] = {}
@@ -160,7 +156,7 @@ def save_global(self, default_tenant_name: str = None, output_format: str = None
         if 'global' not in self.config.keys():
             self.config['global'] = {}
         if default_tenant_name:
-            self.config['global']['default_tenant'] = default_tenant_name.replace('.britive-app.com', '')
+            self.config['global']['default_tenant'] = default_tenant_name
         if output_format:
             self.config['global']['output_format'] = output_format
         if backend:
@@ -266,10 +262,6 @@ def validate_tenant(self, section, fields):
             if field == 'output_format' and value not in output_format_choices.choices:
                 error = f'Invalid {section} field {field} value {value} provided. Invalid value choice.'
                 self.validation_error_messages.append(error)
-            if field == 'name' and 'britive-app.com' in value:
-                error = f'Invalid {section} field {field} value {value} provided. Tenant name cannot include ' \
-                        'britive-app.com'
-                self.validation_error_messages.append(error)
 
     def auto_refresh_profile_cache(self):
         self.load()

src/pybritive/helpers/credentials.py

@@ -8,7 +8,6 @@
 import click
 import configparser
 import json
-from .config import ConfigManager
 import os
 from .encryption import StringEncryption, InvalidPassphraseException
 
@@ -42,11 +41,11 @@ def b64_encode_url_safe(value: bytes):
 
 # this base class expects self.credentials to be a dict - so sub classes need to convert to dict
 class CredentialManager:
-    def __init__(self, tenant_name: str, tenant_alias: str, cli: ConfigManager):
+    def __init__(self, tenant_name: str, tenant_alias: str, cli):
         self.cli = cli
         self.tenant = tenant_name
         self.alias = tenant_alias
-        self.base_url = f'https://{self.tenant}.britive-app.com'
+        self.base_url = f'https://{cli.parse_tenant()}'
 
         # not sure if we really need 32 random bytes or if any random string would work
         # but the current britive-cli in node.js does it this way so it will be done the same
@@ -138,7 +137,7 @@ def has_valid_credentials(self):
 
 
 class FileCredentialManager(CredentialManager):
-    def __init__(self, tenant_name: str, tenant_alias: str, cli: ConfigManager):
+    def __init__(self, tenant_name: str, tenant_alias: str, cli):
         home = os.getenv('PYBRITIVE_HOME_DIR', str(Path.home()))
         self.path = str(Path(home) / '.britive' / 'pybritive.credentials')
         super().__init__(tenant_name, tenant_alias, cli)
@@ -179,7 +178,7 @@ def delete(self):
 
 
 class EncryptedFileCredentialManager(CredentialManager):
-    def __init__(self, tenant_name: str, tenant_alias: str, cli: ConfigManager, passphrase: str = None):
+    def __init__(self, tenant_name: str, tenant_alias: str, cli, passphrase: str = None):
         home = os.getenv('PYBRITIVE_HOME_DIR', str(Path.home()))
         self.path = str(Path(home) / '.britive' / 'pybritive.credentials.encrypted')
         self.passphrase = passphrase

src/pybritive/options/configure_tenant.py

@@ -1,15 +1,8 @@
 import click
 
 
-def validate_tenant(ctx, self, value):
-    if value is None:
-        return None
-    return value.replace('.britive-app.com', '')  # just in case
-
-
 option = click.option(
     '--tenant', '-t', 'configure_tenant',
-    callback=validate_tenant,
     default=None,
     help='The name of the tenant: [tenant].britive-app.com.'
 )