Update proto file paths and packages related to microgrids

tiyash-basu-frequenz · tiyash-basu-frequenz · commit b4c2ce4f02a0 · 2023-11-07T17:25:45.000+01:00
The following package renames have been done:

- `frequenz.api.common.v1.components` -&gt;
   `frequenz.api.common.v1.microgrid.components`

- `frequenz.api.common.v1.lifetime` -&gt;
   `frequenz.api.common.v1.microgrid.lifetime`

- `frequenz.api.common.v1.sensors` -&gt;
   `frequenz.api.common.v1.microgrid.sensors`

Signed-off-by: Tiyash Basu &lt;tiyash.basu@frequenz.com&gt;
diff --git a/proto/frequenz/api/common/v1/microgrid/components/battery.proto b/proto/frequenz/api/common/v1/microgrid/components/battery.proto
@@ -8,7 +8,7 @@
 
 syntax = "proto3";
 
-package frequenz.api.common.v1.components;
+package frequenz.api.common.v1.microgrid.components;
 
 // Enumerated battery types.
 enum BatteryType {
diff --git a/proto/frequenz/api/common/v1/microgrid/components/components.proto b/proto/frequenz/api/common/v1/microgrid/components/components.proto
@@ -8,16 +8,16 @@
 
 syntax = "proto3";
 
-package frequenz.api.common.v1.components;
-
-import "frequenz/api/common/v1/components/battery.proto";
-import "frequenz/api/common/v1/components/ev_charger.proto";
-import "frequenz/api/common/v1/components/fuse.proto";
-import "frequenz/api/common/v1/components/grid.proto";
-import "frequenz/api/common/v1/components/inverter.proto";
-import "frequenz/api/common/v1/components/transformer.proto";
-import "frequenz/api/common/v1/lifetime.proto";
+package frequenz.api.common.v1.microgrid.components;
+
 import "frequenz/api/common/v1/metrics.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";
+import "frequenz/api/common/v1/microgrid/components/grid.proto";
+import "frequenz/api/common/v1/microgrid/components/inverter.proto";
+import "frequenz/api/common/v1/microgrid/components/transformer.proto";
+import "frequenz/api/common/v1/microgrid/lifetime.proto";
 
 import "google/protobuf/timestamp.proto";
 
@@ -85,12 +85,12 @@ enum ComponentCategory {
 // Metadata specific to a microgrid component.
 message ComponentCategoryMetadataVariant {
   oneof metadata {
-    frequenz.api.common.v1.components.Battery battery = 1;
-    frequenz.api.common.v1.components.EvCharger ev_charger = 2;
-    frequenz.api.common.v1.components.Fuse fuse = 3;
-    frequenz.api.common.v1.components.GridConnectionPoint grid = 4;
-    frequenz.api.common.v1.components.Inverter inverter = 5;
-    frequenz.api.common.v1.components.VoltageTransformer
+    frequenz.api.common.v1.microgrid.components.Battery battery = 1;
+    frequenz.api.common.v1.microgrid.components.EvCharger ev_charger = 2;
+    frequenz.api.common.v1.microgrid.components.Fuse fuse = 3;
+    frequenz.api.common.v1.microgrid.components.GridConnectionPoint grid = 4;
+    frequenz.api.common.v1.microgrid.components.Inverter inverter = 5;
+    frequenz.api.common.v1.microgrid.components.VoltageTransformer
       voltage_transformer = 6;
   }
 }
@@ -140,7 +140,7 @@ message Component {
   ComponentStatus status = 8;
 
   // The operational lifetime of the component.
-  frequenz.api.common.v1.lifetime.Lifetime operational_lifetime = 9;
+  frequenz.api.common.v1.microgrid.Lifetime operational_lifetime = 9;
 }
 
 // ComponentConnection describes a single electrical link between two components
@@ -177,7 +177,7 @@ message ComponentConnection {
   uint64 destination_component_id = 2;
 
   // The operational lifetime of the connection.
-  frequenz.api.common.v1.lifetime.Lifetime operational_lifetime = 3;
+  frequenz.api.common.v1.microgrid.Lifetime operational_lifetime = 3;
 }
 
 // ComponentData message aggregates multiple metrics, operational states, and
diff --git a/proto/frequenz/api/common/v1/microgrid/components/ev_charger.proto b/proto/frequenz/api/common/v1/microgrid/components/ev_charger.proto
@@ -8,7 +8,7 @@
 
 syntax = "proto3";
 
-package frequenz.api.common.v1.components;
+package frequenz.api.common.v1.microgrid.components;
 
 // Enumerated EV charger types.
 enum EvChargerType {
diff --git a/proto/frequenz/api/common/v1/microgrid/components/fuse.proto b/proto/frequenz/api/common/v1/microgrid/components/fuse.proto
@@ -8,7 +8,7 @@
 
 syntax = "proto3";
 
-package frequenz.api.common.v1.components;
+package frequenz.api.common.v1.microgrid.components;
 
 // A representation of a fuse.
 // The fuse component represents a fuse in the microgrid. It is used to protect
diff --git a/proto/frequenz/api/common/v1/microgrid/components/grid.proto b/proto/frequenz/api/common/v1/microgrid/components/grid.proto
@@ -8,7 +8,7 @@
 
 syntax = "proto3";
 
-package frequenz.api.common.v1.components;
+package frequenz.api.common.v1.microgrid.components;
 
 // A representation of a grid connection point. This is the point where a
 // microgrid connects to the grid.
diff --git a/proto/frequenz/api/common/v1/microgrid/components/inverter.proto b/proto/frequenz/api/common/v1/microgrid/components/inverter.proto
@@ -8,7 +8,7 @@
 
 syntax = "proto3";
 
-package frequenz.api.common.v1.components;
+package frequenz.api.common.v1.microgrid.components;
 
 // Enumerated inverter types.
 enum InverterType {
diff --git a/proto/frequenz/api/common/v1/microgrid/components/transformer.proto b/proto/frequenz/api/common/v1/microgrid/components/transformer.proto
@@ -8,7 +8,7 @@
 
 syntax = "proto3";
 
-package frequenz.api.common.v1.components;
+package frequenz.api.common.v1.microgrid.components;
 
 // A representation of a voltage transformer.
 // Voltage transformers are used to step up or step down the voltage, keeping
diff --git a/proto/frequenz/api/common/v1/microgrid/lifetime.proto b/proto/frequenz/api/common/v1/microgrid/lifetime.proto
@@ -7,7 +7,7 @@
 
 syntax = "proto3";
 
-package frequenz.api.common.v1.lifetime;
+package frequenz.api.common.v1.microgrid;
 
 import "google/protobuf/timestamp.proto";
 
diff --git a/proto/frequenz/api/common/v1/microgrid/microgrid.proto b/proto/frequenz/api/common/v1/microgrid/microgrid.proto
diff --git a/proto/frequenz/api/common/v1/microgrid/sensors/sensors.proto b/proto/frequenz/api/common/v1/microgrid/sensors/sensors.proto
@@ -8,10 +8,10 @@
 
 syntax = "proto3";
 
-package frequenz.api.common.v1.sensors;
+package frequenz.api.common.v1.microgrid.sensors;
 
-import "frequenz/api/common/v1/lifetime.proto";
 import "frequenz/api/common/v1/metrics.proto";
+import "frequenz/api/common/v1/microgrid/lifetime.proto";
 
 import "google/protobuf/timestamp.proto";
 
@@ -64,7 +64,7 @@ message Sensor {
   string model_name = 6;
 
   // The operational lifetime of the sensor.
-  frequenz.api.common.v1.lifetime.Lifetime operational_lifetime = 7;
+  frequenz.api.common.v1.microgrid.Lifetime operational_lifetime = 7;
 }
 
 // Enumrated sensor metrics.
diff --git a/py/frequenz/api/common/v1/microgrid/__init__.py b/py/frequenz/api/common/v1/microgrid/__init__.py
diff --git a/py/frequenz/api/common/v1/microgrid/components/__init__.py b/py/frequenz/api/common/v1/microgrid/components/__init__.py
diff --git a/py/frequenz/api/common/v1/microgrid/sensors/__init__.py b/py/frequenz/api/common/v1/microgrid/sensors/__init__.py
diff --git a/pytests/test_common.py b/pytests/test_common.py
@@ -12,19 +12,6 @@ def test_package_import() -> None:
     assert v1 is not None
 
 
-def test_module_import_components() -> None:
-    """Test that the modules can be imported."""
-    # pylint: disable=import-outside-toplevel
-    from frequenz.api.common.v1 import components_pb2
-
-    assert components_pb2 is not None
-
-    # pylint: disable=import-outside-toplevel
-    from frequenz.api.common.v1 import components_pb2_grpc
-
-    assert components_pb2_grpc is not None
-
-
 def test_module_import_metrics() -> None:
     """Test that the modules can be imported."""
     # pylint: disable=import-outside-toplevel
@@ -62,3 +49,112 @@ def test_module_import_grid() -> None:
     from frequenz.api.common.v1 import grid_pb2_grpc
 
     assert grid_pb2_grpc is not None
+
+
+def test_module_import_microgrid() -> None:
+    """Test that the modules can be imported."""
+    # pylint: disable=import-outside-toplevel
+    from frequenz.api.common.v1 import microgrid
+
+    assert microgrid is not None
+
+    # pylint: disable=import-outside-toplevel
+    from frequenz.api.common.v1.microgrid import microgrid_pb2
+
+    assert microgrid_pb2 is not None
+
+    # pylint: disable=import-outside-toplevel
+    from frequenz.api.common.v1.microgrid import microgrid_pb2_grpc
+
+    assert microgrid_pb2_grpc is not None
+
+
+def test_module_import_microgrid_lifetime() -> None:
+    """Test that the modules can be imported."""
+    # pylint: disable=import-outside-toplevel
+    from frequenz.api.common.v1.microgrid import lifetime_pb2
+
+    assert lifetime_pb2 is not None
+
+    # pylint: disable=import-outside-toplevel
+    from frequenz.api.common.v1.microgrid import lifetime_pb2_grpc
+
+    assert lifetime_pb2_grpc is not None
+
+
+def test_module_import_microgrid_components() -> None:
+    """Test that the modules can be imported."""
+    # pylint: disable=import-outside-toplevel
+    from frequenz.api.common.v1.microgrid import components
+
+    assert components is not None
+
+    # pylint: disable=import-outside-toplevel
+    from frequenz.api.common.v1.microgrid.components import battery_pb2
+
+    assert battery_pb2 is not None
+
+    # pylint: disable=import-outside-toplevel
+    from frequenz.api.common.v1.microgrid.components import battery_pb2_grpc
+
+    assert battery_pb2_grpc is not None
+
+    # pylint: disable=import-outside-toplevel
+    from frequenz.api.common.v1.microgrid.components import components_pb2
+
+    assert components_pb2 is not None
+
+    # pylint: disable=import-outside-toplevel
+    from frequenz.api.common.v1.microgrid.components import components_pb2_grpc
+
+    assert components_pb2_grpc is not None
+
+    # pylint: disable=import-outside-toplevel
+    from frequenz.api.common.v1.microgrid.components import ev_charger_pb2
+
+    assert ev_charger_pb2 is not None
+
+    # pylint: disable=import-outside-toplevel
+    from frequenz.api.common.v1.microgrid.components import ev_charger_pb2_grpc
+
+    assert ev_charger_pb2_grpc is not None
+
+    # pylint: disable=import-outside-toplevel
+    from frequenz.api.common.v1.microgrid.components import fuse_pb2
+
+    assert fuse_pb2 is not None
+
+    # pylint: disable=import-outside-toplevel
+    from frequenz.api.common.v1.microgrid.components import fuse_pb2_grpc
+
+    assert fuse_pb2_grpc is not None
+
+    # pylint: disable=import-outside-toplevel
+    from frequenz.api.common.v1.microgrid.components import grid_pb2
+
+    assert grid_pb2 is not None
+
+    # pylint: disable=import-outside-toplevel
+    from frequenz.api.common.v1.microgrid.components import grid_pb2_grpc
+
+    assert grid_pb2_grpc is not None
+
+    # pylint: disable=import-outside-toplevel
+    from frequenz.api.common.v1.microgrid.components import inverter_pb2
+
+    assert inverter_pb2 is not None
+
+    # pylint: disable=import-outside-toplevel
+    from frequenz.api.common.v1.microgrid.components import inverter_pb2_grpc
+
+    assert inverter_pb2_grpc is not None
+
+    # pylint: disable=import-outside-toplevel
+    from frequenz.api.common.v1.microgrid.components import transformer_pb2
+
+    assert transformer_pb2 is not None
+
+    # pylint: disable=import-outside-toplevel
+    from frequenz.api.common.v1.microgrid.components import transformer_pb2_grpc
+
+    assert transformer_pb2_grpc is not None
