Improve partial handling

- Add possibility to define each operation to support partials
- Fix possible panic when assigning read selectors or elements
- Improve filter test
- Set defaults for local server feature partial support: read is false, write is true
- Properly set the remotes partial support information
- Model fix

api/api.go

@@ -45,7 +45,9 @@ type HeartbeatManagerInterface interface {
 
 type OperationsInterface interface {
 	Write() bool
+	WritePartial() bool
 	Read() bool
+	ReadPartial() bool
 	String() string
 	Information() *model.PossibleOperationsType
 }

api/function.go

@@ -7,10 +7,14 @@ import "github.com/enbility/spine-go/model"
 type FunctionDataCmdInterface interface {
 	FunctionDataInterface
 	// Get the CmdType data for a read command
+	//
+	// Note: partialSelector and elements have to be pointers!
 	ReadCmdType(partialSelector any, elements any) model.CmdType
 	// Get the CmdType data for a reply command
 	ReplyCmdType(partial bool) model.CmdType
 	// Get the CmdType data for a notify or write command
+	//
+	// Note: partialSelector and elements have to be pointers!
 	NotifyOrWriteCmdType(deleteSelector, partialSelector any, partialWithoutSelector bool, deleteElements any) model.CmdType
 }
 

model/commandframe_additions_test.go

@@ -34,7 +34,9 @@ func TestFilterType_Selector_SetDataForFunction(t *testing.T) {
 	cmd.SetDataForFunction(EEBusTagTypeTypeSelector, FunctionTypeElectricalConnectionDescriptionListData, nil)
 	assert.Nil(t, cmd.ElectricalConnectionDescriptionListDataSelectors)
 
-	var test *ElectricalConnectionDescriptionListDataSelectorsType
+	test := &ElectricalConnectionDescriptionListDataSelectorsType{
+		ElectricalConnectionId: util.Ptr(ElectricalConnectionIdType(1)),
+	}
 	cmd = FilterType{}
 	cmd.SetDataForFunction(EEBusTagTypeTypeSelector, FunctionTypeElectricalConnectionDescriptionListData, test)
 	assert.NotNil(t, cmd.ElectricalConnectionDescriptionListDataSelectors)

model/deviceconfiguration.go

@@ -129,8 +129,8 @@ type DeviceConfigurationKeyValueDescriptionListDataType struct {
 }
 
 type DeviceConfigurationKeyValueDescriptionListDataSelectorsType struct {
-	KeyId   *DeviceConfigurationKeyIdType `json:"keyId,omitempty"`
-	KeyName *string                       `json:"keyName,omitempty"`
+	KeyId   *DeviceConfigurationKeyIdType   `json:"keyId,omitempty"`
+	KeyName *DeviceConfigurationKeyNameType `json:"keyName,omitempty"`
 }
 
 type DeviceConfigurationKeyValueConstraintsDataType struct {

spine/feature_local.go

@@ -76,7 +76,7 @@ func (r *FeatureLocal) AddFunctionType(function model.FunctionType, read, write
 	if r.operations[function] != nil {
 		return
 	}
-	r.operations[function] = NewOperations(read, write)
+	r.operations[function] = NewOperations(read, false, write, write)
 
 	if r.role == model.RoleTypeServer &&
 		r.ftype == model.FeatureTypeTypeDeviceDiagnosis &&

spine/feature_remote.go

@@ -82,7 +82,12 @@ func (r *FeatureRemote) SetOperations(functions []model.FunctionPropertyType) {
 		if sf.PossibleOperations == nil {
 			continue
 		}
-		r.operations[*sf.Function] = NewOperations(sf.PossibleOperations.Read != nil, sf.PossibleOperations.Write != nil)
+		r.operations[*sf.Function] = NewOperations(
+			sf.PossibleOperations.Read != nil,
+			sf.PossibleOperations.Read != nil && sf.PossibleOperations.Read.Partial != nil,
+			sf.PossibleOperations.Write != nil,
+			sf.PossibleOperations.Write != nil && sf.PossibleOperations.Write.Partial != nil,
+		)
 	}
 }
 

spine/function_data_cmd.go

@@ -76,10 +76,10 @@ func filtersForSelectorsElements(functionType model.FunctionType, filters []mode
 	if partialSelector != nil || readElements != nil {
 		filter := model.FilterType{CmdControl: &model.CmdControlType{Partial: &model.ElementTagType{}}}
 		if partialSelector != nil {
-			filter = addSelectorToFilter(filter, functionType, &partialSelector)
+			filter = addSelectorToFilter(filter, functionType, partialSelector)
 		}
 		if readElements != nil {
-			filter = addElementToFilter(filter, functionType, &readElements)
+			filter = addElementToFilter(filter, functionType, readElements)
 		}
 		filters = append(filters, filter)
 	}
@@ -92,15 +92,15 @@ func filterEmptyPartial() []model.FilterType {
 	return []model.FilterType{*model.NewFilterTypePartial()}
 }
 
-func addSelectorToFilter[T any](filter model.FilterType, function model.FunctionType, data *T) model.FilterType {
+func addSelectorToFilter(filter model.FilterType, function model.FunctionType, data any) model.FilterType {
 	result := filter
 
 	result.SetDataForFunction(model.EEBusTagTypeTypeSelector, function, data)
 
 	return result
 }
 
-func addElementToFilter[T any](filter model.FilterType, function model.FunctionType, data *T) model.FilterType {
+func addElementToFilter(filter model.FilterType, function model.FunctionType, data any) model.FilterType {
 	result := filter
 
 	result.SetDataForFunction(model.EEbusTagTypeTypeElements, function, data)

spine/function_data_cmd_test.go

@@ -36,7 +36,10 @@ func (suite *FctDataCmdSuite) TestFunctionDataCmd_ReadCmd() {
 	assert.Nil(suite.T(), readCmd.Function)
 
 	partialS := model.NewFilterTypePartial()
-	readCmd = suite.sut.ReadCmdType(partialS, nil)
+	partialE := &model.DeviceClassificationManufacturerDataElementsType{
+		DeviceName: util.Ptr(model.ElementTagType{}),
+	}
+	readCmd = suite.sut.ReadCmdType(partialS, partialE)
 	assert.NotNil(suite.T(), readCmd.DeviceClassificationManufacturerData)
 	assert.Nil(suite.T(), readCmd.DeviceClassificationManufacturerData.DeviceName)
 	assert.NotNil(suite.T(), readCmd.Function)

spine/operations.go

@@ -6,26 +6,36 @@ import (
 )
 
 type Operations struct {
-	read, write bool
+	read, write               bool
+	readPartial, writePartial bool
 }
 
 var _ api.OperationsInterface = (*Operations)(nil)
 
-func NewOperations(read, write bool) *Operations {
+func NewOperations(read, readPartial, write, writePartial bool) *Operations {
 	return &Operations{
-		read:  read,
-		write: write,
+		read:         read,
+		readPartial:  readPartial,
+		write:        write,
+		writePartial: writePartial,
 	}
 }
-
 func (r *Operations) Read() bool {
 	return r.read
 }
 
+func (r *Operations) ReadPartial() bool {
+	return r.readPartial
+}
+
 func (r *Operations) Write() bool {
 	return r.write
 }
 
+func (r *Operations) WritePartial() bool {
+	return r.writePartial
+}
+
 func (r *Operations) String() string {
 	switch {
 	case r.read && !r.write:
@@ -41,10 +51,18 @@ func (r *Operations) Information() *model.PossibleOperationsType {
 	res := new(model.PossibleOperationsType)
 	if r.read {
 		res.Read = &model.PossibleOperationsReadType{}
+		if r.readPartial {
+			res.Read = &model.PossibleOperationsReadType{
+				Partial: &model.ElementTagType{},
+			}
+		}
 	}
 	if r.write {
-		res.Write = &model.PossibleOperationsWriteType{
-			Partial: &model.ElementTagType{},
+		res.Write = &model.PossibleOperationsWriteType{}
+		if r.writePartial {
+			res.Write = &model.PossibleOperationsWriteType{
+				Partial: &model.ElementTagType{},
+			}
 		}
 	}
 

spine/operations_test.go

@@ -7,7 +7,7 @@ import (
 )
 
 func TestOperations(t *testing.T) {
-	operations := NewOperations(true, false)
+	operations := NewOperations(true, true, false, false)
 	assert.NotNil(t, operations)
 
 	text := operations.String()
@@ -16,7 +16,16 @@ func TestOperations(t *testing.T) {
 	data := operations.Information()
 	assert.NotNil(t, data)
 
-	operations2 := NewOperations(true, true)
+	result := operations.Read()
+	assert.True(t, result)
+	result = operations.ReadPartial()
+	assert.True(t, result)
+	result = operations.Write()
+	assert.False(t, result)
+	result = operations.WritePartial()
+	assert.False(t, result)
+
+	operations2 := NewOperations(true, false, true, true)
 	assert.NotNil(t, operations2)
 
 	text = operations2.String()
@@ -25,12 +34,30 @@ func TestOperations(t *testing.T) {
 	data = operations2.Information()
 	assert.NotNil(t, data)
 
-	operations3 := NewOperations(false, false)
+	result = operations2.Read()
+	assert.True(t, result)
+	result = operations2.ReadPartial()
+	assert.False(t, result)
+	result = operations2.Write()
+	assert.True(t, result)
+	result = operations2.WritePartial()
+	assert.True(t, result)
+
+	operations3 := NewOperations(false, false, false, false)
 	assert.NotNil(t, operations3)
 
 	text = operations3.String()
 	assert.NotEqual(t, 0, len(text))
 
 	data = operations3.Information()
 	assert.NotNil(t, data)
+
+	result = operations3.Read()
+	assert.False(t, result)
+	result = operations3.ReadPartial()
+	assert.False(t, result)
+	result = operations3.Write()
+	assert.False(t, result)
+	result = operations3.WritePartial()
+	assert.False(t, result)
 }