Returns the list of commands to be run through gatorgrader.
Parse the input yaml file and generate specified checks.
Parameters:
| Name |
Type |
Description |
Default |
file |
Path
|
Yaml file containing gatorgrade and shell command checks |
required
|
Returns:
| Type |
Description |
|
|
Returns a dictionary that specifies shell commands and gatorgrade commands |
Source code in gatorgrade/input/parse_config.py
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32 | def parse_config(file: Path):
"""Parse the input yaml file and generate specified checks.
Args:
file: Yaml file containing gatorgrade and shell command checks
Returns:
Returns a dictionary that specifies shell commands and gatorgrade commands
"""
# parse the YAML file using parse_yaml_file provided by gatorgrade
parsed_yaml_file = parse_yaml_file(file)
# the parsed YAML file contains some contents in a list and thus
# the tool should generate a GatorGrader check for each element in list
if len(parsed_yaml_file) > 0:
# after reformatting the parse YAML file,
# use it to generate all of the checks;
# these will be valid checks that are now
# ready for execution with this tool
parse_con = generate_checks(reformat_yaml_data(parsed_yaml_file))
return parse_con
# return an empty list because of the fact that the
# parsing process did not return a list with content;
# allow the calling function to handle the empty list
return []
|