Merge ~freyes/ubuntu/+source/magnum:bug/2038109-ussuri into ~ubuntu-openstack-dev/ubuntu/+source/magnum:stable/ussuri

[Felipe Reyes]

diff --git a/debian/changelog b/debian/changelog
index fb910d1..916df90 100644
--- a/debian/changelog
+++ b/debian/changelog
@@ -1,3 +1,10 @@
+magnum (10.1.0-0ubuntu1.1) UNRELEASED; urgency=medium
+
+  * d/p/lp2038109-1.patch: Add validator for fixed_network (LP: #2038109).
+  * d/d/lp2038109-2.patch: Add validator for fixed_subnet (LP: #2038109).
+
+ -- Felipe Reyes <[e-mail]>  Mon, 05 Aug 2024 10:57:30 -0400
+
 magnum (10.1.0-0ubuntu1) focal; urgency=medium
 
   [ Corey bryant ]
diff --git a/debian/patches/lp2038109-1.patch b/debian/patches/lp2038109-1.patch
new file mode 100644
index 0000000..c49b2ed
--- /dev/null
+++ b/debian/patches/lp2038109-1.patch
@@ -0,0 +1,93 @@
+From 753baadbb8b5b4c3032d4618166b1c899a50fb07 Mon Sep 17 00:00:00 2001
+From: Felipe Reyes <[e-mail]>
+Date: Thu, 5 Oct 2023 18:39:39 -0300
+Subject: [PATCH] Add validator for fixed_network.
+
+The validate_fixed_network() validator looks for an available network
+matching the id or name, if no networks match a FixedNetworkNotFound
+exception is raised, if more than one networks match then the Conflict
+exception is raised.
+
+Partial-Bug: #2038109
+Change-Id: I7fb0122889feb4f8fa039be5752e8ac3fbc23b94
+---
+ magnum/api/attr_validator.py                 | 20 +++++++++--
+ magnum/tests/unit/api/test_attr_validator.py | 38 ++++++++++++++++++++
+ 2 files changed, 55 insertions(+), 3 deletions(-)
+
+--- a/magnum/api/attr_validator.py
++++ b/magnum/api/attr_validator.py
+@@ -100,9 +100,23 @@
+ def validate_fixed_network(cli, fixed_network):
+     """Validate fixed network"""
+ 
+-    # TODO(houming):this method implement will be added after this
+-    # first pathch for Cluster's OpenStack resources validation is merged.
+-    pass
++    count = 0
++    network_id = None
++    networks = cli.neutron().list_networks()
++    for net in networks.get('networks'):
++        if fixed_network in [net.get('name'), net.get('id')]:
++            count += 1
++            network_id = net.get('id')
++
++    if count == 0:
++        # Unable to find the configured fixed_network.
++        raise exception.FixedNetworkNotFound(network=fixed_network)
++    elif count > 1:
++        msg = _("Multiple networks exist with same name '%s'. "
++                "Please use the network ID instead.")
++        raise exception.Conflict(msg % fixed_network)
++
++    return network_id
+ 
+ 
+ def validate_labels(labels):
+--- a/magnum/tests/unit/api/test_attr_validator.py
++++ b/magnum/tests/unit/api/test_attr_validator.py
+@@ -94,6 +94,44 @@
+                           attr_validator.validate_external_network,
+                           mock_os_cli, 'test_ext_net')
+ 
++    def test_validate_fixed_network_with_valid_network(self):
++        mock_networks = {'networks': [{'name': 'test_net',
++                         'id': 'test_net_id'}]}
++        mock_neutron = mock.MagicMock()
++        mock_neutron.list_networks.return_value = mock_networks
++        mock_os_cli = mock.MagicMock()
++        mock_os_cli.neutron.return_value = mock_neutron
++        self.assertEqual('test_net_id',
++                         attr_validator.validate_fixed_network(mock_os_cli,
++                                                               'test_net'))
++        self.assertTrue(mock_neutron.list_networks.called)
++
++    def test_validate_fixed_network_with_multiple_valid_network(self):
++        mock_networks = {
++            'networks': [{'name': 'test_net',
++                          'id': 'test_net_id1'},
++                         {'name': 'test_net',
++                          'id': 'test_net_id2'}],
++        }
++        mock_neutron = mock.MagicMock()
++        mock_neutron.list_networks.return_value = mock_networks
++        mock_os_cli = mock.MagicMock()
++        mock_os_cli.neutron.return_value = mock_neutron
++        self.assertRaises(exception.Conflict,
++                          attr_validator.validate_fixed_network,
++                          mock_os_cli, 'test_net')
++
++    def test_validate_fixed_network_with_invalid_network(self):
++        mock_networks = {'networks': [{'name': 'test_net_not_equal',
++                         'id': 'test_net_id_not_equal'}]}
++        mock_neutron = mock.MagicMock()
++        mock_neutron.list_networks.return_value = mock_networks
++        mock_os_cli = mock.MagicMock()
++        mock_os_cli.neutron.return_value = mock_neutron
++        self.assertRaises(exception.FixedNetworkNotFound,
++                          attr_validator.validate_fixed_network,
++                          mock_os_cli, 'test_net')
++
+     def test_validate_keypair_with_no_keypair(self):
+         mock_keypair = mock.MagicMock()
+         mock_keypair.id = None
diff --git a/debian/patches/lp2038109-2.patch b/debian/patches/lp2038109-2.patch
new file mode 100644
index 0000000..e863cce
--- /dev/null
+++ b/debian/patches/lp2038109-2.patch
@@ -0,0 +1,173 @@
+From a8bce0bfee81218cd1c0ddcf3e2b86b96659933e Mon Sep 17 00:00:00 2001
+From: Felipe Reyes <[e-mail]>
+Date: Thu, 5 Oct 2023 18:45:55 -0300
+Subject: [PATCH] Add validator for fixed_subnet
+
+Validate the existance of the subnet referenced by fixed_subnet. It's
+not checked if the subnet is associated to the fixed_network.
+
+Closes-Bug: #2038109
+Change-Id: Ia75f0ae525b768ad5b965d22b522cca6f80dcab2
+---
+ magnum/api/attr_validator.py                 | 35 +++++++--
+ magnum/tests/unit/api/test_attr_validator.py | 81 ++++++++++++++++++++
+ 2 files changed, 110 insertions(+), 6 deletions(-)
+
+--- a/magnum/api/attr_validator.py
++++ b/magnum/api/attr_validator.py
+@@ -119,6 +119,28 @@
+     return network_id
+ 
+ 
++def validate_fixed_subnet(cli, fixed_subnet):
++    """Validate fixed subnet"""
++
++    count = 0
++    subnet_id = None
++    subnets = cli.neutron().list_subnets()
++    for subnet in subnets.get('subnets'):
++        if fixed_subnet in [subnet.get('name'), subnet.get('id')]:
++            count += 1
++            subnet_id = subnet.get('id')
++
++    if count == 0:
++        # Unable to find the configured fixed_subnet.
++        raise exception.FixedSubnetNotFound(subnet=fixed_subnet)
++    elif count > 1:
++        msg = _("Multiple subnets exist with same name '%s'. "
++                "Please use the subnet ID instead.")
++        raise exception.Conflict(msg % fixed_subnet)
++    else:
++        return subnet_id
++
++
+ def validate_labels(labels):
+     """"Validate labels"""
+ 
+@@ -207,15 +229,15 @@
+ 
+     for attr, validate_method in validators.items():
+         if cluster and attr in cluster and cluster[attr]:
+-            if attr != 'labels':
+-                validate_method(cli, cluster[attr])
+-            else:
++            if attr == 'labels':
+                 validate_method(cluster[attr])
+-        elif attr in cluster_template and cluster_template[attr] is not None:
+-            if attr != 'labels':
+-                validate_method(cli, cluster_template[attr])
+             else:
++                validate_method(cli, cluster[attr])
++        elif attr in cluster_template and cluster_template[attr] is not None:
++            if attr == 'labels':
+                 validate_method(cluster_template[attr])
++            else:
++                validate_method(cli, cluster_template[attr])
+ 
+     if cluster:
+         validate_keypair(cli, cluster['keypair'])
+@@ -261,6 +283,7 @@
+               'master_flavor_id': validate_flavor,
+               'external_network_id': validate_external_network,
+               'fixed_network': validate_fixed_network,
++              'fixed_subnet': validate_fixed_subnet,
+               'labels': validate_labels}
+ 
+ labels_validators = {'mesos_slave_isolation': validate_labels_isolation,
+--- a/magnum/tests/unit/api/test_attr_validator.py
++++ b/magnum/tests/unit/api/test_attr_validator.py
+@@ -132,6 +132,46 @@
+                           attr_validator.validate_fixed_network,
+                           mock_os_cli, 'test_net')
+ 
++    def test_validate_fixed_subnet_with_valid_subnet(self):
++        mock_neutron = mock.MagicMock()
++        mock_subnets = {'subnets': [{'name': 'test_subnet',
++                                     'id': 'test_subnet_id',
++                                     'network_id': 'test_net_id'}]}
++        mock_neutron.list_subnets.return_value = mock_subnets
++        mock_os_cli = mock.MagicMock()
++        mock_os_cli.neutron.return_value = mock_neutron
++        self.assertEqual('test_subnet_id',
++                         attr_validator.validate_fixed_subnet(mock_os_cli,
++                                                              'test_subnet'))
++        mock_neutron.list_subnets.assert_called_with()
++
++    def test_validate_fixed_subnet_with_invalid_subnet(self):
++        mock_neutron = mock.MagicMock()
++        mock_subnets = {'subnets': [{'name': 'test_subnet',
++                                     'id': 'test_subnet_id',
++                                     'network_id': 'test_net_id'}]}
++        mock_neutron.list_subnets.return_value = mock_subnets
++        mock_os_cli = mock.MagicMock()
++        mock_os_cli.neutron.return_value = mock_neutron
++        self.assertRaises(exception.FixedSubnetNotFound,
++                          attr_validator.validate_fixed_subnet,
++                          mock_os_cli, 'test_subnet_not_found')
++
++    def test_validate_fixed_subnet_with_multiple_valid_subnet(self):
++        mock_neutron = mock.MagicMock()
++        mock_subnets = {'subnets': [{'name': 'test_subnet',
++                                     'id': 'test_subnet_id',
++                                     'network_id': 'test_net_id'},
++                                    {'name': 'test_subnet',
++                                     'id': 'test_subnet_id2',
++                                     'network_id': 'test_net_id2'}]}
++        mock_neutron.list_subnets.return_value = mock_subnets
++        mock_os_cli = mock.MagicMock()
++        mock_os_cli.neutron.return_value = mock_neutron
++        self.assertRaises(exception.Conflict,
++                          attr_validator.validate_fixed_subnet,
++                          mock_os_cli, 'test_subnet')
++
+     def test_validate_keypair_with_no_keypair(self):
+         mock_keypair = mock.MagicMock()
+         mock_keypair.id = None
+@@ -360,6 +400,47 @@
+                                              mock_cluster_template)
+ 
+     @mock.patch('magnum.common.clients.OpenStackClients')
++    def test_validate_os_resources_with_valid_fixed_subnet(self,
++                                                           os_clients_klass):
++        mock_cluster_template = {'fixed_network': 'test_net',
++                                 'fixed_subnet': 'test_subnet'}
++        mock_context = mock.MagicMock()
++        mock_os_cli = mock.MagicMock()
++        os_clients_klass.return_value = mock_os_cli
++        mock_neutron = mock.MagicMock()
++        mock_networks = {'networks': [{'name': 'test_net',
++                                       'id': 'test_net_id'}]}
++        mock_neutron.list_networks.return_value = mock_networks
++        mock_subnets = {'subnets': [{'name': 'test_subnet',
++                                     'id': 'test_subnet_id',
++                                     'network_id': 'test_net_id'}]}
++        mock_neutron.list_subnets.return_value = mock_subnets
++        mock_os_cli.neutron.return_value = mock_neutron
++        attr_validator.validate_os_resources(mock_context,
++                                             mock_cluster_template)
++
++    @mock.patch('magnum.common.clients.OpenStackClients')
++    def test_validate_os_resources_with_invalid_fixed_subnet(self,
++                                                             os_clients_klass):
++        mock_cluster_template = {'fixed_network': 'test_net',
++                                 'fixed_subnet': 'test_subnet2'}
++        mock_context = mock.MagicMock()
++        mock_os_cli = mock.MagicMock()
++        os_clients_klass.return_value = mock_os_cli
++        mock_neutron = mock.MagicMock()
++        mock_networks = {'networks': [{'name': 'test_net',
++                                       'id': 'test_net_id'}]}
++        mock_neutron.list_networks.return_value = mock_networks
++        mock_subnets = {'subnets': [{'name': 'test_subnet',
++                                     'id': 'test_subnet_id',
++                                     'network_id': 'test_net_id'}]}
++        mock_neutron.list_subnets.return_value = mock_subnets
++        mock_os_cli.neutron.return_value = mock_neutron
++        self.assertRaises(exception.FixedSubnetNotFound,
++                          attr_validator.validate_os_resources, mock_context,
++                          mock_cluster_template)
++
++    @mock.patch('magnum.common.clients.OpenStackClients')
+     def test_validate_os_resources_with_cluster(self, mock_os_cli):
+         mock_cluster_template = {}
+         mock_cluster = {
diff --git a/debian/patches/series b/debian/patches/series
index 25c0f24..34e1237 100644
--- a/debian/patches/series
+++ b/debian/patches/series
@@ -1 +1,3 @@
 install-missing-files.patch
+lp2038109-1.patch
+lp2038109-2.patch