pytest updates

Author: twratl

TECH_README.md

@@ -42,6 +42,9 @@ Environment variables that should be set for testing include the following.
 
 Create `./testing-variables.txt` and load what you need so you can easily re-create the needed variables. This file is in `.gitignore`. 
 
+Package the code locally with `pip install -e .` so pytest can run against the python package.
+Then `pytest tests/ -v` to perform the testing. 
+
 The identity used for testing will require access to at least one profile to test `checkout` and `checkin`. 
 Additionally, the identity will need access to 2 secrets
 * one standard secret with path `/pybritive-test-standard` to test `view` - the value of the secret should be generic note with note of `test`

src/pybritive/helpers/cloud_credential_printer.py

@@ -237,7 +237,7 @@ def print_gcloudauth(self):
         else:  # we need to parse out/sanitize what was provided
             path = Path(self.gcloud_key_file).expanduser().absolute()
 
-        # key file does not yet exist, create it as an empty file
+        # key file does not yet exist so write to it
         path.parent.mkdir(exist_ok=True, parents=True)
         path.write_text(json.dumps(self.credentials, indent=2))
 

tests/test_0200_configure.py

@@ -45,73 +45,73 @@ def common_asserts(result, substring=None, exit_code=0):
 
 
 def test_configure_tenant_via_flags_no_alias(runner, cli):
-    result = runner.invoke(cli, 'configure tenant -t test1 -f yaml'.split(' '))
-    common_asserts(result, substring='[tenant-test1]')
+    result = runner.invoke(cli, 'configure tenant -t pybritivetest1.dev -f yaml'.split(' '))
+    common_asserts(result, substring='[tenant-pybritivetest1.dev]')
 
 
 def test_configure_tenant_via_flags_no_alias_no_format(runner, cli):
-    result = runner.invoke(cli, 'configure tenant -t test2'.split(' '))
-    common_asserts(result, substring='[tenant-test2]')
+    result = runner.invoke(cli, 'configure tenant -t pybritivetest2.dev'.split(' '))
+    common_asserts(result, substring='[tenant-pybritivetest2.dev]')
 
 
 def test_configure_tenant_via_flags_yes_alias(runner, cli):
-    result = runner.invoke(cli, 'configure tenant -t test -f yaml -a testalias1'.split(' '))
+    result = runner.invoke(cli, 'configure tenant -t pybritivetest1.dev -f yaml -a testalias1'.split(' '))
     common_asserts(result, substring='[tenant-testalias1]')
 
 
 def test_configure_tenant_via_flags_yes_alias_no_format(runner, cli):
-    result = runner.invoke(cli, 'configure tenant -t test -a testalias2'.split(' '))
+    result = runner.invoke(cli, 'configure tenant -t pybritivetest2.dev -a testalias2'.split(' '))
     common_asserts(result, substring='[tenant-testalias2]')
 
 
 def test_configure_tenant_via_prompt_no_alias(runner, cli):
-    result = runner.invoke(cli, 'configure tenant'.split(' '), input='test3\n\njson\n')
-    common_asserts(result, substring='[tenant-test3]')
+    result = runner.invoke(cli, 'configure tenant'.split(' '), input='pybritivetest3.dev\n\njson\n')
+    common_asserts(result, substring='[tenant-pybritivetest3.dev]')
 
 
 def test_configure_tenant_via_prompt_no_alias_no_format(runner, cli):
-    result = runner.invoke(cli, 'configure tenant'.split(' '), input='test4\n\n\n')
-    common_asserts(result, substring='[tenant-test4]')
+    result = runner.invoke(cli, 'configure tenant'.split(' '), input='pybritivetest4.dev\n\n\n')
+    common_asserts(result, substring='[tenant-pybritivetest4.dev]')
 
 
 def test_configure_tenant_via_prompt_yes_alias(runner, cli):
-    result = runner.invoke(cli, ['configure', 'tenant'], input='test4\ntestalias3\nyaml\n')
+    result = runner.invoke(cli, ['configure', 'tenant'], input='pybritivetest3.dev\ntestalias3\nyaml\n')
     common_asserts(result, substring='[tenant-testalias3]')
 
 
 def test_configure_tenant_via_prompt_yes_alias_no_format(runner, cli):
-    result = runner.invoke(cli, ['configure', 'tenant'], input='test4\ntestalias4\n\n')
+    result = runner.invoke(cli, ['configure', 'tenant'], input='pybritivetest4.dev\ntestalias4\n\n')
     common_asserts(result, substring='[tenant-testalias4]')
 
 
 def test_configure_global_via_flags_file_backend(runner, cli):
-    result = runner.invoke(cli, 'configure global -t test1 -f table -b file'.split(' '))
-    common_asserts(result, substring=['default_tenant=test1', 'output_format=table', 'credential_backend=file'])
+    result = runner.invoke(cli, 'configure global -t pybritivetest1.dev -f table -b file'.split(' '))
+    common_asserts(result, substring=['default_tenant=pybritivetest1.dev', 'output_format=table', 'credential_backend=file'])
 
 
 def test_configure_global_via_flags_encrypted_file_backend(runner, cli):
