fix(_comp__included_ssh_config_files): ignore comments in "Include"

Co-authored-by: Koichi Murase <[email protected]>

Author: Rémi Laurent

bash_completion

@@ -2542,7 +2542,8 @@ _comp__included_ssh_config_files()
     # https://github.com/openssh/openssh-portable/blob/5ec5504f1d328d5bfa64280cd617c3efec4f78f3/readconf.c#L2240
     local max_depth=16
     while ((${#included[@]} > 0 && depth++ < max_depth)); do
-        _comp_split include_files "$(command sed -ne 's/^[[:blank:]]*[Ii][Nn][Cc][Ll][Uu][Dd][Ee][[:blank:]]\(.*\)$/\1/p' "${included[@]}")" || return
+        _comp_split include_files "$(command sed -ne 's/^[[:blank:]]*[Ii][Nn][Cc][Ll][Uu][Dd][Ee][[:blank:]]*\([^#]*\).*$/\1/p' "${included[@]}")" || return
+
         included=()
         for i in "${include_files[@]}"; do
             if [[ $i != [~/]* ]]; then

test/fixtures/_known_hosts/.ssh/config_comment

@@ -0,0 +1 @@
+Host with_comment

test/fixtures/_known_hosts/.ssh/inside_comment

@@ -0,0 +1 @@
+Host this_file_should_not_be_included

test/fixtures/_known_hosts/config_include

@@ -7,3 +7,5 @@ Include config_relative_path
 Include config_asterisk* config_?uestion_mark
 # Include a directory name.  This is a misconfiguration, but ssh ignores it without errors.
 Include ../../_known_hosts
+# Include with extra comment
+Include config_comment # inside_comment this should be ignored

test/t/unit/test_unit_compgen_known_hosts.py

@@ -127,6 +127,8 @@ def test_included_configs(self, bash, hosts):
         expected.extend("asterisk_1 asterisk_2".split())
         # fixtures/_known_hosts/.ssh/config_question_mark
         expected.append("question_mark")
+        # fixtures/_known_hosts/.ssh/config_comment
+        expected.append("with_comment")
 
         with bash_env_saved(bash) as bash_env:
             bash_env.write_variable("HOME", "%s/_known_hosts" % bash.cwd)