Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Add MeaMod tests for Discover / Drop OSCQuery Services #57

Open
wants to merge 3 commits into
base: main
Choose a base branch
from
+70 −0
Open

Add MeaMod tests for Discover / Drop OSCQuery Services #57

Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
4265a57
Adds service discovery tests for MeaModDiscovery
momo-the-monster Feb 26, 2024
399e5c9
Merge remote-tracking branch 'origin/main' into feature/rus
momo-the-monster Feb 26, 2024
ceb2c4b
Improves comments in MeaModDiscoveryTests
momo-the-monster Feb 26, 2024
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
70 changes: 70 additions & 0 deletions Tests/vrc-oscquery-tests/MeaModDiscoveryTests.cs
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,70 @@
using System.Net;

namespace VRC.OSCQuery.Tests;

public class MeaModDiscoveryTests
{
private const int DELAY_TIME_MS = 1000;

[Test]
public async Task Discovery_WhenOSCQueryServiceAdvertised_ContainsService()
{
// Set up Advertising and Discovery
var advertiser = new MeaModDiscovery();
var discoverer = new MeaModDiscovery();
var oscQueryServiceProfile = new OSCQueryServiceProfile
(
Guid.NewGuid().ToString(),
IPAddress.Loopback,
Extensions.GetAvailableTcpPort(),
OSCQueryServiceProfile.ServiceType.OSCQuery
);

// Advertise the service, Refresh the services, and wait for the service to be discovered
advertiser.Advertise(oscQueryServiceProfile);
await Task.Delay(DELAY_TIME_MS); // Wait for the service to be advertised
discoverer.RefreshServices();
await Task.Delay(DELAY_TIME_MS); // Wait for the service to be discovered
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

can we not use the other side of MDNS here and just wait for a service to appear in the callback? We could kick it off as 2 tasks one which simply resolves after X maximum test timeout (e.g. 5 seconds) and the other as soon as the service is found?

Instead of just waiting a flat amount

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I tried that approach, making a TaskCancellationSource which resolves once the right service is found, or times out if it's not. It worked once and failed 5 times, whereas this approach worked every time for me. I don't love this approach, though.

I looked up the actual MeaMod Tests at the end of this weekend programming session - too late for another refactor on that day but probably worth investigating to see how they test things.


// Assert that the service was discovered
var discoveredServices = discoverer.GetOSCQueryServices();
Assert.Contains(oscQueryServiceProfile, discoveredServices.ToList());

// Stop advertising the service
advertiser.Unadvertise(oscQueryServiceProfile);
}

[Test]
public async Task Discovery_WhenOSCQueryServiceUnadvertised_DoesNotContainService()
{
// Set up Advertising and Discovery
var advertiser = new MeaModDiscovery();
var discoverer = new MeaModDiscovery();
var oscQueryServiceProfile = new OSCQueryServiceProfile
(
Guid.NewGuid().ToString(),
IPAddress.Loopback,
Extensions.GetAvailableTcpPort(),
OSCQueryServiceProfile.ServiceType.OSCQuery
);

// Advertise the service, Refresh the services, and wait for the service to be discovered
advertiser.Advertise(oscQueryServiceProfile);
await Task.Delay(DELAY_TIME_MS); // Wait for the service to be advertised
discoverer.RefreshServices();
await Task.Delay(DELAY_TIME_MS); // Wait for the service to be discovered

// Assert that the service was discovered
var discoveredServices = discoverer.GetOSCQueryServices();
Assert.Contains(oscQueryServiceProfile, discoveredServices.ToList());

// Stop advertising the service, Refresh the services, and wait for the service to be disconnected
advertiser.Unadvertise(oscQueryServiceProfile);
discoverer.RefreshServices();
await Task.Delay(DELAY_TIME_MS); // Wait for the service to be disconnected

// Assert that the service is no longer in the list
discoveredServices = discoverer.GetOSCQueryServices();
Assert.IsFalse(discoveredServices.Contains(oscQueryServiceProfile));
}
}
Loading