Terminology: suite to workflow #4174

hjoliver · 2021-04-15T06:02:51Z

This is a ~~small~~ large-but-trivial change with no associated Issue (but discussed with the team!)

globally replace suite/Suite/SUITE with workflow/Workflow/WORKFLOW
- thank @@#$$@# for easy command-line automation
rename all *suite* filenames as *workflow*
restore any back-compat references to suite.rc
fix style violations resulting from slightly longer lines
restore CYLC_SUITE_* job environment variables for back-compat

Note:

much easier to do this all at once than separate user-facing and internal changes
some use of the word suite should really be translated to scheduler rather than workflow, but I haven't done that (requires a careful look at each case)

Requirements check-list

I have read CONTRIBUTING.md and added my name as a Code Contributor.
Contains logically grouped changes (else tidy your branch by rebase).
Does not contain off-topic changes (use other PRs for other changes).
Already covered by existing tests.
Appropriate change log entry included.
documentation PR: Terminology: suite to workflow cylc-doc#238
No dependency changes.

hjoliver · 2021-04-15T07:10:55Z

All tests passing locally.

datamel

I have worked my way through the bulk of this PR.
Couple of comments.
All tests pass for me locally. I have also read through code changes.
Will re-review when the
TODO: restore CYLC_SUITE_* job environment variables for back-compat has been completed.
This change will break ui so will wait on giving explicit approval before a companion pr for cylc-uiserver is also approved.

tests/unit/parsec/test_include.py

tests/functional/deprecations/01-cylc8-basic/validation.stderr

cylc/flow/scripts/reinstall.py

cylc/flow/workflow_files.py

cylc/flow/parsec/fileparse.py

cylc/flow/scripts/install.py

hjoliver · 2021-04-15T21:28:38Z

I have worked my way through the bulk of this PR.

Thanks @datamel, I'm sure that was mildly painful!

hjoliver · 2021-04-16T02:17:01Z

Should be good to go now. No need to merge for beta-1 release though.

datamel

I have reviewed the final files that I didn't get to yesterday...
!!!!
A couple of points....

(Minor) On occasion you have replaced suite server program with scheduler, did you want to sed workflow server program and change them all to scheduler for consistency?
(Minor) etc/bin/run-functional-tests has a couple of workflows that should be suites.
(Possibly more major) I have checkout out sibling PRs and get errors when my run directory contains a contact file with old fields e.g CYLC_SUITE_UUID.. this returns traceback to the user

Maybe we want some back compatibility, since users may encounter this problem?

Compatibility for cylc review was also raised by @dpmatthews, @wxtim has added this to his to do list.

cylc/flow/subprocpool.py

etc/bin/run-functional-tests

hjoliver · 2021-04-19T04:38:56Z

Good points @datamel, I'll address them soon...

cylc/flow/cfgspec/workflow.py

cylc/flow/etc/job.sh

cylc/flow/etc/syntax/cylc-mode.el

cylc/flow/etc/syntax/cylc.lang

cylc/flow/etc/syntax/cylc.vim

cylc/flow/etc/syntax/cylc.xml

cylc/flow/exceptions.py

cylc/flow/scripts/cylc.py

hjoliver · 2021-04-21T07:15:26Z

(closed and reopened to trigger Actions)

hjoliver · 2021-04-21T07:20:38Z

@datamel -

(Possibly more major) I have checkout out sibling PRs and get errors when my run directory contains a contact file with old fields e.g CYLC_SUITE_UUID.. this returns traceback to the user

Last commit fixes this. (It fixes cylc scan here, in case of old contact files, and the hub-reported errors if you pip install this branch into your ui-server).

hjoliver · 2021-04-21T07:21:14Z

I think the test failures are spurious - something weird just happened (see comment on Element) ... but I'll come back to check later.

cylc/flow/workflow_files.py

hjoliver · 2021-04-21T11:54:43Z

Tests passing 🎉

Co-authored-by: Ronnie Dutta <[email protected]>

hjoliver · 2021-04-22T23:12:26Z

Finally finished reviewing all the files 😅

Thanks, excellent reviewing! 💐

datamel

I can confirm the issue that resulted in traceback on ui-server has been fixed.
Approved.

oliver-sanders · 2021-04-23T12:57:51Z

thank @@#$$@# for easy command-line automation

Couldn't find any words in the English language which match that pattern, gonna have to be more specific.

oliver-sanders

Well that was fun!

I think we need to keep the "suite" fields we provide to ~~suite~~workflow/task event scripts (unless there's some clever logic handling that I didn't spot).

cylc/flow/etc/job.sh

cylc/flow/task_events_mgr.py

cylc/flow/workflow_events.py

oliver-sanders

👍

oliver-sanders · 2021-04-27T08:29:08Z

Brace for conflicts, it's going in!

hjoliver added this to the cylc-8.0b2 milestone Apr 15, 2021

hjoliver self-assigned this Apr 15, 2021

hjoliver marked this pull request as ready for review April 15, 2021 07:11

MetRonnie self-requested a review April 15, 2021 09:35

datamel reviewed Apr 15, 2021

View reviewed changes

This was referenced Apr 16, 2021

Terminology: suite to workflow. cylc/cylc-uiserver#206

Merged

Terminology: suite to workflow. cylc/cylc-ui#646

Merged

hjoliver mentioned this pull request Apr 16, 2021

Terminology: suite to workflow cylc/cylc-doc#238

Merged

datamel reviewed Apr 16, 2021

View reviewed changes

cylc/flow/subprocpool.py Outdated Show resolved Hide resolved

