Merge pull request #12 from ircwaves/update-to-support-workflow-event…

…-manager

Update to support workflow event manager

.github/workflows/python-test.yml

@@ -10,16 +10,16 @@ jobs:
     strategy:
       matrix:
         python-version:
-          - "3.8"
           - "3.9"
           - "3.10"
           - "3.11"
+          - "3.12"
     runs-on: ubuntu-latest
     steps:
       - name: Checkout
-        uses: actions/checkout@v3
+        uses: actions/checkout@v4
       - name: Set up Python ${{ matrix.python-version }}
-        uses: actions/setup-python@v4
+        uses: actions/setup-python@v5
         with:
           python-version: ${{ matrix.python-version }}
       - name: Install dependencies
@@ -39,7 +39,10 @@ jobs:
       - name: Test with pytest
         run: pytest --cov=cirrus --cov-report=xml
       - name: "Upload coverage to Codecov"
-        uses: codecov/codecov-action@v3
+        if: ${{ matrix.python-version == '3.12' }}
+        uses: codecov/codecov-action@v4
+        env:
+          CODECOV_TOKEN: ${{ secrets.CODECOV_TOKEN }}
         with:
           fail_ci_if_error: true
           verbose: true

CHANGELOG.md

@@ -5,6 +5,27 @@ All notable changes to this project will be documented in this file.
 The format is based on [Keep a Changelog](http://keepachangelog.com/en/1.0.0/)
 and this project adheres to [Semantic Versioning](http://semver.org/spec/v2.0.0.html).
 
+## [Unreleased]
+
+### Added
+
+- Support for `cirrus-geo>=0.15.0` with WorkflowEventManager changes around
+  ProcessPayloads. ([#12])
+- Added support for Python 3.12
+
+### Changed
+
+- Given the heavy changes initiated with
+  [cirrus-geo#268](https://github.com/cirrus-geo/cirrus-geo/pull/268),
+  `cirrus-mgmt` is now pinned to use the stable releases of cirrus-geo
+  (`<1.0`). As described, in that PR, the management commands for releases
+  `>=1.0` will not use this separate package.
+- Updated Github Actions per nodejs16 deprecation notice in workflows.
+
+### Removed
+
+- Python support for python 3.8.
+
 ## [v0.1.1] - 2024-02-16
 
 ### Fixed
@@ -36,3 +57,4 @@ Initial release
 [v0.1.1]: https://github.com/cirrus-geo/cirrus-mgmt/compare/v0.1.0...v0.1.1
 [v0.1.0]: https://github.com/cirrus-geo/cirrus-mgmt/compare/v0.1.0a...v0.1.0
 [v0.1.0a]: https://github.com/cirrus-geo/cirrus-mgmt/releases/tag/v0.1.0a
+[#12]: https://github.com/cirrus-geo/cirrus-mgmt/pull/12

requirements.txt

@@ -1,3 +1,3 @@
 click-option-group>=0.5.5
-cirrus-geo>=0.9.0
+cirrus-geo>=0.9.0,<1
 backoff>=2.2.1

setup.py

@@ -33,10 +33,10 @@
     classifiers=[
         "Intended Audience :: Developers",
         "License :: OSI Approved :: Apache Software License",
-        "Programming Language :: Python :: 3.8",
         "Programming Language :: Python :: 3.9",
         "Programming Language :: Python :: 3.10",
         "Programming Language :: Python :: 3.11",
+        "Programming Language :: Python :: 3.12",
     ],
     license="Apache-2.0",
     include_package_data=True,

src/cirrus/plugins/management/commands/manage.py

@@ -2,16 +2,13 @@
 import logging
 import sys
 from functools import wraps
+from subprocess import CalledProcessError
 
 import click
 from cirrus.cli.utils import click as utils_click
 from click_option_group import RequiredMutuallyExclusiveOptionGroup, optgroup
 
-from cirrus.plugins.management.deployment import (
-    WORKFLOW_POLL_INTERVAL,
-    CalledProcessError,
-    Deployment,
-)
+from cirrus.plugins.management.deployment import WORKFLOW_POLL_INTERVAL, Deployment
 from cirrus.plugins.management.utils.click import (
     additional_variables,
     silence_templating_errors,

src/cirrus/plugins/management/deployment.py

@@ -4,7 +4,7 @@
 import os
 from datetime import datetime, timezone
 from pathlib import Path
-from subprocess import CalledProcessError, check_call
+from subprocess import check_call
 from time import sleep, time
 
 import backoff
@@ -321,6 +321,16 @@ def invoke_lambda(self, event, function_name):
 
         return json.load(response["Payload"])
 
+    def workflow_event_manager(self):
+        wfem = None
+        try:
+            from cirrus.lib2.events import WorkflowEventManager
+
+            wfem = WorkflowEventManager()
+        except ImportError:
+            pass
+        return wfem
+
     def run_workflow(
         self,
         payload: dict,

tests/conftest.py

@@ -229,11 +229,17 @@ def _invoke(cmd, **kwargs):
 
 
 @pytest.fixture
-def basic_payloads(fixtures):
-    return ProcessPayloads(
-        process_payloads=[
-            ProcessPayload(
-                json.loads(fixtures.joinpath("basic_payload.json").read_text())
-            )
-        ]
-    )
+def basic_payloads(fixtures, statedb):
+    payload_list = [
+        ProcessPayload(json.loads(fixtures.joinpath("basic_payload.json").read_text()))
+    ]
+    try:
+        # cirrus-geo >= 0.15.0
+        payloads = ProcessPayloads(process_payloads=payload_list, statedb=statedb)
+    except TypeError as te:
+        # cirrus-geo < 0.15.0
+        if "unexpected keyword argument 'statedb'" in te.args[0]:
+            payloads = ProcessPayloads(process_payloads=payload_list)
+        else:
+            raise
+    return payloads

tests/test_manage.py

@@ -107,11 +107,18 @@ def test_manage_get_execution_by_payload_id(deployment, basic_payloads, statedb)
     """
     current_env = deepcopy(os.environ)  # stash env
     deployment.set_env()
-    basic_payloads.process()
+
+    ############
+    # Handle cirrus-geo before WorkflowEventManager (0.15.0)
+    wfem = deployment.workflow_event_manager()
+    proc_args = [] if wfem is None else [wfem]
+    ############
+
+    basic_payloads.process(*proc_args)
     pid = basic_payloads[0]["id"]
     sfn_exe1 = deployment.get_execution_by_payload_id(pid)
     statedb.set_aborted(pid, execution_arn=sfn_exe1["executionArn"])
-    basic_payloads.process()
+    basic_payloads.process(*proc_args)
     sfn_exe2 = deployment.get_execution_by_payload_id(pid)
     assert sfn_exe1["executionArn"] != sfn_exe2["executionArn"]
     os.environ = current_env  # pop stash