Backup - update

additional tests

Author: UrszulaNeuman

tests/unit_tests/test_dls_barcode/test_data_store/test_backup.py

@@ -0,0 +1,112 @@
+import unittest
+
+import time
+from mock import MagicMock
+
+from dls_barcode.data_store.backup import Backup
+from dls_barcode.data_store.record import Record
+
+ID0 = "id0"
+ID1 = "id1"
+ID2 = "id2"
+ID3 = "id3"
+
+class TestBackup(unittest.TestCase):
+
+    def setUp(self):
+        self.comms_man = MagicMock()
+        self.backup_time = MagicMock()
+        self.backup_time.value.return_value = 3
+
+    def test_truncate_removes_all_old_records(self):
+        # Arrange
+        records = self._get_records()
+        self.comms_man.load_records_from_file.return_value = records
+
+        # Act
+        backup = Backup(self.comms_man, self.backup_time)
+        orig_size = len(backup._records)
+        backup._truncate_record_list()
+
+        # Assert
+        new_size = len(backup._records)
+        self.assertNotEqual(orig_size, new_size)
+        self.assertEqual(new_size, 0)
+
+    def test_backup_records_adds_new_records_to_existing_list(self):
+        # Arrange
+        records = self._get_records()
+        self.comms_man.load_records_from_file.return_value = records
+
+        # Act
+        backup = Backup(self.comms_man, self.backup_time)
+        org_size = len(backup._records)
+        backup._truncate_record_list = MagicMock() #mute truncate for the test
+        backup.backup_records(records)
+
+        # Assert
+        self.assertEqual(len(backup._records), 2*org_size)
+
+    def test_backup_records_removes_old_records_when_its_called(self):
+        # Arrange
+        records = self._get_records()
+        self.comms_man.load_records_from_file.return_value = records
+
+        # Act
+        backup = Backup(self.comms_man, self.backup_time)
+        backup.backup_records(records)
+
+        # Assert
+        self.assertEqual(len(backup._records), 0)
+
+    def test_backup_records_to_csv_file(self):
+        #Arrange
+        self.comms_man.to_csv_file = MagicMock()
+        backup = Backup(self.comms_man, self.backup_time)
+
+        # Act
+        backup.backup_records([])
+
+        #Assert
+        self.comms_man.to_csv_file.assert_called_once()
+
+    def test_is_old_returns_true_for_records_older_than_assumed_number_of_weeks(self):
+        # Arrange
+        weeks = self.backup_time.value.return_value
+        timestamp = str(time.time() - 604800 * (weeks + 1))
+        rec_string = "f59c92c1;" + timestamp + ";test.png;None;ABCDE123,ABCDE123;1569:1106:70-2307:1073:68-1944:1071:68"
+        record = Record.from_string(rec_string)
+
+        # Act
+        backup = Backup(self.comms_man, self.backup_time)
+
+        # Assert
+        self.assertTrue(backup._is_old(record))
+
+    def test_is_old_returns_false_for_records_younger_than_assumed_number_of_weeks(self):
+        # Arrange
+        weeks = self.backup_time.value.return_value
+        timestamp = str(time.time() - 604800 * (weeks - 1))
+        rec_string = "f59c92c1;"+timestamp+";test.png;None;ABCDE123,ABCDE123;1569:1106:70-2307:1073:68-1944:1071:68"
+        record = Record.from_string(rec_string)
+
+        # Act
+        backup = Backup(self.comms_man, self.backup_time)
+
+        # Assert
+        self.assertFalse(backup._is_old(record))
+
+    def _get_record_strings(self):
+        str_rep = list()
+        str_rep.append(ID0 + ";1494238923.0;test" + ID0 + ".png;None;DLSL-001,DLSL-010,DLSL-011,DLSL-012;1569:1106:70-2307:1073:68-1944:1071:68")
+        str_rep.append(ID1 + ";1494238922.0;test" + ID1 + ".png;None;DLSL-002,DLSL-010,DLSL-011,DLSL-012;1569:1106:70-2307:1073:68-1944:1071:68")
+        str_rep.append(ID2 + ";1494238921.0;test" + ID2 + ".png;None;DLSL-003,DLSL-010,DLSL-011,DLSL-012;1569:1106:70-2307:1073:68-1944:1071:68")
+        str_rep.append(ID3 + ";1494238920.0;test" + ID3 + ".png;None;DLSL-004,DLSL-010,DLSL-011,DLSL-012;1569:1106:70-2307:1073:68-1944:1071:68")
+        return str_rep
+
+    def _get_records(self):
+        strings = self._get_record_strings()
+        rep = list()
+        for str in strings:
+            rep.append(Record.from_string(str))
+        return rep

tests/unit_tests/test_dls_barcode/test_data_store/test_comms_manager.py

