Directories with trailing slash in .gitignore will not be exluded in version 6.17

[hille721]

Summary

directories with trailing slashes in .gitignore won't be exluded in ansible-lint 6.17.0.
I guess this is related to the reimplementation of the file exclusion logic (#3507).

This statement

ansible-lint/src/ansiblelint/file_utils.py

Line 541 in 98063af

return any(spec.match_file(str(path_to_check)) for spec in pathspecs)

will return false for a comparison of Path(foo) with foo/ in the pathspec object. It will even return false for Path('foo/') as pathlib will strip trailing slashes (see python/cpython#65238)

Issue Type

• Bug Report

OS / ENVIRONMENT

ansible-lint --version
ansible-lint 6.17.0 using ansible-core:2.14.6 ruamel-yaml:None ruamel-yaml-clib:None

• ansible installation method: pip
• ansible-lint installation method: pip

STEPS TO REPRODUCE

echo "foo/" > .gitignore
mkdir foo
echo 'foobar' > foo/bar.yml
ansible-lint -v

This will result in following error:

INFO     Loading ignores from .gitignore
WARNING  Listing 1 violation(s) that are fatal
load-failure: Failed to load or parse file.
foo/bar.yml:1


             Rule Violation Summary              
 count tag          profile rule associated tags 
     1 load-failure min     core, unskippable    

Failed after : 1 failure(s), 0 warning(s) on 2 files.

As you can see, it won't be excluded.

Desired Behavior

It should work the same as if the directory is specified without trailing slash:

echo "foo" > .gitignore
mkdir foo
echo 'foobar' > foo/bar.yml
ansible-lint -v

INFO     Loading ignores from .gitignore
INFO     Excluded: foo

Passed with production profile: 0 failure(s), 0 warning(s) on 1 files.

[hille721]

easy fix would be for example to change the lines

ansible-lint/src/ansiblelint/file_utils.py

Lines 563 to 565 in 98063af

	pathspecs.append(
	pathspec.GitIgnoreSpec.from_lines(f.read().splitlines()),
	)

to

pathspecs.append(
    pathspec.GitIgnoreSpec.from_lines(line.strip("/") for line in f.read().splitlines()),
)

[ssbarnea]

@hille721 Thanks for the very well written report! Would you mind making PR to address it?

[hille721]

--exclude foo and --exclude foo/ also have a different behavior. Both are working but with --exclude foo/ ansible-lint will look into foo directory first and then exclude all file individually. This could lead to a light performance impact on large directories.

$ ansible-lint --exclude foo/ -v
INFO     Excluded: foo/bar.yml
INFO     Excluded: foo/bar2.yml

Passed with production profile: 0 failure(s), 0 warning(s) on 0 files.


$ ansible-lint --exclude foo -v
INFO     Excluded: foo

Passed with production profile: 0 failure(s), 0 warning(s) on 0 files.

[hille721]

ok found a similar issue, which the guys from black project had: cpburnz/python-pathspec#65
pathspec version 0.10.3 introduces a new method pathspec.util.append_dir_sep() which we can use in the is_excluded function to fix this issue.
Will do some more tests and provide a PR.

[ssbarnea]

That is brilliant, I wanted to suggest you to look at black as they are heavy users of pathspec.