Fix reinstall not detecting changed permissions by itself

Author: MetRonnie

cylc/flow/remote.py

@@ -180,9 +180,14 @@ def get_includes_to_rsync(rsync_includes=None):
 DEFAULT_RSYNC_OPTS = [
     '-a',
     '--checksum',
-    '--out-format=%o %n%L',
+    '--out-format=%o %i %n%L',  # see comment below
     '--no-t'
 ]
+# %o: the operation (send or del.)
+# %i: itemized changes (needed for rsync to report files with
+#     changed permissions
+# %n: filename
+# %L: "-> symlink_target" if applicable
 
 DEFAULT_INCLUDES = [
     '/ana/***',  # Rose ana analysis modules

cylc/flow/scripts/reinstall.py

@@ -68,33 +68,42 @@
   "cylc install" even if present in the source directory.
 """
 
+from functools import partial
 from pathlib import Path
+import re
 import sys
-from typing import Optional, TYPE_CHECKING, List, Callable
-from functools import partial
+from typing import (
+    TYPE_CHECKING,
+    Callable,
+    List,
+    Optional,
+)
 
 from ansimarkup import parse as cparse
 
 from cylc.flow.exceptions import (
     ServiceFileError,
     WorkflowFilesError,
 )
-from cylc.flow.install import (
-    reinstall_workflow,
-)
+from cylc.flow.install import reinstall_workflow
 from cylc.flow.network.multi import call_multi
 from cylc.flow.option_parsers import (
+    ID_MULTI_ARG_DOC,
     CylcOptionParser as COP,
     OptionSettings,
-    ID_MULTI_ARG_DOC
 )
 from cylc.flow.pathutil import get_workflow_run_dir
 from cylc.flow.plugins import run_plugins_async
+from cylc.flow.terminal import (
+    DIM,
+    cli_function,
+    is_terminal,
+)
 from cylc.flow.workflow_files import (
     get_workflow_source_dir,
     load_contact_file,
 )
-from cylc.flow.terminal import cli_function, DIM, is_terminal
+
 
 if TYPE_CHECKING:
     from optparse import Values
@@ -319,7 +328,7 @@ def format_rsync_out(out: str) -> List[str]:
 
     Example:
         >>> format_rsync_out(
-        ...     'send foo\ndel. bar\nbaz'
+        ...     'send >f+++++++++ foo\ndel. *deleting   bar\nbaz'
         ...     '\ncannot delete non-empty directory: opt'
         ... ) == [
         ...     cparse('<green>send foo</green>'),
@@ -331,18 +340,20 @@ def format_rsync_out(out: str) -> List[str]:
     """
     lines = []
     for line in out.splitlines():
-        if line[0:4] == 'send':
-            # file added or updated
-            lines.append(cparse(f'<green>{line}</green>'))
-        elif line[0:4] == 'del.':
-            # file deleted
-            lines.append(cparse(f'<red>{line}</red>'))
-        elif line == 'cannot delete non-empty directory: opt':
+        if line == 'cannot delete non-empty directory: opt':
             # These "cannot delete non-empty directory" messages can arise
             # as a result of excluding files within sub-directories.
-            # This opt dir message is likely to occur when a rose-suit.conf
+            # This opt dir message is likely to occur when a rose-suite.conf
             # file is present.
             continue
+        match = re.match(r'^(send|del\.)\s.{11}\s(.*)$', line)
+        # .{11} is the itemized changes bit, which users don't need to see
+        if match:
+            operation = match.group(1)
+            color = 'green' if operation == 'send' else 'red'
+            lines.append(
+                cparse(f"<{color}>{operation}</{color}> {match.group(2)}")
+            )
         else:
             # other uncategorised log line
             lines.append(line)

tests/unit/scripts/test_reinstall.py

@@ -0,0 +1,45 @@
+# THIS FILE IS PART OF THE CYLC WORKFLOW ENGINE.
+# Copyright (C) NIWA & British Crown (Met Office) & Contributors.
+#
+# This program is free software: you can redistribute it and/or modify
+# it under the terms of the GNU General Public License as published by
+# the Free Software Foundation, either version 3 of the License, or
+# (at your option) any later version.
+#
+# This program is distributed in the hope that it will be useful,
+# but WITHOUT ANY WARRANTY; without even the implied warranty of
+# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+# GNU General Public License for more details.
+#
+# You should have received a copy of the GNU General Public License
+# along with this program.  If not, see <http://www.gnu.org/licenses/>.
+
+from textwrap import dedent
+
+from ansimarkup import parse as cparse
+from cylc.flow.scripts.reinstall import format_rsync_out
+
+
+def test_format_rsync_out():
+    """It should:
+    - colorize the output
+    - remove the itemized changes from rsync format
+    - remove the "cannot delete non-empty directory" message
+    """
+    rsync_output = dedent("""
+        del. *deleting   Cloud.jpg
+        send >f+++++++++ cloud.jpg
+        send .f...p..... foo
+        send >fcsTp..... bar
+        cannot delete non-empty directory: opt
+        send >f+++++++++ meow.txt
+        send cL+++++++++ garage -> foo
+    """).strip()
+    assert format_rsync_out(rsync_output) == [
+        cparse("<red>del.</red> Cloud.jpg"),
+        cparse("<green>send</green> cloud.jpg"),
+        cparse("<green>send</green> foo"),
+        cparse("<green>send</green> bar"),
+        cparse("<green>send</green> meow.txt"),
+        cparse("<green>send</green> garage -> foo"),
+    ]