Various updates (#111)

- Update Github workflow to stable gosec - Update SHIP and SPINE - Add CS LPC / LPP logging - Change default `IsValueChangeable` of CS LPC/LPP for failsafe power limits to `true` - Check for subscriptions and bindings before requesting them
enbility · Sep 7, 2024 · cd3e59d · cd3e59d
2 parents 5cf478f + 974c8ea
commit cd3e59d
Show file tree

Hide file tree

Showing 20 changed files with 229 additions and 107 deletions.
diff --git a/.github/workflows/default.yml b/.github/workflows/default.yml
@@ -48,7 +48,7 @@ jobs:
           file: coverage.out
 
       - name: Run Gosec Security Scanner
-        uses: securego/gosec@11d69032b0856c96afd4c493967ab7a30e20ff5e
+        uses: securego/gosec@v2.20.0
         with:
           # we let the report trigger content trigger a failure using the GitHub Security features.
           args: '-no-fail -fmt sarif -out results.sarif ./...'

diff --git a/go.mod b/go.mod
@@ -3,8 +3,8 @@ module github.com/enbility/eebus-go
 go 1.21.1
 
 require (
-	github.com/enbility/ship-go v0.5.3
-	github.com/enbility/spine-go v0.6.2
+	github.com/enbility/ship-go v0.0.0-20240904104254-04d944c4f825
+	github.com/enbility/spine-go v0.0.0-20240907194637-0024041a4f36
 	github.com/stretchr/testify v1.9.0
 )
 
@@ -35,7 +35,3 @@ retract (
 	v0.2.2 // Contains retractions only.
 	v0.2.1 // Published accidentally.
 )
-
-replace github.com/enbility/ship-go => github.com/enbility/ship-go v0.0.0-20240904104254-04d944c4f825
-
-replace github.com/enbility/spine-go => github.com/enbility/spine-go v0.0.0-20240903070433-dd8261993071
diff --git a/go.sum b/go.sum
@@ -6,8 +6,8 @@ github.com/enbility/go-avahi v0.0.0-20240829083637-9ae2ef5f5ed2 h1:voP4zFVNvVWxl
 github.com/enbility/go-avahi v0.0.0-20240829083637-9ae2ef5f5ed2/go.mod h1:KJXUEgg/b4XZzS+OFfqnykHREsinuNSL/IzJ+nU43P8=
 github.com/enbility/ship-go v0.0.0-20240904104254-04d944c4f825 h1:i/n9UFYf660TyC8Y48P3MDxLaWWKRNW3pFjEOVzPzto=
 github.com/enbility/ship-go v0.0.0-20240904104254-04d944c4f825/go.mod h1:dzymc1D7BDZUTLVHVt9JRRkFLlBrlUmRKyLJvAe07Mc=
-github.com/enbility/spine-go v0.0.0-20240903070433-dd8261993071 h1:rjvpnD3xTrSPdU6AQK4miwl/gZQ84CJ6gv/kEEguBME=
-github.com/enbility/spine-go v0.0.0-20240903070433-dd8261993071/go.mod h1:6AbRXzd0fLVGFJdT60YQACe1WskwdjiznCfljQ+Ud6s=
+github.com/enbility/spine-go v0.0.0-20240907194637-0024041a4f36 h1:Y44hzp5uIYSEyBMe/zwFzlXKokgZHQ9cv2NiIF1NkZs=
+github.com/enbility/spine-go v0.0.0-20240907194637-0024041a4f36/go.mod h1:BDvhbs+XsWDGYwd8eQOzPXc8w/avVFmWKLlSKV/gx9k=
 github.com/enbility/zeroconf/v2 v2.0.0-20240827101515-f3956627c450 h1:39tnpfiV5OVfYb9sOqYmoivBzTHyNLWSYIxd9Qng1eg=
 github.com/enbility/zeroconf/v2 v2.0.0-20240827101515-f3956627c450/go.mod h1:1sUbJ+VE7yLNyRzGoCMjoDWtdZ+bW4aYBKx2+Rw+9hs=
 github.com/godbus/dbus/v5 v5.1.0 h1:4KLkAxT3aOY8Li4FRJe/KvhoNFFxo0m6fNuFUO8QJUk=

diff --git a/usecases/cem/cevc/events.go b/usecases/cem/cevc/events.go
@@ -49,8 +49,10 @@ func (e *CEVC) HandleEvent(payload spineapi.EventPayload) {
 func (e *CEVC) evConnected(entity spineapi.EntityRemoteInterface) {
 	// initialise features, e.g. subscriptions, descriptions
 	if evDeviceConfiguration, err := client.NewDeviceConfiguration(e.LocalEntity, entity); err == nil {
-		if _, err := evDeviceConfiguration.Subscribe(); err != nil {
-			logging.Log().Debug(err)
+		if !evDeviceConfiguration.HasSubscription() {
+			if _, err := evDeviceConfiguration.Subscribe(); err != nil {
+				logging.Log().Debug(err)
+			}
 		}
 
 		// get device configuration descriptions
@@ -60,12 +62,16 @@ func (e *CEVC) evConnected(entity spineapi.EntityRemoteInterface) {
 	}
 
 	if evTimeSeries, err := client.NewTimeSeries(e.LocalEntity, entity); err == nil {
-		if _, err := evTimeSeries.Subscribe(); err != nil {
-			logging.Log().Debug(err)
+		if !evTimeSeries.HasSubscription() {
+			if _, err := evTimeSeries.Subscribe(); err != nil {
+				logging.Log().Debug(err)
+			}
 		}
 
-		if _, err := evTimeSeries.Bind(); err != nil {
-			logging.Log().Debug(err)
+		if !evTimeSeries.HasBinding() {
+			if _, err := evTimeSeries.Bind(); err != nil {
+				logging.Log().Debug(err)
+			}
 		}
 
 		// get time series descriptions
@@ -80,12 +86,16 @@ func (e *CEVC) evConnected(entity spineapi.EntityRemoteInterface) {
 	}
 
 	if evIncentiveTable, err := client.NewIncentiveTable(e.LocalEntity, entity); err == nil {
-		if _, err := evIncentiveTable.Subscribe(); err != nil {
-			logging.Log().Debug(err)
+		if !evIncentiveTable.HasSubscription() {
+			if _, err := evIncentiveTable.Subscribe(); err != nil {
+				logging.Log().Debug(err)
+			}
 		}
 
-		if _, err := evIncentiveTable.Bind(); err != nil {
-			logging.Log().Debug(err)
+		if !evIncentiveTable.HasBinding() {
+			if _, err := evIncentiveTable.Bind(); err != nil {
+				logging.Log().Debug(err)
+			}
 		}
 
 		// get incentivetable descriptions

diff --git a/usecases/cem/evcc/events.go b/usecases/cem/evcc/events.go
@@ -58,8 +58,10 @@ func (e *EVCC) HandleEvent(payload spineapi.EventPayload) {
 func (e *EVCC) evConnected(payload spineapi.EventPayload) {
 	// initialise features, e.g. subscriptions, descriptions
 	if evDeviceClassification, err := client.NewDeviceClassification(e.LocalEntity, payload.Entity); err == nil {
-		if _, err := evDeviceClassification.Subscribe(); err != nil {
-			logging.Log().Debug(err)
+		if !evDeviceClassification.HasSubscription() {
+			if _, err := evDeviceClassification.Subscribe(); err != nil {
+				logging.Log().Debug(err)
+			}
 		}
 
 		// get manufacturer details
@@ -69,18 +71,23 @@ func (e *EVCC) evConnected(payload spineapi.EventPayload) {
 	}
 
 	if evDeviceConfiguration, err := client.NewDeviceConfiguration(e.LocalEntity, payload.Entity); err == nil {
-		if _, err := evDeviceConfiguration.Subscribe(); err != nil {
-			logging.Log().Debug(err)
+		if !evDeviceConfiguration.HasSubscription() {
+			if _, err := evDeviceConfiguration.Subscribe(); err != nil {
+				logging.Log().Debug(err)
+			}
 		}
+
 		// get ev configuration data
 		if _, err := evDeviceConfiguration.RequestKeyValueDescriptions(nil, nil); err != nil {
 			logging.Log().Debug(err)
 		}
 	}
 
 	if evDeviceDiagnosis, err := client.NewDeviceDiagnosis(e.LocalEntity, payload.Entity); err == nil {
-		if _, err := evDeviceDiagnosis.Subscribe(); err != nil {
-			logging.Log().Debug(err)
+		if !evDeviceDiagnosis.HasSubscription() {
+			if _, err := evDeviceDiagnosis.Subscribe(); err != nil {
+				logging.Log().Debug(err)
+			}
 		}
 
 		// get device diagnosis state
@@ -90,8 +97,10 @@ func (e *EVCC) evConnected(payload spineapi.EventPayload) {
 	}
 
 	if evElectricalConnection, err := client.NewElectricalConnection(e.LocalEntity, payload.Entity); err == nil {
-		if _, err := evElectricalConnection.Subscribe(); err != nil {
-			logging.Log().Debug(err)
+		if !evElectricalConnection.HasSubscription() {
+			if _, err := evElectricalConnection.Subscribe(); err != nil {
+				logging.Log().Debug(err)
+			}
 		}
 
 		// get electrical connection parameter descriptions
@@ -106,8 +115,10 @@ func (e *EVCC) evConnected(payload spineapi.EventPayload) {
 	}
 
 	if evIdentification, err := client.NewIdentification(e.LocalEntity, payload.Entity); err == nil {
-		if _, err := evIdentification.Subscribe(); err != nil {
-			logging.Log().Debug(err)
+		if !evIdentification.HasSubscription() {
+			if _, err := evIdentification.Subscribe(); err != nil {
+				logging.Log().Debug(err)
+			}
 		}
 
 		// get identification

diff --git a/usecases/cem/evcem/events.go b/usecases/cem/evcem/events.go
@@ -43,8 +43,10 @@ func (e *EVCEM) evConnected(entity spineapi.EntityRemoteInterface) {
 	// initialise features, e.g. subscriptions, descriptions
 
 	if evElectricalConnection, err := client.NewElectricalConnection(e.LocalEntity, entity); err == nil {
-		if _, err := evElectricalConnection.Subscribe(); err != nil {
-			logging.Log().Debug(err)
+		if !evElectricalConnection.HasSubscription() {
+			if _, err := evElectricalConnection.Subscribe(); err != nil {
+				logging.Log().Debug(err)
+			}
 		}
 
 		// get electrical connection descriptions
@@ -59,8 +61,10 @@ func (e *EVCEM) evConnected(entity spineapi.EntityRemoteInterface) {
 	}
 
 	if evMeasurement, err := client.NewMeasurement(e.LocalEntity, entity); err == nil {
-		if _, err := evMeasurement.Subscribe(); err != nil {
-			logging.Log().Debug(err)
+		if !evMeasurement.HasSubscription() {
+			if _, err := evMeasurement.Subscribe(); err != nil {
+				logging.Log().Debug(err)
+			}
 		}
 
 		// get measurement descriptions

diff --git a/usecases/cem/opev/events.go b/usecases/cem/opev/events.go
@@ -43,12 +43,16 @@ func (e *OPEV) HandleEvent(payload spineapi.EventPayload) {
 func (e *OPEV) evConnected(entity spineapi.EntityRemoteInterface) {
 	// initialise features, e.g. subscriptions, descriptions
 	if evLoadControl, err := client.NewLoadControl(e.LocalEntity, entity); err == nil {
-		if _, err := evLoadControl.Subscribe(); err != nil {
-			logging.Log().Debug(err)
+		if !evLoadControl.HasSubscription() {
+			if _, err := evLoadControl.Subscribe(); err != nil {
+				logging.Log().Debug(err)
+			}
 		}
 
-		if _, err := evLoadControl.Bind(); err != nil {
-			logging.Log().Debug(err)
+		if !evLoadControl.HasBinding() {
+			if _, err := evLoadControl.Bind(); err != nil {
+				logging.Log().Debug(err)
+			}
 		}
 
 		// get descriptions

diff --git a/usecases/cem/vabd/events.go b/usecases/cem/vabd/events.go
@@ -39,8 +39,10 @@ func (e *VABD) HandleEvent(payload spineapi.EventPayload) {
 // process required steps when a grid device is connected
 func (e *VABD) inverterConnected(entity spineapi.EntityRemoteInterface) {
 	if electricalConnection, err := client.NewElectricalConnection(e.LocalEntity, entity); err == nil {
-		if _, err := electricalConnection.Subscribe(); err != nil {
-			logging.Log().Error(err)
+		if !electricalConnection.HasSubscription() {
+			if _, err := electricalConnection.Subscribe(); err != nil {
+				logging.Log().Error(err)
+			}
 		}
 
 		// get electrical connection parameter
@@ -54,8 +56,10 @@ func (e *VABD) inverterConnected(entity spineapi.EntityRemoteInterface) {
 	}
 
 	if measurement, err := client.NewMeasurement(e.LocalEntity, entity); err == nil {
-		if _, err := measurement.Subscribe(); err != nil {
-			logging.Log().Error(err)
+		if !measurement.HasSubscription() {
+			if _, err := measurement.Subscribe(); err != nil {
+				logging.Log().Error(err)
+			}
 		}
 
 		// get measurement parameters

diff --git a/usecases/cem/vapd/events.go b/usecases/cem/vapd/events.go
@@ -45,8 +45,10 @@ func (e *VAPD) HandleEvent(payload spineapi.EventPayload) {
 // process required steps when a grid device is connected
 func (e *VAPD) inverterConnected(entity spineapi.EntityRemoteInterface) {
 	if deviceConfiguration, err := client.NewDeviceConfiguration(e.LocalEntity, entity); err == nil {
-		if _, err := deviceConfiguration.Subscribe(); err != nil {
-			logging.Log().Error(err)
+		if !deviceConfiguration.HasSubscription() {
+			if _, err := deviceConfiguration.Subscribe(); err != nil {
+				logging.Log().Error(err)
+			}
 		}
 
 		// get configuration data
@@ -56,8 +58,10 @@ func (e *VAPD) inverterConnected(entity spineapi.EntityRemoteInterface) {
 	}
 
 	if electricalConnection, err := client.NewElectricalConnection(e.LocalEntity, entity); err == nil {
-		if _, err := electricalConnection.Subscribe(); err != nil {
-			logging.Log().Error(err)
+		if !electricalConnection.HasSubscription() {
+			if _, err := electricalConnection.Subscribe(); err != nil {
+				logging.Log().Error(err)
+			}
 		}
 
 		// get electrical connection parameter
@@ -71,8 +75,10 @@ func (e *VAPD) inverterConnected(entity spineapi.EntityRemoteInterface) {
 	}
 
 	if measurement, err := client.NewMeasurement(e.LocalEntity, entity); err == nil {
-		if _, err := measurement.Subscribe(); err != nil {
-			logging.Log().Error(err)
+		if !measurement.HasSubscription() {
+			if _, err := measurement.Subscribe(); err != nil {
+				logging.Log().Error(err)
+			}
 		}
 
 		// get measurement parameters

diff --git a/usecases/cs/lpc/events.go b/usecases/cs/lpc/events.go
@@ -102,8 +102,10 @@ func (e *LPC) deviceConnected(payload spineapi.EventPayload) {
 	if len(deviceDiagEntities) == 1 {
 		if localDeviceDiag, err := client.NewDeviceDiagnosis(e.LocalEntity, deviceDiagEntities[0]); err == nil {
 			e.heartbeatDiag = localDeviceDiag
-			if _, err := localDeviceDiag.Subscribe(); err != nil {
-				logging.Log().Debug(err)
+			if !localDeviceDiag.HasSubscription() {
+				if _, err := localDeviceDiag.Subscribe(); err != nil {
+					logging.Log().Debug(err)
+				}
 			}
 
 			if _, err := localDeviceDiag.RequestHeartbeat(); err != nil {
@@ -126,8 +128,10 @@ func (e *LPC) subscribeHeartbeatWorkaround(payload spineapi.EventPayload) {
 	if e.heartbeatKeoWorkaround {
 		if localDeviceDiag, err := client.NewDeviceDiagnosis(e.LocalEntity, payload.Entity); err == nil {
 			e.heartbeatDiag = localDeviceDiag
-			if _, err := localDeviceDiag.Subscribe(); err != nil {
-				logging.Log().Debug(err)
+			if !localDeviceDiag.HasSubscription() {
+				if _, err := localDeviceDiag.Subscribe(); err != nil {
+					logging.Log().Debug(err)
+				}
 			}
 
 			if _, err := localDeviceDiag.RequestHeartbeat(); err != nil {

diff --git a/usecases/cs/lpc/public_test.go b/usecases/cs/lpc/public_test.go
@@ -81,21 +81,21 @@ func (s *CsLPCSuite) Test_PendingConsumptionLimits() {
 func (s *CsLPCSuite) Test_Failsafe() {
 	limit, changeable, err := s.sut.FailsafeConsumptionActivePowerLimit()
 	assert.Equal(s.T(), 0.0, limit)
-	assert.Equal(s.T(), false, changeable)
+	assert.Equal(s.T(), true, changeable)
 	assert.Nil(s.T(), err)
 
-	err = s.sut.SetFailsafeConsumptionActivePowerLimit(10, true)
+	err = s.sut.SetFailsafeConsumptionActivePowerLimit(10, false)
 	assert.Nil(s.T(), err)
 
 	limit, changeable, err = s.sut.FailsafeConsumptionActivePowerLimit()
 	assert.Equal(s.T(), 10.0, limit)
-	assert.Equal(s.T(), true, changeable)
+	assert.Equal(s.T(), false, changeable)
 	assert.Nil(s.T(), err)
 
 	// The actual tests of the functionality is located in the util package
 	duration, changeable, err := s.sut.FailsafeDurationMinimum()
 	assert.Equal(s.T(), time.Duration(0), duration)
-	assert.Equal(s.T(), false, changeable)
+	assert.Equal(s.T(), true, changeable)
 	assert.Nil(s.T(), err)
 
 	err = s.sut.SetFailsafeDurationMinimum(time.Duration(time.Hour*1), true)
@@ -104,6 +104,9 @@ func (s *CsLPCSuite) Test_Failsafe() {
 	err = s.sut.SetFailsafeDurationMinimum(time.Duration(time.Hour*2), true)
 	assert.Nil(s.T(), err)
 
+	err = s.sut.SetFailsafeConsumptionActivePowerLimit(10, true)
+	assert.Nil(s.T(), err)
+
 	limit, changeable, err = s.sut.FailsafeConsumptionActivePowerLimit()
 	assert.Equal(s.T(), 10.0, limit)
 	assert.Equal(s.T(), true, changeable)

diff --git a/usecases/cs/lpc/usecase.go b/usecases/cs/lpc/usecase.go
@@ -8,6 +8,7 @@ import (
 	"github.com/enbility/eebus-go/features/server"
 	ucapi "github.com/enbility/eebus-go/usecases/api"
 	"github.com/enbility/eebus-go/usecases/usecase"
+	"github.com/enbility/ship-go/logging"
 	spineapi "github.com/enbility/spine-go/api"
 	"github.com/enbility/spine-go/model"
 	"github.com/enbility/spine-go/spine"
@@ -124,11 +125,13 @@ func (e *LPC) approveOrDenyConsumptionLimit(msg *spineapi.Message, approve bool,
 func (e *LPC) loadControlWriteCB(msg *spineapi.Message) {
 	if msg.RequestHeader == nil || msg.RequestHeader.MsgCounter == nil ||
 		msg.Cmd.LoadControlLimitListData == nil {
+		logging.Log().Debug("LPC loadControlWriteCB: invalid message")
 		return
 	}
 
 	_, limitId, err := e.loadControlServerAndLimitId()
 	if err != nil {
+		logging.Log().Debug("LPC loadControlWriteCB: error getting limit id")
 		return
 	}
 
@@ -137,6 +140,7 @@ func (e *LPC) loadControlWriteCB(msg *spineapi.Message) {
 	// we assume there is always only one limit
 	if data == nil || data.LoadControlLimitData == nil ||
 		len(data.LoadControlLimitData) == 0 {
+		logging.Log().Debug("LPC loadControlWriteCB: no data")
 		return
 	}
 
@@ -223,7 +227,7 @@ func (e *LPC) AddFeatures() {
 		_ = dcs.UpdateKeyValueDataForFilter(
 			model.DeviceConfigurationKeyValueDataType{
 				Value:             value,
-				IsValueChangeable: util.Ptr(false),
+				IsValueChangeable: util.Ptr(true),
 			},
 			nil,
 			model.DeviceConfigurationKeyValueDescriptionDataType{
@@ -237,7 +241,7 @@ func (e *LPC) AddFeatures() {
 		_ = dcs.UpdateKeyValueDataForFilter(
 			model.DeviceConfigurationKeyValueDataType{
 				Value:             value,
-				IsValueChangeable: util.Ptr(false),
+				IsValueChangeable: util.Ptr(true),
 			},
 			nil,
 			model.DeviceConfigurationKeyValueDescriptionDataType{