Opengrok tools version --version (#2499)

tulinkry · Vladimir Kotal · commit 6da51376a4d1 · 2018-11-12T11:50:19.000+01:00
* moving version to a python file
diff --git a/opengrok-tools/pom.xml b/opengrok-tools/pom.xml
@@ -96,7 +96,7 @@ Portions Copyright (c) 2017-2018, Chris Fraire <cfraire@me.com>.
                 <version>3.1.0</version>
                 <executions>
                     <execution>
-                        <id>copy-resources-python</id>
+                        <id>copy package source files</id>
                         <phase>compile</phase>
                         <goals>
                             <goal>copy-resources</goal>
@@ -111,29 +111,41 @@ Portions Copyright (c) 2017-2018, Chris Fraire <cfraire@me.com>.
                         </configuration>
                     </execution>
                     <execution>
-                        <id>copy package resources</id>
+                        <id>copy version file and replace the opengrok version in it</id>
                         <phase>compile</phase>
                         <goals>
                             <goal>copy-resources</goal>
                         </goals>
                         <configuration>
-                            <outputDirectory>${project.build.directory}</outputDirectory>
+                            <!-- replace ${project.python.package.version} in version.py -->
+                            <outputDirectory>${project.build.directory}/src/main/python/opengrok_tools</outputDirectory>
                             <resources>
                                 <resource>
-                                    <directory>${basedir}</directory>
+                                    <directory>${basedir}/src/main/python/opengrok_tools</directory>
                                     <includes>
-                                        <include>MANIFEST.in</include>
-                                        <include>README.md</include>
-                                        <include>logging.properties.template</include>
+                                        <include>version.py</include>
                                     </includes>
+                                    <filtering>true</filtering>
                                 </resource>
-                                <!-- replace ${project.python.package.version} in setup.py -->
+                            </resources>
+                        </configuration>
+                    </execution>
+                    <execution>
+                        <id>copy top level package resources</id>
+                        <phase>compile</phase>
+                        <goals>
+                            <goal>copy-resources</goal>
+                        </goals>
+                        <configuration>
+                            <outputDirectory>${project.build.directory}</outputDirectory>
+                            <resources>
                                 <resource>
                                     <directory>${basedir}</directory>
                                     <includes>
+                                        <include>MANIFEST.in</include>
+                                        <include>README.md</include>
                                         <include>setup.py</include>
                                     </includes>
-                                    <filtering>true</filtering>
                                 </resource>
                             </resources>
                         </configuration>
diff --git a/opengrok-tools/setup.py b/opengrok-tools/setup.py
@@ -3,6 +3,8 @@
 
 from setuptools import setup
 
+from src.main.python.opengrok_tools.version import __version__ as version
+
 SCRIPT_DIR = os.path.dirname(os.path.realpath(__file__))
 
 
@@ -18,23 +20,9 @@ def my_test_suite():
     return test_suite
 
 
-def get_version(version):
-    """
-    Detect the mvn build versus the local python setup.py install run.
-    :param version: the new version string to be applied
-    :return: the mvn version, or local version number
-    """
-    if 'project.python.package.version' in version:
-        return '0.0.1'
-    return version
-
-
 setup(
     name='opengrok-tools',
-    # The package version is taken from maven.
-    # this "variable" is replaced by maven on the fly so don't change it here
-    # see pom.xml for this module
-    version=get_version('${project.python.package.version}'),
+    version=version,
     packages=[
         'opengrok_tools',
         'opengrok_tools.utils',
diff --git a/opengrok-tools/src/main/python/opengrok_tools/config_merge.py b/opengrok-tools/src/main/python/opengrok_tools/config_merge.py
@@ -25,9 +25,9 @@
 import logging
 import sys
 
-from .utils.java import Java, get_javaparser
+from .utils.java import Java
 from .utils.log import print_exc_exit
-
+from .utils.parsers import get_javaparser
 
 """
  Wrapper for Java program merging OpenGrok configuration.
diff --git a/opengrok-tools/src/main/python/opengrok_tools/deploy.py b/opengrok-tools/src/main/python/opengrok_tools/deploy.py
@@ -25,11 +25,12 @@
 import argparse
 import os
 import tempfile
-from zipfile import ZipFile
 from shutil import copyfile
-from .utils.log import get_console_logger, get_class_basename, \
-    add_log_level_argument, print_exc_exit
+from zipfile import ZipFile
 
+from .utils.log import get_console_logger, get_class_basename, \
+    print_exc_exit
+from .utils.parsers import get_baseparser
 
 """
  deploy war file
@@ -97,9 +98,9 @@ def deploy_war(logger, sourceWar, targetWar, configFile=None):
 
 
 def main():
-    parser = argparse.ArgumentParser(description='Deploy WAR file')
+    parser = argparse.ArgumentParser(description='Deploy WAR file',
+                                     parents=[get_baseparser()])
 
-    add_log_level_argument(parser)
     parser.add_argument('-c', '--config',
                         help='Path to OpenGrok configuration file')
     parser.add_argument('source_war', nargs=1,
diff --git a/opengrok-tools/src/main/python/opengrok_tools/groups.py b/opengrok-tools/src/main/python/opengrok_tools/groups.py
@@ -24,9 +24,9 @@
 import argparse
 import sys
 
-from .utils.java import Java, get_javaparser
+from .utils.java import Java
 from .utils.log import get_console_logger, get_class_basename, print_exc_exit
-
+from .utils.parsers import get_javaparser
 
 """
  Script for manipulating project groups
diff --git a/opengrok-tools/src/main/python/opengrok_tools/indexer.py b/opengrok-tools/src/main/python/opengrok_tools/indexer.py
@@ -27,8 +27,8 @@
 import sys
 
 from .utils.indexer import FindCtags, Indexer
-from .utils.java import get_javaparser
 from .utils.log import get_console_logger, get_class_basename, print_exc_exit
+from .utils.parsers import get_javaparser
 
 """
   opengrok.jar wrapper
diff --git a/opengrok-tools/src/main/python/opengrok_tools/java.py b/opengrok-tools/src/main/python/opengrok_tools/java.py
@@ -25,8 +25,9 @@
 import argparse
 import sys
 
-from .utils.java import Java, get_javaparser
+from .utils.java import Java
 from .utils.log import get_console_logger, get_class_basename, print_exc_exit
+from .utils.parsers import get_javaparser
 
 
 def main():
diff --git a/opengrok-tools/src/main/python/opengrok_tools/mirror.py b/opengrok-tools/src/main/python/opengrok_tools/mirror.py
@@ -36,19 +36,20 @@
 import sys
 import tempfile
 from logging.handlers import RotatingFileHandler
+
 from filelock import Timeout, FileLock
 
 from .utils.hook import run_hook
 from .utils.log import get_console_logger, get_class_basename, \
-    add_log_level_argument, print_exc_exit
+    print_exc_exit
 from .utils.opengrok import get_repos, get_config_value, get_repo_type
+from .utils.parsers import get_baseparser
 from .utils.readconfig import read_config
 from .utils.repofactory import get_repository
-from .utils.utils import is_exe, check_create_dir, get_int, diff_list,\
+from .utils.utils import is_exe, check_create_dir, get_int, diff_list, \
     is_web_uri
 from .scm.repository import RepositoryException
 
-
 major_version = sys.version_info[0]
 if major_version < 3:
     print("Need Python 3, you are running {}".format(major_version))
@@ -118,10 +119,10 @@ def get_repos_for_project(logger, project, ignored_repos, **kwargs):
 def main():
     ret = 0
 
-    parser = argparse.ArgumentParser(description='project mirroring')
+    parser = argparse.ArgumentParser(description='project mirroring',
+                                     parents=[get_baseparser()])
 
     parser.add_argument('project')
-    add_log_level_argument(parser)
     parser.add_argument('-c', '--config',
                         help='config file in JSON/YAML format')
     parser.add_argument('-U', '--uri', default='http://localhost:8080/source',
diff --git a/opengrok-tools/src/main/python/opengrok_tools/projadm.py b/opengrok-tools/src/main/python/opengrok_tools/projadm.py
@@ -33,13 +33,15 @@
 import sys
 import tempfile
 from os import path
+
 from filelock import Timeout, FileLock
 
 from .utils.command import Command
 from .utils.log import get_console_logger, get_class_basename, \
-    add_log_level_argument, print_exc_exit
+    print_exc_exit
 from .utils.opengrok import get_configuration, set_configuration, \
     add_project, delete_project, get_config_value
+from .utils.parsers import get_baseparser
 from .utils.utils import get_command, is_web_uri
 
 MAJOR_VERSION = sys.version_info[0]
@@ -204,9 +206,9 @@ def project_delete(logger, project, uri, doit=True, deletesource=False):
 def main():
     parser = argparse.ArgumentParser(description='project management.',
                                      formatter_class=argparse.
-                                     ArgumentDefaultsHelpFormatter)
+                                     ArgumentDefaultsHelpFormatter,
+                                     parents=[get_baseparser()])
 
-    add_log_level_argument(parser)
     parser.add_argument('-b', '--base', default="/var/opengrok",
                         help='OpenGrok instance base directory')
     parser.add_argument('-R', '--roconfig',
diff --git a/opengrok-tools/src/main/python/opengrok_tools/reindex_project.py b/opengrok-tools/src/main/python/opengrok_tools/reindex_project.py
@@ -28,9 +28,9 @@
 import tempfile
 
 from .utils.indexer import Indexer
-from .utils.java import get_javaparser
 from .utils.log import get_console_logger, get_class_basename, print_exc_exit
 from .utils.opengrok import get_configuration
+from .utils.parsers import get_javaparser
 
 """
  OpenGrok reindexing script for single project. Makes sure it uses
diff --git a/opengrok-tools/src/main/python/opengrok_tools/sync.py b/opengrok-tools/src/main/python/opengrok_tools/sync.py
@@ -37,15 +37,15 @@
 import tempfile
 from multiprocessing import Pool
 from os import path
+
 from filelock import Timeout, FileLock
 
 from .utils.commandsequence import CommandSequence, CommandSequenceBase
+from .utils.log import get_console_logger, get_class_basename, print_exc_exit
 from .utils.opengrok import list_indexed_projects, get_config_value
+from .utils.parsers import get_baseparser
 from .utils.readconfig import read_config
 from .utils.utils import is_web_uri
-from .utils.log import get_console_logger, get_class_basename,\
-    add_log_level_argument, print_exc_exit
-
 
 major_version = sys.version_info[0]
 if (major_version < 3):
@@ -70,7 +70,8 @@ def worker(base):
 def main():
     dirs_to_process = []
 
-    parser = argparse.ArgumentParser(description='Manage parallel workers.')
+    parser = argparse.ArgumentParser(description='Manage parallel workers.',
+                                     parents=[get_baseparser()])
     parser.add_argument('-w', '--workers', default=multiprocessing.cpu_count(),
                         help='Number of worker processes')
 
@@ -83,7 +84,6 @@ def main():
 
     parser.add_argument('-I', '--indexed', action='store_true',
                         help='Sync indexed projects only')
-    add_log_level_argument(parser)
     parser.add_argument('-i', '--ignore_errors', nargs='*',
                         help='ignore errors from these projects')
     parser.add_argument('-c', '--config', required=True,
diff --git a/opengrok-tools/src/main/python/opengrok_tools/utils/__init__.py b/opengrok-tools/src/main/python/opengrok_tools/utils/__init__.py
@@ -1,11 +1,12 @@
-from . import commandsequence
 from . import command
-from . import opengrok
-from . import utils
+from . import commandsequence
 from . import hook
+from . import opengrok
+from . import parsers
+from . import readconfig
 from . import repofactory
+from . import utils
 from . import webutil
-from . import readconfig
 
 __all__ = [
     'opengrok',
@@ -15,5 +16,6 @@
     'hook',
     'repofactory',
     'webutil',
-    'readconfig'
+    'readconfig',
+    'parsers',
 ]
diff --git a/opengrok-tools/src/main/python/opengrok_tools/utils/java.py b/opengrok-tools/src/main/python/opengrok_tools/utils/java.py
@@ -25,9 +25,7 @@
 import platform
 from .command import Command
 from .utils import is_exe
-from .log import add_log_level_argument
 import os
-import argparse
 
 
 class Java(Command):
@@ -108,24 +106,3 @@ def FindJava(self, logger):
                     java = os.path.join(java_home, 'bin', 'java')
 
         return java
-
-
-def get_javaparser():
-    parser = argparse.ArgumentParser(add_help=False)
-    add_log_level_argument(parser)
-    parser.add_argument('-j', '--java',
-                        help='path to java binary')
-    parser.add_argument('-J', '--java_opts',
-                        help='java options', action='append')
-    parser.add_argument('-e', '--environment', action='append',
-                        help='Environment variables in the form of name=value')
-
-    group = parser.add_mutually_exclusive_group(required=True)
-    group.add_argument('-a', '--jar',
-                       help='Path to jar archive to run')
-    group.add_argument('-c', '--classpath',
-                       help='Class path')
-
-    parser.add_argument('options', nargs='+', help='options')
-
-    return parser
diff --git a/opengrok-tools/src/main/python/opengrok_tools/utils/parsers.py b/opengrok-tools/src/main/python/opengrok_tools/utils/parsers.py
@@ -0,0 +1,33 @@
+import argparse
+
+from .log import add_log_level_argument
+from ..version import __version__ as version
+
+
+def get_baseparser():
+    parser = argparse.ArgumentParser(add_help=False)
+    add_log_level_argument(parser)
+    parser.add_argument('-v', '--version', action='version', version=version,
+                        help='Version of the tool')
+    return parser
+
+
+def get_javaparser():
+    parser = argparse.ArgumentParser(add_help=False,
+                                     parents=[get_baseparser()])
+    parser.add_argument('-j', '--java',
+                        help='path to java binary')
+    parser.add_argument('-J', '--java_opts',
+                        help='java options', action='append')
+    parser.add_argument('-e', '--environment', action='append',
+                        help='Environment variables in the form of name=value')
+
+    group = parser.add_mutually_exclusive_group(required=True)
+    group.add_argument('-a', '--jar',
+                       help='Path to jar archive to run')
+    group.add_argument('-c', '--classpath',
+                       help='Class path')
+
+    parser.add_argument('options', nargs='+', help='options')
+
+    return parser
diff --git a/opengrok-tools/src/main/python/opengrok_tools/utils/repofactory.py b/opengrok-tools/src/main/python/opengrok_tools/utils/repofactory.py
@@ -21,11 +21,11 @@
 # Copyright (c) 2018, Oracle and/or its affiliates. All rights reserved.
 #
 
-from ..scm.mercurial import MercurialRepository
-from ..scm.teamware import TeamwareRepository
 from ..scm.cvs import CVSRepository
-from ..scm.svn import SubversionRepository
 from ..scm.git import GitRepository
+from ..scm.mercurial import MercurialRepository
+from ..scm.svn import SubversionRepository
+from ..scm.teamware import TeamwareRepository
 
 
 def get_repository(logger, path, repo_type, project, commands, env, hooks,
diff --git a/opengrok-tools/src/main/python/opengrok_tools/version.py b/opengrok-tools/src/main/python/opengrok_tools/version.py
diff --git a/opengrok-tools/src/test/python/test_versions.py b/opengrok-tools/src/test/python/test_versions.py
