From 4a399f60bfa1c2e004b1bc1883f1e4bf84e4178f Mon Sep 17 00:00:00 2001
From: =?UTF-8?q?Adrien=20Verg=C3=A9?= <adrienverge@gmail.com>
Date: Fri, 16 Feb 2024 11:28:38 +0100
Subject: [PATCH] cli: Restore ignoration of files passed as command-line
 arguments

Commit 2344380 "Cleanly skip broken symlinks that are ignored" fixed a
problem on symbolic links but also introduced a change on how ignored
files should be treated, depending on whether they're explicitely passed
as command-line arguments or not [^1].

This change is annoying for users that dynamically build the list of
files to pass as arguments, e.g. [^2]:

    find -name '*\.yaml' | xargs yamllint

The present commit adds unit tests for `yamllint [FILES]...` and
`yamllint --list-files [FILES]...`, that passed with previous version
1.34.0, and restore the behavior of this version.

As a result it also reverts the API change of commit 2344380 on
`yamllint.linter.run(stream, config)`.

[^1]: https://github.com/adrienverge/yamllint/issues/657#issuecomment-1948009315
[^2]: https://github.com/adrienverge/yamllint/issues/657#issuecomment-1948093680
---
 tests/test_cli.py    | 19 +++++++++++++++++++
 tests/test_config.py | 17 +++++++++++++++++
 yamllint/cli.py      |  3 ++-
 yamllint/linter.py   |  3 +++
 4 files changed, 41 insertions(+), 1 deletion(-)

diff --git a/tests/test_cli.py b/tests/test_cli.py
index 8b817e44..e0ae0fee 100644
--- a/tests/test_cli.py
+++ b/tests/test_cli.py
@@ -714,6 +714,25 @@ def test_run_list_files(self):
              os.path.join(self.wd, 'warn.yaml')]
         )
 
+        config = 'ignore: ["*.yaml", "*.yml", "!a.yaml"]'
+        with RunContext(self) as ctx:
+            cli.run(('--list-files', '-d', config, self.wd))
+        self.assertEqual(ctx.returncode, 0)
+        self.assertEqual(
+            sorted(ctx.stdout.splitlines()),
+            [os.path.join(self.wd, 'a.yaml')]
+        )
+        with RunContext(self) as ctx:
+            cli.run(('--list-files', '-d', config,
+                     os.path.join(self.wd, 'a.yaml'),
+                     os.path.join(self.wd, 'en.yaml'),
+                     os.path.join(self.wd, 'c.yaml')))
+        self.assertEqual(ctx.returncode, 0)
+        self.assertEqual(
+            sorted(ctx.stdout.splitlines()),
+            [os.path.join(self.wd, 'a.yaml')]
+        )
+
 
 class CommandLineConfigTestCase(unittest.TestCase):
     def test_config_file(self):
diff --git a/tests/test_config.py b/tests/test_config.py
index eec2ade2..fb570c66 100644
--- a/tests/test_config.py
+++ b/tests/test_config.py
@@ -803,3 +803,20 @@ def test_run_with_ignore_with_broken_symlink(self):
 
         os.chdir(backup_wd)
         shutil.rmtree(wd)
+
+    def test_run_with_ignore_on_ignored_file(self):
+        with open(os.path.join(self.wd, '.yamllint'), 'w') as f:
+            f.write('ignore: file.dont-lint-me.yaml\n'
+                    'rules:\n'
+                    '  trailing-spaces: enable\n'
+                    '  key-duplicates:\n'
+                    '    ignore: file-at-root.yaml\n')
+
+        sys.stdout = StringIO()
+        with self.assertRaises(SystemExit):
+            cli.run(('-f', 'parsable', 'file.dont-lint-me.yaml',
+                     'file-at-root.yaml'))
+        self.assertEqual(
+            sys.stdout.getvalue().strip(),
+            'file-at-root.yaml:4:17: [error] trailing spaces (trailing-spaces)'
+        )
diff --git a/yamllint/cli.py b/yamllint/cli.py
index 6fe43507..9a39bd8c 100644
--- a/yamllint/cli.py
+++ b/yamllint/cli.py
@@ -210,7 +210,8 @@ def run(argv=None):
 
     if args.list_files:
         for file in find_files_recursively(args.files, conf):
-            print(file)
+            if not conf.is_file_ignored(file):
+                print(file)
         sys.exit(0)
 
     max_level = 0
diff --git a/yamllint/linter.py b/yamllint/linter.py
index 5d283f99..a2faa061 100644
--- a/yamllint/linter.py
+++ b/yamllint/linter.py
@@ -222,6 +222,9 @@ def run(input, conf, filepath=None):
     :param input: buffer, string or stream to read from
     :param conf: yamllint configuration object
     """
+    if filepath is not None and conf.is_file_ignored(filepath):
+        return ()
+
     if isinstance(input, (bytes, str)):
         return _run(input, conf, filepath)
     elif isinstance(input, io.IOBase):