Merge pull request #223 from Microsoft/master

V0.9.3 release - ETW streaming and refactoring of aync usage

Author: David Kline

CONTRIBUTING.md

@@ -71,6 +71,17 @@ Address any review comments, force push to your topic branch, and post a comment
 
 If the pull request review goes well, a project maintainer will merge your changes. Thank you for helping improve the Windows Device Portal Wrapper!
 
+# NuGet release and versioning
+
+**For maintainers**
+
+When creating a new NuGet and GitHub release, the following steps should be taken:
+1. Bump the version number as appropriate in master (after 1.0, WDP Wrapper will correctly use semver)
+2. Merge from Master to Release, with a PR appropriately named ("v1.2.3 release")
+3. Squash and merge commits, leaving major feature entries and fixes in the description. 
+4. Compile release builds of the .NET and UWP libraries, sign them, and upload to NuGet 
+5. Cut a new release on GitHub using the same version number ("v1.2.3") and attach the signed libraries to the release. 
+6. Update code documentation. 
 
 # Updating code documentation
 

Samples/SampleWdpClient.UniversalWindows/MainPage.xaml.cs

@@ -40,8 +40,11 @@ public class Program
             new Endpoint(HttpMethods.Get, DevicePortal.IpConfigApi),
             new Endpoint(HttpMethods.Get, DevicePortal.SystemPerfApi),
             new Endpoint(HttpMethods.Get, DevicePortal.RunningProcessApi),
+            new Endpoint(HttpMethods.Get, DevicePortal.CustomEtwProvidersApi),
+            new Endpoint(HttpMethods.Get, DevicePortal.EtwProvidersApi),
             new Endpoint(HttpMethods.WebSocket, DevicePortal.SystemPerfApi),
             new Endpoint(HttpMethods.WebSocket, DevicePortal.RunningProcessApi),
+            new Endpoint(HttpMethods.WebSocket, DevicePortal.RealtimeEtwSessionApi),
 
             // HoloLens specific endpoints
             new Endpoint(HttpMethods.Get, DevicePortal.HolographicIpdApi),

WindowsDevicePortalWrapper/MockDataGenerator/Program.cs

