Merge pull request #41 from stackhpc/upstream/master-2025-04-14

Synchronise master with upstream

Author: priteau

HACKING.rst

@@ -10,19 +10,12 @@ As such, we tend to follow Neutron conventions regarding coding style.
 
 Octavia Specific Commandments
 -----------------------------
-- [O316] Change assertTrue(isinstance(A, B)) by optimal assert like
-  assertIsInstance(A, B).
-- [O318] Change assert(Not)Equal(A, None) or assert(Not)Equal(None, A)
-  by optimal assert like assertIs(Not)None(A).
 - [O319] Validate that debug level logs are not translated.
 - [O321] Validate that jsonutils module is used instead of json
 - [O322] Don't use author tags
 - [O323] Change assertEqual(True, A) or assertEqual(False, A) to the more
   specific assertTrue(A) or assertFalse(A)
 - [O324] Method's default argument shouldn't be mutable
-- [O338] Change assertEqual(A in B, True), assertEqual(True, A in B),
-  assertEqual(A in B, False) or assertEqual(False, A in B) to the more
-  specific assertIn/NotIn(A, B)
 - [O339] LOG.warn() is not allowed. Use LOG.warning()
 - [O340] Don't use xrange()
 - [O341] Don't translate logs.

api-ref/source/v2/examples/availabilityzoneprofile-create-request.json

@@ -3,6 +3,6 @@
         {
             "name": "some_az",
             "provider_name": "amphora",
-            "availability_zone_data": "{\"compute_zone\": \"az1\"}"
+            "availability_zone_data": "{\"compute_zone\": \"az1\", \"volume_zone\": \"az1\"}"
         }
 }

api-ref/source/v2/examples/availabilityzoneprofile-create-response.json

@@ -4,6 +4,6 @@
             "id": "5712097e-0092-45dc-bff0-ab68b61ad51a",
             "name": "some_az",
             "provider_name": "amphora",
-            "availability_zone_data": "{\"compute_zone\": \"az1\"}"
+            "availability_zone_data": "{\"compute_zone\": \"az1\", \"volume_zone\": \"az1\"}"
         }
 }

api-ref/source/v2/examples/availabilityzoneprofile-list-response.json

@@ -4,7 +4,7 @@
             "id": "5712097e-0092-45dc-bff0-ab68b61ad51a",
             "name": "some_az",
             "provider_name": "amphora",
-            "availability_zone_data": "{\"compute_zone\": \"az1\"}"
+            "availability_zone_data": "{\"compute_zone\": \"az1\", \"volume_zone\": \"az2\"}"
         }
     ]
 }

api-ref/source/v2/examples/availabilityzoneprofile-show-response.json

@@ -4,6 +4,6 @@
             "id": "5712097e-0092-45dc-bff0-ab68b61ad51a",
             "name": "some_az",
             "provider_name": "amphora",
-            "availability_zone_data": "{\"compute_zone\": \"az1\"}"
+            "availability_zone_data": "{\"compute_zone\": \"az1\", \"volume_zone\": \"az1\"}"
         }
 }

api-ref/source/v2/examples/availabilityzoneprofile-update-request.json

@@ -3,6 +3,6 @@
         {
             "name": "other_az",
             "provider_name": "amphora",
-            "availability_zone_data": "{\"compute_zone\": \"az2\"}"
+            "availability_zone_data": "{\"compute_zone\": \"az2\", \"volume_zone\": \"az2\"}"
         }
 }

api-ref/source/v2/examples/availabilityzoneprofile-update-response.json

@@ -4,6 +4,6 @@
             "id": "5712097e-0092-45dc-bff0-ab68b61ad51a",
             "name": "other_az",
             "provider_name": "amphora",
-            "availability_zone_data": "{\"compute_zone\": \"az2\"}"
+            "availability_zone_data": "{\"compute_zone\": \"az2\", \"volume_zone\": \"az2\"}"
         }
 }

