adding python tool specific version (#2720)

 - --version now reports the tool specific version along with the tools global version

Author: tulinkry

opengrok-tools/src/main/python/opengrok_tools/mirror.py

@@ -49,6 +49,9 @@
 from .utils.repofactory import get_repository
 from .utils.utils import is_exe, check_create_dir, get_int, diff_list, \
     is_web_uri
+
+# do not reorder this import, it must be imported after utils.
+# (for me) idea reorders the import to the top, causing an import error
 from .scm.repository import RepositoryException
 
 major_version = sys.version_info[0]
@@ -122,7 +125,9 @@ def main():
     ret = 0
 
     parser = argparse.ArgumentParser(description='project mirroring',
-                                     parents=[get_baseparser()])
+                                     parents=[get_baseparser(
+                                         tool_version=__version__)
+                                     ])
 
     parser.add_argument('project')
     parser.add_argument('-c', '--config',

opengrok-tools/src/main/python/opengrok_tools/projadm.py

@@ -207,7 +207,9 @@ def main():
     parser = argparse.ArgumentParser(description='project management.',
                                      formatter_class=argparse.
                                      ArgumentDefaultsHelpFormatter,
-                                     parents=[get_baseparser()])
+                                     parents=[get_baseparser(
+                                         tool_version=__version__)
+                                     ])
 
     parser.add_argument('-b', '--base', default="/var/opengrok",
                         help='OpenGrok instance base directory')

opengrok-tools/src/main/python/opengrok_tools/sync.py

@@ -67,7 +67,10 @@ def main():
     dirs_to_process = []
 
     parser = argparse.ArgumentParser(description='Manage parallel workers.',
-                                     parents=[get_baseparser()])
+                                     parents=[
+                                         get_baseparser(
+                                             tool_version=__version__)
+                                     ])
     parser.add_argument('-w', '--workers', default=multiprocessing.cpu_count(),
                         help='Number of worker processes')
 

opengrok-tools/src/main/python/opengrok_tools/utils/parsers.py

@@ -1,12 +1,22 @@
 import argparse
 
 from .log import add_log_level_argument
-from ..version import __version__ as version
+from ..version import __version__ as tools_version
 
 
-def get_baseparser():
+def get_baseparser(tool_version=None):
+    """
+    Get the base parser which supports --version option reporting
+    the overall version of the tools and the specific version of the
+    invoked tool.
+    :param tool_version: the specific version tool if applicable
+    :return: the parser
+    """
     parser = argparse.ArgumentParser(add_help=False)
     add_log_level_argument(parser)
+    version = tools_version
+    if tool_version:
+        version += ' (v{})'.format(tool_version)
     parser.add_argument('-v', '--version', action='version', version=version,
                         help='Version of the tool')
     return parser

opengrok-tools/src/test/python/test_versions.py

@@ -53,4 +53,4 @@ def test_opengrok_version(command):
     cmd.execute()
     assert cmd.getretcode() == 0
     assert cmd.getstate() == Command.FINISHED
-    assert cmd.getoutputstr() == version
+    assert version in cmd.getoutputstr()