Add versioning to common proto files (#90)

This commit adds versioning to the common proto files. This is done by
adding a v1 directory to the common directory and moving all the proto
files into it. The proto packages are also renamed to include the v1
suffix.

This commit also updates the imports in the test_common.py file to
reflect the changes.

Author: tiyash-basu-frequenz

RELEASE_NOTES.md

@@ -6,7 +6,9 @@
 
 ## Upgrading
 
-<!-- Here goes notes on how to upgrade from previous versions, including deprecations and what they should be replaced with -->
+- The package names have been changed from `frequenz.api.common.<package>` to
+  `frequenz.api.common.v1.<package>`. `v1` is the API's major version, and will
+  be incremented for breaking changes.
 
 ## New Features
 

proto/frequenz/api/common/components.proto renamed to proto/frequenz/api/common/v1/components.proto

@@ -8,7 +8,7 @@
 
 syntax = "proto3";
 
-package frequenz.api.common.components;
+package frequenz.api.common.v1.components;
 
 // Enumrated component categories.
 enum ComponentCategory {

proto/frequenz/api/common/location.proto renamed to proto/frequenz/api/common/v1/location.proto

@@ -7,7 +7,7 @@
 
 syntax = "proto3";
 
-package frequenz.api.common.location;
+package frequenz.api.common.v1.location;
 
 // A pair of geographical co-ordinates, representing the location of a place.
 message Location {

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

@@ -8,7 +8,7 @@
 
 syntax = "proto3";
 
-package frequenz.api.common.metrics;
+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.
@@ -114,11 +114,11 @@ message MetricAggregation {
   // The manufacturer's rated bounds of the metric. This may differ from
   // `system_bounds` as it does not take into account the current state of the
   // overall system.
-  frequenz.api.common.metrics.Bounds rated_bounds = 13;
+  frequenz.api.common.v1.metrics.Bounds rated_bounds = 13;
 
   // The current bounds of the metric, as imposed by the component this metric
   // originates from.
-  frequenz.api.common.metrics.Bounds component_bounds = 14;
+  frequenz.api.common.v1.metrics.Bounds component_bounds = 14;
 
   // These bounds indicate the range of values that are disallowed for the
   // metric.
@@ -147,7 +147,7 @@ message MetricAggregation {
   // ```
   // ---- values here are disallowed and wil be rejected
   // ==== vales here are allowed and will be accepted
-  frequenz.api.common.metrics.Bounds system_exclusion_bounds = 4;
+  frequenz.api.common.v1.metrics.Bounds system_exclusion_bounds = 4;
 
   // These bounds indicate the range of values that are allowed for the metric.
   // If these bounds for a metric are [`lower`, `upper`], then this metric's
@@ -174,5 +174,5 @@ message MetricAggregation {
   // ```
   // ---- values here are disallowed and wil be rejected
   // ==== vales here are allowed and will be accepted
-  frequenz.api.common.metrics.Bounds system_inclusion_bounds = 5;
+  frequenz.api.common.v1.metrics.Bounds system_inclusion_bounds = 5;
 }

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

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

py/frequenz/api/common/__init__.py renamed to py/frequenz/api/common/v1/__init__.py

@@ -7,45 +7,45 @@
 def test_package_import() -> None:
     """Test that the package can be imported."""
     # pylint: disable=import-outside-toplevel
-    from frequenz.api import common
+    from frequenz.api.common import v1
 
-    assert common is not 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 import components_pb2
+    from frequenz.api.common.v1 import components_pb2
 
     assert components_pb2 is not None
 
     # pylint: disable=import-outside-toplevel
-    from frequenz.api.common import components_pb2_grpc
+    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
-    from frequenz.api.common import metrics_pb2
+    from frequenz.api.common.v1 import metrics_pb2
 
     assert metrics_pb2 is not None
 
     # pylint: disable=import-outside-toplevel
-    from frequenz.api.common import metrics_pb2_grpc
+    from frequenz.api.common.v1 import metrics_pb2_grpc
 
     assert metrics_pb2_grpc is not None
 
 
 def test_module_import_metrics_electrical() -> None:
     """Test that the modules can be imported."""
     # pylint: disable=import-outside-toplevel
-    from frequenz.api.common.metrics import electrical_pb2
+    from frequenz.api.common.v1.metrics import electrical_pb2
 
     assert electrical_pb2 is not None
 
     # pylint: disable=import-outside-toplevel
-    from frequenz.api.common.metrics import electrical_pb2_grpc
+    from frequenz.api.common.v1.metrics import electrical_pb2_grpc
 
     assert electrical_pb2_grpc is not None