re-enable printing to the console by default in opengrok-indexer

also make --doprint toggle-able

fixes #2935

Author: Vladimir Kotal

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

@@ -61,9 +61,16 @@ def main():
     if not args.no_ctags_check and not FindCtags(logger):
         logger.warning("Unable to determine Universal CTags command")
 
+    if args.doprint is None:
+        logger.debug("Console logging is enabled by default")
+        doprint = True
+    else:
+        doprint = args.doprint[0]
+        logger.debug("Console logging: {}".format(doprint))
+
     indexer = Indexer(args.options, logger=logger, java=args.java,
                       jar=args.jar, java_opts=args.java_opts,
-                      env_vars=args.environment, doprint=args.doprint)
+                      env_vars=args.environment, doprint=doprint)
     indexer.execute()
     ret = indexer.getretcode()
     if ret is None or ret != SUCCESS_EXITVAL:

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

@@ -52,6 +52,13 @@ class Command:
     def __init__(self, cmd, args_subst=None, args_append=None, logger=None,
                  excl_subst=False, work_dir=None, env_vars=None, timeout=None,
                  redirect_stderr=True, resource_limits=None, doprint=False):
+
+        if doprint is None:
+            doprint = False
+
+        if isinstance(doprint, list):
+            doprint = doprint[0]
+
         self.cmd = cmd
         self.state = "notrun"
         self.excl_subst = excl_subst

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

@@ -4,6 +4,21 @@
 from ..version import __version__ as tools_version
 
 
+def str2bool(v):
+    if isinstance(v, bool):
+        return v
+
+    if isinstance(v, str):
+        v_lower = v.lower()
+        if v_lower in ('yes', 'true', 'y', '1'):
+            return True
+        elif v_lower in ('no', 'false', 'n', '0'):
+            return False
+
+    raise argparse.ArgumentTypeError('Boolean value or its string '
+                                     'representation expected.')
+
+
 def get_baseparser(tool_version=None):
     """
     Get the base parser which supports --version option reporting
@@ -31,9 +46,10 @@ def get_javaparser():
                         help='java options', action='append')
     parser.add_argument('-e', '--environment', action='append',
                         help='Environment variables in the form of name=value')
-    parser.add_argument('--doprint', action='store_true', default=False,
-                        help='Print messages from the application as they '
-                        'are produced.')
+    parser.add_argument('--doprint', type=str2bool, nargs=1, default=None,
+                        metavar='boolean',
+                        help='Enable/disable printing of messages '
+                             'from the application as they are produced.')
 
     group = parser.add_mutually_exclusive_group(required=True)
     group.add_argument('-a', '--jar',

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

@@ -0,0 +1,53 @@
+#!/usr/bin/env python3
+
+#
+# CDDL HEADER START
+#
+# The contents of this file are subject to the terms of the
+# Common Development and Distribution License (the "License").
+# You may not use this file except in compliance with the License.
+#
+# See LICENSE.txt included in this distribution for the specific
+# language governing permissions and limitations under the License.
+#
+# When distributing Covered Code, include this CDDL HEADER in each
+# file and include the License file at LICENSE.txt.
+# If applicable, add the following below this CDDL HEADER, with the
+# fields enclosed by brackets "[]" replaced with your own identifying
+# information: Portions Copyright [yyyy] [name of copyright owner]
+#
+# CDDL HEADER END
+#
+
+#
+# Copyright (c) 2019, Oracle and/or its affiliates. All rights reserved.
+#
+
+import argparse
+import pytest
+from opengrok_tools.utils.parsers import str2bool
+
+
+def test_str2bool_exception():
+    with pytest.raises(argparse.ArgumentTypeError):
+        str2bool('foo')
+
+
+def test_str2bool_exception_empty_str():
+    with pytest.raises(argparse.ArgumentTypeError):
+        str2bool('')
+
+
+def test_str2bool_bool():
+    assert str2bool(True)
+    assert not str2bool(False)
+
+
+def test_str2bool():
+    for val in ['true', 'y', 'yes']:
+        assert str2bool(val)
+        assert str2bool(val.upper())
+
+    for val in ['false', 'n', 'no']:
+        assert not str2bool(val)
+        assert not str2bool(val.upper())