|
| 1 | +// This source code is dual-licensed under the Apache License, version |
| 2 | +// 2.0, and the Mozilla Public License, version 2.0. |
| 3 | +// |
| 4 | +// The APL v2.0: |
| 5 | +// |
| 6 | +//--------------------------------------------------------------------------- |
| 7 | +// Copyright (c) 2007-2025 Broadcom. All Rights Reserved. |
| 8 | +// |
| 9 | +// Licensed under the Apache License, Version 2.0 (the "License"); |
| 10 | +// you may not use this file except in compliance with the License. |
| 11 | +// You may obtain a copy of the License at |
| 12 | +// |
| 13 | +// https://www.apache.org/licenses/LICENSE-2.0 |
| 14 | +// |
| 15 | +// Unless required by applicable law or agreed to in writing, software |
| 16 | +// distributed under the License is distributed on an "AS IS" BASIS, |
| 17 | +// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. |
| 18 | +// See the License for the specific language governing permissions and |
| 19 | +// limitations under the License. |
| 20 | +//--------------------------------------------------------------------------- |
| 21 | +// |
| 22 | +// The MPL v2.0: |
| 23 | +// |
| 24 | +//--------------------------------------------------------------------------- |
| 25 | +// This Source Code Form is subject to the terms of the Mozilla Public |
| 26 | +// License, v. 2.0. If a copy of the MPL was not distributed with this |
| 27 | +// file, You can obtain one at https://mozilla.org/MPL/2.0/. |
| 28 | +// |
| 29 | +// Copyright (c) 2007-2025 Broadcom. All Rights Reserved. |
| 30 | +//--------------------------------------------------------------------------- |
| 31 | + |
| 32 | +using System; |
| 33 | +using System.Collections.Generic; |
| 34 | +using System.Diagnostics; |
| 35 | +using System.Linq; |
| 36 | +using System.Text; |
| 37 | +using System.Threading; |
| 38 | +using Xunit; |
| 39 | + |
| 40 | +namespace Test |
| 41 | +{ |
| 42 | + public class ActivityRecorder : IDisposable |
| 43 | + { |
| 44 | + private string _activitySourceName; |
| 45 | + private string _activityName; |
| 46 | + |
| 47 | + private readonly ActivityListener _listener; |
| 48 | + private List<Activity> _finishedActivities = new(); |
| 49 | + |
| 50 | + private int _started; |
| 51 | + private int _stopped; |
| 52 | + |
| 53 | + public int Started => _started; |
| 54 | + public int Stopped => _stopped; |
| 55 | + |
| 56 | + public Predicate<Activity> Filter { get; set; } = _ => true; |
| 57 | + public bool VerifyParent { get; set; } = true; |
| 58 | + public Activity ExpectedParent { get; set; } |
| 59 | + |
| 60 | + public Activity LastStartedActivity { get; private set; } |
| 61 | + public Activity LastFinishedActivity { get; private set; } |
| 62 | + public IEnumerable<Activity> FinishedActivities => _finishedActivities; |
| 63 | + |
| 64 | + public ActivityRecorder(string activitySourceName, string activityName) |
| 65 | + { |
| 66 | + _activitySourceName = activitySourceName; |
| 67 | + _activityName = activityName; |
| 68 | + _listener = new ActivityListener |
| 69 | + { |
| 70 | + ShouldListenTo = (activitySource) => activitySource.Name == _activitySourceName, |
| 71 | + Sample = (ref ActivityCreationOptions<ActivityContext> options) => ActivitySamplingResult.AllData, |
| 72 | + ActivityStarted = (activity) => |
| 73 | + { |
| 74 | + if (activity.OperationName == _activityName && Filter(activity)) |
| 75 | + { |
| 76 | + if (VerifyParent) |
| 77 | + { |
| 78 | + Assert.Same(ExpectedParent, activity.Parent); |
| 79 | + } |
| 80 | + |
| 81 | + Interlocked.Increment(ref _started); |
| 82 | + |
| 83 | + LastStartedActivity = activity; |
| 84 | + } |
| 85 | + }, |
| 86 | + ActivityStopped = (activity) => |
| 87 | + { |
| 88 | + if (activity.OperationName == _activityName && Filter(activity)) |
| 89 | + { |
| 90 | + if (VerifyParent) |
| 91 | + { |
| 92 | + Assert.Same(ExpectedParent, activity.Parent); |
| 93 | + } |
| 94 | + |
| 95 | + Interlocked.Increment(ref _stopped); |
| 96 | + |
| 97 | + lock (_finishedActivities) |
| 98 | + { |
| 99 | + LastFinishedActivity = activity; |
| 100 | + _finishedActivities.Add(activity); |
| 101 | + } |
| 102 | + } |
| 103 | + } |
| 104 | + }; |
| 105 | + |
| 106 | + ActivitySource.AddActivityListener(_listener); |
| 107 | + } |
| 108 | + |
| 109 | + public void Dispose() => _listener.Dispose(); |
| 110 | + |
| 111 | + public void VerifyActivityRecorded(int times) |
| 112 | + { |
| 113 | + Assert.Equal(times, Started); |
| 114 | + Assert.Equal(times, Stopped); |
| 115 | + } |
| 116 | + |
| 117 | + public Activity VerifyActivityRecordedOnce() |
| 118 | + { |
| 119 | + VerifyActivityRecorded(1); |
| 120 | + return LastFinishedActivity; |
| 121 | + } |
| 122 | + } |
| 123 | + |
| 124 | + public static class ActivityAssert |
| 125 | + { |
| 126 | + public static KeyValuePair<string, object> HasTag(this Activity activity, string name) |
| 127 | + { |
| 128 | + KeyValuePair<string, object> tag = activity.TagObjects.SingleOrDefault(t => t.Key == name); |
| 129 | + if (tag.Key is null) |
| 130 | + { |
| 131 | + Assert.Fail($"The Activity tags should contain {name}."); |
| 132 | + } |
| 133 | + |
| 134 | + return tag; |
| 135 | + } |
| 136 | + |
| 137 | + public static void HasTag<T>(this Activity activity, string name, T expectedValue) |
| 138 | + { |
| 139 | + KeyValuePair<string, object> tag = HasTag(activity, name); |
| 140 | + Assert.Equal(expectedValue, (T)tag.Value); |
| 141 | + } |
| 142 | + |
| 143 | + public static void HasRecordedException(this Activity activity, Exception exception) |
| 144 | + { |
| 145 | + var exceptionEvent = activity.Events.First(); |
| 146 | + Assert.Equal("exception", activity.Events.First().Name); |
| 147 | + Assert.Equal(exception.GetType().ToString(), |
| 148 | + exceptionEvent.Tags.SingleOrDefault(t => t.Key == "exception.type").Value); |
| 149 | + } |
| 150 | + |
| 151 | + public static void IsInError(this Activity activity) |
| 152 | + { |
| 153 | + Assert.Equal(ActivityStatusCode.Error, activity.Status); |
| 154 | + } |
| 155 | + |
| 156 | + public static void HasNoTag(this Activity activity, string name) |
| 157 | + { |
| 158 | + bool contains = activity.TagObjects.Any(t => t.Key == name); |
| 159 | + Assert.False(contains, $"The Activity tags should not contain {name}."); |
| 160 | + } |
| 161 | + |
| 162 | + public static void FinishedInOrder(this Activity first, Activity second) |
| 163 | + { |
| 164 | + Assert.True(first.StartTimeUtc + first.Duration < second.StartTimeUtc + second.Duration, |
| 165 | + $"{first.OperationName} should stop before {second.OperationName}"); |
| 166 | + } |
| 167 | + |
| 168 | + public static string CamelToSnake(string camel) |
| 169 | + { |
| 170 | + if (string.IsNullOrEmpty(camel)) return camel; |
| 171 | + StringBuilder bld = new(); |
| 172 | + bld.Append(char.ToLower(camel[0])); |
| 173 | + for (int i = 1; i < camel.Length; i++) |
| 174 | + { |
| 175 | + char c = camel[i]; |
| 176 | + if (char.IsUpper(c)) |
| 177 | + { |
| 178 | + bld.Append('_'); |
| 179 | + } |
| 180 | + |
| 181 | + bld.Append(char.ToLower(c)); |
| 182 | + } |
| 183 | + |
| 184 | + return bld.ToString(); |
| 185 | + } |
| 186 | + } |
| 187 | +} |
0 commit comments