Update misc. parse functions for bounds checking and style

- All test variations pass.
thingspect · Feb 2, 2024 · 24c7475 · 24c7475
1 parent 897b4fc
commit 24c7475
Show file tree

Hide file tree

Showing 7 changed files with 39 additions and 14 deletions.
diff --git a/pkg/decode/globalsat/ls11x.go b/pkg/decode/globalsat/ls11x.go
@@ -23,6 +23,11 @@ func ls11x(body []byte) ([]*decode.Point, error) {
 
 	// Parse humidity.
 	hum := float64(binary.BigEndian.Uint16(body[3:5])) / 100
+	if hum > 100 {
+		return msgs, decode.ErrFormat("ls11x", "humidity outside allowed range",
+			body)
+	}
+
 	msgs = append(msgs, &decode.Point{Attr: "humidity_pct", Value: hum})
 
 	return msgs, nil

diff --git a/pkg/decode/globalsat/ls11x_test.go b/pkg/decode/globalsat/ls11x_test.go
@@ -39,6 +39,11 @@ func TestLs11x(t *testing.T) {
 		// LS-11X bad length.
 		{"000102030405", nil, "ls11x format bad length: 000102030405"},
 		{"0001020304050607", nil, "ls11x format bad length: 0001020304050607"},
+		// LS-11X humidity outside allowed range.
+		{"020a18f0e70000", []*decode.Point{
+			{Attr: "temp_c", Value: 25.8},
+			{Attr: "temp_f", Value: 78.5},
+		}, "ls11x format humidity outside allowed range: 020a18f0e70000"},
 	}
 
 	for _, test := range tests {

diff --git a/pkg/decode/radiobridge/supervisory.go b/pkg/decode/radiobridge/supervisory.go
@@ -66,8 +66,8 @@ func supervisory(body []byte) ([]*decode.Point, error) {
 	// Parse battery level.
 	vInt := body[4] >> 4
 	vFract := body[4] & clearVolt
-	batt := float64(vInt) + float64(vFract)/10
-	msgs = append(msgs, &decode.Point{Attr: "battery_v", Value: batt})
+	volt := float64(vInt) + float64(vFract)/10
+	msgs = append(msgs, &decode.Point{Attr: "battery_v", Value: volt})
 
 	// Parse event count.
 	if len(body) >= 11 {

diff --git a/pkg/decode/tektelic/channel_type.go b/pkg/decode/tektelic/channel_type.go
@@ -69,13 +69,13 @@ func chanHumidity(body []byte) ([]*decode.Point, []byte, error) {
 			body)
 	}
 
-	// Parse humidity.
-	humidity, rem, err := typeHumidity(body)
+	// Parse hum.
+	hum, rem, err := typeHumidity(body)
 	if err != nil {
 		return nil, nil, err
 	}
 
-	return []*decode.Point{{Attr: "humidity_pct", Value: humidity}}, rem, nil
+	return []*decode.Point{{Attr: "humidity_pct", Value: hum}}, rem, nil
 }
 
 // chanBatteryV parses a Battery (V) data channel from a []byte according to the
@@ -91,11 +91,11 @@ func chanBatteryV(body []byte) ([]*decode.Point, []byte, error) {
 			body)
 	}
 
-	// Parse voltage.
-	voltage, rem, err := typeAnalogV(body)
+	// Parse volt.
+	volt, rem, err := typeAnalogV(body)
 	if err != nil {
 		return nil, nil, err
 	}
 
-	return []*decode.Point{{Attr: "battery_v", Value: voltage}}, rem, nil
+	return []*decode.Point{{Attr: "battery_v", Value: volt}}, rem, nil
 }
diff --git a/pkg/decode/tektelic/channel_type_test.go b/pkg/decode/tektelic/channel_type_test.go
@@ -76,6 +76,14 @@ func TestChanTempC(t *testing.T) {
 			{Attr: "temp_c", Value: 1.0},
 			{Attr: "temp_f", Value: 33.8},
 		}, []byte{}, ""},
+		{"036700ca", []*decode.Point{
+			{Attr: "temp_c", Value: 20.2},
+			{Attr: "temp_f", Value: 68.4},
+		}, []byte{}, ""},
+		{"0367fff0", []*decode.Point{
+			{Attr: "temp_c", Value: -1.6},
+			{Attr: "temp_f", Value: 29.1},
+		}, []byte{}, ""},
 		{"036700c4", []*decode.Point{
 			{Attr: "temp_c", Value: 19.6},
 			{Attr: "temp_f", Value: 67.3},

diff --git a/pkg/decode/tektelic/data_type.go b/pkg/decode/tektelic/data_type.go
@@ -69,10 +69,14 @@ func typeHumidity(body []byte) (float64, []byte, error) {
 		return 0, nil, decode.ErrFormat("typeHumidity", "bad identifier", body)
 	}
 
-	// Parse humidity.
-	humidity := float64(body[2]) / 2
+	// Parse hum.
+	hum := float64(body[2]) / 2
+	if hum > 100 {
+		return 0, nil, decode.ErrFormat("typeHumidity", "outside allowed range",
+			body)
+	}
 
-	return humidity, body[3:], nil
+	return hum, body[3:], nil
 }
 
 // typeAnalogV parses a Analog (V) data type from a []byte according to the spec
@@ -87,8 +91,8 @@ func typeAnalogV(body []byte) (float64, []byte, error) {
 		return 0, nil, decode.ErrFormat("typeAnalogV", "bad identifier", body)
 	}
 
-	// Parse voltage.
-	voltage := float64(int16(binary.BigEndian.Uint16(body[2:4]))) / 100
+	// Parse volt.
+	volt := float64(binary.BigEndian.Uint16(body[2:4])) / 100
 
-	return voltage, body[4:], nil
+	return volt, body[4:], nil
 }
diff --git a/pkg/decode/tektelic/data_type_test.go b/pkg/decode/tektelic/data_type_test.go
@@ -70,6 +70,7 @@ func TestTypeTempC(t *testing.T) {
 		// Temperature.
 		{"0367000a", 1, []byte{}, ""},
 		{"036700ca", 20.2, []byte{}, ""},
+		{"0367fff0", -1.6, []byte{}, ""},
 		{"036700c4", 19.6, []byte{}, ""},
 		{"036700c404687f", 19.6, []byte{0x04, 0x68, 0x7f}, ""},
 		// Temperature bad length.
@@ -120,6 +121,8 @@ func TestTypeHumidity(t *testing.T) {
 		{"04", 0, nil, "typeHumidity format bad length: 04"},
 		// Humidity bad identifier.
 		{"04697f", 0, nil, "typeHumidity format bad identifier: 04697f"},
+		// Humidity outside allowed range.
+		{"0468f0", 0, nil, "typeHumidity format outside allowed range: 0468f0"},
 	}
 
 	for _, test := range tests {