Merge pull request #1092 from debrief/check-network-version

Compare version with network version on launch, and add Update Pepys option

.isort.cfg

@@ -4,4 +4,4 @@ include_trailing_comma = true
 force_grid_wrap = 0
 use_parentheses = true
 line_length = 100
-known_third_party =alembic,dateutil,flask,flask_cachebuster,flask_cors,freezegun,geoalchemy2,geopy,halo,iterfzf,loguru,lxml,pexpect,pg8000,pint,prompt_toolkit,psycopg2,pyfiglet,pygments,pytest,setuptools,shapely,sqlalchemy,sqlalchemy_utils,tabulate,testing,tqdm,twisted,waitress
+known_third_party =alembic,dateutil,flask,flask_cachebuster,flask_cors,freezegun,geoalchemy2,geopy,halo,iterfzf,loguru,lxml,packaging,pexpect,pg8000,pint,prompt_toolkit,psycopg2,pyfiglet,pygments,pytest,setuptools,shapely,sqlalchemy,sqlalchemy_utils,tabulate,testing,tqdm,twisted,waitress

bin/install_pepys.ps1

@@ -92,6 +92,8 @@ try {
     # Pepys Viewer shortcuts
     Make-Shortcut -ShortcutLocation ($startmenu_location + "Pepys\Pepys Viewer.lnk") -TargetPath ".\pepys_viewer.bat" -Icon $icon_string
     Make-Shortcut -ShortcutLocation ($startmenu_location + "Pepys\Pepys Viewer (training mode).lnk") -TargetPath ".\pepys_viewer_training.bat" -Icon $icon_string
+
+    Make-Shortcut -ShortcutLocation ($startmenu_location + "Pepys\Upgrade Pepys.lnk") -TargetPath ".\upgrade_pepys.bat" -Icon $icon_string
 }
 catch {
     Write-Output $_

bin/upgrade_pepys.bat

@@ -0,0 +1,13 @@
+@ECHO off
+CALL set_title.bat Upgrade Pepys
+CALL set_paths.bat
+
+powershell.exe -executionpolicy remotesigned -File upgrade_pepys.ps1
+IF ERRORLEVEL 1 GOTO :ERROR
+ECHO Pepys Upgrade completed
+PAUSE
+
+GOTO :eof
+
+:ERROR
+ECHO Error running upgrade_pepys.ps1

bin/upgrade_pepys.ps1

@@ -0,0 +1,32 @@
+# Get the path to the network master install from the Pepys config file
+# To make this as reliable as possible, we use Pepys own config parsing code
+$network_path = python -c "import config; print(config.NETWORK_MASTER_INSTALL_PATH)"
+
+if ($network_path -eq "") {
+    Write-Output "Network path not set in config file, cannot copy."
+    Exit 1
+}
+
+
+
+try {
+    Write-Output "Deleting old version of Pepys"
+    Set-Location -Path ..
+    # Delete all except the bin directory, as that directory is still kept open by the Powershell/CMD process
+    Remove-Item -Path * -Recurse -Force -Exclude bin -Verbose
+    # Move to bin and delete all the contents, but not the folder (it's fine to keep the folder, as we're
+    # always going to have a bin directory)
+    Set-Location -Path bin
+    Remove-Item -Path *
+    # Change back to the main directory
+    Set-Location -Path ..
+    Write-Output "Copying new version of Pepys from $network_path"
+    Copy-Item -Path "$network_path\*" -Destination "." -Recurse -Force -Verbose -Exclude ".git"
+}
+catch {
+    Write-Output $_
+    Write-Output "ERROR: Could not copy new Pepys version"
+    Exit 1
+}
+
+Write-Output "Copy completed"

config.py

@@ -66,3 +66,6 @@
 LOCAL_PARSERS = config.get("local", "parsers", fallback="")
 LOCAL_BASIC_TESTS = config.get("local", "basic_tests", fallback="")
 LOCAL_ENHANCED_TESTS = config.get("local", "enhanced_tests", fallback="")
+
+# Fetch network section
+NETWORK_MASTER_INSTALL_PATH = config.get("network", "master_install_path", fallback="")

default_config.ini

@@ -13,3 +13,6 @@ path = archive
 parsers =
 basic_tests =
 enhanced_tests =
+[network]
+master_install_path =
+

docs/configuration.rst

@@ -57,6 +57,13 @@ The specific variables are:
  - :code:`basic_tests`: Path to a folder containing custom basic validation tests to be loaded by pepys-import (default: none)
  - :code:`enhanced_tests`: Path to a folder containing custom enhanced validation tests to be loaded by pepys-import (default: none)
 
+:code:`[network]` section
+#########################
+These settings control which paths Pepys looks for on the network. The specific variables are:
+
+  - :code:`master_install_location`: Path to a folder containing the 'master' install of Pepys. The current Pepys version will be checked against
+    this install, and an error will be given if the master version is newer.
+
 Encryption
 ##########
 Various fields can be specified in an encrypted form (see notes above). To do this,

pepys_import/core/store/data_store.py

@@ -9,6 +9,7 @@
 
 import pint
 import sqlalchemy
+from packaging import version
 from sqlalchemy import create_engine, inspect
 from sqlalchemy.event import listen
 from sqlalchemy.exc import ArgumentError, OperationalError
@@ -17,6 +18,8 @@
 from sqlalchemy.sql.expression import text
 from sqlalchemy_utils import dependent_objects, get_referencing_foreign_keys, merge_references
 
+import config
+import pepys_import
 from paths import MIGRATIONS_DIRECTORY, PEPYS_IMPORT_DIRECTORY
 from pepys_admin.utils import read_latest_revisions_file
 from pepys_import import __build_timestamp__, __version__
@@ -36,6 +39,7 @@
     create_stored_procedures_for_postgres,
     import_from_csv,
     lowercase_or_none,
+    read_version_from_pepys_install,
 )
 from pepys_import.utils.sqlite_utils import load_spatialite, set_sqlite_foreign_keys_on
 from pepys_import.utils.value_transforming_utils import format_datetime
