tests: Stop using open()’s default encoding

In general, using open()’s default encoding is a mistake [1]. This
change makes sure that every time open() is called, the encoding
parameter is specified. Specifically, it makes it so that all tests
succeed when run like this:

	python -X warn_default_encoding -W error::EncodingWarning -m unittest discover

[1]: <https://peps.python.org/pep-0597/#using-the-default-encoding-is-a-common-mistake>

Author: Jayman2000

tests/common.py

@@ -150,8 +150,9 @@ def build_temp_workspace(files):
         else:
             if isinstance(content, Blob):
                 content = content.text.encode(content.encoding)
-            mode = 'wb' if isinstance(content, bytes) else 'w'
-            with open(path, mode) as f:
+            elif isinstance(content, str):
+                content = content.encode('utf_8')
+            with open(path, 'wb') as f:
                 f.write(content)
 
     return tempdir

tests/test_cli.py

@@ -283,14 +283,14 @@ def test_run_with_implicit_extends_config(self):
             (ctx.returncode, ctx.stdout, ctx.stderr), (0, expected_out, ''))
 
     def test_run_with_config_file(self):
-        with open(os.path.join(self.wd, 'config'), 'w') as f:
+        with open(os.path.join(self.wd, 'config'), 'w', encoding='utf_8') as f:
             f.write('rules: {trailing-spaces: disable}')
 
         with RunContext(self) as ctx:
             cli.run(('-c', f.name, os.path.join(self.wd, 'a.yaml')))
         self.assertEqual(ctx.returncode, 0)
 
-        with open(os.path.join(self.wd, 'config'), 'w') as f:
+        with open(os.path.join(self.wd, 'config'), 'w', encoding='utf_8') as f:
             f.write('rules: {trailing-spaces: enable}')
 
         with RunContext(self) as ctx:
@@ -306,14 +306,14 @@ def test_run_with_user_global_config_file(self):
         self.addCleanup(os.environ.__delitem__, 'HOME')
         os.environ['HOME'] = home
 
-        with open(config, 'w') as f:
+        with open(config, 'w', encoding='utf_8') as f:
             f.write('rules: {trailing-spaces: disable}')
 
         with RunContext(self) as ctx:
             cli.run((os.path.join(self.wd, 'a.yaml'), ))
         self.assertEqual(ctx.returncode, 0)
 
-        with open(config, 'w') as f:
+        with open(config, 'w', encoding='utf_8') as f:
             f.write('rules: {trailing-spaces: enable}')
 
         with RunContext(self) as ctx:
@@ -326,7 +326,8 @@ def test_run_with_user_xdg_config_home_in_env(self):
         with tempfile.TemporaryDirectory('w') as d:
             os.environ['XDG_CONFIG_HOME'] = d
             os.makedirs(os.path.join(d, 'yamllint'))
-            with open(os.path.join(d, 'yamllint', 'config'), 'w') as f:
+            path = os.path.join(d, 'yamllint', 'config')
+            with open(path, 'w', encoding='utf_8') as f:
                 f.write('extends: relaxed')
             with RunContext(self) as ctx:
                 cli.run(('-f', 'parsable', os.path.join(self.wd, 'warn.yaml')))
@@ -336,15 +337,15 @@ def test_run_with_user_xdg_config_home_in_env(self):
     def test_run_with_user_yamllint_config_file_in_env(self):
         self.addCleanup(os.environ.__delitem__, 'YAMLLINT_CONFIG_FILE')
 
-        with tempfile.NamedTemporaryFile('w') as f:
+        with tempfile.NamedTemporaryFile('w', encoding='utf_8') as f:
             os.environ['YAMLLINT_CONFIG_FILE'] = f.name
             f.write('rules: {trailing-spaces: disable}')
             f.flush()
             with RunContext(self) as ctx:
                 cli.run((os.path.join(self.wd, 'a.yaml'), ))
             self.assertEqual(ctx.returncode, 0)
 
-        with tempfile.NamedTemporaryFile('w') as f:
+        with tempfile.NamedTemporaryFile('w', encoding='utf_8') as f:
             os.environ['YAMLLINT_CONFIG_FILE'] = f.name
             f.write('rules: {trailing-spaces: enable}')
             f.flush()
@@ -488,7 +489,11 @@ def test_run_default_format_output_in_tty(self):
         # Create a pseudo-TTY and redirect stdout to it
         old_stdout = sys.stdout
         master, slave = pty.openpty()
-        sys.stdout = os.fdopen(slave, 'w')
+        sys.stdout = os.fdopen(
+            slave,
+            'w',
+            encoding=os.device_encoding(slave)
+        )
 
         with self.assertRaises(SystemExit) as ctx:
             cli.run((path, ))
@@ -497,7 +502,7 @@ def test_run_default_format_output_in_tty(self):
         self.assertEqual(ctx.exception.code, 1)
 
         # Read output from TTY
