[PATCH v2 0/4] expand-on-first-boot CI testing

[PATCH v2 0/4] expand-on-first-boot CI testing

[Henning Schild]

changes since v1:
 - complete rewrite to not focus only on the tests but rather the
   feature for all examples

This first was only about testing but meanwhile has a focus on enabling
the expand feature in all example images anyhow, and later look for
traces of that happening in CI test where we can.
We install the application in any image and in the wic images add some
scratch space at the end. That will enable improved interactive use of
all those wic images, so makes sense apart from any testing.
Later use the log reading feature of the qemu tests to look for traces
of successful resizing for non ubuntu images. In ubuntu the
console_loglevel is not verbose enough to find traces.

Henning Schild (4):
  CI: improve cibuilder readability
  meta-isar: install expand-on-first-boot in all example images
  meta-isar: add some empty space at the end of our wic images
  CI: expect a message about filesystem resize vom expand script

 meta-isar/conf/local.conf.sample              |  2 +-
 .../lib/wic/canned-wks/sdimage-efi-sd.wks     |  2 ++
 .../lib/wic/canned-wks/sdimage-efi.wks        |  2 ++
 testsuite/cibuilder.py                        | 26 +++++++++++++++----
 4 files changed, 26 insertions(+), 6 deletions(-)

-- 
2.37.4

[PATCH v2 1/4] CI: improve cibuilder readability

[Henning Schild]

What was called "servive_prompt" is not a prompt nor a service. Document
what that is and rename the variable.

Signed-off-by: Henning Schild <henning.schild@siemens.com>
---
 testsuite/cibuilder.py | 5 +++--
 1 file changed, 3 insertions(+), 2 deletions(-)

diff --git a/testsuite/cibuilder.py b/testsuite/cibuilder.py
index d5c83b222d50..07a9edc56d9c 100755
--- a/testsuite/cibuilder.py
+++ b/testsuite/cibuilder.py
@@ -229,7 +229,8 @@ class CIBuilder(Test):
         self.log.info('QEMU boot line: ' + str(cmdline))
 
         login_prompt = b'isar login:'
-        service_prompt = b'Just an example'
+        # the printk of recipes-kernel/example-module
+        module_output = b'Just an example'
 
         timeout = time.time() + int(time_to_wait)
 
@@ -263,7 +264,7 @@ class CIBuilder(Test):
         if os.path.exists(output_file) and os.path.getsize(output_file) > 0:
             with open(output_file, "rb") as f1:
                 data = f1.read()
-                if service_prompt in data and login_prompt in data:
+                if module_output in data and login_prompt in data:
                     return
                 else:
                     app_log.error(data.decode(errors='replace'))
-- 
2.37.4

[PATCH v2 2/4] meta-isar: install expand-on-first-boot in all example images

[Henning Schild]

The package just makes sense if people want to actuallly use the example
images in an interactive way, as such images will need some space to
write stuff to.
It also will help test that feature in CI.

Signed-off-by: Henning Schild <henning.schild@siemens.com>
---
 meta-isar/conf/local.conf.sample | 2 +-
 1 file changed, 1 insertion(+), 1 deletion(-)

diff --git a/meta-isar/conf/local.conf.sample b/meta-isar/conf/local.conf.sample
index 57d062025f21..27becf19aefd 100644
--- a/meta-isar/conf/local.conf.sample
+++ b/meta-isar/conf/local.conf.sample
@@ -198,7 +198,7 @@ CONF_VERSION = "1"
 
 #
 # The default list of extra packages to be installed.
-IMAGE_INSTALL = "hello-isar example-raw example-module-${KERNEL_NAME} enable-fsck isar-exclude-docs samefile hello isar-disable-apt-cache cowsay example-prebuilt"
+IMAGE_INSTALL = "hello-isar example-raw example-module-${KERNEL_NAME} enable-fsck isar-exclude-docs samefile hello isar-disable-apt-cache cowsay example-prebuilt expand-on-first-boot"
 
 #
 # Enable cross-compilation support
-- 
2.37.4

