< Summary

Class:Azure.Core.Pipeline.ClientDiagnostics
Assembly:Azure.Core
File(s):C:\Git\azure-sdk-for-net\sdk\core\Azure.Core\src\Shared\ClientDiagnostics.cs
Covered lines:63
Uncovered lines:8
Coverable lines:71
Total lines:192
Line coverage:88.7% (63 of 71)
Covered branches:29
Total branches:32
Branch coverage:90.6% (29 of 32)

Metrics

MethodCyclomatic complexity Line coverage Branch coverage
.ctor(...)-100%100%
CreateRequestFailedExceptionAsync()-100%100%
CreateRequestFailedException(...)-0%100%
CreateRequestFailedExceptionWithContent(...)-100%100%
CreateRequestFailedMessageAsync(...)-0%100%
CreateRequestFailedMessage(...)-0%100%
CreateRequestFailedMessageAsync()-0%100%
CreateRequestFailedMessageWithContent(...)-97.06%93.75%
ReadContentAsync()-100%83.33%
GetResourceProviderNamespace(...)-100%83.33%

File(s)

C:\Git\azure-sdk-for-net\sdk\core\Azure.Core\src\Shared\ClientDiagnostics.cs

#LineLine coverage
 1// Copyright (c) Microsoft Corporation. All rights reserved.
 2// Licensed under the MIT License.
 3
 4using System;
 5using System.Collections.Generic;
 6using System.Diagnostics;
 7using System.Globalization;
 8using System.IO;
 9using System.Linq;
 10using System.Reflection;
 11using System.Text;
 12using System.Threading.Tasks;
 13using Azure.Core.Pipeline;
 14
 15#nullable enable
 16
 17namespace Azure.Core.Pipeline
 18{
 19    internal sealed partial class ClientDiagnostics : DiagnosticScopeFactory
 20    {
 21        private const string DefaultMessage = "Service request failed.";
 22
 23        private readonly HttpMessageSanitizer _sanitizer;
 224        public ClientDiagnostics(ClientOptions options) : base(
 225            options.GetType().Namespace!,
 226            GetResourceProviderNamespace(options.GetType().Assembly),
 227            options.Diagnostics.IsDistributedTracingEnabled)
 28        {
 229            _sanitizer = new HttpMessageSanitizer(
 230                options.Diagnostics.LoggedQueryParameters.ToArray(),
 231                options.Diagnostics.LoggedHeaderNames.ToArray());
 232        }
 33
 34        /// <summary>
 35        /// Partial method that can optionally be defined to extract the error
 36        /// message, code, and details in a service specific manner.
 37        /// </summary>
 38        /// <param name="content">The error content.</param>
 39        /// <param name="message">The error message.</param>
 40        /// <param name="errorCode">The error code.</param>
 41        /// <param name="additionalInfo">Additional error details.</param>
 42        partial void ExtractFailureContent(
 43            string? content,
 44            ref string? message,
 45            ref string? errorCode,
 46            ref IDictionary<string, string>? additionalInfo);
 47
 48        public async ValueTask<RequestFailedException> CreateRequestFailedExceptionAsync(Response response, string? mess
 49        {
 1450            var content = await ReadContentAsync(response, true).ConfigureAwait(false);
 51            ExtractFailureContent(content, ref message, ref errorCode, ref additionalInfo);
 1452            return CreateRequestFailedExceptionWithContent(response, message, content, errorCode, additionalInfo, innerE
 1453        }
 54
 55        public RequestFailedException CreateRequestFailedException(Response response, string? message = null, string? er
 56        {
 057            string? content = ReadContentAsync(response, false).EnsureCompleted();
 58            ExtractFailureContent(content, ref message, ref errorCode, ref additionalInfo);
 059            return CreateRequestFailedExceptionWithContent(response, message, content, errorCode, additionalInfo, innerE
 60        }
 61
 62        public RequestFailedException CreateRequestFailedExceptionWithContent(
 63            Response response,
 64            string? message = null,
 65            string? content = null,
 66            string? errorCode = null,
 67            IDictionary<string, string>? additionalInfo = null,
 68            Exception? innerException = null)
 69        {
 1470            var formatMessage = CreateRequestFailedMessageWithContent(response, message, content, errorCode, additionalI
 1471            var exception = new RequestFailedException(response.Status, formatMessage, errorCode, innerException);
 72
 1473            if (additionalInfo != null)
 74            {
 1275                foreach (KeyValuePair<string, string> keyValuePair in additionalInfo)
 76                {
 477                    exception.Data.Add(keyValuePair.Key, keyValuePair.Value);
 78                }
 79            }
 80
 1481            return exception;
 82        }
 83
 84        public ValueTask<string> CreateRequestFailedMessageAsync(Response response, string? message = null, string? erro
 85        {
 086            return CreateRequestFailedMessageAsync(response, message, errorCode, additionalInfo, true);
 87        }
 88
 89        public string CreateRequestFailedMessage(Response response, string? message = null, string? errorCode = null, ID
 90        {
 091            return CreateRequestFailedMessageAsync(response, message, errorCode, additionalInfo, false).EnsureCompleted(
 92        }
 93
 94        private async ValueTask<string> CreateRequestFailedMessageAsync(Response response, string? message, string? erro
 95        {
 096            var content = await ReadContentAsync(response, async).ConfigureAwait(false);
 97
 098            return CreateRequestFailedMessageWithContent(response, message, content, errorCode, additionalInfo);
 099        }
 100
 101        public string CreateRequestFailedMessageWithContent(Response response, string? message, string? content, string?
 102        {
 14103            StringBuilder messageBuilder = new StringBuilder()
 14104                .AppendLine(message ?? DefaultMessage)
 14105                .Append("Status: ")
 14106                .Append(response.Status.ToString(CultureInfo.InvariantCulture));
 107
 14108            if (!string.IsNullOrEmpty(response.ReasonPhrase))
 109            {
 14110                messageBuilder.Append(" (")
 14111                    .Append(response.ReasonPhrase)
 14112                    .AppendLine(")");
 113            }
 114            else
 115            {
 0116                messageBuilder.AppendLine();
 117            }
 118
 14119            if (!string.IsNullOrWhiteSpace(errorCode))
 120            {
 2121                messageBuilder.Append("ErrorCode: ")
 2122                    .Append(errorCode)
 2123                    .AppendLine();
 124            }
 125
 14126            if (additionalInfo != null && additionalInfo.Count > 0)
 127            {
 2128                messageBuilder
 2129                    .AppendLine()
 2130                    .AppendLine("Additional Information:");
 12131                foreach (KeyValuePair<string, string> info in additionalInfo)
 132                {
 4133                    messageBuilder
 4134                        .Append(info.Key)
 4135                        .Append(": ")
 4136                        .AppendLine(info.Value);
 137                }
 138            }
 139
 14140            if (content != null)
 141            {
 2142                messageBuilder
 2143                    .AppendLine()
 2144                    .AppendLine("Content:")
 2145                    .AppendLine(content);
 146            }
 147
 14148            messageBuilder
 14149                .AppendLine()
 14150                .AppendLine("Headers:");
 151
 80152            foreach (HttpHeader responseHeader in response.Headers)
 153            {
 26154                string headerValue = _sanitizer.SanitizeHeader(responseHeader.Name, responseHeader.Value);
 26155                messageBuilder.AppendLine($"{responseHeader.Name}: {headerValue}");
 156            }
 157
 14158            return messageBuilder.ToString();
 159        }
 160
 161        private static async ValueTask<string?> ReadContentAsync(Response response, bool async)
 162        {
 14163            string? content = null;
 164
 14165            if (response.ContentStream != null &&
 14166                ContentTypeUtilities.TryGetTextEncoding(response.Headers.ContentType, out var encoding))
 167            {
 2168                using (var streamReader = new StreamReader(response.ContentStream, encoding))
 169                {
 2170                    content = async ? await streamReader.ReadToEndAsync().ConfigureAwait(false) : streamReader.ReadToEnd
 2171                }
 172            }
 173
 14174            return content;
 14175        }
 176
 177        internal static string? GetResourceProviderNamespace(Assembly assembly)
 178        {
 714179            foreach (var customAttribute in assembly.GetCustomAttributes(true))
 180            {
 181                // Weak bind internal shared type
 326182                var attributeType = customAttribute.GetType();
 326183                if (attributeType.Name == "AzureResourceProviderNamespaceAttribute")
 184                {
 58185                    return attributeType.GetProperty("ResourceProviderNamespace")?.GetValue(customAttribute) as string;
 186                }
 187            }
 188
 2189            return null;
 190        }
 191    }
 192}
Generated by: ReportGenerator 4.6.4.0
8/12/2020 - 3:46:41 PM
GitHub | www.palmmedia.de

Methods/Properties

.ctor(...)
CreateRequestFailedExceptionAsync()
CreateRequestFailedException(...)
CreateRequestFailedExceptionWithContent(...)
CreateRequestFailedMessageAsync(...)
CreateRequestFailedMessage(...)
CreateRequestFailedMessageAsync()
CreateRequestFailedMessageWithContent(...)
ReadContentAsync()
GetResourceProviderNamespace(...)