Merge branch 'fix-crash-dimacs-reader-when-it-should'

Author: SamyAB

CHANGELOG.md

@@ -4,6 +4,10 @@ All notable changes to this project will be documented in this file.
 The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/),
 and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html).
 
+## [1.0.2] - 2020-06-30
+### Fixed
+- Ensure the DIMACS file reader crashes when it reads a literal number higher than the number of literals
+
 ## [1.0.1] - 2020-06-27
 ### Fixed
 - Reader of DIMACS CNF formula format to handle toughsat generated formulae

cugen/sat_problem_modelling/dimacs_reader.py

@@ -16,7 +16,7 @@ def transform_dimacs_clause_to_cugen_clause(dimacs_clause: str, number_of_litera
 
     for literal in signed_literals:
         literal_as_integer = int(literal)
-        literal_as_index = cupy.absolute(literal_as_integer) - 1
+        literal_as_index = int(cupy.absolute(literal_as_integer) - 1)
 
         if cupy.isnan(cugen_clause[literal_as_index]):
             cugen_clause[literal_as_index] = 0 if literal_as_integer < 0 else 1

tests/test_sat_problem_modelling/test_dimacs_reader.py

@@ -1,6 +1,7 @@
 from unittest.mock import patch, call
 
 import cupy
+import pytest
 
 from cugen.sat_problem_modelling.dimacs_reader import transform_dimacs_clause_to_cugen_clause, read_dimacs_file
 
@@ -49,6 +50,17 @@ def test_transform_dimacs_clause_to_cugen_clause_transforms_contradicting_litera
     cupy.testing.assert_array_equal(cugen_clause_with_nans, expected_cugen_clause_with_nans)
 
 
+def test_transform_dimacs_clause_to_cugen_clause_raises_exception_when_literal_is_out_of_bounds():
+    # Given
+    clause_with_literal_out_of_bounds = '42 -246 528 0\n'
+    number_of_literals = 527
+
+    # Then
+    with pytest.raises(IndexError):
+        # When
+        _ = transform_dimacs_clause_to_cugen_clause(clause_with_literal_out_of_bounds, number_of_literals)
+
+
 @patch(f'{TESTED_MODULE}.transform_dimacs_clause_to_cugen_clause', return_value=cupy.array([1, 2, 3]))
 def test_read_dimacs_file_finds_the_right_number_of_literals_and_loops_over_clauses_to_transform_them(
         mock_transform_clause, tmp_path