verify_menu_config Namespace Reference

Functions
	verify (config, trigger_level)
	load_and_verify (file_path, trigger_level)
	paths_starting_with (prefix)

Variables
	log = logging.getLogger("TriggerMenuConfigTest")
	parser
	individual
	help
	args = parser.parse_args()
dict	results = {}
list	json_files
bool	any_failures = False
str	success_plural
str	failure_plural

Detailed Description

Script for verifying menu configurations.

Can be run on individual files with the -hlt and/or -l1 options,
or on multiple files with the --folder option.

Function Documentation

load_and_verify()

verify_menu_config.load_and_verify	(		file_path,
			trigger_level )

Definition at line 40 of file verify_menu_config.py.

def load_and_verify(file_path, trigger_level):
    if not os.path.isfile(file_path):
        log.error("'{}' does not exist".format(file_path))
    elif not os.path.splitext(file_path)[1] == ".json":
        log.error("'{}' is not a JSON file".format(file_path))
    else:
        with open(file_path, "r") as config_file:
            config = json.load(config_file)
 
        return verify(config, trigger_level)
 
    return {"successes": [], "failures": []}
 
 

paths_starting_with()

verify_menu_config.paths_starting_with

(

prefix

)

Definition at line 74 of file verify_menu_config.py.

        def paths_starting_with(prefix):
            return [args.folder + os.sep + f
                    for f in json_files if f.startswith(prefix)]
 

verify()

verify_menu_config.verify	(		config,
			trigger_level )

Run all consistency checks for the trigger on the config.

Definition at line 22 of file verify_menu_config.py.

def verify(config, trigger_level):
    '''
    Run all consistency checks for the trigger on the config.
    '''
    tests = menu_tests[trigger_level]
    for test in tests:
        test.run(config)
 
    successes = []
    failures = []
    for test in tests:
        if test.failures:
            failures.append(test)
        else:
            successes.append(test)
    return { "successes": successes, "failures": failures }
 
 

Variable Documentation

any_failures

bool verify_menu_config.any_failures = False

Definition at line 93 of file verify_menu_config.py.

args

verify_menu_config.args = parser.parse_args()

Definition at line 64 of file verify_menu_config.py.

failure_plural

str verify_menu_config.failure_plural

Initial value:

=  1 \
                         else "s"

Definition at line 97 of file verify_menu_config.py.

help

verify_menu_config.help

Definition at line 60 of file verify_menu_config.py.

individual

verify_menu_config.individual

Initial value:

=  parser.add_argument_group(
        title="Individual file options")

Definition at line 57 of file verify_menu_config.py.

json_files

list verify_menu_config.json_files

Initial value:

=  [f for f in os.listdir(args.folder)
                        if f.endswith("json")]

Definition at line 72 of file verify_menu_config.py.

log

verify_menu_config.log = logging.getLogger("TriggerMenuConfigTest")

Definition at line 20 of file verify_menu_config.py.

parser

verify_menu_config.parser

Initial value:

=  argparse.ArgumentParser(
        description="Check a generated JSON configuration is valid")

Definition at line 55 of file verify_menu_config.py.

results

dict verify_menu_config.results = {}

Definition at line 66 of file verify_menu_config.py.

success_plural

str verify_menu_config.success_plural

Initial value:

=  1 \
                         else "es"

Definition at line 95 of file verify_menu_config.py.