Updated the documentation

Also added 6.6.3.1 to the list of supported versions.

.pylintrc

@@ -54,88 +54,14 @@ confidence=
 # --enable=similarities". If you want to run only the classes checker, but have
 # no Warning level messages displayed, use"--disable=all --enable=classes
 # --disable=W"
-disable=print-statement,
-        parameter-unpacking,
-        unpacking-in-except,
-        old-raise-syntax,
-        backtick,
-        long-suffix,
-        old-ne-operator,
-        old-octal-literal,
-        import-star-module-level,
-        non-ascii-bytes-literal,
-        invalid-unicode-literal,
+disable=
         raw-checker-failed,
         bad-inline-option,
         locally-disabled,
-        locally-enabled,
         file-ignored,
         suppressed-message,
         useless-suppression,
         deprecated-pragma,
-        apply-builtin,
-        basestring-builtin,
-        buffer-builtin,
-        cmp-builtin,
-        coerce-builtin,
-        execfile-builtin,
-        file-builtin,
-        long-builtin,
-        raw_input-builtin,
-        reduce-builtin,
-        standarderror-builtin,
-        unicode-builtin,
-        xrange-builtin,
-        coerce-method,
-        delslice-method,
-        getslice-method,
-        setslice-method,
-        no-absolute-import,
-        old-division,
-        dict-iter-method,
-        dict-view-method,
-        next-method-called,
-        metaclass-assignment,
-        indexing-exception,
-        raising-string,
-        reload-builtin,
-        oct-method,
-        hex-method,
-        nonzero-method,
-        cmp-method,
-        input-builtin,
-        round-builtin,
-        intern-builtin,
-        unichr-builtin,
-        map-builtin-not-iterating,
-        zip-builtin-not-iterating,
-        range-builtin-not-iterating,
-        filter-builtin-not-iterating,
-        using-cmp-argument,
-        eq-without-hash,
-        div-method,
-        idiv-method,
-        rdiv-method,
-        exception-message-attribute,
-        invalid-str-codec,
-        sys-max-int,
-        bad-python3-import,
-        deprecated-string-function,
-        deprecated-str-translate-call,
-        deprecated-itertools-function,
-        deprecated-types-field,
-        next-method-defined,
-        dict-items-not-iterating,
-        dict-keys-not-iterating,
-        dict-values-not-iterating,
-        deprecated-operator-function,
-        deprecated-urllib-function,
-        xreadlines-attribute,
-        deprecated-sys-function,
-        exception-escape,
-        comprehension-escape,
-    bad-whitespace,
-    bad-continuation,
     invalid-name,
     wrong-import-position,
     global-statement,
@@ -148,7 +74,10 @@ disable=print-statement,
     import-outside-toplevel,
     isinstance-second-argument-not-valid-type,
     consider-using-f-string,
-    consider-using-max-builtin
+    consider-using-max-builtin,
+    use-implicit-booleaness-not-comparison,
+    unnecessary-lambda-assignment,
+    duplicate-string-formatting-argument,
 
 # Enable the message, report, category or checker with the given id(s). You can
 # either give multiple identifier separated by comma (,) or put this option
@@ -293,13 +222,6 @@ max-line-length=120
 # Maximum number of lines in a module
 max-module-lines=1000
 
-# List of optional constructs for which whitespace checking is disabled. `dict-
-# separator` is used to allow tabulation in dicts, etc.: {1  : 1,\n222: 2}.
-# `trailing-comma` allows a space between comma and closing bracket: (a, ).
-# `empty-line` allows space-only lines.
-no-space-check=trailing-comma,
-               dict-separator
-
 # Allow the body of a class to be on the same line as the declaration if body
 # contains single statement.
 single-line-class-stmt=no

Dockerfile

@@ -1,77 +1,55 @@
 # NOTE: Use the run-container.sh script to build and launch this container.
 
-# We do a multi-stage build (requires Docker >= 17.05) to install everything, then copy it all
-# to the final target image.
+# NOTE: Multi-stage builds require Docker >= 17.05.
+FROM rockylinux:8.5 AS base
 
-FROM centos:8 AS base
+# update packages and install requirements
+RUN dnf -y upgrade-minimal && \
+    dnf install -y python39
 
-# update packages
-RUN dnf -y upgrade-minimal
+# NOTE: We don't need the following stuff for the build step, but it's nice to not have to re-install
+# it all every time we change the requirements :-/
 
-# - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
+# install Java
+ARG JAVA_URL=https://download.oracle.com/java/17/archive/jdk-17.0.2_linux-x64_bin.tar.gz
+RUN curl -s "$JAVA_URL" | tar -xz -C /usr/bin/
 
-# NOTE: We install the Python dependencies into a temporary intermediate stage, then copy everything over
-# to the final image, because some modules (e.g. grpcio) need pre-requisites to be installed.
-# This saves us about 300 MB for the final image and, importantly, adding a requirement doesn't cause us
-# to re-install Java and Firefox below, when we start building the final image.
+# install Firefox
+ARG FIREFOX_URL=https://ftp.mozilla.org/pub/firefox/releases/94.0.2/linux-x86_64/en-US/firefox-94.0.2.tar.bz2
+RUN dnf install -y bzip2 xorg-x11-server-Xvfb gtk3 dbus-glib && \
+    curl -s "$FIREFOX_URL" | tar -jx -C /usr/local/ && \
+    ln -s /usr/local/firefox/firefox /usr/bin/firefox && \
+    echo "exclude=firefox" >>/etc/dnf/dnf.conf
 
