test(scp): leave comments for a failing test case

Author: akinomyoga

completions/ssh

@@ -471,6 +471,13 @@ _comp_cmd_scp__path_esc='[][(){}<>"'"'"',:;^&!$=?`\\|[:space:]]'
 # "compopt +o nospace" instead, but it would suffix a space to directory names
 # unexpectedly.
 #
+# FIXME: With the current strategy of using "ls -FL", we cannot distinguish the
+# filenames that end with one of the type-classifier characters.  For example,
+# a regular file "pipe|" and a named pipe "pipe" would both produce the
+# identical result "pipe|" with "ls -1FL".  As a consequence, those characters
+# at the end of the filename are removed unexpectedly.  To solve this problem,
+# we need to give up relying on "ls -1FL".
+#
 # Options:
 #     -d  Only directory names are selected.
 # @param $2 escape_replacement - If a non-empty value is specified, special

test/t/test_scp.py

@@ -183,7 +183,13 @@ def test_remote_path_ending_with_backslash(self, bash):
 
     @pytest.fixture
     def tmpdir_mkfifo(self, request, bash):
-        tmpdir, _, _ = prepare_fixture_dir(request, files=[], dirs=[])
+        # We prepare two files: 1) a named pipe and 2) a regular file ending
+        # with the same name but an extra special character "|".
+        tmpdir, _, _ = prepare_fixture_dir(
+            request,
+            files=["local_path_2-pipe|"],
+            dirs=[],
+        )
 
         # If the system allows creating a named pipe, we create it in a
         # temporary directory and returns the path.  We cannot check the
@@ -206,6 +212,13 @@ def test_local_path_mark_1(self, bash, tmpdir_mkfifo):
         )
         assert completion == "pipe"
 
+    # FIXME: This test currently fails.
+    # def test_local_path_mark_2(self, bash, tmpdir_mkfifo):
+    #     completion = assert_complete(
+    #         bash, "scp local_path_2-", cwd=tmpdir_mkfifo
+    #     )
+    #     assert completion == "pipe\\|"
+
     @pytest.mark.complete("scp spa", cwd="scp")
     def test_local_path_with_spaces_1(self, completion):
         assert completion == r"ced\ \ conf"