-
Notifications
You must be signed in to change notification settings - Fork 42
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
move functions in settings to dedicated submodule for better testability
- Loading branch information
1 parent
c54967d
commit 3fbda62
Showing
21 changed files
with
630 additions
and
298 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,139 @@ | ||
| # This file is part of django-ca (https://github.com/mathiasertl/django-ca). | ||
| # | ||
| # django-ca is free software: you can redistribute it and/or modify it under the terms of the GNU General | ||
| # Public License as published by the Free Software Foundation, either version 3 of the License, or (at your | ||
| # option) any later version. | ||
| # | ||
| # django-ca is distributed in the hope that it will be useful, but WITHOUT ANY WARRANTY; without even the | ||
| # implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License | ||
| # for more details. | ||
| # | ||
| # You should have received a copy of the GNU General Public License along with django-ca. If not, see | ||
| # <http://www.gnu.org/licenses/>. | ||
|
|
||
| """Utility functions for loading settings.""" | ||
| import logging | ||
| import os | ||
| from pathlib import Path | ||
| from typing import Any, Dict, Iterator, Optional, Tuple | ||
|
|
||
| from django.core.exceptions import ImproperlyConfigured | ||
|
|
||
| try: | ||
| import yaml | ||
| except ImportError: # pragma: no cover | ||
| yaml = False # type: ignore[assignment] | ||
|
|
||
|
|
||
| def load_secret_key(secret_key: Optional[str], secret_key_file: Optional[str]) -> str: | ||
| """Load SECRET_KEY from file if not set elsewhere.""" | ||
| if secret_key: | ||
| return secret_key | ||
|
|
||
| if secret_key_file and os.path.exists(secret_key_file): | ||
| with open(secret_key_file, encoding="utf-8") as stream: | ||
| return stream.read() | ||
| raise ImproperlyConfigured("Unable to determine SECRET_KEY.") | ||
|
|
||
|
|
||
| def get_settings_files(base_dir: Path, paths: str) -> Iterator[Path]: | ||
| """Get relevant settings files.""" | ||
| for path in [base_dir / p for p in paths.split(":")]: | ||
| if not path.exists(): | ||
| raise ImproperlyConfigured(f"{path}: No such file or directory.") | ||
|
|
||
| if path.is_dir(): | ||
| # exclude files that don't end with '.yaml' and any directories | ||
| yield from sorted( | ||
| [path / _f.name for _f in path.iterdir() if _f.suffix == ".yaml" and not _f.is_dir()] | ||
| ) | ||
| else: | ||
| yield path | ||
|
|
||
| settings_yaml = base_dir / "ca" / "settings.yaml" | ||
| if settings_yaml.exists(): | ||
| yield settings_yaml | ||
|
|
||
|
|
||
| def load_settings_from_files(base_dir: Path) -> Iterator[Tuple[str, Any]]: | ||
| """Load settings from YAML files.""" | ||
| # TYPEHINT NOTE: mypy typehints this to a module in the initial import statement | ||
| if yaml is False: # type: ignore[comparison-overlap] | ||
| return | ||
|
|
||
| # CONFIGURATION_DIRECTORY is set by the SystemD ConfigurationDirectory= directive. | ||
| settings_paths = os.environ.get("DJANGO_CA_SETTINGS", os.environ.get("CONFIGURATION_DIRECTORY", "")) | ||
|
|
||
| settings_files = [] | ||
|
|
||
| for full_path in get_settings_files(base_dir, settings_paths): | ||
| with open(full_path, encoding="utf-8") as stream: | ||
| try: | ||
| data = yaml.safe_load(stream) | ||
| except Exception as ex: | ||
| logging.exception(ex) | ||
| raise ImproperlyConfigured(f"{full_path}: Invalid YAML.") from ex | ||
|
|
||
| if data is None: | ||
| pass # silently ignore empty files | ||
| elif not isinstance(data, dict): | ||
| raise ImproperlyConfigured(f"{full_path}: File is not a key/value mapping.") | ||
| else: | ||
| settings_files.append(full_path) | ||
| for key, value in data.items(): | ||
| yield key, value | ||
|
|
||
| # ALSO yield the SETTINGS_FILES setting with the loaded files. | ||
| yield "SETTINGS_FILES", tuple(settings_files) | ||
|
|
||
|
|
||
| def load_settings_from_environment() -> Iterator[Tuple[str, Any]]: | ||
| """Load settings from the environment.""" | ||
| for key, value in {k[10:]: v for k, v in os.environ.items() if k.startswith("DJANGO_CA_")}.items(): | ||
| if key == "SETTINGS": # points to yaml files loaded in get_settings_files | ||
| continue | ||
|
|
||
| if key == "ALLOWED_HOSTS": | ||
| yield key, value.split() | ||
| elif key in ("CA_USE_CELERY", "CA_ENABLE_ACME", "CA_ENABLE_REST_API", "ENABLE_ADMIN"): | ||
| yield key, parse_bool(value) | ||
| else: | ||
| yield key, value | ||
|
|
||
|
|
||
| def parse_bool(value: str) -> bool: | ||
| """Parse a variable that is supposed to represent a boolean value.""" | ||
| return value.strip().lower() in ("true", "yes", "1") | ||
|
|
||
|
|
||
| def _set_db_setting( | ||
| databases: Dict[str, Dict[str, Any]], name: str, env_name: str, default: Optional[str] = None | ||
| ) -> None: | ||
| if databases["default"].get(name): | ||
| return | ||
|
|
||
| if os.environ.get(env_name): | ||
| databases["default"][name] = os.environ[env_name] | ||
| elif os.environ.get(f"{env_name}_FILE"): | ||
| with open(os.environ[f"{env_name}_FILE"], encoding="utf-8") as env_stream: | ||
| databases["default"][name] = env_stream.read() | ||
| elif default is not None: | ||
| databases["default"][name] = default | ||
|
|
||
|
|
||
| def update_database_setting_from_environment(databases: Dict[str, Dict[str, Any]]) -> None: | ||
| """Update the DATABASES dict with Docker-style environment variables.""" | ||
| # use POSTGRES_* environment variables from the postgres Docker image | ||
| if databases["default"]["ENGINE"] in ( | ||
| "django.db.backends.postgresql_psycopg2", | ||
| "django.db.backends.postgresql", | ||
| ): | ||
| _set_db_setting(databases, "PASSWORD", "POSTGRES_PASSWORD", default="postgres") | ||
| _set_db_setting(databases, "USER", "POSTGRES_USER", default="postgres") | ||
| _set_db_setting(databases, "NAME", "POSTGRES_DB", default=databases["default"].get("USER")) | ||
|
|
||
| # use MYSQL_* environment variables from the mysql Docker image | ||
| if databases["default"]["ENGINE"] == "django.db.backends.mysql": | ||
| _set_db_setting(databases, "PASSWORD", "MYSQL_PASSWORD") | ||
| _set_db_setting(databases, "USER", "MYSQL_USER") | ||
| _set_db_setting(databases, "NAME", "MYSQL_DATABASE") |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Oops, something went wrong.