-FROM base AS build
+# install geckodriver
+ARG GECKODRIVER_URL=https://github.com/mozilla/geckodriver/releases/download/v0.31.0/geckodriver-v0.31.0-linux64.tar.gz
+RUN curl -sL "$GECKODRIVER_URL" | tar -xz -C /usr/bin/
 
-# install Python
-# NOTE: The version of Python we want is newer than what's in Centos 8,
-# so we have to install from source :-/
-RUN dnf -y groupinstall "Development Tools" && \
-    dnf -y install openssl-devel bzip2-devel libffi-devel sqlite-devel
-RUN cd /tmp && \
-    dnf -y install wget && \
-    wget https://www.python.org/ftp/python/3.8.7/Python-3.8.7.tgz && \
-    tar xvf Python-3.8.7.tgz && \
-    cd Python-3.8.7/ && \
-    ./configure --enable-optimizations && \
-    make install
+# clean up
+RUN dnf clean all
+
+# - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
+
+FROM base AS build
 
 # set up a virtualenv
 RUN python3 -m venv /opt/venv
 ENV PATH="/opt/venv/bin:$PATH"
+RUN pip install --upgrade pip
 
 # install the application requirements
-COPY requirements.txt requirements-dev.txt ./
-RUN pip3 install -r requirements.txt
+COPY requirements.txt requirements-dev.txt /tmp/
+RUN pip3 install -r /tmp/requirements.txt
 ARG CONTROL_TESTS_PORT
 RUN if [ -n "$CONTROL_TESTS_PORT" ]; then \
-    dnf install -y gcc-c++ python3-devel && \
-    pip3 install -r requirements-dev.txt \
+    pip3 install -r /tmp/requirements-dev.txt \
 ; fi
 
 # - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
 
 FROM base
 
