Add acceptance tests of the demo application, document the workflows

camptocamp · Jul 4, 2022 · 5bdd328 · 5bdd328
1 parent 68588cb
commit 5bdd328
Show file tree

Hide file tree

Showing 17 changed files with 372 additions and 161 deletions.
diff --git a/ci/create-new-project b/ci/create-new-project
@@ -1,5 +1,7 @@
 #!/bin/bash -eux
 
+echo ::group::Create the project
+
 TAG=$(scripts/get-version --major)
 DOCKER_TAG=${TAG} make build-tools
 DOCKER_TAG=${TAG} make build-runner
@@ -37,8 +39,6 @@ if [ $BASE_APP != true ]; then
     mv ${WORKSPACE}/${PACKAGE}/geoportal/vars.yaml ${WORKSPACE}/${PACKAGE}/geoportal/vars_origin.yaml
     cp ci/vars.yaml ${WORKSPACE}/${PACKAGE}/geoportal/
     mkdir -p ${WORKSPACE}/${PACKAGE}/geoportal/ci
-    cp ci/waitwsgi ${WORKSPACE}/${PACKAGE}/geoportal/ci
-    cp ci/test-new-project ${WORKSPACE}/${PACKAGE}/geoportal/ci
     mkdir -p ${WORKSPACE}/${PACKAGE}/ci
     echo "PGSSLMODE=prefer" >> ${WORKSPACE}/${PACKAGE}/env.project
 fi
@@ -75,12 +75,15 @@ git add --all
 git commit --quiet --message='Initial commit'
 
 mv ci/config.yaml{,_}
+echo ::endgroup::
 c2cciutils-checks --fix --check=isort
 c2cciutils-checks --fix --check=black
 c2cciutils-checks --fix --check=prettier
 mv ci/config.yaml{_,}
 
+echo ::group::Diff
 git --no-pager diff
+echo ::endgroup::
 git add --all
 git commit --quiet --message='Format'
 git clean -fX
diff --git a/ci/test-app b/ci/test-app
@@ -3,8 +3,9 @@
 rm -rf "${HOME}/workspace/testgeomapfishapp"
 
 ci/create-new-project "${HOME}/workspace"
+
+# Copy the files needed to run the tests
 cp ci/docker-compose.override.yaml "${HOME}/workspace/testgeomapfishapp/"
-cp ci/waitwsgi "${HOME}/workspace/testgeomapfishapp/ci/"
 cp ci/empty.qgz "${HOME}/workspace/testgeomapfishapp/qgisserver/project.qgz"
 cp -r ci/test-app-db "${HOME}/workspace/testgeomapfishapp/ci/"
 cp -r ci/test-external-db "${HOME}/workspace/testgeomapfishapp/ci/"
@@ -14,12 +15,21 @@ cd "${HOME}/workspace/testgeomapfishapp/"
 
 folder=geoportal/interfaces
 cp -r CONST_create_template/${folder} ${folder}
+file=tests/test_testapp.py
+cp CONST_create_template/${file} ${file}
 
+# Check if the `c2cciutils-checks` pass
 c2cciutils-checks
 cp "${PROJECT_DIR}/ci/project-config.yaml" ci/config.yaml
 c2cciutils-checks
+
+# Build
+echo ::group::Build
 CI=true ./build
+echo ::endgroup::
 
+# Lint
+echo ::group::Lint
 docker-compose run --entrypoint= --no-deps --rm --volume=$(pwd)/geoportal:/app geoportal \
     prospector --output-format=pylint --die-on-tool-error
 docker-compose run --entrypoint= --no-deps --rm --volume=$(pwd)/geoportal:/app geoportal \
@@ -28,69 +38,124 @@ docker-compose run --entrypoint= --no-deps --rm --volume=$(pwd)/geoportal:/app g
     eslint $(find testgeomapfishapp -type f -name '*.ts' -print 2> /dev/null)
 
 docker-compose down --volumes
+echo ::endgroup::
+
+# Start
+echo ::group::Start
 docker-compose up -d
 docker-compose exec -T geoportal bash -c 'PGHOST=externaldb PGDATABASE=test wait-db;'
 docker-compose exec -T geoportal wait-db
-docker-compose ps
+echo ::endgroup::
+c2cciutils-docker-logs
+
+# Run alembic
+echo ::group::Run alembic
 docker-compose exec -T geoportal alembic --config=alembic.ini --name=main upgrade head
 docker-compose exec -T geoportal alembic --config=alembic.ini --name=static upgrade head