[PATCH v2 3/4] meta-isar: add some empty space at the end of our wic images

[Henning Schild]

Add some empty space at the end of our example images. This will enable
better interactive use of our example images since people will have some
space to install some more packages. While the space seems fixed it
really is open end if the mass storage happens to be bigger, because we
installed expand-on-first-boot earlier.

Signed-off-by: Henning Schild <henning.schild@siemens.com>
---
 meta-isar/scripts/lib/wic/canned-wks/sdimage-efi-sd.wks | 2 ++
 meta-isar/scripts/lib/wic/canned-wks/sdimage-efi.wks    | 2 ++
 2 files changed, 4 insertions(+)

diff --git a/meta-isar/scripts/lib/wic/canned-wks/sdimage-efi-sd.wks b/meta-isar/scripts/lib/wic/canned-wks/sdimage-efi-sd.wks
index 754fbc46f8e4..e6b7128eb3ae 100644
--- a/meta-isar/scripts/lib/wic/canned-wks/sdimage-efi-sd.wks
+++ b/meta-isar/scripts/lib/wic/canned-wks/sdimage-efi-sd.wks
@@ -6,4 +6,6 @@ part /boot --source bootimg-efi-isar --sourceparams "loader=systemd-boot" --ondi
 
 part / --source rootfs --ondisk sda --fstype ext4 --mkfs-extraopts "-T default" --label platform --align 1024 --use-uuid --exclude-path boot/
 
+part --source empty --no-table --ondisk sda --size 256M
+
 bootloader --ptable gpt --timeout 3 --append "rootwait console=ttyS0,115200 console=tty0"
diff --git a/meta-isar/scripts/lib/wic/canned-wks/sdimage-efi.wks b/meta-isar/scripts/lib/wic/canned-wks/sdimage-efi.wks
index f3addbc7515d..5e555b3cc472 100644
--- a/meta-isar/scripts/lib/wic/canned-wks/sdimage-efi.wks
+++ b/meta-isar/scripts/lib/wic/canned-wks/sdimage-efi.wks
@@ -6,4 +6,6 @@ part /boot --source bootimg-efi-isar --sourceparams "loader=grub-efi" --ondisk s
 
 part / --source rootfs --ondisk sda --fstype ext4 --mkfs-extraopts "-T default" --label platform --align 1024 --use-uuid --exclude-path boot/
 
+part --source empty --no-table --ondisk sda --size 256M
+
 bootloader --ptable gpt --timeout 3 --append "rootwait console=ttyS0,115200 console=tty0"
-- 
2.37.4

[PATCH v2 4/4] CI: expect a message about filesystem resize vom expand script

[Henning Schild]

We have added the expand-on-first-boot recipe and some space to grow to
our example images. So now any image using wic should "expand" on its
first boot. And the kernel actually leaves a message for us to read, at
least on debian but not on ubuntu.

Signed-off-by: Henning Schild <henning.schild@siemens.com>
---
 testsuite/cibuilder.py | 21 ++++++++++++++++++---
 1 file changed, 18 insertions(+), 3 deletions(-)

diff --git a/testsuite/cibuilder.py b/testsuite/cibuilder.py
index 07a9edc56d9c..ec44b5756b15 100755
--- a/testsuite/cibuilder.py
+++ b/testsuite/cibuilder.py
@@ -231,6 +231,18 @@ class CIBuilder(Test):
         login_prompt = b'isar login:'
         # the printk of recipes-kernel/example-module
         module_output = b'Just an example'
+        # output we see when expand-on-first-boot runs on ext4
+        resize_output = b'resized filesystem to'
+        expecting_resize = False
+
+        bb_output = get_bitbake_env(arch, distro).decode()
+        wks_file = get_bitbake_var(bb_output, 'WKS_FILE')
+        if wks_file and "sdimage-efi" in wks_file:
+            bbdistro = get_bitbake_var(bb_output, 'DISTRO')
+            # ubuntu is less verbose so we do not see the message
+            # /etc/sysctl.d/10-console-messages.conf
+            if bbdistro and "ubuntu" not in bbdistro:
+                expecting_resize = True
 
         timeout = time.time() + int(time_to_wait)
 
