github/Bose-SoundTouch
1
0
Fork 0
mirror of https://github.com/gesellix/Bose-SoundTouch.git synced 2026-08-19 00:56:16 +00:00
Code Issues Packages Projects Releases Wiki Activity

test(discovery): optimize discovery tests for faster execution

Browse Source 
Reduces `pkg/discovery` test suite runtime by ~75% (from ~17s to ~4s) by eliminating unnecessary network timeouts and reducing wait intervals.

- Refactor `discovery.Service` to use an injectable `http.Client`, allowing UPnP enrichment tests to use `httptest.Server` instead of waiting for 5s network timeouts.
- Make `DNSDiscovery` forward timeout configurable and reduce it from 2s to 100ms in unit tests.
- Decrease discovery and context timeouts in mDNS and Unified discovery tests to the minimum required for stable verification (typically 100-200ms).
This commit is contained in:
Tobias Gesellchen
2026-02-22 23:40:51 +01:00
parent 403e2275dc
commit be762dbc22
7 changed files with 62 additions and 45 deletions
Download Patch File Download Diff File Expand all files Collapse all files
pkg/discovery/dns.go
+5 -1
View File
@@ -32,6 +32,9 @@ type DNSDiscovery struct {
// Address for loop prevention
bindAddr string
// Forward timeout
timeout time.Duration
// Log throttling
lastLog map[string]time.Time
lastLogMu sync.Mutex
@@ -54,6 +57,7 @@ func NewDNSDiscovery(upstreamDNS []string, serviceIP string) *DNSDiscovery {
upstreamDNS: upstreamDNS,
serviceIP: serviceIP,
discovered: make(map[string]*DiscoveredHost),
timeout: 2 * time.Second,
lastLog: make(map[string]time.Time),
}
}
@@ -295,7 +299,7 @@ func (d *DNSDiscovery) forward(w dns.ResponseWriter, r *dns.Msg) {
}
c := new(dns.Client)
c.Timeout = 2 * time.Second
c.Timeout = d.timeout
for _, upstream := range d.upstreamDNS {
// Add port 53 if not present
pkg/discovery/dns_test.go
+3 -2
View File
@@ -400,6 +400,7 @@ func TestDNSDiscovery_ForwardTimeout(t *testing.T) {
// Use an IP that is unroutable or doesn't exist on the network to ensure timeout
upstreamDNS := []string{"192.0.2.1:53"} // TEST-NET-1, usually non-routable
d := NewDNSDiscovery(upstreamDNS, serviceIP)
d.timeout = 100 * time.Millisecond
m := new(dns.Msg)
m.SetQuestion("google.com.", dns.TypeA)
@@ -410,8 +411,8 @@ func TestDNSDiscovery_ForwardTimeout(t *testing.T) {
d.forward(rw, m)
duration := time.Since(start)
if duration < 2*time.Second {
t.Errorf("Expected forward to take at least 2 seconds (timeout), but took %v", duration)
if duration < 100*time.Millisecond {
t.Errorf("Expected forward to take at least 100ms (timeout), but took %v", duration)
}
if rw.msg == nil || rw.msg.Rcode != dns.RcodeServerFailure {
pkg/discovery/mdns_test.go
+2 -2
View File
@@ -21,9 +21,9 @@ func TestNewMDNSDiscoveryService(t *testing.T) {
}
func TestMDNSDiscoverDevices(t *testing.T) {
service := NewMDNSDiscoveryService(2 * time.Second)
service := NewMDNSDiscoveryService(100 * time.Millisecond)
ctx, cancel := context.WithTimeout(context.Background(), 3*time.Second)
ctx, cancel := context.WithTimeout(context.Background(), 200*time.Millisecond)
defer cancel()
// Note: This test will attempt actual mDNS discovery
pkg/discovery/unified_test.go
+6 -6
View File
@@ -78,11 +78,11 @@ func TestUnifiedDiscoveryWithCustomConfig(t *testing.T) {
func TestUnifiedDiscoverDevices(t *testing.T) {
cfg := config.DefaultConfig()
cfg.DiscoveryTimeout = 2 * time.Second
cfg.DiscoveryTimeout = 100 * time.Millisecond
cfg.CacheEnabled = false // Disable cache for testing
service := NewUnifiedDiscoveryService(cfg)
ctx, cancel := context.WithTimeout(context.Background(), 5*time.Second)
ctx, cancel := context.WithTimeout(context.Background(), 200*time.Millisecond)
defer cancel()
devices, err := service.DiscoverDevices(ctx)
@@ -119,13 +119,13 @@ func TestUnifiedDiscoverDevices(t *testing.T) {
func TestUnifiedDiscoveryOnlyMDNS(t *testing.T) {
cfg := config.DefaultConfig()
cfg.DiscoveryTimeout = 1 * time.Second
cfg.DiscoveryTimeout = 100 * time.Millisecond
cfg.UPnPEnabled = false // Disable UPnP
cfg.MDNSEnabled = true // Enable only mDNS
cfg.CacheEnabled = false
service := NewUnifiedDiscoveryService(cfg)
ctx, cancel := context.WithTimeout(context.Background(), 3*time.Second)
ctx, cancel := context.WithTimeout(context.Background(), 200*time.Millisecond)
defer cancel()
devices, err := service.DiscoverDevices(ctx)
@@ -141,13 +141,13 @@ func TestUnifiedDiscoveryOnlyMDNS(t *testing.T) {
func TestUnifiedDiscoveryOnlySSDP(t *testing.T) {
cfg := config.DefaultConfig()
cfg.DiscoveryTimeout = 1 * time.Second
cfg.DiscoveryTimeout = 100 * time.Millisecond
cfg.UPnPEnabled = true // Enable only UPnP
cfg.MDNSEnabled = false // Disable mDNS
cfg.CacheEnabled = false
service := NewUnifiedDiscoveryService(cfg)
ctx, cancel := context.WithTimeout(context.Background(), 3*time.Second)
ctx, cancel := context.WithTimeout(context.Background(), 200*time.Millisecond)
defer cancel()
devices, err := service.DiscoverDevices(ctx)
pkg/discovery/upnp.go
+19 -20
View File
@@ -20,11 +20,12 @@ import (
// Service handles UPnP SSDP discovery of SoundTouch devices
type Service struct {
timeout time.Duration
cache map[string]*models.DiscoveredDevice
cacheTTL time.Duration
mutex sync.RWMutex
config *config.Config
timeout time.Duration
cache map[string]*models.DiscoveredDevice
cacheTTL time.Duration
mutex sync.RWMutex
config *config.Config
httpClient *http.Client
}
// NewService creates a new UPnP discovery service
@@ -34,11 +35,12 @@ func NewService(timeout time.Duration) *Service {
}
return &Service{
timeout: timeout,
cache: make(map[string]*models.DiscoveredDevice),
cacheTTL: defaultCacheTTL,
mutex: sync.RWMutex{},
config: config.DefaultConfig(),
timeout: timeout,
cache: make(map[string]*models.DiscoveredDevice),
cacheTTL: defaultCacheTTL,
mutex: sync.RWMutex{},
config: config.DefaultConfig(),
httpClient: &http.Client{Timeout: 5 * time.Second},
}
}
@@ -55,11 +57,12 @@ func NewServiceWithConfig(cfg *config.Config) *Service {
}
return &Service{
timeout: timeout,
cache: make(map[string]*models.DiscoveredDevice),
cacheTTL: cacheTTL,
mutex: sync.RWMutex{},
config: cfg,
timeout: timeout,
cache: make(map[string]*models.DiscoveredDevice),
cacheTTL: cacheTTL,
mutex: sync.RWMutex{},
config: cfg,
httpClient: &http.Client{Timeout: 5 * time.Second},
}
}
@@ -423,11 +426,7 @@ func (d *Service) parseLocationURL(location, usn string) (*models.DiscoveredDevi
func (d *Service) enrichDeviceInfo(device *models.DiscoveredDevice, location string) error {
log.Printf("UPnP: Attempting to enrich device info by fetching %s", location)
client := &http.Client{
Timeout: 5 * time.Second,
}
resp, err := client.Get(location)
resp, err := d.httpClient.Get(location)
if err != nil {
log.Printf("UPnP: Failed to fetch device description from %s: %v", location, err)
return err
pkg/discovery/upnp_enrich_test.go
+3 -1
View File
@@ -6,6 +6,7 @@ import (
"net/http"
"net/http/httptest"
"testing"
"time"
"github.com/gesellix/bose-soundtouch/pkg/models"
)
@@ -32,7 +33,8 @@ func TestEnrichDeviceInfo(t *testing.T) {
Name: "Initial Name",
}
service := &Service{}
service := NewService(1 * time.Second)
service.httpClient = server.Client()
err := service.enrichDeviceInfo(device, server.URL)
if err != nil {
pkg/discovery/upnp_test.go
+24 -13
View File
@@ -2,6 +2,9 @@ package discovery
import (
"context"
"fmt"
"net/http"
"net/http/httptest"
"strings"
"testing"
"time"
@@ -109,18 +112,30 @@ func TestParseLocationURL_Invalid(t *testing.T) {
}
func TestParseResponse_ValidMediaRenderer(t *testing.T) {
service := NewService(1 * time.Second)
xmlPayload := `<?xml version="1.0" encoding="utf-8"?>
<root xmlns="urn:schemas-upnp-org:device-1-0">
<device>
<friendlyName>Test Device</friendlyName>
<modelName>SoundTouch 10</modelName>
<serialNumber>AABBCCDDEEFF</serialNumber>
</device>
</root>`
server := httptest.NewServer(http.HandlerFunc(func(w http.ResponseWriter, r *http.Request) {
w.Header().Set("Content-Type", "text/xml")
fmt.Fprint(w, xmlPayload)
}))
defer server.Close()
validResponse := `HTTP/1.1 200 OK
service := NewService(1 * time.Second)
service.httpClient = server.Client()
validResponse := fmt.Sprintf(`HTTP/1.1 200 OK
Cache-Control: max-age=1800
Date: Mon, 22 Jun 1998 09:55:21 GMT
EXT:
Location: http://192.168.1.100:8090/device.xml
Server: Linux/3.14.0 UPnP/1.0 Bose-SoundTouch/1.0
Location: %s
ST: urn:schemas-upnp-org:device:MediaRenderer:1
USN: uuid:12345678-1234-5678-9012-123456789012::urn:schemas-upnp-org:device:MediaRenderer:1
`
`, server.URL)
device, err := service.parseResponse(validResponse)
if err != nil {
@@ -131,12 +146,8 @@ USN: uuid:12345678-1234-5678-9012-123456789012::urn:schemas-upnp-org:device:Medi
t.Fatal("Expected device, got nil")
}
if device.Host != "192.168.1.100" {
t.Errorf("Expected host '192.168.1.100', got '%s'", device.Host)
}
if device.UPnPLocation != "http://192.168.1.100:8090/device.xml" {
t.Errorf("Expected UPnP location 'http://192.168.1.100:8090/device.xml', got '%s'", device.UPnPLocation)
if device.Name != "Test Device" {
t.Errorf("Expected name 'Test Device', got '%s'", device.Name)
}
}