Source code for ekfsm.config

from typing import Any, List, Tuple, Union

import munch
import yamale  # type: ignore
import yaml

from ekfsm.exceptions import ConfigError

schema_str = """
system_config:
  name: str()
  aggregates: map(required=False)
  slots: list(include('slot'))
---
slot:
  name: str()
  slot_type: regex('^CPCI_S0_(PER|SYS|PSU|UTILITY)$')
  desired_hwmodule_type: str()
  desired_hwmodule_name: str()
  attributes: map(required=False)
"""


def _validate_config(config_file: str) -> None:
    schema = yamale.make_schema(content=schema_str)
    data = yamale.make_data(config_file)
    try:
        yamale.validate(schema, data)
    except yamale.YamaleError:
        raise ConfigError("Error in configuration file")


def _parse_config(config_file: str) -> Union[Any, munch.Munch, List, Tuple]:
    try:
        with open(config_file) as file:
            config = yaml.safe_load(file)
            munchified_config = munch.munchify(config)
    except OSError:
        raise ConfigError("Failed to open configuration file: {config_file}")
    return munchified_config



[docs]
def load_config(config_file: str) -> Any:
    _validate_config(config_file)
    config = _parse_config(config_file)
    return config