use MSC_PYGEOAPI_OGC_API_URL for OpenAPI document (#311)

* use MSC_PYGEOAPI_OGC_API_URL for OpenAPI document

* add tests/CI

.github/workflows/main.yml

@@ -30,4 +30,6 @@ jobs:
     - name: Install package 📦
       run: python3 setup.py install
     - name: run tests ⚙️
-      run: pytest -k test_loader
+      run: |
+        pytest -k test_loader
+        pytest tests/test_openapi_document.py

debian/postinst

@@ -31,7 +31,7 @@
 export MSC_PYGEOAPI_ES_TIMEOUT=90
 export MSC_PYGEOAPI_ES_URL=http://localhost:9200
 export MSC_PYGEOAPI_CACHEDIR=/tmp
-export MSC_PYGEOAPI_OGC_API_URL=https://api.wxod-dev.cmc.ec.gc.ca/
+export MSC_PYGEOAPI_OGC_API_URL=https://api.wxod-dev.cmc.ec.gc.ca
 export MSC_PYGEOAPI_OGC_API_URL_BASEPATH=/
 export MSC_PYGEOAPI_METPX_EVENT_FILE_PY=/opt/msc-pygeoapi/event/file_.py
 export MSC_PYGEOAPI_METPX_EVENT_MESSAGE_PY=/opt/msc-pygeoapi/event/message.py

deploy/default/msc-pygeoapi.wsgi

@@ -48,7 +48,7 @@ import os
 os.environ['PYGEOAPI_CONFIG'] = '/opt/msc-pygeoapi/conf/msc-pygeoapi-config.yml'
 os.environ['PYGEOAPI_OPENAPI'] = '/opt/msc-pygeoapi/conf/msc-pygeoapi-openapi.yml'
 os.environ['MSC_PYGEOAPI_ES_URL'] = 'http://localhost:9200'
-os.environ['MSC_PYGEOAPI_OGC_API_URL'] = 'https://api.wxod-dev.cmc.ec.gc.ca/'
+os.environ['MSC_PYGEOAPI_OGC_API_URL'] = 'https://api.wxod-dev.cmc.ec.gc.ca'
 os.environ['MSC_PYGEOAPI_OGC_API_URL_BASEPATH'] = '/'
 os.environ['MSC_PYGEOAPI_LOCALE'] = '/opt/msc-pygeoapi/locale'
 os.environ['MSC_PYGEOAPI_TEMPLATES'] = '/opt/msc-pygeoapi/theme/templates'

deploy/nightly/deploy-nightly.sh

@@ -78,7 +78,6 @@ mkdir schemas.opengis.net
 curl -O http://schemas.opengis.net/SCHEMAS_OPENGIS_NET.zip && unzip ./SCHEMAS_OPENGIS_NET.zip "ogcapi/*" -d schemas.opengis.net && rm -f ./SCHEMAS_OPENGIS_NET.zip
 
 cp msc-pygeoapi/deploy/default/msc-pygeoapi-config.yml msc-pygeoapi/deploy/nightly
-sed -i "s#https://api.wxod-dev.cmc.ec.gc.ca/#$MSC_PYGEOAPI_OGC_API_URL#g" msc-pygeoapi/deploy/nightly/msc-pygeoapi-config.yml
 sed -i 's#basepath: /#basepath: /msc-pygeoapi/nightly/latest#' msc-pygeoapi/deploy/nightly/msc-pygeoapi-config.yml
 sed -i 's^# cors: true^cors: true^' msc-pygeoapi/deploy/nightly/msc-pygeoapi-config.yml
 

deploy/nightly/msc-pygeoapi.wsgi

@@ -49,7 +49,7 @@ import sys
 os.environ['PYGEOAPI_CONFIG'] = '/data/web/msc-pygeoapi-nightly/latest/msc-pygeoapi/deploy/nightly/msc-pygeoapi-config.yml'
 os.environ['PYGEOAPI_OPENAPI'] = '/data/web/msc-pygeoapi-nightly/latest/msc-pygeoapi/deploy/nightly/msc-pygeoapi-openapi.yml'
 os.environ['MSC_PYGEOAPI_ES_URL'] = 'http://localhost:9200'
-os.environ['MSC_PYGEOAPI_OGC_API_URL'] = 'https://geomet-dev-03-nightly.cmc.ec.gc.ca/msc-pygeoapi/nightly/latest/'
+os.environ['MSC_PYGEOAPI_OGC_API_URL'] = 'https://geomet-dev-03-nightly.cmc.ec.gc.ca/msc-pygeoapi/nightly/latest'
 os.environ['MSC_PYGEOAPI_OGC_API_URL_BASEPATH'] = '/'
 os.environ['MSC_PYGEOAPI_TEMPLATES'] = '/data/web/msc-pygeoapi-nightly/latest/msc-pygeoapi/theme/templates'
 os.environ['MSC_PYGEOAPI_STATIC'] = '/data/web/msc-pygeoapi-nightly/latest/msc-pygeoapi/theme/static'

msc-pygeoapi.env

@@ -6,7 +6,7 @@ export MSC_PYGEOAPI_ES_TIMEOUT=90
 #export MSC_PYGEOAPI_ES_PASSWORD=bar
 export MSC_PYGEOAPI_ES_URL=http://${MSC_PYGEOAPI_ES_USERNAME}:${MSC_PYGEOAPI_ES_PASSWORD}@localhost:9200
 export MSC_PYGEOAPI_CACHEDIR=/tmp
-export MSC_PYGEOAPI_OGC_API_URL=https://api.wxod-dev.cmc.ec.gc.ca/
+export MSC_PYGEOAPI_OGC_API_URL=https://api.wxod-dev.cmc.ec.gc.ca
 export MSC_PYGEOAPI_OGC_API_URL_BASEPATH=/
 export MSC_PYGEOAPI_METPX_EVENT_FILE_PY=/opt/msc-pygeoapi/event/file_.py
 export MSC_PYGEOAPI_METPX_EVENT_MESSAGE_PY=/opt/msc-pygeoapi/event/message.py

tests/test_openapi_document.py

@@ -0,0 +1,47 @@
+# =================================================================
+#
+# Author: Tom Kralidis <tom.kralidis@ec.gc.ca>
+#
+# Copyright (c) 2023 Tom Kralidis
+#
+# Permission is hereby granted, free of charge, to any person
+# obtaining a copy of this software and associated documentation
+# files (the "Software"), to deal in the Software without
+# restriction, including without limitation the rights to use,
+# copy, modify, merge, publish, distribute, sublicense, and/or sell
+# copies of the Software, and to permit persons to whom the
+# Software is furnished to do so, subject to the following
+# conditions:
+#
+# The above copyright notice and this permission notice shall be
+# included in all copies or substantial portions of the Software.
+#
+# THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
+# EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES
+# OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
+# NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT
+# HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY,
+# WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING
+# FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR
+# OTHER DEALINGS IN THE SOFTWARE.
+#
+# =================================================================
+
+import pytest
+
+from util import get_test_file_path
+
+
+@pytest.fixture()
+def openapi_config():
+    openapi_document = '../deploy/default/msc-pygeoapi-openapi.yml'
+    with open(get_test_file_path(openapi_document)) as fh:
+        return fh.read()
+
+
+def test_openapi_config(openapi_config):
+    """Test OpenAPI document"""
+
+    assert 'https://api.w' not in openapi_config
+    assert 'url: ${MSC_PYGEOAPI_OGC_API_URL}' in openapi_config
+    assert '$ref: ${MSC_PYGEOAPI_OGC_API_URL}' in openapi_config