+docker-compose start alembic
+echo ::endgroup::
+c2cciutils-docker-logs
+
+# Create the Theme
+echo ::group::Create the Theme
 docker-compose exec -T geoportal create-demo-theme
+echo ::endgroup::
 c2cciutils-docker-logs
+
+# Test `theme2fts`
+echo ::group::Test theme2fts
 docker-compose exec -T geoportal theme2fts
+echo ::endgroup::
+
+# Test `update-po`
+echo ::group::Test update-po
 make update-po
+echo ::endgroup::
 
-docker-compose exec -T geoportal ci/waitwsgi https://front/themes
-for path in c2c/health_check c2c/health_check?max_level=9 c2c/health_check?checks=check_collector "layers/test/values/type enum" admin/layertree admin/layertree/children; do
-    docker-compose exec -T geoportal ci/test-new-project https://front/${path}
+# Test the checker and QGIS
+echo ::group::Test the checker and QGIS
+for url in 'https://front/c2c/health_check?max_level=9' 'http://qgisserver:8080/mapserv_proxy?SERVICE=WMS&REQUEST=GetCapabilities'; do
+    docker-compose exec -T geoportal curl --fail --insecure "${url}" \
+        || (docker-compose exec -T geoportal curl --insecure "${url}" && false)
 done
-docker-compose exec -T geoportal ci/test-new-project 'http://qgisserver:8080/mapserv_proxy?SERVICE=WMS&REQUEST=GetCapabilities'
-docker-compose exec -T geoportal curl --insecure https://front/admin/ | grep Login
-docker-compose exec -T geoportal curl --insecure 'https://front/dynamic.json?interface=desktop&query=&path=%2F'
-docker-compose exec -T geoportal curl --insecure https://front/static-geomapfish/0/locales/fr.json
-docker-compose exec -T geoportal curl --insecure https://front/desktop_alt
-docker-compose exec -T geoportal curl --insecure https://front/desktop_alt \
-    | grep '<script src="https://front/static-ngeo-dist/desktop\..*\.js" crossorigin="anonymous"></script>'
-docker-compose exec -T geoportal curl --insecure https://front/desktop_alt \
-    | grep '<html lang="{{mainCtrl.lang}}" '
-
-function test_pot {
-    docker-compose exec -T geoportal curl --insecure https://front/locale.pot --output /tmp/locale.pot
-    docker-compose exec -T geoportal cat /tmp/locale.pot > /tmp/locale.pot
-    if [ "$(wc -l < /tmp/locale.pot)" -eq "$(wc -l < geoportal/testgeomapfishapp_geoportal/locale/testgeomapfishapp_geoportal-client.pot)" ]; then
-        echo 'View locale.pot match in size with update-po'
-    else
-        echo 'Error: View locale.pot does not match in size with update-po'
-        sed -i 's%/app/%./geoportal/%g' /tmp/locale.pot
-        diff geoportal/testgeomapfishapp_geoportal/locale/testgeomapfishapp_geoportal-client.pot /tmp/locale.pot
-        exit 1
-    fi
-}
-test_pot
-# A second time to check that the initialisation is working
-test_pot
+echo ::endgroup::
 
+# Test the `proutes` and `pviews` commands
+echo ::group::Test the proutes command with development.ini
 docker-compose exec -T geoportal proutes c2c://development.ini
+echo ::endgroup::
+echo ::group::Test the pviews command with development.ini
 docker-compose exec -T geoportal pviews c2c://development.ini /
+echo ::endgroup::
+echo ::group::Test the proutes command with production.ini
 docker-compose exec -T geoportal proutes c2c://production.ini
+echo ::endgroup::
+echo ::group::Test the pviews command with production.ini
 docker-compose exec -T geoportal pviews c2c://production.ini /
+echo ::endgroup::
 
-docker-compose stop qgisserver
-docker-compose exec -T geoportal alembic --config=alembic.ini --name=static downgrade base
-docker-compose exec -T geoportal alembic --config=alembic.ini --name=main downgrade base
-
+# Test the `db-backup` and `db-restore` commands
+echo ::group::Test the db-backup command
 cp .env env.int
 echo PGHOST_SLAVE="$(ip -4 addr show docker0 | grep -Po 'inet \K[\d.]+')" >> env.int
 echo PGPORT_SLAVE=54321 >> env.int
 scripts/db-backup --env=env.int dump.backup
