[OE-core] [PATCH 1/2] oeqa/utils/metadata.py: Add metadata library

[Mariano Lopez]

On Tuesday, November 29, 2016 04:17:25 PM Benjamin Esquivel wrote:
> On Tue, 2016-11-29 at 08:42 -0600, mariano.lopez at linux.intel.com wrote:
> > From: Mariano Lopez <mariano.lopez at linux.intel.com>
> > 
> > Adds functions to get metadata from the host running the tests.
> > 
> > [YOCTO #9954]
> > 
> > Signed-off-by: Mariano Lopez <mariano.lopez at linux.intel.com>
> > ---
> >  meta/lib/oeqa/utils/metadata.py | 77
> > +++++++++++++++++++++++++++++++++++++++++
> >  1 file changed, 77 insertions(+)
> >  create mode 100644 meta/lib/oeqa/utils/metadata.py
> > 
> > diff --git a/meta/lib/oeqa/utils/metadata.py
> > b/meta/lib/oeqa/utils/metadata.py
> > new file mode 100644
> > index 0000000..3be805c
> > --- /dev/null
> > +++ b/meta/lib/oeqa/utils/metadata.py
> > @@ -0,0 +1,77 @@
> > +# Copyright (C) 2016 Intel Corporation
> > +#
> > +# Released under the MIT license (see COPYING.MIT)
> > +#
> > +# Functions to get metadata from the testing host used
> > +# for analytics of test results.
> > +
> > +from git import Repo
> > +from collections import OrderedDict
> > +from collections.abc import MutableMapping
> > +from xml.dom.minidom import parseString
> > +from xml.etree.ElementTree import Element, tostring
> > +
> > +from oe.lsb import distro_identifier
> > +from oeqa.utils.commands import runCmd, get_bb_var
> > +
> > +def metadata_from_bb():
> > +    """ Returns test's metadata as OrderedDict.
> > +
> > +        Data will be gathered using bitbake -e thanks to get_bb_var.
> > +    """
> > +
> > +    info_dict = OrderedDict()
> > +    hostname = runCmd('hostname')
> > +    info_dict['hostname'] = hostname.output
> > +    info_dict['machine'] = get_bb_var('MACHINE')
> > +    info_dict['distro'] = get_bb_var('DISTRO')
> > +    info_dict['distro_version'] = get_bb_var('DISTRO_VERSION')
> > +    host_distro= distro_identifier()
> > +    host_distro, _, host_distro_release = host_distro.partition('-')
> > +    info_dict['host_distro'] = host_distro
> > +    info_dict['host_distro_release'] = host_distro_release
> > +    info_dict['layers'] = get_layers(get_bb_var('BBLAYERS'))
> is none of the upper statements going to throw exceptions? otherwise
> try/except as appropriate.

I really don't expect this code to throw an exception, these are bitbake
commands running in the host.

> > +    return info_dict
> > +
> > +def metadata_from_data_store(d):
> > +    """ Returns test's metadata as OrderedDict.
> > +
> > +        Data will be collected from the provided data store.
> > +    """
> > +    # TODO: Getting metadata from the data store would
> > +    # be useful when running within bitbake.
> > +    pass
> > +
> > +def get_layers(layers):
> > +    """ Returns layer name, branch, and revision as OrderedDict. """
> > +
> > +    layer_dict = OrderedDict()
> > +    for layer in layers.split():
> > +        layer_name = os.path.basename(layer)
> > +        layer_dict[layer_name] = OrderedDict()
> > +        repo = Repo(layer, search_parent_directories=True)
> > +        revision, branch = repo.head.object.name_rev.split()
> > +        layer_dict[layer_name]['branch'] = branch
> > +        layer_dict[layer_name]['revision'] = revision
> same here for the try/except, did you test with usual cases of zero
> input and unexisting path's, etc?

If the function doesn't receive input, it won't enter in the loop, in case the
directory doesn't exists bitbake would complain long before reaching this
code. If the user gets creative enough to not pass a valid BBLAYER value
I think s/he deserve to be bitten by the exception.

> > +    return layer_dict
> > +
> > +def write_metadata_file(file_path, metadata):
> > +    """ Writes metadata to a XML file in directory. """
> > +
> > +    xml = dict_to_XML('metadata', metadata)
> > +    xml_doc = parseString(tostring(xml).decode('UTF-8'))
> > +    with open(file_path, 'w') as f:
> > +        f.write(xml_doc.toprettyxml())
> > +
> > +def dict_to_XML(tag, dictionary):
> > +    """ Return XML element converting dicts recursively. """
> > +
> > +    elem = Element(tag)
> > +    for key, val in dictionary.items():
> > +        if isinstance(val, MutableMapping):
> > +            child = (dict_to_XML(key, val))
> > +        else:
> > +            child = Element(key)
> > +            child.text = str(val)
> > +        elem.append(child)
> > +    return elem
> > -- 
> > 2.7.3
> >