Add unit tests for the table module (latex-access#7)

* Initial unit test for the table module

* Add more tests for table module.

* Fix typo.

* Try to fix another error.

* Additional tests for table module.

* Introduce test checking that the table module cannot be executed as a file

* Split some long lines

* Try to get stdout

* Handle exit code being different on *nix

Co-authored-by: jakubl7545 <[email protected]>

latex_access/tests/test_table.py

@@ -0,0 +1,109 @@
+import os
+import subprocess
+import sys
+import unittest
+
+try:
+    import latex_access.table as table_module
+except SyntaxError:
+    FAILED_TO_IMPORT_TABLE_MODULE = True
+else:
+    FAILED_TO_IMPORT_TABLE_MODULE = False
+
+
+@unittest.skipIf(
+    FAILED_TO_IMPORT_TABLE_MODULE,
+    "Table module is incompatible with the current version of Python"
+)
+class TestTable(unittest.TestCase):
+
+    def test_Build_header_row(self):
+        """Test for the `BuildHeaderString` method.
+        """
+        self.assertEqual(
+            table_module.BuildHeaderString(
+                "Name & Surname & Age \\\\ \\hline \n"
+            ),
+            ["Name ", " Surname ", " Age   "]
+        )
+
+    def test_where_am_i(self):
+        """Tests that information about current location in table
+        is properly retrieved.
+        """
+        self.assertEqual(
+            table_module.WhereAmI(
+                '4&5',
+                ['1', '2', '3'],
+                '1&2&3\\\\4&5&6'
+            ),
+            'focus is in column 2 at location B 2'
+        )
+
+    def test_invalid_table(self):
+        """Tests that proper message is returned for invalid table."""
+        self.assertEqual(
+            table_module.WhereAmI(
+                '4&5&6&7',
+                ['1', '2', '3'],
+                '1&2&3\\4&5&6'
+            ),
+            "outside table"
+        )
+
+    def test_get_table_top_row(self):
+        """Tests that table's top row is properly retrieved."""
+        self.assertEqual(
+            table_module.GetTableTopRow('1&2&3\\\\4&5&6'), '1&2&3'
+        )
+
+    def test_get_table_current_row(self):
+        """Tests that table's current row is properly retrieved"""
+        # The tested function is wrongly implemented
+        # that's why returned row has backslash sign at the start.
+        # This will be fixed later and this test will be corrected too.
+        self.assertEqual(
+            table_module.GetTableCurrentRow(
+                '1&2&3\\\\4&5&6\\\\7&8&9'
+            ),
+            '\\7&8&9'
+        )
+
+    def test_get_table_position(self):
+        """Tests that cell location is provided as a coordinate."""
+        self.assertEqual(
+            table_module.GetTablePosition('1&2&3\\\\4&5&6', '4&5&6'), 'C 2'
+        )
+
+    def test_two_letter_coordinate(self):
+        """Tests that cell location is provided
+        as a coordinate with two-letter column definition.
+        """
+        self.assertEqual(
+            table_module.GetTablePosition('1&'*26, '1&'*26), 'A A 1'
+        )
+
+    def test_module_running_as_file(self):
+        """Test that the `table` module shows a warning when
+        running innteractively.
+        """
+        modFilePath = os.path.abspath(table_module.__file__)
+        tableSubprocess = subprocess.Popen(
+            (sys.executable, modFilePath),
+            stdout=subprocess.PIPE,
+            universal_newlines=True
+        )
+        tableSubprocess.wait()
+        # The table module exits with exit code set to -1.
+        # On *nix based systems negative exit codes are invalid.
+        # Therefore exit code set to -1 is converted to 255
+        # which represents exit code out of range.
+        # To remain compatible with Windows check for both -1 and 255.
+        self.assertIn(tableSubprocess.returncode, (-1, 255))
+        self.assertEqual(
+            tableSubprocess.stdout.read(),
+            (
+                "This can only be used as a module,"
+                " and does nothing when called interactively.\n"
+            )
+        )