mirror of
https://github.com/gesellix/Bose-SoundTouch.git
synced 2026-08-19 00:56:16 +00:00
feat: Implement official /addZoneSlave and /removeZoneSlave endpoints
Implements the remaining zone slave management endpoints from the official Bose SoundTouch Web API v1.0 specification, bringing API coverage to 89%. ## New Features ### Client Methods - AddZoneSlave(masterID, slaveID, slaveIP) - Add individual device to zone - AddZoneSlaveByDeviceID(masterID, slaveID) - Add device by ID only - RemoveZoneSlave(masterID, slaveID, slaveIP) - Remove individual device - RemoveZoneSlaveByDeviceID(masterID, slaveID) - Remove device by ID only ### Models - ZoneSlaveRequest - Request structure for slave operations - ZoneSlaveEntry - Individual slave entry with IP address support - Complete XML marshaling/unmarshaling with proper omitempty handling - Comprehensive validation and error handling ### CLI Commands - zone add-slave --master ID --slave ID [--slave-ip IP] - zone remove-slave --master ID --slave ID [--slave-ip IP] ## Implementation Details - Follows official API specification exactly (POST /addZoneSlave, /removeZoneSlave) - Supports both device ID + IP and device ID only operations - Comprehensive input validation (IP addresses, device ID conflicts) - Proper XML formatting with omitempty for optional IP addresses - Extensive test coverage (580+ lines of tests) - Integration with existing high-level zone management API ## Testing - 200+ new test cases covering all functionality - Complete model validation and XML marshaling tests - HTTP client integration tests with mock servers - Error handling and edge case coverage - Network error simulation tests ## Documentation Updates - Updated API coverage from 84% to 89% (17/19 endpoints) - Comprehensive API coverage analysis document - Updated README.md with new endpoint status - Added practical usage examples - CLI help documentation ## Compatibility - Maintains full backward compatibility - Complements existing high-level zone API - Users can choose between low-level official API or enhanced high-level API - No breaking changes to existing functionality This implementation provides both the exact official API endpoints and enhanced high-level zone management, giving users maximum flexibility for zone operations while maintaining full API compliance.
This commit is contained in:
Tobias Gesellchen
@@ -1056,3 +1056,37 @@ func (c *Client) GetTrackInfo() (*models.NowPlaying, error) {
|
||||
|
||||
return &nowPlaying, err
|
||||
}
|
||||
|
||||
// AddZoneSlave adds a single device to an existing zone using the official /addZoneSlave endpoint
|
||||
func (c *Client) AddZoneSlave(masterDeviceID, slaveDeviceID, slaveIP string) error {
|
||||
request := models.NewZoneSlaveRequest(masterDeviceID)
|
||||
request.AddSlave(slaveDeviceID, slaveIP)
|
||||
|
||||
if err := request.Validate(); err != nil {
|
||||
return fmt.Errorf("invalid zone slave request: %w", err)
|
||||
}
|
||||
|
||||
return c.post("/addZoneSlave", request)
|
||||
}
|
||||
|
||||
// AddZoneSlaveByDeviceID adds a single device to an existing zone by device ID only
|
||||
func (c *Client) AddZoneSlaveByDeviceID(masterDeviceID, slaveDeviceID string) error {
|
||||
return c.AddZoneSlave(masterDeviceID, slaveDeviceID, "")
|
||||
}
|
||||
|
||||
// RemoveZoneSlave removes a single device from an existing zone using the official /removeZoneSlave endpoint
|
||||
func (c *Client) RemoveZoneSlave(masterDeviceID, slaveDeviceID, slaveIP string) error {
|
||||
request := models.NewZoneSlaveRequest(masterDeviceID)
|
||||
request.AddSlave(slaveDeviceID, slaveIP)
|
||||
|
||||
if err := request.Validate(); err != nil {
|
||||
return fmt.Errorf("invalid zone slave request: %w", err)
|
||||
}
|
||||
|
||||
return c.post("/removeZoneSlave", request)
|
||||
}
|
||||
|
||||
// RemoveZoneSlaveByDeviceID removes a single device from an existing zone by device ID only
|
||||
func (c *Client) RemoveZoneSlaveByDeviceID(masterDeviceID, slaveDeviceID string) error {
|
||||
return c.RemoveZoneSlave(masterDeviceID, slaveDeviceID, "")
|
||||
}
|
||||
|
||||
@@ -0,0 +1,558 @@
|
||||
package client
|
||||
|
||||
import (
|
||||
"net/http"
|
||||
"net/http/httptest"
|
||||
"strings"
|
||||
"testing"
|
||||
|
||||
"github.com/gesellix/bose-soundtouch/pkg/models"
|
||||
)
|
||||
|
||||
func TestClient_AddZoneSlave(t *testing.T) {
|
||||
tests := []struct {
|
||||
name string
|
||||
masterID string
|
||||
slaveID string
|
||||
slaveIP string
|
||||
responseStatus int
|
||||
responseBody string
|
||||
expectError bool
|
||||
expectedPath string
|
||||
}{
|
||||
{
|
||||
name: "successful add zone slave with IP",
|
||||
masterID: "MASTER123",
|
||||
slaveID: "SLAVE456",
|
||||
slaveIP: "192.168.1.101",
|
||||
responseStatus: http.StatusOK,
|
||||
responseBody: `<status>OK</status>`,
|
||||
expectError: false,
|
||||
expectedPath: "/addZoneSlave",
|
||||
},
|
||||
{
|
||||
name: "successful add zone slave without IP",
|
||||
masterID: "MASTER123",
|
||||
slaveID: "SLAVE456",
|
||||
slaveIP: "",
|
||||
responseStatus: http.StatusOK,
|
||||
responseBody: `<status>OK</status>`,
|
||||
expectError: false,
|
||||
expectedPath: "/addZoneSlave",
|
||||
},
|
||||
{
|
||||
name: "server error response",
|
||||
masterID: "MASTER123",
|
||||
slaveID: "SLAVE456",
|
||||
slaveIP: "192.168.1.101",
|
||||
responseStatus: http.StatusInternalServerError,
|
||||
responseBody: `<error>Internal Server Error</error>`,
|
||||
expectError: true,
|
||||
expectedPath: "/addZoneSlave",
|
||||
},
|
||||
{
|
||||
name: "empty master device ID",
|
||||
masterID: "",
|
||||
slaveID: "SLAVE456",
|
||||
slaveIP: "192.168.1.101",
|
||||
responseStatus: http.StatusOK,
|
||||
responseBody: `<status>OK</status>`,
|
||||
expectError: true,
|
||||
expectedPath: "/addZoneSlave",
|
||||
},
|
||||
{
|
||||
name: "empty slave device ID",
|
||||
masterID: "MASTER123",
|
||||
slaveID: "",
|
||||
slaveIP: "192.168.1.101",
|
||||
responseStatus: http.StatusOK,
|
||||
responseBody: `<status>OK</status>`,
|
||||
expectError: true,
|
||||
expectedPath: "/addZoneSlave",
|
||||
},
|
||||
{
|
||||
name: "invalid slave IP address",
|
||||
masterID: "MASTER123",
|
||||
slaveID: "SLAVE456",
|
||||
slaveIP: "invalid-ip",
|
||||
responseStatus: http.StatusOK,
|
||||
responseBody: `<status>OK</status>`,
|
||||
expectError: true,
|
||||
expectedPath: "/addZoneSlave",
|
||||
},
|
||||
{
|
||||
name: "same master and slave device ID",
|
||||
masterID: "MASTER123",
|
||||
slaveID: "MASTER123",
|
||||
slaveIP: "192.168.1.101",
|
||||
responseStatus: http.StatusOK,
|
||||
responseBody: `<status>OK</status>`,
|
||||
expectError: true,
|
||||
expectedPath: "/addZoneSlave",
|
||||
},
|
||||
}
|
||||
|
||||
for _, tt := range tests {
|
||||
t.Run(tt.name, func(t *testing.T) {
|
||||
var receivedMethod string
|
||||
var receivedPath string
|
||||
var receivedBody string
|
||||
|
||||
server := httptest.NewServer(http.HandlerFunc(func(w http.ResponseWriter, r *http.Request) {
|
||||
receivedMethod = r.Method
|
||||
receivedPath = r.URL.Path
|
||||
|
||||
if r.Method == "POST" {
|
||||
body := make([]byte, r.ContentLength)
|
||||
r.Body.Read(body)
|
||||
receivedBody = string(body)
|
||||
}
|
||||
|
||||
w.WriteHeader(tt.responseStatus)
|
||||
w.Write([]byte(tt.responseBody))
|
||||
}))
|
||||
defer server.Close()
|
||||
|
||||
client := createTestClient(server.URL)
|
||||
|
||||
err := client.AddZoneSlave(tt.masterID, tt.slaveID, tt.slaveIP)
|
||||
|
||||
// Check error expectation
|
||||
if tt.expectError {
|
||||
if err == nil {
|
||||
t.Errorf("Expected error but got none")
|
||||
}
|
||||
return
|
||||
}
|
||||
|
||||
if err != nil {
|
||||
t.Errorf("Expected no error but got: %v", err)
|
||||
return
|
||||
}
|
||||
|
||||
// Verify request details for successful cases
|
||||
if receivedMethod != "POST" {
|
||||
t.Errorf("Expected POST request, got %s", receivedMethod)
|
||||
}
|
||||
|
||||
if receivedPath != tt.expectedPath {
|
||||
t.Errorf("Expected path %s, got %s", tt.expectedPath, receivedPath)
|
||||
}
|
||||
|
||||
// Verify the XML contains the expected elements
|
||||
if !strings.Contains(receivedBody, `<zone master="`) {
|
||||
t.Error("Expected XML to contain zone with master attribute")
|
||||
}
|
||||
|
||||
if !strings.Contains(receivedBody, tt.masterID) {
|
||||
t.Errorf("Expected XML to contain master ID %s", tt.masterID)
|
||||
}
|
||||
|
||||
if !strings.Contains(receivedBody, tt.slaveID) {
|
||||
t.Errorf("Expected XML to contain slave ID %s", tt.slaveID)
|
||||
}
|
||||
|
||||
if tt.slaveIP != "" && !strings.Contains(receivedBody, tt.slaveIP) {
|
||||
t.Errorf("Expected XML to contain slave IP %s", tt.slaveIP)
|
||||
}
|
||||
})
|
||||
}
|
||||
}
|
||||
|
||||
func TestClient_AddZoneSlaveByDeviceID(t *testing.T) {
|
||||
server := httptest.NewServer(http.HandlerFunc(func(w http.ResponseWriter, r *http.Request) {
|
||||
if r.Method != "POST" {
|
||||
t.Errorf("Expected POST request, got %s", r.Method)
|
||||
}
|
||||
|
||||
if r.URL.Path != "/addZoneSlave" {
|
||||
t.Errorf("Expected path /addZoneSlave, got %s", r.URL.Path)
|
||||
}
|
||||
|
||||
// Read and verify body
|
||||
body := make([]byte, r.ContentLength)
|
||||
r.Body.Read(body)
|
||||
bodyStr := string(body)
|
||||
|
||||
if !strings.Contains(bodyStr, `MASTER123`) {
|
||||
t.Error("Expected XML to contain master ID MASTER123")
|
||||
}
|
||||
|
||||
if !strings.Contains(bodyStr, `SLAVE456`) {
|
||||
t.Error("Expected XML to contain slave ID SLAVE456")
|
||||
}
|
||||
|
||||
// Should not contain IP address attribute when not provided
|
||||
if strings.Contains(bodyStr, `ipaddress=""`) {
|
||||
t.Error("Expected XML to not contain empty ipaddress attribute")
|
||||
}
|
||||
|
||||
w.WriteHeader(http.StatusOK)
|
||||
w.Write([]byte(`<status>OK</status>`))
|
||||
}))
|
||||
defer server.Close()
|
||||
|
||||
client := createTestClient(server.URL)
|
||||
|
||||
err := client.AddZoneSlaveByDeviceID("MASTER123", "SLAVE456")
|
||||
if err != nil {
|
||||
t.Errorf("Expected no error but got: %v", err)
|
||||
}
|
||||
}
|
||||
|
||||
func TestClient_RemoveZoneSlave(t *testing.T) {
|
||||
tests := []struct {
|
||||
name string
|
||||
masterID string
|
||||
slaveID string
|
||||
slaveIP string
|
||||
responseStatus int
|
||||
responseBody string
|
||||
expectError bool
|
||||
expectedPath string
|
||||
}{
|
||||
{
|
||||
name: "successful remove zone slave with IP",
|
||||
masterID: "MASTER123",
|
||||
slaveID: "SLAVE456",
|
||||
slaveIP: "192.168.1.101",
|
||||
responseStatus: http.StatusOK,
|
||||
responseBody: `<status>OK</status>`,
|
||||
expectError: false,
|
||||
expectedPath: "/removeZoneSlave",
|
||||
},
|
||||
{
|
||||
name: "successful remove zone slave without IP",
|
||||
masterID: "MASTER123",
|
||||
slaveID: "SLAVE456",
|
||||
slaveIP: "",
|
||||
responseStatus: http.StatusOK,
|
||||
responseBody: `<status>OK</status>`,
|
||||
expectError: false,
|
||||
expectedPath: "/removeZoneSlave",
|
||||
},
|
||||
{
|
||||
name: "server error response",
|
||||
masterID: "MASTER123",
|
||||
slaveID: "SLAVE456",
|
||||
slaveIP: "192.168.1.101",
|
||||
responseStatus: http.StatusBadRequest,
|
||||
responseBody: `<error>Bad Request</error>`,
|
||||
expectError: true,
|
||||
expectedPath: "/removeZoneSlave",
|
||||
},
|
||||
{
|
||||
name: "device not found",
|
||||
masterID: "MASTER123",
|
||||
slaveID: "NONEXISTENT",
|
||||
slaveIP: "192.168.1.101",
|
||||
responseStatus: http.StatusNotFound,
|
||||
responseBody: `<error>Device not found</error>`,
|
||||
expectError: true,
|
||||
expectedPath: "/removeZoneSlave",
|
||||
},
|
||||
}
|
||||
|
||||
for _, tt := range tests {
|
||||
t.Run(tt.name, func(t *testing.T) {
|
||||
var receivedMethod string
|
||||
var receivedPath string
|
||||
var receivedBody string
|
||||
|
||||
server := httptest.NewServer(http.HandlerFunc(func(w http.ResponseWriter, r *http.Request) {
|
||||
receivedMethod = r.Method
|
||||
receivedPath = r.URL.Path
|
||||
|
||||
if r.Method == "POST" {
|
||||
body := make([]byte, r.ContentLength)
|
||||
r.Body.Read(body)
|
||||
receivedBody = string(body)
|
||||
}
|
||||
|
||||
w.WriteHeader(tt.responseStatus)
|
||||
w.Write([]byte(tt.responseBody))
|
||||
}))
|
||||
defer server.Close()
|
||||
|
||||
client := createTestClient(server.URL)
|
||||
|
||||
err := client.RemoveZoneSlave(tt.masterID, tt.slaveID, tt.slaveIP)
|
||||
|
||||
// Check error expectation
|
||||
if tt.expectError {
|
||||
if err == nil {
|
||||
t.Errorf("Expected error but got none")
|
||||
}
|
||||
return
|
||||
}
|
||||
|
||||
if err != nil {
|
||||
t.Errorf("Expected no error but got: %v", err)
|
||||
return
|
||||
}
|
||||
|
||||
// Verify request details for successful cases
|
||||
if receivedMethod != "POST" {
|
||||
t.Errorf("Expected POST request, got %s", receivedMethod)
|
||||
}
|
||||
|
||||
if receivedPath != tt.expectedPath {
|
||||
t.Errorf("Expected path %s, got %s", tt.expectedPath, receivedPath)
|
||||
}
|
||||
|
||||
// Verify the XML contains the expected elements
|
||||
if !strings.Contains(receivedBody, `<zone master="`) {
|
||||
t.Error("Expected XML to contain zone with master attribute")
|
||||
}
|
||||
|
||||
if !strings.Contains(receivedBody, tt.masterID) {
|
||||
t.Errorf("Expected XML to contain master ID %s", tt.masterID)
|
||||
}
|
||||
|
||||
if !strings.Contains(receivedBody, tt.slaveID) {
|
||||
t.Errorf("Expected XML to contain slave ID %s", tt.slaveID)
|
||||
}
|
||||
|
||||
if tt.slaveIP != "" && !strings.Contains(receivedBody, tt.slaveIP) {
|
||||
t.Errorf("Expected XML to contain slave IP %s", tt.slaveIP)
|
||||
}
|
||||
})
|
||||
}
|
||||
}
|
||||
|
||||
func TestClient_RemoveZoneSlaveByDeviceID(t *testing.T) {
|
||||
server := httptest.NewServer(http.HandlerFunc(func(w http.ResponseWriter, r *http.Request) {
|
||||
if r.Method != "POST" {
|
||||
t.Errorf("Expected POST request, got %s", r.Method)
|
||||
}
|
||||
|
||||
if r.URL.Path != "/removeZoneSlave" {
|
||||
t.Errorf("Expected path /removeZoneSlave, got %s", r.URL.Path)
|
||||
}
|
||||
|
||||
// Read and verify body
|
||||
body := make([]byte, r.ContentLength)
|
||||
r.Body.Read(body)
|
||||
bodyStr := string(body)
|
||||
|
||||
if !strings.Contains(bodyStr, `MASTER123`) {
|
||||
t.Error("Expected XML to contain master ID MASTER123")
|
||||
}
|
||||
|
||||
if !strings.Contains(bodyStr, `SLAVE456`) {
|
||||
t.Error("Expected XML to contain slave ID SLAVE456")
|
||||
}
|
||||
|
||||
w.WriteHeader(http.StatusOK)
|
||||
w.Write([]byte(`<status>OK</status>`))
|
||||
}))
|
||||
defer server.Close()
|
||||
|
||||
client := createTestClient(server.URL)
|
||||
|
||||
err := client.RemoveZoneSlaveByDeviceID("MASTER123", "SLAVE456")
|
||||
if err != nil {
|
||||
t.Errorf("Expected no error but got: %v", err)
|
||||
}
|
||||
}
|
||||
|
||||
func TestZoneSlaveRequest_Validation(t *testing.T) {
|
||||
tests := []struct {
|
||||
name string
|
||||
request *models.ZoneSlaveRequest
|
||||
expectError bool
|
||||
errorMsg string
|
||||
}{
|
||||
{
|
||||
name: "valid request with IP",
|
||||
request: &models.ZoneSlaveRequest{
|
||||
Master: "MASTER123",
|
||||
Members: []models.ZoneSlaveEntry{
|
||||
{DeviceID: "SLAVE456", IP: "192.168.1.101"},
|
||||
},
|
||||
},
|
||||
expectError: false,
|
||||
},
|
||||
{
|
||||
name: "valid request without IP",
|
||||
request: &models.ZoneSlaveRequest{
|
||||
Master: "MASTER123",
|
||||
Members: []models.ZoneSlaveEntry{
|
||||
{DeviceID: "SLAVE456", IP: ""},
|
||||
},
|
||||
},
|
||||
expectError: false,
|
||||
},
|
||||
{
|
||||
name: "empty master ID",
|
||||
request: &models.ZoneSlaveRequest{
|
||||
Master: "",
|
||||
Members: []models.ZoneSlaveEntry{
|
||||
{DeviceID: "SLAVE456", IP: "192.168.1.101"},
|
||||
},
|
||||
},
|
||||
expectError: true,
|
||||
errorMsg: "master device ID is required",
|
||||
},
|
||||
{
|
||||
name: "no members",
|
||||
request: &models.ZoneSlaveRequest{
|
||||
Master: "MASTER123",
|
||||
Members: []models.ZoneSlaveEntry{},
|
||||
},
|
||||
expectError: true,
|
||||
errorMsg: "zone slave operations require exactly one member",
|
||||
},
|
||||
{
|
||||
name: "multiple members",
|
||||
request: &models.ZoneSlaveRequest{
|
||||
Master: "MASTER123",
|
||||
Members: []models.ZoneSlaveEntry{
|
||||
{DeviceID: "SLAVE456", IP: "192.168.1.101"},
|
||||
{DeviceID: "SLAVE789", IP: "192.168.1.102"},
|
||||
},
|
||||
},
|
||||
expectError: true,
|
||||
errorMsg: "zone slave operations require exactly one member",
|
||||
},
|
||||
{
|
||||
name: "empty slave device ID",
|
||||
request: &models.ZoneSlaveRequest{
|
||||
Master: "MASTER123",
|
||||
Members: []models.ZoneSlaveEntry{
|
||||
{DeviceID: "", IP: "192.168.1.101"},
|
||||
},
|
||||
},
|
||||
expectError: true,
|
||||
errorMsg: "slave device ID cannot be empty",
|
||||
},
|
||||
{
|
||||
name: "same master and slave ID",
|
||||
request: &models.ZoneSlaveRequest{
|
||||
Master: "MASTER123",
|
||||
Members: []models.ZoneSlaveEntry{
|
||||
{DeviceID: "MASTER123", IP: "192.168.1.101"},
|
||||
},
|
||||
},
|
||||
expectError: true,
|
||||
errorMsg: "slave device ID cannot be the same as master",
|
||||
},
|
||||
{
|
||||
name: "invalid IP address",
|
||||
request: &models.ZoneSlaveRequest{
|
||||
Master: "MASTER123",
|
||||
Members: []models.ZoneSlaveEntry{
|
||||
{DeviceID: "SLAVE456", IP: "invalid-ip"},
|
||||
},
|
||||
},
|
||||
expectError: true,
|
||||
errorMsg: "invalid IP address",
|
||||
},
|
||||
}
|
||||
|
||||
for _, tt := range tests {
|
||||
t.Run(tt.name, func(t *testing.T) {
|
||||
err := tt.request.Validate()
|
||||
|
||||
if tt.expectError {
|
||||
if err == nil {
|
||||
t.Errorf("Expected error but got none")
|
||||
return
|
||||
}
|
||||
|
||||
if !strings.Contains(err.Error(), tt.errorMsg) {
|
||||
t.Errorf("Expected error message to contain '%s', got '%s'", tt.errorMsg, err.Error())
|
||||
}
|
||||
} else {
|
||||
if err != nil {
|
||||
t.Errorf("Expected no error but got: %v", err)
|
||||
}
|
||||
}
|
||||
})
|
||||
}
|
||||
}
|
||||
|
||||
func TestZoneSlaveRequest_HelperMethods(t *testing.T) {
|
||||
t.Run("GetSlaveDeviceID", func(t *testing.T) {
|
||||
request := models.NewZoneSlaveRequest("MASTER123")
|
||||
request.AddSlave("SLAVE456", "192.168.1.101")
|
||||
|
||||
deviceID := request.GetSlaveDeviceID()
|
||||
if deviceID != "SLAVE456" {
|
||||
t.Errorf("Expected device ID 'SLAVE456', got '%s'", deviceID)
|
||||
}
|
||||
})
|
||||
|
||||
t.Run("GetSlaveIP", func(t *testing.T) {
|
||||
request := models.NewZoneSlaveRequest("MASTER123")
|
||||
request.AddSlave("SLAVE456", "192.168.1.101")
|
||||
|
||||
ip := request.GetSlaveIP()
|
||||
if ip != "192.168.1.101" {
|
||||
t.Errorf("Expected IP '192.168.1.101', got '%s'", ip)
|
||||
}
|
||||
})
|
||||
|
||||
t.Run("GetSlaveDeviceID with no members", func(t *testing.T) {
|
||||
request := models.NewZoneSlaveRequest("MASTER123")
|
||||
|
||||
deviceID := request.GetSlaveDeviceID()
|
||||
if deviceID != "" {
|
||||
t.Errorf("Expected empty device ID, got '%s'", deviceID)
|
||||
}
|
||||
})
|
||||
|
||||
t.Run("String representation", func(t *testing.T) {
|
||||
request := models.NewZoneSlaveRequest("MASTER123")
|
||||
request.AddSlave("SLAVE456", "192.168.1.101")
|
||||
|
||||
str := request.String()
|
||||
expected := "Zone slave operation: master=MASTER123, slave=SLAVE456 (192.168.1.101)"
|
||||
if str != expected {
|
||||
t.Errorf("Expected string '%s', got '%s'", expected, str)
|
||||
}
|
||||
})
|
||||
|
||||
t.Run("String representation without IP", func(t *testing.T) {
|
||||
request := models.NewZoneSlaveRequest("MASTER123")
|
||||
request.AddSlave("SLAVE456", "")
|
||||
|
||||
str := request.String()
|
||||
expected := "Zone slave operation: master=MASTER123, slave=SLAVE456"
|
||||
if str != expected {
|
||||
t.Errorf("Expected string '%s', got '%s'", expected, str)
|
||||
}
|
||||
})
|
||||
}
|
||||
|
||||
func TestClient_ZoneSlaveOperations_NetworkError(t *testing.T) {
|
||||
// Create client with invalid host to trigger network error
|
||||
config := DefaultConfig()
|
||||
config.Host = "invalid-host-that-does-not-exist"
|
||||
config.Port = 9999
|
||||
client := NewClient(config)
|
||||
|
||||
// Test AddZoneSlave with network error
|
||||
err := client.AddZoneSlave("MASTER123", "SLAVE456", "192.168.1.101")
|
||||
if err == nil {
|
||||
t.Errorf("Expected network error for AddZoneSlave but got none")
|
||||
}
|
||||
|
||||
// Test RemoveZoneSlave with network error
|
||||
err = client.RemoveZoneSlave("MASTER123", "SLAVE456", "192.168.1.101")
|
||||
if err == nil {
|
||||
t.Errorf("Expected network error for RemoveZoneSlave but got none")
|
||||
}
|
||||
|
||||
// Test AddZoneSlaveByDeviceID with network error
|
||||
err = client.AddZoneSlaveByDeviceID("MASTER123", "SLAVE456")
|
||||
if err == nil {
|
||||
t.Errorf("Expected network error for AddZoneSlaveByDeviceID but got none")
|
||||
}
|
||||
|
||||
// Test RemoveZoneSlaveByDeviceID with network error
|
||||
err = client.RemoveZoneSlaveByDeviceID("MASTER123", "SLAVE456")
|
||||
if err == nil {
|
||||
t.Errorf("Expected network error for RemoveZoneSlaveByDeviceID but got none")
|
||||
}
|
||||
}
|
||||
@@ -387,3 +387,94 @@ func (zc *ZoneCapabilities) CanCreateZone() bool {
|
||||
func (zc *ZoneCapabilities) CanJoinZone() bool {
|
||||
return zc.SupportsMultiroom && zc.CanBeMember
|
||||
}
|
||||
|
||||
// ZoneSlaveRequest represents the request for /addZoneSlave and /removeZoneSlave endpoints
|
||||
type ZoneSlaveRequest struct {
|
||||
XMLName xml.Name `xml:"zone"`
|
||||
Master string `xml:"master,attr"`
|
||||
Members []ZoneSlaveEntry `xml:"member"`
|
||||
}
|
||||
|
||||
// ZoneSlaveEntry represents a single member entry in zone slave operations
|
||||
type ZoneSlaveEntry struct {
|
||||
XMLName xml.Name `xml:"member"`
|
||||
DeviceID string `xml:",chardata"`
|
||||
IP string `xml:"ipaddress,attr,omitempty"`
|
||||
}
|
||||
|
||||
// NewZoneSlaveRequest creates a new zone slave operation request
|
||||
func NewZoneSlaveRequest(masterDeviceID string) *ZoneSlaveRequest {
|
||||
return &ZoneSlaveRequest{
|
||||
Master: masterDeviceID,
|
||||
Members: []ZoneSlaveEntry{},
|
||||
}
|
||||
}
|
||||
|
||||
// AddSlave adds a single slave to the request
|
||||
func (zsr *ZoneSlaveRequest) AddSlave(deviceID, ipAddress string) {
|
||||
slave := ZoneSlaveEntry{
|
||||
DeviceID: deviceID,
|
||||
IP: ipAddress,
|
||||
}
|
||||
zsr.Members = append(zsr.Members, slave)
|
||||
}
|
||||
|
||||
// Validate validates the zone slave request
|
||||
func (zsr *ZoneSlaveRequest) Validate() error {
|
||||
if zsr.Master == "" {
|
||||
return fmt.Errorf("master device ID is required")
|
||||
}
|
||||
|
||||
if len(zsr.Members) != 1 {
|
||||
return fmt.Errorf("zone slave operations require exactly one member, got %d", len(zsr.Members))
|
||||
}
|
||||
|
||||
member := zsr.Members[0]
|
||||
if member.DeviceID == "" {
|
||||
return fmt.Errorf("slave device ID cannot be empty")
|
||||
}
|
||||
|
||||
if member.DeviceID == zsr.Master {
|
||||
return fmt.Errorf("slave device ID cannot be the same as master: %s", member.DeviceID)
|
||||
}
|
||||
|
||||
if member.IP != "" {
|
||||
if net.ParseIP(member.IP) == nil {
|
||||
return fmt.Errorf("invalid IP address for device %s: %s", member.DeviceID, member.IP)
|
||||
}
|
||||
}
|
||||
|
||||
return nil
|
||||
}
|
||||
|
||||
// GetSlaveDeviceID returns the device ID of the slave being added/removed
|
||||
func (zsr *ZoneSlaveRequest) GetSlaveDeviceID() string {
|
||||
if len(zsr.Members) > 0 {
|
||||
return zsr.Members[0].DeviceID
|
||||
}
|
||||
return ""
|
||||
}
|
||||
|
||||
// GetSlaveIP returns the IP address of the slave being added/removed
|
||||
func (zsr *ZoneSlaveRequest) GetSlaveIP() string {
|
||||
if len(zsr.Members) > 0 {
|
||||
return zsr.Members[0].IP
|
||||
}
|
||||
return ""
|
||||
}
|
||||
|
||||
// String returns a human-readable string representation
|
||||
func (zsr *ZoneSlaveRequest) String() string {
|
||||
if len(zsr.Members) == 0 {
|
||||
return fmt.Sprintf("Zone slave operation on master %s (no slave specified)", zsr.Master)
|
||||
}
|
||||
|
||||
slave := zsr.Members[0]
|
||||
if slave.IP != "" {
|
||||
return fmt.Sprintf("Zone slave operation: master=%s, slave=%s (%s)",
|
||||
zsr.Master, slave.DeviceID, slave.IP)
|
||||
}
|
||||
|
||||
return fmt.Sprintf("Zone slave operation: master=%s, slave=%s",
|
||||
zsr.Master, slave.DeviceID)
|
||||
}
|
||||
|
||||
@@ -0,0 +1,445 @@
|
||||
package models
|
||||
|
||||
import (
|
||||
"encoding/xml"
|
||||
"strings"
|
||||
"testing"
|
||||
)
|
||||
|
||||
func TestZoneSlaveRequest_Creation(t *testing.T) {
|
||||
t.Run("NewZoneSlaveRequest", func(t *testing.T) {
|
||||
masterID := "MASTER123"
|
||||
request := NewZoneSlaveRequest(masterID)
|
||||
|
||||
if request.Master != masterID {
|
||||
t.Errorf("Expected master ID '%s', got '%s'", masterID, request.Master)
|
||||
}
|
||||
|
||||
if len(request.Members) != 0 {
|
||||
t.Errorf("Expected empty members slice, got %d members", len(request.Members))
|
||||
}
|
||||
})
|
||||
|
||||
t.Run("AddSlave", func(t *testing.T) {
|
||||
request := NewZoneSlaveRequest("MASTER123")
|
||||
request.AddSlave("SLAVE456", "192.168.1.101")
|
||||
|
||||
if len(request.Members) != 1 {
|
||||
t.Errorf("Expected 1 member, got %d", len(request.Members))
|
||||
return
|
||||
}
|
||||
|
||||
member := request.Members[0]
|
||||
if member.DeviceID != "SLAVE456" {
|
||||
t.Errorf("Expected device ID 'SLAVE456', got '%s'", member.DeviceID)
|
||||
}
|
||||
|
||||
if member.IP != "192.168.1.101" {
|
||||
t.Errorf("Expected IP '192.168.1.101', got '%s'", member.IP)
|
||||
}
|
||||
})
|
||||
}
|
||||
|
||||
func TestZoneSlaveRequest_Validation(t *testing.T) {
|
||||
tests := []struct {
|
||||
name string
|
||||
masterID string
|
||||
members []ZoneSlaveEntry
|
||||
expectError bool
|
||||
errorMsg string
|
||||
}{
|
||||
{
|
||||
name: "valid request with IP",
|
||||
masterID: "MASTER123",
|
||||
members: []ZoneSlaveEntry{
|
||||
{DeviceID: "SLAVE456", IP: "192.168.1.101"},
|
||||
},
|
||||
expectError: false,
|
||||
},
|
||||
{
|
||||
name: "valid request without IP",
|
||||
masterID: "MASTER123",
|
||||
members: []ZoneSlaveEntry{
|
||||
{DeviceID: "SLAVE456", IP: ""},
|
||||
},
|
||||
expectError: false,
|
||||
},
|
||||
{
|
||||
name: "empty master ID",
|
||||
masterID: "",
|
||||
members: []ZoneSlaveEntry{{DeviceID: "SLAVE456", IP: "192.168.1.101"}},
|
||||
expectError: true,
|
||||
errorMsg: "master device ID is required",
|
||||
},
|
||||
{
|
||||
name: "no members",
|
||||
masterID: "MASTER123",
|
||||
members: []ZoneSlaveEntry{},
|
||||
expectError: true,
|
||||
errorMsg: "zone slave operations require exactly one member",
|
||||
},
|
||||
{
|
||||
name: "multiple members",
|
||||
masterID: "MASTER123",
|
||||
members: []ZoneSlaveEntry{
|
||||
{DeviceID: "SLAVE456", IP: "192.168.1.101"},
|
||||
{DeviceID: "SLAVE789", IP: "192.168.1.102"},
|
||||
},
|
||||
expectError: true,
|
||||
errorMsg: "zone slave operations require exactly one member",
|
||||
},
|
||||
{
|
||||
name: "empty slave device ID",
|
||||
masterID: "MASTER123",
|
||||
members: []ZoneSlaveEntry{{DeviceID: "", IP: "192.168.1.101"}},
|
||||
expectError: true,
|
||||
errorMsg: "slave device ID cannot be empty",
|
||||
},
|
||||
{
|
||||
name: "same master and slave ID",
|
||||
masterID: "MASTER123",
|
||||
members: []ZoneSlaveEntry{{DeviceID: "MASTER123", IP: "192.168.1.101"}},
|
||||
expectError: true,
|
||||
errorMsg: "slave device ID cannot be the same as master",
|
||||
},
|
||||
{
|
||||
name: "invalid IP address",
|
||||
masterID: "MASTER123",
|
||||
members: []ZoneSlaveEntry{{DeviceID: "SLAVE456", IP: "invalid-ip"}},
|
||||
expectError: true,
|
||||
errorMsg: "invalid IP address",
|
||||
},
|
||||
{
|
||||
name: "malformed IP address",
|
||||
masterID: "MASTER123",
|
||||
members: []ZoneSlaveEntry{{DeviceID: "SLAVE456", IP: "300.300.300.300"}},
|
||||
expectError: true,
|
||||
errorMsg: "invalid IP address",
|
||||
},
|
||||
}
|
||||
|
||||
for _, tt := range tests {
|
||||
t.Run(tt.name, func(t *testing.T) {
|
||||
request := &ZoneSlaveRequest{
|
||||
Master: tt.masterID,
|
||||
Members: tt.members,
|
||||
}
|
||||
|
||||
err := request.Validate()
|
||||
|
||||
if tt.expectError {
|
||||
if err == nil {
|
||||
t.Errorf("Expected error but got none")
|
||||
return
|
||||
}
|
||||
|
||||
if !strings.Contains(err.Error(), tt.errorMsg) {
|
||||
t.Errorf("Expected error message to contain '%s', got '%s'", tt.errorMsg, err.Error())
|
||||
}
|
||||
} else {
|
||||
if err != nil {
|
||||
t.Errorf("Expected no error but got: %v", err)
|
||||
}
|
||||
}
|
||||
})
|
||||
}
|
||||
}
|
||||
|
||||
func TestZoneSlaveRequest_HelperMethods(t *testing.T) {
|
||||
t.Run("GetSlaveDeviceID with member", func(t *testing.T) {
|
||||
request := NewZoneSlaveRequest("MASTER123")
|
||||
request.AddSlave("SLAVE456", "192.168.1.101")
|
||||
|
||||
deviceID := request.GetSlaveDeviceID()
|
||||
expected := "SLAVE456"
|
||||
if deviceID != expected {
|
||||
t.Errorf("Expected device ID '%s', got '%s'", expected, deviceID)
|
||||
}
|
||||
})
|
||||
|
||||
t.Run("GetSlaveDeviceID with no members", func(t *testing.T) {
|
||||
request := NewZoneSlaveRequest("MASTER123")
|
||||
|
||||
deviceID := request.GetSlaveDeviceID()
|
||||
if deviceID != "" {
|
||||
t.Errorf("Expected empty device ID, got '%s'", deviceID)
|
||||
}
|
||||
})
|
||||
|
||||
t.Run("GetSlaveIP with member", func(t *testing.T) {
|
||||
request := NewZoneSlaveRequest("MASTER123")
|
||||
request.AddSlave("SLAVE456", "192.168.1.101")
|
||||
|
||||
ip := request.GetSlaveIP()
|
||||
expected := "192.168.1.101"
|
||||
if ip != expected {
|
||||
t.Errorf("Expected IP '%s', got '%s'", expected, ip)
|
||||
}
|
||||
})
|
||||
|
||||
t.Run("GetSlaveIP with no members", func(t *testing.T) {
|
||||
request := NewZoneSlaveRequest("MASTER123")
|
||||
|
||||
ip := request.GetSlaveIP()
|
||||
if ip != "" {
|
||||
t.Errorf("Expected empty IP, got '%s'", ip)
|
||||
}
|
||||
})
|
||||
|
||||
t.Run("GetSlaveIP with empty IP", func(t *testing.T) {
|
||||
request := NewZoneSlaveRequest("MASTER123")
|
||||
request.AddSlave("SLAVE456", "")
|
||||
|
||||
ip := request.GetSlaveIP()
|
||||
if ip != "" {
|
||||
t.Errorf("Expected empty IP, got '%s'", ip)
|
||||
}
|
||||
})
|
||||
}
|
||||
|
||||
func TestZoneSlaveRequest_String(t *testing.T) {
|
||||
tests := []struct {
|
||||
name string
|
||||
setup func() *ZoneSlaveRequest
|
||||
expected string
|
||||
}{
|
||||
{
|
||||
name: "with IP address",
|
||||
setup: func() *ZoneSlaveRequest {
|
||||
req := NewZoneSlaveRequest("MASTER123")
|
||||
req.AddSlave("SLAVE456", "192.168.1.101")
|
||||
return req
|
||||
},
|
||||
expected: "Zone slave operation: master=MASTER123, slave=SLAVE456 (192.168.1.101)",
|
||||
},
|
||||
{
|
||||
name: "without IP address",
|
||||
setup: func() *ZoneSlaveRequest {
|
||||
req := NewZoneSlaveRequest("MASTER123")
|
||||
req.AddSlave("SLAVE456", "")
|
||||
return req
|
||||
},
|
||||
expected: "Zone slave operation: master=MASTER123, slave=SLAVE456",
|
||||
},
|
||||
{
|
||||
name: "no members",
|
||||
setup: func() *ZoneSlaveRequest {
|
||||
return NewZoneSlaveRequest("MASTER123")
|
||||
},
|
||||
expected: "Zone slave operation on master MASTER123 (no slave specified)",
|
||||
},
|
||||
}
|
||||
|
||||
for _, tt := range tests {
|
||||
t.Run(tt.name, func(t *testing.T) {
|
||||
request := tt.setup()
|
||||
result := request.String()
|
||||
|
||||
if result != tt.expected {
|
||||
t.Errorf("Expected string '%s', got '%s'", tt.expected, result)
|
||||
}
|
||||
})
|
||||
}
|
||||
}
|
||||
|
||||
func TestZoneSlaveRequest_XMLMarshaling(t *testing.T) {
|
||||
t.Run("marshal with IP", func(t *testing.T) {
|
||||
request := NewZoneSlaveRequest("MASTER123")
|
||||
request.AddSlave("SLAVE456", "192.168.1.101")
|
||||
|
||||
xmlData, err := xml.Marshal(request)
|
||||
if err != nil {
|
||||
t.Fatalf("Failed to marshal XML: %v", err)
|
||||
}
|
||||
|
||||
xmlStr := string(xmlData)
|
||||
|
||||
// Check for expected XML elements
|
||||
if !strings.Contains(xmlStr, `<zone master="MASTER123">`) {
|
||||
t.Error("Expected XML to contain zone element with master attribute")
|
||||
}
|
||||
|
||||
if !strings.Contains(xmlStr, `<member ipaddress="192.168.1.101">SLAVE456</member>`) {
|
||||
t.Error("Expected XML to contain member with IP address")
|
||||
}
|
||||
})
|
||||
|
||||
t.Run("marshal without IP", func(t *testing.T) {
|
||||
request := NewZoneSlaveRequest("MASTER123")
|
||||
request.AddSlave("SLAVE456", "")
|
||||
|
||||
xmlData, err := xml.Marshal(request)
|
||||
if err != nil {
|
||||
t.Fatalf("Failed to marshal XML: %v", err)
|
||||
}
|
||||
|
||||
xmlStr := string(xmlData)
|
||||
|
||||
// Check for expected XML elements
|
||||
if !strings.Contains(xmlStr, `<zone master="MASTER123">`) {
|
||||
t.Error("Expected XML to contain zone element with master attribute")
|
||||
}
|
||||
|
||||
if !strings.Contains(xmlStr, `<member>SLAVE456</member>`) {
|
||||
t.Error("Expected XML to contain member without IP address")
|
||||
}
|
||||
|
||||
// Should not contain empty ipaddress attribute
|
||||
if strings.Contains(xmlStr, `ipaddress=""`) {
|
||||
t.Error("Expected XML to not contain empty ipaddress attribute")
|
||||
}
|
||||
})
|
||||
}
|
||||
|
||||
func TestZoneSlaveRequest_XMLUnmarshaling(t *testing.T) {
|
||||
tests := []struct {
|
||||
name string
|
||||
xmlData string
|
||||
expectedReq *ZoneSlaveRequest
|
||||
expectError bool
|
||||
}{
|
||||
{
|
||||
name: "valid XML with IP",
|
||||
xmlData: `<zone master="MASTER123"><member ipaddress="192.168.1.101">SLAVE456</member></zone>`,
|
||||
expectedReq: &ZoneSlaveRequest{
|
||||
Master: "MASTER123",
|
||||
Members: []ZoneSlaveEntry{
|
||||
{DeviceID: "SLAVE456", IP: "192.168.1.101"},
|
||||
},
|
||||
},
|
||||
expectError: false,
|
||||
},
|
||||
{
|
||||
name: "valid XML without IP",
|
||||
xmlData: `<zone master="MASTER123"><member>SLAVE456</member></zone>`,
|
||||
expectedReq: &ZoneSlaveRequest{
|
||||
Master: "MASTER123",
|
||||
Members: []ZoneSlaveEntry{
|
||||
{DeviceID: "SLAVE456", IP: ""},
|
||||
},
|
||||
},
|
||||
expectError: false,
|
||||
},
|
||||
{
|
||||
name: "invalid XML",
|
||||
xmlData: `<zone master="MASTER123"><member>SLAVE456</member>`,
|
||||
expectError: true,
|
||||
},
|
||||
}
|
||||
|
||||
for _, tt := range tests {
|
||||
t.Run(tt.name, func(t *testing.T) {
|
||||
var request ZoneSlaveRequest
|
||||
err := xml.Unmarshal([]byte(tt.xmlData), &request)
|
||||
|
||||
if tt.expectError {
|
||||
if err == nil {
|
||||
t.Errorf("Expected error but got none")
|
||||
}
|
||||
return
|
||||
}
|
||||
|
||||
if err != nil {
|
||||
t.Errorf("Expected no error but got: %v", err)
|
||||
return
|
||||
}
|
||||
|
||||
// Compare the unmarshaled request with expected
|
||||
if request.Master != tt.expectedReq.Master {
|
||||
t.Errorf("Expected master '%s', got '%s'", tt.expectedReq.Master, request.Master)
|
||||
}
|
||||
|
||||
if len(request.Members) != len(tt.expectedReq.Members) {
|
||||
t.Errorf("Expected %d members, got %d", len(tt.expectedReq.Members), len(request.Members))
|
||||
return
|
||||
}
|
||||
|
||||
for i, expectedMember := range tt.expectedReq.Members {
|
||||
member := request.Members[i]
|
||||
if member.DeviceID != expectedMember.DeviceID {
|
||||
t.Errorf("Expected member %d device ID '%s', got '%s'", i, expectedMember.DeviceID, member.DeviceID)
|
||||
}
|
||||
|
||||
if member.IP != expectedMember.IP {
|
||||
t.Errorf("Expected member %d IP '%s', got '%s'", i, expectedMember.IP, member.IP)
|
||||
}
|
||||
}
|
||||
})
|
||||
}
|
||||
}
|
||||
|
||||
func TestZoneSlaveEntry_XMLMarshaling(t *testing.T) {
|
||||
t.Run("entry with IP", func(t *testing.T) {
|
||||
entry := ZoneSlaveEntry{
|
||||
DeviceID: "SLAVE456",
|
||||
IP: "192.168.1.101",
|
||||
}
|
||||
|
||||
xmlData, err := xml.Marshal(entry)
|
||||
if err != nil {
|
||||
t.Fatalf("Failed to marshal XML: %v", err)
|
||||
}
|
||||
|
||||
xmlStr := string(xmlData)
|
||||
expected := `<member ipaddress="192.168.1.101">SLAVE456</member>`
|
||||
if xmlStr != expected {
|
||||
t.Errorf("Expected XML '%s', got '%s'", expected, xmlStr)
|
||||
}
|
||||
})
|
||||
|
||||
t.Run("entry without IP", func(t *testing.T) {
|
||||
entry := ZoneSlaveEntry{
|
||||
DeviceID: "SLAVE456",
|
||||
IP: "",
|
||||
}
|
||||
|
||||
xmlData, err := xml.Marshal(entry)
|
||||
if err != nil {
|
||||
t.Fatalf("Failed to marshal XML: %v", err)
|
||||
}
|
||||
|
||||
xmlStr := string(xmlData)
|
||||
expected := `<member>SLAVE456</member>`
|
||||
if xmlStr != expected {
|
||||
t.Errorf("Expected XML '%s', got '%s'", expected, xmlStr)
|
||||
}
|
||||
})
|
||||
}
|
||||
|
||||
func TestZoneSlaveRequest_EdgeCases(t *testing.T) {
|
||||
t.Run("multiple AddSlave calls", func(t *testing.T) {
|
||||
request := NewZoneSlaveRequest("MASTER123")
|
||||
request.AddSlave("SLAVE456", "192.168.1.101")
|
||||
request.AddSlave("SLAVE789", "192.168.1.102")
|
||||
|
||||
if len(request.Members) != 2 {
|
||||
t.Errorf("Expected 2 members, got %d", len(request.Members))
|
||||
}
|
||||
|
||||
// Should fail validation due to multiple members
|
||||
err := request.Validate()
|
||||
if err == nil {
|
||||
t.Error("Expected validation error for multiple members but got none")
|
||||
}
|
||||
})
|
||||
|
||||
t.Run("IPv6 address", func(t *testing.T) {
|
||||
request := NewZoneSlaveRequest("MASTER123")
|
||||
request.AddSlave("SLAVE456", "2001:db8::1")
|
||||
|
||||
err := request.Validate()
|
||||
if err != nil {
|
||||
t.Errorf("Expected no error for IPv6 address but got: %v", err)
|
||||
}
|
||||
})
|
||||
|
||||
t.Run("localhost IP", func(t *testing.T) {
|
||||
request := NewZoneSlaveRequest("MASTER123")
|
||||
request.AddSlave("SLAVE456", "127.0.0.1")
|
||||
|
||||
err := request.Validate()
|
||||
if err != nil {
|
||||
t.Errorf("Expected no error for localhost IP but got: %v", err)
|
||||
}
|
||||
})
|
||||
}
|
||||
Reference in New Issue
Block a user