Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Throw warning if DATABASE_URL isn't set #199

Merged
merged 6 commits into from
Jan 30, 2023
Merged

Throw warning if DATABASE_URL isn't set #199

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
6 commits
Select commit Hold shift + click to select a range
83c73a1
Throw warning/exception if DATABASE_URL isn't set
palfrey Dec 14, 2022
983b6a8
Explicitly clear os.environ in the cases that need it
palfrey Dec 14, 2022
7cf361f
Merge branch 'master' into no-env-warning
palfrey Jan 30, 2023
02cb377
Merge branch 'master' into no-env-warning
palfrey Jan 30, 2023
6c8c3e1
Remove exception test
palfrey Jan 30, 2023
f8468dc
Don't need a separate message variable
palfrey Jan 30, 2023
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
6 changes: 6 additions & 0 deletions dj_database_url.py
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,3 +1,4 @@
import logging
import os
import urllib.parse as urlparse
from typing import Any, Dict, Optional, Union
Expand Down Expand Up @@ -62,6 +63,11 @@ def config(
"""Returns configured DATABASE dictionary from DATABASE_URL."""
s = os.environ.get(env, default)

if s is None:
logging.warning(
"No %s environment variable set, and so no databases setup" % env
)

if s:
return parse(
s, engine, conn_max_age, conn_health_checks, ssl_require, test_options
Expand Down
108 changes: 70 additions & 38 deletions test_dj_database_url.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -130,13 +130,16 @@ def test_mysql_connector_parsing(self):
assert url["PORT"] == 5431

def test_config_test_options(self):
os.environ[
"DATABASE_URL"
] = "postgres://uf07k1i6d8ia0v:[email protected]:5431/d8r82722r2kuvn?"
test_db_config = {
'NAME': 'mytestdatabase',
}
url = dj_database_url.config(test_options=test_db_config)
with mock.patch.dict(
os.environ,
{
"DATABASE_URL": "postgres://uf07k1i6d8ia0v:[email protected]:5431/d8r82722r2kuvn?"
},
):
test_db_config = {
'NAME': 'mytestdatabase',
}
url = dj_database_url.config(test_options=test_db_config)

assert url['TEST']['NAME'] == 'mytestdatabase'

Expand All @@ -152,15 +155,17 @@ def test_cleardb_parsing(self):
assert url["PORT"] == ""

def test_database_url(self):
del os.environ["DATABASE_URL"]
a = dj_database_url.config()
with mock.patch.dict(os.environ, clear=True):
a = dj_database_url.config()
assert not a

os.environ[
"DATABASE_URL"
] = "postgres://uf07k1i6d8ia0v:[email protected]:5431/d8r82722r2kuvn"

url = dj_database_url.config()
with mock.patch.dict(
os.environ,
{
"DATABASE_URL": "postgres://uf07k1i6d8ia0v:[email protected]:5431/d8r82722r2kuvn"
},
):
url = dj_database_url.config()

assert url["ENGINE"] == "django.db.backends.postgresql"
assert url["NAME"] == "d8r82722r2kuvn"
Expand Down Expand Up @@ -192,10 +197,13 @@ def test_parse_engine_setting(self):

def test_config_engine_setting(self):
engine = "django_mysqlpool.backends.mysqlpool"
os.environ[
"DATABASE_URL"
] = "mysql://bea6eb025ca0d8:[email protected]/heroku_97681db3eff7580?reconnect=true"
url = dj_database_url.config(engine=engine)
with mock.patch.dict(
os.environ,
{
"DATABASE_URL": "mysql://bea6eb025ca0d8:[email protected]/heroku_97681db3eff7580?reconnect=true"
},
):
url = dj_database_url.config(engine=engine)

assert url["ENGINE"] == engine

Expand All @@ -208,19 +216,25 @@ def test_parse_conn_max_age_setting(self):

def test_config_conn_max_age_setting(self):
conn_max_age = 600
os.environ[
"DATABASE_URL"
] = "mysql://bea6eb025ca0d8:[email protected]/heroku_97681db3eff7580?reconnect=true"
url = dj_database_url.config(conn_max_age=conn_max_age)
with mock.patch.dict(
os.environ,
{
"DATABASE_URL": "mysql://bea6eb025ca0d8:[email protected]/heroku_97681db3eff7580?reconnect=true"
},
):
url = dj_database_url.config(conn_max_age=conn_max_age)

assert url["CONN_MAX_AGE"] == conn_max_age

def test_database_url_with_options(self):
# Test full options
os.environ[
"DATABASE_URL"
] = "postgres://uf07k1i6d8ia0v:[email protected]:5431/d8r82722r2kuvn?sslrootcert=rds-combined-ca-bundle.pem&sslmode=verify-full"
url = dj_database_url.config()
with mock.patch.dict(
os.environ,
{
"DATABASE_URL": "postgres://uf07k1i6d8ia0v:[email protected]:5431/d8r82722r2kuvn?sslrootcert=rds-combined-ca-bundle.pem&sslmode=verify-full"
},
):
url = dj_database_url.config()

assert url["ENGINE"] == "django.db.backends.postgresql"
assert url["NAME"] == "d8r82722r2kuvn"
Expand All @@ -234,17 +248,23 @@ def test_database_url_with_options(self):
}

# Test empty options
os.environ[
"DATABASE_URL"
] = "postgres://uf07k1i6d8ia0v:[email protected]:5431/d8r82722r2kuvn?"
url = dj_database_url.config()
with mock.patch.dict(
os.environ,
{
"DATABASE_URL": "postgres://uf07k1i6d8ia0v:[email protected]:5431/d8r82722r2kuvn?"
},
):
url = dj_database_url.config()
assert "OPTIONS" not in url

def test_mysql_database_url_with_sslca_options(self):
os.environ[
"DATABASE_URL"
] = "mysql://uf07k1i6d8ia0v:[email protected]:3306/d8r82722r2kuvn?ssl-ca=rds-combined-ca-bundle.pem"
url = dj_database_url.config()
with mock.patch.dict(
os.environ,
{
"DATABASE_URL": "mysql://uf07k1i6d8ia0v:[email protected]:3306/d8r82722r2kuvn?ssl-ca=rds-combined-ca-bundle.pem"
},
):
url = dj_database_url.config()

assert url["ENGINE"] == "django.db.backends.mysql"
assert url["NAME"] == "d8r82722r2kuvn"
Expand All @@ -255,10 +275,13 @@ def test_mysql_database_url_with_sslca_options(self):
assert url["OPTIONS"] == {"ssl": {"ca": "rds-combined-ca-bundle.pem"}}

# Test empty options
os.environ[
"DATABASE_URL"
] = "mysql://uf07k1i6d8ia0v:[email protected]:3306/d8r82722r2kuvn?"
url = dj_database_url.config()
with mock.patch.dict(
os.environ,
{
"DATABASE_URL": "mysql://uf07k1i6d8ia0v:[email protected]:3306/d8r82722r2kuvn?"
},
):
url = dj_database_url.config()
assert "OPTIONS" not in url

def test_oracle_parsing(self):
Expand Down Expand Up @@ -541,6 +564,15 @@ def test_persistent_connection_variables_config(self):
assert url["CONN_MAX_AGE"] == 600
assert url["CONN_HEALTH_CHECKS"] is True

def test_no_env_variable(self):
with self.assertLogs() as cm:
with mock.patch.dict(os.environ, clear=True):
url = dj_database_url.config()
assert url == {}, url
assert cm.output == [
'WARNING:root:No DATABASE_URL environment variable set, and so no databases setup'
], cm.output

def test_bad_url_parsing(self):
with self.assertRaisesRegex(ValueError, "No support for 'foo'. We support: "):
dj_database_url.parse("foo://bar")
Expand Down