Run CI tests also on windows

Author: Otto-AA

.github/workflows/tests.yml

@@ -4,13 +4,13 @@ on: [push, pull_request]
 
 jobs:
   tests:
-    name: Test Python ${{ matrix.python-version }}
-    # Todo: Revert to ubuntu-latest when Python 3.7 support no longer needed
-    runs-on: ubuntu-22.04
+    name: Test ${{ matrix.os }} - ${{ matrix.python-version }}
+    runs-on: ${{ matrix.os }}
     strategy:
       fail-fast: false
       matrix:
         python-version: ["3.13", "3.12", "3.11", "3.10", "3.9"]
+        os: [ubuntu-latest, windows-latest]
     steps:
       - name: Checkout
         uses: actions/checkout@v3

e2e_projects/config/tests/test_main.py

@@ -21,6 +21,6 @@ def test_max_stack_depth():
 def test_data_exists():
     path = (Path("data") / "data.json").resolve()
     assert path.exists()
-    with open(path) as f:
+    with open(path, encoding='utf-8') as f:
         data = json.load(f)
         assert data['comment'] == 'this should be copied to the mutants folder'

mutmut/__main__.py

@@ -11,7 +11,6 @@
 import multiprocessing
 import multiprocessing.connection
 import os
-import resource
 import shutil
 import signal
 import subprocess
@@ -230,14 +229,14 @@ def copy_also_copy_files():
 def create_mutants_for_file(filename, output_path):
     input_stat = os.stat(filename)
 
-    with open(filename) as f:
+    with open(filename, encoding='utf-8') as f:
         source = f.read()
 
-    with open(output_path, 'w') as out:
+    with open(output_path, 'w', encoding='utf-8') as out:
         mutant_names, hash_by_function_name = write_all_mutants_to_file(out=out, source=source, filename=filename)
 
     # validate no syntax errors of mutants
-    with open(output_path) as f:
+    with open(output_path, encoding='utf-8') as f:
         try:
             ast.parse(f.read())
         except (IndentationError, SyntaxError) as e:
@@ -282,7 +281,7 @@ def __init__(self, *, path):
 
     def load(self):
         try:
-            with open(self.meta_path) as f:
+            with open(self.meta_path, encoding='utf-8') as f:
                 self.meta = json.load(f)
         except FileNotFoundError:
             return
@@ -309,7 +308,7 @@ def stop_children(self):
             os.kill(pid, SIGTERM)
 
     def save(self):
-        with open(self.meta_path, 'w') as f:
+        with open(self.meta_path, 'w', encoding='utf-8') as f:
             json.dump(dict(
                 exit_code_by_key=self.exit_code_by_key,
                 hash_by_function_name=self.hash_by_function_name,
@@ -507,6 +506,9 @@ def status_printer():
     last_update = [datetime(1900, 1, 1)]
     update_threshold = timedelta(seconds=0.1)
 
+    # support the spinner chars on windows
+    sys.__stdout__.reconfigure(encoding='utf-8')
+
     def p(s, *, force_output=False):
         if not force_output and (datetime.now() - last_update[0]) < update_threshold:
             return
@@ -781,7 +783,7 @@ def collect_or_load_stats(runner):
 def load_stats():
     did_load = False
     try:
-        with open('mutants/mutmut-stats.json') as f:
+        with open('mutants/mutmut-stats.json', encoding='utf-8') as f:
             data = json.load(f)
             for k, v in data.pop('tests_by_mangled_function_name').items():
                 mutmut.tests_by_mangled_function_name[k] |= set(v)
@@ -795,7 +797,7 @@ def load_stats():
 
 
 def save_stats():
-    with open('mutants/mutmut-stats.json', 'w') as f:
+    with open('mutants/mutmut-stats.json', 'w', encoding='utf-8') as f:
         json.dump(dict(
             tests_by_mangled_function_name={k: list(v) for k, v in mutmut.tests_by_mangled_function_name.items()},
             duration_by_test=mutmut.duration_by_test,
@@ -1078,6 +1080,7 @@ def _test_mutation(task: Task):
             # TODO: implement timeout for windows + unix
             # estimated_time_of_tests = m.estimated_time_of_tests_by_mutant[mutant_name]
             # cpu_time_limit = ceil((estimated_time_of_tests + 1) * 2 + process_time()) * 10
+            # import resource
             # resource.setrlimit(resource.RLIMIT_CPU, (cpu_time_limit, cpu_time_limit))
 
             with CatchOutput():
@@ -1086,7 +1089,7 @@ def _test_mutation(task: Task):
         return result
         # os._exit(result)
     except Exception as e:
-        with open(f'error.{mutant_name}.log', 'w') as log:
+        with open(f'error.{mutant_name}.log', 'w', encoding='utf-8') as log:
             log.write(str(e))
             log.flush()
         return -24
@@ -1120,12 +1123,12 @@ def results(all):
 
 
 def read_mutants_module(path) -> cst.Module:
-    with open(Path('mutants') / path) as f:
+    with open(Path('mutants') / path, encoding='utf-8') as f:
         return cst.parse_module(f.read())
 
 
 def read_orig_module(path) -> cst.Module:
-    with open(path) as f:
+    with open(path, encoding='utf-8') as f:
         return cst.parse_module(f.read())
 
 
@@ -1226,7 +1229,7 @@ def apply_mutant(mutant_name):
 
     new_module: cst.Module = orig_module.deep_replace(original_function, mutant_function) # type: ignore
 
-    with open(path, 'w') as f:
+    with open(path, 'w', encoding='utf-8') as f:
         f.write(new_module.code)
 
 

tests/e2e/test_e2e_result_snapshots.py

@@ -29,18 +29,18 @@ def read_all_stats_for_project(project_path: Path) -> dict[str, dict]:
                 continue
             data = SourceFileMutationData(path=p)
             data.load()
-            stats[str(data.meta_path)] = data.exit_code_by_key
+            stats[str(data.meta_path.as_posix())] = data.exit_code_by_key
 
         return stats
 
 
 def read_json_file(path: Path):
-    with open(path, 'r') as file:
+    with open(path, 'r', encoding='utf-8') as file:
         return json.load(file)
 
 
 def write_json_file(path: Path, data: Any):
-    with open(path, 'w') as file:
+    with open(path, 'w', encoding='utf-8') as file:
         json.dump(data, file, indent=2)