@@ -265,8 +277,11 @@ class CIBuilder(Test):
             with open(output_file, "rb") as f1:
                 data = f1.read()
                 if module_output in data and login_prompt in data:
-                    return
-                else:
-                    app_log.error(data.decode(errors='replace'))
+                    if expecting_resize:
+                        if resize_output in data:
+                            return
+                    else:
+                        return
+                app_log.error(data.decode(errors='replace'))
 
         self.fail('Log ' + output_file)
-- 
2.37.4

Re: [PATCH v2 4/4] CI: expect a message about filesystem resize vom expand script

[Henning Schild]

Am Mon, 14 Nov 2022 18:40:53 +0100
schrieb Henning Schild <henning.schild@siemens.com>:

> We have added the expand-on-first-boot recipe and some space to grow
> to our example images. So now any image using wic should "expand" on
> its first boot. And the kernel actually leaves a message for us to
> read, at least on debian but not on ubuntu.
> 
> Signed-off-by: Henning Schild <henning.schild@siemens.com>
> ---
>  testsuite/cibuilder.py | 21 ++++++++++++++++++---
>  1 file changed, 18 insertions(+), 3 deletions(-)
> 
> diff --git a/testsuite/cibuilder.py b/testsuite/cibuilder.py
> index 07a9edc56d9c..ec44b5756b15 100755
> --- a/testsuite/cibuilder.py
> +++ b/testsuite/cibuilder.py
> @@ -231,6 +231,18 @@ class CIBuilder(Test):
>          login_prompt = b'isar login:'
>          # the printk of recipes-kernel/example-module
>          module_output = b'Just an example'
> +        # output we see when expand-on-first-boot runs on ext4
> +        resize_output = b'resized filesystem to'
> +        expecting_resize = False
> +
> +        bb_output = get_bitbake_env(arch, distro).decode()

the get_bitbake calls need a start_vm. prefix

Henning

> +        wks_file = get_bitbake_var(bb_output, 'WKS_FILE')
> +        if wks_file and "sdimage-efi" in wks_file:
> +            bbdistro = get_bitbake_var(bb_output, 'DISTRO')
> +            # ubuntu is less verbose so we do not see the message
> +            # /etc/sysctl.d/10-console-messages.conf
> +            if bbdistro and "ubuntu" not in bbdistro:
> +                expecting_resize = True
>  
>          timeout = time.time() + int(time_to_wait)
>  
> @@ -265,8 +277,11 @@ class CIBuilder(Test):
>              with open(output_file, "rb") as f1:
>                  data = f1.read()
>                  if module_output in data and login_prompt in data:
> -                    return
> -                else:
> -                    app_log.error(data.decode(errors='replace'))
> +                    if expecting_resize:
> +                        if resize_output in data:
> +                            return
> +                    else:
> +                        return
> +                app_log.error(data.decode(errors='replace'))
>  
>          self.fail('Log ' + output_file)

Re: [PATCH v2 2/4] meta-isar: install expand-on-first-boot in all example images

[Henning Schild]

Am Mon, 14 Nov 2022 18:40:51 +0100
schrieb Henning Schild <henning.schild@siemens.com>:

> The package just makes sense if people want to actuallly use the
> example images in an interactive way, as such images will need some
> space to write stuff to.
> It also will help test that feature in CI.
> 
> Signed-off-by: Henning Schild <henning.schild@siemens.com>
> ---
>  meta-isar/conf/local.conf.sample | 2 +-
>  1 file changed, 1 insertion(+), 1 deletion(-)
> 
> diff --git a/meta-isar/conf/local.conf.sample
> b/meta-isar/conf/local.conf.sample index 57d062025f21..27becf19aefd
> 100644 --- a/meta-isar/conf/local.conf.sample
> +++ b/meta-isar/conf/local.conf.sample
> @@ -198,7 +198,7 @@ CONF_VERSION = "1"
>  
>  #
>  # The default list of extra packages to be installed.
> -IMAGE_INSTALL = "hello-isar example-raw
> example-module-${KERNEL_NAME} enable-fsck isar-exclude-docs samefile
> hello isar-disable-apt-cache cowsay example-prebuilt" +IMAGE_INSTALL
> = "hello-isar example-raw example-module-${KERNEL_NAME} enable-fsck
> isar-exclude-docs samefile hello isar-disable-apt-cache cowsay
> example-prebuilt expand-on-first-boot" # # Enable cross-compilation
> support

