Add top-like monitoring tool

Inspiration and code from qui-domains and visuals from xentop.

- Colors entries according to state
- Footer with clock to show last time the screen was refreshed
- Allows scrolling domain list when it is longer than the screen height,
  with a less-type hint indicating how many lines to scroll
- To scroll, readline style (Emacs) navigation is supported, with some
  Vi keys also supported
- Inexpensive calls using "admin.vm.Stats"

Author: ben-grande

doc/conf.py

@@ -366,6 +366,8 @@
         u'Manage tags on a qube', _man_pages_author, 1),
     ('manpages/qvm-template', 'qvm-template',
         u'Manage templates', _man_pages_author, 1),
+    ('manpages/qvm-top', 'qvm-top',
+        u'Top-like monitoring tool', _man_pages_author, 1),
     ('manpages/qvm-unpause', 'qvm-unpause',
         u'Pause a qube', _man_pages_author, 1),
     ('manpages/qvm-volume', 'qvm-volume',

doc/manpages/qvm-top.rst

@@ -0,0 +1,52 @@
+.. program:: qvm-top
+
+:program:`qvm-top` -- top-like monitoring tool
+==============================================
+
+Synopsis
+--------
+
+:command:`qvm-top` [--verbose] [--quiet] [--help] [--version] [--all] [--exclude EXCLUDE] [*VMNAME* ...]
+
+Options
+-------
+
+.. option:: --help, -h
+
+   Show the help message and exit.
+
+.. option:: --verbose, -v
+
+   Increase verbosity.
+
+.. option:: --quiet, -q
+
+   Decrease verbosity.
+
+.. option:: --all
+
+   Show all qubes. It's the default. Pass qubes as positional parameters to
+   show only those.
+
+.. option:: --exclude=EXCLUDE
+
+   Exclude the qube from :option:`--all`.
+
+.. option:: --version
+
+   Show program's version number and exit
+
+
+Notes
+-----
+
+Quit by pressing `q`, `Q`, or `ESC`. When scrolling up or down, there is
+readline-style (Emacs) navigation, with a pinch of Vi navigation.
+
+Authors
+-------
+
+| Benjamin Grande <ben.grande.b at gmail dot com>
+| For complete author list see: https://github.com/QubesOS/qubes-core-admin-client.git
+
+.. vim: ts=3 sw=3 et tw=80

doc/qubesadmin.tools.rst

@@ -196,6 +196,14 @@ qubesadmin\.tools\.qvm\_template\_postprocess module
     :undoc-members:
     :show-inheritance:
 
+qubesadmin\.tools\.qvm\_top module
+----------------------------------------------------
+
+.. automodule:: qubesadmin.tools.qvm_top
+    :members:
+    :undoc-members:
+    :show-inheritance:
+
 qubesadmin\.tools\.qvm\_unpause module
 --------------------------------------
 

qubesadmin/tools/__init__.py

@@ -157,12 +157,18 @@ def parse_qubes_app(self, parser, namespace):
         assert hasattr(namespace, 'app')
         setattr(namespace, 'domains', [])
         app = namespace.app
-        if hasattr(namespace, 'all_domains') and namespace.all_domains:
+        if (
+            hasattr(namespace, 'all_domains')
+            and namespace.all_domains
+            and not getattr(namespace, 'VMNAME')
+        ):
             namespace.domains = [
                 vm
                 for vm in app.domains
-                if not vm.klass == 'AdminVM' and
-                   vm.name not in namespace.exclude
+                if (
+                    namespace.all_domains == "global"
+                    or not vm.klass == 'AdminVM'
+                ) and vm.name not in namespace.exclude
             ]
         else:
             if hasattr(namespace, 'exclude') and namespace.exclude:
@@ -361,7 +367,7 @@ class QubesArgumentParser(argparse.ArgumentParser):
     '''
 
     def __init__(self, vmname_nargs=None, show_forceroot=False, version=None, \
-            **kwargs):
+            all_default=False, all_include_adminvm=False, **kwargs):
 
         super().__init__(add_help=False, **kwargs)
 
@@ -398,7 +404,8 @@ def __init__(self, vmname_nargs=None, show_forceroot=False, version=None, \
             self.add_argument('--version', action='version')
 
         if self._vmname_nargs in [argparse.ZERO_OR_MORE, argparse.ONE_OR_MORE]:
-            vm_name_group = VmNameGroup(self,
+            vm_name_group = VmNameGroup(self, all_default=all_default,
+                all_include_adminvm=all_include_adminvm,
                 required=(self._vmname_nargs
                           not in [argparse.ZERO_OR_MORE, argparse.OPTIONAL]))
             self._mutually_exclusive_groups.append(vm_name_group)
@@ -574,13 +581,16 @@ class VmNameGroup(argparse._MutuallyExclusiveGroup):
         :py:class:``argparse.ArgumentParser```.
     '''
 
-    def __init__(self, container, required, vm_action=VmNameAction, help=None):
+    def __init__(self, container, required, vm_action=VmNameAction,\
+            all_default=False, all_include_adminvm=False, help=None):
         # pylint: disable=redefined-builtin
         super().__init__(container, required=required)
         if not help:
             help = 'perform the action on all qubes'
+        if all_default and all_include_adminvm:
+            all_default = "global"
         self.add_argument('--all', action='store_true', dest='all_domains',
-                          help=help)
+                          default=all_default, help=help)
         container.add_argument('--exclude', action='append', default=[],
                                help='exclude the qube from --all')