j3d1/webvirtcloud
1
0
Fork 0
mirror of https://github.com/retspen/webvirtcloud synced 2026-11-09 03:36:48 +00:00
Code Issues Projects Releases Wiki Activity

feat(settings): database (PostgreSQL) and SMTP are configurable from the environment

Browse source
This commit is contained in:
catborise 2026-10-07 15:50:07 +03:00
parent 9f5e8fe1c4
commit 85706c5df6
5 changed files with 99 additions and 13 deletions
Download patch file Download diff file Expand all files Collapse all files

36
webvirtcloud/settings.py.template
View file

@ -134,12 +134,26 @@ WSGI_APPLICATION = "webvirtcloud.wsgi.application"
# Database
# https://docs.djangoproject.com/en/3.0/ref/settings/#databases
DATABASES = {
"default": {
"ENGINE": "django.db.backends.sqlite3",
"NAME": Path.joinpath(BASE_DIR, "db.sqlite3"),
# sqlite by default; PostgreSQL when WEBVIRTCLOUD_DB_HOST is set (a host name,
# an IP, or a unix socket directory).
if db_host := os.getenv("WEBVIRTCLOUD_DB_HOST"):
DATABASES = {
"default": {
"ENGINE": "django.db.backends.postgresql",
"HOST": db_host,
"PORT": os.getenv("WEBVIRTCLOUD_DB_PORT", "5432"),
"NAME": os.getenv("WEBVIRTCLOUD_DB_NAME", "webvirtcloud"),
"USER": os.getenv("WEBVIRTCLOUD_DB_USER", "webvirtcloud"),
"PASSWORD": os.getenv("WEBVIRTCLOUD_DB_PASSWORD", ""),
}
}
else:
DATABASES = {
"default": {
"ENGINE": "django.db.backends.sqlite3",
"NAME": Path.joinpath(BASE_DIR, "db.sqlite3"),
}
}
}
AUTHENTICATION_BACKENDS = [
# first: refuses logins that are locked out
@ -355,15 +369,15 @@ SPECTACULAR_SETTINGS = {
"REDOC_DIST": "SIDECAR",
}
# EMAIL Config
# EMAIL Config (SMTP; override through the environment)
EMAIL_BACKEND = 'django.core.mail.backends.smtp.EmailBackend'
EMAIL_HOST = 'smtp.gmail.com'
EMAIL_USE_TLS = True
EMAIL_PORT = 587
EMAIL_HOST = os.getenv("EMAIL_HOST", "smtp.gmail.com")
EMAIL_USE_TLS = os.getenv("EMAIL_USE_TLS", "1") == "1"
EMAIL_PORT = int(os.getenv("EMAIL_PORT", "587"))
## sender's email-id
EMAIL_HOST_USER = ''
EMAIL_HOST_USER = os.getenv("EMAIL_HOST_USER", "")
## password associated with above email-id
EMAIL_HOST_PASSWORD = ''
EMAIL_HOST_PASSWORD = os.getenv("EMAIL_HOST_PASSWORD", "")
# LDAP Config
#

46
webvirtcloud/test_settings_env.py
View file

@ -11,7 +11,12 @@ from django.test import SimpleTestCase, TestCase, override_settings
# Env vars that change the settings; removed from the inherited environment so
# every case starts from the defaults.
CONFIG_VARS = ["WEBVIRTCLOUD_HTTPS", "ALLOWED_HOSTS"]
CONFIG_VARS = [
"WEBVIRTCLOUD_HTTPS", "ALLOWED_HOSTS",
"EMAIL_HOST", "EMAIL_PORT", "EMAIL_HOST_USER", "EMAIL_HOST_PASSWORD", "EMAIL_USE_TLS",
"WEBVIRTCLOUD_DB_HOST", "WEBVIRTCLOUD_DB_PORT", "WEBVIRTCLOUD_DB_NAME",
"WEBVIRTCLOUD_DB_USER", "WEBVIRTCLOUD_DB_PASSWORD",
]
def _env(env):
@ -85,3 +90,42 @@ class AllowedHostsTestCase(SimpleTestCase):
def test_allowed_hosts_star_escape(self):
self.assertIn("*", self.hosts({"ALLOWED_HOSTS": "*"}))
class EmailEnvTestCase(SimpleTestCase):
def test_email_from_env(self):
names = ["EMAIL_HOST", "EMAIL_PORT", "EMAIL_HOST_USER", "EMAIL_HOST_PASSWORD", "EMAIL_USE_TLS"]
env = {"EMAIL_HOST": "smtp.example.com", "EMAIL_PORT": "25", "EMAIL_HOST_USER": "wvc",
"EMAIL_HOST_PASSWORD": "secret", "EMAIL_USE_TLS": "0"}
self.assertEqual(load_settings(env, names), {
"EMAIL_HOST": "smtp.example.com", "EMAIL_PORT": 25, "EMAIL_HOST_USER": "wvc",
"EMAIL_HOST_PASSWORD": "secret", "EMAIL_USE_TLS": False,
})
class DatabaseEnvTestCase(SimpleTestCase):
def db(self, env):
return load_settings(env, ["DATABASES"])["DATABASES"]["default"]
def test_sqlite_is_the_default(self):
db = self.db({})
self.assertEqual(db["ENGINE"], "django.db.backends.sqlite3")
self.assertTrue(db["NAME"].endswith("db.sqlite3"))
def test_postgres_from_env(self):
db = self.db({"WEBVIRTCLOUD_DB_HOST": "db.example.com", "WEBVIRTCLOUD_DB_PORT": "6432",
"WEBVIRTCLOUD_DB_NAME": "wvc", "WEBVIRTCLOUD_DB_USER": "wvcuser",
"WEBVIRTCLOUD_DB_PASSWORD": "secret"})
self.assertEqual(
{k: db[k] for k in ("ENGINE", "HOST", "PORT", "NAME", "USER", "PASSWORD")},
{"ENGINE": "django.db.backends.postgresql", "HOST": "db.example.com", "PORT": "6432",
"NAME": "wvc", "USER": "wvcuser", "PASSWORD": "secret"},
)
def test_postgres_defaults(self):
db = self.db({"WEBVIRTCLOUD_DB_HOST": "db.example.com"})
self.assertEqual(
{k: db[k] for k in ("ENGINE", "PORT", "NAME", "USER", "PASSWORD")},
{"ENGINE": "django.db.backends.postgresql", "PORT": "5432",
"NAME": "webvirtcloud", "USER": "webvirtcloud", "PASSWORD": ""},
)