-        output = os.fdopen(master, 'r')
+        output = os.fdopen(master, 'r', encoding=os.device_encoding(master))
         os.set_blocking(master, False)
 
         out = output.read().replace('\r\n', '\n')

tests/test_config.py

@@ -259,7 +259,7 @@ def test_extend_on_object(self):
         self.assertEqual(len(new.enabled_rules(None)), 2)
 
     def test_extend_on_file(self):
-        with tempfile.NamedTemporaryFile('w') as f:
+        with tempfile.NamedTemporaryFile('w', encoding='utf_8') as f:
             f.write('rules:\n'
                     '  colons:\n'
                     '    max-spaces-before: 0\n'
@@ -278,7 +278,7 @@ def test_extend_on_file(self):
         self.assertEqual(len(c.enabled_rules(None)), 2)
 
     def test_extend_remove_rule(self):
-        with tempfile.NamedTemporaryFile('w') as f:
+        with tempfile.NamedTemporaryFile('w', encoding='utf_8') as f:
             f.write('rules:\n'
                     '  colons:\n'
                     '    max-spaces-before: 0\n'
@@ -297,7 +297,7 @@ def test_extend_remove_rule(self):
         self.assertEqual(len(c.enabled_rules(None)), 1)
 
     def test_extend_edit_rule(self):
-        with tempfile.NamedTemporaryFile('w') as f:
+        with tempfile.NamedTemporaryFile('w', encoding='utf_8') as f:
             f.write('rules:\n'
                     '  colons:\n'
                     '    max-spaces-before: 0\n'
@@ -319,7 +319,7 @@ def test_extend_edit_rule(self):
         self.assertEqual(len(c.enabled_rules(None)), 2)
 
     def test_extend_reenable_rule(self):
-        with tempfile.NamedTemporaryFile('w') as f:
+        with tempfile.NamedTemporaryFile('w', encoding='utf_8') as f:
             f.write('rules:\n'
                     '  colons:\n'
                     '    max-spaces-before: 0\n'
@@ -339,7 +339,7 @@ def test_extend_reenable_rule(self):
         self.assertEqual(len(c.enabled_rules(None)), 2)
 
     def test_extend_recursive_default_values(self):
-        with tempfile.NamedTemporaryFile('w') as f:
+        with tempfile.NamedTemporaryFile('w', encoding='utf_8') as f:
             f.write('rules:\n'
                     '  braces:\n'
                     '    max-spaces-inside: 1248\n')
@@ -354,7 +354,7 @@ def test_extend_recursive_default_values(self):
         self.assertEqual(c.rules['braces']['min-spaces-inside-empty'], 2357)
         self.assertEqual(c.rules['braces']['max-spaces-inside-empty'], -1)
 
-        with tempfile.NamedTemporaryFile('w') as f:
+        with tempfile.NamedTemporaryFile('w', encoding='utf_8') as f:
             f.write('rules:\n'
                     '  colons:\n'
                     '    max-spaces-before: 1337\n')
@@ -366,8 +366,8 @@ def test_extend_recursive_default_values(self):
         self.assertEqual(c.rules['colons']['max-spaces-before'], 1337)
         self.assertEqual(c.rules['colons']['max-spaces-after'], 1)
 
-        with tempfile.NamedTemporaryFile('w') as f1, \
-                tempfile.NamedTemporaryFile('w') as f2:
+        with tempfile.NamedTemporaryFile('w', encoding='utf_8') as f1, \
+                tempfile.NamedTemporaryFile('w', encoding='utf_8') as f2:
             f1.write('rules:\n'
                      '  colons:\n'
                      '    max-spaces-before: 1337\n')
@@ -384,7 +384,7 @@ def test_extend_recursive_default_values(self):
         self.assertEqual(c.rules['colons']['max-spaces-after'], 1)
 
     def test_extended_ignore_str(self):
-        with tempfile.NamedTemporaryFile('w') as f:
+        with tempfile.NamedTemporaryFile('w', encoding='utf_8') as f:
             f.write('ignore: |\n'
                     '  *.template.yaml\n')
             f.flush()
@@ -394,7 +394,7 @@ def test_extended_ignore_str(self):
         self.assertEqual(c.ignore.match_file('test.yaml'), False)
 
     def test_extended_ignore_list(self):
-        with tempfile.NamedTemporaryFile('w') as f:
+        with tempfile.NamedTemporaryFile('w', encoding='utf_8') as f:
             f.write('ignore:\n'
                     '  - "*.template.yaml"\n')
             f.flush()
@@ -564,7 +564,8 @@ def test_no_ignore(self):
         )))
 
     def test_run_with_ignore_str(self):
-        with open(os.path.join(self.wd, '.yamllint'), 'w') as f:
+        path = os.path.join(self.wd, '.yamllint')
+        with open(path, 'w', encoding='utf_8') as f:
             f.write('extends: default\n'
                     'ignore: |\n'
                     '  *.dont-lint-me.yaml\n'
@@ -618,7 +619,8 @@ def test_run_with_ignore_str(self):
         )))
 
     def test_run_with_ignore_list(self):
