def test_config_only(mock_exit):
""" Test that config is something reasonable when only the config file data is supplied.
Note: there is no real-world use case where command-line arguments will not be supplied,
but this test does some work in verifying that values from the config file are carried over.
"""
cfg = base_cfg_in.copy()
config = DocGenerator.combine_configs(config_data=cfg)
assert config.get('local_to_uri') == {
"/config/path/to/json-schema": "redfish.dmtf.org/schemas/v1"
}
assert config.get('uri_to_local') == {
"redfish.dmtf.org/schemas/v1": "/config/path/to/json-schema"
}
assert config.get('units_translation') == {
"s": "s_from_cfg",
"Mb/s": "Mb/s_from_cfg",
}
assert config.get('html_title') == "Title from config"
assert config.get('wants_common_objects') == False
assert config.get('actions_in_property_table') == True
assert config.get('import_from') == ['/config/path/to/schemas']
assert config.get('outfile_name') == 'config_outfile_name.html'
assert config.get('output_format') == 'html'
def test_config_overrides_supplement(mock_exit):
""" Verify that if some parameters are specified in both the supplement and the config file,
the values from the config file are used.
"""
cfg = base_cfg_in.copy()
supp = base_supp.copy()
config = DocGenerator.combine_configs(config_data=cfg,
supplemental_data=supp)
assert config.get('local_to_uri') == {
"/config/path/to/json-schema": "redfish.dmtf.org/schemas/v1"
}
assert config.get('uri_to_local') == {
"redfish.dmtf.org/schemas/v1": "/config/path/to/json-schema"
}
assert config.get('units_translation') == {
"s": "s_from_cfg",
"Mb/s": "Mb/s_from_cfg",
}
assert config.get('html_title') == "Title from config"
assert config.get('actions_in_property_table') == True
assert config.get('import_from') == ['/config/path/to/schemas']
assert config.get('outfile_name') == 'config_outfile_name.html'
assert config.get('output_format') == 'html'
def test_supplement_only():
""" Test that config is something reasonable when only the supplemental file is supplied.
Note: there is no real-world use case where command-line arguments will not be supplied,
but this test does some work in verifying that values from the supplement are carried over
"""
supp = base_supp.copy()
# Update keywords and wants_common_objects,just for this test:
supp["keywords"] = {
"html_title": "Title from the supplemental doc",
"actions_in_property_table": True
}
supp['wants_common_objects'] = True
config = DocGenerator.combine_configs(supplemental_data=supp)
assert config.get('supplemental') == supp
assert config.get('local_to_uri') == {
"/supp/path/to/json-schema": "redfish.dmtf.org/schemas/v1"
}
assert config.get('uri_to_local') == {
"redfish.dmtf.org/schemas/v1": "/supp/path/to/json-schema"
}
assert config.get('units_translation') == {
"s": "s_from_supp",
"Mb/s": "Mb/s_from_supp",
}
assert config.get('html_title') == "Title from the supplemental doc"
assert config.get('wants_common_objects') == True
assert config.get('actions_in_property_table') == True
def test_config_cannot_set_common_objects(mock_exit):
""" Test that config file cannot set wants_common_objects to True.
Since common object (a.k.a. common property) collection only makes sense if there is
a place to output the results, it wants_common_objects can be set only by the
data parsed from the supplemental markdown file.
"""
cfg = base_cfg_in.copy()
cfg['wants_common_objects'] = True
config = DocGenerator.combine_configs(config_data=cfg)
assert config.get('wants_common_objects') == False
def test_cli_overrides_config(mock_exit):
""" Verify that if some parameters are specified in both the config file and the command line,
the values from the command line are used.
"""
cli_args = base_cli_args.copy()
cfg = base_cfg_in.copy()
config = DocGenerator.combine_configs(command_line_args=cli_args,
config_data=cfg)
assert config.get('import_from') == ['/cli/path/to/schemas']
assert config.get('outfile_name') == 'cli_outfile_name.md'
assert config.get('output_format') == 'markdown'
assert config.get('escape_chars') == ['@', '#']
def test_config_defaults():
""" Ensure expected defaults are set in config, even if no config input is provided.
"""
cwd = os.getcwd()
config = DocGenerator.combine_configs()
assert config['output_format'] == 'slate'
assert config['output_content'] == 'full_doc'
assert config['outfile_name'] == 'output.md'
assert config['cwd'] == cwd
# import_from should be a list, in this case of one path, to "json-schema" within cwd.
assert isinstance(config['import_from'], list)
import_from = config['import_from'].pop()
assert import_from.startswith(cwd)
assert import_from.endswith('json-schema')
def test_config_keys():
""" Ensure expected keys are present in config, even if no config input is provided.
Really, this test just specifies what the DocFormatter classes can rely on having in
config.
"""
expected_keys = [
"actions_in_property_table",
"cwd",
"escape_chars",
"excluded_annotations",
"excluded_annotations_by_match",
"excluded_by_match",
"excluded_pattern_props",
"excluded_properties",
"excluded_schemas",
"excluded_schemas_by_match",
"import_from",
"local_to_uri",
"normative",
"omit_version_in_headers",
"outfile_name",
"output_content",
"output_format",
"profile",
"profile_doc",
"profile_mode",
"profile_resources",
"profile_uri_to_local",
"schema_supplement",
"supplemental",
"units_translation",
"uri_replacements",
"uri_to_local",
"wants_common_objects",
]
config = DocGenerator.combine_configs()
for key in expected_keys:
assert key in config