@@ -0,0 +1,109 @@
+//----------------------------------------------------------------------------------------------
+// <copyright file="EtwTests.cs" company="Microsoft Corporation">
+//     Licensed under the MIT License. See LICENSE.TXT in the project root license information.
+// </copyright>
+//----------------------------------------------------------------------------------------------
+
+using System;
+using System.Collections.Generic;
+using System.Linq;
+using System.Threading;
+using System.Threading.Tasks;
+using Microsoft.VisualStudio.TestTools.UnitTesting;
+using static Microsoft.Tools.WindowsDevicePortal.DevicePortal;
+
+namespace Microsoft.Tools.WindowsDevicePortal.Tests.Core
+{
+    /// <summary>
+    /// Test class for ETW APIs.
+    /// </summary>
+    [TestClass]
+    public class EtwTests : BaseTests
+    {
+        /// <summary>
+        /// Basic test of GET method for getting a list of custom registered ETW providers.
+        /// </summary>
+        [TestMethod]
+        public void GetCustomEtwProvidersTest()
+        {
+            TestHelpers.MockHttpResponder.AddMockResponse(DevicePortal.CustomEtwProvidersApi, HttpMethods.Get);
+
+            Task<EtwProviders> getCustomEtwProvidersTask = TestHelpers.Portal.GetCustomEtwProvidersAsync();
+            getCustomEtwProvidersTask.Wait();
+
+            Assert.AreEqual(TaskStatus.RanToCompletion, getCustomEtwProvidersTask.Status);
+
+            ValidateEtwProviders(getCustomEtwProvidersTask.Result);
+        }
+
+        /// <summary>
+        /// Basic test of GET method for getting a list of registered ETW providers.
+        /// </summary>
+        [TestMethod]
+        public void GetEtwProvidersTest()
+        {
+            TestHelpers.MockHttpResponder.AddMockResponse(DevicePortal.EtwProvidersApi, HttpMethods.Get);
+
+            Task<EtwProviders> getEtwProvidersTask = TestHelpers.Portal.GetEtwProvidersAsync();
+            getEtwProvidersTask.Wait();
+
+            Assert.AreEqual(TaskStatus.RanToCompletion, getEtwProvidersTask.Status);
+
+            ValidateEtwProviders(getEtwProvidersTask.Result);
+        }
+
+        [TestMethod]
+        public void GetEtwEventsTest()
+        {
+            TestHelpers.MockHttpResponder.AddMockResponse(DevicePortal.RealtimeEtwSessionApi, HttpMethods.WebSocket);
+
+            ManualResetEvent etwEventsReceived = new ManualResetEvent(false);
+            EtwEvents etwEvents = null;
+
+            WindowsDevicePortal.WebSocketMessageReceivedEventHandler<EtwEvents> etwEventsReceivedHandler =
+                delegate (DevicePortal sender, WebSocketMessageReceivedEventArgs<EtwEvents> args)
+                {
+                    if (args.Message != null)
+                    {
+                        etwEvents = args.Message;
+                        etwEventsReceived.Set();
+                    }
+                };
+
+            TestHelpers.Portal.RealtimeEventsMessageReceived += etwEventsReceivedHandler;
+
+            Task startListeningForEtwEventsTask = TestHelpers.Portal.StartListeningForEtwEventsAsync();
+            startListeningForEtwEventsTask.Wait();
+            Assert.AreEqual(TaskStatus.RanToCompletion, startListeningForEtwEventsTask.Status);
+
+            etwEventsReceived.WaitOne();
+
+            Task stopListeningForEtwEventsTask = TestHelpers.Portal.StopListeningForEtwEventsAsync();
+            stopListeningForEtwEventsTask.Wait();
+            Assert.AreEqual(TaskStatus.RanToCompletion, stopListeningForEtwEventsTask.Status);
+
+            TestHelpers.Portal.RealtimeEventsMessageReceived -= etwEventsReceivedHandler;
+
+            ValidateEtwEvents(etwEvents);
+        }
+
+        /// <summary>
+        /// Validate the <see cref="EtwEvents"/>  returned from the tests.
+        /// </summary>
+        /// <param name="etwEvents">The <see cref="EtwEvents"/> to validate.</param>
+        private static void ValidateEtwEvents(EtwEvents etwEvents)
+        {
+            Assert.IsNotNull(etwEvents);
+        }
+        
+        /// <summary>
+        /// Validate the <see cref="EtwProviders"/> returned from the tests. 
+        /// </summary>
+        /// <param name="etw">The <see cref="EtwProviders"/> to validate.</param>
+        private static void ValidateEtwProviders(EtwProviders etw)
+        {
+            Assert.IsTrue(etw.Providers.Count > 0);
+            Assert.IsTrue(etw.Providers.All(etwProvider => !string.IsNullOrEmpty(etwProvider.Name)));
+        }
+    }
+}

WindowsDevicePortalWrapper/UnitTestProject/Core/EtwTests.cs

@@ -0,0 +1,78 @@
+//----------------------------------------------------------------------------------------------
+// <copyright file="WindowsErrorReportingTests.cs" company="Microsoft Corporation">
+//     Licensed under the MIT License. See LICENSE.TXT in the project root license information.
+// </copyright>
+//----------------------------------------------------------------------------------------------
+
+using System.Collections.Generic;
+using System.Linq;
+using System.Threading.Tasks;
+using Microsoft.VisualStudio.TestTools.UnitTesting;
+using static Microsoft.Tools.WindowsDevicePortal.DevicePortal;
+
+namespace Microsoft.Tools.WindowsDevicePortal.Tests.Core
+{
+    /// <summary>
+    /// Test class for Windows Error Reporting (WER) APIs.
+    /// </summary>
+    [TestClass]
+    public class WindowsErrorReportingTests : BaseTests
+    {
+        /// <summary>
+        /// Basic test of GET method for getting a list of Windows Error Reporting (WER) reports.
+        /// </summary>
+        [TestMethod]
+        public void GetWindowsErrorReportsTest()
+        {
+            TestHelpers.MockHttpResponder.AddMockResponse(DevicePortal.WindowsErrorReportsApi, HttpMethods.Get);
+
+            Task<WerDeviceReports> getWerReportsTask = TestHelpers.Portal.GetWindowsErrorReportsAsync();
+            getWerReportsTask.Wait();
+
+            Assert.AreEqual(TaskStatus.RanToCompletion, getWerReportsTask.Status);
+
+            List<WerUserReports> deviceReports = getWerReportsTask.Result.UserReports;
+            Assert.AreEqual(6, deviceReports.Count);
+            deviceReports.ForEach(userReport =>
+            {
+                Assert.IsFalse(string.IsNullOrWhiteSpace(userReport.UserName));
+                userReport.Reports.ForEach(report =>
+                {
+                    Assert.AreNotEqual(0, report.CreationTime);
+                    Assert.IsFalse(string.IsNullOrWhiteSpace(report.Name));
+                    switch (report.Type.ToLower())
+                    {
+                        case "queue":
+                        case "archive":
+                            break;
+                        default:
+                            Assert.Fail($"Expected the report type to be 'Queue' or 'Archive'. Actual value is '{report.Type}'.");
+                            break;
+                    }
+                });
+            });
+        }
+
+        /// <summary>
+        /// Basic test of GET method for getting a list of Windows Error Reporting (WER) report files.
+        /// </summary>
+        [TestMethod]
+        public void GetWindowsErrorReportFilesTest()
+        {
+            TestHelpers.MockHttpResponder.AddMockResponse(DevicePortal.WindowsErrorReportingFilesApi, HttpMethods.Get);
+
+            Task<WerFiles> getWerReportingFilesTask = TestHelpers.Portal.GetWindowsErrorReportingFileListAsync(string.Empty, string.Empty, string.Empty);
+            getWerReportingFilesTask.Wait();
+
+            Assert.AreEqual(TaskStatus.RanToCompletion, getWerReportingFilesTask.Status);
+
+            List<WerFileInformation> list = getWerReportingFilesTask.Result.Files;
+            Assert.AreEqual(2, list.Count);
+            list.ForEach(file =>
+            {
+                Assert.IsFalse(string.IsNullOrWhiteSpace(file.Name));
+                Assert.AreNotEqual(0, file.Size);
+            });
+        }
+    }
+}

