Source code for insights.tools.insights_inspect

#!/usr/bin/env python
"""
The inspect module allows you to execute an insights component
(parser, combiner, rule or datasource) dropping you into an
ipython session where you can inspect the outcome.


>>> insights-inspect insights.parsers.hostname.Hostname
IPython Console Usage Info:
Enter 'Hostname.' and tab to get a list of properties
Example:
In [1]: Hostname.<property_name>
Out[1]: <property value>
To exit ipython enter 'exit' and hit enter or use 'CTL D'
Python 3.6.6 (default, Jul 19 2018, 14:25:17)
Type "copyright", "credits" or "license" for more information.
IPython 5.8.0 -- An enhanced Interactive Python.
?         -> Introduction and overview of IPython's features.
%quickref -> Quick reference.
help      -> Python's own help system.
object?   -> Details about 'object', use 'object??' for extra details.
In [1]: Hostname.fqdn
Out[1]: 'lhuett.usersys.redhat.com'"


>>> insights-inspect insights.combiners.hostname.hostname
IPython Console Usage Info:
Enter 'hostname.' and tab to get a list of properties
Example:
In [1]: hostname.<property_name>
Out[1]: <property value>
To exit ipython enter 'exit' and hit enter or use 'CTL D'
Python 3.6.6 (default, Jul 19 2018, 14:25:17)
Type "copyright", "credits" or "license" for more information.
IPython 5.8.0 -- An enhanced Interactive Python.
?         -> Introduction and overview of IPython's features.
%quickref -> Quick reference.
help      -> Python's own help system.
object?   -> Details about 'object', use 'object??' for extra details.
In [1]: hostname.fqdn
Out[1]: 'lhuett.usersys.redhat.com'


>>> insights-inspect insights.specs.Specs.hostname
IPython Console Usage Info:
Enter 'hostname.' and tab to get a list of properties
Example:
In [1]: hostname.<property_name>
Out[1]: <property value>
To exit ipython enter 'exit' and hit enter or use 'CTL D'
Python 3.6.6 (default, Jul 19 2018, 14:25:17)
Type "copyright", "credits" or "license" for more information.
IPython 5.8.0 -- An enhanced Interactive Python.
?         -> Introduction and overview of IPython's features.
%quickref -> Quick reference.
help      -> Python's own help system.
object?   -> Details about 'object', use 'object??' for extra details.
In [1]: hostname.cmd
Out[1]: '/usr/bin/hostname -f'


>>> insights-inspect examples.rules.bash_version.report
IPython Console Usage Info:
Enter 'report.' and tab to get a list of properties
Example:
In [1]: report.<property_name>
Out[1]: <property value>
To exit ipython enter 'exit' and hit enter or use 'CTL D'
Python 3.6.6 (default, Jul 19 2018, 14:25:17)
Type "copyright", "credits" or "license" for more information.
IPython 5.8.0 -- An enhanced Interactive Python.
?         -> Introduction and overview of IPython's features.
%quickref -> Quick reference.
help      -> Python's own help system.
object?   -> Details about 'object', use 'object??' for extra details.
In [1]: report.values()
Out[1]: dict_values([0:bash-4.2.46-31.el7, 'pass', 'BASH_VERSION'])
In [2]: broker.keys()
Out[2]: dict_keys([<class 'insights.core.context.HostArchiveContext'>,
<insights.core.spec_factory.glob_file object at 0x7f0303c93390>,
<insights.core.spec_factory.head object at 0x7f0303cabef0>,
insights.specs.Specs.installed_rpms,
<class 'insights.parsers.installed_rpms.InstalledRpms'>,
<function report at 0x7f0303c679d8>])
In [3]: import insights
In [4]: p = broker[insights.parsers.installed_rpms.InstalledRpms]
In [5]: a = p.get_max('bash')
In [6]: a.nevra
Out[5]: 'bash-0:4.2.46-31.el7.x86_64'
"""

from __future__ import print_function
import argparse
import logging
import os
import sys
import yaml

from contextlib import contextmanager

from insights import (apply_configs, dr, extract, HostContext,
                      load_default_plugins)
from insights.core import filters
from insights.core.hydration import initialize_broker
from IPython import embed
from IPython.terminal.embed import InteractiveShellEmbed


try:
    import colorama as C
    C.init()
except:
    class Pass(object):
        def __getattr__(self, name):
            return ""

    class C(object):
        Fore = Pass()
        Style = Pass()


[docs]def get_ipshell(): banner = 'Starting IPython Interpreter Now \n' exit_msg = '\nExiting IPython Interpreter Now' try: return InteractiveShellEmbed(banner1=banner, exit_msg=exit_msg) except: print("*** Error initializing colorized shell, failing over to non-colorized shell ***\n\n") return embed
[docs]def parse_args(): p = argparse.ArgumentParser("Insights component runner.") p.add_argument("-c", "--config", help="Configure components.") p.add_argument("-D", "--debug", action="store_true", help="Show debug level information.") p.add_argument("--nofilters", action="store_true", help="Turn datasource filters off") p.add_argument("component", nargs=1, help="Component to inspect.") p.add_argument("archive", nargs="?", help="Archive or directory to analyze.") return p.parse_args()
[docs]def configure_logging(debug): if debug: logging.basicConfig(level=logging.DEBUG, stream=sys.stderr)
[docs]def configure(config): if config: with open(config) as f: apply_configs(yaml.safe_load(f))
[docs]def get_component(fqdn): return dr.get_component(fqdn)
[docs]@contextmanager def create_broker(root=None): if not root: broker = dr.Broker() broker[HostContext] = HostContext() yield broker else: def from_dir(d): # ctx is returned here, but its already in the broker so not needed _, broker = initialize_broker(d) return broker if os.path.isdir(root): yield from_dir(root) else: with extract(root) as ex: yield from_dir(ex.tmp_dir)
[docs]def dump_error(component, broker): if component in broker.exceptions: for ex in broker.exceptions[component]: print(broker.tracebacks[ex], file=sys.stderr) if component in broker.missing_requirements: missing = broker.missing_requirements[component] required = missing[0] at_least_one = missing[1] buf = sys.stderr print("Missing Dependencies:", file=buf) if required: print(" Requires:", file=buf) for d in required: print(" %s" % dr.get_name(d), file=buf) if at_least_one: for alo in at_least_one: print(" At Least One Of:", file=buf) for d in alo: print(" %s" % dr.get_name(d), file=buf)
[docs]def run(component, archive=None): with create_broker(archive) as broker: value = dr.run(component, broker=broker).get(component) name = dr.get_name(component).rsplit(".", 1)[1] vars()[name] = value if value: print(C.Fore.BLUE + "\nIPython Console Usage Info:\n" + C.Style.RESET_ALL, file=sys.stderr) print("Enter '{}.' and tab to get a list of properties ".format(name)) print("Example:") print("In [1]: {}.<property_name>".format(name)) print("Out[1]: <property value>\n") print("To exit ipython enter 'exit' and hit enter or use 'CTL D'\n") ipshell = get_ipshell() ipshell() else: dump_error(component, broker) return sys.exit(1)
[docs]def main(): args = parse_args() configure_logging(args.debug) configure(args.config) load_default_plugins() component = get_component(args.component[0]) if not component: print("Component not found: %s" % args.component[0], file=sys.stderr) sys.exit(1) if args.nofilters: filters.ENABLED = False run(component, archive=args.archive)
if __name__ == "__main__": main()