Upgrade failed

.UPGRADE_INSTRUCTIONS

@@ -0,0 +1,6 @@
+The `create.diff` file is a recommendation of the changes that you should apply to your project.
+You should apply the changes shown in the diff file on `CONST_create_template/<file>` on your project's `<file>`.
+Some advice to be more efficient: if the changes on a file concern a file that you never customize, you can simply copy the new file from `CONST_create_template` (`cp CONST_create_template/<file> <file>`).You can furthermore add this file to the `unmanaged_files` section of the `project.yaml` file, to avoid its contents appearing in the diff file for the next upgrade.
+Note that you can also apply them using: git apply --3way create.diff
+To continue, type:
+./upgrade 2.9.rc.12 11

.upgrade.yaml

@@ -0,0 +1,67 @@
+---
+# The list (by include, exclude) of default files that will not be overwritten by the upgrade.
+# That that can be extended with managed_files or reduced with unmanaged_files from the
+# project.yaml file in the project root directory.
+default_project_file:
+  include:
+    - geoportal/setup\.py
+    - geoportal/vars\.yaml
+    - geoportal/Makefile
+    - geoportal/geomapfish_geoportal/__init__\.py
+    - geoportal/geomapfish_geoportal/templates/.*
+    - geoportal/geomapfish_geoportal/locale/.*
+    - geoportal/geomapfish_geoportal/static/.*
+    - geoportal/geomapfish_geoportal/static-ngeo/.*
+    - print/print-apps/.*
+    - mapserver/.*
+    - tilegeneration/config\.yaml\.tmpl
+    - project\.yaml
+    - docker-compose\.yaml
+    - env\.project
+    - README\.rst
+    - \.github/workflows/main\.yaml
+    - \.github/workflows/rebuild\.yaml
+  exclude:
+    - mapserver/demo\.map\.tmpl
+    - geoportal/geomapfish_geoportal/static-ngeo/js/apps/image/favicon\.ico
+
+# Files ignored when creating the diff files => will just be left untouched.
+no_diff:
+  - .*\.po
+  - CONST_.+
+  - .*/CONST_.+
+
+# Files that will be present in the CONST_create_template but will not be considered in the upgrade.
+# Used to provide the alt applications => does not disturb the user during upgrade.
+extra:
+  - geoportal/geomapfish_geoportal/static-ngeo/js/apps/mobile_alt\.html\.ejs
+  - geoportal/geomapfish_geoportal/static-ngeo/js/apps/oeedit\.html\.ejs
+  - geoportal/geomapfish_geoportal/static-ngeo/js/apps/Controllermobile_alt\.js
+  - geoportal/geomapfish_geoportal/static-ngeo/js/apps/Controlleroeedit\.js
+  - geoportal/geomapfish_geoportal/static-ngeo/js/apps/sass/mobile_alt\.scss
+  - geoportal/geomapfish_geoportal/static-ngeo/js/apps/sass/vars_mobile_alt\.scss
+  - geoportal/geomapfish_geoportal/static-ngeo/js/apps/sass/oeedit\.scss
+  - geoportal/geomapfish_geoportal/static-ngeo/js/apps/sass/vars_oeedit\.scss
+  - geoportal/interfaces/desktop_alt\.html\.mako
+  - geoportal/geomapfish_geoportal/static/images/background-layer-button\.png
+  - tests/test_testapp.py
+
+# Automated file system operations:
+# Remove some files or directories:
+#  - action: remove
+#    paths:
+#      - <one file or directory>
+# Move a file:
+#  - action: move
+#    from: <src file>
+#    to: <dst file>
+upgrade_files:
+  - action: remove
+    paths:
+      - geoportal/tools/extract-messages.js
+  - action: move
+    from: geoportal/lingua-server.cfg
+    to: geoportal/lingva-server.cfg
+  - action: move
+    from: geoportal/lingua-client.cfg
+    to: geoportal/lingva-client.cfg

CONST_create_template/docker-compose-lib.yaml

@@ -82,6 +82,8 @@ services:
     environment:
       - PGOPTIONS
       - MAPSERVER_CONFIG_FILE=/etc/mapserver/mapserver.conf
+      - MAPSERVER_BASE_PATH=/mapserv_proxy
+      - OGCAPI_HTML_TEMPLATE_DIRECTORY=/usr/local/share/mapserver/ogcapi/templates/html-bootstrap4/
       - AWS_ACCESS_KEY_ID
       - AWS_SECRET_ACCESS_KEY
       - AWS_DEFAULT_REGION

CONST_create_template/env.default

@@ -1,5 +1,5 @@
 # Default values for c2cgeoportal
