From 9f03969994797220663280ef13fcb187446335ee Mon Sep 17 00:00:00 2001 From: Paul Eggleton Date: Thu, 5 Feb 2015 15:08:22 +0000 Subject: oe-pkgdata-util: improve command-line usage * Use argparse instead of optparse for standardised help output, options and a much cleaner code structure * Look up pkgdata directory automatically so the user doesn't have to specify it * Use standard logging NOTE: this does mean a slight change in syntax - if you do want to specify the pkgdata directory (usually only necessary if you're calling it from within the build process) you need to use the parameter -p (or --pkgdata-dir) and specify this before the command, not after it. Examples: oe-pkgdata-util find-path /sbin/mke2fs oe-pkgdata-util lookup-recipe libelf1 oe-pkgdata-util read-value PKGSIZE libc6 oe-pkgdata-util -p /home/user/oe/build/tmp/sysroots/qemux86-64/pkgdata read-value PKGSIZE libc6 (From OE-Core rev: 04dc571ac7c26f0dcf1a1fcd466482e22519998d) Signed-off-by: Paul Eggleton Signed-off-by: Richard Purdie --- scripts/oe-pkgdata-util | 264 +++++++++++++++++++++++------------------------- 1 file changed, 128 insertions(+), 136 deletions(-) (limited to 'scripts/oe-pkgdata-util') diff --git a/scripts/oe-pkgdata-util b/scripts/oe-pkgdata-util index bf8754749e..f70f85e147 100755 --- a/scripts/oe-pkgdata-util +++ b/scripts/oe-pkgdata-util @@ -4,7 +4,7 @@ # # Written by: Paul Eggleton # -# Copyright 2012-2013 Intel Corporation +# Copyright 2012-2015 Intel Corporation # # This program is free software; you can redistribute it and/or modify # it under the terms of the GNU General Public License version 2 as @@ -25,30 +25,40 @@ import os import os.path import fnmatch import re -import optparse +import argparse +import logging from collections import defaultdict -def glob(args, usage, debug=False): - if len(args) < 3: - usage() - sys.exit(1) +scripts_path = os.path.dirname(os.path.realpath(__file__)) +lib_path = scripts_path + '/lib' +sys.path = sys.path + [lib_path] +import scriptutils +logger = scriptutils.logger_create('pkgdatautil') - pkgdata_dir = args[0] - pkglist_file = args[1] - globs = args[2].split() +def tinfoil_init(): + import bb.tinfoil + import logging + tinfoil = bb.tinfoil.Tinfoil() + tinfoil.prepare(True) + + tinfoil.logger.setLevel(logging.WARNING) + return tinfoil - if not os.path.exists(pkgdata_dir): - print('ERROR: Unable to find pkgdata directory %s' % pkgdata_dir) - sys.exit(1) - if not os.path.exists(pkglist_file): - print('ERROR: Unable to find package list file %s' % pkglist_file) +def glob(args): + # Handle both multiple arguments and multiple values within an arg (old syntax) + globs = [] + for globitem in args.glob: + globs.extend(globitem.split()) + + if not os.path.exists(args.pkglistfile): + logger.error('Unable to find package list file %s' % args.pkglistfile) sys.exit(1) skipregex = re.compile("-locale-|^locale-base-|-dev$|-doc$|-dbg$|-staticdev$|^kernel-module-") mappedpkgs = set() - with open(pkglist_file, 'r') as f: + with open(args.pkglistfile, 'r') as f: for line in f: fields = line.rstrip().split() if not fields: @@ -59,8 +69,7 @@ def glob(args, usage, debug=False): # Skip packages for which there is no point applying globs if skipregex.search(pkg): - if debug: - print("%s -> !!" % pkg) + logger.debug("%s -> !!" % pkg) continue # Skip packages that already match the globs, so if e.g. a dev package @@ -72,15 +81,14 @@ def glob(args, usage, debug=False): already = True break if already: - if debug: - print("%s -> !" % pkg) + logger.debug("%s -> !" % pkg) continue # Define some functions def revpkgdata(pkgn): - return os.path.join(pkgdata_dir, "runtime-reverse", pkgn) + return os.path.join(args.pkgdata_dir, "runtime-reverse", pkgn) def fwdpkgdata(pkgn): - return os.path.join(pkgdata_dir, "runtime", pkgn) + return os.path.join(args.pkgdata_dir, "runtime", pkgn) def readpn(pkgdata_file): pn = "" with open(pkgdata_file, 'r') as f: @@ -130,81 +138,61 @@ def glob(args, usage, debug=False): mappedpkg = "" else: # Package doesn't even exist... - if debug: - print "%s is not a valid package!" % (pkg) + logger.debug("%s is not a valid package!" % (pkg)) break if mappedpkg: - if debug: - print "%s (%s) -> %s" % (pkg, g, mappedpkg) + logger.debug("%s (%s) -> %s" % (pkg, g, mappedpkg)) mappedpkgs.add(mappedpkg) else: - if debug: - print "%s (%s) -> ?" % (pkg, g) + logger.debug("%s (%s) -> ?" % (pkg, g)) - if debug: - print "------" + logger.debug("------") print("\n".join(mappedpkgs)) -def read_value(args, usage, debug=False): - if len(args) < 3: - usage() - sys.exit(1) - - pkgdata_dir = args[0] - var = args[1] - packages = args[2].split() +def read_value(args): + # Handle both multiple arguments and multiple values within an arg (old syntax) + packages = [] + for pkgitem in args.pkg: + packages.extend(pkgitem.split()) - if not os.path.exists(pkgdata_dir): - print('ERROR: Unable to find pkgdata directory %s' % pkgdata_dir) - sys.exit(1) - - def readvar(pkgdata_file, var): + def readvar(pkgdata_file, valuename): val = "" with open(pkgdata_file, 'r') as f: for line in f: - if line.startswith(var + ":"): + if line.startswith(valuename + ":"): val = line.split(': ')[1].rstrip() return val - if debug: - print "read-value('%s', '%s' '%s'" % (pkgdata_dir, var, packages) + logger.debug("read-value('%s', '%s' '%s'" % (args.pkgdata_dir, args.valuename, packages)) for package in packages: pkg_split = package.split('_') pkg_name = pkg_split[0] - if debug: - print "package: '%s'" % pkg_name - revlink = os.path.join(pkgdata_dir, "runtime-reverse", pkg_name) - if debug: - print(revlink) + logger.debug("package: '%s'" % pkg_name) + revlink = os.path.join(args.pkgdata_dir, "runtime-reverse", pkg_name) + logger.debug(revlink) if os.path.exists(revlink): mappedpkg = os.path.basename(os.readlink(revlink)) - qvar = var + qvar = args.valuename if qvar == "PKGSIZE": # append packagename - qvar = "%s_%s" % (var, mappedpkg) + qvar = "%s_%s" % (args.valuename, mappedpkg) # PKGSIZE is now in bytes, but we we want it in KB pkgsize = (int(readvar(revlink, qvar)) + 1024 // 2) // 1024 print("%d" % pkgsize) else: print(readvar(revlink, qvar)) -def lookup_pkg(args, usage, debug=False): - if len(args) < 2: - usage() - sys.exit(1) - - pkgdata_dir = args[0] - pkgs = args[1].split() - - if not os.path.exists(pkgdata_dir): - print('ERROR: Unable to find pkgdata directory %s' % pkgdata_dir) - sys.exit(1) +def lookup_pkg(args): + # Handle both multiple arguments and multiple values within an arg (old syntax) + pkgs = [] + for pkgitem in args.recipepkg: + pkgs.extend(pkgitem.split()) mappings = defaultdict(list) for pkg in pkgs: - pkgfile = os.path.join(pkgdata_dir, 'runtime', pkg) + pkgfile = os.path.join(args.pkgdata_dir, 'runtime', pkg) if os.path.exists(pkgfile): with open(pkgfile, 'r') as f: for line in f: @@ -214,29 +202,23 @@ def lookup_pkg(args, usage, debug=False): break if len(mappings) < len(pkgs): missing = list(set(pkgs) - set(mappings.keys())) - sys.stderr.write("ERROR: the following packages could not be found: %s\n" % ', '.join(missing)) + logger.error("The following packages could not be found: %s" % ', '.join(missing)) sys.exit(1) items = [] for pkg in pkgs: items.extend(mappings.get(pkg, [])) - print '\n'.join(items) + print('\n'.join(items)) -def lookup_recipe(args, usage, debug=False): - if len(args) < 2: - usage() - sys.exit(1) - - pkgdata_dir = args[0] - pkgs = args[1].split() - - if not os.path.exists(pkgdata_dir): - print('ERROR: Unable to find pkgdata directory %s' % pkgdata_dir) - sys.exit(1) +def lookup_recipe(args): + # Handle both multiple arguments and multiple values within an arg (old syntax) + pkgs = [] + for pkgitem in args.pkg: + pkgs.extend(pkgitem.split()) mappings = defaultdict(list) for pkg in pkgs: - pkgfile = os.path.join(pkgdata_dir, 'runtime-reverse', pkg) + pkgfile = os.path.join(args.pkgdata_dir, 'runtime-reverse', pkg) if os.path.exists(pkgfile): with open(pkgfile, 'r') as f: for line in f: @@ -246,30 +228,18 @@ def lookup_recipe(args, usage, debug=False): break if len(mappings) < len(pkgs): missing = list(set(pkgs) - set(mappings.keys())) - sys.stderr.write("ERROR: the following packages could not be found: %s\n" % ', '.join(missing)) + logger.error("The following packages could not be found: %s" % ', '.join(missing)) sys.exit(1) items = [] for pkg in pkgs: items.extend(mappings.get(pkg, [])) - print '\n'.join(items) - -def find_path(args, usage, debug=False): - if len(args) < 2: - usage() - sys.exit(1) - - pkgdata_dir = args[0] - targetpath = args[1] - - if not os.path.exists(pkgdata_dir): - print('ERROR: Unable to find pkgdata directory %s' % pkgdata_dir) - sys.exit(1) + print('\n'.join(items)) +def find_path(args): import json - import fnmatch - for root, dirs, files in os.walk(os.path.join(pkgdata_dir, 'runtime')): + for root, dirs, files in os.walk(os.path.join(args.pkgdata_dir, 'runtime')): for fn in files: with open(os.path.join(root,fn)) as f: for line in f: @@ -277,55 +247,77 @@ def find_path(args, usage, debug=False): val = line.split(':', 1)[1].strip() dictval = json.loads(val) for fullpth in dictval.keys(): - if fnmatch.fnmatchcase(fullpth, targetpath): + if fnmatch.fnmatchcase(fullpth, args.targetpath): print("%s: %s" % (fn, fullpth)) break def main(): - parser = optparse.OptionParser( - usage = '''%prog [options] - -Available commands: - glob "" - expand one or more glob expressions over the packages listed in - pkglistfile (one package per line) - lookup-pkg "" - look up the specified recipe-space package name(s) to see what the - final runtime package name is (e.g. eglibc becomes libc6) - lookup-recipe "" - look up the specified package(s) to see which recipe they were - produced by - find-path - find the package providing the specified path (wildcards * ? allowed) - read-value "" - read the named value from the pkgdata files for the specified - packages''') - - parser.add_option("-d", "--debug", - help = "Enable debug output", - action="store_true", dest="debug", default=False) - - options, args = parser.parse_args(sys.argv) - args = args[1:] - - if len(args) < 1: - parser.print_help() + parser = argparse.ArgumentParser(description="OpenEmbedded pkgdata tool - queries the pkgdata files written out during do_package", + epilog="Use %(prog)s --help to get help on a specific command") + parser.add_argument('-d', '--debug', help='Enable debug output', action='store_true') + parser.add_argument('-p', '--pkgdata-dir', help='Path to pkgdata directory (determined automatically if not specified)') + subparsers = parser.add_subparsers(title='subcommands', metavar='') + + parser_lookup_pkg = subparsers.add_parser('lookup-pkg', + help='Translate recipe-space package names to runtime package names', + description='Looks up the specified recipe-space package name(s) to see what the final runtime package name is (e.g. glibc becomes libc6)') + parser_lookup_pkg.add_argument('recipepkg', nargs='+', help='Recipe-space package name to look up') + parser_lookup_pkg.set_defaults(func=lookup_pkg) + + parser_lookup_recipe = subparsers.add_parser('lookup-recipe', + help='Find recipe producing one or more packages', + description='Looks up the specified runtime package(s) to see which recipe they were produced by') + parser_lookup_recipe.add_argument('pkg', nargs='+', help='Runtime package name to look up') + parser_lookup_recipe.set_defaults(func=lookup_recipe) + + parser_find_path = subparsers.add_parser('find-path', + help='Find package providing a target path', + description='Finds the recipe-space package providing the specified target path') + parser_find_path.add_argument('targetpath', help='Path to find (wildcards * ? allowed, use quotes to avoid shell expansion)') + parser_find_path.set_defaults(func=find_path) + + parser_read_value = subparsers.add_parser('read-value', + help='Read any pkgdata value for one or more packages', + description='Reads the named value from the pkgdata files for the specified packages') + parser_read_value.add_argument('valuename', help='Name of the value to look up') + parser_read_value.add_argument('pkg', nargs='+', help='Runtime package name to look up') + parser_read_value.set_defaults(func=read_value) + + parser_glob = subparsers.add_parser('glob', + help='Expand package name glob expression', + description='Expands one or more glob expressions over the packages listed in pkglistfile') + parser_glob.add_argument('pkglistfile', help='File listing packages (one package name per line)') + parser_glob.add_argument('glob', nargs="+", help='Glob expression for package names, e.g. *-dev') + parser_glob.set_defaults(func=glob) + + + args = parser.parse_args() + + if args.debug: + logger.setLevel(logging.DEBUG) + + if not args.pkgdata_dir: + import scriptpath + bitbakepath = scriptpath.add_bitbake_lib_path() + if not bitbakepath: + logger.error("Unable to find bitbake by searching parent directory of this script or PATH") + sys.exit(1) + logger.debug('Found bitbake path: %s' % bitbakepath) + tinfoil = tinfoil_init() + args.pkgdata_dir = tinfoil.config_data.getVar('PKGDATA_DIR', True) + logger.debug('Value of PKGDATA_DIR is "%s"' % args.pkgdata_dir) + if not args.pkgdata_dir: + logger.error('Unable to determine pkgdata directory from PKGDATA_DIR') + sys.exit(1) + + if not os.path.exists(args.pkgdata_dir): + logger.error('Unable to find pkgdata directory %s' % pkgdata_dir) sys.exit(1) - if args[0] == "glob": - glob(args[1:], parser.print_help, options.debug) - elif args[0] == "lookup-pkg": - lookup_pkg(args[1:], parser.print_help, options.debug) - elif args[0] == "lookup-recipe": - lookup_recipe(args[1:], parser.print_help, options.debug) - elif args[0] == "find-path": - find_path(args[1:], parser.print_help, options.debug) - elif args[0] == "read-value": - read_value(args[1:], parser.print_help, options.debug) - else: - parser.print_help() - sys.exit(1) + ret = args.func(args) + + return ret if __name__ == "__main__": -- cgit v1.2.3-54-g00ecf