-scripts/db-backup --env=env.int --arg=--schema=main dump.backup
+scripts/db-backup --env=env.int --arg=--schema=main main-dump.backup
+echo ::endgroup::
+
+echo ::group::Test the db-restore command
 docker-compose exec -T tools psql --command="ALTER SCHEMA main RENAME TO main_old"
 docker-compose exec -T tools psql --command="CREATE SCHEMA main"
 scripts/db-restore --arg=--schema=main dump.backup
+echo ::endgroup::
 
+# Empty the database
+echo ::group::Empty the database
+docker-compose exec -T geoportal alembic --config=alembic.ini --name=static downgrade base
+docker-compose exec -T geoportal alembic --config=alembic.ini --name=main downgrade base
+echo ::endgroup::
+
+# Test the `mappyfile validate` command
+echo ::group::Test the mappyfile validate command
 docker-compose exec -T tools rm /etc/mapserver/demo.map
 docker-compose exec -T tools mappyfile validate --version=7.6 /etc/mapserver/*.map
+echo ::endgroup::
 c2cciutils-docker-logs
+
+# Run the acceptances tests
+echo ::group::Stop
 docker-compose down
-sudo rm -rf "${HOME}/workspace/testgeomapfishapp"
+mv docker-compose.override.yaml docker-compose.test.yaml
+echo ::endgroup::
+
+echo ::group::Init acceptance tests
+make acceptance-init
+docker-compose \
+    --file=docker-compose.yaml \
+    --file=docker-compose-db.yaml \
+    --file=docker-compose.test.yaml up -d
+echo ::endgroup::
+c2cciutils-docker-logs
+
+echo ::group::Run acceptance tests
+make acceptance
+echo ::endgroup::
+c2cciutils-docker-logs
 
+echo ::group::Run acceptance tests in dev mode
+docker-compose \
+    --file=docker-compose.yaml \
+    --file=docker-compose-db.yaml \
+    --file=docker-compose.test.yaml \
+    --file=docker-compose.override.sample.yaml up -d
+make acceptance
+echo ::endgroup::
+c2cciutils-docker-logs
+
+# Remove the test project
+echo ::group::Remove the test project
+docker-compose down --remove-orphans || true
+cd -
+sudo rm -rf "${HOME}/workspace/testgeomapfishapp"
 docker rmi camptocamp/testgeomapfishapp-config:latest
+echo ::endgroup::
diff --git a/ci/test-new-project b/ci/test-new-project
diff --git a/ci/waitwsgi b/ci/waitwsgi
diff --git a/doc/integrator/create_application.rst b/doc/integrator/create_application.rst
@@ -294,7 +294,56 @@ Then follow the sections in the install application guide:
 Dynamic configuration
 ---------------------
 
-Several files are generated on runtime, their content depending of the variables you
+Several files are generated on runtime, their content depending on the variables you
 have set as environment variables.
 
 The files can have the extension ``.tmpl`` and it use bash syntax (``${VARIABLE}``).
+
+GitHub workflows
+----------------
+
+With the application we have some predefined workflows.
+
+`.github/workflows/main.yaml`
+.............................
+
+The workflow that will run on all your commits, he will:
+- Run some code style checks on your code.
+- Build you application.
+- Run the acceptance tests (if configured).
+- Publish the application on DockerHub.
+- Trigger another workflow (on ArgoCD repository) to deploy you new application.
+
+`.github/workflows/rebuild.yaml`
+................................
+
+This workflow run on each night to rebuild the application with the new version of the base images.
+
+Be careful, GitHub will read only the file present on the main branch.
+
+`.github/workflows/update_l10n.yaml`
+....................................
+
+This workflow will query the `locale.pot` view, using `PROJECT_PUBLIC_URL` found in `Makefile`,
+and open a pull request to update the localization files (`.po`) with current list of translatable strings.
+
+Be careful, GitHub will read only the file present on the main branch.
+
+Acceptance tests
+................
+
+To have some acceptance tests you need to have a minimal dump of your database in the repository,
+it can be obtained with:
+
+.. prompt:: bash
+
+    scripts/db-backup --arg=--schema=<schema> ../dump.backup
+
+In the `Makefile` you should configure the dump file as `DUMP_FILE`, the `db-restore` call in `acceptance-init`
+should probably also be updated.
+
+In the file `.github/workflows/main.yaml` you should uncomment all the lines related to the
+acceptance tests.
+
+The acceptance tests will test that we didn't have any service in error, test the response of some URL,
+see in the file `tests/test_app.py`.