Merge branch 'main' of https://github.com/paulissoft/pato-gui

MANIFEST.in

@@ -1,4 +1,4 @@
-include requirements.txt
+include development_requirements.txt
 include test_requirements.txt
 include Makefile
 include CHANGELOG.md

Makefile

@@ -11,7 +11,8 @@ PYTHON_EXECUTABLES = python python3
 MYPY = mypy
 # The -O flag is used to suppress error messages related to eggs.
 # See also https://stackoverflow.com/questions/43177200/assertionerror-egg-link-does-not-match-installed-location-of-reviewboard-at.
-PIP = $(PYTHON) -O -m pip
+VERBOSE := 
+PIP = $(PYTHON) -O -m pip $(VERBOSE)
 # Otherwise perl may complain on a Mac
 LANG = C
 # This is GNU specific I guess
@@ -62,14 +63,14 @@ help: ## This help.
 #	@echo home: $(home)
 
 init: ## Fulfill the requirements
-	$(PIP) install -r requirements.txt -r src/requirements.txt
+	$(PIP) install -r development_requirements.txt -r src/program/requirements.txt
 
 clean: init ## Cleanup the package and remove it from the Python installation path.
 	$(PYTHON) setup.py clean --all
 	$(PYTHON) -Bc "import pathlib; [p.unlink() for p in pathlib.Path('.').rglob('*.py[co]')]"
 	$(PYTHON) -Bc "import pathlib; [p.rmdir() for p in pathlib.Path('.').rglob('__pycache__')]"
 	$(PYTHON) -Bc "import shutil; import os; [shutil.rmtree(d) for d in ['.pytest_cache', '.mypy_cache', 'dist', 'htmlcov', '.coverage'] if os.path.isdir(d)]"
-	cd src && $(MAKE) clean
+	cd src && cd program && $(MAKE) clean
 
 install: init ## Install the package to the Python installation path.
 	$(PIP) install -e .
