Skip to content

Commit

Permalink
feat: created python script to extract env vars and convert to ini files
Browse files Browse the repository at this point in the history
this will be used to allow config files to be 100% managed via docker env vars
created unit tests to cover script
added gitignore to ensure no python relate junk ends up in the repo
  • Loading branch information
Johnny-Knighten committed Nov 28, 2023
1 parent aacef9a commit 26745c4
Show file tree
Hide file tree
Showing 5 changed files with 466 additions and 0 deletions.
163 changes: 163 additions & 0 deletions .gitignore
Original file line number Diff line number Diff line change
@@ -0,0 +1,163 @@
# Python
# From: https://github.com/github/gitignore/blob/main/Python.gitignore

# Byte-compiled / optimized / DLL files
__pycache__/
*.py[cod]
*$py.class

# C extensions
*.so

# Distribution / packaging
.Python
build/
develop-eggs/
dist/
downloads/
eggs/
.eggs/
lib/
lib64/
parts/
sdist/
var/
wheels/
share/python-wheels/
*.egg-info/
.installed.cfg
*.egg
MANIFEST

# PyInstaller
# Usually these files are written by a python script from a template
# before PyInstaller builds the exe, so as to inject date/other infos into it.
*.manifest
*.spec

# Installer logs
pip-log.txt
pip-delete-this-directory.txt

# Unit test / coverage reports
htmlcov/
.tox/
.nox/
.coverage
.coverage.*
.cache
nosetests.xml
coverage.xml
*.cover
*.py,cover
.hypothesis/
.pytest_cache/
cover/

# Translations
*.mo
*.pot

# Django stuff:
*.log
local_settings.py
db.sqlite3
db.sqlite3-journal

# Flask stuff:
instance/
.webassets-cache

# Scrapy stuff:
.scrapy

# Sphinx documentation
docs/_build/

# PyBuilder
.pybuilder/
target/

# Jupyter Notebook
.ipynb_checkpoints

# IPython
profile_default/
ipython_config.py

# pyenv
# For a library or package, you might want to ignore these files since the code is
# intended to run in multiple environments; otherwise, check them in:
# .python-version

# pipenv
# According to pypa/pipenv#598, it is recommended to include Pipfile.lock in version control.
# However, in case of collaboration, if having platform-specific dependencies or dependencies
# having no cross-platform support, pipenv may install dependencies that don't work, or not
# install all needed dependencies.
#Pipfile.lock

# poetry
# Similar to Pipfile.lock, it is generally recommended to include poetry.lock in version control.
# This is especially recommended for binary packages to ensure reproducibility, and is more
# commonly ignored for libraries.
# https://python-poetry.org/docs/basic-usage/#commit-your-poetrylock-file-to-version-control
#poetry.lock

# pdm
# Similar to Pipfile.lock, it is generally recommended to include pdm.lock in version control.
#pdm.lock
# pdm stores project-wide configurations in .pdm.toml, but it is recommended to not include it
# in version control.
# https://pdm.fming.dev/#use-with-ide
.pdm.toml

# PEP 582; used by e.g. github.com/David-OConnor/pyflow and github.com/pdm-project/pdm
__pypackages__/

# Celery stuff
celerybeat-schedule
celerybeat.pid

# SageMath parsed files
*.sage.py

# Environments
.env
.venv
env/
venv/
ENV/
env.bak/
venv.bak/

# Spyder project settings
.spyderproject
.spyproject

# Rope project settings
.ropeproject

# mkdocs documentation
/site

# mypy
.mypy_cache/
.dmypy.json
dmypy.json

# Pyre type checker
.pyre/

# pytype static type analyzer
.pytype/

# Cython debug symbols
cython_debug/

# PyCharm
# JetBrains specific template is maintained in a separate JetBrains.gitignore that can
# be found at https://github.com/github/gitignore/blob/main/Global/JetBrains.gitignore
# and can be added to the global gitignore or merged into this file. For a more nuclear
# option (not recommended) you can uncomment the following to ignore the entire idea folder.
#.idea/
Empty file.
96 changes: 96 additions & 0 deletions config_from_env_vars/main.py
Original file line number Diff line number Diff line change
@@ -0,0 +1,96 @@
import os
import logging
from argparse import ArgumentParser
from configparser import ConfigParser
from pathlib import Path
import sys
from typing import Dict

# Configure logging
logging.basicConfig(
level=logging.INFO, format="%(asctime)s - %(levelname)s - %(message)s"
)


def process_env_vars() -> Dict[str, Dict[str, Dict[str, str]]]:
config_files: Dict[str, Dict[str, Dict[str, str]]] = {}
for key, value in os.environ.items():
if not key.startswith("CONFIG_"):
continue

tokens = key.split("_")

if len(tokens) < 4:
logging.warning(f"Invalid config environment variable: {key}")
continue

file_name = tokens[1]
var_name = tokens[-1].split("=")[0]
section_name = "_".join(tokens[2:-1]).replace("SLASH", "/").replace("DOT", ".")
section_name = (
section_name.replace("_/_", "/").replace("/_", "/").replace("_._", ".")
)

if file_name not in config_files:
config_files[file_name] = {}
if section_name not in config_files[file_name]:
config_files[file_name][section_name] = {}

config_files[file_name][section_name][var_name] = value

return config_files


def update_ini_files(
config_data: Dict[str, Dict[str, Dict[str, str]]], path: str
) -> None:
for file_name, sections in config_data.items():
config_parser = ConfigParser()
file_path = os.path.join(path, f"{file_name}.ini")

try:
if not Path(file_path).exists():
logging.warning(
f"File not found: {file_path}. A new file will be created."
)
config_parser.read(file_path)

for section, vars in sections.items():
if not config_parser.has_section(section):
config_parser.add_section(section)
for var, value in vars.items():
config_parser.set(section, var, value)

with open(file_path, "w") as config_file:
config_parser.write(config_file)

except Exception as e:
logging.error(f"Error updating file {file_name}.ini: {e}")
continue


def main():
parser = ArgumentParser(
description="Update ini configuration files based on environment variables."
)
parser.add_argument(
"--path",
dest="config_directory",
type=str,
help="Path to store created ini files.",
default="/ark-server/server/ShooterGame/Saved/Config/WindowsServer",
)
args = parser.parse_args()

if not os.path.isdir(args.config_directory):
logging.error(
f"The specified directory does not exist: {args.config_directory}"
)
sys.exit(1)

config_data = process_env_vars()
update_ini_files(config_data, args.config_directory)


if __name__ == "__main__":
main()
Empty file.
Loading

0 comments on commit 26745c4

Please sign in to comment.