-    result = runner.invoke(cli, 'configure global -t test2 -f yaml -b encrypted-file'.split(' '))
+    result = runner.invoke(cli, 'configure global -t pybritivetest2.dev -f yaml -b encrypted-file'.split(' '))
     common_asserts(
         result,
         substring=[
-            'default_tenant=test2',
+            'default_tenant=pybritivetest2.dev',
             'output_format=yaml',
             'credential_backend=encrypted-file'
         ]
     )
 
 
 def test_configure_global_via_prompt_file_backend(runner, cli):
-    result = runner.invoke(cli, 'configure global'.split(' '), input='test1\ntable-pretty\nfile\n')
-    common_asserts(result, substring=['default_tenant=test1', 'output_format=table-pretty', 'credential_backend=file'])
+    result = runner.invoke(cli, 'configure global'.split(' '), input='pybritivetest1.dev\ntable-pretty\nfile\n')
+    common_asserts(result, substring=['default_tenant=pybritivetest1.dev', 'output_format=table-pretty', 'credential_backend=file'])
 
 
 def test_configure_global_via_prompt_encrypted_file_backend(runner, cli):
-    result = runner.invoke(cli, 'configure global'.split(' '), input='test2\n\nencrypted-file\n')
+    result = runner.invoke(cli, 'configure global'.split(' '), input='pybritivetest2.dev\n\nencrypted-file\n')
     common_asserts(
         result,
         substring=[
-            'default_tenant=test2',
+            'default_tenant=pybritivetest2.dev',
             'output_format=json',
             'credential_backend=encrypted-file'
         ]
@@ -124,8 +124,8 @@ def test_configure_global_with_invalid_format(runner, cli):
 
 
 def test_configure_global_with_invalid_tenant(runner, cli):
-    result = runner.invoke(cli, 'configure global -t incorect'.split(' '))
-    assert "Invalid global field default_tenant value incorect provided. Tenant not found." in result.output
+    result = runner.invoke(cli, 'configure global -t incorrect'.split(' '))
+    assert "Invalid global field default_tenant value incorrect provided. Tenant not found." in result.output
 
 
 def test_configure_import_simple(runner, cli):
@@ -166,7 +166,7 @@ def test_configure_update_global_correct_data(runner, cli):
 
 def test_configure_update_tenant_correct_data(runner, cli):
     tenant = os.getenv('PYBRITIVE_TEST_TENANT')
-    result = runner.invoke(cli, f'configure update tenant-{tenant} name test'.split(' '))
-    common_asserts(result, substring=['name=test'])
+    result = runner.invoke(cli, f'configure update tenant-{tenant} name pybritivetest1.dev'.split(' '))
+    common_asserts(result, substring=['name=pybritivetest1.dev'])
     # set it back
     runner.invoke(cli, f'configure update tenant-{tenant} name {tenant}'.split(' '))

tests/test_0850_clear.py

@@ -0,0 +1,41 @@
+import os
+from pathlib import Path
+import json
+
+
+def test_clear_cache(runner, cli):
+    result = runner.invoke(cli, 'clear cache'.split(' '))
+    local_home = os.getenv('PYBRITIVE_HOME_DIR')
+    path = Path(Path(local_home) / '.britive' / 'pybritive.cache')
+    with open(str(path), 'r') as f:
+        data = json.loads(f.read())
+    assert result.exit_code == 0
+    assert 'profiles' in data.keys()
+    assert len(data['profiles']) == 0
+
+
+def test_clear_gcloud_key_files(runner, cli):
+    local_home = os.getenv('PYBRITIVE_HOME_DIR')
+    path = Path(local_home) / '.britive' / 'pybritive-gcloud-key-files'
+    file1 = path / 'file1.json'
+    file2 = path / 'file2.json'
+
+    path.mkdir(exist_ok=True, parents=True)
+    file1.write_text('')
+    file2.write_text('')
+
+    assert path.is_dir()
+    assert file1.is_file()
+    assert file2.is_file()
+
+    result = runner.invoke(cli, 'clear gcloud-auth-key-files'.split(' '))
+    assert result.exit_code == 0
+    assert not file1.is_file()
+    assert not file2.is_file()
+    assert not path.is_dir()
+
+
+
+
+
+

tests/test_0900_login.py

@@ -12,7 +12,7 @@ def test_login_interactive(runner, cli, unset_api_token_env_var):
     result = runner.invoke(cli, ['login'])
     assert result.exit_code == 0
     local_home = os.getenv('PYBRITIVE_HOME_DIR')
-    path = Path(Path(local_home) / '.britive' / 'pybritive.credentials')
+    path = Path(Path(local_home) / '.britive' / 'pybritive.credentials.encrypted')
     with open(str(path), 'r') as f:
         data = f.read()
     assert 'accessToken=' in data

tests/test_1000_logout.py

@@ -2,11 +2,11 @@
 import os
 
 
-def test_logout(runner, cli, profile):
+def test_logout(runner, cli):
     result = runner.invoke(cli, ['logout'])
     assert result.exit_code == 0
     local_home = os.getenv('PYBRITIVE_HOME_DIR')
-    path = Path(Path(local_home) / '.britive' / 'pybritive.credentials')
+    path = Path(Path(local_home) / '.britive' / 'pybritive.credentials.encrypted')
     with open(str(path), 'r') as f:
         data = f.read()
     assert len(data) == 0