environment.py

"""
This module parses some configuration variables from
the runtime environment to use them in different sections
from this application

Attributes:
    DEVELOPMENT (bool): If True, this indicates if the application should run in
        development mode. By default, the application will start in development mode,
        the value is going to be True.
        To disable it and run in production, please set the environment variable "PRODUCTION"
        with a value.
    DEBUG (bool): If True, this sets the debug level for the root logger to DEBUG
    REMOTE_PATH (str): This is the folder, into AFS or EOS, where ReReco submissions files will
        be stored before to submit a job via ReqMgr2.
    SERVICE_URL (str): ReReco service access URL. 
        For example, https://cms-pdmv-prod.web.cern.ch/rereco
    CMSWEB_URL (str): URL to CMS WEB Services. For example, https://cmsweb.cern.ch
    REMOTE_SSH_USERNAME (str): Username to authenticate to the remote node via SSH
    REMOTE_SSH_PASSWORD (str): Password to authenticate to the remote node via SSH
    REMOTE_SSH_NODE (str): Remote node for executing batch tasks, like resolving auto conditions.
        Default value: lxplus.cern.ch
    MONGO_DB_USERNAME (str): Username to authenticate to MongoDB database
    MONGO_DB_PASSWORD (str): Password to authenticate to MongoDB database
    MONGO_DB_HOST (str): MongoDB database hostname
    MONGO_DB_PORT (int): MongoDB database port
    GRID_USER_CERT (str): Path to Grid Certificate to authenticate to CMS WEB Services
    GRID_USER_KEY (str): Path to Private Key to authenticate to CMS WEB Services
    HOST (str): Host for service the web application
    PORT (int): Port for service the web application
    SECRET_KEY (str): Flask secret key for securing Flask sessions
    LOG_FOLDER (str): Path to the log folder to store ReReco logs.
    CALLBACK_CLIENT_ID (str): This credential is used for requesting access_token
        via client_credential grant for batch job integrations. 
        For this application, it is used to request authentication tokens to perform
        updates in Stats2 (refresh_workflows_in_stats function in core_lib). 
    CALLBACK_CLIENT_SECRET (str): This credential is used for requesting 
        access_token via client_credential grant for batch job integrations.
        For this application, it is used to request authentication tokens to perform
        updates in Stats2 (refresh_workflows_in_stats function in core_lib).
    APPLICATION_CLIENT_ID (str): This is ID for target application (audience),
        registered in CERN Application Portal, that handles OIDC authentication flow 
        for PdmV applications or this application.
"""
import os
import inspect
import pprint

# Variables retrieved from runtime environment
DEVELOPMENT: bool = not bool(os.getenv("PRODUCTION"))
DEBUG: bool = bool(os.getenv("DEBUG"))
REMOTE_PATH: str = os.getenv("REMOTE_PATH", "")
SERVICE_URL: str = os.getenv("SERVICE_URL", "https://cms-pdmv-dev.web.cern.ch/rereco")
CMSWEB_URL: str = os.getenv("CMSWEB_URL", "")
REMOTE_SSH_USERNAME: str = os.getenv("REMOTE_SSH_USERNAME", "")
REMOTE_SSH_PASSWORD: str = os.getenv("REMOTE_SSH_PASSWORD", "")
REMOTE_SSH_NODE: str = os.getenv("REMOTE_SSH_NODE", "lxplus.cern.ch")
MONGO_DB_USERNAME: str = os.getenv("MONGO_DB_USERNAME", "")
MONGO_DB_PASSWORD: str = os.getenv("MONGO_DB_PASSWORD", "")
MONGO_DB_HOST: str = os.getenv("MONGO_DB_HOST", "")
MONGO_DB_PORT: int = int(os.getenv("MONGO_DB_PORT", "27017"))
GRID_USER_CERT: str = os.getenv("GRID_USER_CERT", "")
GRID_USER_KEY: str = os.getenv("GRID_USER_KEY", "")
HOST: str = os.getenv("HOST", "0.0.0.0")
PORT: int = int(os.getenv("PORT", "8000"))
LOG_FOLDER: str = os.getenv("LOG_FOLDER", "")
CALLBACK_CLIENT_ID: str = os.getenv("CALLBACK_CLIENT_ID", "")
CALLBACK_CLIENT_SECRET: str = os.getenv("CALLBACK_CLIENT_SECRET", "")
APPLICATION_CLIENT_ID: str = os.getenv("APPLICATION_CLIENT_ID", "")
SECRET_KEY: str = os.getenv("SECRET_KEY", "")

# Raise an error if they are empty variables
missing_environment_variables: dict[str, str] = {
    k: v
    for k, v in globals().items()
    if not k.startswith("__")
    and not inspect.ismodule(v)
    and not isinstance(v, bool)
    and not v
}

if missing_environment_variables:
    msg: str = (
        "There are some environment variables "
        "required to be set before running this application\n"
        "Please set the following values via environment variables\n"
        "For more details, please see the description available into `environment.py` module\n"
        f"{pprint.pformat(list(missing_environment_variables.keys()), indent=4)}"
    )
    raise RuntimeError(msg)