blob: 8980137d02cfff3eea0a55b22427d9d6d04996bf [file] [log] [blame]
Patrick Williams2390b1b2022-11-03 13:47:49 -05001#
2# Copyright OpenEmbedded Contributors
3#
4# SPDX-License-Identifier: MIT
5#
6
7##
8## Purpose:
9## This class is used to update the list of crates in SRC_URI
10## by reading Cargo.lock in the source tree.
11##
12## See meta/recipes-devtools/python/python3-bcrypt_*.bb for an example
13##
14## To perform the update: bitbake -c update_crates recipe-name
15
16addtask do_update_crates after do_patch
17do_update_crates[depends] = "python3-native:do_populate_sysroot"
Andrew Geisslerc5535c92023-01-27 16:10:19 -060018do_update_crates[nostamp] = "1"
Andrew Geisslerfc113ea2023-03-31 09:59:46 -050019do_update_crates[doc] = "Update the recipe by reading Cargo.lock and write in ${THISDIR}/${BPN}-crates.inc"
Patrick Williams2390b1b2022-11-03 13:47:49 -050020
21# The directory where to search for Cargo.lock files
22CARGO_LOCK_SRC_DIR ??= "${S}"
23
24do_update_crates() {
Andrew Geisslerfc113ea2023-03-31 09:59:46 -050025 TARGET_FILE="${THISDIR}/${BPN}-crates.inc"
26
Patrick Williams2390b1b2022-11-03 13:47:49 -050027 nativepython3 - <<EOF
28
29def get_crates(f):
30 import tomllib
31 c_list = '# from %s' % os.path.relpath(f, '${CARGO_LOCK_SRC_DIR}')
32 c_list += '\nSRC_URI += " \\\'
33 crates = tomllib.load(open(f, 'rb'))
Andrew Geisslerfc113ea2023-03-31 09:59:46 -050034
35 # Build a list with crates info that have crates.io in the source
36 crates_candidates = list(filter(lambda c: 'crates.io' in c.get('source', ''), crates['package']))
37
38 if not crates_candidates:
39 raise ValueError("Unable to find any candidate crates that use crates.io")
40
Andrew Geisslerfc113ea2023-03-31 09:59:46 -050041 # Update crates uri and their checksum, to avoid name clashing on the checksum
Patrick Williams8e7b46e2023-05-01 14:19:06 -050042 # we need to rename crates with name and version to have a unique key
Andrew Geisslerfc113ea2023-03-31 09:59:46 -050043 cksum_list = ''
44 for c in crates_candidates:
Patrick Williams8e7b46e2023-05-01 14:19:06 -050045 rename = "%s-%s" % (c['name'], c['version'])
46 c_list += '\n crate://crates.io/%s/%s \\\' % (c['name'], c['version'])
Andrew Geisslerfc113ea2023-03-31 09:59:46 -050047 if 'checksum' in c:
48 cksum_list += '\nSRC_URI[%s.sha256sum] = "%s"' % (rename, c['checksum'])
49
Patrick Williams2390b1b2022-11-03 13:47:49 -050050 c_list += '\n"\n'
Andrew Geisslerfc113ea2023-03-31 09:59:46 -050051 c_list += cksum_list
52 c_list += '\n'
Patrick Williams2390b1b2022-11-03 13:47:49 -050053 return c_list
54
55import os
56crates = "# Autogenerated with 'bitbake -c update_crates ${PN}'\n\n"
Andrew Geisslerfc113ea2023-03-31 09:59:46 -050057found = False
Patrick Williams2390b1b2022-11-03 13:47:49 -050058for root, dirs, files in os.walk('${CARGO_LOCK_SRC_DIR}'):
Patrick Williams8e7b46e2023-05-01 14:19:06 -050059 # ignore git and patches directories
60 if root.startswith(os.path.join('${CARGO_LOCK_SRC_DIR}', '.pc')):
61 continue
62 if root.startswith(os.path.join('${CARGO_LOCK_SRC_DIR}', '.git')):
63 continue
Patrick Williams2390b1b2022-11-03 13:47:49 -050064 for file in files:
65 if file == 'Cargo.lock':
Patrick Williams8e7b46e2023-05-01 14:19:06 -050066 try:
67 cargo_lock_path = os.path.join(root, file)
68 crates += get_crates(os.path.join(root, file))
69 except Exception as e:
70 raise ValueError("Cannot parse '%s'" % cargo_lock_path) from e
71 else:
72 found = True
Andrew Geisslerfc113ea2023-03-31 09:59:46 -050073if not found:
Patrick Williams8e7b46e2023-05-01 14:19:06 -050074 raise ValueError("Unable to find any Cargo.lock in ${CARGO_LOCK_SRC_DIR}")
Andrew Geisslerfc113ea2023-03-31 09:59:46 -050075open("${TARGET_FILE}", 'w').write(crates)
Patrick Williams2390b1b2022-11-03 13:47:49 -050076EOF
Andrew Geisslerfc113ea2023-03-31 09:59:46 -050077
78 bbnote "Successfully update crates inside '${TARGET_FILE}'"
Patrick Williams2390b1b2022-11-03 13:47:49 -050079}