From 06b6f0c6de0c50828744edb6f9c6b4ce8e5e82a6 Mon Sep 17 00:00:00 2001 From: Tiyash Basu Date: Mon, 19 May 2025 16:42:45 +0200 Subject: [PATCH] Rename `metric_sample.proto` to `metrics.proto` This change renames the `metric_sample.proto` file to `metrics.proto` to better reflect its content. The file contains multiple metric-related messages, including `SimpleMetricValue` and `MetricSample`, which are used to represent metric values and samples, respectively. The new name `metrics.proto` is more descriptive and aligns with the purpose of the file. Signed-off-by: Tiyash Basu # Conflicts: # RELEASE_NOTES.md --- RELEASE_NOTES.md | 1 + .../v1/metrics/{metric_sample.proto => metrics.proto} | 0 .../electrical_components/electrical_components.proto | 2 +- .../api/common/v1/microgrid/sensors/sensors.proto | 2 +- pytests/test_common.py | 10 +++++----- 5 files changed, 8 insertions(+), 7 deletions(-) rename proto/frequenz/api/common/v1/metrics/{metric_sample.proto => metrics.proto} (100%) diff --git a/RELEASE_NOTES.md b/RELEASE_NOTES.md index d8a9f37e..e986d736 100644 --- a/RELEASE_NOTES.md +++ b/RELEASE_NOTES.md @@ -25,6 +25,7 @@ - Remove unnecessary gap in numbering in the `ElectricalComponentCategory` enum. - Renumber variants in the `Metric` enum to remove unnecessary gaps. - Added a new enum `ElectricalComponentControlMode` to define control modes for electrical components. +- Renamed `metric_sample.proto` to `metrics.proto` to better reflect its content. ## Bug Fixes diff --git a/proto/frequenz/api/common/v1/metrics/metric_sample.proto b/proto/frequenz/api/common/v1/metrics/metrics.proto similarity index 100% rename from proto/frequenz/api/common/v1/metrics/metric_sample.proto rename to proto/frequenz/api/common/v1/metrics/metrics.proto diff --git a/proto/frequenz/api/common/v1/microgrid/electrical_components/electrical_components.proto b/proto/frequenz/api/common/v1/microgrid/electrical_components/electrical_components.proto index 7c5a22b7..072905b3 100644 --- a/proto/frequenz/api/common/v1/microgrid/electrical_components/electrical_components.proto +++ b/proto/frequenz/api/common/v1/microgrid/electrical_components/electrical_components.proto @@ -11,7 +11,7 @@ syntax = "proto3"; package frequenz.api.common.v1.microgrid.electrical_components; import "frequenz/api/common/v1/metrics/bounds.proto"; -import "frequenz/api/common/v1/metrics/metric_sample.proto"; +import "frequenz/api/common/v1/metrics/metrics.proto"; import "frequenz/api/common/v1/microgrid/electrical_components/battery.proto"; import "frequenz/api/common/v1/microgrid/electrical_components/ev_charger.proto"; diff --git a/proto/frequenz/api/common/v1/microgrid/sensors/sensors.proto b/proto/frequenz/api/common/v1/microgrid/sensors/sensors.proto index e48e5739..c79ec263 100644 --- a/proto/frequenz/api/common/v1/microgrid/sensors/sensors.proto +++ b/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/metric_sample.proto"; +import "frequenz/api/common/v1/metrics/metrics.proto"; import "frequenz/api/common/v1/microgrid/lifetime.proto"; import "google/protobuf/timestamp.proto"; diff --git a/pytests/test_common.py b/pytests/test_common.py index 9d214b75..1418b880 100644 --- a/pytests/test_common.py +++ b/pytests/test_common.py @@ -38,17 +38,17 @@ def test_module_import_metrics_bounds() -> None: assert bounds_pb2_grpc is not None -def test_module_import_metrics_metric_sample() -> None: +def test_module_import_metrics_metrics() -> None: """Test that the modules can be imported.""" # pylint: disable=import-outside-toplevel - from frequenz.api.common.v1.metrics import metric_sample_pb2 + from frequenz.api.common.v1.metrics import metrics_pb2 - assert metric_sample_pb2 is not None + assert metrics_pb2 is not None # pylint: disable=import-outside-toplevel - from frequenz.api.common.v1.metrics import metric_sample_pb2_grpc + from frequenz.api.common.v1.metrics import metrics_pb2_grpc - assert metric_sample_pb2_grpc is not None + assert metrics_pb2_grpc is not None def test_module_import_grid() -> None: