implement and expose ISmartDevice.EndPoint

smdn · Jan 18, 2024 · 0741005 · 0741005
1 parent 997d1ab
commit 0741005
Show file tree

Hide file tree

Showing 4 changed files with 43 additions and 2 deletions.
diff --git a/src/Smdn.TPSmartHomeDevices.Kasa/Smdn.TPSmartHomeDevices.Kasa/KasaDevice.cs b/src/Smdn.TPSmartHomeDevices.Kasa/Smdn.TPSmartHomeDevices.Kasa/KasaDevice.cs
@@ -50,6 +50,19 @@ protected readonly struct NullParameter { }
 
   private IDeviceEndPoint deviceEndPoint; // if null, it indicates a 'disposed' state.
 
+  /// <summary>
+  /// Gets the <see cref="IDeviceEndPoint"/> representing a endpoint of smart device,
+  /// which will be used to resolve the actual endpoint used to communicate with smart devices.
+  /// </summary>
+  /// <exception cref="ObjectDisposedException">The device has been disposed.</exception>
+  public IDeviceEndPoint EndPoint {
+    get {
+      ThrowIfDisposed();
+
+      return deviceEndPoint;
+    }
+  }
+
 #if SYSTEM_DIAGNOSTICS_CODEANALYSIS_MEMBERNOTNULLWHENATTRIBUTE
   [MemberNotNullWhen(false, nameof(deviceEndPoint))]
 #endif

diff --git a/src/Smdn.TPSmartHomeDevices.Tapo/Smdn.TPSmartHomeDevices.Tapo/TapoDevice.cs b/src/Smdn.TPSmartHomeDevices.Tapo/Smdn.TPSmartHomeDevices.Tapo/TapoDevice.cs
@@ -49,6 +49,19 @@ public LoggerScopeEndPointState(EndPoint currentEndPoint, IDeviceEndPoint device
 
   private IDeviceEndPoint deviceEndPoint; // if null, it indicates a 'disposed' state.
 
+  /// <summary>
+  /// Gets the <see cref="IDeviceEndPoint"/> representing a endpoint of smart device,
+  /// which will be used to resolve the actual endpoint used to communicate with smart devices.
+  /// </summary>
+  /// <exception cref="ObjectDisposedException">The device has been disposed.</exception>
+  public IDeviceEndPoint EndPoint {
+    get {
+      ThrowIfDisposed();
+
+      return deviceEndPoint;
+    }
+  }
+
 #if SYSTEM_DIAGNOSTICS_CODEANALYSIS_MEMBERNOTNULLWHENATTRIBUTE
   [MemberNotNullWhen(false, nameof(deviceEndPoint))]
 #endif

diff --git a/tests/Smdn.TPSmartHomeDevices.Kasa/Smdn.TPSmartHomeDevices.Kasa/KasaDevice.cs b/tests/Smdn.TPSmartHomeDevices.Kasa/Smdn.TPSmartHomeDevices.Kasa/KasaDevice.cs
@@ -52,6 +52,7 @@ public async Task Create_WithIPAddress()
       ipAddress: IPAddress.Loopback
     );
 
+    Assert.That(device.EndPoint, Is.Not.Null);
     Assert.That(
       await device.ResolveEndPointAsync(),
       Is.EqualTo(new IPEndPoint(IPAddress.Loopback, KasaClient.DefaultPort))
@@ -65,6 +66,7 @@ public async Task Create_WithHostName()
       host: "localhost"
     );
 
+    Assert.That(device.EndPoint, Is.Not.Null);
     Assert.That(
       await device.ResolveEndPointAsync(),
       Is.EqualTo(new DnsEndPoint("localhost", KasaClient.DefaultPort))
@@ -85,6 +87,7 @@ public async Task Create_WithMacAddress_IServiceProvider()
       serviceProvider: services.BuildServiceProvider()
     );
 
+    Assert.That(device.EndPoint, Is.Not.Null);
     Assert.That(
       await device.ResolveEndPointAsync(),
       Is.EqualTo(new IPEndPoint(IPAddress.Loopback, KasaClient.DefaultPort))
@@ -107,10 +110,13 @@ public void Create_WithMacAddress_IServiceProvider_IDeviceEndPointFactoryNotRegi
   [Test]
   public async Task Create_WithEndPoint()
   {
+    var endpoint = new StaticDeviceEndPoint(new DnsEndPoint("localhost", 0));
+
     using var device = KasaDevice.Create(
-      deviceEndPoint: new StaticDeviceEndPoint(new DnsEndPoint("localhost", 0))
+      deviceEndPoint: endpoint
     );
 
+    Assert.That(device.EndPoint, Is.EqualTo(endpoint));
     Assert.That(
       await device.ResolveEndPointAsync(),
       Is.EqualTo(new DnsEndPoint("localhost", KasaClient.DefaultPort))
@@ -127,6 +133,7 @@ public void Dispose()
     Assert.DoesNotThrow(device.Dispose, "dispose");
     Assert.DoesNotThrow(device.Dispose, "dispose again");
 
+    Assert.Throws<ObjectDisposedException>(() => Assert.That(device.EndPoint, Is.Not.Null), nameof(device.EndPoint));
     Assert.Throws<ObjectDisposedException>(() => Assert.That(device.IsConnected, Is.False), nameof(device.IsConnected));
 
     Assert.ThrowsAsync<ObjectDisposedException>(async () => await device.ResolveEndPointAsync(), nameof(device.ResolveEndPointAsync));

diff --git a/tests/Smdn.TPSmartHomeDevices.Tapo/Smdn.TPSmartHomeDevices.Tapo/TapoDevice.cs b/tests/Smdn.TPSmartHomeDevices.Tapo/Smdn.TPSmartHomeDevices.Tapo/TapoDevice.cs
@@ -129,6 +129,7 @@ public async Task Create_WithIPAddress()
       "password"
     );
 
+    Assert.That(device.EndPoint, Is.Not.Null);
     Assert.That(
       await device.ResolveEndPointAsync(),
       Is.EqualTo(new IPEndPoint(IPAddress.Loopback, TapoClient.DefaultPort))
@@ -144,6 +145,7 @@ public async Task Create_WithHostName()
       "password"
     );
 
+    Assert.That(device.EndPoint, Is.Not.Null);
     Assert.That(
       await device.ResolveEndPointAsync(),
       Is.EqualTo(new DnsEndPoint("localhost", TapoClient.DefaultPort))
@@ -166,6 +168,7 @@ public async Task Create_WithMacAddress_IServiceProvider()
       serviceProvider: services!.BuildServiceProvider()
     );
 
+    Assert.That(device.EndPoint, Is.Not.Null);
     Assert.That(
       await device.ResolveEndPointAsync(),
       Is.EqualTo(new IPEndPoint(IPAddress.Loopback, TapoClient.DefaultPort))
@@ -190,11 +193,14 @@ public void Create_WithMacAddress_IServiceProvider_IDeviceEndPointFactoryNotRegi
   [Test]
   public async Task Create_WithEndPoint()
   {
+    var endpoint = new StaticDeviceEndPoint(new DnsEndPoint("localhost", 0));
+
     using var device = TapoDevice.Create(
-      deviceEndPoint: new StaticDeviceEndPoint(new DnsEndPoint("localhost", 0)),
+      deviceEndPoint: endpoint,
       serviceProvider: services!.BuildServiceProvider()
     );
 
+    Assert.That(device.EndPoint, Is.EqualTo(endpoint));
     Assert.That(
       await device.ResolveEndPointAsync(),
       Is.EqualTo(new DnsEndPoint("localhost", TapoClient.DefaultPort))
@@ -249,6 +255,8 @@ public void Dispose()
 
     Assert.That(device.Session, Is.Null, nameof(device.Session));
 
+    Assert.Throws<ObjectDisposedException>(() => Assert.That(device.EndPoint, Is.Not.Null), nameof(device.EndPoint));
+
 #pragma warning disable CA2012
     Assert.ThrowsAsync<ObjectDisposedException>(async () => await device.ResolveEndPointAsync(), nameof(device.ResolveEndPointAsync));
     Assert.Throws<ObjectDisposedException>(() => device.ResolveEndPointAsync(), nameof(device.ResolveEndPointAsync));