""" A global template for all tests. """ from modules import internal_io class TestTemplate: def __init__(self, args, agnpath, test_data, queue): """ Simple test template. :param args: List of arguments :type args: argparse.Namespace :param agnpath: The path to the discord folder :type agnpath: agnostic_path.AgnosticPath :param test_data: The data to be tested :type test_data: str """ self.ptb = args.ptb self.agnostic_path = agnpath self.os_name = agnpath.os self.main_path = agnpath.main_path self.test_data = test_data self.is_infected = False self.status_code = "idle" self.status = "Test not yet initialized." self.queue = queue self.set_status("idle") def run_test(self): """ The main runner function, must be implemented by the child class. During the execution of the test, the status code and status MUST be updated. """ self.set_status("running", "The test will begin shortly, please wait...") self.set_status("sucess", "The test was a success but kinda not a success.") def name(self): """ :return: Name of the test :rtype: str """ return str(self.__class__.__name__) def get_status_code(self): """ :return: Status code at the time of call. :rtype: str """ return self.status_code def get_status(self): """ :return: Status at the time of call. :rtype: internal_io.test_status """ return internal_io.test_status(self.name(), self.status_code, self.status) @staticmethod def get_status_from_code(code): """ :param code: The status code to get the status from. :type code: str :return: Description of the status code :rtype: str """ return internal_io.return_code_dict[code] def set_status(self, statuscode: str, message: str = None): """ Sets a new status code. :param statuscode: Status code to set :param message: Message to set :type statuscode: str :return: new status code :rtype: str """ self.status_code = statuscode if message is not None: self.status = message else: self.status = self.get_status_from_code(statuscode) return self.status_code class TestWalkTemplate(TestTemplate): def __init__(self, args, agnpath, test_data, queue): """ Simple test template. :param args: List of arguments :type args: argparse.Namespace :param agnpath: The path to the discord folder :type agnpath: agnostic_path.AgnosticPath :param test_data: The data to be tested :type test_data: str """ super().__init__(args, agnpath, test_data, queue) if test_data is None: self.set_status("problem", "No test data given.") def run_test(self): if self.test_data is None: self.set_status("problem", "No test data given.") return self.get_status() self.set_status("running", "The test will begin shortly, please wait...") for path in self.walk(): self.compare(path, "test", lambda x: True, [], {}) def walk(self): """ Walks the given path and returns a list of all files and directories. :return: List of all files and directories :return: """ return self.agnostic_path.walk_all_files(self.agnostic_path()) def compare(self, path, entry_name, function, args, kwargs): """ Use the function on the given path, with given arguments and compare it with the entry in the test data. :param path: Path to the file or directory :type path: agnostic_path.AgnosticPath :param entry_name: Name of the entry in the test data :type entry_name: str :param function: Function to use on the path :type function: function :param args: Arguments to use on the function :type args: list :param kwargs: Keyword arguments to use on the function :type kwargs: dict """ if path not in self.test_data["files"]: raise ValueError("No entry in test data for path: " + str(path)) if entry_name not in self.test_data["files"][path]: raise ValueError("No entry in test data for path: " + str(path) + " and entry name: " + str(entry_name)) data_origin = self.test_data["files"][path][entry_name] data_result = function(path, *args, **kwargs) if data_origin != data_result: return False return True