From bd4e4785a9bc4f44ceb7423bac09502719819971 Mon Sep 17 00:00:00 2001
From: J-P Nurmi <jp.nurmi@canonical.com>
Date: Wed, 1 Dec 2021 16:30:01 +0100
Subject: [PATCH] filesystem: add disk model and vendor name

Read ID_MODEL/VENDOR_ENC for disks to allow the GUI installer to show
pretty disk names without having to call libudev through FFI.

As a bonus, this also fixes disk names to match the machine config in
dry-run mode.

Related issues
- FR-1710
- canonical/ubuntu-desktop-installer#415
---
 subiquity/common/filesystem/labels.py |  4 +++-
 subiquity/common/types.py             |  2 ++
 subiquity/models/filesystem.py        | 15 ++++++++++++++-
 subiquity/tests/api/test_api.py       | 16 ++++++++++++++++
 4 files changed, 35 insertions(+), 2 deletions(-)

diff --git a/subiquity/common/filesystem/labels.py b/subiquity/common/filesystem/labels.py
index 18422cfe..f6a047e5 100644
--- a/subiquity/common/filesystem/labels.py
+++ b/subiquity/common/filesystem/labels.py
@@ -270,7 +270,9 @@ def _for_client_disk(disk, *, min_size=0):
         partitions=[for_client(p) for p in disk._partitions],
         free_for_partitions=disk.free_for_partitions,
         boot_device=boot.is_boot_device(disk),
-        ok_for_guided=disk.size >= min_size)
+        ok_for_guided=disk.size >= min_size,
+        model=getattr(disk, 'model', None),
+        vendor=getattr(disk, 'vendor', None))
 
 
 @for_client.register(Partition)
diff --git a/subiquity/common/types.py b/subiquity/common/types.py
index 8dd3ddca..b3ac4b1f 100644
--- a/subiquity/common/types.py
+++ b/subiquity/common/types.py
@@ -272,6 +272,8 @@ class Disk:
     path: Optional[str]
     free_for_partitions: int
     boot_device: bool
+    model: Optional[str] = None
+    vendor: Optional[str] = None
 
 
 @attr.s(auto_attribs=True)
diff --git a/subiquity/models/filesystem.py b/subiquity/models/filesystem.py
index 0f67b4eb..9a6b5b26 100644
--- a/subiquity/models/filesystem.py
+++ b/subiquity/models/filesystem.py
@@ -569,7 +569,6 @@ class Disk(_Device):
     wwn = attr.ib(default=None)
     multipath = attr.ib(default=None)
     path = attr.ib(default=None)
-    model = attr.ib(default=None)
     wipe = attr.ib(default=None)
     preserve = attr.ib(default=False)
     name = attr.ib(default="")
@@ -642,6 +641,20 @@ class Disk(_Device):
 
     ok_for_lvm_vg = ok_for_raid
 
+    @property
+    def model(self):
+        return self._decode_id('ID_MODEL_ENC')
+
+    @property
+    def vendor(self):
+        return self._decode_id('ID_VENDOR_ENC')
+
+    def _decode_id(self, id):
+        id = self._info.raw.get(id)
+        if id is None:
+            return None
+        return id.encode('utf-8').decode('unicode_escape').strip()
+
 
 @fsobj("partition")
 class Partition(_Formattable):
diff --git a/subiquity/tests/api/test_api.py b/subiquity/tests/api/test_api.py
index 5b1be192..feaa112d 100755
--- a/subiquity/tests/api/test_api.py
+++ b/subiquity/tests/api/test_api.py
@@ -675,6 +675,22 @@ class TestInfo(TestAPI):
             sda = first(resp['disks'], 'id', disk_id)
             self.assertEqual('/dev/sda', sda['path'])
 
+    async def test_model_and_vendor(self):
+        async with start_server('examples/simple.json') as inst:
+            disk_id = 'disk-sda'
+            resp = await inst.get('/storage/v2')
+            sda = first(resp['disks'], 'id', disk_id)
+            self.assertEqual('QEMU HARDDISK', sda['model'])
+            self.assertEqual('ATA', sda['vendor'])
+
+    async def test_no_vendor(self):
+        async with start_server('examples/many-nics-and-disks.json') as inst:
+            disk_id = 'disk-sda'
+            resp = await inst.get('/storage/v2')
+            sda = first(resp['disks'], 'id', disk_id)
+            self.assertEqual('QEMU HARDDISK', sda['model'])
+            self.assertEqual(None, sda['vendor'])
+
 
 class TestFree(TestAPI):
     @timeout(5)