docs(http-tests): author XML doc comments on test surface

Author: ottobolyos

tests/MTConnect.NET-HTTP-Tests/Clients/Current.cs

@@ -11,9 +11,11 @@ namespace MTConnect.Tests.Http.Clients
     // MTConnectHttpServer started by AgentRunner, exercising the HTTP current
     // request/response path end to end for XML and JSON, all devices, a single
     // device and a device path filter.
+    /// <summary>Pins the behaviour expressed by the test name: current.</summary>
     [TestFixture]
     public class Current : HttpClientFixture
     {
+        /// <summary>Pins the behaviour expressed by the test name: run xml.</summary>
         [Test]
         public void RunXml()
         {
@@ -25,6 +27,7 @@ public void RunXml()
             Assert.That(response.Streams.Count(), Is.EqualTo(ExpectedDocumentEntryCount), "XML Current did not return all device streams");
         }
 
+        /// <summary>Pins the behaviour expressed by the test name: run json.</summary>
         [Test]
         public void RunJson()
         {
@@ -36,6 +39,7 @@ public void RunJson()
             Assert.That(response.Streams.Count(), Is.EqualTo(ExpectedDocumentEntryCount), "JSON Current did not return all device streams");
         }
 
+        /// <summary>Pins the behaviour expressed by the test name: run device xml.</summary>
         [Test]
         public void RunDeviceXml()
         {
@@ -47,6 +51,7 @@ public void RunDeviceXml()
             Assert.That(response.Streams.FirstOrDefault(o => o.Name == DeviceName), Is.Not.Null, $"XML Current did not return device {DeviceName}");
         }
 
+        /// <summary>Pins the behaviour expressed by the test name: run device json.</summary>
         [Test]
         public void RunDeviceJson()
         {
@@ -58,6 +63,7 @@ public void RunDeviceJson()
             Assert.That(response.Streams.FirstOrDefault(o => o.Name == DeviceName), Is.Not.Null, $"JSON Current did not return device {DeviceName}");
         }
 
+        /// <summary>Pins the behaviour expressed by the test name: run device path xml.</summary>
         [Test]
         public void RunDevicePathXml()
         {

tests/MTConnect.NET-HTTP-Tests/Clients/HttpClientFixture.cs

@@ -15,22 +15,30 @@ namespace MTConnect.Tests.Http.Clients
     // per fixture removes that contention. AgentRunner.Start() blocks until the
     // server actually answers a Probe, so the first client request never races
     // the fire-and-forget socket bind.
+    /// <summary>Represents the http client fixture.</summary>
     public abstract class HttpClientFixture
     {
+        /// <summary>The hostname.</summary>
         protected const string Hostname = "127.0.0.1";
+        /// <summary>The device name.</summary>
         protected const string DeviceName = "OKUMA-Lathe";
+        /// <summary>The device uuid.</summary>
         protected const string DeviceUuid = "OKUMA.Lathe.123456";
 
+        /// <summary>Gets or sets the agent runner.</summary>
         protected AgentRunner AgentRunner { get; private set; } = null!;
 
+        /// <summary>Gets or sets the port.</summary>
         protected int Port { get; private set; }
 
         // Streams/devices include the implicit Agent device alongside the two
         // device files AgentRunner loads, so a full document carries one more
         // entry than AgentRunner.Devices.
+        /// <summary>Gets or sets the expected document entry count.</summary>
         protected int ExpectedDocumentEntryCount => AgentRunner.Devices.Count() + 1;
 
 
+        /// <summary>Sets up the fixture before each test.</summary>
         [OneTimeSetUp]
         public void OneTimeSetUp()
         {
@@ -39,6 +47,7 @@ public void OneTimeSetUp()
             AgentRunner.Start();
         }
 
+        /// <summary>Tears down the fixture after each test.</summary>
         [OneTimeTearDown]
         public void OneTimeTearDown()
         {

tests/MTConnect.NET-HTTP-Tests/Clients/Probe.cs

@@ -11,9 +11,11 @@ namespace MTConnect.Tests.Http.Clients
     // MTConnectHttpServer started by AgentRunner, exercising the HTTP probe
     // request/response path end to end for XML and JSON, all devices and a
     // single device.
+    /// <summary>Pins the behaviour expressed by the test name: probe.</summary>
     [TestFixture]
     public class Probe : HttpClientFixture
     {
+        /// <summary>Pins the behaviour expressed by the test name: run xml.</summary>
         [Test]
         public void RunXml()
         {
@@ -25,6 +27,7 @@ public void RunXml()
             Assert.That(response.Devices.Count(), Is.EqualTo(ExpectedDocumentEntryCount), "XML Probe did not return all devices");
         }
 
+        /// <summary>Pins the behaviour expressed by the test name: run json.</summary>
         [Test]
         public void RunJson()
         {
@@ -36,6 +39,7 @@ public void RunJson()
             Assert.That(response.Devices.Count(), Is.EqualTo(ExpectedDocumentEntryCount), "JSON Probe did not return all devices");
         }
 
+        /// <summary>Pins the behaviour expressed by the test name: run device xml.</summary>
         [Test]
         public void RunDeviceXml()
         {
@@ -47,6 +51,7 @@ public void RunDeviceXml()
             Assert.That(response.Devices.FirstOrDefault(o => o.Name == DeviceName), Is.Not.Null, $"XML Probe did not return device {DeviceName}");
         }
 
+        /// <summary>Pins the behaviour expressed by the test name: run device json.</summary>
         [Test]
         public void RunDeviceJson()
         {

tests/MTConnect.NET-HTTP-Tests/Clients/Sample.cs

@@ -11,9 +11,11 @@ namespace MTConnect.Tests.Http.Clients
     // MTConnectHttpServer started by AgentRunner, exercising the HTTP sample
     // request/response path end to end for XML and JSON, all devices, a single
     // device and a device path filter.
+    /// <summary>Pins the behaviour expressed by the test name: sample.</summary>
     [TestFixture]
     public class Sample : HttpClientFixture
     {
+        /// <summary>Pins the behaviour expressed by the test name: run xml.</summary>
         [Test]
         public void RunXml()
         {
@@ -25,6 +27,7 @@ public void RunXml()
             Assert.That(response.Streams.Count(), Is.EqualTo(ExpectedDocumentEntryCount), "XML Sample did not return all device streams");
         }
 
+        /// <summary>Pins the behaviour expressed by the test name: run json.</summary>
         [Test]
         public void RunJson()
         {
@@ -36,6 +39,7 @@ public void RunJson()
             Assert.That(response.Streams.Count(), Is.EqualTo(ExpectedDocumentEntryCount), "JSON Sample did not return all device streams");
         }
 
+        /// <summary>Pins the behaviour expressed by the test name: run device xml.</summary>
         [Test]
         public void RunDeviceXml()
         {
@@ -47,6 +51,7 @@ public void RunDeviceXml()
             Assert.That(response.Streams.FirstOrDefault(o => o.Name == DeviceName), Is.Not.Null, $"XML Sample did not return device {DeviceName}");
         }
 
+        /// <summary>Pins the behaviour expressed by the test name: run device json.</summary>
         [Test]
         public void RunDeviceJson()
         {
@@ -58,6 +63,7 @@ public void RunDeviceJson()
             Assert.That(response.Streams.FirstOrDefault(o => o.Name == DeviceName), Is.Not.Null, $"JSON Sample did not return device {DeviceName}");
         }
 
+        /// <summary>Pins the behaviour expressed by the test name: run device path xml.</summary>
         [Test]
         public void RunDevicePathXml()
         {

tests/MTConnect.NET-HTTP-Tests/Clients/SampleStream.cs

@@ -20,6 +20,7 @@ namespace MTConnect.Tests.Http.Clients
     // asserts the streamed Sample delivers that observation back. This
     // exercises the broker ingest/sequence/buffer path and the HTTP server
     // stream + HTTP streaming-client per-chunk loop end to end.
+    /// <summary>Pins the behaviour expressed by the test name: sample client.</summary>
     [TestFixture]
     public class SampleClient
     {
@@ -37,6 +38,7 @@ public class SampleClient
         private readonly object _lock = new object();
 
 
+        /// <summary>Sets up the fixture before each test.</summary>
         [OneTimeSetUp]
         public void OneTimeSetUp()
         {
@@ -50,6 +52,7 @@ public void OneTimeSetUp()
             _client.Start();
         }
 
+        /// <summary>Tears down the fixture after each test.</summary>
         [OneTimeTearDown]
         public void OneTimeTearDown()
         {
@@ -88,6 +91,7 @@ private void SampleReceived(object? sender, IStreamsResponseDocument response)
         }
 
 
+        /// <summary>Pins the behaviour expressed by the test name: run.</summary>
         [Test]
         public void Run()
         {