tests/utils/test_default_config_yaml.py

# Licensed to the Apache Software Foundation (ASF) under one
# or more contributor license agreements.  See the NOTICE file
# distributed with this work for additional information
# regarding copyright ownership.  The ASF licenses this file
# to you under the Apache License, Version 2.0 (the
# "License"); you may not use this file except in compliance
# with the License.  You may obtain a copy of the License at
#
#   http://www.apache.org/licenses/LICENSE-2.0
#
# Unless required by applicable law or agreed to in writing,
# software distributed under the License is distributed on an
# "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
# KIND, either express or implied.  See the License for the
# specific language governing permissions and limitations
# under the License.

"""Test default config file."""

from ruamel.yaml import YAML
from ruamel.yaml.comments import CommentedMap

from tests.testing.path import path_default_config_yaml


def nested_key_check(comment_map: CommentedMap) -> None:
    """Test whether default configuration file exists specific character."""
    for key, val in comment_map.items():
        assert "." not in key, f"There is not allowed special character in key `{key}`."
        if isinstance(val, CommentedMap):
            nested_key_check(val)


def test_key_without_dot_delimiter():
    """Test wrapper of whether default configuration file exists specific character."""
    yaml = YAML()
    with open(path_default_config_yaml) as f:
        comment_map = yaml.load(f.read())
        nested_key_check(comment_map)