-GEOMAPFISH_VERSION=2.9.rc.10
+GEOMAPFISH_VERSION=2.9.rc.12
 GEOMAPFISH_MAIN_VERSION=2.9
 GEOMAPFISH_MAIN_MINOR_VERSION=2.9.0
 COMPOSE_PROJECT_NAME=geomapfish

CONST_create_template/geoportal/webpack.apps.js

@@ -23,7 +23,7 @@ for (const filename of ls(
       chunks: [name],
       vars: {
         entry_point: '${VISIBLE_ENTRY_POINT}',
-        version: '2.9.rc.10',
+        version: '2.9.rc.12',
         cache_version: '${CACHE_VERSION}',
       },
     })

CONST_create_template/tests/test_app.py

@@ -17,12 +17,47 @@
         ("https://front/c2c/health_check", {"checker": "check_collector"}, 2),
         ("https://front/admin/layertree", {}, 10),
         ("https://front/admin/layertree/children", {}, 10),
-        ("http://mapserver:8080/mapserv_proxy", {"SERVICE": "WMS", "REQUEST": "GetCapabilities"}, 60),
+        (
+            "http://mapserver:8080/mapserv_proxy/mapserver",
+            {"SERVICE": "WMS", "REQUEST": "GetCapabilities"},
+            60,
+        ),
         (
             "https://front/mapserv_proxy",
-            {"ogcserver": "source for image/png", "SERVICE": "WMS", "REQUEST": "GetCapabilities"},
+            {"ogcserver": "mapserver", "SERVICE": "WMS", "REQUEST": "GetCapabilities"},
             60,
         ),
+        # (
+        #     "http://qgisserver:8080/mapserv_proxy/",
+        #     {"SERVICE": "WMS", "REQUEST": "GetCapabilities", "MAP": "/etc/qgisserver/project.qgs"},
+        #     60,
+        # ),
+        # (
+        #     "https://front/mapserv_proxy",
+        #     {"ogcserver": "qgisserver", "SERVICE": "WMS", "REQUEST": "GetCapabilities"},
+        #     60,
+        # ),
+        # OGC API - Features
+        # (
+        #     "http://mapserver:8080/mapserv_proxy/mapserver/ogcapi/collections/osm_protected/items",
+        #     {"bbox": "6.0,46.0,7.0,47.0", "limit": "100"},
+        #     60,
+        # ),
+        # (
+        #     "https://front/mapserv_proxy/mapserver/mapserver/ogcapi/collections/osm_open/items",
+        #     {"bbox": "6.0,46.0,7.0,47.0", "limit": "100"},
+        #     60,
+        # ),
+        # (
+        #     "http://qgisserver:8080/mapserv_proxy/qgisserver/wfs3/collections/points/items",
+        #     {"map": "/etc/qgisserver/project.qgs", "bbox": "6.0,46.0,7.0,47.0", "limit": "100"},
+        #     60,
+        # ),
+        # (
+        #     "https://front/mapserv_proxy/qgisserver/wfs3/collections/points/items",
+        #     {"bbox": "6.0,46.0,7.0,47.0", "limit": "100"},
+        #     60,
+        # ),
     ],
 )
 def test_url(url: str, params: dict[str, str], timeout: int) -> None:

docker-compose-lib.yaml

@@ -82,6 +82,8 @@ services:
     environment:
       - PGOPTIONS
       - MAPSERVER_CONFIG_FILE=/etc/mapserver/mapserver.conf
+      - MAPSERVER_BASE_PATH=/mapserv_proxy
+      - OGCAPI_HTML_TEMPLATE_DIRECTORY=/usr/local/share/mapserver/ogcapi/templates/html-bootstrap4/
       - AWS_ACCESS_KEY_ID
       - AWS_SECRET_ACCESS_KEY
       - AWS_DEFAULT_REGION

env.default

@@ -1,5 +1,5 @@
 # Default values for c2cgeoportal
-GEOMAPFISH_VERSION=2.9.rc.10
+GEOMAPFISH_VERSION=2.9.rc.12
 GEOMAPFISH_MAIN_VERSION=2.9
 GEOMAPFISH_MAIN_MINOR_VERSION=2.9.0
 COMPOSE_PROJECT_NAME=geomapfish

env.project

@@ -63,7 +63,7 @@ AWS_DEFAULT_REGION=ch-dk-2
 AWS_S3_ENDPOINT=sos-ch-dk-2.exo.io
 
 # Set a strong password here for authentication on technical interfaces behind path /c2c
