Skip to content

TESTING.md

Latest commit

 

History

History
164 lines (117 loc) · 6.04 KB

TESTING.md

File metadata and controls

164 lines (117 loc) · 6.04 KB

Arkane.Zeroconf Testing Guide

Overview

This document provides a comprehensive guide to testing the Arkane.Zeroconf library. The test suite includes unit tests, integration tests, platform-specific tests, end-to-end tests, and performance tests.

Test Projects

Arkane.Zeroconf.Tests

The main test project targeting .NET 10.0 with the following test categories:

1. Facade Tests (Facades/)

  • ServiceBrowserTests.cs - Tests for ServiceBrowser wrapper
  • RegisterServiceTests.cs - Tests for RegisterService wrapper
  • TxtRecordTests.cs - Tests for TxtRecord wrapper
  • ZeroconfSupportTests.cs - Tests for capability checks (CanBrowse, CanPublish)

Purpose: Verify that public facade classes correctly delegate to provider implementations, expose provider capability checks, and handle parameter validation.

2. Provider Tests (Providers/)

  • ProviderFactoryTests.cs - Tests for provider discovery and selection
  • WindowsMdnsProviderTests.cs - Tests for Windows fallback provider capability and lookup-only publish behavior
  • SystemdResolvedProviderTests.cs - Tests for Linux systemd-resolved fallback provider capability and publish behavior

Purpose: Verify provider discovery and runtime fallback behavior.

3. Integration Tests (Integration/)

  • BonjourBrowserIntegrationTests.cs - Tests for Bonjour service browsing
  • BonjourRegistrationIntegrationTests.cs - Tests for Bonjour service registration
  • WindowsMdnsBrowserIntegrationTests.cs - Tests Windows DNS-SD fallback service discovery

Purpose: Verify daemon/API integration for both Bonjour and Windows DNS-SD fallback paths.

Requires:

  • Bonjour integration tests:
    • Windows: Bonjour service (Apple Bonjour for Windows)
    • macOS: Built-in mDNS support
    • Linux: Avahi daemon
  • WindowsMdns integration test:
    • Windows 11+ host
    • At least one discoverable mDNS service on the local network

WindowsMdnsBrowserIntegrationTests probes multiple common service types in parallel and passes if at least one returns a service. Override probe types with:

# PowerShell
$env:ARKANE_ZEROCONF_TEST_SERVICE_TYPES = "_http._tcp,_ipp._tcp,_printer._tcp"

4. Platform-Specific Tests (Platform/)

  • PlatformSpecificTests.cs - Tests for platform detection and native interop, including Linux Avahi availability, Linux systemd-resolved availability, and Windows Bonjour/DNS-SD availability

5. End-to-End Tests (E2E/)

  • AzClientE2ETests.cs - Tests using the azclient CLI tool

6. Performance Tests (Performance/)

  • PerformanceAndStressTests.cs - Performance and stress tests

Running Tests

Prerequisites

For unit/facade/provider tests

dotnet test Arkane.Zeroconf.Tests --filter "FullyQualifiedName!~Integration"

For systemd-resolved provider tests (Linux)

# Non-privileged: tests that require publish skip automatically
dotnet test Arkane.Zeroconf.Tests --filter "FullyQualifiedName~SystemdResolvedProviderTests"

# Privileged: enables publish-path tests (requires polkit authorization)
sudo dotnet test Arkane.Zeroconf.Tests --filter "FullyQualifiedName~SystemdResolvedProviderTests"

Note: Running tests under sudo may leave build artifacts (obj/) owned by root. Fix with: sudo find . -path '*/obj/*' | xargs sudo chown $USER

For Windows DNS-SD fallback integration test

dotnet test Arkane.Zeroconf.Tests --filter "FullyQualifiedName~WindowsMdnsBrowserIntegrationTests"

Optional service type override:

# PowerShell
$env:ARKANE_ZEROCONF_TEST_SERVICE_TYPES = "_http._tcp;_ssh._tcp"
dotnet test Arkane.Zeroconf.Tests --filter "FullyQualifiedName~WindowsMdnsBrowserIntegrationTests"

For Bonjour integration tests

You need an mDNS daemon running:

Windows:

  1. Download Bonjour from Apple (Bonjour for Windows)
  2. Install the service
  3. Verify the "Bonjour Service" is running in Services

macOS:

  • Built-in support, no installation needed

Linux:

# Ubuntu/Debian
sudo apt-get install avahi-daemon

# Fedora/RHEL
sudo dnf install avahi

# Start the daemon
sudo systemctl start avahi-daemon

Common commands

# Run all tests
dotnet test Arkane.Zeroconf.Tests

# Run only integration tests
dotnet test Arkane.Zeroconf.Tests --filter "Arkane.Zeroconf.Tests.Integration"

# Run only Windows fallback integration test
dotnet test Arkane.Zeroconf.Tests --filter "FullyQualifiedName~WindowsMdnsBrowserIntegrationTests"

# Run systemd-resolved provider tests (with sudo for publish paths)
sudo dotnet test Arkane.Zeroconf.Tests --filter "FullyQualifiedName~SystemdResolvedProviderTests"

# Run with detailed output
dotnet test Arkane.Zeroconf.Tests -v n

# Run with code coverage
dotnet-coverage collect -f cobertura -o coverage.cobertura.xml dotnet test Arkane.Zeroconf.Tests

Troubleshooting

Windows fallback integration test fails quickly with no discoveries

  • Ensure network has discoverable mDNS services.
  • Override ARKANE_ZEROCONF_TEST_SERVICE_TYPES to match your environment.
  • Check local firewall prompts/allow rules for test process network access.

"No Zeroconf providers could be found"

  • Bonjour unavailable and no supported fallback available for current OS.
  • On Windows, fallback lookup requires Windows 11+.
  • On Linux, ensure systemd-resolved is running and MulticastDNS is not no in /etc/systemd/resolved.conf.

Publishing fails on Windows fallback provider

  • Expected behavior (PlatformNotSupportedException).
  • Check ZeroconfSupport.CanPublish before attempting publish.

Publishing fails on Linux systemd-resolved fallback provider

  • Check ZeroconfSupport.CanPublish — if false, polkit denied authorization.
  • Run with sudo or configure a polkit rule for org.freedesktop.resolve1.
  • Ensure MulticastDNS=yes (not just resolve) in /etc/systemd/resolved.conf.

SystemdResolved tests are all skipped

  • The provider is only available on Linux with systemd-resolved running and MulticastDNS ≠ no.
  • Check: systemctl status systemd-resolved and resolvectl status | grep -i multicast.