"""Store configuration options as a singleton.""" from __future__ import annotations import json import logging import os import sys import time import urllib.request import warnings from dataclasses import dataclass, field from http.client import HTTPException from importlib.metadata import PackageNotFoundError, distribution, version from pathlib import Path from typing import Any from urllib.error import HTTPError, URLError from packaging.version import Version from ansiblelint import __version__ from ansiblelint.loaders import yaml_from_file _logger = logging.getLogger(__name__) CACHE_DIR = ( os.path.expanduser(os.environ.get("XDG_CACHE_HOME", "~/.cache")) + "/ansible-lint" ) DEFAULT_WARN_LIST = [ "experimental", "jinja[spacing]", # warning until we resolve all reported false-positives "fqcn[deep]", # 2023-05-31 added ] DEFAULT_KINDS = [ # Do not sort this list, order matters. {"jinja2": "**/*.j2"}, # jinja2 templates are not always parsable as something else {"jinja2": "**/*.j2.*"}, {"yaml": ".github/**/*.{yaml,yml}"}, # github workflows {"text": "**/templates/**/*.*"}, # templates are unlikely to validate {"execution-environment": "**/execution-environment.yml"}, {"ansible-lint-config": "**/.ansible-lint"}, {"ansible-lint-config": "**/.ansible-lint.{yaml,yml}"}, {"ansible-lint-config": "**/.config/ansible-lint.{yaml,yml}"}, {"ansible-navigator-config": "**/ansible-navigator.{yaml,yml}"}, {"inventory": "**/inventory/**.{yaml,yml}"}, {"requirements": "**/meta/requirements.{yaml,yml}"}, # v1 only # https://docs.ansible.com/projects/ansible/latest/dev_guide/collections_galaxy_meta.html {"galaxy": "**/galaxy.yml"}, # Galaxy collection meta {"reno": "**/releasenotes/*/*.{yaml,yml}"}, # reno release notes {"vars": "**/{host_vars,group_vars,vars,defaults}/**/*.{yaml,yml}"}, {"tasks": "**/tasks/**/*.{yaml,yml}"}, {"rulebook": "**/rulebooks/*.{yml,yaml"}, {"pattern": "**/extensions/patterns/*/meta/pattern.json"}, {"play-argspec": "**/*.meta.{yaml,yml}"}, {"playbook": "**/playbooks/*.{yml,yaml}"}, {"playbook": "**/*playbook*.{yml,yaml}"}, {"playbook": "**/extensions/patterns/*/playbooks/*.{yml,yaml}"}, {"role": "**/roles/*/"}, {"handlers": "**/handlers/*.{yaml,yml}"}, {"test-meta": "**/tests/integration/targets/*/meta/main.{yaml,yml}"}, {"meta": "**/meta/main.{yaml,yml}"}, {"meta-runtime": "**/meta/runtime.{yaml,yml}"}, {"role-arg-spec": "**/meta/argument_specs.{yaml,yml}"}, # role argument specs {"yaml": ".config/molecule/config.{yaml,yml}"}, # molecule global config { "requirements": "**/molecule/*/{collections,requirements}.{yaml,yml}", }, # molecule old collection requirements (v1), ansible 2.8 only {"yaml": "**/molecule/*/{base,molecule}.{yaml,yml}"}, # molecule config {"requirements": "**/requirements.{yaml,yml}"}, # v2 and v1 {"playbook": "**/molecule/*/*.{yaml,yml}"}, # molecule playbooks {"yaml": "**/{.ansible-lint,.yamllint}"}, {"changelog": "**/changelogs/changelog.{yaml,yml}"}, {"yaml": "**/*.{yaml,yml}"}, {"yaml": "**/.*.{yaml,yml}"}, {"sanity-ignore-file": "**/tests/sanity/ignore-*.txt"}, # what are these doc_fragments? We also ignore module_utils for now { "plugin": "**/plugins/{action,become,cache,callback,connection,filter,inventory,lookup,modules,test}/**/*.py", }, {"python": "**/*.py"}, ] BASE_KINDS = [ # These assignations are only for internal use and are only inspired by # MIME/IANA model. Their purpose is to be able to process a file based on # it type, including generic processing of text files using the prefix. { "text/jinja2": "**/*.j2", }, # jinja2 templates are not always parsable as something else {"text/jinja2": "**/*.j2.*"}, {"text": "**/templates/**/*.*"}, # templates are unlikely to validate {"text/json": "**/*.json"}, # standardized {"text/markdown": "**/*.md"}, # https://tools.ietf.org/html/rfc7763 {"text/rst": "**/*.rst"}, # https://en.wikipedia.org/wiki/ReStructuredText {"text/ini": "**/*.ini"}, # YAML has no official IANA assignation {"text/yaml": "**/{.ansible-lint,.yamllint}"}, {"text/yaml": "**/*.{yaml,yml}"}, {"text/yaml": "**/.*.{yaml,yml}"}, {"text/python": "**/*.py"}, ] # File kinds that are recognized by ansible, used internally to force use of # YAML 1.1 instead of 1.2 due to ansible-core dependency on pyyaml. ANSIBLE_OWNED_KINDS = { "handlers", "galaxy", "meta", "meta-runtime", "playbook", "requirements", "role-arg-spec", "rulebook", "tasks", "vars", } PROFILES = yaml_from_file(Path(__file__).parent / "data" / "profiles.yml") LOOP_VAR_PREFIX = "^(__|{role}_)" @dataclass class Options: # pylint: disable=too-many-instance-attributes """Store ansible-lint effective configuration options.""" # Private attributes _skip_ansible_syntax_check: bool = False # Public attributes cache_dir: Path | None = None colored: bool = True configured: bool = False cwd: Path = Path() display_relative_path: bool = True exclude_paths: list[str] = field(default_factory=list) format: str = "brief" lintables: list[str] = field(default_factory=list) list_rules: bool = False list_tags: bool = False write_list: list[str] = field(default_factory=list) write_exclude_list: list[str] = field(default_factory=list) quiet: bool = False rulesdirs: list[Path] = field(default_factory=list) skip_list: list[str] = field(default_factory=list) tags: list[str] = field(default_factory=list) verbosity: int = 0 warn_list: list[str] = field(default_factory=list) kinds = DEFAULT_KINDS mock_filters: list[str] = field(default_factory=list) mock_modules: list[str] = field(default_factory=list) mock_roles: list[str] = field(default_factory=list) loop_var_prefix: str | None = None only_builtins_allow_collections: list[str] = field(default_factory=list) only_builtins_allow_modules: list[str] = field(default_factory=list) var_naming_pattern: str | None = None offline: bool = False project_dir: str = "." # default should be valid folder (do not use None here) extra_vars: dict[str, Any] | None = None enable_list: list[str] = field(default_factory=list) skip_action_validation: bool = True strict: bool = False rules: dict[str, Any] = field( default_factory=dict, ) # Placeholder to set and keep configurations for each rule. profile: str | None = None task_name_prefix: str = "{stem} | " sarif_file: Path | None = None config_file: str | None = None generate_ignore: bool = False rulesdir: list[Path] = field(default_factory=list) use_default_rules: bool = False version: bool = False # display version command list_profiles: bool = False # display profiles command ignore_file: Path | None = None yamllint_file: Path | None = None max_tasks: int = 100 max_block_depth: int = 20 # Refer to https://docs.ansible.com/projects/ansible/latest/reference_appendices/release_and_maintenance.html#ansible-core-support-matrix _default_supported = ["2.15.", "2.16.", "2.17.", "2.18.", "2.19."] supported_ansible_also: list[str] = field(default_factory=list) @property def nodeps(self) -> bool: """Returns value of nodeps feature.""" # We do not want this to be cached as it would affect our testings. return bool(int(os.environ.get("ANSIBLE_LINT_NODEPS", "0"))) def __post_init__(self) -> None: """Extra initialization logic.""" if self.nodeps: self.offline = True @property def supported_ansible(self) -> list[str]: """Returns list of ansible versions that are considered supported.""" return sorted([*self._default_supported, *self.supported_ansible_also]) @property def mock_collections_path(self) -> Path | None: """Return the mock collections path if cache_dir is set.""" if self.cache_dir is None: return None return self.cache_dir / "collections" def has_collection_mocks(self) -> bool: """Check if any mock roles or modules use collection format (ns.coll.name).""" return any(len(r.split(".")) >= 3 for r in self.mock_roles) or any( len(m.split(".")) >= 3 for m in self.mock_modules ) options = Options() # Used to store detected tag deprecations used_old_tags: dict[str, str] = {} # Used to store log messages before logging is initialized (level, message) log_entries: list[tuple[int, str]] = [] def in_venv() -> bool: """Determine whether Python is running from a venv.""" if hasattr(sys, "real_prefix") or os.environ.get("CONDA_EXE", None) is not None: return True pfx = getattr(sys, "base_prefix", sys.prefix) return pfx != sys.prefix def guess_install_method() -> str: """Guess if pip upgrade command should be used.""" package_name = "ansible-lint" try: if (distribution(package_name).read_text("INSTALLER") or "").strip() != "pip": return "" except PackageNotFoundError as exc: _logger.debug(exc) return "" pip = "" if in_venv(): _logger.debug("Found virtualenv, assuming `pip3 install` will work.") pip = f"pip install --upgrade {package_name}" elif __file__.startswith(os.path.expanduser("~/.local/lib")): _logger.debug( "Found --user installation, assuming `pip3 install --user` will work.", ) pip = f"pip3 install --user --upgrade {package_name}" # By default we assume pip is not safe to be used use_pip = False try: # Use pip to detect if is safe to use it to upgrade the package. # We do imports here to for performance and reasons, and also in order # to avoid errors if pip internals change. Also we want to avoid having # to add pip as a dependency, so we make use of it only when present. # trick to avoid runtime warning from inside pip: _distutils_hack/__init__.py:33: UserWarning: Setuptools is replacing distutils. with warnings.catch_warnings(record=True): warnings.simplefilter("always") # pylint: disable=import-outside-toplevel from pip._internal.metadata import get_default_environment from pip._internal.req.req_uninstall import uninstallation_paths dist = get_default_environment().get_distribution(package_name) if dist: _logger.debug("Found %s dist", dist) for _ in uninstallation_paths(dist): use_pip = True else: _logger.debug("Skipping %s as it is not installed.", package_name) use_pip = False except (AttributeError, ModuleNotFoundError) as exc: # On Fedora 36, we got a AttributeError exception from pip that we want to avoid # On NixOS, we got a ModuleNotFoundError exception from pip that we want to avoid _logger.debug(exc) use_pip = False # We only want to recommend pip for upgrade if it looks safe to do so. return pip if use_pip else "" def get_deps_versions() -> dict[str, Version | None]: """Return versions of most important dependencies.""" result: dict[str, Version | None] = {} for name in ["ansible-core", "ansible-compat", "ruamel-yaml", "ruamel-yaml-clib"]: try: result[name] = Version(version(name)) except PackageNotFoundError: result[name] = None return result def get_version_warning() -> str: """Patched on Debian to not download release information from third parties""" return ""