@@ -224,6 +228,8 @@ def __init__(
             # of the same length makes things prettier
             print("-" * 78)
 
+        self.check_network_version()
+
     def initialise(self):
         """Create schemas for the database"""
         if self.db_type == "sqlite":
@@ -269,6 +275,21 @@ def session_scope(self):
         finally:
             self.session.close()
 
+    def check_network_version(self):
+        if config.NETWORK_MASTER_INSTALL_PATH != "":
+            network_version = read_version_from_pepys_install(config.NETWORK_MASTER_INSTALL_PATH)
+            current_version = pepys_import.__version__
+
+            if network_version is None:
+                # We've already given a warning that we can't read the network version, so just continue
+                return
+
+            if version.parse(network_version) > version.parse(current_version):
+                print(
+                    "Your local installation of Pepys is older than than the network master. Please run `Upgrade Pepys` from the Start Menu."
+                )
+                sys.exit(1)
+
     #############################################################
     # Other DataStore Methods
 

pepys_import/utils/data_store_utils.py

@@ -433,3 +433,20 @@ def convert_objects_to_ids(items, table_obj):
         else:
             value = items
         return value
+
+
+def read_version_from_pepys_install(path):
+    init_path = os.path.join(path, "pepys_import", "__init__.py")
+
+    try:
+        with open(init_path, "r") as f:
+            for line in f:
+                if "__version__" in line:
+                    splitted = line.split("=")
+                    # Remove whitespace, double-quotes and single-quotes from either end
+                    version = splitted[1].strip().strip('"').strip("'")
+                    return version
+            return None
+    except Exception:
+        print(f"WARNING: Cannot read Pepys version from network master install at {path}")
+        return None

requirements.txt

@@ -21,4 +21,5 @@ Flask
 Flask-CacheBuster
 flask-cors
 waitress
-lxml
+lxml
+packaging

tests/gui_tests/gui_test_utils.py

@@ -66,7 +66,6 @@ def run_gui(ds, keys=None, print_output=False):
 
             return "\n".join(screen.display)
 
-
 else:
 
     def run_gui():