etc/bin/run-functional-tests Outdated Show resolved Hide resolved

etc/bin/run-functional-tests Outdated Show resolved Hide resolved

MetRonnie reviewed Apr 20, 2021

View reviewed changes

cylc/flow/cfgspec/workflow.py Outdated Show resolved Hide resolved

cylc/flow/cfgspec/workflow.py Show resolved Hide resolved

cylc/flow/cfgspec/workflow.py Outdated Show resolved Hide resolved

MetRonnie reviewed Apr 20, 2021

View reviewed changes

cylc/flow/scripts/cylc.py Outdated Show resolved Hide resolved

hjoliver force-pushed the suite-to-workflow branch from 69fc60c to d886b46 Compare April 21, 2021 05:54

Squashed commit: "suite" to "workflow" everywhere.

ff94ee2

hjoliver force-pushed the suite-to-workflow branch from d886b46 to ff94ee2 Compare April 21, 2021 06:08

hjoliver added 2 commits April 21, 2021 18:45

Tweak test.

cbe2e47

Back compat for "suite" contact files.

211382a

hjoliver closed this Apr 21, 2021

hjoliver reopened this Apr 21, 2021

hjoliver closed this Apr 21, 2021

hjoliver reopened this Apr 21, 2021

MetRonnie reviewed Apr 21, 2021

View reviewed changes

cylc/flow/workflow_files.py Outdated Show resolved Hide resolved

cylc/flow/workflow_files.py Outdated Show resolved Hide resolved

hjoliver and others added 6 commits April 23, 2021 09:19

Update cylc/flow/scheduler.py

0eb473b

Co-authored-by: Ronnie Dutta <[email protected]>

Update cylc/flow/rundb.py

a46d364

Co-authored-by: Ronnie Dutta <[email protected]>

Remove obsolete env section.

a8befdb

Revert Cylc 7 suite restart test.

5ce7f8f

Remove spurious vim file from repo.

7ad69fa

Bump version, for some tests on this branch.

12d7bd9

Merge branch 'master' into suite-to-workflow

4833d6c

hjoliver force-pushed the suite-to-workflow branch from 1d40697 to 4833d6c Compare April 22, 2021 23:13

Update cylc verison in fake test db.

3c0c8b8

MetRonnie approved these changes Apr 23, 2021

View reviewed changes

Merge branch 'master' into suite-to-workflow

609e494

MetRonnie force-pushed the suite-to-workflow branch from 0e26b28 to 0d574b7 Compare April 23, 2021 10:56

MetRonnie added 2 commits April 23, 2021 12:01

Fix style, fix patching in unit test

165f289

Update changelog

6e718d3

MetRonnie force-pushed the suite-to-workflow branch from 0d574b7 to 6e718d3 Compare April 23, 2021 11:04

MetRonnie mentioned this pull request Apr 23, 2021

suite -> workflow cylc/cylc-rose#56

Merged

datamel approved these changes Apr 23, 2021

View reviewed changes

Revert 1 line [skip ci]

91cbb94

oliver-sanders reviewed Apr 23, 2021

View reviewed changes

hjoliver added 3 commits April 27, 2021 15:52

Address review feedback.

e6f0118

Deprecate "suite" event handler template vars.

5c0536a

Handler bad mail footer template.

697c407

hjoliver force-pushed the suite-to-workflow branch from 6ced750 to 697c407 Compare April 27, 2021 05:36

oliver-sanders approved these changes Apr 27, 2021

View reviewed changes

oliver-sanders merged commit 35a3d1b into cylc:master Apr 27, 2021

MetRonnie mentioned this pull request Apr 27, 2021

Terminology: suite to workflow follow-up #4198

Merged

7 tasks

hjoliver deleted the suite-to-workflow branch April 27, 2021 20:39

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Terminology: suite to workflow #4174

Terminology: suite to workflow #4174

hjoliver commented Apr 15, 2021 •

edited

Loading

hjoliver commented Apr 15, 2021

datamel left a comment

hjoliver commented Apr 15, 2021

hjoliver commented Apr 16, 2021

datamel left a comment

hjoliver commented Apr 19, 2021

hjoliver commented Apr 21, 2021

hjoliver commented Apr 21, 2021

hjoliver commented Apr 21, 2021

hjoliver commented Apr 21, 2021

hjoliver commented Apr 22, 2021

datamel left a comment

oliver-sanders commented Apr 23, 2021

oliver-sanders left a comment

oliver-sanders left a comment

oliver-sanders commented Apr 27, 2021

Terminology: suite to workflow #4174

Terminology: suite to workflow #4174

Conversation

hjoliver commented Apr 15, 2021 • edited Loading

hjoliver commented Apr 15, 2021

datamel left a comment

Choose a reason for hiding this comment

hjoliver commented Apr 15, 2021

hjoliver commented Apr 16, 2021

datamel left a comment

Choose a reason for hiding this comment

hjoliver commented Apr 19, 2021

hjoliver commented Apr 21, 2021

hjoliver commented Apr 21, 2021

hjoliver commented Apr 21, 2021

hjoliver commented Apr 21, 2021

hjoliver commented Apr 22, 2021

datamel left a comment

Choose a reason for hiding this comment

oliver-sanders commented Apr 23, 2021

oliver-sanders left a comment

Choose a reason for hiding this comment

oliver-sanders left a comment

Choose a reason for hiding this comment

oliver-sanders commented Apr 27, 2021

hjoliver commented Apr 15, 2021 •

edited

Loading