|
| 1 | +# Copyright (c) Microsoft Corporation. |
| 2 | +# Licensed under the MIT license. |
| 3 | + |
| 4 | +"""Tests for operation_context support on DataverseClient and User-Agent header.""" |
| 5 | + |
| 6 | +import unittest |
| 7 | +from unittest.mock import MagicMock |
| 8 | + |
| 9 | +from azure.core.credentials import TokenCredential |
| 10 | + |
| 11 | +from PowerPlatform.Dataverse.client import DataverseClient |
| 12 | +from PowerPlatform.Dataverse.core.config import DataverseConfig |
| 13 | +from PowerPlatform.Dataverse.data._odata import _ODataClient, _USER_AGENT |
| 14 | + |
| 15 | + |
| 16 | +class TestOperationContextConfig(unittest.TestCase): |
| 17 | + """Tests for operation_context on DataverseConfig.""" |
| 18 | + |
| 19 | + def test_default_is_none(self): |
| 20 | + config = DataverseConfig.from_env() |
| 21 | + self.assertIsNone(config.operation_context) |
| 22 | + |
| 23 | + def test_explicit_value(self): |
| 24 | + config = DataverseConfig(operation_context="app=test/1.0;agent=claude-code") |
| 25 | + self.assertEqual(config.operation_context, "app=test/1.0;agent=claude-code") |
| 26 | + |
| 27 | + def test_default_constructor_is_none(self): |
| 28 | + config = DataverseConfig() |
| 29 | + self.assertIsNone(config.operation_context) |
| 30 | + |
| 31 | + |
| 32 | +class TestOperationContextClient(unittest.TestCase): |
| 33 | + """Tests for operation_context kwarg on DataverseClient.""" |
| 34 | + |
| 35 | + def setUp(self): |
| 36 | + self.mock_credential = MagicMock(spec=TokenCredential) |
| 37 | + self.base_url = "https://example.crm.dynamics.com" |
| 38 | + |
| 39 | + def test_kwarg_sets_config(self): |
| 40 | + client = DataverseClient( |
| 41 | + self.base_url, self.mock_credential, |
| 42 | + operation_context="app=test/1.0;skill=dv-data;agent=claude-code", |
| 43 | + ) |
| 44 | + self.assertEqual(client._config.operation_context, "app=test/1.0;skill=dv-data;agent=claude-code") |
| 45 | + |
| 46 | + def test_no_kwarg_leaves_config_default(self): |
| 47 | + client = DataverseClient(self.base_url, self.mock_credential) |
| 48 | + self.assertIsNone(client._config.operation_context) |
| 49 | + |
| 50 | + def test_config_and_kwarg_raises(self): |
| 51 | + config = DataverseConfig(operation_context="app=test/1.0") |
| 52 | + with self.assertRaises(ValueError): |
| 53 | + DataverseClient( |
| 54 | + self.base_url, self.mock_credential, |
| 55 | + config=config, |
| 56 | + operation_context="app=other/2.0", |
| 57 | + ) |
| 58 | + |
| 59 | + def test_config_alone_works(self): |
| 60 | + config = DataverseConfig(operation_context="app=test/1.0;agent=copilot") |
| 61 | + client = DataverseClient(self.base_url, self.mock_credential, config=config) |
| 62 | + self.assertEqual(client._config.operation_context, "app=test/1.0;agent=copilot") |
| 63 | + |
| 64 | + |
| 65 | +class TestOperationContextUserAgent(unittest.TestCase): |
| 66 | + """Tests for User-Agent header with operation_context.""" |
| 67 | + |
| 68 | + def setUp(self): |
| 69 | + self.dummy_auth = MagicMock() |
| 70 | + token_result = MagicMock() |
| 71 | + token_result.access_token = "test-token" |
| 72 | + self.dummy_auth._acquire_token.return_value = token_result |
| 73 | + self.base_url = "https://org.example.com" |
| 74 | + |
| 75 | + def test_default_user_agent_unchanged(self): |
| 76 | + odata = _ODataClient(self.dummy_auth, self.base_url) |
| 77 | + headers = odata._headers() |
| 78 | + self.assertEqual(headers["User-Agent"], _USER_AGENT) |
| 79 | + |
| 80 | + def test_operation_context_appended(self): |
| 81 | + ctx = "app=dataverse-skills/1.2.1;skill=dv-data;agent=claude-code" |
| 82 | + config = DataverseConfig(operation_context=ctx) |
| 83 | + odata = _ODataClient(self.dummy_auth, self.base_url, config=config) |
| 84 | + headers = odata._headers() |
| 85 | + self.assertEqual(headers["User-Agent"], f"{_USER_AGENT} ({ctx})") |
| 86 | + |
| 87 | + def test_none_context_no_parentheses(self): |
| 88 | + config = DataverseConfig(operation_context=None) |
| 89 | + odata = _ODataClient(self.dummy_auth, self.base_url, config=config) |
| 90 | + headers = odata._headers() |
| 91 | + self.assertNotIn("(", headers["User-Agent"]) |
| 92 | + |
| 93 | + def test_empty_string_context_no_parentheses(self): |
| 94 | + config = DataverseConfig(operation_context="") |
| 95 | + odata = _ODataClient(self.dummy_auth, self.base_url, config=config) |
| 96 | + headers = odata._headers() |
| 97 | + self.assertNotIn("(", headers["User-Agent"]) |
0 commit comments