| Message ID | 20220301234214.247172-3-richard.purdie@linuxfoundation.org |
|---|---|
| State | Accepted, archived |
| Commit | 9379f80f484f94686a4d494e9e237fadfb72a938 |
| Headers | show |
| Series | [1/4] mutlilib: Handle WHITELIST_GPL-3.0 being unset | expand |
> -----Original Message----- > From: openembedded-core@lists.openembedded.org <openembedded-core@lists.openembedded.org> On Behalf Of Richard Purdie > Sent: den 2 mars 2022 00:42 > To: openembedded-core@lists.openembedded.org > Subject: [OE-core] [PATCH 3/4] license/insane: Show warning for obsolete license usage > > We want to use SPDX identifiers in LICENSE variables. There is now a > conversion script to make most of the translations. Add a list of > strings which have been replaced so we can show warnings to users > if they're still used anywhere. > > Add checks to the package as insane check. This is currently a warning > by default but can be turned off or made an error as per the other standard > checks. > > Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org> > --- > meta/classes/base.bbclass | 6 ++++++ > meta/classes/insane.bbclass | 31 ++++++++++++++++++++++--------- > meta/lib/oe/license.py | 10 ++++++++++ > 3 files changed, 38 insertions(+), 9 deletions(-) > > diff --git a/meta/classes/base.bbclass b/meta/classes/base.bbclass > index bfc7087a189..b7869da3b38 100644 > --- a/meta/classes/base.bbclass > +++ b/meta/classes/base.bbclass > @@ -597,6 +597,12 @@ python () { > > exceptions = (d.getVar("INCOMPATIBLE_LICENSE_EXCEPTIONS") or "").split() > > + for lic_exception in exceptions: > + if ":" in lic_exception: > + lic_exception.split(":")[0] > + if lic_exception in oe.license.obsolete_license_list(): > + bb.fatal("Invalid license %s used in INCOMPATIBLE_LICENSE_EXCEPTIONS" % lic_exception) > + > pkgs = d.getVar('PACKAGES').split() > skipped_pkgs = {} > unskipped_pkgs = [] > diff --git a/meta/classes/insane.bbclass b/meta/classes/insane.bbclass > index 29b9b3d466a..3c8d49f13bd 100644 > --- a/meta/classes/insane.bbclass > +++ b/meta/classes/insane.bbclass > @@ -27,7 +27,7 @@ WARN_QA ?= " libdir xorg-driver-abi \ > mime mime-xdg unlisted-pkg-lics unhandled-features-check \ > missing-update-alternatives native-last missing-ptest \ > license-exists license-no-generic license-syntax license-format \ > - license-incompatible license-file-missing \ > + license-incompatible license-file-missing obsolete-license \ > " > ERROR_QA ?= "dev-so debug-deps dev-deps debug-files arch pkgconfig la \ > perms dep-cmp pkgvarcheck perm-config perm-line perm-link \ > @@ -909,14 +909,19 @@ def package_qa_check_unlisted_pkg_lics(package, d, messages): > return True > > recipe_lics_set = oe.license.list_licenses(d.getVar('LICENSE')) > - unlisted = oe.license.list_licenses(pkg_lics) - recipe_lics_set > - if not unlisted: > - return True > - > - oe.qa.add_message(messages, "unlisted-pkg-lics", > - "LICENSE:%s includes licenses (%s) that are not " > - "listed in LICENSE" % (package, ' '.join(unlisted))) > - return False > + package_lics = oe.license.list_licenses(pkg_lics) > + unlisted = package_lics - recipe_lics_set > + if unlisted: > + oe.qa.add_message(messages, "unlisted-pkg-lics", > + "LICENSE:%s includes licenses (%s) that are not " > + "listed in LICENSE" % (package, ' '.join(unlisted))) > + return False > + obsolete = set(oe.license.obsolete_license_list()) & package_lics - recipe_lics_set > + if obsolete: > + oe.qa.add_message(messages, "obsolete-license", > + "LICENSE:%s includes obsolete licenses %s" % (package, ' '.join(obsolete))) > + return False > + return True > > QAPKGTEST[empty-dirs] = "package_qa_check_empty_dirs" > def package_qa_check_empty_dirs(pkg, d, messages): > @@ -1012,6 +1017,14 @@ python do_package_qa () { > > bb.note("DO PACKAGE QA") > > + main_lic = d.getVar('LICENSE') > + > + # Check for obsolete license references in main LICENSE (packages are checked below for any changes) > + main_licenses = oe.license.list_licenses(d.getVar('LICENSE')) The documentation for oe.license.list_licenses() says that it returns a list, but I assume that is not true or the code below would not work... > + obsolete = set(oe.license.obsolete_license_list()) & main_licenses > + if obsolete: > + oe.qa.handle_error("obsolete-license", "Recipe LICENSE includes obsolete licenses %s" % ' '.join(obsolete), d) > + > bb.build.exec_func("read_subpackage_metadata", d) > > # Check non UTF-8 characters on recipe's metadata //Peter
On Wed, 2022-03-02 at 15:17 +0000, Peter Kjellerstedt wrote: > > + main_lic = d.getVar('LICENSE') > > + > > + # Check for obsolete license references in main LICENSE (packages are checked below for any changes) > > + main_licenses = oe.license.list_licenses(d.getVar('LICENSE')) > > The documentation for oe.license.list_licenses() says that it returns > a list, but I assume that is not true or the code below would not work... > > > + obsolete = set(oe.license.obsolete_license_list()) & main_licenses > > + if obsolete: > > + oe.qa.handle_error("obsolete-license", "Recipe LICENSE includes obsolete licenses %s" % ' '.join(obsolete), d) > > + > > bb.build.exec_func("read_subpackage_metadata", d) > > > > # Check non UTF-8 characters on recipe's metadata It does return a set, not a list. Cheers, Richard
diff --git a/meta/classes/base.bbclass b/meta/classes/base.bbclass index bfc7087a189..b7869da3b38 100644 --- a/meta/classes/base.bbclass +++ b/meta/classes/base.bbclass @@ -597,6 +597,12 @@ python () { exceptions = (d.getVar("INCOMPATIBLE_LICENSE_EXCEPTIONS") or "").split() + for lic_exception in exceptions: + if ":" in lic_exception: + lic_exception.split(":")[0] + if lic_exception in oe.license.obsolete_license_list(): + bb.fatal("Invalid license %s used in INCOMPATIBLE_LICENSE_EXCEPTIONS" % lic_exception) + pkgs = d.getVar('PACKAGES').split() skipped_pkgs = {} unskipped_pkgs = [] diff --git a/meta/classes/insane.bbclass b/meta/classes/insane.bbclass index 29b9b3d466a..3c8d49f13bd 100644 --- a/meta/classes/insane.bbclass +++ b/meta/classes/insane.bbclass @@ -27,7 +27,7 @@ WARN_QA ?= " libdir xorg-driver-abi \ mime mime-xdg unlisted-pkg-lics unhandled-features-check \ missing-update-alternatives native-last missing-ptest \ license-exists license-no-generic license-syntax license-format \ - license-incompatible license-file-missing \ + license-incompatible license-file-missing obsolete-license \ " ERROR_QA ?= "dev-so debug-deps dev-deps debug-files arch pkgconfig la \ perms dep-cmp pkgvarcheck perm-config perm-line perm-link \ @@ -909,14 +909,19 @@ def package_qa_check_unlisted_pkg_lics(package, d, messages): return True recipe_lics_set = oe.license.list_licenses(d.getVar('LICENSE')) - unlisted = oe.license.list_licenses(pkg_lics) - recipe_lics_set - if not unlisted: - return True - - oe.qa.add_message(messages, "unlisted-pkg-lics", - "LICENSE:%s includes licenses (%s) that are not " - "listed in LICENSE" % (package, ' '.join(unlisted))) - return False + package_lics = oe.license.list_licenses(pkg_lics) + unlisted = package_lics - recipe_lics_set + if unlisted: + oe.qa.add_message(messages, "unlisted-pkg-lics", + "LICENSE:%s includes licenses (%s) that are not " + "listed in LICENSE" % (package, ' '.join(unlisted))) + return False + obsolete = set(oe.license.obsolete_license_list()) & package_lics - recipe_lics_set + if obsolete: + oe.qa.add_message(messages, "obsolete-license", + "LICENSE:%s includes obsolete licenses %s" % (package, ' '.join(obsolete))) + return False + return True QAPKGTEST[empty-dirs] = "package_qa_check_empty_dirs" def package_qa_check_empty_dirs(pkg, d, messages): @@ -1012,6 +1017,14 @@ python do_package_qa () { bb.note("DO PACKAGE QA") + main_lic = d.getVar('LICENSE') + + # Check for obsolete license references in main LICENSE (packages are checked below for any changes) + main_licenses = oe.license.list_licenses(d.getVar('LICENSE')) + obsolete = set(oe.license.obsolete_license_list()) & main_licenses + if obsolete: + oe.qa.handle_error("obsolete-license", "Recipe LICENSE includes obsolete licenses %s" % ' '.join(obsolete), d) + bb.build.exec_func("read_subpackage_metadata", d) # Check non UTF-8 characters on recipe's metadata diff --git a/meta/lib/oe/license.py b/meta/lib/oe/license.py index 29412dfe46b..99cfa5f7339 100644 --- a/meta/lib/oe/license.py +++ b/meta/lib/oe/license.py @@ -14,6 +14,16 @@ def license_ok(license, dont_want_licenses): return False return True +def obsolete_license_list(): + return ["AGPL-3", "AGPL-3+", "AGPLv3", "AGPLv3+", "AGPLv3.0", "AGPLv3.0+", "AGPL-3.0", "AGPL-3.0+", "BSD-0-Clause", + "GPL-1", "GPL-1+", "GPLv1", "GPLv1+", "GPLv1.0", "GPLv1.0+", "GPL-1.0", "GPL-1.0+", "GPL-2", "GPL-2+", "GPLv2", + "GPLv2+", "GPLv2.0", "GPLv2.0+", "GPL-2.0", "GPL-2.0+", "GPL-3", "GPL-3+", "GPLv3", "GPLv3+", "GPLv3.0", "GPLv3.0+", + "GPL-3.0", "GPL-3.0+", "LGPLv2", "LGPLv2+", "LGPLv2.0", "LGPLv2.0+", "LGPL-2.0", "LGPL-2.0+", "LGPL2.1", "LGPL2.1+", + "LGPLv2.1", "LGPLv2.1+", "LGPL-2.1", "LGPL-2.1+", "LGPLv3", "LGPLv3+", "LGPL-3.0", "LGPL-3.0+", "MPL-1", "MPLv1", + "MPLv1.1", "MPLv2", "MIT-X", "MIT-style", "openssl", "PSF", "PSFv2", "Python-2", "Apachev2", "Apache-2", "Artisticv1", + "Artistic-1", "AFL-2", "AFL-1", "AFLv2", "AFLv1", "CDDLv1", "CDDL-1", "EPLv1.0", "FreeType", "Nauman", + "tcl", "vim", "SGIv1"] + class LicenseError(Exception): pass
We want to use SPDX identifiers in LICENSE variables. There is now a conversion script to make most of the translations. Add a list of strings which have been replaced so we can show warnings to users if they're still used anywhere. Add checks to the package as insane check. This is currently a warning by default but can be turned off or made an error as per the other standard checks. Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org> --- meta/classes/base.bbclass | 6 ++++++ meta/classes/insane.bbclass | 31 ++++++++++++++++++++++--------- meta/lib/oe/license.py | 10 ++++++++++ 3 files changed, 38 insertions(+), 9 deletions(-)