# This file is part of Checkbox.
#
# Copyright 2012-2013 Canonical Ltd.
# Written by:
# Zygmunt Krynicki <zygmunt.krynicki@canonical.com>
#
# Checkbox is free software: you can redistribute it and/or modify
# it under the terms of the GNU General Public License version 3,
# as published by the Free Software Foundation.
#
# Checkbox is distributed in the hope that it will be useful,
# but WITHOUT ANY WARRANTY; without even the implied warranty of
# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
# GNU General Public License for more details.
#
# You should have received a copy of the GNU General Public License
# along with Checkbox. If not, see <http://www.gnu.org/licenses/>.
"""
:mod:`plainbox.impl.commands.special` -- special sub-command
============================================================
.. warning::
THIS MODULE DOES NOT HAVE STABLE PUBLIC API
"""
from logging import getLogger
from plainbox.impl.commands import PlainBoxCommand
from plainbox.impl.commands.checkbox import CheckBoxCommandMixIn
from plainbox.impl.commands.checkbox import CheckBoxInvocationMixIn
logger = getLogger("plainbox.commands.special")
[docs]class SpecialInvocation(CheckBoxInvocationMixIn):
def __init__(self, provider_list, ns):
super(SpecialInvocation, self).__init__(provider_list)
self.ns = ns
[docs] def run(self):
ns = self.ns
job_list = self.get_job_list(ns)
# Now either do a special action or run the jobs
if ns.special == "list-jobs":
self._print_job_list(ns, job_list)
elif ns.special == "list-job-hashes":
self._print_job_hash_list(ns, job_list)
elif ns.special == "list-expr":
self._print_expression_list(ns, job_list)
elif ns.special == "dep-graph":
self._print_dot_graph(ns, job_list)
# Always succeed
return 0
def _get_matching_job_list(self, ns, job_list):
matching_job_list = super(
SpecialInvocation, self)._get_matching_job_list(ns, job_list)
# As a special exception, when ns.special is set and we're either
# listing jobs or job dependencies then when no run pattern was
# specified just operate on the whole set. The ns.special check
# prevents people starting plainbox from accidentally running _all_
# jobs without prompting.
if ns.special is not None and not ns.include_pattern_list:
matching_job_list = job_list
return matching_job_list
def _print_job_list(self, ns, job_list):
matching_job_list = self._get_matching_job_list(ns, job_list)
for job in matching_job_list:
print("{}".format(job))
def _print_job_hash_list(self, ns, job_list):
matching_job_list = self._get_matching_job_list(ns, job_list)
for job in matching_job_list:
print("{} {}".format(job.checksum, job))
def _print_expression_list(self, ns, job_list):
matching_job_list = self._get_matching_job_list(ns, job_list)
expressions = set()
for job in matching_job_list:
prog = job.get_resource_program()
if prog is not None:
for expression in prog.expression_list:
expressions.add(expression.text)
for expression in sorted(expressions):
print(expression)
def _print_dot_graph(self, ns, job_list):
matching_job_list = self._get_matching_job_list(ns, job_list)
print('digraph dependency_graph {')
print('\tnode [shape=box];')
for job in matching_job_list:
if job.plugin == "resource":
print('\t"{}" [shape=ellipse,color=blue];'.format(job.name))
elif job.plugin == "attachment":
print('\t"{}" [color=green];'.format(job.name))
elif job.plugin == "local":
print('\t"{}" [shape=invtriangle,color=red];'.format(
job.name))
elif job.plugin == "shell":
print('\t"{}" [];'.format(job.name))
elif job.plugin in ("manual", "user-verify", "user-interact"):
print('\t"{}" [color=orange];'.format(job.name))
for dep_name in job.get_direct_dependencies():
print('\t"{}" -> "{}";'.format(job.name, dep_name))
prog = job.get_resource_program()
if ns.dot_resources and prog is not None:
for expression in prog.expression_list:
print('\t"{}" [shape=ellipse,color=blue];'.format(
expression.resource_name))
print('\t"{}" -> "{}" [style=dashed, label="{}"];'.format(
job.name, expression.resource_name,
expression.text.replace('"', "'")))
print("}")
[docs]class SpecialCommand(PlainBoxCommand, CheckBoxCommandMixIn):
"""
Implementation of ``$ plainbox special``
"""
def __init__(self, provider_list):
self.provider_list = provider_list
[docs] def invoked(self, ns):
return SpecialInvocation(self.provider_list, ns).run()
[docs] def register_parser(self, subparsers):
parser = subparsers.add_parser(
"special", help="special/internal commands")
parser.set_defaults(command=self)
group = parser.add_mutually_exclusive_group(required=True)
group.add_argument(
'-j', '--list-jobs',
help="List jobs instead of running them",
action="store_const", const="list-jobs", dest="special")
group.add_argument(
'-J', '--list-job-hashes',
help="List jobs with hashes instead of running them",
action="store_const", const="list-job-hashes", dest="special")
group.add_argument(
'-e', '--list-expressions',
help="List all unique resource expressions",
action="store_const", const="list-expr", dest="special")
group.add_argument(
'-d', '--dot',
help="Print a graph of jobs instead of running them",
action="store_const", const="dep-graph", dest="special")
parser.add_argument(
'--dot-resources',
help="Render resource relationships (for --dot)",
action='store_true')
# Call enhance_parser from CheckBoxCommandMixIn
self.enhance_parser(parser)