@@ -82,10 +83,10 @@ test: init ## Test the package.
 dist: install test ## Prepare the distribution the package by installing and testing it.
 	$(PYTHON) setup.py sdist bdist_wheel
 	$(PYTHON) -m twine check dist/*
-	cd src && $(MAKE) dist
+	cd src && cd program && $(MAKE) dist
 
 distclean: clean ## Runs clean first and then cleans up dependency include files. 
-	cd src && $(MAKE) distclean
+	cd src && cd program && $(MAKE) distclean
 
 upload_test: dist ## Upload the package to PyPI test.
 	$(PYTHON) -m twine upload -r pypitest dist/*

bin/pato-gui

@@ -9,7 +9,7 @@ do
   then
     exec $executable - << 'EOF' "$@"
 import sys
-from pato_gui import main
+from program.pato_gui import main
 
 print(f"pato-gui arguments: {sys.argv[1:]}")
 main()

mypy.ini

@@ -4,3 +4,6 @@
 
 [mypy-gooey.*]
 ignore_missing_imports = True
+
+[mypy-utils.*]
+ignore_missing_imports = True

setup.py

@@ -30,17 +30,20 @@ def run_tests(self):
         errno = pytest.main(shlex.split(self.pytest_args))
         sys.exit(errno)
 
-
+# copy of src/program/requirements.txt
 install_requires = [
-    'bs4',
+    'wxpython>=4.1.0',
+    'Gooey>=1.0.8'
 ]
 
+# copy of test_requirements.txt
 tests_require = [
     'pytest',
     'pytest-cov',
     'pytest-flakes',
     'pytest-pycodestyle',
     'flake8',
+    'mypy'
 ]
 
 
@@ -81,8 +84,8 @@ def run_tests(self):
         cmdclass={'test': PyTest},
         extras_require={'test': tests_require},
         entry_points = {
-            'console_scripts': [
-                'pato-gui = pato_gui:main',
+            'gui_scripts': [
+                'pato-gui = program.pato_gui:main',
             ],
         },
         classifiers=[

src/__init__.py

@@ -0,0 +1 @@
+__import__('pkg_resources').declare_namespace(__name__)

src/program/__init__.py

@@ -0,0 +1 @@
+__import__('pkg_resources').declare_namespace(__name__)

src/program/pato_gui.py

@@ -0,0 +1,209 @@
+"""
+The PATO GUI for launching Maven builds based on PATO.
+"""
+
+# Python modules
+import os
+import sys
+import argparse
+import subprocess
+from gooey import Gooey, GooeyParser
+from shutil import which
+
+# local module(s)
+from utils import about
+from utils.pom import db_order, initialize, process_POM
+
+# f"" syntax
+if sys.version_info < (3, 6):
+    sys.exit("Please use Python 3.6+")
+
+
+logger = None
+
+
+DEFAULT_SIZE = (1200, 800)
+MENU = [{'name': 'Help',
+         'items': [{'type': 'Link',
+                    'menuTitle': 'Documentation',
+                    'url': about.__help_url__},
+                   {'type': 'AboutDialog',
+                    'menuTitle': 'About',
+                    'name': 'Paulissoft Application Tools for Oracle (PATO)',
+                    'description': 'Run the various PATO commands',
+                    'version': about.__version__,
+                    'copyright': about.__copyright__,
+                    'website': about.__url__,
+                    'author(s)': about.__author__,
+                    'license': about.__license__}]}]
+TERMINAL_FONT_FAMILY = 'Courier New'
+
+MVND = '--mvnd'
+EXTRA_MAVEN_COMMAND_LINE_OPTIONS = '--extra-maven-command-line-options'
+ACTION = '--action'
+DB = '--db'
+DB_PROXY_PASSWORD = '--db-proxy-password'
+DB_PASSWORD = '--db-password'
+FILE = '--file'
+DB_CONFIG_DIR = '--db-config-dir'
+
+
+def find_executable(executables):
+    for executable in executables:
+        if which(executable) is not None:
+            return executable
+    assert False, "None of the executables ({}) can be found on the PATH.".format(", ".join(executables))
+
+
+PYTHONW = find_executable(['pythonw3', 'pythonw', 'python3', 'python'])
+
+
+@Gooey(program='Get POM file',
+       target=f"{PYTHONW} -u {__file__}",
+       show_success_modal=False,
+       show_failure_modal=True,
+       show_restart_button=True,
+       disable_progress_bar_animation=True,
+       clear_before_run=True,
+       default_size=DEFAULT_SIZE,
+       menu=MENU,
+       terminal_font_family=TERMINAL_FONT_FAMILY)
+def get_POM_file(argv):
+    logger.debug('get_POM_file(%s)' % (argv))
+    parser = GooeyParser(description='Get a Maven POM file to work with')
+    parser.add_argument(
+        'file',
+        help='The POM file',
+        nargs='?',
+        widget="FileChooser",
+        gooey_options={
+            'validator': {
+                'test': "user_input[-7:] == 'pom.xml'",
+                'message': 'This is not a POM file'
+            }
+        })
+    parser.add_argument(
+        DB_CONFIG_DIR,
+        required=False,
+        help='The database configuration directory',
+        widget="DirChooser")
+    args = parser.parse_args(argv)
+    logger.debug('args: %s' % (args))
+    logger.debug('return')
+    return args
+
+
+@Gooey(program='Run POM file',
+       show_success_modal=True,
+       show_failure_modal=True,
+       show_restart_button=True,
+       disable_progress_bar_animation=False,
+       clear_before_run=True,
+       required_cols=3,
+       default_size=DEFAULT_SIZE,
+       menu=MENU,
+       terminal_font_family=TERMINAL_FONT_FAMILY)
+def run_POM_file_gui(pom_file, db_config_dir, mvnd):
+    logger.debug('run_POM_file_gui({}, {}, {})'.format(pom_file, db_config_dir, mvnd))
+
+    db_config_dir, dbs, profiles, db_proxy_username, db_username = process_POM(pom_file, db_config_dir)
+    db_proxy_password_help = f'The password for database proxy account {db_proxy_username}'
+    db_password_help = f'The password for database account {db_username}'
+    dbs_sorted = sorted(dbs, key=db_order)
+
+    parser = GooeyParser(description='Get the Maven POM settings to work with and run the Maven POM file')
+
+    group0 = parser.add_argument_group('Database Information', 'Choose the database connection')
+    group0.add_argument(DB, required=True, choices=dbs_sorted, default=dbs_sorted[0], help='The database to log on to')
+    if db_proxy_username:
+        group0.add_argument(DB_PROXY_PASSWORD, required=True, widget="PasswordField", help=db_proxy_password_help)
+    else:
+        group0.add_argument(DB_PASSWORD, required=True, widget="PasswordField", help=db_password_help)
+
+    group1 = parser.add_argument_group('Other Information', 'Choose action to perform and (optionally) extra Maven command line options')
+    group1.add_argument(ACTION, required=True, choices=profiles, default=profiles[0], help='The action to perform')
+    group1.add_argument(EXTRA_MAVEN_COMMAND_LINE_OPTIONS, required=False, help='Extra Maven command line options')
+    if mvnd:
+        group1.add_argument(MVND, required=False, widget='CheckBox', default=True, help='Use the Maven daemon for a (possibly) better performance')  # , metavar='Maven daemon'
+
+    group2 = parser.add_argument_group('Information to be supplied to Maven', 'DO NOT CHANGE!')
+    group2.add_argument(
+        FILE,
+        required=True,
+        default=pom_file,
+        gooey_options={
+            'validator': {
+                'test': "hash(user_input) == {}".format(hash(pom_file)),
+                'message': 'Did you change the POM file?'
+            }
+        },
+        help='The POM file (DO NOT CHANGE!)'
+    )
+    group2.add_argument(
+        DB_CONFIG_DIR,
+        required=False,
+        default=db_config_dir,
+        gooey_options={
+            'validator': {
+                'test': "hash(user_input) == {}".format(hash(db_config_dir)),
+                'message': 'Did you change the database configuration directory?'
+            }
+        },
+        help='The database configuration directory (DO NOT CHANGE!)'
+    )
+
+    args = parser.parse_args(list(pom_file))
+    logger.debug('args: %s' % (args))
+    logger.debug('return')
+
+
+def run_POM_file(argv):
+    logger.debug('run_POM_file(%s)' % (argv))
+    parser = argparse.ArgumentParser(description='Get the POM settings to work with and run the POM file')
+    db_proxy_password_help = 'The password for database proxy account'
+    db_password_help = 'The password for database account'
+    # 4 positional arguments
+    parser.add_argument(ACTION, help='The action to perform')
+    parser.add_argument(DB, help='The database to log on to')
+    parser.add_argument(DB_PROXY_PASSWORD, default='', required=False, help=db_proxy_password_help)
+    parser.add_argument(DB_PASSWORD, default='', required=False, help=db_password_help)
+    parser.add_argument(FILE, help='The POM file')
+    parser.add_argument(DB_CONFIG_DIR, help='The database configuration directory')
+    parser.add_argument(MVND, action='store_true', help='Use the Maven daemon')
+    args, extra_maven_command_line_options = parser.parse_known_args(argv)
+    logger.debug('args: %s; extra_maven_command_line_options: %s' % (args, extra_maven_command_line_options))
+    try:
+        extra_maven_command_line_options.remove(EXTRA_MAVEN_COMMAND_LINE_OPTIONS)
+    except Exception:
+        pass
+    cmd = '{0} {1} {2} -P{3} -Ddb.config.dir={4} -Ddb={5}'.format('mvnd' if args.mvnd else 'mvn', FILE, args.file, args.action, args.db_config_dir, args.db)
+    if len(extra_maven_command_line_options) > 0:
+        cmd += ' ' + ' '.join(extra_maven_command_line_options)
+    sql_home = os.path.dirname(os.path.dirname(which('sql')))
+    logger.debug('sql_home: {}'.format(sql_home))
+    cmd += f' -Dsql.home="{sql_home}"'
+    logger.info('Maven command to execute: %s' % (cmd))
+    # now add the password
+    if args.db_proxy_password:
+        os.environ['DB_PASSWORD'] = args.db_proxy_password
+    elif args.db_password:
+        os.environ['DB_PASSWORD'] = args.db_password
+    subprocess.run(cmd, check=True, shell=True)
+    os.environ['DB_PASSWORD'] = ''
+    logger.debug('return')
+
+
+def main():
+    global logger
+
+    argv, logger, args = initialize()
+    if len(argv) <= 4:
+        if not args.file:
+            args = get_POM_file(argv)
+        run_POM_file_gui(args.file, args.db_config_dir, args.mvnd)
+    else:
+        run_POM_file(argv)
+
+
+if __name__ == '__main__':
+    main()

src/utils/about.py

@@ -6,7 +6,7 @@
 Paulissoft Application Tools for Oracle (PATO) GUI.
 '''.strip().split())
 __email__ = "[email protected]"
-__version_info__ = ('3', '0', '1')
+__version_info__ = ('3', '1', '0')
 __version__ = '.'.join(__version_info__)
 __license__ = "MIT License"
 __copyright__ = 'Copyright (c) 2021-2023 Gert-Jan Paulissen'