b2f4ffb98a
# What this PR does Remove [`apps.get_model`](https://docs.djangoproject.com/en/3.2/ref/applications/#django.apps.apps.get_model) invocations and use inline `import` statements in places where models are imported within functions/methods to avoid circular imports. I believe `import` statements are more appropriate for most use cases as they allow for better static code analysis & formatting, and solve the issue of circular imports without being unnecessarily dynamic as `apps.get_model`. With `import` statements, it's possible to: - Jump to model definitions in most IDEs - Automatically sort inline imports with `isort` - Find import errors faster/easier (most IDEs highlight broken imports) - Have more consistency across regular & inline imports when importing models This PR also adds a flake8 rule to ban imports of `django.apps.apps`, so it's harder to use `apps.get_model` by mistake (it's possible to ignore this rule by using `# noqa: I251`). The rule is not enforced on directories with migration files, because `apps.get_model` is often used to get a historical state of a model, which is useful when writing migrations ([see this SO answer for more details](https://stackoverflow.com/a/37769213)). So `apps.get_model` is considered OK in migrations (even necessary in some cases). ## Checklist - [x] Unit, integration, and e2e (if applicable) tests updated - [x] Documentation added (or `pr:no public docs` PR label added if not required) - [x] `CHANGELOG.md` updated (or `pr:no changelog` PR label added if not required)
61 lines
1.9 KiB
Python
61 lines
1.9 KiB
Python
import sys
|
|
from unittest.mock import patch
|
|
|
|
import pytest
|
|
from django.apps import apps # noqa: I251
|
|
from django.conf import settings
|
|
from django.test import override_settings
|
|
|
|
app_name = "grafana_plugin"
|
|
|
|
|
|
@pytest.mark.parametrize(
|
|
"startup_command,app_crashed",
|
|
[
|
|
(["python", "manage.py", "runserver"], True),
|
|
(["uwsgi", "blah", "blah", "blah"], True),
|
|
(["python", "manage.py", "migration"], False),
|
|
],
|
|
)
|
|
@patch.object(sys, "exit")
|
|
@override_settings(LICENSE=settings.OPEN_SOURCE_LICENSE_NAME)
|
|
@override_settings(SELF_HOSTED_SETTINGS={"GRAFANA_API_URL": None})
|
|
@pytest.mark.django_db
|
|
def test_it_crashes_the_app_if_the_env_var_is_not_present_for_oss_installations_and_an_org_does_not_exist(
|
|
mocked_sys_exit,
|
|
startup_command,
|
|
app_crashed,
|
|
) -> None:
|
|
with patch.object(sys, "argv", startup_command):
|
|
apps.get_app_config(app_name).ready()
|
|
|
|
if app_crashed:
|
|
mocked_sys_exit.assert_called_once()
|
|
else:
|
|
mocked_sys_exit.assert_not_called()
|
|
|
|
|
|
@patch.object(sys, "argv", ["runserver"])
|
|
@patch.object(sys, "exit")
|
|
@override_settings(LICENSE=settings.OPEN_SOURCE_LICENSE_NAME)
|
|
@override_settings(IS_OPEN_SOURCE=True)
|
|
@override_settings(SELF_HOSTED_SETTINGS={"GRAFANA_API_URL": None})
|
|
@pytest.mark.django_db
|
|
def test_it_doesnt_crash_the_app_if_the_env_var_is_not_present_for_oss_installations_and_an_org_does_exist(
|
|
mocked_sys_exit, make_organization
|
|
) -> None:
|
|
make_organization()
|
|
|
|
apps.get_app_config(app_name).ready()
|
|
mocked_sys_exit.assert_not_called()
|
|
|
|
|
|
@patch.object(sys, "argv", ["runserver"])
|
|
@patch.object(sys, "exit")
|
|
@override_settings(LICENSE=settings.CLOUD_LICENSE_NAME)
|
|
@override_settings(IS_OPEN_SOURCE=False)
|
|
def test_it_ignores_non_oss_installations(mocked_sys_exit) -> None:
|
|
# settings.LICENSE = CLOUD_LICENSE_NAME
|
|
# settings.IS_OPEN_SOURCE = True
|
|
apps.get_app_config(app_name).ready()
|
|
mocked_sys_exit.assert_not_called()
|