-# copy the Python installation from the build image
-COPY --from=build /usr/local/bin/python3.8 /usr/local/bin/python3.8
-COPY --from=build /usr/local/lib/python3.8 /usr/local/lib/python3.8
-COPY --from=build /usr/local/bin/pip3 /usr/local/bin/pip3
-RUN ln -s /usr/local/bin/python3.8 /usr/local/bin/python3
-
-# install Java
-RUN url="https://download.java.net/java/GA/jdk15.0.1/51f4f36ad4ef43e39d0dfdbaf6549e32/9/GPL/openjdk-15.0.1_linux-x64_bin.tar.gz" ; \
-    curl -s "$url" | tar -C /usr/bin/ -xz
-
-# install Firefox
-RUN dnf install -y wget bzip2 xorg-x11-server-Xvfb gtk3 dbus-glib && \
-    wget -qO- "https://download.mozilla.org/?product=firefox-latest-ssl&os=linux64&lang=en-US" \
-        | tar -C /usr/local/ -jx && \
-    ln -s /usr/local/firefox/firefox /usr/bin/firefox && \
-    echo "exclude=firefox" >>/etc/dnf/dnf.conf
-
-# install geckodriver
-RUN url=$( curl -s https://api.github.com/repos/mozilla/geckodriver/releases/latest | grep -Poh 'https.*linux64\.tar\.gz(?!\.)' ) && \
-    curl -sL "$url" | tar -C /usr/bin/ -xz
-
-# clean up
-RUN dnf clean all
-
-# install the application requirements
+# copy the virtualenv from the build image
 COPY --from=build /opt/venv /opt/venv
 ENV PATH="/opt/venv/bin:$PATH"
 
@@ -95,6 +73,13 @@ COPY docker/config/ ./vasl_templates/webapp/config/
 RUN useradd --create-home app
 USER app
 
+# FUDGE! We need this to stop spurious warning messages:
+#   Fork support is only compatible with the epoll1 and poll polling strategies
+# Setting the verbosity to ERROR should suppress these, but doesn't :-/
+#   https://github.com/grpc/grpc/issues/17253
+#   https://github.com/grpc/grpc/blob/master/doc/environment_variables.md
+ENV GRPC_VERBOSITY=NONE
+
 # run the application
 EXPOSE 5010
 COPY docker/run.sh ./

README.md

@@ -1,16 +1,14 @@
 # VASL Templates
 
-<a href="https://github.com/pacman-ghost/vasl-templates/raw/master/vasl_templates/webapp/static/help/images/hill-621.png" target="_blank">
-<img src="https://github.com/pacman-ghost/vasl-templates/raw/master/vasl_templates/webapp/static/help/images/hill-621.small.png" width="200" align="right" hspace="10">
-</a>
+[<img src="vasl_templates/webapp/static/help/images/hill-621.small.png" width="200" align="right" hspace="10">](vasl_templates/webapp/static/help/images/hill-621.png)
 
 *VASL Templates* makes it easy to set up attractive VASL scenarios, with loads of useful information embedded to assist with game play.
 
 Simply enter the scenario information into the UI, and the program will generate HTML snippets that you can transfer into VASL labels in your scenario.
 
-<img src="https://github.com/pacman-ghost/vasl-templates/raw/master/vasl_templates/webapp/static/help/images/ob_setup.png" width="200">
+[<img src="vasl_templates/webapp/static/help/images/ob_setup.png" width="200">](vasl_templates/webapp/static/help/images/ob_setup.png)
 
-You can find more examples of the program in action [here](https://github.com/pacman-ghost/vasl-templates/tree/master/examples/).
+You can find more examples of the program in action [here](examples/).
 
 ### Documentation
 
@@ -20,3 +18,4 @@ You can find more examples of the program in action [here](https://github.com/pa
 * [Setting up Chapter H data](https://vasl-templates.org/help?tab=chapterh)
 * [Writing your own templates](https://vasl-templates.org/help?tab=templatepacks)
 * [For developers](https://vasl-templates.org/help?tab=fordevelopers)
+* [FAQ](https://vasl-templates.org/FAQ)

conftest.py

@@ -4,8 +4,8 @@ import os
 import threading
 import json
 import re
-import logging
 import tempfile
+import logging
 import urllib.request
 from urllib.error import URLError
 import pytest
@@ -42,7 +42,7 @@ def pytest_addoption( parser ):
         help="Run the tests headless."
     )
     parser.addoption(
-        "--window-size", action="store", dest="window_size", default="1000x700",
+        "--window-size", action="store", dest="window_size", default="1020x700",
         help="Browser window size."
     )
 
@@ -70,6 +70,13 @@ def pytest_configure( config ):
     import vasl_templates.webapp.tests
     vasl_templates.webapp.tests.pytest_options = config.option
 
+# - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
+
+@pytest.fixture( scope="session" )
+def monkeypatch():
+    """Override the default monkeypatch fixture."""
+    assert False, "Don't use monkeypatch!" # it won't work when testing against a remote server
+
 # ---------------------------------------------------------------------
 
 _webapp = None
@@ -100,7 +107,7 @@ def _make_webapp():
     if webapp_url and not webapp_url.startswith( "http://" ):
         webapp_url = "http://" + webapp_url
     app.base_url = webapp_url if webapp_url else "http://localhost:{}".format( FLASK_WEBAPP_PORT )
-    logging.disable( logging.CRITICAL )
+    _disable_console_logging()
 
     # initialize
     # WTF?! https://github.com/pallets/flask/issues/824
@@ -147,7 +154,8 @@ def _make_webapp():
         def is_ready():
             """Try to connect to the webapp server."""
             try:
-                with urllib.request.urlopen( app.url_for("ping") ) as resp:
+                url = app.url_for( "ping" )
+                with urllib.request.urlopen( url ) as resp:
                     assert resp.read().startswith( b"pong: " )
                 return True
             except URLError:
@@ -172,6 +180,17 @@ def _make_webapp():
     addr = "{}:{}".format( mo.group(1), port_no )
     app.control_tests = ControlTests( addr )
 
+    # NOTE: We set the back-end webdriver to be the of the same type (Firefox or Chrome) as the browser
+    # being used to drive the tests, which, strictly speaking, doesn't make sense, since the two things
+    # don't have anything to do with each other. However, this is a convenient way to switch the backend
+    # webdriver's and exercise both of them. The webdriver binary must be on the path, but if it's not,
+    # we won't have even got this far, since it needs to be there to drive the browser.
+    # NOTE: This will have no effect if we're talking to a remote server, but we can live with that.
+    if _pytest_options.webdriver == "firefox":
+        app.config[ "WEBDRIVER_PATH" ] = "geckodriver"
+    elif _pytest_options.webdriver == "chrome":
+        app.config[ "WEBDRIVER_PATH" ] = "chromedriver"
+
     return app
 
 # - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
@@ -179,7 +198,7 @@ def _make_webapp():
 @pytest.fixture( scope="session" )
 def test_client():
     """Return a test client that can be used to connect to the webapp."""
-    logging.disable( logging.CRITICAL )
+    _disable_console_logging()
     return app.test_client()
 
 # - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
@@ -197,27 +216,17 @@ def webdriver( request ):
     # initialize
     driver = request.config.getoption( "--webdriver" )
     from selenium import webdriver as wb
+    log_fname = os.path.join( tempfile.gettempdir(), "webdriver-pytest.log" )
     if driver == "firefox":
         options = wb.FirefoxOptions()
         options.headless = _pytest_options.headless
-        driver = wb.Firefox(
-            options = options,
-            service_log_path = os.path.join( tempfile.gettempdir(), "geckodriver.log" )
-        )
+        service = wb.firefox.service.Service( log_path=log_fname )
+        driver = wb.Firefox( options=options, service=service )
     elif driver == "chrome":
         options = wb.ChromeOptions()
         options.headless = _pytest_options.headless
         options.add_argument( "--disable-gpu" )
         driver = wb.Chrome( options=options )
-    elif driver == "ie":
-        # NOTE: IE11 requires a registry key to be set:
-        #   https://github.com/SeleniumHQ/selenium/wiki/InternetExplorerDriver#required-configuration
-        options = wb.IeOptions()
-        if _pytest_options.headless:
-            raise RuntimeError( "IE WebDriver cannot be run headless." )
-        options.IntroduceInstabilityByIgnoringProtectedModeSettings = True
-        options.EnsureCleanSession = True
-        driver = wb.Ie( ie_options=options )
     else:
         raise RuntimeError( "Unknown webdriver: {}".format( driver ) )
 
@@ -230,3 +239,19 @@ def webdriver( request ):
         yield driver
     finally:
         driver.quit()
+
+# ---------------------------------------------------------------------
+
+def _disable_console_logging():
+    """Disable Python logging to the console.
+
+    We do this when running tests because:
+    (1) pytest's output is voluminous enough without including our stuff in there as well (and it tends to be
+        not that helpful, anyway)
+    (2) pytest captures all output and shows it when the test ends i.e. we don't get to see messages in real-time.
+    """
+    for logger in utils.get_all_loggers():
+        # NOTE: FileHandler derives from StreamHandler, and we want to keep those, so we can't use isinstance().
+        handlers = [ h for h in logger.handlers if type( h ) is logging.StreamHandler ] #pylint: disable=unidiomatic-typecheck
+        for h in handlers:
+            logger.removeHandler( h )

docker/config/site.cfg

@@ -2,5 +2,5 @@
 
 IS_CONTAINER = 1
 
-JAVA_PATH = /usr/bin/jdk-15.0.1/bin/java
+JAVA_PATH = /usr/bin/jdk-17.0.2/bin/java
 WEBDRIVER_PATH = /usr/bin/geckodriver

examples/Hill 621 (Scenario E).json

@@ -1,16 +1,12 @@
 {
-    "SCENARIO_NAME": "Hill 621",
-    "SCENARIO_ID": "ASL E",
-    "SCENARIO_LOCATION": "Near Minsk, Russia",
+    "COMPASS": "right",
     "SCENARIO_DATE": "1944-07-01",
     "SCENARIO_WIDTH": "",
-    "PLAYER_1_DESCRIPTION": "Retreating elements of 170th Infantry Division",
-    "PLAYER_2_DESCRIPTION": "Elements of 5th Guards Army",
     "ASA_ID": "56512",
     "ROAR_ID": "129",
     "PLAYERS_WIDTH": "",
-    "VICTORY_CONDITIONS_WIDTH": "240px",
-    "SSR_WIDTH": "500px",
+    "VICTORY_CONDITIONS_WIDTH": "",
+    "SSR_WIDTH": "400px",
     "OB_VEHICLES_WIDTH_1": "",
     "OB_VEHICLES_MA_NOTES_WIDTH_1": "300px",
     "OB_ORDNANCE_WIDTH_1": "",
@@ -19,7 +15,12 @@
     "OB_VEHICLES_MA_NOTES_WIDTH_2": "300px",
     "OB_ORDNANCE_WIDTH_2": "",
     "OB_ORDNANCE_MA_NOTES_WIDTH_2": "300px",
-    "VICTORY_CONDITIONS": "The Russians win at Game End if they Control ≥ five Level 3 hill hexes on Board 2.",
+    "SCENARIO_NAME": "Hill 621",
+    "SCENARIO_ID": "ASL E",
+    "SCENARIO_LOCATION": "Near Minsk, Russia",
+    "PLAYER_1_DESCRIPTION": "Retreating elements of 170th Infantry Division",
+    "PLAYER_2_DESCRIPTION": "Elements of 5th Guards Army",
+    "VICTORY_CONDITIONS": "The Russians win at Game End if they Control<br>≥ five Level 3 hill hexes on Board 2.",
     "SCENARIO_THEATER": "ETO",
     "PLAYER_1": "russian",
     "PLAYER_1_ELR": "4",
@@ -27,6 +28,15 @@
     "PLAYER_2": "german",
     "PLAYER_2_ELR": "3",
     "PLAYER_2_SAN": "4",
+    "TURN_TRACK": {
+        "NTURNS": "10",
+        "WIDTH": "",
+        "VERTICAL": false,
+        "SHADING": "",
+        "REINFORCEMENTS_1": "2,5",
+        "REINFORCEMENTS_2": "1,2,4,5,8",
+        "SWAP_PLAYERS": false
+    },
     "SSR": [
         "EC are Moderate, with no wind at start.",
         "After \"At Start\" placement, each German infantry unit must take a TC. The only possible consequence of failure is that the unit must begin the scenario broken. Those units which break during this pre-game TC are not subject to DM in the initial German RPh.",
@@ -106,7 +116,7 @@
     ],
     "SCENARIO_NOTES": [
         {
-            "caption": "Download the scenario card from <a href=\"http://www.multimanpublishing.com/Support/ASLASLSK/ASLOfficialDownloads/tabid/109/Default.aspx\">Multi-Man Publishing</a> (ASL Classic pack).",
+            "caption": "Download the scenario card from <a href=\"https://mmpgamers.com/asl-downloads-ezp-3#scenarios\">Multi-Man Publishing</a> (ASL Classic pack).",
             "width": "300px",
             "id": 1
         }
@@ -173,7 +183,7 @@
             "id": 2
         }
     ],
-    "_app_version": "v1.3",
-    "_last_update_time": "2020-09-27T04:13:08.719Z",
+    "_app_version": "v1.10",
+    "_last_update_time": "2022-09-12T02:46:18.035Z",
     "_creation_time": "2020-09-27T03:46:56.089Z"
 }

examples/Hube's Pocket (Scenario G).json

@@ -1,15 +1,11 @@
 {
-    "SCENARIO_NAME": "Hube's Pocket",
-    "SCENARIO_ID": "ASL G",
-    "SCENARIO_LOCATION": "Near Buchach, Southern Russia",
+    "COMPASS": "down",
     "SCENARIO_DATE": "1944-04-06",
     "SCENARIO_WIDTH": "",
-    "PLAYER_1_DESCRIPTION": "Advance elements of 5th Tank Corps",
-    "PLAYER_2_DESCRIPTION": "10th SS Panzer Division \"Frundsberg\" and the First Panzer Army ",
     "ASA_ID": "56514",
     "ROAR_ID": "131",
     "PLAYERS_WIDTH": "",
-    "VICTORY_CONDITIONS_WIDTH": "320px",
+    "VICTORY_CONDITIONS_WIDTH": "",
     "SSR_WIDTH": "330px",
     "OB_VEHICLES_WIDTH_1": "",
     "OB_VEHICLES_MA_NOTES_WIDTH_1": "300px",
@@ -19,7 +15,12 @@
     "OB_VEHICLES_MA_NOTES_WIDTH_2": "300px",
     "OB_ORDNANCE_WIDTH_2": "",
     "OB_ORDNANCE_MA_NOTES_WIDTH_2": "300px",
-    "VICTORY_CONDITIONS": "The Germans win immediately by exiting &ge; 10 vehicles <br>\noff the west edge in either one or two Convoys (see SSR 4).",
+    "SCENARIO_NAME": "Hube's Pocket",
+    "SCENARIO_ID": "ASL G",
+    "SCENARIO_LOCATION": "Near Buchach, Southern Russia",
+    "PLAYER_1_DESCRIPTION": "Advance elements of 5th Tank Corps",
+    "PLAYER_2_DESCRIPTION": "10th SS Panzer Division \"Frundsberg\" and the First Panzer Army",
+    "VICTORY_CONDITIONS": "The Germans win immediately by exiting ≥ 10 vehicles <br>\noff the west edge in either one or two Convoys (see SSR 4).",
     "SCENARIO_THEATER": "ETO",
     "PLAYER_1": "german",
     "PLAYER_1_ELR": "4",
@@ -27,6 +28,15 @@
     "PLAYER_2": "russian",
     "PLAYER_2_ELR": "3",
     "PLAYER_2_SAN": "2",
+    "TURN_TRACK": {
+        "NTURNS": "14",
+        "WIDTH": "5",
+        "VERTICAL": false,
+        "SHADING": "",
+        "REINFORCEMENTS_1": "1,5",
+        "REINFORCEMENTS_2": "1",
+        "SWAP_PLAYERS": true
+    },
     "SSR": [
         "The SPW 251/sMG inherent HS is a 3-4-8.",
         "German inherent crews have a morale of 9.",
@@ -84,7 +94,7 @@
     ],
     "SCENARIO_NOTES": [
         {
-            "caption": "Download the scenario card from <a href=\"http://www.multimanpublishing.com/Support/ASLASLSK/ASLOfficialDownloads/tabid/109/Default.aspx\">Multi-Man Publishing</a> (ASL Classic pack).",
+            "caption": "Download the scenario card from <a href=\"https://mmpgamers.com/asl-downloads-ezp-3#scenarios\">Multi-Man Publishing</a> (ASL Classic pack).",
             "width": "",
             "id": 1
         }
@@ -110,7 +120,7 @@
     ],
     "OB_NOTES_1": [],
     "OB_NOTES_2": [],
-    "_app_version": "v1.3",
-    "_last_update_time": "2020-09-27T04:33:18.643Z",
+    "_app_version": "v1.10",
+    "_last_update_time": "2022-09-12T02:22:47.511Z",
     "_creation_time": "2020-09-27T04:11:07.200Z"
 }

examples/README.md

@@ -4,4 +4,4 @@ This directory contains examples of *VASL Templates* in action, with the `.json`
 
 The online versions contain images that will be loaded from the internet, which looks much better, but there will be a short delay when you open the scenario in VASSAL as the images are downloaded.
 
-These scenarios were taken from Multi-Man Publishing's [*ASL Classic* scenario pack](http://www.multimanpublishing.com/Support/ASLASLSK/ASLOfficialDownloads/tabid/109/Default.aspx).
+These scenarios were taken from Multi-Man Publishing's [*ASL Classic* scenario pack](https://mmpgamers.com/asl-downloads-ezp-3#scenarios).

examples/The Streets Of Stalingrad (Scenario C).json

@@ -1,15 +1,11 @@
 {
-    "SCENARIO_NAME": "The Streets Of Stalingrad",
-    "SCENARIO_ID": "ASL C",
-    "SCENARIO_LOCATION": "Stalingrad, Russia",
+    "COMPASS": "up",
     "SCENARIO_DATE": "1942-10-06",
     "SCENARIO_WIDTH": "",
-    "PLAYER_1_DESCRIPTION": "308th Rifle Division / 295th Rifle Division / 2nd Battalion, 37th Guards Division",
-    "PLAYER_2_DESCRIPTION": "389th Infantry Division",
     "ASA_ID": "56510",
     "ROAR_ID": "127",
     "PLAYERS_WIDTH": "",
-    "VICTORY_CONDITIONS_WIDTH": "400px",
+    "VICTORY_CONDITIONS_WIDTH": "450px",
     "SSR_WIDTH": "500px",
     "OB_VEHICLES_WIDTH_1": "",
     "OB_VEHICLES_MA_NOTES_WIDTH_1": "300px",
@@ -19,7 +15,12 @@
     "OB_VEHICLES_MA_NOTES_WIDTH_2": "300px",
     "OB_ORDNANCE_WIDTH_2": "",
     "OB_ORDNANCE_MA_NOTES_WIDTH_2": "300px",
-    "VICTORY_CONDITIONS": "Victory is based upon satisfying the Victory Conditions of Scenarios A and B:\n<ul style=\"margin:0 0 10px 10px;\">\n<li> If each side fulfills one Victory Condition, the game is a draw.\n<li> If a player fulfills one Victory Condition and draws the other, he wnis.\n<li> A decisive victory is achieved when a player fulfills both Victory Conditions.\n</ul>\n\n<p> <b>Scenario A:</b> The Russians win at Game End if they Control &ge; 2 more buildings initially occupied by the Germans than they lose of their own initially-held stone buildings to German Control, and/or have a favorable 3:1 ratio of unbroken squad-equivalents.\n<p> <b>Scenario B:</b> At Game End, the player with undisputed control of at least 6 hexes of building X3 wins. A hex containing a Melee is controlled by neither player. If only one player has an unbroken unit in the building at Game End, that player is the winner. Any other result is a draw.\n</ul>",
+    "SCENARIO_NAME": "The Streets Of Stalingrad",
+    "SCENARIO_ID": "ASL C",
+    "SCENARIO_LOCATION": "Stalingrad, Russia",
+    "PLAYER_1_DESCRIPTION": "308th Rifle Division / 295th Rifle Division / 2nd Battalion, 37th Guards Division",
+    "PLAYER_2_DESCRIPTION": "389th Infantry Division",
+    "VICTORY_CONDITIONS": "Victory is based upon satisfying the Victory Conditions of Scenarios A and B:\n<ul style=\"margin:0 0 10px 10px;\">\n<li> If each side fulfills one Victory Condition, the game is a draw.\n</li><li> If a player fulfills one Victory Condition and draws the other, he wnis.\n</li><li> A decisive victory is achieved when a player fulfills both Victory Conditions.\n</li></ul>\n\n<p> <b>Scenario A:</b> The Russians win at Game End if they Control ≥ 2 more buildings initially occupied by the Germans than they lose of their own initially-held stone buildings to German Control, and/or have a favorable 3:1 ratio of unbroken squad-equivalents.\n</p><p> <b>Scenario B:</b> At Game End, the player with undisputed control of at least 6 hexes of building X3 wins. A hex containing a Melee is controlled by neither player. If only one player has an unbroken unit in the building at Game End, that player is the winner. Any other result is a draw.\n</p>",
     "SCENARIO_THEATER": "ETO",
     "PLAYER_1": "russian",
     "PLAYER_1_ELR": "3",
@@ -27,6 +28,15 @@
     "PLAYER_2": "german",
     "PLAYER_2_ELR": "4",
     "PLAYER_2_SAN": "6",
+    "TURN_TRACK": {
+        "NTURNS": "7",
+        "WIDTH": "",
+        "VERTICAL": false,
+        "SHADING": "",
+        "REINFORCEMENTS_1": "2",
+        "REINFORCEMENTS_2": "3",
+        "SWAP_PLAYERS": false
+    },
     "SSR": [
         "Roll a die to determine who moves first.",
         "Set up the forces of Scenario A prior to placing the units of Scenario B.",
@@ -61,7 +71,7 @@
     ],
     "SCENARIO_NOTES": [
         {
-            "caption": "Download the scenario card from <a href=\"http://www.multimanpublishing.com/Support/ASLASLSK/ASLOfficialDownloads/tabid/109/Default.aspx\">Multi-Man Publishing</a> (ASL Classic pack).",
+            "caption": "Download the scenario card from <a href=\"https://mmpgamers.com/asl-downloads-ezp-3#scenarios\">Multi-Man Publishing</a> (ASL Classic pack).",
             "width": "",
             "id": 1
         }
@@ -157,7 +167,7 @@
     ],
     "OB_NOTES_1": [],
     "OB_NOTES_2": [],
-    "_app_version": "v1.3",
-    "_last_update_time": "2020-09-27T04:46:21.803Z",
+    "_app_version": "v1.10",
+    "_last_update_time": "2022-09-12T02:58:13.237Z",
     "_creation_time": "2020-09-27T04:44:48.473Z"
 }

freeze.py

@@ -95,8 +95,8 @@ def main( args ): #pylint: disable=too-many-locals
         args.append( "--noconsole" )
         args.extend( [ "--icon", APP_ICON ] )
         # NOTE: These files are not always required but it's probably safer to always include them.
-        import distutils.sysconfig #pylint: disable=import-error
-        dname = os.path.join( distutils.sysconfig.get_python_lib() , "PyQt5/Qt5/bin" )
+        import sysconfig
+        dname = os.path.join( sysconfig.get_path("platlib") , "PyQt5/Qt5/bin" )
         args.extend( [ "--add-binary", os.path.join(dname,"libEGL.dll") + os.pathsep + "PyQt5/Qt/bin" ] )
         args.extend( [ "--add-binary", os.path.join(dname,"libGLESv2.dll") + os.pathsep + "PyQt5/Qt/bin" ] )
     args.append( MAIN_SCRIPT )

loader/freeze.py

@@ -98,7 +98,7 @@ def _convert_app_icon( save_fname ):
     # to an image, then insert it into the PyInstaller-generated executable (so that
     # we don't have to bundle Pillow into the release).
     img = Image.open( APP_ICON )
-    img = img.convert( "RGBA" ).resize( (64, 64) )
+    img = img.convert( "RGBA" ).resize( (48, 48) )
     img.save( save_fname, "png" )
 
 # ---------------------------------------------------------------------

loader/main.py

@@ -93,7 +93,7 @@ def create_window( app_icon ):
     """Create the splash window."""
 
     # create the splash window
-    main_window.geometry( "290x75" )
+    main_window.geometry( "275x64" )
     main_window.title( "vasl-templates loader" )
     main_window.overrideredirect( 1 ) # nb: "-type splash" doesn't work on Windows :-/
     main_window.eval( "tk::PlaceWindow . center" )
@@ -103,11 +103,11 @@ def create_window( app_icon ):
 
     # add the app icon
     label = tkinter.Label( main_window, image=app_icon )
-    label.grid( row=0, column=0, rowspan=2, padx=5, pady=5 )
+    label.grid( row=0, column=0, rowspan=2, padx=8, pady=8 )
 
     # add the caption
     label = tkinter.Label( main_window, text="Loading vasl-templates...", font=("Helvetica",12) )
-    label.grid( row=0, column=1, padx=5, pady=(5,0) )
+    label.grid( row=0, column=1, padx=5, pady=(8,0) )
 
     # add the "loading" image (we have to animate it ourself :-/)
     anim_label = tkinter.Label( main_window )

requirements-dev.txt

@@ -1,7 +1,7 @@
-pytest==6.2.5
-grpcio-tools==1.41.0
+pytest==7.1.2
+grpcio-tools==1.46.3
 tabulate==0.8.9
-lxml==4.6.3
-pylint==2.11.1
+lxml==4.9.0
+pylint==2.14.1
 pytest-pylint==0.18.0
-pyinstaller==4.5.1
+pyinstaller==5.1

requirements.txt

@@ -1,7 +1,9 @@
-# python 3.8.7
+# python 3.10.7
 
-flask==2.0.1
-pyyaml==5.4.1
-pillow==8.3.2
-selenium==3.141.0
-click==8.0.1
+flask==2.1.2
+pyyaml==6.0
+pillow==9.1.1
+selenium==4.2.0
+waitress==2.1.2
+appdirs==1.4.4
+click==8.1.3

run-container.sh

@@ -14,11 +14,17 @@ function main
     VASL_BOARDS=
     CHAPTER_H_NOTES=
     USER_FILES=
+    LOGGING_CONFIG=
+    VASSAL_SHIM_LOGGING_CONFIG=
+    ASA_INDEX=
+    ROAR_INDEX=
+    VO_NOTES_IMAGE_CACHE=
     TEMPLATE_PACK=
     IMAGE_TAG=latest
     CONTAINER_NAME=vasl-templates
     DETACH=
     NO_BUILD=
+    BUILD_ARGS=
     BUILD_NETWORK=
     RUN_NETWORK=
     CONTROL_TESTS_PORT=
@@ -30,7 +36,7 @@ function main
         print_help
         exit 0
     fi
-    params="$(getopt -o p:v:e:k:t:d -l port:,control-tests-port:,vassal:,vasl:,vasl-extensions:,boards:,chapter-h:,template-pack:,user-files:,tag:,name:,detach,no-build,build-network:,run-network:,test-data-vassal:,test-data-vasl-mods:,help --name "$0" -- "$@")"
+    params="$(getopt -o p:v:e:k:t:d -l port:,control-tests-port:,vassal:,vasl:,vasl-extensions:,boards:,chapter-h:,template-pack:,user-files:,logging:,vassal-shim-logging:,asa-index:,roar-index:,vo-notes-image-cache:,tag:,name:,detach,no-build,build-arg:,build-network:,run-network:,test-data-vassal:,test-data-vasl-mods:,help --name "$0" -- "$@")"
     if [ $? -ne 0 ]; then exit 1; fi
     eval set -- "$params"
     while true; do
@@ -59,6 +65,21 @@ function main
             -k | --template-pack)
                 TEMPLATE_PACK=$2
                 shift 2 ;;
+            --logging)
+                LOGGING_CONFIG=$2
+                shift 2 ;;
+            --vassal-shim-logging)
+                VASSAL_SHIM_LOGGING_CONFIG=$2
+                shift 2 ;;
+            --asa-index)
+                ASA_INDEX=$2
+                shift 2 ;;
+            --roar-index)
+                ROAR_INDEX=$2
+                shift 2 ;;
+            --vo-notes-image-cache)
+                VO_NOTES_IMAGE_CACHE=$2
+                shift 2 ;;
             -t | --tag)
                 IMAGE_TAG=$2
                 shift 2 ;;
