Merge ~ogayot/curtin:lunar-2023-04-03 into curtin:ubuntu/lunar

[Olivier Gayot]

block-meta: fix failed disk lookup when WWN includes extension

curtin's storage config extracts the WWN of a disk from one of the
following udev variables:

 * ID_WWN_WITH_EXTENSION (preferred)
 * ID_WWN

However, when trying to look the disk up later in the block-meta code,
curtin only tries to match the WWN value against the ID_WWN variable
(and another variable related to DM multipath).

This means that the disk can not be be found just based on the wwn if
the ID_WWN and ID_WWN_WITH_EXTENSION variables don't hold the same
value.

In the past, that was often okay because other fields (such as disk path
or serial) would still make the disk lookup succeed.

However, the following patch introduced a restriction. In v2, all fields
specified must now match for the disk lookup to be successful:

8c5f87ed block_meta: all fields on a disk action must match with v2 config

Fixed by matching against the ID_WWN_WITH_EXTENSION (preferred) and then
ID_WWN.

(cherry picked from commit 73da3c4f47ea22d58f57371594a396c5434ab260)

Cherry pick to ubuntu/lunar of the change introduced in https://code.launchpad.net/~ogayot/curtin/+git/curtin/+merge/440232.

[Server Team CI bot (server-team-bot)]

PASSED: Continuous integration, rev:f30a1533f88b753b6fdd3c04699dda9621b632cc
https://jenkins.canonical.com/server-team/job/curtin-ci/92/
Executed test runs:
    SUCCESS: https://jenkins.canonical.com/server-team/job/curtin-ci/nodes=metal-amd64/92/
    SUCCESS: https://jenkins.canonical.com/server-team/job/curtin-ci/nodes=metal-arm64/92/
    SUCCESS: https://jenkins.canonical.com/server-team/job/curtin-ci/nodes=metal-ppc64el/92/
    SUCCESS: https://jenkins.canonical.com/server-team/job/curtin-ci/nodes=metal-s390x/92/

Click here to trigger a rebuild:
https://jenkins.canonical.com/server-team/job/curtin-ci/92//rebuild

review: Approve (continuous-integration)

[Dan Bungert (dbungert)]

review: Approve

[Server Team CI bot (server-team-bot)]

Autolanding: FAILED
More details in the following jenkins job:
https://jenkins.canonical.com/server-team/job/curtin-autoland-test/54/
Executed test runs:
    FAILURE: https://jenkins.canonical.com/server-team/job/curtin-autoland-test/nodes=metal-amd64/54/
    FAILURE: https://jenkins.canonical.com/server-team/job/curtin-autoland-test/nodes=metal-arm64/54/
    FAILURE: https://jenkins.canonical.com/server-team/job/curtin-autoland-test/nodes=metal-ppc64el/54/
    FAILURE: https://jenkins.canonical.com/server-team/job/curtin-autoland-test/nodes=metal-s390x/54/

review: Needs Fixing (continuous-integration)

[Server Team CI bot (server-team-bot)]

Autolanding: FAILED
More details in the following jenkins job:
https://jenkins.canonical.com/server-team/job/curtin-autoland-test/55/
Executed test runs:
    FAILURE: https://jenkins.canonical.com/server-team/job/curtin-autoland-test/nodes=metal-amd64/55/
    FAILURE: https://jenkins.canonical.com/server-team/job/curtin-autoland-test/nodes=metal-arm64/55/
    FAILURE: https://jenkins.canonical.com/server-team/job/curtin-autoland-test/nodes=metal-ppc64el/55/
    FAILURE: https://jenkins.canonical.com/server-team/job/curtin-autoland-test/nodes=metal-s390x/55/

review: Needs Fixing (continuous-integration)

[Dan Bungert (dbungert)]

Confirmed that the autolander is trying to test with a merge to master, so a manual merge is desired.

diff --git a/curtin/commands/block_meta.py b/curtin/commands/block_meta.py
index c0e595d..7988f3a 100644
--- a/curtin/commands/block_meta.py
+++ b/curtin/commands/block_meta.py
@@ -513,7 +513,8 @@ def v2_get_path_to_disk(vol):
         cands.append(set([dev['DEVNAME'] for dev in new_devs]))
 
     if 'wwn' in vol:
-        add_cands(*disk_by_keys(vol['wwn'], 'DM_WWN', 'ID_WWN'))
+        add_cands(*disk_by_keys(vol['wwn'],
+                                'DM_WWN', 'ID_WWN_WITH_EXTENSION', 'ID_WWN'))
     if 'serial' in vol:
         add_cands(
             *disk_by_keys(
diff --git a/tests/unittests/test_commands_block_meta.py b/tests/unittests/test_commands_block_meta.py
index 0c198e6..82530ff 100644
--- a/tests/unittests/test_commands_block_meta.py
+++ b/tests/unittests/test_commands_block_meta.py
@@ -222,6 +222,23 @@ class TestGetPathToStorageVolume(CiTestCase):
             devname,
             block_meta.get_path_to_storage_volume(disk_id, s_cfg))
 
+    def test_v2_match_wwn_with_extension(self):
+        wwn = self.random_string()
+        extension = self.random_string()
+        devname = self.random_string()
+        self.m_udev_all.return_value = [
+            {'DEVNAME': devname,
+             'ID_WWN': wwn,
+             'ID_WWN_WITH_EXTENSION': wwn + extension},
+            ]
+        disk_id = self.random_string()
+        cfg = {'id': disk_id, 'type': 'disk', 'wwn': wwn + extension}
+        s_cfg = OrderedDict({disk_id: cfg})
+        s_cfg.version = 2
+        self.assertEqual(
+            devname,
+            block_meta.get_path_to_storage_volume(disk_id, s_cfg))
+
     def test_v2_match_wwn_prefer_mpath(self):
         wwn = self.random_string()
         devname1 = self.random_string()