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.

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

fix: override AutoField default value only for Spanner #780

Merged
merged 1 commit into from
Jul 20, 2022
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
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
8 changes: 7 additions & 1 deletion django_spanner/__init__.py
Original file line number Diff line number Diff line change
Expand Up @@ -15,6 +15,7 @@
import pkg_resources
from google.cloud.spanner_v1 import JsonObject
from django.db.models.fields import (
NOT_PROVIDED,
AutoField,
Field,
)
Expand Down Expand Up @@ -61,7 +62,12 @@ def gen_rand_int64():
def autofield_init(self, *args, **kwargs):
kwargs["blank"] = True
Field.__init__(self, *args, **kwargs)
self.default = gen_rand_int64

if (
django.db.connection.settings_dict["ENGINE"] == "django_spanner"
and self.default == NOT_PROVIDED
):
Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Using the INT64 random key only in case it's a Spanner database and default value/function for the auto-field is not provided. Thus, outside Spanner database it'll work as always, and for Spanner users will still be able to override the key with whatever they want.

self.default = gen_rand_int64


AutoField.__init__ = autofield_init
Expand Down
33 changes: 31 additions & 2 deletions tests/unit/django_spanner/test_schema.py
Original file line number Diff line number Diff line change
Expand Up @@ -6,9 +6,10 @@


from .models import Author
from django.db import NotSupportedError
from django.db import NotSupportedError, connection
from django.db.models import Index
from django.db.models.fields import IntegerField
from django.db.models.fields import AutoField, IntegerField
from django_spanner import gen_rand_int64
from django_spanner.schema import DatabaseSchemaEditor
from tests._helpers import HAS_OPENTELEMETRY_INSTALLED
from tests.unit.django_spanner.simple_test import SpannerSimpleTestClass
Expand Down Expand Up @@ -404,3 +405,31 @@ def constraint_names(*args, **kwargs):
new_field.set_attributes_from_name("author_num")
with self.assertRaises(NotSupportedError):
schema_editor.alter_field(Author, old_field, new_field)

def test_autofield_no_default(self):
"""Spanner, default is not provided."""
field = AutoField(name="field_name")
assert gen_rand_int64 == field.default

def test_autofield_default(self):
"""Spanner, default provided."""
mock_func = mock.Mock()
field = AutoField(name="field_name", default=mock_func)
assert gen_rand_int64 != field.default
assert mock_func == field.default

def test_autofield_not_spanner(self):
"""Not Spanner, default not provided."""
connection.settings_dict["ENGINE"] = "another_db"
field = AutoField(name="field_name")
assert gen_rand_int64 != field.default
connection.settings_dict["ENGINE"] = "django_spanner"

def test_autofield_not_spanner_w_default(self):
"""Not Spanner, default provided."""
connection.settings_dict["ENGINE"] = "another_db"
mock_func = mock.Mock()
field = AutoField(name="field_name", default=mock_func)
assert gen_rand_int64 != field.default
assert mock_func == field.default
connection.settings_dict["ENGINE"] = "django_spanner"