-        with open(os.path.join(self.wd, '.yamllint'), 'w') as f:
+        path = os.path.join(self.wd, '.yamllint')
+        with open(path, 'w', encoding='utf_8') as f:
             f.write('extends: default\n'
                     'ignore:\n'
                     '  - "*.dont-lint-me.yaml"\n'
@@ -672,19 +674,22 @@ def test_run_with_ignore_list(self):
         )))
 
     def test_run_with_ignore_from_file(self):
-        with open(os.path.join(self.wd, '.yamllint'), 'w') as f:
+        path = os.path.join(self.wd, '.yamllint')
+        with open(path, 'w', encoding='utf_8') as f:
             f.write('extends: default\n'
                     'ignore-from-file: .gitignore\n'
                     'rules:\n'
                     '  key-duplicates:\n'
                     '    ignore-from-file: .ignore-key-duplicates\n')
 
-        with open(os.path.join(self.wd, '.gitignore'), 'w') as f:
+        path = os.path.join(self.wd, '.gitignore')
+        with open(path, 'w', encoding='utf_8') as f:
             f.write('*.dont-lint-me.yaml\n'
                     '/bin/\n'
                     '!/bin/*.lint-me-anyway.yaml\n')
 
-        with open(os.path.join(self.wd, '.ignore-key-duplicates'), 'w') as f:
+        path = os.path.join(self.wd, '.ignore-key-duplicates')
+        with open(path, 'w', encoding='utf_8') as f:
             f.write('/ign-dup\n')
 
         sys.stdout = StringIO()
@@ -729,13 +734,16 @@ def test_run_with_ignore_from_file(self):
         )))
 
     def test_run_with_ignored_from_file(self):
-        with open(os.path.join(self.wd, '.yamllint'), 'w') as f:
+        path = os.path.join(self.wd, '.yamllint')
+        with open(path, 'w', encoding='utf_8') as f:
             f.write('ignore-from-file: [.gitignore, .yamlignore]\n'
                     'extends: default\n')
-        with open(os.path.join(self.wd, '.gitignore'), 'w') as f:
+        path = os.path.join(self.wd, '.gitignore')
+        with open(path, 'w', encoding='utf_8') as f:
             f.write('*.dont-lint-me.yaml\n'
                     '/bin/\n')
-        with open(os.path.join(self.wd, '.yamlignore'), 'w') as f:
+        path = os.path.join(self.wd, '.yamlignore')
+        with open(path, 'w', encoding='utf_8') as f:
             f.write('!/bin/*.lint-me-anyway.yaml\n')
 
         sys.stdout = StringIO()
@@ -794,7 +802,7 @@ def test_run_with_ignore_with_broken_symlink(self):
             cli.run(('-f', 'parsable', '.'))
         self.assertNotEqual(ctx.returncode, 0)
 
-        with open(os.path.join(wd, '.yamllint'), 'w') as f:
+        with open(os.path.join(wd, '.yamllint'), 'w', encoding='utf_8') as f:
             f.write('extends: default\n'
                     'ignore: |\n'
                     '  *404.yaml\n')
@@ -812,7 +820,8 @@ def test_run_with_ignore_with_broken_symlink(self):
         shutil.rmtree(wd)
 
     def test_run_with_ignore_on_ignored_file(self):
-        with open(os.path.join(self.wd, '.yamllint'), 'w') as f:
+        path = os.path.join(self.wd, '.yamllint')
+        with open(path, 'w', encoding='utf_8') as f:
             f.write('ignore: file.dont-lint-me.yaml\n'
                     'rules:\n'
                     '  trailing-spaces: enable\n'

tests/test_module.py

@@ -28,12 +28,14 @@ def setUp(self):
         self.wd = tempfile.mkdtemp(prefix='yamllint-tests-')
 
         # file with only one warning
-        with open(os.path.join(self.wd, 'warn.yaml'), 'w') as f:
+        path = os.path.join(self.wd, 'warn.yaml')
+        with open(path, 'w', encoding='utf_8') as f:
             f.write('key: value\n')
 
         # file in dir
         os.mkdir(os.path.join(self.wd, 'sub'))
-        with open(os.path.join(self.wd, 'sub', 'nok.yaml'), 'w') as f:
+        path = os.path.join(self.wd, 'sub', 'nok.yaml')
+        with open(path, 'w', encoding='utf_8') as f:
             f.write('---\n'
                     'list: [  1, 1, 2, 3, 5, 8]  \n')