class TestConfig(yc.YamlConfigLoader):
ELEMENTS = [
yc.StrElem("pet",
default="squirrel",
required=True,
choices=["squirrel", "cat", "dog"],
help_text="The kind of pet."),
yc.IntElem("quantity", required=True, choices=[1, 2, 3]),
yc.FloatRangeElem("quality", vmin=0, vmax=1.0),
yc.ListElem("potential_names",
help_text="What you could name this pet.",
sub_elem=yc.StrElem(help_text="Such as Fido.")),
yc.KeyedElem(
"properties",
help_text="Pet properties",
elements=[
yc.StrElem("description",
help_text="General pet description."),
yc.RegexElem("greeting",
regex=r'hello \w+$',
help_text="A regex of some sort."),
yc.IntRangeElem("legs", vmin=0)
]),
yc.CodeElem("behavior_code",
help_text="Program for pet behavior.")
]
class SeriesConfigLoader(yc.YamlConfigLoader):
"""This class describes a series file."""
ELEMENTS = [
TestCatElem(
'series', sub_elem=yc.KeyedElem(
elements=[
yc.ListElem('tests', sub_elem=yc.StrElem()),
yc.StrElem('depends_pass',
choices=['True', 'true', 'False', 'false'],
default='False'),
yc.ListElem('depends_on', sub_elem=yc.StrElem()),
yc.ListElem('modes', sub_elem=yc.StrElem()),
CondCategoryElem(
'only_if', sub_elem=yc.ListElem(sub_elem=yc.StrElem()),
key_case=EnvCatElem.KC_MIXED
),
CondCategoryElem(
'not_if', sub_elem=yc.ListElem(sub_elem=yc.StrElem()),
key_case=EnvCatElem.KC_MIXED
),
]
),
),
yc.ListElem(
'modes', sub_elem=yc.StrElem()
),
yc.IntElem(
'simultaneous',
),
yc.StrElem(
'ordered', choices=['True', 'true', 'False', 'false'],
default='False'
),
yc.StrElem(
'restart', choices=['True', 'true', 'False', 'false'],
default='False'
)
]
"""Describes elements in Series Config Loader."""
class PavilionConfigLoader(yc.YamlConfigLoader):
"""This object uses YamlConfig to define Pavilion's base configuration
format and options. If you're looking to add an option to the general
pavilion.yaml format, this is the place to do it."""
# Each and every configuration element needs to either not be required,
# or have a sensible default. Essentially, Pavilion needs to work if no
# config is given.
ELEMENTS = [
yc.ListElem(
"config_dirs",
sub_elem=ExPathElem(),
post_validator=config_dirs_validator,
help_text="Additional Paths to search for Pavilion config files. "
"Pavilion configs (other than this core config) are "
"searched for in the given order. In the case of "
"identically named files, directories listed earlier "
"take precedence."),
yc.BoolElem(
"user_config",
default=False,
help_text="Whether to automatically add the user's config "
"directory at ~/.pavilion to the config_dirs. Configs "
"in this directory always take precedence."
),
ExPathElem(
'working_dir', default=USER_HOME_PAV/'working_dir', required=True,
help_text="Where pavilion puts it's run files, downloads, etc."),
yc.ListElem(
"disable_plugins", sub_elem=yc.StrElem(),
help_text="Allows you to disable plugins by '<type>.<name>'. For "
"example, 'module.gcc' would disable the gcc module "
"wrapper."),
yc.StrElem(
"shared_group", post_validator=_group_validate,
help_text="Pavilion can automatically set group permissions on all "
"created files, so that users can share relevant "
"results, etc."),
yc.StrElem(
"umask", default="2",
help_text="The umask to apply to all files created by pavilion. "
"This should be in the format needed by the umask shell "
"command."),
yc.IntRangeElem(
"build_threads", default=4, vmin=1,
help_text="Maximum simultaneous builds. Note that each build may "
"itself spawn off threads/processes, so it's probably "
"reasonable to keep this at just a few."),
yc.StrElem(
"log_format",
default="{asctime}, {levelname}, {hostname}, {name}: {message}",
help_text="The log format to use for the pavilion logger. "
"Uses the modern '{' format style. See: "
"https://docs.python.org/3/library/logging.html#"
"logrecord-attributes"),
yc.StrElem(
"log_level", default="info",
choices=['debug', 'info', 'warning', 'error', 'critical'],
help_text="The minimum log level for messages sent to the pavilion "
"logfile."),
ExPathElem(
"result_log",
# Derive the default from the working directory, if a value isn't
# given.
post_validator=(lambda d, v: v if v is not None else
d['working_dir']/'results.log'),
help_text="Results are put in both the general log and a specific "
"results log. This defaults to 'results.log' in the "
"working directory."),
yc.BoolElem(
"flatten_results", default=True,
help_text="Flatten results with multiple 'per_file' values into "
"multiple result log lines, one for each 'per_file' "
"value. Each flattened result will have a 'file' key, "
"and the contents of its 'per_file' data will be added "
"to the base results mapping."),
ExPathElem(
'exception_log',
# Derive the default from the working directory, if a value isn't
# given.
post_validator=(lambda d, v: v if v is not None else
d['working_dir']/'exceptions.log'),
help_text="Full exception tracebacks and related debugging "
"information is logged here."
),
yc.IntElem(
"wget_timeout", default=5,
help_text="How long to wait on web requests before timing out. On "
"networks without internet access, zero will allow you "
"to spot issues faster."
),
yc.CategoryElem(
"proxies", sub_elem=yc.StrElem(),
help_text="Proxies, by protocol, to use when accessing the "
"internet. Eg: http: 'http://myproxy.myorg.org:8000'"),
yc.ListElem(
"no_proxy", sub_elem=yc.StrElem(),
help_text="A list of DNS suffixes to ignore for proxy purposes. "
"For example: 'blah.com' would match 'www.blah.com', but "
"not 'myblah.com'."),
yc.ListElem(
"env_setup", sub_elem=yc.StrElem(),
help_text="A list of commands to be executed at the beginning of "
"every kickoff script."),
yc.CategoryElem(
"default_results", sub_elem=yc.StrElem(),
help_text="Each of these will be added as a constant result "
"parser with the corresponding key and constant value. "
"Generally, the values should contain a pavilion "
"variable of some sort to resolve."),
# The following configuration items are for internal use and provide a
# convenient way to pass around core pavilion components or data.
# They are not intended to be set by the user, and will generally be
# overwritten without even checking for user provided values.
ExPathElem(
'pav_cfg_file', hidden=True,
help_text="The location of the loaded pav config file."
),
ExPathElem(
'pav_root', default=PAV_ROOT, hidden=True,
help_text="The root directory of the pavilion install. This "
"shouldn't be set by the user."),
yc.KeyedElem(
'pav_vars', elements=[], hidden=True, default={},
help_text="This will contain the pavilion variable dictionary."),
]
class PavilionConfigLoader(yc.YamlConfigLoader):
# Each and every configuration element needs to either not be required,
# or have a sensible default. Essentially, Pavilion needs to work if no
# config is given.
ELEMENTS = [
yc.ListElem(
"config_dirs",
defaults=PAV_CONFIG_SEARCH_DIRS,
sub_elem=yc.StrElem(),
help_text="Paths to search for Pavilion config files. Pavilion "
"configs (other than this core config) are searched for "
"in the given order. In the case of identically named "
"files, directories listed earlier take precedent."),
yc.StrElem(
'working_dir', default=USER_HOME_PAV,
help_text="Where pavilion puts it's run files, downloads, etc."),
yc.ListElem(
"disable_plugins", sub_elem=yc.StrElem(),
help_text="Allows you to disable plugins by '<type>.<name>'. For "
"example, 'module.gcc' would disable the gcc module "
"wrapper."),
yc.StrElem(
"shared_group", post_validator=group_validate,
help_text="Pavilion can automatically set group permissions on all "
"created files, so that users can share relevant "
"results, etc."),
yc.StrElem(
"umask", default="0002",
help_text="The umask to apply to all files created by pavilion. "
"This should be in the format needed by the umask shell "
"command."),
yc.StrElem(
"log_format",
default="%{asctime}, ${levelname}, ${name}: ${message}",
help_text="The log format to use for the pavilion logger. See: "
"https://docs.python.org/3/library/logging.html#"
"logrecord-attributes"),
yc.StrElem(
"log_level", default="info", post_validator=log_level_validate,
help_text="The minimum log level for messages sent to the pavilion "
"logfile."),
yc.IntElem(
"wget_timeout", default=5,
help_text="How long to wait on web requests before timing out. On"
"networks without internet access, zero will allow you"
"to spot issues faster."
),
yc.CategoryElem(
"proxies", sub_elem=yc.StrElem(),
help_text="Proxies, by protocol, to use when accessing the "
"internet. Eg: http: 'http://myproxy.myorg.org:8000'"),
yc.ListElem(
"no_proxy", sub_elem=yc.StrElem(),
help_text="A list of DNS suffixes to ignore for proxy purposes. "
"For example: 'blah.com' would match 'www.blah.com', but "
"not 'myblah.com'."),
# The following configuration items are for internal use and provide a
# convenient way to pass around core pavilion components or data.
# They are not intended to be set by the user, and will generally be
# overwritten without even checking for user provided values.
yc.StrElem(
'pav_root', default=pav_root, hidden=True,
help_text="The root directory of the pavilion install. This "
"shouldn't be set by the user."),
yc.KeyedElem(
'sys_vars', elements=[], hidden=True, default={},
help_text="This will contain the system variable dictionary."),
yc.KeyedElem(
'pav_vars', elements=[], hidden=True, default={},
help_text="This will contain the pavilion variable dictionary."),
]