api-ref/source/v2/examples/provider-availability-zone-capability-show-response.json

@@ -3,6 +3,10 @@
     {
       "name": "compute_zone",
       "description": "The compute availability zone."
+    },
+    {
+      "name": "volume_zone",
+      "description": "The volume availability zone."
     }
   ]
 }

doc/source/contributor/guides/providers.rst

@@ -1782,6 +1782,7 @@ description. For example:
 .. code-block:: python
 
     {"compute_zone": "The compute availability zone to use for this loadbalancer.",
+     "volume_zone": "The volume availability zone to use for this loadbalancer.",
      "management_network": "The management network ID for the loadbalancer.",
      "valid_vip_networks": "List of network IDs that are allowed for VIP use. This overrides/replaces the list of allowed networks configured in `octavia.conf`."}
 

octavia/api/drivers/amphora_driver/availability_zone_schema.py

@@ -39,6 +39,10 @@
             "type": "string",
             "description": "The compute availability zone."
         },
+        consts.VOLUME_ZONE: {
+            "type": "string",
+            "description": "The volume availability zone."
+        },
         consts.MANAGEMENT_NETWORK: {
             "type": "string",
             "description": "The management network ID for the amphora."

octavia/api/drivers/amphora_driver/v2/driver.py

@@ -582,6 +582,18 @@ def validate_availability_zone(self, availability_zone_dict):
             # when the octavia-lib supports it.
             compute_driver.validate_availability_zone(compute_zone)
 
+        volume_zone = availability_zone_dict.get(consts.VOLUME_ZONE, None)
+        if volume_zone:
+            volume_driver = stevedore_driver.DriverManager(
+                namespace='octavia.volume.drivers',
+                name=CONF.controller_worker.volume_driver,
+                invoke_on_load=True
+            ).driver
+
+            # TODO(johnsom) Fix this to raise a NotFound error
+            # when the octavia-lib supports it.
+            volume_driver.validate_availability_zone(volume_zone)
+
         check_nets = availability_zone_dict.get(
             consts.VALID_VIP_NETWORKS, [])
         management_net = availability_zone_dict.get(

octavia/api/drivers/noop_driver/driver.py

@@ -260,6 +260,8 @@ def get_supported_availability_zone_metadata(self):
             self.__class__.__name__)
 
         return {"compute_zone": "The compute availability zone to use for "
+                "this loadbalancer.",
+                "volume_zone": "The volume availability zone to use for "
                 "this loadbalancer."}
 
     def validate_availability_zone(self, availability_zone_metadata):

octavia/common/constants.py

@@ -332,6 +332,7 @@
 COMPUTE_ID = 'compute_id'
 COMPUTE_OBJ = 'compute_obj'
 COMPUTE_ZONE = 'compute_zone'
+VOLUME_ZONE = 'volume_zone'
 CONN_MAX_RETRIES = 'conn_max_retries'
 CONN_RETRY_INTERVAL = 'conn_retry_interval'
 CREATED_AT = 'created_at'

octavia/compute/compute_base.py

@@ -42,7 +42,7 @@ def build(self, name="amphora_name", amphora_flavor=None,
                           well or a string
         :param server_group_id: Optional server group id(uuid) which is used
                                 for anti_affinity feature
-        :param availability_zone: Name of the compute availability zone.
+        :param availability_zone: Availability zone data dict
 
         :raises ComputeBuildException: if compute failed to build amphora
         :returns: UUID of amphora

octavia/compute/drivers/nova_driver.py

@@ -90,8 +90,7 @@ def build(self, name="amphora_name", amphora_flavor=None,
                           well or a string
         :param server_group_id: Optional server group id(uuid) which is used
                                 for anti_affinity feature
-        :param availability_zone: Name of the compute availability zone.
-
+        :param availability_zone: Availability zone data dict
         :raises ComputeBuildException: if nova failed to build virtual machine
         :returns: UUID of amphora
 
@@ -109,7 +108,12 @@ def build(self, name="amphora_name", amphora_flavor=None,
 
             server_group = None if server_group_id is None else {
                 "group": server_group_id}
-            az_name = availability_zone or CONF.nova.availability_zone
+
+            if availability_zone:
+                az_name = availability_zone.get(constants.COMPUTE_ZONE,
+                                                CONF.nova.availability_zone)
+            else:
+                az_name = CONF.nova.availability_zone
 
             image_id = self.image_driver.get_image_id_by_tag(
                 image_tag, image_owner)
@@ -127,7 +131,7 @@ def build(self, name="amphora_name", amphora_flavor=None,
                 LOG.debug('Creating volume for amphora from image %s',
                           image_id)
                 volume_id = self.volume_driver.create_volume_from_image(
-                    image_id)
+                    image_id, availability_zone)
                 LOG.debug('Created boot volume %s for amphora', volume_id)
                 # If use volume based, does not require image ID anymore
                 image_id = None

octavia/controller/worker/v2/tasks/compute_tasks.py

@@ -107,13 +107,9 @@ def execute(self, amphora_id, server_group_id, config_drive_files=None,
             amp_image_tag = CONF.controller_worker.amp_image_tag
 
         if availability_zone:
-            amp_availability_zone = availability_zone.get(
-                constants.COMPUTE_ZONE)
             amp_network = availability_zone.get(constants.MANAGEMENT_NETWORK)
             if amp_network:
                 network_ids = [amp_network]
-        else:
-            amp_availability_zone = None
         try:
             if CONF.haproxy_amphora.build_rate_limit != -1:
                 self.rate_limit.add_to_build_request_queue(
@@ -146,7 +142,7 @@ def execute(self, amphora_id, server_group_id, config_drive_files=None,
                 config_drive_files=config_drive_files,
                 user_data=user_data,
                 server_group_id=server_group_id,
-                availability_zone=amp_availability_zone)
+                availability_zone=availability_zone)
 
             LOG.info("Server created with id: %s for amphora id: %s",
                      compute_id, amphora_id)

octavia/hacking/checks.py

@@ -42,24 +42,11 @@
         hints='|'.join(_all_hints),
     ))
 
-assert_trueinst_re = re.compile(
-    r"(.)*assertTrue\(isinstance\((\w|\.|\'|\"|\[|\])+, "
-    r"(\w|\.|\'|\"|\[|\])+\)\)")
-assert_equal_in_end_with_true_or_false_re = re.compile(
-    r"assertEqual\((\w|[][.'\"])+ in (\w|[][.'\", ])+, (True|False)\)")
-assert_equal_in_start_with_true_or_false_re = re.compile(
-    r"assertEqual\((True|False), (\w|[][.'\"])+ in (\w|[][.'\", ])+\)")
 assert_equal_with_true_re = re.compile(
     r"assertEqual\(True,")
 assert_equal_with_false_re = re.compile(
     r"assertEqual\(False,")
 mutable_default_args = re.compile(r"^\s*def .+\((.+=\{\}|.+=\[\])")
-assert_equal_end_with_none_re = re.compile(r"(.)*assertEqual\(.+, None\)")
-assert_equal_start_with_none_re = re.compile(r".*assertEqual\(None, .+\)")
-assert_not_equal_end_with_none_re = re.compile(
-    r"(.)*assertNotEqual\(.+, None\)")
-assert_not_equal_start_with_none_re = re.compile(
-    r"(.)*assertNotEqual\(None, .+\)")
 revert_must_have_kwargs_re = re.compile(
     r'[ ]*def revert\(.+,[ ](?!\*\*kwargs)\w+\):')
 untranslated_exception_re = re.compile(r"raise (?:\w*)\((.*)\)")
@@ -73,35 +60,6 @@ def _translation_checks_not_enforced(filename):
     return any(pat in filename for pat in ["/tests/", "rally-jobs/plugins/"])
 
 
-@core.flake8ext
-def assert_true_instance(logical_line):
-    """Check for assertTrue(isinstance(a, b)) sentences
-
-    O316
-    """
-    if assert_trueinst_re.match(logical_line):
-        yield (0, "O316: assertTrue(isinstance(a, b)) sentences not allowed. "
-               "Use assertIsInstance instead.")
-
-
-@core.flake8ext
-def assert_equal_or_not_none(logical_line):
-    """Check for assertEqual(A, None) or assertEqual(None, A) sentences,
-
-    assertNotEqual(A, None) or assertNotEqual(None, A) sentences
-
-    O318
-    """
-    msg = ("O318: assertEqual/assertNotEqual(A, None) or "
-           "assertEqual/assertNotEqual(None, A) sentences not allowed")
-    res = (assert_equal_start_with_none_re.match(logical_line) or
-           assert_equal_end_with_none_re.match(logical_line) or
-           assert_not_equal_start_with_none_re.match(logical_line) or
-           assert_not_equal_end_with_none_re.match(logical_line))
-    if res:
-        yield (0, msg)
-
-
 @core.flake8ext
 def assert_equal_true_or_false(logical_line):
     """Check for assertEqual(True, A) or assertEqual(False, A) sentences
@@ -122,22 +80,6 @@ def no_mutable_default_args(logical_line):
         yield (0, msg)
 
 
-@core.flake8ext
-def assert_equal_in(logical_line):
-    """Check for assertEqual(A in B, True), assertEqual(True, A in B),
-
-    assertEqual(A in B, False) or assertEqual(False, A in B) sentences
-
-    O338
-    """
-    res = (assert_equal_in_start_with_true_or_false_re.search(logical_line) or
-           assert_equal_in_end_with_true_or_false_re.search(logical_line))
-    if res:
-        yield (0, "O338: Use assertIn/NotIn(A, B) rather than "
-               "assertEqual(A in B, True/False) when checking collection "
-               "contents.")
-
-
 @core.flake8ext
 def no_log_warn(logical_line):
     """Disallow 'LOG.warn('

octavia/tests/functional/api/v2/test_provider.py

@@ -186,9 +186,14 @@ def test_nonexistent_provider(self):
             provider='bogus'), status=400)
 
     def test_noop_provider(self):
-        ref_capabilities = [{'description': 'The compute availability zone to '
-                                            'use for this loadbalancer.',
-                             'name': constants.COMPUTE_ZONE}]
+        ref_capabilities = [
+            {'description': 'The compute availability zone to '
+                            'use for this loadbalancer.',
+             'name': constants.COMPUTE_ZONE},
+            {'description': 'The volume availability zone to '
+                            'use for this loadbalancer.',
+             'name': constants.VOLUME_ZONE},
+        ]
 
         result = self.get(
             self.AVAILABILITY_ZONE_CAPABILITIES_PATH.format(
@@ -220,9 +225,14 @@ def test_not_implemented(self, mock_get_metadata):
             provider='noop_driver'), status=501)
 
     def test_authorized(self):
-        ref_capabilities = [{'description': 'The compute availability zone to '
-                                            'use for this loadbalancer.',
-                             'name': constants.COMPUTE_ZONE}]
+        ref_capabilities = [
+            {'description': 'The compute availability zone to '
+                            'use for this loadbalancer.',
+             'name': constants.COMPUTE_ZONE},
+            {'description': 'The volume availability zone to '
+                            'use for this loadbalancer.',
+             'name': constants.VOLUME_ZONE},
+        ]
         self.conf = self.useFixture(oslo_fixture.Config(cfg.CONF))
         auth_strategy = self.conf.conf.api_settings.get('auth_strategy')
         self.conf.config(group='api_settings', auth_strategy=constants.TESTING)