@@ -71,6 +92,9 @@ function main
             --no-build )
                 NO_BUILD=1
                 shift 1 ;;
+            --build-arg )
+                BUILD_ARGS="$BUILD_ARGS --build-arg $2"
+                shift 2 ;;
             --build-network )
                 # FUDGE! We sometimes can't get out to the internet from the container (DNS problems) using the default
                 # "bridge" network, so we offer the option of using an alternate network (e.g. "host").
@@ -182,12 +206,72 @@ function main
         fi
         mpoint=/data/template-pack
         TEMPLATE_PACK_VOLUME="--volume $target:$mpoint"
-        TEMPLATE_PACK_ENV="--env DEFAULT_TEMPLATE_PACK=$mpoint --env DEFAULT_TEMPLATE_PACK_TARGET"
+        TEMPLATE_PACK_ENV="--env DEFAULT_TEMPLATE_PACK=$mpoint"
+    fi
+
+    # check if logging has been configured
+    if [ -n "$LOGGING_CONFIG" ]; then
+        target=$( get_target FILE "$LOGGING_CONFIG" )
+        if [ -z "$target" ]; then
+            echo "Can't find the logging config file: $LOGGING_CONFIG"
+            exit 1
+        fi
+        mpoint=/app/vasl_templates/webapp/config/logging.yaml
+        LOGGING_CONFIG_VOLUME="--volume $target:$mpoint"
+    fi
+    if [ -n "$VASSAL_SHIM_LOGGING_CONFIG" ]; then
+        target=$( get_target FILE "$VASSAL_SHIM_LOGGING_CONFIG" )
+        if [ -z "$target" ]; then
+            echo "Can't find the VASSAL shim logging config file: $VASSAL_SHIM_LOGGING_CONFIG"
+            exit 1
+        fi
+        mpoint=/app/vassal-shim/release/logback-test.xml
+        VASSAL_SHIM_LOGGING_CONFIG_VOLUME="--volume $target:$mpoint"
+    fi
+
+    # check if external ASA/ROAR index files have been specified
+    # NOTE: We don't need to pass env.vars into the container, or anything like that. The code already
+    # saves the downloaded files in /tmp/ (inside the container), so all we need to do is map these files
+    # to the specified external files.
+    if [ -n "$ASA_INDEX" ]; then
+        target=$( realpath --no-symlinks "$ASA_INDEX" )
+        if [ ! -f "$target" ]; then
+            if ! touch "$target" 2>/dev/null; then
+                echo "Can't find the ASA index file: $ASA_INDEX"
+                exit 1
+            fi
+        fi
+        mpoint=/tmp/asl-scenario-archive.json
+        ASA_INDEX_VOLUME="--volume $target:$mpoint"
+    fi
+    if [ -n "$ROAR_INDEX" ]; then
+        target=$( realpath --no-symlinks "$ROAR_INDEX" )
+        if [ ! -f "$target" ]; then
+            if ! touch "$target" 2>/dev/null ; then
+                echo "Can't find the ROAR index file: $ASA_INDEX"
+                exit 1
+            fi
+        fi
+        mpoint=/tmp/roar-scenario-index.json
+        ROAR_INDEX_VOLUME="--volume $target:$mpoint"
+    fi
+
+    # check if an external v/o notes image cache directory has been specified
+    if [ -n "$VO_NOTES_IMAGE_CACHE" ]; then
+        target=$( realpath --no-symlinks "$VO_NOTES_IMAGE_CACHE" )
+        if [ ! -d "$target" ]; then
+            if ! mkdir "$target" 2>/dev/null; then
+                echo "Can't find the V/O notes image cache directory: $VO_NOTES_IMAGE_CACHE"
+                exit 1
+            fi
+        fi
+        mpoint=/tmp/vo-notes-image-cache/
+        VO_NOTES_IMAGE_CACHE_VOLUME="--volume $target:$mpoint"
     fi
 
     # check if testing has been enabled
     if [ -n "$CONTROL_TESTS_PORT" ]; then
-        CONTROL_TESTS_PORT_BUILD="--build-arg CONTROL_TESTS_PORT=$CONTROL_TESTS_PORT"
+        BUILD_ARGS="$BUILD_ARGS --build-arg CONTROL_TESTS_PORT=$CONTROL_TESTS_PORT"
         CONTROL_TESTS_PORT_RUN="--env CONTROL_TESTS_PORT=$CONTROL_TESTS_PORT --publish $CONTROL_TESTS_PORT:$CONTROL_TESTS_PORT"
     fi
 
@@ -196,7 +280,7 @@ function main
         echo Building the \"$IMAGE_TAG\" image...
         docker build \
             --tag vasl-templates:$IMAGE_TAG \
-            $CONTROL_TESTS_PORT_BUILD \
+            $BUILD_ARGS \
             $BUILD_NETWORK \
             . 2>&1 \
           | sed -e 's/^/  /'
@@ -215,6 +299,8 @@ function main
         --env DOCKER_CONTAINER_NAME="$CONTAINER_NAME" \
 <