bird-house · mishaschwartz · Apr 12, 2023 · Mar 24, 2023 · Mar 24, 2023 · Mar 24, 2023
@@ -1,5 +1,5 @@
 [bumpversion]
-current_version = 1.25.3
+current_version = 1.25.4
 commit = True
 tag = False
 tag_name = {new_version}
@@ -30,11 +30,11 @@ search = {current_version}
 replace = {new_version}
 
 [bumpversion:file:RELEASE.txt]
-search = {current_version} 2023-04-12T21:49:10Z
+search = {current_version} 2023-04-12T22:02:31Z
 replace = {new_version} {utcnow:%Y-%m-%dT%H:%M:%SZ}
 
 [bumpversion:part:releaseTime]
-values = 2023-04-12T21:49:10Z
+values = 2023-04-12T22:02:31Z
 
 [bumpversion:file(version):birdhouse/config/canarie-api/docker_configuration.py.template]
 search = 'version': '{current_version}'

@@ -0,0 +1,21 @@
+name: Unit tests
+on:
+  pull_request:
+    types: [opened, synchronize, reopened, ready_for_review]
+jobs:
+  test:
+    if: github.event.pull_request.draft == false
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v3
+      - name: Set up python for testing
+        uses: actions/setup-python@v4
+        with:
+          python-version: "3.11"
+          cache: 'pip'
+      - name: Install python test dependencies
+        run: |
+          pip install -r ./tests/requirements.txt
+      - name: Test with pytest
+        run: |
+          pytest ./tests/
@@ -23,3 +23,9 @@ ubuntu-bionic-18.04-cloudimg-console.log
 ## Python temp files
 **/__pycache__
 **/*.py[cod]
+
+## Virtual environments
+venv/
+
+## Testing
+.pytest_cache/
@@ -1,3 +1,4 @@
+
 # Changes
 
 [//]: # (NOTES:)
@@ -16,6 +17,94 @@
 
 [//]: # (list changes here, using '-' for each new entry, remove this when items are added)
 
+[1.25.4](https://github.com/bird-house/birdhouse-deploy/tree/1.25.4) (2023-04-12)
+------------------------------------------------------------------------------------------------------------------
+
+## Fixes
+- Enforce the load order of components defined in env.local
+
+  Extra components defined in the `EXTRA_CONF_DIRS` variables were being loaded before the dependant components
+  defined in the `COMPONENT_DEPENDENCIES` variables in each default.env file. This meant that if an extra component
+  was meant to override some setting defined in a dependant component, the setting would not be overridden by the
+  extra component. 
+
+  This change enforces the following load order rules:
+
+  - components defined in `DEFAULT_CONF_DIRS` are loaded before those in `EXTRA_CONF_DIRS`
+  - components are loaded in the order they appear in either `DEFAULT_CONF_DIRS` or `EXTRA_CONF_DIRS`
+  - components that appear in `COMPONENT_DEPENDENCIES` variable are immediately loaded unless they have already been
+    loaded
+
+  For example, with the following files in place:
+
+  ```shell
+  # env.local
+  DEFAULT_CONF_DIRS="
+    ./config/twitcher
+    ./config/project-api
+    ./config/magpie
+  "
+  EXTRA_CONF_DIRS="
+    ./optional-components/generic_bird
+    ./components/cowbird
+  "
+
+  # config/twitcher/default.env
+  COMPONENT_DEPENDENCIES="
+    ./config/magpie
+  "
+  # optional-components/generic_bird/default.env
+  COMPONENT_DEPENDENCIES="
+    ./config/wps_outputs-volume
+  "
+  ```
+
+  the load order is:
+
+  - ./config/magpie (loaded as a dependency of twitcher, not loaded a second time after project-api)
+  - ./config/twitcher
+  - ./config/project-api
+  - ./config/wps_outputs-volume (loaded as a dependency of generic_bird)
+  - ./optional-components/generic_bird
+  - ./components/cowbird
+
+  This load order also applies to the order that docker-compose-extra.yml files are specified. If a component also
+  includes an override file for another component (eg: ./config/finch/config/proxy/docker-compose-extra.yml overrides 
+  ./config/proxy/docker-compose-extra.yml), the following additional load order rules apply:
+
+  - if the component that is being overridden has already been loaded, the override file is loaded immediately
+  - otherwise, the override files will be loaded immediately after the component that is being overridden has been loaded
+
+  For example, with the following files in place:
+
+    ```shell
+  # env.local
+  DEFAULT_CONF_DIRS="
+    ./config/finch
+    ./config/proxy
+  "
+  ```
+  ```yaml
+  # config/proxy/docker-compose-extra.yml
+    ...
+  # config/finch/docker-compose-extra.yml
+    ...
+  # config/finch/config/proxy/docker-compose-extra.yml
+    ...
+  ```
+
+  the docker compose files will be loaded in the following order: 
+
+  - config/finch/docker-compose-extra.yml
+  - config/proxy/docker-compose-extra.yml
+  - config/finch/config/proxy/docker-compose-extra.yml
+
+- Add tests to ensure override capabilities are preserved which allows all default
+  behaviors of the platform can be customized.
+
+  See [birdhouse/README.rst](birdhouse/README.rst) for instruction to run the
+  tests.
+
 [1.25.3](https://github.com/bird-house/birdhouse-deploy/tree/1.25.3) (2023-04-12)
 ------------------------------------------------------------------------------------------------------------------
 

@@ -1,7 +1,7 @@
 # Generic variables
 override SHELL       := bash
 override APP_NAME    := birdhouse-deploy
-override APP_VERSION := 1.25.3
+override APP_VERSION := 1.25.4
 
 # utility to remove comments after value of an option variable
 override clean_opt = $(shell echo "$(1)" | $(_SED) -r -e "s/[ '$'\t'']+$$//g")

@@ -14,13 +14,13 @@ for a full-fledged production platform.
     * - releases
       - | |latest-version| |commits-since|
 
-.. |commits-since| image:: https://img.shields.io/github/commits-since/bird-house/birdhouse-deploy/1.25.3.svg
+.. |commits-since| image:: https://img.shields.io/github/commits-since/bird-house/birdhouse-deploy/1.25.4.svg
     :alt: Commits since latest release
-    :target: https://github.com/bird-house/birdhouse-deploy/compare/1.25.3...master
+    :target: https://github.com/bird-house/birdhouse-deploy/compare/1.25.4...master
 
-.. |latest-version| image:: https://img.shields.io/badge/tag-1.25.3-blue.svg?style=flat
+.. |latest-version| image:: https://img.shields.io/badge/tag-1.25.4-blue.svg?style=flat
     :alt: Latest Tag
-    :target: https://github.com/bird-house/birdhouse-deploy/tree/1.25.3
+    :target: https://github.com/bird-house/birdhouse-deploy/tree/1.25.4
 
 .. |readthedocs| image:: https://readthedocs.org/projects/birdhouse-deploy/badge/?version=latest
     :alt: ReadTheDocs Build Status (latest version)

@@ -1 +1 @@
-1.25.3 2023-04-12T21:49:10Z
+1.25.4 2023-04-12T22:02:31Z
@@ -202,6 +202,18 @@ Starting and managing the lifecycle of the VM:
    vagrant provision
 
 
+Framework tests
+---------------
+
+Core features of the platform has tests to prevent regressions.
+
+To run the tests:
+
+.. code-block:: shell
+    python3 -m pip install -r tests/requirements.txt
+    pytest tests/
+
+
 Tagging policy
 --------------
 

@@ -5,7 +5,6 @@ export PROXY_IMAGE="pavics/canarieapi:0.3.5"
 
 # add any component that this component requires to run
 COMPONENT_DEPENDENCIES="
-  $COMPONENT_DEPENDENCIES
   ./config/proxy
 "
 
@@ -17,8 +17,8 @@ SERVICES = {
         'info': {
             'name': 'Node',
             'synopsis': 'Nodes are data, compute and index endpoints accessed through the PAVICS platform or external clients. The Node service is the backend that allows: data storage, harvesting, indexation and discovery of local and federated data; authentication and authorization; server registration and management. Node service is therefore composed of several other services.',
-            'version': '1.25.3',
-            'releaseTime': '2023-04-12T21:49:10Z',
+            'version': '1.25.4',
+            'releaseTime': '2023-04-12T22:02:31Z',
             'institution': 'Ouranos',
             'researchSubject': 'Climatology',
             'supportEmail': '${SUPPORT_EMAIL}',
@@ -47,8 +47,8 @@ PLATFORMS = {
         'info': {
             'name': 'PAVICS',
             'synopsis': 'The PAVICS (Power Analytics for Visualization of Climate Science) platform is a collection of climate analysis services served through Open Geospatial Consortium (OGC) protocols. These services include data access, processing and visualization. Both data and algorithms can be accessed either programmatically, through OGC-compliant clients such as QGIS or ArcGIS, or a custom web interface.',
-            'version': '1.25.3',
-            'releaseTime': '2023-04-12T21:49:10Z',
+            'version': '1.25.4',
+            'releaseTime': '2023-04-12T22:02:31Z',
             'institution': 'Ouranos',
             'researchSubject': 'Climatology',
             'supportEmail': '${SUPPORT_EMAIL}',

@@ -26,6 +26,5 @@ VARS="
 
 # add any component that this component requires to run
 COMPONENT_DEPENDENCIES="
-  $COMPONENT_DEPENDENCIES
   ./config/postgres
 "
@@ -24,7 +24,6 @@ export WEAVER_WPS_PROVIDERS="
 
 # add any component that this component requires to run
 COMPONENT_DEPENDENCIES="
-  $COMPONENT_DEPENDENCIES
   ./config/wps_outputs-volume
   ./config/postgres
 "
@@ -17,7 +17,6 @@ export WEAVER_WPS_PROVIDERS="
 
 # add any component that this component requires to run
 COMPONENT_DEPENDENCIES="
-  $COMPONENT_DEPENDENCIES
   ./config/postgres
   ./config/wps_outputs-volume
 "
@@ -1,7 +1,6 @@
 
 # add any component that this component requires to run
 COMPONENT_DEPENDENCIES="
-  $COMPONENT_DEPENDENCIES
   ./config/ncwms2
   ./config/catalog
   ./config/malleefowl

@@ -16,7 +16,6 @@ export WEAVER_WPS_PROVIDERS="
 
 # add any component that this component requires to run
 COMPONENT_DEPENDENCIES="
-  $COMPONENT_DEPENDENCIES
   ./config/postgres
   ./config/wps_outputs-volume
   ./config/data-volume

@@ -67,6 +67,5 @@ OPTIONAL_VARS="
 
 # add any component that this component requires to run
 COMPONENT_DEPENDENCIES="
-  $COMPONENT_DEPENDENCIES
   ./config/magpie
 "
@@ -16,7 +16,6 @@ export WEAVER_WPS_PROVIDERS="
 
 # add any component that this component requires to run
 COMPONENT_DEPENDENCIES="
-  $COMPONENT_DEPENDENCIES
   ./config/postgres
   ./config/wps_outputs-volume
   ./config/data-volume

@@ -1,6 +1,5 @@
 
 # add any component that this component requires to run
 COMPONENT_DEPENDENCIES="
-  $COMPONENT_DEPENDENCIES
   ./config/geoserver
 "
@@ -13,6 +13,5 @@ OPTIONAL_VARS="
 
 # add any component that this component requires to run
 COMPONENT_DEPENDENCIES="
-  $COMPONENT_DEPENDENCIES
   ./config/wps_outputs-volume
 "
@@ -9,7 +9,6 @@ VARS="
 
 # add any component that this component requires to run
 COMPONENT_DEPENDENCIES="
-  $COMPONENT_DEPENDENCIES
   ./config/malleefowl
   ./config/flyingpigeon
   ./config/catalog

@@ -2,6 +2,5 @@
 
 # add any component that this component requires to run
 COMPONENT_DEPENDENCIES="
-  $COMPONENT_DEPENDENCIES
   ./config/postgres
 "
@@ -25,7 +25,6 @@ export WEAVER_WPS_PROVIDERS="
 
 # add any component that this component requires to run
 COMPONENT_DEPENDENCIES="
-  $COMPONENT_DEPENDENCIES
   ./config/postgres
   ./config/wps_outputs-volume
 "
@@ -18,6 +18,5 @@ OPTIONAL_VARS="
 
 # add any component that this component requires to run
 COMPONENT_DEPENDENCIES="
-  $COMPONENT_DEPENDENCIES
   ./config/magpie
 "
@@ -19,6 +19,7 @@ export DELAYED_EVAL=''
 
 export DEFAULT_CONF_DIRS='
   ./config/proxy
+  ./config/canarie-api
   ./config/phoenix
   ./config/geoserver
   ./config/flyingpigeon
@@ -35,5 +36,4 @@ export DEFAULT_CONF_DIRS='
   ./config/catalog
   ./config/malleefowl
   ./config/solr
-  ./config/canarie-api
 '
@@ -72,6 +72,10 @@ export GEOSERVER_ADMIN_PASSWORD=geoserverpass
 # Suggested to keep the private-config-repo last in the list to be able to
 # override anything.
 #
+# Note that a component listed in DEFAULT_CONF_DIRS and EXTRA_CONF_DIRS
+# will load any dependant components (defined in the COMPONENT_DEPENDENCIES
+# variable) immediately after the specified component.
+#
 # Format: space separated list of dirs
 #
 #export EXTRA_CONF_DIRS="/path/to/dir1 ./path/to/dir2 dir3 dir4"

@@ -2,6 +2,5 @@
 
 # add any component that this component requires to run
 COMPONENT_DEPENDENCIES="
-  $COMPONENT_DEPENDENCIES
   ./config/magpie
 "
@@ -2,6 +2,5 @@
 
 # add any component that this component requires to run
 COMPONENT_DEPENDENCIES="
-  $COMPONENT_DEPENDENCIES
   ./config/canarie-api
 "
@@ -34,7 +34,6 @@ OPTIONAL_VARS="
 # add any component that this component requires to run
 if [ "$EMU_WPS_OUTPUTS_VOL" == 'wps_outputs' ]; then
   COMPONENT_DEPENDENCIES="
-    $COMPONENT_DEPENDENCIES
     ./config/wps_outputs-volume
   "
 fi
@@ -30,6 +30,5 @@ OPTIONAL_VARS="
 
 # add any component that this component requires to run
 COMPONENT_DEPENDENCIES="
-  $COMPONENT_DEPENDENCIES
   ./config/wps_outputs-volume
 "
@@ -29,7 +29,6 @@ export DELAYED_EVAL="
 
 # add any component that this component requires to run
 COMPONENT_DEPENDENCIES="
-  $COMPONENT_DEPENDENCIES
   ./config/magpie
   ./config/twitcher
   ./config/proxy

@@ -1,6 +1,5 @@
 # add any component that this component requires to run
 COMPONENT_DEPENDENCIES="
-  $COMPONENT_DEPENDENCIES
   ./config/magpie
   ./config/thredds
 "
Original file line number	Diff line number	Diff line change
		@@ -1 +1 @@
		1.25.3 2023-04-12T21:49:10Z
		1.25.4 2023-04-12T22:02:31Z