Clean: Use BOOK_SERVER_PATH instead of hardcoded path where possible.

Author: bjones1

Dockerfile

@@ -19,10 +19,9 @@ ENV DOCKER_BUILD_ARGS=${DOCKER_BUILD_ARGS}
 # Define some ARGs which could be passed into while building.
 #
 # **Warning:** Changing this path will require changes in many other places: the Docker volume locations, the paths in ``pyproject.toml``, paths used to run tests, etc.
-ARG WEB2PY_PATH=/srv/web2py
-# And export some as env vars so they could be available at run time
-ENV WEB2PY_PATH=${WEB2PY_PATH}
+ENV WEB2PY_PATH=/srv/web2py
 ENV RUNESTONE_PATH=${WEB2PY_PATH}/applications/runestone
+ENV BOOK_SERVER_PATH=/srv/BookServer
 
 # Click needs these encodings for Python 3.
 ENV LC_ALL=C.UTF-8

docker/docker_tools.py

@@ -810,7 +810,8 @@ def _build_phase_1(
         # ``sphinxcontrib.paverutils.run_sphinx`` lacks venv support -- it doesn't use ``sys.executable``, so it doesn't find ``sphinx-build`` in the system path when executing ``/srv/venv/bin/runestone`` directly, instead of activating the venv first (where it does work). As a huge, ugly hack, symlink it to make it available in the system path.
         "ln -sf $RUNESTONE_PATH/.venv/bin/sphinx-build /usr/local/bin",
         # Deal with a different subdirectory layout inside the container (mandated by web2py) and outside the container by adding these symlinks.
-        "ln -sf /srv/BookServer $WEB2PY_PATH/applications/BookServer",
+        "ln -sf $BOOK_SERVER_PATH $WEB2PY_PATH/applications/BookServer",
+        # We can't use ``$BOOK_SERVER_PATH`` here, since we need ``/srv/bookserver-dev`` in lowercase, not CamelCase.
         "ln -sf /srv/bookserver-dev $WEB2PY_PATH/applications/bookserver-dev",
         "ln -sf /srv/RunestoneComponents $WEB2PY_PATH/applications/RunestoneComponents",
     )

docker/docker_tools_misc.py

@@ -201,7 +201,7 @@ def test(bks: bool, rc: bool, rs: bool, passthrough: Tuple) -> None:
     pytest = "$RUNESTONE_PATH/.venv/bin/pytest"
     passthrough_args = " ".join(passthrough)
     if bks:
-        xqt(f"{pytest} -v {passthrough_args}", cwd="/srv/BookServer")
+        xqt(f"{pytest} -v {passthrough_args}", cwd=env.BOOK_SERVER_PATH)
     if rc:
         xqt(f"{pytest} -v {passthrough_args}", cwd="/srv/RunestoneComponents")
     if rs:

docker/gunicorn_config/fastapi_config.py

@@ -20,14 +20,14 @@
 #
 # Local application imports
 # -------------------------
-from common_config import *
+from common_config import *  # noqa: F401, F403
 
 
 # Configuration
 # =============
 # `chdir <https://docs.gunicorn.org/en/stable/settings.html#chdir>`_: Change directory to specified directory before loading apps. Otherwise gunicorn does not know where to look for changes to your code.
 if os.environ["BOOK_SERVER_CONFIG"] == "development":
-    chdir = "/srv/BookServer"
+    chdir = os.environ["BOOK_SERVER_PATH"]
 
 # `wsgi_app <https://docs.gunicorn.org/en/stable/settings.html#wsgi-app>`_: A WSGI application path in pattern ``$(MODULE_NAME):$(VARIABLE_NAME)``.
 wsgi_app = "bookserver.main:app"