Add checks if output files are missing (#55)

* Add checks for missing output files

* Add tests

* Split code into functions

* Add tests

* Fix tests

* Add more comments and split into smaller functions

* Update src/sinol_make/commands/run/__init__.py

Co-authored-by: Tomasz Nowak <[email protected]>

* Fix spelling mistake

* Fix tests

---------

Co-authored-by: Tomasz Nowak <[email protected]>

Author: MasloMaslane

src/sinol_make/commands/run/__init__.py

@@ -2,6 +2,7 @@
 # Author of the original code: Bartosz Kostka <[email protected]>
 # Version 0.6 (2021-08-29)
 import subprocess
+import glob
 
 from sinol_make.commands.run.structs import ExecutionResult, ResultChange, ValidationResult, ExecutionData, PointsChange
 from sinol_make.helpers.parsers import add_compilation_arguments
@@ -155,6 +156,10 @@ def get_output_file(self, test_path):
         return os.path.join("out", os.path.split(os.path.splitext(test_path)[0])[1]) + ".out"
 
 
+    def get_groups(self, tests):
+        return sorted(list(set([self.get_group(test) for test in tests])))
+
+
     def compile_solutions(self, solutions):
         os.makedirs(self.COMPILATION_DIR, exist_ok=True)
         os.makedirs(self.EXECUTABLES_DIR, exist_ok=True)
@@ -808,7 +813,7 @@ def exit(self):
 
     def set_scores(self):
         self.tests = package_util.get_tests(self.args.tests)
-        self.groups = list(sorted(set([self.get_group(test) for test in self.tests])))
+        self.groups = self.get_groups(self.tests)
         self.scores = collections.defaultdict(int)
 
         if 'scores' not in self.config.keys():
@@ -846,6 +851,49 @@ def set_scores(self):
 
         self.possible_score = self.get_possible_score(self.groups)
 
+    def get_valid_input_files(self):
+        """
+        Returns list of input files that have corresponding output file.
+        """
+        output_tests = glob.glob(os.path.join(os.getcwd(), "out", "*.out"))
+        output_tests_ids = [self.extract_test_id(test) for test in output_tests]
+        valid_input_files = []
+        for test in self.tests:
+            if self.extract_test_id(test) in output_tests_ids:
+                valid_input_files.append(test)
+        return valid_input_files
+
+    def validate_existence_of_outputs(self):
+        """
+        Checks if all input files have corresponding output files.
+        """
+        valid_input_files = self.get_valid_input_files()
+        if len(valid_input_files) != len(self.tests):
+            missing_tests = list(set(self.tests) - set(valid_input_files))
+            missing_tests.sort()
+
+            print(util.warning('Missing output files for tests: ' + ', '.join(
+                [self.extract_file_name(test) for test in missing_tests])))
+            print(util.warning('Running only on tests with output files.'))
+            self.tests = valid_input_files
+            self.groups = self.get_groups(self.tests)
+
+    def check_are_any_tests_to_run(self):
+        """
+        Checks if there are any tests to run and prints them and checks
+        if all input files have corresponding output files.
+        """
+        if len(self.tests) > 0:
+            print(util.bold('Tests that will be run:'), ' '.join([self.extract_file_name(test) for test in self.tests]))
+
+            example_tests = [test for test in self.tests if self.get_group(test) == 0]
+            if len(example_tests) == len(self.tests):
+                print(util.warning('Running only on example tests.'))
+
+            self.validate_existence_of_outputs()
+        else:
+            print(util.warning('There are no tests to run.'))
+
     def check_errors(self, results: dict[str, dict[str, dict[str, ExecutionResult]]]):
         error_msg = ""
         for solution in results:
@@ -909,15 +957,7 @@ def run(self, args):
             self.checker = None
 
         self.set_scores()
-
-        if len(self.tests) > 0:
-            print(util.bold('Tests that will be run:'), ' '.join([self.extract_file_name(test) for test in self.tests]))
-
-            example_tests = [test for test in self.tests if self.get_group(test) == 0]
-            if len(example_tests) == len(self.tests):
-                print(util.warning('Running only on example tests.'))
-        else:
-            print(util.warning('There are no tests to run.'))
+        self.check_are_any_tests_to_run()
 
         self.failed_compilations = []
         solutions = self.get_solutions(self.args.solutions)

tests/commands/run/test_integration.py

@@ -189,3 +189,29 @@ def test_no_scores(capsys, create_package, time_tool):
 
     out = capsys.readouterr().out
     assert "Scores are not defined in config.yml. Points will be assigned equally to all groups." in out
+
+
+@pytest.mark.parametrize("create_package", [get_simple_package_path(), get_verify_status_package_path()], indirect=True)
+def test_missing_output_files(capsys, create_package):
+    """
+    Test with missing output files.
+    """
+    package_path = create_package
+    command = get_command()
+    create_ins_outs(package_path)
+
+    outs = glob.glob(os.path.join(package_path, "out", "*.out"))
+    outs.sort()
+    os.unlink(outs[0])
+    os.unlink(outs[1])
+    out1 = command.extract_file_name(outs[0]).replace(".out", ".in")
+    out2 = command.extract_file_name(outs[1]).replace(".out", ".in")
+
+    parser = configure_parsers()
+    args = parser.parse_args(["run", "--time_tool", "time"])
+    command = Command()
+    with pytest.raises(SystemExit):
+        command.run(args)
+
+    out = capsys.readouterr().out
+    assert f'Missing output files for tests: {out1}, {out2}' in out

tests/commands/run/test_unit.py

@@ -403,7 +403,7 @@ def test_print_expected_scores_diff(capsys, create_package):
     }
 
 
-@pytest.mark.parametrize("create_package", [get_simple_package_path()], indirect=["create_package"])
+@pytest.mark.parametrize("create_package", [get_simple_package_path()], indirect=True)
 def test_set_scores(create_package):
     """
     Test set_scores function.
@@ -423,3 +423,21 @@ def test_set_scores(create_package):
         5: 16,
         6: 20
     }
+
+
+@pytest.mark.parametrize("create_package", [get_simple_package_path(), get_verify_status_package_path()], indirect=True)
+def test_get_valid_input_files(create_package):
+    """
+    Test get_valid_input_files function.
+    """
+    package_path = create_package
+    command = get_command(package_path)
+    create_ins_outs(package_path)
+    command.tests = package_util.get_tests(None)
+
+    outputs = glob.glob(os.path.join(package_path, "out", "*.out"))
+    os.unlink(outputs[0])
+    valid_inputs = command.get_valid_input_files()
+    assert len(valid_inputs) == len(outputs) - 1
+    assert "in/" + os.path.basename(outputs[0].replace(".out", ".in")) not in valid_inputs
+    assert "in/" + os.path.basename(outputs[1].replace(".out", ".in")) in valid_inputs