def test_check_function_verification_list(commandline_arguments): """Ensure that check verification works for standard functions.""" testargs = [os.getcwd()] with patch.object(sys, "argv", testargs): parsed_arguments, remaining_arguments = arguments.parse( commandline_arguments) args_verified = arguments.verify(parsed_arguments) assert args_verified is True external_checker_directory = checkers.get_checker_dir(parsed_arguments) checker_source = checkers.get_source([external_checker_directory]) check_name = checkers.get_chosen_check(parsed_arguments) check_file = checkers.transform_check(check_name) check_exists = checkers.verify_check_existence(check_file, checker_source) assert check_exists is True # create the check check = checker_source.load_plugin(check_file) # verify that the check has the functions, specified separately assert (checkers.verify_check_functions( check, ["act", "get_parser", "parse"]) is True) # verify that the check has the functions, specified according to defaults assert checkers.verify_check_functions(check) is True # verify that the check does not have the provided functions, specified separately assert (checkers.verify_check_functions( check, ["actWRONG", "get_parser", "parse"]) is False) assert (checkers.verify_check_functions( check, ["act", "get_parserWRONG", "parse"]) is False) assert (checkers.verify_check_functions( check, ["actWRONG", "get_parser", "parseWRONG"]) is False)
def _load_checker(parsed_arguments): """Define internal function to load a checker using pluginbase.""" external_checker_directory = checkers.get_checker_dir(parsed_arguments) checker_source = checkers.get_source([external_checker_directory]) check_name = checkers.get_chosen_check(parsed_arguments) check_file = checkers.transform_check(check_name) check_exists = checkers.verify_check_existence(check_file, checker_source) return (check_exists, checker_source, check_file)
def check(system_arguments): """Orchestrate a full check of the specified deliverables.""" # *Section: Initialize # step_results = [] check_results = [] # **Step: Parse and then verify the arguments, extract remaining arguments parsed_arguments, remaining_arguments = parse_arguments(system_arguments) verification_status = verify_arguments(parsed_arguments) # **Step: Get the source of all the checkers available from either: # --> the internal directory of checkers (e.g., "./gator/checks") # --> the directory specified on the command-line external_checker_directory = checkers.get_checker_dir(parsed_arguments) checker_source = checkers.get_source([external_checker_directory]) # **Step: Get and perform the preliminary actions before running a checker # if the arguments did not parse or verify correctly, then: # --> argparse will cause the program to crash with an error OR # --> one of the actions will be to display the help message and exit actions = get_actions(parsed_arguments, verification_status) perform_actions(actions) # *Section: Perform the check # **Step: Get and transform the name of the chosen checker and # then prepare for running it by ensuring that it is: # --> available for use (i.e., pluginbase found and loaded it) check_name = checkers.get_chosen_check(parsed_arguments) check_file = checkers.transform_check(check_name) check_exists = checkers.verify_check_existence(check_file, checker_source) # **Step: Load the check and verify that it is valid: check_verified = False check = None if check_exists: check = checker_source.load_plugin(check_file) check_verified = checkers.verify_check_functions(check) # produce error message and exit because the check is not valid if not check_exists or not check_verified: # do not potentially produce the welcome message again parsed_arguments.nowelcome = True actions = get_actions(parsed_arguments, check_verified) perform_actions(actions) # **Step: Perform the check since it exists and it is verified check_result = check.act(parsed_arguments, remaining_arguments) check_results.extend(check_result) # *Section: Output the report # **Step: get the report's details result = report.get_result() # **Step: Override the result's description if a user-provided description exists result = description.transform_result_dictionary(parsed_arguments, result) # **Step: produce the output produced_output = report.output(report.get_result(), OUTPUT_TYPE) # **Step: display the output display.message(produced_output) # Section: Return control back to __main__ in gatorgrader # Only step: determine the correct exit code for the checks correct_exit_code = leave.get_code(check_results) return correct_exit_code
def test_check_function_verification_separate(commandline_arguments): """Ensure that check verification works for standard functions.""" testargs = [os.getcwd()] with patch.object(sys, "argv", testargs): parsed_arguments, remaining_arguments = arguments.parse(commandline_arguments) args_verified = arguments.verify(parsed_arguments) assert args_verified is True external_checker_directory = checkers.get_checker_dir(parsed_arguments) checker_source = checkers.get_source([external_checker_directory]) check_name = checkers.get_chosen_check(parsed_arguments) check_file = checkers.transform_check(check_name) check_exists = checkers.verify_check_existence(check_file, checker_source) assert check_exists is True check = checker_source.load_plugin(check_file) assert checkers.verify_check_function(check, "act") is True assert checkers.verify_check_function(check, "get_parser") is True assert checkers.verify_check_function(check, "parse") is True
def test_check_transformation(): """Ensure that check name transformation works correctly.""" check_name_on_commandline = "CountCommits" transformed_check_name = checkers.transform_check(check_name_on_commandline) assert transformed_check_name == "check_CountCommits"