summaryrefslogtreecommitdiffstats
path: root/tests/common.py
diff options
context:
space:
mode:
authorDaniel Baumann <daniel.baumann@progress-linux.org>2024-05-04 00:38:50 +0000
committerDaniel Baumann <daniel.baumann@progress-linux.org>2024-05-04 00:38:50 +0000
commit09e7b47bad7e7310a6f52bdc20e9a9f251e79769 (patch)
treec93d189c1318902b8f1e5333d7ee34a1e9db9a34 /tests/common.py
parentInitial commit. (diff)
downloadyamllint-09e7b47bad7e7310a6f52bdc20e9a9f251e79769.tar.xz
yamllint-09e7b47bad7e7310a6f52bdc20e9a9f251e79769.zip
Adding upstream version 1.33.0.upstream/1.33.0
Signed-off-by: Daniel Baumann <daniel.baumann@progress-linux.org>
Diffstat (limited to 'tests/common.py')
-rw-r--r--tests/common.py86
1 files changed, 86 insertions, 0 deletions
diff --git a/tests/common.py b/tests/common.py
new file mode 100644
index 0000000..65af63b
--- /dev/null
+++ b/tests/common.py
@@ -0,0 +1,86 @@
+# Copyright (C) 2016 Adrien Vergé
+#
+# 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/>.
+
+import contextlib
+import os
+import shutil
+import tempfile
+import unittest
+
+import yaml
+
+from yamllint.config import YamlLintConfig
+from yamllint import linter
+
+
+class RuleTestCase(unittest.TestCase):
+ def build_fake_config(self, conf):
+ if conf is None:
+ conf = {}
+ else:
+ conf = yaml.safe_load(conf)
+ conf = {'extends': 'default',
+ 'rules': conf}
+ return YamlLintConfig(yaml.safe_dump(conf))
+
+ def check(self, source, conf, **kwargs):
+ expected_problems = []
+ for key in kwargs:
+ assert key.startswith('problem')
+ if len(kwargs[key]) > 2:
+ if kwargs[key][2] == 'syntax':
+ rule_id = None
+ else:
+ rule_id = kwargs[key][2]
+ else:
+ rule_id = self.rule_id
+ expected_problems.append(linter.LintProblem(
+ kwargs[key][0], kwargs[key][1], rule=rule_id))
+ expected_problems.sort()
+
+ real_problems = list(linter.run(source, self.build_fake_config(conf)))
+ self.assertEqual(real_problems, expected_problems)
+
+
+def build_temp_workspace(files):
+ tempdir = tempfile.mkdtemp(prefix='yamllint-tests-')
+
+ for path, content in files.items():
+ path = os.path.join(tempdir, path).encode('utf-8')
+ if not os.path.exists(os.path.dirname(path)):
+ os.makedirs(os.path.dirname(path))
+
+ if type(content) is list:
+ os.mkdir(path)
+ else:
+ mode = 'wb' if isinstance(content, bytes) else 'w'
+ with open(path, mode) as f:
+ f.write(content)
+
+ return tempdir
+
+
+@contextlib.contextmanager
+def temp_workspace(files):
+ """Provide a temporary workspace that is automatically cleaned up."""
+ backup_wd = os.getcwd()
+ wd = build_temp_workspace(files)
+
+ try:
+ os.chdir(wd)
+ yield
+ finally:
+ os.chdir(backup_wd)
+ shutil.rmtree(wd)