Fix logic checking for address match

Author: DerAndereAndi

spine/binding_manager.go

@@ -177,15 +177,10 @@ func (c *BindingManager) RemoveBindingsForRemoteEntity(remoteEntity api.EntityRe
 	remoteEntityAddress := remoteEntity.Address().Entity
 
 	for _, binding := range bindingData.BindingEntry {
-		// check if this binding contains the remote device
-		if !reflect.DeepEqual(binding.ClientAddress.Device, remoteDeviceAddress) &&
-			!reflect.DeepEqual(binding.ServerAddress.Device, remoteDeviceAddress) {
-			continue
-		}
-
-		// check if this binding contains the remote entity
-		if !reflect.DeepEqual(binding.ClientAddress.Entity, remoteEntityAddress) &&
-			!reflect.DeepEqual(binding.ServerAddress.Entity, remoteEntityAddress) {
+		// check if binding matches ClientAddress or ServerAddress
+		if !isMatchingClientOrServerByDeviceAndEntity(
+			binding.ClientAddress, binding.ServerAddress,
+			remoteDeviceAddress, remoteEntityAddress) {
 			continue
 		}
 
@@ -208,15 +203,10 @@ func (c *BindingManager) RemoveBindingsForLocalEntity(localEntity api.EntityLoca
 	localEntityAddress := localEntity.Address().Entity
 
 	for _, binding := range bindingData.BindingEntry {
-		// check if this binding contains the local device
-		if !reflect.DeepEqual(binding.ClientAddress.Device, localDeviceAddress) &&
-			!reflect.DeepEqual(binding.ServerAddress.Device, localDeviceAddress) {
-			continue
-		}
-
-		// check if this binding contains the local entity
-		if !reflect.DeepEqual(binding.ClientAddress.Entity, localEntityAddress) &&
-			!reflect.DeepEqual(binding.ServerAddress.Entity, localEntityAddress) {
+		// check if binding matches ClientAddress or ServerAddress
+		if !isMatchingClientOrServerByDeviceAndEntity(
+			binding.ClientAddress, binding.ServerAddress,
+			localDeviceAddress, localEntityAddress) {
 			continue
 		}
 

spine/subscription_manager.go

@@ -168,15 +168,10 @@ func (c *SubscriptionManager) RemoveSubscriptionsForRemoteEntity(remoteEntity ap
 	remoteEntityAddress := remoteEntity.Address().Entity
 
 	for _, subscription := range subscriptionData.SubscriptionEntry {
-		// check if this subscription contains the remote device
-		if !reflect.DeepEqual(subscription.ClientAddress.Device, remoteDeviceAddress) &&
-			!reflect.DeepEqual(subscription.ServerAddress.Device, remoteDeviceAddress) {
-			continue
-		}
-
-		// check if this subscription contains the remote entity
-		if !reflect.DeepEqual(subscription.ClientAddress.Entity, remoteEntityAddress) &&
-			!reflect.DeepEqual(subscription.ServerAddress.Entity, remoteEntityAddress) {
+		// check if subscription matches ClientAddress or ServerAddress
+		if !isMatchingClientOrServerByDeviceAndEntity(
+			subscription.ClientAddress, subscription.ServerAddress,
+			remoteDeviceAddress, remoteEntityAddress) {
 			continue
 		}
 
@@ -199,15 +194,10 @@ func (c *SubscriptionManager) RemoveSubscriptionsForLocalEntity(localEntity api.
 	localEntityAddress := localEntity.Address().Entity
 
 	for _, subscription := range subscriptionData.SubscriptionEntry {
-		// check if this subscription contains the remote device
-		if !reflect.DeepEqual(subscription.ClientAddress.Device, localDeviceAddress) &&
-			!reflect.DeepEqual(subscription.ServerAddress.Device, localDeviceAddress) {
-			continue
-		}
-
-		// check if this subscription contains the remote entity
-		if !reflect.DeepEqual(subscription.ClientAddress.Entity, localEntityAddress) &&
-			!reflect.DeepEqual(subscription.ServerAddress.Entity, localEntityAddress) {
+		// check if subscription matches ClientAddress or ServerAddress
+		if !isMatchingClientOrServerByDeviceAndEntity(
+			subscription.ClientAddress, subscription.ServerAddress,
+			localDeviceAddress, localEntityAddress) {
 			continue
 		}
 

spine/util.go

@@ -11,6 +11,32 @@ import (
 
 var notFoundError = errors.New("data not found")
 
+// check if a client or server feature address matches
+// a combination of a deviceAddress and entityAddress
+func isMatchingClientOrServerByDeviceAndEntity(
+	clientAddress, serverAddress *model.FeatureAddressType,
+	deviceAddress *model.AddressDeviceType,
+	entityAddress []model.AddressEntityType,
+) bool {
+	if deviceAddress == nil || entityAddress == nil {
+		return false
+	}
+
+	if clientAddress != nil &&
+		reflect.DeepEqual(clientAddress.Device, deviceAddress) &&
+		reflect.DeepEqual(clientAddress.Entity, entityAddress) {
+		return true
+	}
+
+	if serverAddress != nil &&
+		reflect.DeepEqual(serverAddress.Device, deviceAddress) &&
+		reflect.DeepEqual(serverAddress.Entity, entityAddress) {
+		return true
+	}
+
+	return false
+}
+
 // return details for a given remoteDevice of a client and server address
 //
 // Note: when the feature address and/or entity address is not given,

spine/util_test.go

@@ -24,6 +24,44 @@ type UtilsSuite struct {
 
 func (s *UtilsSuite) WriteShipMessageWithPayload([]byte) {}
 
+func (s *UtilsSuite) Test_isMatchingClientOrServerByDeviceAndEntity() {
+	result := isMatchingClientOrServerByDeviceAndEntity(nil, nil, nil, nil)
+	assert.False(s.T(), result)
+
+	clientAddress := &model.FeatureAddressType{}
+	serverAddress := &model.FeatureAddressType{}
+	result = isMatchingClientOrServerByDeviceAndEntity(clientAddress, serverAddress, nil, nil)
+	assert.False(s.T(), result)
+
+	clientAddress = &model.FeatureAddressType{
+		Device:  util.Ptr(model.AddressDeviceType("Device1")),
+		Entity:  []model.AddressEntityType{1},
+		Feature: util.Ptr(model.AddressFeatureType(100)),
+	}
+	serverAddress = &model.FeatureAddressType{
+		Device:  util.Ptr(model.AddressDeviceType("Device2")),
+		Entity:  []model.AddressEntityType{1},
+		Feature: util.Ptr(model.AddressFeatureType(100)),
+	}
+	deviceAddress := util.Ptr(model.AddressDeviceType("Device1"))
+	entityAddress := []model.AddressEntityType{2}
+	result = isMatchingClientOrServerByDeviceAndEntity(clientAddress, serverAddress, deviceAddress, entityAddress)
+	assert.False(s.T(), result)
+
+	entityAddress = []model.AddressEntityType{1}
+	result = isMatchingClientOrServerByDeviceAndEntity(clientAddress, serverAddress, deviceAddress, entityAddress)
+	assert.True(s.T(), result)
+
+	deviceAddress = util.Ptr(model.AddressDeviceType("Device2"))
+	entityAddress = []model.AddressEntityType{2}
+	result = isMatchingClientOrServerByDeviceAndEntity(clientAddress, serverAddress, deviceAddress, entityAddress)
+	assert.False(s.T(), result)
+
+	entityAddress = []model.AddressEntityType{1}
+	result = isMatchingClientOrServerByDeviceAndEntity(clientAddress, serverAddress, deviceAddress, entityAddress)
+	assert.True(s.T(), result)
+}
+
 func (s *UtilsSuite) Test_addressDetails() {
 	s.localDevice = NewDeviceLocal("brand", "model", "serial", "code", "address", model.DeviceTypeTypeEnergyManagementSystem, model.NetworkManagementFeatureSetTypeSmart)