Re: [OE-core][scarthgap 17/18] image_qa: fix error handling

Steve Sakoman
2024-10-18T20:19:34Z

On Fri, Oct 18, 2024 at 12:56 PM Peter Kjellerstedt
<peter.kjellerstedt@axis.com> wrote:
>
> > -----Original Message-----
> > From: openembedded-core@lists.openembedded.org <openembedded-core@lists.openembedded.org> On Behalf Of Steve Sakoman
> > Sent: den 16 oktober 2024 15:27
> > To: Richard Purdie <richard.purdie@linuxfoundation.org>
> > Cc: openembedded-core@lists.openembedded.org
> > Subject: Re: [OE-core][scarthgap 17/18] image_qa: fix error handling
> >
> > On Tue, Oct 15, 2024 at 3:41 PM Richard Purdie <richard.purdie@linuxfoundation.org> wrote:
> > >
> > > On Tue, 2024-10-15 at 11:50 -0700, Steve Sakoman via lists.openembedded.org wrote:
> > > > From: Louis Rannou <louis.rannou@non.se.com>
> > > >
> > > > Make ImageQAFailed inherit BBHandledException so exceptions raised in tests are
> > > > catched when the actual test function is executed by bb.utils.better_exec.
> > > >
> > > > Change the do_image_qa tasks so errors are handled with oe.qa.handle_error. Add
> > > > some comment to explain this requires to list the test in ERROR_QA or WARN_QA.
> > > >
> > > > [YOCTO #14807]
> > > > https://bugzilla.yoctoproject.org/show_bug.cgi?id=14807
> > > >
> > > > Signed-off-by: Louis Rannou <louis.rannou@non.se.com>
> > > > Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
> > > > (cherry picked from commit 905e224849fbbed1719e0add231b00e2d570b3b4)
> > > > Signed-off-by: Steve Sakoman <steve@sakoman.com>
> > > > ---
> > > > meta/classes-recipe/image.bbclass | 11 ++++++-----
> > > > meta/lib/oe/utils.py | 2 +-
> > > > 2 files changed, 7 insertions(+), 6 deletions(-)
> > > >
> > > > diff --git a/meta/classes-recipe/image.bbclass b/meta/classes-recipe/image.bbclass
> > > > index 28be6c6362..a682b5f3b2 100644
> > > > --- a/meta/classes-recipe/image.bbclass
> > > > +++ b/meta/classes-recipe/image.bbclass
> > > > @@ -308,23 +308,24 @@ addtask do_image_complete_setscene
> > > > #
> > > > # The functions should use ${IMAGE_ROOTFS} to find the unpacked rootfs
> > > > # directory, which if QA passes will be the basis for the images.
> > > > +#
> > > > +# The functions should use oe.utils.ImageQAFailed(description, name) to raise
> > > > +# errors. The name must be listed in ERROR_QA or WARN_QA to prompt.
> > > > fakeroot python do_image_qa () {
> > > > from oe.utils import ImageQAFailed
> > > >
> > > > qa_cmds = (d.getVar('IMAGE_QA_COMMANDS') or '').split()
> > > > - qamsg = ""
> > > >
> > > > for cmd in qa_cmds:
> > > > try:
> > > > bb.build.exec_func(cmd, d)
> > > > except oe.utils.ImageQAFailed as e:
> > > > - qamsg = qamsg + '\tImage QA function %s failed: %s\n' % (e.name, e.description)
> > > > + qamsg = 'Image QA function %s failed: %s\n' % (e.name, e.description)
> > > > + oe.qa.handle_error(e.name, qamsg, d)
> > > > except Exception as e:
> > > > qamsg = qamsg + '\tImage QA function %s failed: %s\n' % (cmd, e)
> > > >
> > > > - if qamsg:
> > > > - imgname = d.getVar('IMAGE_NAME')
> > > > - bb.fatal("QA errors found whilst validating image: %s\n%s" % (imgname, qamsg))
> > > > + oe.qa.exit_if_errors(d)
> > > > }
> > > > addtask do_image_qa after do_rootfs before do_image
> > > >
> > > > diff --git a/meta/lib/oe/utils.py b/meta/lib/oe/utils.py
> > > > index 14a7d07ef0..83f1440887 100644
> > > > --- a/meta/lib/oe/utils.py
> > > > +++ b/meta/lib/oe/utils.py
> > > > @@ -482,7 +482,7 @@ def get_multilib_datastore(variant, d):
> > > > localdata.setVar("MLPREFIX", "")
> > > > return localdata
> > > >
> > > > -class ImageQAFailed(Exception):
> > > > +class ImageQAFailed(bb.BBHandledException):
> > > > def __init__(self, description, name=None, logfile=None):
> > > > self.description = description
> > > > self.name = name
> > > >
> > >
> > > This caused further issues if I remember correctly.
> > >
> > > https://git.yoctoproject.org/poky/commit/?id=b0eb2b9b3660dfda1c4c43cfcca6a2c4a84d6dc8
> > >
> > > for example.
> >
> > Thanks for reviewing! I've got that one now and will also take it for
> > styhead.
> >
> > Steve
>
> Do note that I sent an alternative patch for Styhead that does not
> remove the ImageQAFailed exception. While I would be happy to see the
> version that went into master backported, I assumed that removing the
> ImageQAFailed exception would be considered as a change in behavior
> and thus not eligible for backporting.
>
> The alternative version I created for Styhead can be found here:
>
> https://lists.openembedded.org/g/openembedded-core/message/204982

Since I already took the master version for scarthgap, I'm inclined to
take that version for styhead too.

Steve