BACK-3110 Validate maximum number of segments of ISF, Carb Ratio and Correction Range

Author: toddkazakov

go.mod

@@ -21,7 +21,7 @@ require (
 	github.com/prometheus/client_golang v1.19.1
 	github.com/rinchsan/device-check-go v1.3.0
 	github.com/tidepool-org/clinic/client v0.0.0-20240629034458-1365c8963143
-	github.com/tidepool-org/devices/api v0.0.0-20240711091104-8b8e20a3e2c7
+	github.com/tidepool-org/devices/api v0.0.0-20240806072455-2b18f22c9cf5
 	github.com/tidepool-org/go-common v0.12.2-0.20240612192926-de6d5c5a742c
 	github.com/tidepool-org/hydrophone/client v0.0.0-20240613043503-6c32828b1ace
 	github.com/urfave/cli v1.22.15

go.sum

@@ -178,6 +178,8 @@ github.com/tidepool-org/clinic/client v0.0.0-20240629034458-1365c8963143 h1:A6qF
 github.com/tidepool-org/clinic/client v0.0.0-20240629034458-1365c8963143/go.mod h1:7BpAdFdGJNB3aw/xvCz5XnWjSWRoUtWIX4xcMc4Bsko=
 github.com/tidepool-org/devices/api v0.0.0-20240711091104-8b8e20a3e2c7 h1:sfE4V+umi8HM8T2RJLuCd/Dfx/Ba0XREXbfTamke+Aw=
 github.com/tidepool-org/devices/api v0.0.0-20240711091104-8b8e20a3e2c7/go.mod h1:xuQ8k0mLR1ZyEmwe/m0v2BuXctqQuCZeR43urSQpTUM=
+github.com/tidepool-org/devices/api v0.0.0-20240806072455-2b18f22c9cf5 h1:1kiZtHhs++yXayRD/Mh/3POLwtmxV99YR2bSCle1Q74=
+github.com/tidepool-org/devices/api v0.0.0-20240806072455-2b18f22c9cf5/go.mod h1:xuQ8k0mLR1ZyEmwe/m0v2BuXctqQuCZeR43urSQpTUM=
 github.com/tidepool-org/go-common v0.12.2-0.20240612192926-de6d5c5a742c h1:hJZyiHNGeqyLA/5p60/0H9CZtJi4fAuzOuyQF0TpF7E=
 github.com/tidepool-org/go-common v0.12.2-0.20240612192926-de6d5c5a742c/go.mod h1:mIzYteUyPf//fhee4e2KEZhmcm2iE4IQ/2dyQr5pRKA=
 github.com/tidepool-org/hydrophone/client v0.0.0-20240613043503-6c32828b1ace h1:L0UiCj2eL/NOpLa19Tf5IgoK6feILmdA+zK3nCTIhqU=

guardrails/carb_ratio_schedule.go

@@ -3,13 +3,18 @@ package guardrails
 import (
 	devices "github.com/tidepool-org/devices/api"
 
+	structureValidator "github.com/tidepool-org/platform/structure/validator"
+
 	"strconv"
 
 	"github.com/tidepool-org/platform/data/types/settings/pump"
 	"github.com/tidepool-org/platform/structure"
 )
 
 func ValidateCarbohydrateRatioSchedule(carbohydrateRatioSchedule pump.CarbohydrateRatioStartArray, guardRail *devices.CarbohydrateRatioGuardRail, validator structure.Validator) {
+	if guardRail.MaxSegments != nil && len(carbohydrateRatioSchedule) > int(*guardRail.MaxSegments) {
+		validator.ReportError(structureValidator.ErrorLengthNotLessThanOrEqualTo(len(carbohydrateRatioSchedule), int(*guardRail.MaxSegments)))
+	}
 	validValues := generateValidValuesFromAbsoluteBounds(guardRail.AbsoluteBounds)
 	for i, carbRatio := range carbohydrateRatioSchedule {
 		ValidateValueIfNotNil(carbRatio.Amount, validValues, validator.WithReference(strconv.Itoa(i)).WithReference("amount"))

guardrails/carb_ratio_schedule_test.go

@@ -50,4 +50,17 @@ var _ = Describe("ValidateCarbohydrateRatioSchedule", func() {
 		guardrails.ValidateCarbohydrateRatioSchedule(schedule, guardRail, validator)
 		errorsTest.ExpectEqual(validator.Error(), expected)
 	})
+
+	It("returns an error when the number of segments is higher than the guardrail", func() {
+		maxSegments := int32(2)
+		guardRail.MaxSegments = &maxSegments
+		var schedule pump.CarbohydrateRatioStartArray = []*pump.CarbohydrateRatioStart{
+			{Amount: pointer.FromFloat64(120.01)},
+			{Amount: pointer.FromFloat64(110.01)},
+			{Amount: pointer.FromFloat64(10.00)},
+		}
+		expected := errorsTest.WithPointerSource(structureValidator.ErrorLengthNotLessThanOrEqualTo(3, 2), "")
+		guardrails.ValidateCarbohydrateRatioSchedule(schedule, guardRail, validator)
+		errorsTest.ExpectEqual(validator.Error(), expected)
+	})
 })

guardrails/correction_range.go

@@ -4,6 +4,8 @@ import (
 	"math"
 	"strconv"
 
+	structureValidator "github.com/tidepool-org/platform/structure/validator"
+
 	devices "github.com/tidepool-org/devices/api"
 
 	"github.com/tidepool-org/platform/data/blood/glucose"
@@ -12,6 +14,9 @@ import (
 )
 
 func ValidateBloodGlucoseTargetSchedule(bloodGlucoseTargetSchedule pump.BloodGlucoseTargetStartArray, glucoseSafetyLimit *float64, guardRail *devices.CorrectionRangeGuardRail, validator structure.Validator) {
+	if guardRail.MaxSegments != nil && len(bloodGlucoseTargetSchedule) > int(*guardRail.MaxSegments) {
+		validator.ReportError(structureValidator.ErrorLengthNotLessThanOrEqualTo(len(bloodGlucoseTargetSchedule), int(*guardRail.MaxSegments)))
+	}
 	for i, bloodGlucoseTargetStart := range bloodGlucoseTargetSchedule {
 		ValidateBloodGlucoseTarget(bloodGlucoseTargetStart.Target, glucoseSafetyLimit, guardRail, validator.WithReference(strconv.Itoa(i)))
 	}

guardrails/correction_range_test.go

@@ -95,6 +95,19 @@ var _ = Describe("Correction Range", func() {
 					guardrails.ValidateBloodGlucoseTargetSchedule(schedule, glucoseSafetyLimit, guardRail, validator)
 					errorsTest.ExpectEqual(validator.Error(), expected...)
 				})
+
+				It("returns an error when the number of segments is higher than the guardrail", func() {
+					maxSegments := int32(2)
+					guardRail.MaxSegments = &maxSegments
+					var schedule pump.BloodGlucoseTargetStartArray = []*pump.BloodGlucoseTargetStart{
+						{Target: glucose.Target{Low: pointer.FromFloat64(90), High: pointer.FromFloat64(91)}},
+						{Target: glucose.Target{Low: pointer.FromFloat64(100), High: pointer.FromFloat64(105)}},
+						{Target: glucose.Target{Low: pointer.FromFloat64(101), High: pointer.FromFloat64(104)}},
+					}
+					expected := errorsTest.WithPointerSource(structureValidator.ErrorLengthNotLessThanOrEqualTo(3, 2), "")
+					guardrails.ValidateBloodGlucoseTargetSchedule(schedule, glucoseSafetyLimit, guardRail, validator)
+					errorsTest.ExpectEqual(validator.Error(), expected)
+				})
 			})
 
 			Context("With Target values", func() {

guardrails/insulin_sensitivity_schedule.go

@@ -3,13 +3,18 @@ package guardrails
 import (
 	devices "github.com/tidepool-org/devices/api"
 
+	structureValidator "github.com/tidepool-org/platform/structure/validator"
+
 	"strconv"
 
 	"github.com/tidepool-org/platform/data/types/settings/pump"
 	"github.com/tidepool-org/platform/structure"
 )
 
 func ValidateInsulinSensitivitySchedule(insulinSensitivitySchedule pump.InsulinSensitivityStartArray, guardRail *devices.InsulinSensitivityGuardRail, validator structure.Validator) {
+	if guardRail.MaxSegments != nil && len(insulinSensitivitySchedule) > int(*guardRail.MaxSegments) {
+		validator.ReportError(structureValidator.ErrorLengthNotLessThanOrEqualTo(len(insulinSensitivitySchedule), int(*guardRail.MaxSegments)))
+	}
 	validValues := generateValidValuesFromAbsoluteBounds(guardRail.AbsoluteBounds)
 	for i, insulinSensitivity := range insulinSensitivitySchedule {
 		ValidateValueIfNotNil(insulinSensitivity.Amount, validValues, validator.WithReference(strconv.Itoa(i)).WithReference("amount"))

guardrails/insulin_sensitivity_schedule_test.go

@@ -50,4 +50,18 @@ var _ = Describe("ValidateInsulinSensitivitySchedule", func() {
 		guardrails.ValidateInsulinSensitivitySchedule(schedule, guardRail, validator)
 		errorsTest.ExpectEqual(validator.Error(), expected)
 	})
+
+	It("returns an error when the number of segments is higher than the guardrail", func() {
+		maxSegments := int32(2)
+		guardRail.MaxSegments = &maxSegments
+		var schedule pump.InsulinSensitivityStartArray = []*pump.InsulinSensitivityStart{
+			{Amount: pointer.FromFloat64(120.00)},
+			{Amount: pointer.FromFloat64(110.00)},
+			{Amount: pointer.FromFloat64(10.00)},
+		}
+
+		expected := errorsTest.WithPointerSource(structureValidator.ErrorLengthNotLessThanOrEqualTo(3, 2), "")
+		guardrails.ValidateInsulinSensitivitySchedule(schedule, guardRail, validator)
+		errorsTest.ExpectEqual(validator.Error(), expected)
+	})
 })