* [PATCH] license: Allow treating missing license as error
@ 2021-10-08 8:53 Mike Crowe
2021-10-09 15:51 ` [OE-core] " Peter Kjellerstedt
0 siblings, 1 reply; 3+ messages in thread
From: Mike Crowe @ 2021-10-08 8:53 UTC (permalink / raw)
To: openembedded-core; +Cc: Mike Crowe
Use mechanism inspired by insane.bbclass to allow individual recipes or
other configuration to determine whether a missing licence should be
treated as a warning (as it is now) or as an error. This is controlled
by whether the error class is in WARN_LICENSE or ERROR_LICENSE.
Use bb.fatal in the error case to ensure that the task really fails. If
only bb.error is used then do_populate_lic isn't re-run on subsequent
builds which could lead to the error being missed.
Signed-off-by: Mike Crowe <mac@mcrowe.com>
---
meta/classes/license.bbclass | 19 ++++++++++++++++++-
1 file changed, 18 insertions(+), 1 deletion(-)
diff --git a/meta/classes/license.bbclass b/meta/classes/license.bbclass
index 45d912741d..1805f18076 100644
--- a/meta/classes/license.bbclass
+++ b/meta/classes/license.bbclass
@@ -12,6 +12,23 @@ LICENSE_CREATE_PACKAGE ??= "0"
LICENSE_PACKAGE_SUFFIX ??= "-lic"
LICENSE_FILES_DIRECTORY ??= "${datadir}/licenses/"
+# Elect whether a given type of error is a warning or error, they may
+# have been set by other files.
+WARN_LICENSE ?= "no-license"
+ERROR_LICENSE ?= ""
+WARN_LICENSE[doc] = "Space-separated list of license problems that should be reported only as warnings"
+ERROR_LICENSE[doc] = "Space-separated list of license problems that should be reported as errors"
+
+def package_license_handle_error(error_class, error_msg, d):
+ if error_class in (d.getVar("ERROR_LICENSE") or "").split():
+ package_qa_write_error(error_class, error_msg, d)
+ bb.fatal("License Issue: %s [%s]" % (error_msg, error_class))
+ elif error_class in (d.getVar("WARN_LICENSE") or "").split():
+ package_qa_write_error(error_class, error_msg, d)
+ bb.warn("License Issue: %s [%s]" % (error_msg, error_class))
+ else:
+ bb.note("QA Issue: %s [%s]" % (error_msg, error_class))
+
addtask populate_lic after do_patch before do_build
do_populate_lic[dirs] = "${LICSSTATEDIR}/${PN}"
do_populate_lic[cleandirs] = "${LICSSTATEDIR}"
@@ -190,7 +207,7 @@ def find_license_files(d):
# Add explicity avoid of CLOSED license because this isn't generic
if license_type != 'CLOSED':
# And here is where we warn people that their licenses are lousy
- bb.warn("%s: No generic license file exists for: %s in any provider" % (pn, license_type))
+ package_license_handle_error("no-license", "%s: No generic license file exists for: %s in any provider" % (pn, license_type), d)
pass
if not generic_directory:
--
2.30.2
^ permalink raw reply related [flat|nested] 3+ messages in thread
* RE: [OE-core] [PATCH] license: Allow treating missing license as error
2021-10-08 8:53 [PATCH] license: Allow treating missing license as error Mike Crowe
@ 2021-10-09 15:51 ` Peter Kjellerstedt
2021-10-10 17:22 ` mac
0 siblings, 1 reply; 3+ messages in thread
From: Peter Kjellerstedt @ 2021-10-09 15:51 UTC (permalink / raw)
To: mac, openembedded-core
> -----Original Message-----
> From: openembedded-core@lists.openembedded.org <openembedded-
> core@lists.openembedded.org> On Behalf Of Mike Crowe via
> lists.openembedded.org
> Sent: den 8 oktober 2021 10:54
> To: openembedded-core@lists.openembedded.org
> Cc: Mike Crowe <mac@mcrowe.com>
> Subject: [OE-core] [PATCH] license: Allow treating missing license as
> error
>
> Use mechanism inspired by insane.bbclass to allow individual recipes or
> other configuration to determine whether a missing licence should be
> treated as a warning (as it is now) or as an error. This is controlled
> by whether the error class is in WARN_LICENSE or ERROR_LICENSE.
>
> Use bb.fatal in the error case to ensure that the task really fails. If
> only bb.error is used then do_populate_lic isn't re-run on subsequent
> builds which could lead to the error being missed.
>
> Signed-off-by: Mike Crowe <mac@mcrowe.com>
> ---
> meta/classes/license.bbclass | 19 ++++++++++++++++++-
> 1 file changed, 18 insertions(+), 1 deletion(-)
>
> diff --git a/meta/classes/license.bbclass b/meta/classes/license.bbclass
> index 45d912741d..1805f18076 100644
> --- a/meta/classes/license.bbclass
> +++ b/meta/classes/license.bbclass
> @@ -12,6 +12,23 @@ LICENSE_CREATE_PACKAGE ??= "0"
> LICENSE_PACKAGE_SUFFIX ??= "-lic"
> LICENSE_FILES_DIRECTORY ??= "${datadir}/licenses/"
>
> +# Elect whether a given type of error is a warning or error, they may
> +# have been set by other files.
> +WARN_LICENSE ?= "no-license"
> +ERROR_LICENSE ?= ""
> +WARN_LICENSE[doc] = "Space-separated list of license problems that should be reported only as warnings"
> +ERROR_LICENSE[doc] = "Space-separated list of license problems that should be reported as errors"
> +
> +def package_license_handle_error(error_class, error_msg, d):
> + if error_class in (d.getVar("ERROR_LICENSE") or "").split():
> + package_qa_write_error(error_class, error_msg, d)
> + bb.fatal("License Issue: %s [%s]" % (error_msg, error_class))
> + elif error_class in (d.getVar("WARN_LICENSE") or "").split():
> + package_qa_write_error(error_class, error_msg, d)
> + bb.warn("License Issue: %s [%s]" % (error_msg, error_class))
> + else:
> + bb.note("QA Issue: %s [%s]" % (error_msg, error_class))
Change "QA Issue" to "License Issue" for consistency.
> +
> addtask populate_lic after do_patch before do_build
> do_populate_lic[dirs] = "${LICSSTATEDIR}/${PN}"
> do_populate_lic[cleandirs] = "${LICSSTATEDIR}"
> @@ -190,7 +207,7 @@ def find_license_files(d):
> # Add explicity avoid of CLOSED license because this isn't generic
> if license_type != 'CLOSED':
> # And here is where we warn people that their licenses are lousy
> - bb.warn("%s: No generic license file exists for: %s in any provider" % (pn, license_type))
> + package_license_handle_error("no-license", "%s: No generic license file exists for: %s in any provider" % (pn, license_type), d)
> pass
>
> if not generic_directory:
> --
> 2.30.2
//Peter
^ permalink raw reply [flat|nested] 3+ messages in thread
* Re: [OE-core] [PATCH] license: Allow treating missing license as error
2021-10-09 15:51 ` [OE-core] " Peter Kjellerstedt
@ 2021-10-10 17:22 ` mac
0 siblings, 0 replies; 3+ messages in thread
From: mac @ 2021-10-10 17:22 UTC (permalink / raw)
To: Peter Kjellerstedt; +Cc: openembedded-core
On Saturday 09 October 2021 at 15:51:35 +0000, Peter Kjellerstedt wrote:
> > -----Original Message-----
> > From: openembedded-core@lists.openembedded.org <openembedded-
> > core@lists.openembedded.org> On Behalf Of Mike Crowe via
> > lists.openembedded.org
> > Sent: den 8 oktober 2021 10:54
> > To: openembedded-core@lists.openembedded.org
> > Cc: Mike Crowe <mac@mcrowe.com>
> > Subject: [OE-core] [PATCH] license: Allow treating missing license as
> > error
> >
> > Use mechanism inspired by insane.bbclass to allow individual recipes or
> > other configuration to determine whether a missing licence should be
> > treated as a warning (as it is now) or as an error. This is controlled
> > by whether the error class is in WARN_LICENSE or ERROR_LICENSE.
> >
> > Use bb.fatal in the error case to ensure that the task really fails. If
> > only bb.error is used then do_populate_lic isn't re-run on subsequent
> > builds which could lead to the error being missed.
> >
> > Signed-off-by: Mike Crowe <mac@mcrowe.com>
> > ---
> > meta/classes/license.bbclass | 19 ++++++++++++++++++-
> > 1 file changed, 18 insertions(+), 1 deletion(-)
> >
> > diff --git a/meta/classes/license.bbclass b/meta/classes/license.bbclass
> > index 45d912741d..1805f18076 100644
> > --- a/meta/classes/license.bbclass
> > +++ b/meta/classes/license.bbclass
> > @@ -12,6 +12,23 @@ LICENSE_CREATE_PACKAGE ??= "0"
> > LICENSE_PACKAGE_SUFFIX ??= "-lic"
> > LICENSE_FILES_DIRECTORY ??= "${datadir}/licenses/"
> >
> > +# Elect whether a given type of error is a warning or error, they may
> > +# have been set by other files.
> > +WARN_LICENSE ?= "no-license"
> > +ERROR_LICENSE ?= ""
> > +WARN_LICENSE[doc] = "Space-separated list of license problems that should be reported only as warnings"
> > +ERROR_LICENSE[doc] = "Space-separated list of license problems that should be reported as errors"
> > +
> > +def package_license_handle_error(error_class, error_msg, d):
> > + if error_class in (d.getVar("ERROR_LICENSE") or "").split():
> > + package_qa_write_error(error_class, error_msg, d)
> > + bb.fatal("License Issue: %s [%s]" % (error_msg, error_class))
> > + elif error_class in (d.getVar("WARN_LICENSE") or "").split():
> > + package_qa_write_error(error_class, error_msg, d)
> > + bb.warn("License Issue: %s [%s]" % (error_msg, error_class))
> > + else:
> > + bb.note("QA Issue: %s [%s]" % (error_msg, error_class))
>
> Change "QA Issue" to "License Issue" for consistency.
Whoops. Thanks for spotting that. I've posted v2 with it fixed.
Mike.
^ permalink raw reply [flat|nested] 3+ messages in thread
end of thread, other threads:[~2021-10-10 17:23 UTC | newest]
Thread overview: 3+ messages (download: mbox.gz / follow: Atom feed)
-- links below jump to the message on this page --
2021-10-08 8:53 [PATCH] license: Allow treating missing license as error Mike Crowe
2021-10-09 15:51 ` [OE-core] " Peter Kjellerstedt
2021-10-10 17:22 ` mac
This is an external index of several public inboxes,
see mirroring instructions on how to clone and mirror
all data and code used by this external index.