Add tests on custom client-request-id

Author: samwelkanda

tests/integration/test_telemetry.py

@@ -1,4 +1,6 @@
 import platform
+import re
+import uuid
 
 import pytest
 
@@ -50,3 +52,21 @@ def test_telemetry_handler_non_graph_url(graph_client):
         response.request.headers["sdkVersion"]
         response.request.headers["HostOs"]
         response.request.headers["RuntimeEnvironment"]
+
+
+def test_custom_client_request_id(graph_client):
+    """
+    Test customer provided client request id overrides default value
+    """
+    custom_id = str(uuid.uuid4())
+    response = graph_client.get(
+        'https://httpbin.org/status/200', headers={"client-request-id": custom_id}
+    )
+
+    assert response.status_code == 200
+    assert response.request.headers["client-request-id"] == custom_id
+    with pytest.raises(KeyError):
+        response.request.headers["client-request-id"]
+        response.request.headers["sdkVersion"]
+        response.request.headers["HostOs"]
+        response.request.headers["RuntimeEnvironment"]

tests/unit/test_telemetry_handler.py

@@ -57,6 +57,25 @@ def test_add_client_request_id_header():
     assert _is_valid_uuid(request.headers.get('client-request-id'))
 
 
+@responses.activate
+def test_custom_client_request_id_header():
+    """
+    Test that a custom client request id is used, if provided
+    """
+    custom_id = str(uuid.uuid4())
+    responses.add(responses.GET, BASE_URL)
+    response = requests.get(BASE_URL)
+    request = response.request
+    request.context = RequestContext({}, {'client-request-id': custom_id})
+
+    telemetry_handler = TelemetryHandler()
+    telemetry_handler._add_client_request_id_header(request)
+
+    assert 'client-request-id' in request.headers
+    assert _is_valid_uuid(request.headers.get('client-request-id'))
+    assert request.headers.get('client-request-id') == custom_id
+
+
 @responses.activate
 def test_append_sdk_version_header():
     """