added suite state xtrigger for back-compat #5864
Conversation
MetRonnie
changed the title
extended back compat a unit test added deprecation log message refactored implementation flake8 review amends added test for warning text review amends more review ammends Replace icky unit test with functional test (#4) * Replace icky unit test with functional test * Update changelog
markgrahamdawson
force-pushed
the
suite-to-workflow-state-xtrigger
branch
from
bd18c77
to
95d0e59
Compare
There was a problem hiding this comment.
Tests are failing for a valid reason
XtriggerConfigError: [upstream] xtrigger module 'suite_state' not found
This is because of the change introduced in #5831 where built-in xtriggers are now registered by the cylc.xtriggers entry point in setup.cfg
Lines 218 to 223 in 22f41e2
I think the best solution is to just add suite_state to the entry point? cc @oliver-sanders
Yes, that will be needed to register this xtrigger. |
| @@ -220,6 +220,7 @@ cylc.xtriggers = | |||
| echo = cylc.flow.xtriggers.echo:echo | |||
| wall_clock = cylc.flow.xtriggers.wall_clock:wall_clock | |||
| workflow_state = cylc.flow.xtriggers.workflow_state:workflow_state | |||
| suite_state = cylc.flow.xtriggers.suite_state:suite_state | |||
| # along with this program. If not, see <http://www.gnu.org/licenses/>. | ||
|
|
||
| # Test that deprecation warnings are printed appropriately for the suite_state | ||
| # xtrigger. |
There was a problem hiding this comment.
Does this functional test provide anything more than the unit tests below?
There was a problem hiding this comment.
It's icky to test the deprecation message logging from within unit tests because it happens at import time, so did this as a functional test. #5864 (comment)
|
Just failing flake8: |
closes #5835
The issue
The suite_state xtrigger was renamed to workflow_state, this breaks Cylc 7-8 interoperability.
The solution
I have just added a new xtrigger called suite_state which imports from workflow_state
Check List
CONTRIBUTING.mdand added my name as a Code Contributor.setup.cfg(andconda-environment.ymlif present).CHANGES.mdentry included if this is a change that can affect users?.?.xbranch.