-C2C_SECRET=
+C2C_SECRET=1234
 # Or use connection via GitHub, see: https://camptocamp.github.io/c2cgeoportal/2.8/integrator/c2cwsgiutils.html#authentication
 C2C_AUTH_GITHUB_REPOSITORY=camptocamp/demo_geomapfish
 C2C_AUTH_GITHUB_ACCESS_TYPE=admin

geoportal/webpack.apps.js

@@ -23,7 +23,7 @@ for (const filename of ls(
       chunks: [name],
       vars: {
         entry_point: '${VISIBLE_ENTRY_POINT}',
-        version: '2.9.rc.10',
+        version: '2.9.rc.12',
         cache_version: '${CACHE_VERSION}',
       },
     })

mapserver/mapserver.conf

@@ -10,6 +10,7 @@ CONFIG
     # Map aliases
     #
     MAPS
+        MainPNG "/etc/mapserver/mapserver.map"
     END
 
 END

tests/test_app.py

@@ -15,17 +15,70 @@
         ("https://front/c2c/health_check", {}, 2),
         ("https://front/c2c/health_check", {"max_level": "1"}, 2),
         ("https://front/c2c/health_check", {"checker": "check_collector"}, 2),
-        ("http://mapserver:8080/mapserv_proxy", {"SERVICE": "WMS", "REQUEST": "GetCapabilities"}, 60),
+        # ("https://front/admin/layertree", {}, 10),
+        # ("https://front/admin/layertree/children", {}, 10),
         (
-            "https://front/mapserv_proxy",
-            {"ogcserver": "Main PNG", "SERVICE": "WMS", "REQUEST": "GetCapabilities"},
+            "http://mapserver:8080/mapserv_proxy/MainPNG",
+            {"SERVICE": "WMS", "REQUEST": "GetCapabilities"},
+            60,
+        ),
+        (
+            "http://mapserver:8080/mapserv_proxy/",
+            {"MAP": "MainPNG", "SERVICE": "WMS", "REQUEST": "GetCapabilities"},
             60,
         ),
+        # (
+        #     "https://front/mapserv_proxy",
+        #     {"ogcserver": "Main PNG", "SERVICE": "WMS", "REQUEST": "GetCapabilities"},
+        #     60,
+        # ),
+        # (
+        #     "https://front/mapserv_proxy/Main+PNG",
+        #     {"SERVICE": "WMS", "REQUEST": "GetCapabilities"},
+        #     60,
+        # ),
+        # QGIS Server
         (
             "https://front/mapserv_proxy",
             {"ogcserver": "QGIS server", "SERVICE": "WMS", "REQUEST": "GetCapabilities"},
             60,
         ),
+        # (
+        #     "https://front/mapserv_proxy/QGIS+server",
+        #     {"SERVICE": "WMS", "REQUEST": "GetCapabilities"},
+        #     60,
+        # ),
+        # (
+        #     "http://qgisserver:8080/mapserv_proxy/",
+        #     {"SERVICE": "WMS", "REQUEST": "GetCapabilities", "MAP": "/etc/qgisserver/project.qgs"},
+        #     60,
+        # ),
+        # (
+        #     "https://front/mapserv_proxy",
+        #     {"ogcserver": "qgisserver", "SERVICE": "WMS", "REQUEST": "GetCapabilities"},
+        #     60,
+        # ),
+        # OGC API - Features
+        # (
+        #     "http://mapserver:8080/mapserv_proxy/mapserver/ogcapi/collections/osm_protected/items",
+        #     {"bbox": "6.0,46.0,7.0,47.0", "limit": "100"},
+        #     60,
+        # ),
+        # (
+        #     "https://front/mapserv_proxy/mapserver/mapserver/ogcapi/collections/osm_open/items",
+        #     {"bbox": "6.0,46.0,7.0,47.0", "limit": "100"},
+        #     60,
+        # ),
+        # (
+        #     "http://qgisserver:8080/mapserv_proxy/qgisserver/wfs3/collections/points/items",
+        #     {"map": "/etc/qgisserver/project.qgs", "bbox": "6.0,46.0,7.0,47.0", "limit": "100"},
+        #     60,
+        # ),
+        # (
+        #     "https://front/mapserv_proxy/qgisserver/wfs3/collections/points/items",
+        #     {"bbox": "6.0,46.0,7.0,47.0", "limit": "100"},
+        #     60,
+        # ),
     ],
 )
 def test_url(url: str, params: dict[str, str], timeout: int) -> None:

upgrade