WindowsDevicePortalWrapper/UnitTestProject/Core/WindowsErrorReportingTests.cs

@@ -0,0 +1 @@
+{  }

WindowsDevicePortalWrapper/UnitTestProject/MockData/Defaults/WebSocket_api_etw_session_realtime_Default.dat

@@ -0,0 +1 @@
+{"Providers" : [{"GUID" : "3A43D90E-530E-41E5-A897-B555516070E2", "Name" : "Provider.One"},{"GUID" : "52B1715B-5AB6-4B48-A61A-A93EE8D4B5CD", "Name" : "Provider-Two"},{"GUID" : "698F02FF-2B63-4CBB-AB06-FEB88011347E", "Name" : "Provider.Three"}]}

WindowsDevicePortalWrapper/UnitTestProject/MockData/Defaults/api_etw_customproviders_Default.dat

@@ -0,0 +1 @@
+{"Providers" : [{"GUID" : "3A43D90E-530E-41E5-A897-B555516070E2", "Name" : "Provider.One"},{"GUID" : "52B1715B-5AB6-4B48-A61A-A93EE8D4B5CD", "Name" : "Provider-Two"},{"GUID" : "698F02FF-2B63-4CBB-AB06-FEB88011347E", "Name" : "Provider.Three"}]}

WindowsDevicePortalWrapper/UnitTestProject/MockData/Defaults/api_etw_providers_Default.dat

@@ -0,0 +1 @@
+{"Files" : [{"Name" : "DMI59C3.tmp.log.xml", "Size" : 17490},{"Name" : "Report.wer", "Size" : 2354}]}

WindowsDevicePortalWrapper/UnitTestProject/MockData/Defaults/api_wer_report_files_Default.dat

@@ -0,0 +1 @@
+{"WerReports" : [{"User" : "All Users", "Reports" : []},{"User" : "Default", "Reports" : []},{"User" : "Default User", "Reports" : []},{"User" : "defaultuser0", "Reports" : []},{"User" : "Public", "Reports" : []},{"User" : "SYSTEM", "Reports" : [{"CreationTime" : 131318340058889142, "Name" : "NonCritical_x64_7929388dba23a244febb598fddbb379b5a87d15_00000000_cab_03f96433", "Type" : "Queue"},{"CreationTime" : 131318340058732887, "Name" : "NonCritical_x64_bf8ef24cbbad37c50f759d68f2292f1f2b0e7df_00000000_cab_03f96423", "Type" : "Queue"},{"CreationTime" : 131318550054539960, "Name" : "NonCritical_x64_f52a5825f740cca45c7b0c8078746ec73beaac_00000000_18add298", "Type" : "Archive"},{"CreationTime" : 131318340063576709, "Name" : "NonCritical_x64_f728cd6f9e9f34997130a4d3dd3d855648a6f_00000000_0ca56608", "Type" : "Archive"}]}]}