@@ -0,0 +1,152 @@
+import unittest
+
+import os
+from mock import MagicMock
+
+from dls_barcode.data_store.comms_manager import CommsManager
+from dls_barcode.data_store.record import Record
+
+ID0 = "id0"
+ID1 = "id1"
+ID2 = "id2"
+ID3 = "id3"
+
+
+class TestCommsManager(unittest.TestCase):
+
+    def setUp(self):
+        self.directory = MagicMock()
+        self.directory.value.return_value = 'dir'
+        self.file_name = 'test'
+
+    def test_load_records_from_file_returns_empty_record_list_when_no_file(self):
+        cm = CommsManager(self.directory, self.file_name)
+        records = cm.load_records_from_file()
+
+        self.assertEqual(len(records), 0)
+
+    def test_load_record_skip_invalid_lines(self):
+        # Arrange
+        cm = CommsManager(self.directory, self.file_name)
+        cm._file_manager = MagicMock()
+        cm._file_manager.read_lines.return_value = self._invalid_record_strings()
+
+        # Act
+        records = cm.load_records_from_file()
+
+        # Assert
+        self.assertEqual(len(records), 2)
+        self.assertEqual(records[0].id, ID0)
+        self.assertEqual(records[1].id, ID2)
+
+    def test_to_file_stores_records_in_file(self):
+        # Arrange
+        cm = CommsManager(self.directory, self.file_name)
+        cm._file_manager = MagicMock()
+        file_name = os.path.join(self.directory.value.return_value, self.file_name + ".txt")
+        records = self._get_records()
+
+        # Act
+        cm.to_file(records)
+
+        # Assert
+        ((filename_used, record_lines_used), kwargs) = cm._file_manager.write_lines.call_args_list[0]
+        self.assertIn(file_name, filename_used)
+        for r, l in zip(records, record_lines_used):
+            self.assertIn(r.to_string(), l)
+
+    def test_to_file_csv_store_in_csv_file(self):
+        # Arrange
+        cm = CommsManager(self.directory, self.file_name)
+        cm._file_manager = MagicMock()
+        file_name = os.path.join(self.directory.value.return_value, self.file_name + ".csv")
+        records = self._get_records()
+
+        # Act
+        cm.to_csv_file(records)
+
+        # Assert
+        ((filename_used, record_lines_used), kwargs) = cm._file_manager.write_lines.call_args_list[0]
+        self.assertEqual(file_name, filename_used)
+        for r, l in zip(records, record_lines_used):
+            self.assertIn(r.to_csv_string(), l)
+
+    def test_make_image_dir_attempts_to_make_dir_if_it_does_not_exist(self):
+        # Arrange
+        cm = CommsManager(self.directory, self.file_name)
+        cm._file_manager = MagicMock()
+        cm._file_manager.is_dir.return_value = False
+        img_dir = os.path.join(self.directory.value.return_value, "img_dir")
+
+        # Act
+        cm.make_img_dir()
+
+        # Assert
+        cm._file_manager.is_dir.assert_called_once_with(img_dir)
+        cm._file_manager.make_dir.assert_called_once_with(img_dir)
+
+    def test_make_image_dir_doent_make_dir_if_it_does_not_exist(self):
+
+        # Arrange
+        cm = CommsManager(self.directory, self.file_name)
+        cm._file_manager = MagicMock()
+        cm._file_manager.is_dir.return_value = True
+        img_dir = os.path.join(self.directory.value.return_value, "img_dir")
+
+        # Act
+        cm.make_img_dir()
+
+        # Assert
+        cm._file_manager.is_dir.assert_called_once_with(img_dir)
+        cm._file_manager.make_dir.assert_not_called()
+
+    def test_remove_image_file_attempts_to_remove_file_when_it_exists(self):
+        # Arrange
+        cm = CommsManager(self.directory, self.file_name)
+        cm._file_manager = MagicMock()
+        cm._file_manager.is_file.return_value = True
+
+        # Act
+        cm.remove_img_file(MagicMock())
+
+        # Assert
+        cm._file_manager.remove.assert_called_once()
+
+    def test_remove_image_file_does_not_attempt_to_remove_file_when_it_exists(self):
+        # Arrange
+        cm = CommsManager(self.directory, self.file_name)
+        cm._file_manager = MagicMock()
+        cm._file_manager.is_file.return_value = False
+
+        # Act
+        cm.remove_img_file(MagicMock())
+
+        # Assert
+        cm._file_manager.remove.assert_not_called()
+
+
+    def _invalid_record_strings(self):
+        str_rep = list()
+        str_rep.append(ID0 + ";1494238925.0;test.png;None;DLSL-009,DLSL-010,DLSL-011,DLSL-012;1569:1106:70-2307:1073:68-1944:1071:68")
+        str_rep.append(ID1 + ";Invalid record string")
+        str_rep.append(ID2 + ";1494238921.0;test.png;None;DLSL-008,DLSL-010,DLSL-011,DLSL-012;1569:1106:70-2307:1073:68-1944:1071:68")
+        return str_rep
+
+    def _get_record_strings(self):
+        str_rep = list()
+        str_rep.append(ID0 + ";1494238923.0;test" + ID0 + ".png;None;DLSL-001,DLSL-010,DLSL-011,DLSL-012;1569:1106:70-2307:1073:68-1944:1071:68")
+        str_rep.append(ID1 + ";1494238922.0;test" + ID1 + ".png;None;DLSL-002,DLSL-010,DLSL-011,DLSL-012;1569:1106:70-2307:1073:68-1944:1071:68")
+        str_rep.append(ID2 + ";1494238921.0;test" + ID2 + ".png;None;DLSL-003,DLSL-010,DLSL-011,DLSL-012;1569:1106:70-2307:1073:68-1944:1071:68")
+        str_rep.append(ID3 + ";1494238920.0;test" + ID3 + ".png;None;DLSL-004,DLSL-010,DLSL-011,DLSL-012;1569:1106:70-2307:1073:68-1944:1071:68")
+        return str_rep
+
+    def _get_records(self):
+        strings = self._get_record_strings()
+        rep = list()
+        for str in strings:
+            rep.append(Record.from_string(str))
+        return rep
+
+
+
+