Refactor metrics.proto file

This commit refactors the metrics proto files to be more modular and
easier to maintain. The metrics proto files are now split into two
files: `metric_sample.proto` and `bounds.proto`. The former contains
the definition of the `MetricSample` message, while the latter contains
the definition of the `Bounds` message. The files have also been moved
into a new directory `metrics`, establishing their package name as
`frequenz.api.common.v1.metrics`.

Signed-off-by: Tiyash Basu <[email protected]>

Author: tiyash-basu-frequenz

proto/frequenz/api/common/v1/metrics/bounds.proto

@@ -0,0 +1,23 @@
+// Definitions for bounds.
+//
+// Copyright:
+// Copyright 2023 Frequenz Energy-as-a-Service GmbH
+//
+// License:
+// MIT
+
+syntax = "proto3";
+
+package frequenz.api.common.v1.metrics;
+
+// A set of lower and upper bounds for any metric.
+// The units of the bounds are always the same as the related metric.
+message Bounds {
+  // The lower bound.
+  // If absent, there is no lower bound.
+  optional float lower = 1;
+
+  // The upper bound.
+  // If absent, there is no upper bound.
+  optional float upper = 2;
+}

proto/frequenz/api/common/v1/metrics/electrical.proto

@@ -10,7 +10,7 @@ syntax = "proto3";
 
 package frequenz.api.common.v1.metrics.electrical;
 
-import "frequenz/api/common/v1/metrics.proto";
+import "frequenz/api/common/v1/metrics/metric_sample.proto";
 
 // Metrics of a DC electrical connection.
 message DC {

proto/frequenz/api/common/v1/metrics.proto renamed to proto/frequenz/api/common/v1/metrics/metric_sample.proto

@@ -1,4 +1,4 @@
-// Metrics & bounds definitions.
+// Metrics definitions.
 //
 // Copyright:
 // Copyright 2023 Frequenz Energy-as-a-Service GmbH
@@ -10,19 +10,9 @@ syntax = "proto3";
 
 package frequenz.api.common.v1.metrics;
 
-import "google/protobuf/timestamp.proto";
-
-// A set of lower and upper bounds for any metric.
-// The units of the bounds are always the same as the related metric.
-message Bounds {
-  // The lower bound.
-  // If absent, there is no lower bound.
-  optional float lower = 1;
+import "frequenz/api/common/v1/metrics/bounds.proto";
 
-  // The upper bound.
-  // If absent, there is no upper bound.
-  optional float upper = 2;
-}
+import "google/protobuf/timestamp.proto";
 
 // Represents a single sample of a specific metric, the value of which is either
 // measured or derived at a particular time.

proto/frequenz/api/common/v1/microgrid/components/components.proto

@@ -10,7 +10,7 @@ syntax = "proto3";
 
 package frequenz.api.common.v1.microgrid.components;
 
-import "frequenz/api/common/v1/metrics.proto";
+import "frequenz/api/common/v1/metrics/metric_sample.proto";
 import "frequenz/api/common/v1/microgrid/components/battery.proto";
 import "frequenz/api/common/v1/microgrid/components/ev_charger.proto";
 import "frequenz/api/common/v1/microgrid/components/fuse.proto";

proto/frequenz/api/common/v1/microgrid/sensors/sensors.proto

@@ -10,7 +10,7 @@ syntax = "proto3";
 
 package frequenz.api.common.v1.microgrid.sensors;
 
-import "frequenz/api/common/v1/metrics.proto";
+import "frequenz/api/common/v1/metrics/metric_sample.proto";
 import "frequenz/api/common/v1/microgrid/lifetime.proto";
 
 import "google/protobuf/timestamp.proto";

pytests/test_common.py

@@ -12,30 +12,30 @@ def test_package_import() -> None:
     assert v1 is not None
 
 
-def test_module_import_metrics() -> None:
+def test_module_import_metrics_electrical() -> None:
     """Test that the modules can be imported."""
     # pylint: disable=import-outside-toplevel
-    from frequenz.api.common.v1 import metrics_pb2
+    from frequenz.api.common.v1.metrics import electrical_pb2
 
-    assert metrics_pb2 is not None
+    assert electrical_pb2 is not None
 
     # pylint: disable=import-outside-toplevel
-    from frequenz.api.common.v1 import metrics_pb2_grpc
+    from frequenz.api.common.v1.metrics import electrical_pb2_grpc
 
-    assert metrics_pb2_grpc is not None
+    assert electrical_pb2_grpc is not None
 
 
-def test_module_import_metrics_electrical() -> None:
+def test_module_import_metrics_bounds() -> None:
     """Test that the modules can be imported."""
     # pylint: disable=import-outside-toplevel
-    from frequenz.api.common.v1.metrics import electrical_pb2
+    from frequenz.api.common.v1.metrics import bounds_pb2
 
-    assert electrical_pb2 is not None
+    assert bounds_pb2 is not None
 
     # pylint: disable=import-outside-toplevel
-    from frequenz.api.common.v1.metrics import electrical_pb2_grpc
+    from frequenz.api.common.v1.metrics import bounds_pb2_grpc
 
-    assert electrical_pb2_grpc is not None
+    assert bounds_pb2_grpc is not None
 
 
 def test_module_import_grid() -> None: