|
| 1 | +"""Tests for Personal Access Token (PAT) authentication support.""" |
| 2 | + |
| 3 | +import pytest |
| 4 | +from datetime import datetime, timedelta |
| 5 | +from unittest.mock import patch |
| 6 | + |
| 7 | +from datadog_api_client.api_client import ApiClient, Endpoint as _Endpoint |
| 8 | +from datadog_api_client.configuration import Configuration |
| 9 | +from datadog_api_client.delegated_auth import ( |
| 10 | + DelegatedTokenCredentials, |
| 11 | + DelegatedTokenConfig, |
| 12 | + DelegatedTokenProvider, |
| 13 | +) |
| 14 | + |
| 15 | + |
| 16 | +class TestBearerTokenConfiguration: |
| 17 | + """Test bearer_token field on Configuration.""" |
| 18 | + |
| 19 | + def test_bearer_token_stored(self): |
| 20 | + config = Configuration(bearer_token="ddapp_test123") |
| 21 | + assert config.bearer_token == "ddapp_test123" |
| 22 | + |
| 23 | + def test_bearer_token_default_none(self): |
| 24 | + config = Configuration() |
| 25 | + assert config.bearer_token is None |
| 26 | + |
| 27 | + @patch.dict("os.environ", {"DD_BEARER_TOKEN": "ddapp_from_env"}) |
| 28 | + def test_bearer_token_env_var(self): |
| 29 | + config = Configuration() |
| 30 | + assert config.bearer_token == "ddapp_from_env" |
| 31 | + |
| 32 | + @patch.dict("os.environ", {"DD_BEARER_TOKEN": "ddapp_from_env"}) |
| 33 | + def test_bearer_token_env_var_no_override(self): |
| 34 | + config = Configuration(bearer_token="ddapp_explicit") |
| 35 | + assert config.bearer_token == "ddapp_explicit" |
| 36 | + |
| 37 | + |
| 38 | +class TestAuthSettingsWithBearerToken: |
| 39 | + """Test auth_settings() with bearer_token configured.""" |
| 40 | + |
| 41 | + def test_auth_settings_includes_bearer(self): |
| 42 | + config = Configuration(bearer_token="ddapp_test123") |
| 43 | + auth = config.auth_settings() |
| 44 | + assert "bearerAuth" in auth |
| 45 | + assert auth["bearerAuth"]["type"] == "bearer" |
| 46 | + assert auth["bearerAuth"]["in"] == "header" |
| 47 | + assert auth["bearerAuth"]["key"] == "Authorization" |
| 48 | + assert auth["bearerAuth"]["value"] == "Bearer ddapp_test123" |
| 49 | + |
| 50 | + def test_auth_settings_without_bearer(self): |
| 51 | + config = Configuration() |
| 52 | + auth = config.auth_settings() |
| 53 | + assert "bearerAuth" not in auth |
| 54 | + |
| 55 | + def test_auth_settings_bearer_coexists_with_api_keys(self): |
| 56 | + config = Configuration( |
| 57 | + api_key={"apiKeyAuth": "test-api-key", "appKeyAuth": "test-app-key"}, |
| 58 | + bearer_token="ddapp_test123", |
| 59 | + ) |
| 60 | + auth = config.auth_settings() |
| 61 | + assert "bearerAuth" in auth |
| 62 | + assert "apiKeyAuth" in auth |
| 63 | + assert "appKeyAuth" in auth |
| 64 | + |
| 65 | + |
| 66 | +class TestUpdateParamsForAuthWithBearerToken: |
| 67 | + """Test that update_params_for_auth uses bearer token correctly.""" |
| 68 | + |
| 69 | + def _make_endpoint(self, config, auth_schemes): |
| 70 | + """Helper to create an Endpoint with given auth schemes.""" |
| 71 | + api_client = ApiClient(config) |
| 72 | + return _Endpoint( |
| 73 | + settings={ |
| 74 | + "response_type": None, |
| 75 | + "auth": auth_schemes, |
| 76 | + "endpoint_path": "/api/v2/test", |
| 77 | + "operation_id": "test_op", |
| 78 | + "http_method": "GET", |
| 79 | + "version": "v2", |
| 80 | + }, |
| 81 | + params_map={}, |
| 82 | + headers_map={"accept": ["application/json"]}, |
| 83 | + api_client=api_client, |
| 84 | + ) |
| 85 | + |
| 86 | + def test_bearer_replaces_app_key(self): |
| 87 | + config = Configuration( |
| 88 | + api_key={"apiKeyAuth": "test-api-key", "appKeyAuth": "test-app-key"}, |
| 89 | + bearer_token="ddapp_test_pat", |
| 90 | + ) |
| 91 | + endpoint = self._make_endpoint(config, ["apiKeyAuth", "appKeyAuth"]) |
| 92 | + headers = {} |
| 93 | + queries = [] |
| 94 | + endpoint.update_params_for_auth(headers, queries) |
| 95 | + |
| 96 | + assert headers["DD-API-KEY"] == "test-api-key" |
| 97 | + assert headers["Authorization"] == "Bearer ddapp_test_pat" |
| 98 | + assert "DD-APPLICATION-KEY" not in headers |
| 99 | + |
| 100 | + def test_bearer_without_app_key_auth_scheme(self): |
| 101 | + """If endpoint doesn't use appKeyAuth, bearer token is not used.""" |
| 102 | + config = Configuration( |
| 103 | + api_key={"apiKeyAuth": "test-api-key"}, |
| 104 | + bearer_token="ddapp_test_pat", |
| 105 | + ) |
| 106 | + endpoint = self._make_endpoint(config, ["apiKeyAuth"]) |
| 107 | + headers = {} |
| 108 | + queries = [] |
| 109 | + endpoint.update_params_for_auth(headers, queries) |
| 110 | + |
| 111 | + assert headers["DD-API-KEY"] == "test-api-key" |
| 112 | + assert "Authorization" not in headers |
| 113 | + |
| 114 | + def test_regular_auth_without_bearer(self): |
| 115 | + config = Configuration( |
| 116 | + api_key={"apiKeyAuth": "test-api-key", "appKeyAuth": "test-app-key"}, |
| 117 | + ) |
| 118 | + endpoint = self._make_endpoint(config, ["apiKeyAuth", "appKeyAuth"]) |
| 119 | + headers = {} |
| 120 | + queries = [] |
| 121 | + endpoint.update_params_for_auth(headers, queries) |
| 122 | + |
| 123 | + assert headers["DD-API-KEY"] == "test-api-key" |
| 124 | + assert headers["DD-APPLICATION-KEY"] == "test-app-key" |
| 125 | + assert "Authorization" not in headers |
| 126 | + |
| 127 | + def test_delegated_auth_takes_priority_over_bearer(self): |
| 128 | + """When both delegated auth and bearer token are configured, delegated wins.""" |
| 129 | + |
| 130 | + class MockProvider(DelegatedTokenProvider): |
| 131 | + def authenticate(self, config, api_config): |
| 132 | + return DelegatedTokenCredentials( |
| 133 | + org_uuid="test-org", |
| 134 | + delegated_token="delegated-token-123", |
| 135 | + delegated_proof="proof", |
| 136 | + expiration=datetime.now() + timedelta(minutes=10), |
| 137 | + ) |
| 138 | + |
| 139 | + config = Configuration( |
| 140 | + api_key={"apiKeyAuth": "test-api-key", "appKeyAuth": "test-app-key"}, |
| 141 | + bearer_token="ddapp_test_pat", |
| 142 | + delegated_auth_provider=MockProvider(), |
| 143 | + delegated_auth_org_uuid="test-org", |
| 144 | + ) |
| 145 | + endpoint = self._make_endpoint(config, ["apiKeyAuth", "appKeyAuth"]) |
| 146 | + headers = {} |
| 147 | + queries = [] |
| 148 | + endpoint.update_params_for_auth(headers, queries) |
| 149 | + |
| 150 | + # Delegated auth should be used, not bearer token |
| 151 | + assert headers["Authorization"] == "Bearer delegated-token-123" |
| 152 | + assert "DD-APPLICATION-KEY" not in headers |
| 153 | + |
| 154 | + def test_bearer_with_no_api_key_set(self): |
| 155 | + """Bearer token with apiKeyAuth in scheme but no key configured.""" |
| 156 | + config = Configuration(bearer_token="ddapp_test_pat") |
| 157 | + endpoint = self._make_endpoint(config, ["apiKeyAuth", "appKeyAuth"]) |
| 158 | + headers = {} |
| 159 | + queries = [] |
| 160 | + endpoint.update_params_for_auth(headers, queries) |
| 161 | + |
| 162 | + # apiKeyAuth is not configured, so it won't be in headers |
| 163 | + assert "DD-API-KEY" not in headers |
| 164 | + # Bearer token should still be set (replacing appKeyAuth) |
| 165 | + assert headers["Authorization"] == "Bearer ddapp_test_pat" |
0 commit comments