VR: Check workflow stopped if updating template vars from plugin

[wxtim]

Ref: https://cylc.discourse.group/t/jinja2-variable-differences-in-config-files-new-ones-are-not-being-respected/885
Ref: #5297

Description

VR check whether template variables have been changed using the CLI and raises an error if the workflow is running.

If you change the template variables using a plugin, however, this check is not carried out.

The check is currently carried out here:

cylc-flow/cylc/flow/scripts/validate_reinstall.py

Line 102 in 57fe4ae

def check_tvars_and_workflow_stopped(

Reproducible Example

#!jinja2
# flow.cylc
[scheduler]
    allow implicit tasks = True
[scheduling]
    initial cycle point = 1000
    [[graph]]
        R1 = {{task}} => bar

cylc vip workflow --pause -S 'task="foo"'
cylc vr workflow --pause -S 'task="bar"'

# Witnesss that change hasn't happend after the reload.
grep "R1 =" ~/cylc-run/basic.stone/runN/log/config/*

cylc stop workflow

cylc vr workflow --pause -S 'task="bar"'

# OK now
grep "R1 =" ~/cylc-run/basic.stone/runN/log/config/*

[wxtim]

I'm actaully not sure that this is correct. Re-install takes -S but not -s.

The real question is whether it all behaves as expected and there are no nasty surprises for the user. I'm going to develop a couple of tests which will attempt to quantify what is going on.

[oliver-sanders]

I'm actaully not sure that this is correct. Re-install takes -S but not -s.

Yes, reload doesn't support -s and we should check for that, but -S is a reinstall feature so cylc vr should support it fine.

---

The -S option applies to (re)install, so you should be able to use it for both cases.

I.E. I think this is a bug not a lack of CLI validation. So closing this as superseded by #5968

Please reopen if I've got the wrong end of the stick.