Merge pull request #6011 from wxtim/fix.sys-argv-cleaner

Apply CLI clean changes to correct list

changes.d/6011.fix.md

@@ -0,0 +1 @@
+Fixed a `cylc vip` bug causing remote re-invocation to fail if using `--workflow-name` option.

cylc/flow/option_parsers.py

@@ -878,9 +878,9 @@ def cleanup_sysargv(
     new_args[1] = script_name
 
     # replace source path with workflow ID.
-    if str(source) in sys.argv:
+    if str(source) in new_args:
         new_args.remove(str(source))
-    if workflow_id not in sys.argv:
+    if workflow_id not in new_args:
         new_args.append(workflow_id)
 
     sys.argv = new_args

tests/unit/test_option_parsers.py

@@ -383,6 +383,22 @@ def test_combine_options(inputs, expect):
             'play --foo something myworkflow'.split(),
             id='no path given'
         ),
+        param(
+            'vip -n myworkflow --no-run-name'.split(),
+            {
+                'script_name': 'play',
+                'workflow_id': 'myworkflow',
+                'compound_script_opts': [
+                    OptionSettings(['--workflow-name', '-n']),
+                    OptionSettings(['--no-run-name']),
+                ],
+                'script_opts': [
+                    OptionSettings(['--not-used']),
+                ]
+            },
+            'play myworkflow'.split(),
+            id='workflow-id-added'
+        ),
     ]
 )
 def test_cleanup_sysargv(monkeypatch, argv_before, kwargs, expect):