Merge pull request #26 from djyasin/linting_fix_mypy_29442

Add type annotations to function signatures in credential_plugins_test and importable_test modules

.mypy.ini

@@ -34,3 +34,6 @@ strict_optional = true
 warn_no_return = true
 warn_redundant_casts = true
 warn_unused_ignores = true
+
+[mypy-awx.main.models.credential.*]  # This can be removed once AWX can be added as a dependency or eliminated for good
+ignore_missing_imports = true

.pre-commit-config.yaml

@@ -189,6 +189,10 @@ repos:
     additional_dependencies:
     - lxml  # dep of `--txt-report`, `--cobertura-xml-report` & `--html-report`
     - pytest
+    # The following dependency is used in `credentials.aim`,
+    # `credentials.centrify_vault`, `credentials.conjur`
+    # and `credentials.hashivault`:
+    - types-requests
     args:
     - --python-version=3.13
     - --txt-report=.tox/.tmp/.test-results/mypy--py-3.13
@@ -201,6 +205,10 @@ repos:
     additional_dependencies:
     - lxml  # dep of `--txt-report`, `--cobertura-xml-report` & `--html-report`
     - pytest
+    # The following dependency is used in `credentials.aim`,
+    # `credentials.centrify_vault`, `credentials.conjur`
+    # and `credentials.hashivault`:
+    - types-requests
     args:
     - --python-version=3.12
     - --txt-report=.tox/.tmp/.test-results/mypy--py-3.12
@@ -213,6 +221,10 @@ repos:
     additional_dependencies:
     - lxml  # dep of `--txt-report`, `--cobertura-xml-report` & `--html-report`
     - pytest
+    # The following dependency is used in `credentials.aim`,
+    # `credentials.centrify_vault`, `credentials.conjur`
+    # and `credentials.hashivault`:
+    - types-requests
     args:
     - --python-version=3.11
     - --txt-report=.tox/.tmp/.test-results/mypy--py-3.11

tests/credential_plugins_test.py

@@ -5,7 +5,7 @@
 from awx_plugins.credentials import hashivault
 
 
-def test_imported_azure_cloud_sdk_vars():
+def test_imported_azure_cloud_sdk_vars() -> None:
     from awx_plugins.credentials import azure_kv
 
     assert len(azure_kv.clouds) > 0
@@ -14,7 +14,7 @@ def test_imported_azure_cloud_sdk_vars():
     assert all([hasattr(c.suffixes, 'keyvault_dns') for c in azure_kv.clouds])
 
 
