Make python fail properly when invalid key is passed (#350)

* Raise error when auth token is None

* Regenerate client from commit 6bab119 of spec repo

* Always set a key value

Co-authored-by: Thomas Hervé <[email protected]>
Co-authored-by: api-clients-generation-pipeline[bot] <54105614+api-clients-generation-pipeline[bot]@users.noreply.github.com>
Co-authored-by: ci.datadog-api-spec <[email protected]>

Author: 3 people

.apigentools-info

@@ -4,13 +4,13 @@
     "spec_versions": {
         "v1": {
             "apigentools_version": "1.4.1.dev6",
-            "regenerated": "2021-03-30 07:00:01.825212",
-            "spec_repo_commit": "55a2c8a"
+            "regenerated": "2021-03-30 13:18:25.700382",
+            "spec_repo_commit": "6bab119"
         },
         "v2": {
             "apigentools_version": "1.4.1.dev6",
-            "regenerated": "2021-03-30 07:00:44.784406",
-            "spec_repo_commit": "55a2c8a"
+            "regenerated": "2021-03-30 13:19:05.062981",
+            "spec_repo_commit": "6bab119"
         }
     }
 }

.generator/templates/api_client.mustache

@@ -623,6 +623,8 @@ class ApiClient(object):
                     headers['Cookie'] = auth_setting['value']
                 elif auth_setting['in'] == 'header':
                     if auth_setting['type'] != 'http-signature':
+                        if auth_setting["value"] is None:
+                            raise ApiValueError("Invalid authentication token for {}".format(auth_setting["key"]))
                         headers[auth_setting['key']] = auth_setting['value']
 {{#hasHttpSignatureMethods}}
                     else:

src/datadog_api_client/v1/api_client.py

@@ -622,6 +622,8 @@ def update_params_for_auth(self, headers, querys, auth_settings, resource_path,
                     headers["Cookie"] = auth_setting["value"]
                 elif auth_setting["in"] == "header":
                     if auth_setting["type"] != "http-signature":
+                        if auth_setting["value"] is None:
+                            raise ApiValueError("Invalid authentication token for {}".format(auth_setting["key"]))
                         headers[auth_setting["key"]] = auth_setting["value"]
                 elif auth_setting["in"] == "query":
                     querys.append((auth_setting["key"], auth_setting["value"]))

src/datadog_api_client/v2/api_client.py

@@ -622,6 +622,8 @@ def update_params_for_auth(self, headers, querys, auth_settings, resource_path,
                     headers["Cookie"] = auth_setting["value"]
                 elif auth_setting["in"] == "header":
                     if auth_setting["type"] != "http-signature":
+                        if auth_setting["value"] is None:
+                            raise ApiValueError("Invalid authentication token for {}".format(auth_setting["key"]))
                         headers[auth_setting["key"]] = auth_setting["value"]
                 elif auth_setting["in"] == "query":
                     querys.append((auth_setting["key"], auth_setting["value"]))

tests/conftest.py

@@ -276,13 +276,13 @@ def freezer(default_cassette_name, record_mode, vcr):
 @given('a valid "apiKeyAuth" key in the system')
 def a_valid_api_key(configuration):
     """a valid API key."""
-    configuration.api_key["apiKeyAuth"] = os.getenv("DD_TEST_CLIENT_API_KEY", "")
+    configuration.api_key["apiKeyAuth"] = os.getenv("DD_TEST_CLIENT_API_KEY", "fake")
 
 
 @given('a valid "appKeyAuth" key in the system')
 def a_valid_application_key(configuration):
     """a valid Application key."""
-    configuration.api_key["appKeyAuth"] = os.getenv("DD_TEST_CLIENT_APP_KEY", "")
+    configuration.api_key["appKeyAuth"] = os.getenv("DD_TEST_CLIENT_APP_KEY", "fake")
 
 
 @pytest.fixture
@@ -388,8 +388,8 @@ def wrapper(context, undo):
 
         # make sure we have a fresh instance of API client and configuration
         configuration = build_configuration(importlib.import_module(package_name))
-        configuration.api_key["apiKeyAuth"] = os.getenv("DD_TEST_CLIENT_API_KEY", "")
-        configuration.api_key["appKeyAuth"] = os.getenv("DD_TEST_CLIENT_APP_KEY", "")
+        configuration.api_key["apiKeyAuth"] = os.getenv("DD_TEST_CLIENT_API_KEY", "fake")
+        configuration.api_key["appKeyAuth"] = os.getenv("DD_TEST_CLIENT_APP_KEY", "fake")
 
         # enable unstable operation
         configuration.unstable_operations[operation_name] = True