| Message ID | 20240808144824.543208-6-enguerrand.de-ribaucourt@savoirfairelinux.com |
|---|---|
| State | New |
| Headers | show |
| Series | npm: improve fetcher and recipetool compatibility | expand |
Hello, When you resend, can you group the bitbake patches together please? That will make the series easier to apply. On 08/08/2024 16:48:23+0200, Enguerrand de Ribaucourt wrote: > +def match_licenses(licfiles, srctree, d): > + import bb > + md5sums = get_license_md5sums(d) > + > + crunched_md5sums = crunch_known_licenses(d) > + > + licenses = [] > for licfile in sorted(licfiles): > - md5value = bb.utils.md5_file(licfile) > + resolved_licfile = d.expand(licfile) I believe you need to rebase because this causes: https://autobuilder.yoctoproject.org/typhoon/#/builders/87/builds/7055/steps/14/logs/stdio https://autobuilder.yoctoproject.org/typhoon/#/builders/127/builds/3708/steps/14/logs/stdio https://autobuilder.yoctoproject.org/typhoon/#/builders/86/builds/7063/steps/14/logs/stdio https://autobuilder.yoctoproject.org/typhoon/#/builders/79/builds/7041/steps/14/logs/stdio https://autobuilder.yoctoproject.org/typhoon/#/builders/80/builds/6998/steps/14/logs/stdio 2024-08-09 09:19:32,800 - oe-selftest - INFO - recipetool.RecipetoolTests.test_recipetool_handle_license_vars (subunit.RemotedTestCase) 2024-08-09 09:19:32,800 - oe-selftest - INFO - ... ERROR 2024-08-09 09:19:32,801 - oe-selftest - INFO - 6: 43/50 253/601 (5.86s) (0 failed) (recipetool.RecipetoolTests.test_recipetool_handle_license_vars) 2024-08-09 09:19:32,801 - oe-selftest - INFO - testtools.testresult.real._StringException: Traceback (most recent call last): File "/home/pokybuild/yocto-worker/oe-selftest-ubuntu/build/meta/lib/oeqa/selftest/cases/recipetool.py", line 1091, in test_recipetool_handle_license_vars licvalues = handle_license_vars(srctree, lines_before, handled, extravalues, d) File "/home/pokybuild/yocto-worker/oe-selftest-ubuntu/build/scripts/lib/recipetool/create.py", line 963, in handle_license_vars licvalues = find_licenses(srctree, d) File "/home/pokybuild/yocto-worker/oe-selftest-ubuntu/build/scripts/lib/recipetool/create.py", line 1261, in find_licenses licenses = match_licenses(licfiles, srctree, d) File "/home/pokybuild/yocto-worker/oe-selftest-ubuntu/build/scripts/lib/recipetool/create.py", line 1243, in match_licenses resolved_licfile = d.expand(licfile) AttributeError: type object 'DataConnectorCopy' has no attribute 'expand' > + md5value = bb.utils.md5_file(resolved_licfile) > license = md5sums.get(md5value, None) > if not license: > - crunched_md5, lictext = crunch_license(licfile) > + crunched_md5, lictext = crunch_license(resolved_licfile) > license = crunched_md5sums.get(crunched_md5, None) > if lictext and not license: > license = 'Unknown' > @@ -1249,13 +1254,19 @@ def guess_license(srctree, d): > if license: > licenses.append((license, os.path.relpath(licfile, srctree), md5value)) > > + return licenses > + > +def find_licenses(srctree, d): > + licfiles = find_license_files(srctree) > + licenses = match_licenses(licfiles, srctree, d) > + > # FIXME should we grab at least one source file with a license header and add that too? > > return licenses > > def split_pkg_licenses(licvalues, packages, outlines, fallback_licenses=None, pn='${PN}'): > """ > - Given a list of (license, path, md5sum) as returned by guess_license(), > + Given a list of (license, path, md5sum) as returned by match_licenses(), > a dict of package name to path mappings, write out a set of > package-specific LICENSE values. > """ > @@ -1418,4 +1429,3 @@ def register_commands(subparsers): > parser_create.add_argument('--devtool', action="store_true", help=argparse.SUPPRESS) > parser_create.add_argument('--mirrors', action="store_true", help='Enable PREMIRRORS and MIRRORS for source tree fetching (disabled by default).') > parser_create.set_defaults(func=create_recipe) > - > diff --git a/scripts/lib/recipetool/create_go.py b/scripts/lib/recipetool/create_go.py > index a85a2f2786..5cc53931f0 100644 > --- a/scripts/lib/recipetool/create_go.py > +++ b/scripts/lib/recipetool/create_go.py > @@ -14,7 +14,7 @@ from collections import namedtuple > from enum import Enum > from html.parser import HTMLParser > from recipetool.create import RecipeHandler, handle_license_vars > -from recipetool.create import guess_license, tidy_licenses, fixup_license > +from recipetool.create import find_licenses, tidy_licenses, fixup_license > from recipetool.create import determine_from_url > from urllib.error import URLError, HTTPError > > @@ -624,7 +624,7 @@ class GoRecipeHandler(RecipeHandler): > > licenses = [] > lic_files_chksum = [] > - licvalues = guess_license(tmp_vendor_dir, d) > + licvalues = find_licenses(tmp_vendor_dir, d) > shutil.rmtree(tmp_vendor_dir) > > if licvalues: > diff --git a/scripts/lib/recipetool/create_npm.py b/scripts/lib/recipetool/create_npm.py > index dd0ac01c3e..78dc248f31 100644 > --- a/scripts/lib/recipetool/create_npm.py > +++ b/scripts/lib/recipetool/create_npm.py > @@ -17,7 +17,7 @@ from bb.fetch2.npm import npm_package > from bb.fetch2.npmsw import foreach_dependencies > from recipetool.create import RecipeHandler > from recipetool.create import get_license_md5sums > -from recipetool.create import guess_license > +from recipetool.create import find_licenses > from recipetool.create import split_pkg_licenses > logger = logging.getLogger('recipetool') > > @@ -320,7 +320,7 @@ class NpmRecipeHandler(RecipeHandler): > return (licenses, chksums, fallback_licenses) > > (licenses, extravalues["LIC_FILES_CHKSUM"], fallback_licenses) = _guess_odd_license(licfiles) > - split_pkg_licenses([*licenses, *guess_license(srctree, d)], packages, lines_after, fallback_licenses) > + split_pkg_licenses([*licenses, *find_licenses(srctree, d)], packages, lines_after, fallback_licenses) > > classes.append("npm") > handled.append("buildsystem") > -- > 2.34.1 > > > -=-=-=-=-=-=-=-=-=-=-=- > Links: You receive all messages sent to this group. > View/Reply Online (#16458): https://lists.openembedded.org/g/bitbake-devel/message/16458 > Mute This Topic: https://lists.openembedded.org/mt/107790971/3617179 > Group Owner: bitbake-devel+owner@lists.openembedded.org > Unsubscribe: https://lists.openembedded.org/g/bitbake-devel/unsub [alexandre.belloni@bootlin.com] > -=-=-=-=-=-=-=-=-=-=-=- >
diff --git a/meta/classes-global/license.bbclass b/meta/classes-global/license.bbclass index b2e0d3faba..4e39ec1d44 100644 --- a/meta/classes-global/license.bbclass +++ b/meta/classes-global/license.bbclass @@ -39,7 +39,7 @@ python do_populate_lic() { } PSEUDO_IGNORE_PATHS .= ",${@','.join(((d.getVar('COMMON_LICENSE_DIR') or '') + ' ' + (d.getVar('LICENSE_PATH') or '') + ' ' + d.getVar('COREBASE') + '/meta/COPYING').split())}" -# it would be better to copy them in do_install:append, but find_license_filesa is python +# it would be better to copy them in do_install:append, but find_license_files is python python perform_packagecopy:prepend () { enabled = oe.data.typed_value('LICENSE_CREATE_PACKAGE', d) if d.getVar('CLASSOVERRIDE') == 'class-target' and enabled: @@ -149,14 +149,14 @@ def find_license_files(d): # and "with exceptions" being * # we'll just strip out the modifier and put # the base license. - find_license(node.s.replace("+", "").replace("*", "")) + find_licenses(node.s.replace("+", "").replace("*", "")) self.generic_visit(node) def visit_Constant(self, node): - find_license(node.value.replace("+", "").replace("*", "")) + find_licenses(node.value.replace("+", "").replace("*", "")) self.generic_visit(node) - def find_license(license_type): + def find_licenses(license_type): try: bb.utils.mkdirhier(gen_lic_dest) except: diff --git a/scripts/lib/recipetool/create.py b/scripts/lib/recipetool/create.py index 8e9ff38db6..cb1566784b 100644 --- a/scripts/lib/recipetool/create.py +++ b/scripts/lib/recipetool/create.py @@ -960,7 +960,7 @@ def handle_license_vars(srctree, lines_before, handled, extravalues, d): # Someone else has already handled the license vars, just return their value return lichandled[0][1] - licvalues = guess_license(srctree, d) + licvalues = find_licenses(srctree, d) licenses = [] lic_files_chksum = [] lic_unknown = [] @@ -1216,13 +1216,7 @@ def crunch_license(licfile): lictext = '' return md5val, lictext -def guess_license(srctree, d): - import bb - md5sums = get_license_md5sums(d) - - crunched_md5sums = crunch_known_licenses(d) - - licenses = [] +def find_license_files(srctree): licspecs = ['*LICEN[CS]E*', 'COPYING*', '*[Ll]icense*', 'LEGAL*', '[Ll]egal*', '*GPL*', 'README.lic*', 'COPYRIGHT*', '[Cc]opyright*', 'e[dp]l-v10'] skip_extensions = (".html", ".js", ".json", ".svg", ".ts", ".go") licfiles = [] @@ -1235,11 +1229,22 @@ def guess_license(srctree, d): fullpath = os.path.join(root, fn) if not fullpath in licfiles: licfiles.append(fullpath) + + return licfiles + +def match_licenses(licfiles, srctree, d): + import bb + md5sums = get_license_md5sums(d) + + crunched_md5sums = crunch_known_licenses(d) + + licenses = [] for licfile in sorted(licfiles): - md5value = bb.utils.md5_file(licfile) + resolved_licfile = d.expand(licfile) + md5value = bb.utils.md5_file(resolved_licfile) license = md5sums.get(md5value, None) if not license: - crunched_md5, lictext = crunch_license(licfile) + crunched_md5, lictext = crunch_license(resolved_licfile) license = crunched_md5sums.get(crunched_md5, None) if lictext and not license: license = 'Unknown' @@ -1249,13 +1254,19 @@ def guess_license(srctree, d): if license: licenses.append((license, os.path.relpath(licfile, srctree), md5value)) + return licenses + +def find_licenses(srctree, d): + licfiles = find_license_files(srctree) + licenses = match_licenses(licfiles, srctree, d) + # FIXME should we grab at least one source file with a license header and add that too? return licenses def split_pkg_licenses(licvalues, packages, outlines, fallback_licenses=None, pn='${PN}'): """ - Given a list of (license, path, md5sum) as returned by guess_license(), + Given a list of (license, path, md5sum) as returned by match_licenses(), a dict of package name to path mappings, write out a set of package-specific LICENSE values. """ @@ -1418,4 +1429,3 @@ def register_commands(subparsers): parser_create.add_argument('--devtool', action="store_true", help=argparse.SUPPRESS) parser_create.add_argument('--mirrors', action="store_true", help='Enable PREMIRRORS and MIRRORS for source tree fetching (disabled by default).') parser_create.set_defaults(func=create_recipe) - diff --git a/scripts/lib/recipetool/create_go.py b/scripts/lib/recipetool/create_go.py index a85a2f2786..5cc53931f0 100644 --- a/scripts/lib/recipetool/create_go.py +++ b/scripts/lib/recipetool/create_go.py @@ -14,7 +14,7 @@ from collections import namedtuple from enum import Enum from html.parser import HTMLParser from recipetool.create import RecipeHandler, handle_license_vars -from recipetool.create import guess_license, tidy_licenses, fixup_license +from recipetool.create import find_licenses, tidy_licenses, fixup_license from recipetool.create import determine_from_url from urllib.error import URLError, HTTPError @@ -624,7 +624,7 @@ class GoRecipeHandler(RecipeHandler): licenses = [] lic_files_chksum = [] - licvalues = guess_license(tmp_vendor_dir, d) + licvalues = find_licenses(tmp_vendor_dir, d) shutil.rmtree(tmp_vendor_dir) if licvalues: diff --git a/scripts/lib/recipetool/create_npm.py b/scripts/lib/recipetool/create_npm.py index dd0ac01c3e..78dc248f31 100644 --- a/scripts/lib/recipetool/create_npm.py +++ b/scripts/lib/recipetool/create_npm.py @@ -17,7 +17,7 @@ from bb.fetch2.npm import npm_package from bb.fetch2.npmsw import foreach_dependencies from recipetool.create import RecipeHandler from recipetool.create import get_license_md5sums -from recipetool.create import guess_license +from recipetool.create import find_licenses from recipetool.create import split_pkg_licenses logger = logging.getLogger('recipetool') @@ -320,7 +320,7 @@ class NpmRecipeHandler(RecipeHandler): return (licenses, chksums, fallback_licenses) (licenses, extravalues["LIC_FILES_CHKSUM"], fallback_licenses) = _guess_odd_license(licfiles) - split_pkg_licenses([*licenses, *guess_license(srctree, d)], packages, lines_after, fallback_licenses) + split_pkg_licenses([*licenses, *find_licenses(srctree, d)], packages, lines_after, fallback_licenses) classes.append("npm") handled.append("buildsystem")
The npm recipetool handler redefines the license code the could be unified. In order to do this refactoring, extract the bits we'll need into separate functions. guess_license() is renamed to find_licenses() and is split into find_license_files() and match_licenses(). v3: - added commit Signed-off-by: Enguerrand de Ribaucourt <enguerrand.de-ribaucourt@savoirfairelinux.com> --- meta/classes-global/license.bbclass | 8 +++---- scripts/lib/recipetool/create.py | 34 ++++++++++++++++++---------- scripts/lib/recipetool/create_go.py | 4 ++-- scripts/lib/recipetool/create_npm.py | 4 ++-- 4 files changed, 30 insertions(+), 20 deletions(-)