Source code for runway.tests.handlers.yaml_lint

"""yamllint test runner."""
# filename contains underscore to prevent namespace collision
import glob
import logging
import os
import runpy
from typing import Any, Dict, List  # pylint: disable=unused-import

from ...tests.handlers.base import TestHandler
from ...util import argv

TYPE_NAME = "yamllint"
LOGGER = logging.getLogger(__name__)


[docs]class YamllintHandler(TestHandler): """Lints yaml."""
[docs] @staticmethod def get_yaml_files_at_path(provided_path): # type: (str) -> List[str] """Return list of yaml files.""" yaml_files = glob.glob(os.path.join(provided_path, "*.yaml")) yml_files = glob.glob(os.path.join(provided_path, "*.yml")) return yaml_files + yml_files
[docs] @classmethod def get_yamllint_options(cls, path): # type: (str) -> List[str] """Return yamllint option list.""" yamllint_options = [] return yamllint_options + cls.get_dirs(path) + cls.get_yaml_files_at_path(path)
[docs] @classmethod def handle(cls, name, args): # type: (str, Dict[str, Any]) -> None """Perform the actual test.""" base_dir = os.getcwd() if os.path.isfile(os.path.join(base_dir, ".yamllint")): yamllint_config = os.path.join(base_dir, ".yamllint") elif os.path.isfile(os.path.join(base_dir, ".yamllint.yml")): yamllint_config = os.path.join(base_dir, ".yamllint.yml") else: yamllint_config = os.path.join( os.path.dirname( os.path.dirname(os.path.dirname(os.path.abspath(__file__))) ), "templates", ".yamllint.yml", ) yamllint_options = ["--config-file=%s" % yamllint_config] yamllint_options.extend(cls.get_yamllint_options(base_dir)) with argv(*["yamllint"] + yamllint_options): runpy.run_module("yamllint", run_name="__main__")