@@ -0,0 +1,143 @@
+#!/usr/bin/env python3
+
+# Copyright (c) 2019-2024, Camptocamp SA
+# All rights reserved.
+
+# Redistribution and use in source and binary forms, with or without
+# modification, are permitted provided that the following conditions are met:
+
+# 1. Redistributions of source code must retain the above copyright notice, this
+#    list of conditions and the following disclaimer.
+# 2. Redistributions in binary form must reproduce the above copyright notice,
+#    this list of conditions and the following disclaimer in the documentation
+#    and/or other materials provided with the distribution.
+
+# THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" AND
+# ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED
+# WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
+# DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT OWNER OR CONTRIBUTORS BE LIABLE FOR
+# ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES
+# (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES;
+# LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND
+# ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
+# (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS
+# SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
+
+# The views and conclusions contained in the software and documentation are those
+# of the authors and should not be interpreted as representing official policies,
+# either expressed or implied, of the FreeBSD Project.
+
+
+import argparse
+import os
+import platform
+import re
+import subprocess
+import sys
+
+parser = argparse.ArgumentParser(description="Upgrade the project")
+parser.add_argument(
+    "--debug", help="Path to c2cgeoportal source folder to be able to debug the upgrade procedure"
+)
+parser.add_argument("version", help="the version to upgrade to (master or x.y.z)")
+parser.add_argument("step", nargs="?", help="the step to run")
+parser_finalize = argparse.ArgumentParser(description="Upgrade the project", add_help=False)
+parser_finalize.add_argument("--finalize", action="store_true", help="finalize the upgrade")
+parser_finalize.add_argument("--help", action="help", help="show this help message and exit")
+parser_finalize.add_argument("build_arg", nargs="*", help="build arguments")
+
+if len(sys.argv) >= 2 and sys.argv[1] == "--finalize":
+    args = parser_finalize.parse_args()
+
+    if platform.system() == "Windows":
+        code = subprocess.call(["python", "build"] + args.build_arg)
+    else:
+        code = subprocess.call(["./build"] + args.build_arg)
+    if code != 0:
+        sys.exit(code)
+
+    subprocess.call(["docker", "compose", "down", "--remove-orphans"])
+    subprocess.call(
+        ["docker", "compose", "pull", "--ignore-pull-failures"],
+        env={**os.environ, "DOCKER_TAG": "unexisting"},
+    )
+    subprocess.check_call(["docker", "compose", "up", "-d"])
+    subprocess.check_call(
+        [
+            "docker",
+            "compose",
+            "exec",
+            "geoportal",
+            "alembic",
+            "--name=main",
+            "--config=alembic.ini",
+            "upgrade",
+            "head",
+        ]
+    )
+
+else:
+    args = parser.parse_args()
+
+    c2cupgrade_args = ["--step", args.step] if args.step is not None else []
+
+    if os.environ.get("CI") != "true" and args.step is None:
+        major_version = args.version
+        match = re.match(r"^([0-9]+\.[0-9]+)\.[0-9]+$", args.version)
+        if match is not None:
+            major_version = match.group(1)
+        match = re.match(r"^([0-9]+\.[0-9]+)\.[0-9a-z]+\.[0-9]+$", args.version)
+        if match is not None:
+            major_version = match.group(1)
+        if not args.debug:
+            subprocess.check_call(
+                [
+                    "docker",
+                    "pull",
+                    f"camptocamp/geomapfish:{major_version}",
+                ]
+            )
+            subprocess.check_call(["docker", "pull", f"camptocamp/geomapfish-tools:{args.version}"])
+            subprocess.check_call(
+                [
+                    "docker",
+                    "pull",
+                    f"camptocamp/geomapfish-config:{major_version}",
+                ]
+            )
+
+    debug_volumes = (
+        [
+            "--volume={debug}/geoportal/c2cgeoportal_geoportal/scripts/c2cupgrade.py:".format(
+                debug=args.debug
+            ),
+            "/opt/c2cgeoportal/geoportal/c2cgeoportal_geoportal/scripts/c2cupgrade.py",
+        ]
+        if args.debug
+        else []
+    )
+
+    win = platform.system() == "Windows"
+    sys.exit(
+        subprocess.call(
+            [
+                "docker",
+                "run",
+                "--rm",
+                "--env=CI",
+                f"--volume={os.getcwd()}:/src",
+            ]
+            + debug_volumes
+            + [
+                f"camptocamp/geomapfish-tools:{args.version}",
+                "run-git",
+                subprocess.check_output(["git", "config", "--get", "user.name"]).decode().strip(),
+                subprocess.check_output(["git", "config", "--get", "user.email"]).decode().strip(),
+                "" if win else subprocess.check_output(["id", "-u"]).decode().strip(),
+                "" if win else subprocess.check_output(["id", "-g"]).decode().strip(),
+                "/src",
+                "c2cupgrade",
+            ]
+            + c2cupgrade_args
+        )
+    )