/// <summary> /// A helper that can run the test under a variety of conditions /// * Whether the eventSource is enabled at startup /// * Whether the listener is ETW or an EventListern /// * Whether the ETW output is self describing or not. /// </summary> private void Test_Bad_EventSource_Startup(bool onStartup, Listener listener, EventSourceSettings settings) { var eventSourceName = typeof(BadEventSource_MismatchedIds).Name; Debug.WriteLine("***** Test_BadEventSource_Startup(OnStartUp: " + onStartup + " Listener: " + listener + " Settings: " + settings + ")"); // Activate the source before the source exists (if told to). if (onStartup) { listener.EventSourceCommand(eventSourceName, EventCommand.Enable); } var events = new List <Event>(); listener.OnEvent = delegate(Event data) { events.Add(data); }; using (var source = new BadEventSource_MismatchedIds(settings)) { Assert.Equal(eventSourceName, source.Name); // activate the source after the source exists (if told to). if (!onStartup) { listener.EventSourceCommand(eventSourceName, EventCommand.Enable); } source.Event1(1); // Try to send something. } listener.Dispose(); // Confirm that we get exactly one event from this whole process, that has the error message we expect. Assert.Equal(events.Count, 1); Event _event = events[0]; Assert.Equal("EventSourceMessage", _event.EventName); string message = _event.PayloadString(0, "message"); Debug.WriteLine(string.Format("Message=\"{0}\"", message)); // expected message: "ERROR: Exception in Command Processing for EventSource BadEventSource_MismatchedIds: Event Event2 was assigned event ID 2 but 1 was passed to WriteEvent. " if (!PlatformDetection.IsFullFramework) // Full framework has typo { Assert.Matches("Event Event2 was assigned event ID 2 but 1 was passed to WriteEvent", message); } }
/// <summary> /// A helper that can run the test under a variety of conditions /// * Whether the eventSource is enabled at startup /// * Whether the listener is ETW or an EventListern /// * Whether the ETW output is self describing or not. /// </summary> private void Test_Bad_EventSource_Startup(bool onStartup, Listener listener, EventSourceSettings settings) { var eventSourceName = typeof(BadEventSource_MismatchedIds).Name; Debug.WriteLine("***** Test_BadEventSource_Startup(OnStartUp: " + onStartup + " Listener: " + listener + " Settings: " + settings + ")"); // Activate the source before the source exists (if told to). if (onStartup) { listener.EventSourceCommand(eventSourceName, EventCommand.Enable); } var events = new List <Event>(); listener.OnEvent = delegate(Event data) { events.Add(data); }; using (var source = new BadEventSource_MismatchedIds(settings)) { Assert.Equal(eventSourceName, source.Name); // activate the source after the source exists (if told to). if (!onStartup) { listener.EventSourceCommand(eventSourceName, EventCommand.Enable); } source.Event1(1); // Try to send something. } listener.Dispose(); // Confirm that we get exactly one event from this whole process, that has the error message we expect. Assert.Equal(1, events.Count); Event _event = events[0]; Assert.Equal("EventSourceMessage", _event.EventName); string message = _event.PayloadString(0, "message"); Debug.WriteLine(string.Format("Message=\"{0}\"", message)); // expected message: "ERROR: Exception in Command Processing for EventSource BadEventSource_MismatchedIds: Event Event2 was assigned event ID 2 but 1 was passed to WriteEvent. " if (!PlatformDetection.IsNetFramework) // .NET Framework has typo { Assert.Contains("Event Event2 was assigned event ID 2 but 1 was passed to WriteEvent", message); } // Validate the details of the EventWrittenEventArgs object if (_event is EventListenerListener.EventListenerEvent elEvent) { EventWrittenEventArgs ea = elEvent.Data; Assert.NotNull(ea); Assert.Equal(EventSource.CurrentThreadActivityId, ea.ActivityId); Assert.Equal(EventChannel.None, ea.Channel); Assert.Equal(0, ea.EventId); Assert.Equal("EventSourceMessage", ea.EventName); Assert.NotNull(ea.EventSource); Assert.Equal(EventKeywords.None, ea.Keywords); Assert.Equal(EventLevel.LogAlways, ea.Level); Assert.Equal((EventOpcode)0, ea.Opcode); Assert.NotNull(ea.Payload); Assert.NotNull(ea.PayloadNames); Assert.Equal(ea.PayloadNames.Count, ea.Payload.Count); Assert.Equal(Guid.Empty, ea.RelatedActivityId); Assert.Equal(EventTags.None, ea.Tags); Assert.Equal(EventTask.None, ea.Task); Assert.InRange(ea.TimeStamp, DateTime.MinValue, DateTime.MaxValue); Assert.Equal(0, ea.Version); } }
/// <summary> /// Runs a series of tests 'tests' using the listener (either an ETWListener or an EventListenerListener) on /// an EventSource 'source' passing it the filter parameters=options (by default source turn on completely /// /// Note that this routine calls Dispose on the listener, so it can't be used after that. /// </summary> public static void RunTests(List <SubTest> tests, Listener listener, EventSource source, FilteringOptions options = null) { int expectedTestNumber = 0; SubTest currentTest = null; List <Event> replies = new List <Event>(2); // Wire up the callback to handle the validation when the listener receives events. listener.OnEvent = delegate(Event data) { if (data.ProviderName == "TestHarnessEventSource") { Assert.Equal(data.EventName, "StartTest"); int testNumber = (int)data.PayloadValue(1, "testNumber"); Assert.Equal(expectedTestNumber, testNumber); // Validate that the events that came in during the test are correct. if (currentTest != null) { // You can use the currentTest.Name to set a filter in the harness // tests = tests.FindAll(test => Regex.IsMatch(test.Name, "Write/Basic/EventII") // so the test only runs this one sub-test. Then you can set // breakpoints to watch the events be generated. // // All events from EventSource infrastructure should be coming from // the ReportOutOfBand, so placing a breakpoint there is typically useful. if (currentTest.EventListValidator != null) { currentTest.EventListValidator(replies); } else { // we only expect exactly one reply Assert.Equal(replies.Count, 1); currentTest.EventValidator(replies[0]); } } replies.Clear(); if (testNumber < tests.Count) { currentTest = tests[testNumber]; Assert.Equal(currentTest.Name, data.PayloadValue(0, "name")); expectedTestNumber++; } else { Assert.NotNull(currentTest); Assert.Equal("", data.PayloadValue(0, "name")); Assert.Equal(tests.Count, testNumber); currentTest = null; } } else { // If expectedTestNumber is 0 then this is before the first test // If expectedTestNumber is count then it is after the last test Assert.NotNull(currentTest); replies.Add(data); } }; // Run the tests. collecting and validating the results. try { using (TestHarnessEventSource testHarnessEventSource = new TestHarnessEventSource()) { // Turn on the test EventSource. listener.EventSourceSynchronousEnable(source, options); // And the harnesses's EventSource. listener.EventSourceSynchronousEnable(testHarnessEventSource); // Generate events for all the tests, surrounded by events that tell us we are starting a test. int testNumber = 0; foreach (var test in tests) { Console.WriteLine("Starting Sub-Test {0} thread: {1} time: {2:mm:ss.fff}", test.Name, System.Threading.Thread.CurrentThread.ManagedThreadId, DateTime.UtcNow); testHarnessEventSource.StartTest(test.Name, testNumber); test.EventGenerator(); testNumber++; } testHarnessEventSource.StartTest("", testNumber); // Empty test marks the end of testing. // Disable the listeners. listener.EventSourceCommand(source.Name, EventCommand.Disable); listener.EventSourceCommand(testHarnessEventSource.Name, EventCommand.Disable); // Send something that should be ignored. testHarnessEventSource.IgnoreEvent(); } } finally { // Run the tests. collecting and validating the results. Console.WriteLine("Stopped running tests thread: {0} time: {1:mm:ss.fff}", System.Threading.Thread.CurrentThread.ManagedThreadId, DateTime.UtcNow); } listener.Dispose(); // Indicate we are done listening. For the ETW file based cases, we do all the processing here // expectedTetst number are the number of tests we successfully ran. Assert.Equal(expectedTestNumber, tests.Count); }
/// <summary> /// Runs a series of tests 'tests' using the listener (either an ETWListener or an EventListenerListener) on /// an EventSource 'source' passing it the filter parameters=options (by default source turn on completely /// /// Note that this routine calls Dispose on the listener, so it can't be used after that. /// </summary> public static void RunTests(List <SubTest> tests, Listener listener, EventSource source, FilteringOptions options = null) { int expectedTestNumber = 0; SubTest currentTest = null; List <Event> replies = new List <Event>(2); // Wire up the callback to handle the validation when the listener receives events. listener.OnEvent = delegate(Event data) { if (data.ProviderName == "TestHarnessEventSource") { Assert.Equal(data.EventName, "StartTest"); int testNumber = (int)data.PayloadValue(1, "testNumber"); Assert.Equal(expectedTestNumber, testNumber); // Validate that the events that came in during the test are correct. if (currentTest != null) { // You can use the currentTest.Name to set a filter in the harness // tests = tests.FindAll(test => Regex.IsMatch(test.Name, "Write/Basic/EventII") // so the test only runs this one sub-test. Then you can set // breakpoints to watch the events be generated. // // All events from EventSource infrastructure should be coming from // the ReportOutOfBand, so placing a breakpoint there is typically useful. if (currentTest.EventListValidator != null) { currentTest.EventListValidator(replies); } else { // we only expect exactly one reply Assert.Equal(replies.Count, 1); currentTest.EventValidator(replies[0]); } } replies.Clear(); if (testNumber < tests.Count) { currentTest = tests[testNumber]; Assert.Equal(currentTest.Name, data.PayloadValue(0, "name")); expectedTestNumber++; _log = new StringWriter(); LogWriteLine("STARTING Sub-Test {0}", currentTest.Name); } else { Assert.NotNull(currentTest); Assert.Equal("", data.PayloadValue(0, "name")); Assert.Equal(tests.Count, testNumber); currentTest = null; } } else { LogWriteLine("Received Event {0}", data); // If expectedTestNumber is 0 then this is before the first test // If expectedTestNumber is count then it is after the last test Assert.NotNull(currentTest); replies.Add(data); } }; // Run the tests. collecting and validating the results. try { using (TestHarnessEventSource testHarnessEventSource = new TestHarnessEventSource()) { // Turn on the test EventSource. listener.EventSourceSynchronousEnable(source, options); // And the harnesses's EventSource. listener.EventSourceSynchronousEnable(testHarnessEventSource); // Generate events for all the tests, surrounded by events that tell us we are starting a test. int testNumber = 0; foreach (var test in tests) { testHarnessEventSource.StartTest(test.Name, testNumber); test.EventGenerator(); testNumber++; } testHarnessEventSource.StartTest("", testNumber); // Empty test marks the end of testing. // Disable the listeners. listener.EventSourceCommand(source.Name, EventCommand.Disable); listener.EventSourceCommand(testHarnessEventSource.Name, EventCommand.Disable); // Send something that should be ignored. testHarnessEventSource.IgnoreEvent(); } } catch (Exception e) { if (e is EventSourceException) { e = e.InnerException; } LogWriteLine("Exception thrown: {0}", e.Message); var exceptionText = new StringWriter(); exceptionText.WriteLine("Error Detected in EventTestHarness.RunTest"); if (currentTest != null) { exceptionText.WriteLine("FAILURE IN SUBTEST: \"{0}\"", currentTest.Name); } exceptionText.WriteLine("************* EXCEPTION INFO ***************"); exceptionText.WriteLine(e.ToString()); exceptionText.WriteLine("*********** END EXCEPTION INFO *************"); if (_log != null) { exceptionText.WriteLine("************* LOGGING MESSAGES ***************"); exceptionText.WriteLine(_log.ToString()); exceptionText.WriteLine("*********** END LOGGING MESSAGES *************"); } exceptionText.WriteLine("Version of Runtime {0}", Environment.Version); exceptionText.WriteLine("Version of OS {0}", Environment.OSVersion); exceptionText.WriteLine("**********************************************"); throw new EventTestHarnessException(exceptionText.ToString(), e); } listener.Dispose(); // Indicate we are done listening. For the ETW file based cases, we do all the processing here // expectedTetst number are the number of tests we successfully ran. Assert.Equal(expectedTestNumber, tests.Count); }
/// <summary> /// A helper that can run the test under a variety of conditions /// * Whether the eventSource is enabled at startup /// * Whether the listener is ETW or an EventListern /// * Whether the ETW output is self describing or not. /// </summary> private void Test_Bad_EventSource_Startup(bool onStartup, Listener listener, EventSourceSettings settings) { var eventSourceName = typeof(BadEventSource_MismatchedIds).Name; Debug.WriteLine("***** Test_BadEventSource_Startup(OnStartUp: " + onStartup + " Listener: " + listener + " Settings: " + settings + ")"); // Activate the source before the source exists (if told to). if (onStartup) listener.EventSourceCommand(eventSourceName, EventCommand.Enable); var events = new List<Event>(); listener.OnEvent = delegate (Event data) { events.Add(data); }; using (var source = new BadEventSource_MismatchedIds(settings)) { Assert.Equal(eventSourceName, source.Name); // activate the source after the source exists (if told to). if (!onStartup) listener.EventSourceCommand(eventSourceName, EventCommand.Enable); source.Event1(1); // Try to send something. } listener.Dispose(); // Confirm that we get exactly one event from this whole process, that has the error message we expect. Assert.Equal(events.Count, 1); Event _event = events[0]; Assert.Equal("EventSourceMessage", _event.EventName); string message = _event.PayloadString(0, "message"); Debug.WriteLine(String.Format("Message=\"{0}\"", message)); // expected message: "ERROR: Exception in Command Processing for EventSource BadEventSource_MismatchedIds: Event Event2 is given event ID 2 but 1 was passed to WriteEvent. " Assert.True(Regex.IsMatch(message, "Event Event2 is givien event ID 2 but 1 was passed to WriteEvent")); }