From 9da0cf41d446e11651a5bd8b111cfd13a02d76b6 Mon Sep 17 00:00:00 2001
From: Dmitry Tantsur <dtantsur@protonmail.com>
Date: Fri, 8 Dec 2023 15:38:23 +0100
Subject: [PATCH] Fix building images for Bullseye and Bookworm

Bullseye requires installing lshw from backports because the default one
has broken JSON output:
https://bugs.debian.org/cgi-bin/bugreport.cgi?bug=1002025

Bookworm requires installing firmware from a different repository.

Change-Id: I1bfecfcaff1547f99fcb48cc54b8f7ff77f0b0d9
---
 .../environment.d/01-debian-ipa.bash                       | 7 ++++++-
 dib/ironic-python-agent-ramdisk/pkg-map                    | 5 +++++
 doc/source/admin/dib.rst                                   | 2 +-
 releasenotes/notes/debian-9a4fa6b2d3ef96d0.yaml            | 4 ++++
 4 files changed, 16 insertions(+), 2 deletions(-)
 create mode 100644 releasenotes/notes/debian-9a4fa6b2d3ef96d0.yaml

diff --git a/dib/ironic-python-agent-ramdisk/environment.d/01-debian-ipa.bash b/dib/ironic-python-agent-ramdisk/environment.d/01-debian-ipa.bash
index bb697e8..2ca7e3d 100644
--- a/dib/ironic-python-agent-ramdisk/environment.d/01-debian-ipa.bash
+++ b/dib/ironic-python-agent-ramdisk/environment.d/01-debian-ipa.bash
@@ -1,5 +1,10 @@
 # IPA is built with non-free firmware by default.
-export DIB_DEBIAN_COMPONENTS=${DIB_DEBIAN_COMPONENTS:-main,contrib,non-free}
+DIB_DEBIAN_NON_FREE=non-free-firmware
+if [[ "$DIB_RELEASE" == "bullseye" ]]; then
+    # Starting with bookworm, firmware is in a separate repository
+    DIB_DEBIAN_NON_FREE=non-free
+fi
+export DIB_DEBIAN_COMPONENTS=${DIB_DEBIAN_COMPONENTS:-main,contrib,$DIB_DEBIAN_NON_FREE}
 
 if [[ $DIB_DEBIAN_COMPONENTS =~ non-free ]]; then
     export IPA_DEBIAN_NONFREE=true
diff --git a/dib/ironic-python-agent-ramdisk/pkg-map b/dib/ironic-python-agent-ramdisk/pkg-map
index e059f94..af22457 100644
--- a/dib/ironic-python-agent-ramdisk/pkg-map
+++ b/dib/ironic-python-agent-ramdisk/pkg-map
@@ -11,6 +11,11 @@
         "python": "python",
         "python-dev": "python-devel"
       }
+    },
+    "debian": {
+      "bullseye": {
+          "lshw": "lshw/bullseye-backports"
+      }
     }
   },
   "family": {
diff --git a/doc/source/admin/dib.rst b/doc/source/admin/dib.rst
index 72b34a2..d9b5990 100644
--- a/doc/source/admin/dib.rst
+++ b/doc/source/admin/dib.rst
@@ -5,7 +5,7 @@ Images built using diskimage-builder_ are recommended for production use on
 real hardware. The recommended distributions are:
 
 * CentOS Stream 9
-* Debian Bullseye (``debian-minimal`` element)
+* Debian Bullseye and Bookworm (``debian-minimal`` element)
 
 The following should work but receive only limited testing and support:
 
diff --git a/releasenotes/notes/debian-9a4fa6b2d3ef96d0.yaml b/releasenotes/notes/debian-9a4fa6b2d3ef96d0.yaml
new file mode 100644
index 0000000..d59adf1
--- /dev/null
+++ b/releasenotes/notes/debian-9a4fa6b2d3ef96d0.yaml
@@ -0,0 +1,4 @@
+---
+fixes:
+  - |
+    Fixes building images for Debian Bullseye and Bookworm.