-def test_hashivault_approle_auth():
+def test_hashivault_approle_auth() -> None:
     kwargs = {
         'role_id': 'the_role_id',
         'secret_id': 'the_secret_id',
@@ -27,7 +27,7 @@ def test_hashivault_approle_auth():
     assert res == expected_res
 
 
-def test_hashivault_kubernetes_auth():
+def test_hashivault_kubernetes_auth() -> None:
     kwargs = {
         'kubernetes_role': 'the_kubernetes_role',
     }
@@ -44,7 +44,7 @@ def test_hashivault_kubernetes_auth():
         assert res == expected_res
 
 
-def test_hashivault_client_cert_auth_explicit_role():
+def test_hashivault_client_cert_auth_explicit_role() -> None:
     kwargs = {
         'client_cert_role': 'test-cert-1',
     }
@@ -55,31 +55,31 @@ def test_hashivault_client_cert_auth_explicit_role():
     assert res == expected_res
 
 
-def test_hashivault_client_cert_auth_no_role():
-    kwargs = {}
+def test_hashivault_client_cert_auth_no_role() -> None:
+    kwargs: dict[str, str] = {}
     expected_res = {
         'name': None,
     }
     res = hashivault.client_cert_auth(**kwargs)
     assert res == expected_res
 
 
-def test_hashivault_userpass_auth():
+def test_hashivault_userpass_auth() -> None:
     kwargs = {'username': 'the_username', 'password': 'the_password'}
     expected_res = {'username': 'the_username', 'password': 'the_password'}
     res = hashivault.userpass_auth(**kwargs)
     assert res == expected_res
 
 
-def test_hashivault_handle_auth_token():
+def test_hashivault_handle_auth_token() -> None:
     kwargs = {
         'token': 'the_token',
     }
     token = hashivault.handle_auth(**kwargs)
     assert token == kwargs['token']
 
 
-def test_hashivault_handle_auth_approle():
+def test_hashivault_handle_auth_approle() -> None:
     kwargs = {
         'role_id': 'the_role_id',
         'secret_id': 'the_secret_id',
@@ -91,7 +91,7 @@ def test_hashivault_handle_auth_approle():
         assert token == 'the_token'
 
 
-def test_hashivault_handle_auth_kubernetes():
+def test_hashivault_handle_auth_kubernetes() -> None:
     kwargs = {
         'kubernetes_role': 'the_kubernetes_role',
     }
@@ -110,7 +110,7 @@ def test_hashivault_handle_auth_kubernetes():
             assert token == 'the_token'
 
 
-def test_hashivault_handle_auth_client_cert():
+def test_hashivault_handle_auth_client_cert() -> None:
     kwargs = {
         'client_cert_public': 'foo',
         'client_cert_private': 'bar',
@@ -126,7 +126,7 @@ def test_hashivault_handle_auth_client_cert():
         assert token == 'the_token'
 
 
-def test_hashivault_handle_auth_not_enough_args():
+def test_hashivault_handle_auth_not_enough_args() -> None:
     with pytest.raises(Exception):
         hashivault.handle_auth()
 
@@ -137,12 +137,12 @@ class TestDelineaImports:
     library, so these tests are designed to fail if these wind up using the
     fallback import."""
 
-    def test_dsv_import(self):
+    def test_dsv_import(self) -> None:
         from awx_plugins.credentials.dsv import SecretsVault  # noqa
         # assert this module as opposed to older thycotic.secrets.vault
         assert SecretsVault.__module__ == 'delinea.secrets.vault'
 
-    def test_tss_import(self):
+    def test_tss_import(self) -> None:
         from awx_plugins.credentials.tss import DomainPasswordGrantAuthorizer, PasswordGrantAuthorizer, SecretServer, ServerSecret  # noqa
 
         for cls in (

tests/importable_test.py

@@ -16,7 +16,7 @@ class EntryPointParam:
     name: str
     spec: str
 
-    def __str__(self):
+    def __str__(self) -> str:
         """Render an entry-point parameter as a string.
 
         To be used as a part of parametrized test ID.
@@ -159,7 +159,7 @@ def __str__(self):
 
 
 @with_all_plugins
-def test_entry_points_exposed(entry_point: str) -> None:
+def test_entry_points_exposed(entry_point: EntryPointParam) -> None:
     """Verify the plugin entry points are discoverable.
 
     This check relies on the plugin-declaring distribution package to be
@@ -172,7 +172,9 @@ def test_entry_points_exposed(entry_point: str) -> None:
 
 
 @with_credential_plugins
-def test_entry_points_are_credential_plugin(entry_point: str) -> None:
+def test_entry_points_are_credential_plugin(
+        entry_point: EntryPointParam,
+) -> None:
     """Ensure all exposed credential plugins are of the same class."""
     entry_points = _discover_entry_points(group=entry_point.group)
     loaded_plugin_class = entry_points[entry_point.name].load()
@@ -182,7 +184,9 @@ def test_entry_points_are_credential_plugin(entry_point: str) -> None:
 
 
 @with_inventory_plugins
-def test_entry_points_are_inventory_plugin(entry_point: str) -> None:
+def test_entry_points_are_inventory_plugin(
+        entry_point: EntryPointParam,
+) -> None:
     """Ensure all exposed inventory plugins are of the same class."""
     entry_points = _discover_entry_points(group=entry_point.group)
     loaded_plugin_class = entry_points[entry_point.name].load()