I will move this from here to only the images where we use the WKS_FILE
with that added gap at the end.
That does reduce coverage of "does it build/install" but also makes
sure we only add it to images where it makes some sense and do not
waste time and space.

Henning

Re: [PATCH v2 3/4] meta-isar: add some empty space at the end of our wic images

[Schaffner, Tobias]

On 14.11.22 18:40, Henning Schild wrote:
> Add some empty space at the end of our example images. This will enable
> better interactive use of our example images since people will have some
> space to install some more packages. While the space seems fixed it
> really is open end if the mass storage happens to be bigger, because we
> installed expand-on-first-boot earlier.
> 
> Signed-off-by: Henning Schild <henning.schild@siemens.com>
> ---
>   meta-isar/scripts/lib/wic/canned-wks/sdimage-efi-sd.wks | 2 ++
>   meta-isar/scripts/lib/wic/canned-wks/sdimage-efi.wks    | 2 ++
>   2 files changed, 4 insertions(+)
> 
> diff --git a/meta-isar/scripts/lib/wic/canned-wks/sdimage-efi-sd.wks b/meta-isar/scripts/lib/wic/canned-wks/sdimage-efi-sd.wks
> index 754fbc46f8e4..e6b7128eb3ae 100644
> --- a/meta-isar/scripts/lib/wic/canned-wks/sdimage-efi-sd.wks
> +++ b/meta-isar/scripts/lib/wic/canned-wks/sdimage-efi-sd.wks
> @@ -6,4 +6,6 @@ part /boot --source bootimg-efi-isar --sourceparams "loader=systemd-boot" --ondi
>   
>   part / --source rootfs --ondisk sda --fstype ext4 --mkfs-extraopts "-T default" --label platform --align 1024 --use-uuid --exclude-path boot/
>   
> +part --source empty --no-table --ondisk sda --size 256M

It might be a good idea to use some odd value here. Wic only allows you 
to go down to Kibibyte with --fixed-size. Still when using something 
that is not dividable by 4 e.g. ext4 filesystems will not fit perfectly 
into the partition.

Imho we should enlarge the image only for the CI and maybe document how 
to use qemu-img resize for users that want to install additional 
packages. I see that its only an example image and therefore rarely used 
but still it will eat up more space when uncompressed and take longer to 
flash.

Greetings!
> +
>   bootloader --ptable gpt --timeout 3 --append "rootwait console=ttyS0,115200 console=tty0"
> diff --git a/meta-isar/scripts/lib/wic/canned-wks/sdimage-efi.wks b/meta-isar/scripts/lib/wic/canned-wks/sdimage-efi.wks
> index f3addbc7515d..5e555b3cc472 100644
> --- a/meta-isar/scripts/lib/wic/canned-wks/sdimage-efi.wks
> +++ b/meta-isar/scripts/lib/wic/canned-wks/sdimage-efi.wks
> @@ -6,4 +6,6 @@ part /boot --source bootimg-efi-isar --sourceparams "loader=grub-efi" --ondisk s
>   
>   part / --source rootfs --ondisk sda --fstype ext4 --mkfs-extraopts "-T default" --label platform --align 1024 --use-uuid --exclude-path boot/
>   
> +part --source empty --no-table --ondisk sda --size 256M
> +
>   bootloader --ptable gpt --timeout 3 --append "rootwait console=ttyS0,115200 console=tty0"

Re: [PATCH v2 3/4] meta-isar: add some empty space at the end of our wic images

[Henning Schild]

