Merge branch 'master' into cov-params

crim-ca · Feb 6, 2025 · 3fe3b29 · 3fe3b29
2 parents db0c3e3 + a18fa36
commit 3fe3b29
Show file tree

Hide file tree

Showing 34 changed files with 295 additions and 185 deletions.
diff --git a/.pylintrc b/.pylintrc
@@ -97,6 +97,7 @@ disable=C0111,missing-docstring,
         R0901,too-many-ancestors,
         R0902,too-many-instance-attributes,
         R0904,too-many-public-methods,
+        R0911,too-many-return-statements,
         R0912,too-many-branches,
         R0913,too-many-arguments,
         R0914,too-many-locals,

diff --git a/.zenodo.json b/.zenodo.json
@@ -1,8 +1,8 @@
 {
   "upload_type": "software",
-  "title": "crim-ca/weaver:6.1.1",
+  "title": "crim-ca/weaver:6.2.0",
   "description": "Weaver: Workflow Execution Management Service (EMS); Application, Deployment and Execution Service (ADES); OGC API - Processes; WPS; CWL Application Package",
-  "version": "6.1.1",
+  "version": "6.2.0",
   "creators": [
     {
       "name": "Charette-Migneault, Francis",

diff --git a/CHANGES.rst b/CHANGES.rst
@@ -21,6 +21,23 @@ Fixes:
   to provide additional parameters to the remote collection request.
 - Update ``pygeofilter>=0.3.1`` to resolve ``filter-lang=FES`` parser as per other filters
   (relates to `geopython/pygeofilter#102 <https://github.com/geopython/pygeofilter/pull/102>`_).
+
+.. _changes_6.2.0:
+
+`6.2.0 <https://github.com/crim-ca/weaver/tree/6.2.0>`_ (2025-02-06)
+========================================================================
+
+Changes:
+--------
+- Replace ``succeeded`` status by ``successful`` everywhere where applicable (as originally defined by OGC API v1),
+  to align with reversal of the proposed draft name, aligning between both v1 and v2 of `OGC API - Processes`
+  (relates to `opengeospatial/ogcapi-processes#483 <https://github.com/opengeospatial/ogcapi-processes/pull/483>`_).
+- Modify `Job` ``subscribers`` definition to employ the normalized ``weaver.status.StatusCategory`` instead
+  of ``weaver.status.Status`` as mapping keys, such that email and callback notifications are unified under
+  a common naming convention regardless of the resolved ``weaver.status.StatusCompliant`` representation.
+
+Fixes:
+------
 - Fix ``weaver.cli.RequestAuthHandler`` and its derived classes erroneously invoking ``request_auth`` method when
   both the ``url`` and ``token`` are omitted, leading to invalid ``requests`` call under ``weaver.utils.request_extra``.
 

diff --git a/CITATION.cff b/CITATION.cff
@@ -1,10 +1,10 @@
 cff-version: 1.2.0
-title: "crim-ca/weaver:6.1.1"
+title: "crim-ca/weaver:6.2.0"
 message: |
   Weaver: Workflow Execution Management Service (EMS);
   Application, Deployment and Execution Service (ADES);
   OGC API - Processes; WPS; CWL Application Package
-version: "6.1.1"
+version: "6.2.0"
 
 authors:
   - name: &crim Computer Research Institute of Montréal

diff --git a/Makefile b/Makefile
@@ -9,7 +9,7 @@ MAKEFILE_NAME := $(word $(words $(MAKEFILE_LIST)),$(MAKEFILE_LIST))
 # Application
 APP_ROOT    := $(abspath $(lastword $(MAKEFILE_NAME))/..)
 APP_NAME    := $(shell basename $(APP_ROOT))
-APP_VERSION ?= 6.1.1
+APP_VERSION ?= 6.2.0
 APP_INI     ?= $(APP_ROOT)/config/$(APP_NAME).ini
 DOCKER_REPO ?= pavics/weaver
 #DOCKER_REPO ?= docker-registry.crim.ca/ogc/weaver
@@ -187,7 +187,7 @@ conda-base:		## obtain and install a missing conda distribution
 		 echo "Make sure to add '$(CONDA_BIN_DIR)' to your PATH variable in '~/.bashrc'.")
 
 .PHONY: conda-clean
-clean-clean: 	## remove the conda environment
+conda-clean: 	## remove the conda environment
 	@echo "Removing conda env '$(CONDA_ENV)'"
 	@-test -d "$(CONDA_ENV_PATH)" && "$(CONDA_BIN)" remove -n "$(CONDA_ENV)" --yes --all
 
@@ -344,8 +344,8 @@ clean-docs-dirs:	## remove documentation artifacts (minimal)
 clean-src:		## remove all *.pyc files
 	@echo "Removing python artifacts..."
 	@-find "$(APP_ROOT)" -type f -name "*.pyc" -exec rm {} \;
-	@-rm -rf ./build
-	@-rm -rf ./src
+	@-rm -rf "$(APP_ROOT)/build"
+	@-rm -rf "$(APP_ROOT)/src"
 
 .PHONY: clean-test
 clean-test:		## remove files created by tests and coverage analysis

diff --git a/README.rst b/README.rst
@@ -58,13 +58,13 @@ for each process.
     :alt: Requires Python 3.10+
     :target: https://www.python.org/getit
 
-.. |commits-since| image:: https://img.shields.io/github/commits-since/crim-ca/weaver/6.1.1.svg?logo=github
+.. |commits-since| image:: https://img.shields.io/github/commits-since/crim-ca/weaver/6.2.0.svg?logo=github
     :alt: Commits since latest release
-    :target: https://github.com/crim-ca/weaver/compare/6.1.1...master
+    :target: https://github.com/crim-ca/weaver/compare/6.2.0...master
 
-.. |version| image:: https://img.shields.io/badge/latest%20version-6.1.1-blue?logo=github
+.. |version| image:: https://img.shields.io/badge/latest%20version-6.2.0-blue?logo=github
     :alt: Latest Tagged Version
-    :target: https://github.com/crim-ca/weaver/tree/6.1.1
+    :target: https://github.com/crim-ca/weaver/tree/6.2.0
 
 .. |deps| image:: https://img.shields.io/librariesio/github/crim-ca/weaver?logo=librariesdotio&logoColor=white
     :alt: Libraries.io Dependencies Status
@@ -78,9 +78,9 @@ for each process.
     :alt: Github Actions CI Build Status (master branch)
     :target: https://github.com/crim-ca/weaver/actions?query=workflow%3ATests+branch%3Amaster
 
-.. |github_tagged| image:: https://img.shields.io/github/actions/workflow/status/crim-ca/weaver/tests.yml?label=6.1.1&branch=6.1.1&logo=github
+.. |github_tagged| image:: https://img.shields.io/github/actions/workflow/status/crim-ca/weaver/tests.yml?label=6.2.0&branch=6.2.0&logo=github
     :alt: Github Actions CI Build Status (latest tag)
-    :target: https://github.com/crim-ca/weaver/actions?query=workflow%3ATests+branch%3A6.1.1
+    :target: https://github.com/crim-ca/weaver/actions?query=workflow%3ATests+branch%3A6.2.0
 
 .. |readthedocs| image:: https://img.shields.io/readthedocs/pavics-weaver?logo=readthedocs
     :alt: ReadTheDocs Build Status (master branch)
@@ -92,7 +92,7 @@ for each process.
 
 .. below shield will either indicate the targeted version or 'tag not found'
 .. since docker tags are pushed following manual builds by CI, they are not automatic and no build artifact exists
-.. |docker_build_status| image:: https://img.shields.io/docker/v/pavics/weaver/6.1.1?label=tag&logo=docker
+.. |docker_build_status| image:: https://img.shields.io/docker/v/pavics/weaver/6.2.0?label=tag&logo=docker
     :alt: Docker Build Status (latest version)
     :target: https://hub.docker.com/r/pavics/weaver/tags
 
@@ -276,12 +276,12 @@ For a prebuilt image, pull as follows:
 
 .. code-block:: shell
 
-    docker pull pavics/weaver:6.1.1
+    docker pull pavics/weaver:6.2.0
 
 For convenience, following tags are also available:
 
-- ``weaver:6.1.1-manager``: `Weaver` image that will run the API for WPS process and job management.
-- ``weaver:6.1.1-worker``: `Weaver` image that will run the process job runner application.
+- ``weaver:6.2.0-manager``: `Weaver` image that will run the API for WPS process and job management.
+- ``weaver:6.2.0-worker``: `Weaver` image that will run the process job runner application.
 
 Following links correspond to existing servers with `Weaver` configured as *EMS* or *ADES* instances respectively.
 

diff --git a/docker/Dockerfile-base b/docker/Dockerfile-base
@@ -3,7 +3,7 @@ LABEL description.short="Weaver Base"
 LABEL description.long="Workflow Execution Management Service (EMS); Application, Deployment and Execution Service (ADES)"
 LABEL maintainer="Francis Charette-Migneault <francis.charette-migneault@crim.ca>"
 LABEL vendor="CRIM"
-LABEL version="6.1.1"
+LABEL version="6.2.0"
 
 # setup paths
 ENV APP_DIR=/opt/local/src/weaver

diff --git a/docs/examples/job_status_ogcapi.json b/docs/examples/job_status_ogcapi.json
@@ -4,8 +4,8 @@
   "processID": "example-process",
   "providerID": null,
   "type": "process",
-  "status": "succeeded",
-  "message": "Job succeeded.",
+  "status": "successful",
+  "message": "Job successful.",
   "created": "2024-10-02T14:21:12.380000+00:00",
   "started": "2024-10-02T14:21:12.990000+00:00",
   "finished": "2024-10-02T14:21:23.629000+00:00",

diff --git a/docs/source/appendix.rst b/docs/source/appendix.rst
@@ -238,6 +238,10 @@ Glossary
         .. seealso::
             :ref:`quotation_estimator_model`
 
+    openEO
+        | Open Earth Observation
+        | Cloud backend :term:`API` initiative for unified Earth Observation, as described by :ref:`openEO`.
+
     OpenSearch
         Protocol of lookup and retrieval of remotely stored files.
         Please refer to :ref:`OpenSearch Data Source` for details.

diff --git a/docs/source/processes.rst b/docs/source/processes.rst
@@ -1087,7 +1087,7 @@ Once the :term:`Job` is submitted, its status should initially switch to ``accep
 status will change to ``started`` for preparation steps (i.e.: allocation resources, retrieving required
 parametrization details, etc.), followed by ``running`` when effectively reaching the execution step of the underlying
 :term:`Application Package` operation. This status will remain as such until the operation completes, either with
-``succeeded`` or ``failed`` status.
+``successful`` or ``failed`` status.
 
 At any moment during |asynchronous|_ execution, the :term:`Job` status can be requested using |status-req|_. Note that
 depending on the timing at which the user executes this request and the availability of task workers, it could be

diff --git a/setup.cfg b/setup.cfg
@@ -1,5 +1,5 @@
 [bumpversion]
-current_version = 6.1.1
+current_version = 6.2.0
 commit = True
 tag = True
 tag_name = {new_version}

diff --git a/tests/functional/test_builtin.py b/tests/functional/test_builtin.py
@@ -438,7 +438,7 @@ def test_jsonarray2netcdf_execute_sync(self):
         assert resp.content_type == ContentType.APP_JSON
         for field in ["status", "created", "finished", "duration", "progress"]:
             assert field in resp.json
-        assert resp.json["status"] == Status.SUCCEEDED
+        assert resp.json["status"] == Status.SUCCESSFUL
         assert resp.json["progress"] == 100
 
         out_url = f"{job_url}/results"