Am Sat, 19 Nov 2022 20:51:21 +0100
schrieb "Schaffner, Tobias (T CED SES-DE)"
<tobias.schaffner@siemens.com>:

> On 14.11.22 18:40, Henning Schild wrote:
> > Add some empty space at the end of our example images. This will
> > enable better interactive use of our example images since people
> > will have some space to install some more packages. While the space
> > seems fixed it really is open end if the mass storage happens to be
> > bigger, because we installed expand-on-first-boot earlier.
> > 
> > Signed-off-by: Henning Schild <henning.schild@siemens.com>
> > ---
> >   meta-isar/scripts/lib/wic/canned-wks/sdimage-efi-sd.wks | 2 ++
> >   meta-isar/scripts/lib/wic/canned-wks/sdimage-efi.wks    | 2 ++
> >   2 files changed, 4 insertions(+)
> > 
> > diff --git
> > a/meta-isar/scripts/lib/wic/canned-wks/sdimage-efi-sd.wks
> > b/meta-isar/scripts/lib/wic/canned-wks/sdimage-efi-sd.wks index
> > 754fbc46f8e4..e6b7128eb3ae 100644 ---
> > a/meta-isar/scripts/lib/wic/canned-wks/sdimage-efi-sd.wks +++
> > b/meta-isar/scripts/lib/wic/canned-wks/sdimage-efi-sd.wks @@ -6,4
> > +6,6 @@ part /boot --source bootimg-efi-isar --sourceparams
> > "loader=systemd-boot" --ondi part / --source rootfs --ondisk sda
> > --fstype ext4 --mkfs-extraopts "-T default" --label platform
> > --align 1024 --use-uuid --exclude-path boot/ +part --source empty
> > --no-table --ondisk sda --size 256M  
> 
> It might be a good idea to use some odd value here. Wic only allows
> you to go down to Kibibyte with --fixed-size. Still when using
> something that is not dividable by 4 e.g. ext4 filesystems will not
> fit perfectly into the partition.

I would hope/assume that the actual filesystem resize application takes
care about making it fit. And we might always have the situation where
the partition starts somewhere and we do not know the size of the
storage medium used, so there simply is no right answer.

> Imho we should enlarge the image only for the CI and maybe document
> how to use qemu-img resize for users that want to install additional 
> packages. I see that its only an example image and therefore rarely
> used but still it will eat up more space when uncompressed and take
> longer to flash.

I already tried with qemu-img resize in CI, that ended up looking
pretty messy. We could use another example wks just for that resize
test case. But that would make the pipeline even slower and the overall
disk consumption much higher.

How about we go down to 128M from the 256M i proposed? My idea behind
that value was to test the expansion and leave a reasonable amount of
space so people can install stuff in qemu and also cater for people
potentially flashing to a real machine.
 
When we assume that people do not flash, which you did ... it does not
take more time. I would further assume (did not check) that the image
does not consume more disk space, because it is empty space in a sparse
file. So adding a variant will only be more stuff to maintain and more
CI jobs.

Henning


> Greetings!
> > +
> >   bootloader --ptable gpt --timeout 3 --append "rootwait
> > console=ttyS0,115200 console=tty0" diff --git
> > a/meta-isar/scripts/lib/wic/canned-wks/sdimage-efi.wks
> > b/meta-isar/scripts/lib/wic/canned-wks/sdimage-efi.wks index
> > f3addbc7515d..5e555b3cc472 100644 ---
> > a/meta-isar/scripts/lib/wic/canned-wks/sdimage-efi.wks +++
> > b/meta-isar/scripts/lib/wic/canned-wks/sdimage-efi.wks @@ -6,4 +6,6
> > @@ part /boot --source bootimg-efi-isar --sourceparams
> > "loader=grub-efi" --ondisk s part / --source rootfs --ondisk sda
> > --fstype ext4 --mkfs-extraopts "-T default" --label platform
> > --align 1024 --use-uuid --exclude-path boot/ +part --source empty
> > --no-table --ondisk sda --size 256M + bootloader --ptable gpt
> > --timeout 3 --append "rootwait console=ttyS0,115200 console=tty0"