Ticket #17018: django-17018.diff

django/contrib/gis/utils/layermapping.py

@@ -295 +295 @@
             elif isinstance(model_field, models.base.ModelBase):
                 # The related _model_, not a field was passed in -- indicating
                 # another mapping for the related Model.
-                val = self.verify_fk(feat, model_field, ogr_name)
+                fk_field = self.model._meta.get_field(field_name)
+                val = self.verify_fk(feat, model_field, fk_field, ogr_name)
             else:
                 # Otherwise, verify OGR Field type.
                 val = self.verify_ogr_field(feat[ogr_name], model_field)
@@ -373 +374 @@
             val = ogr_field.value
         return val
 
-    def verify_fk(self, feat, rel_model, rel_mapping):
+    def verify_fk(self, feat, rel_model, fk_field, rel_mapping):
         """
         Given an OGR Feature, the related model and its dictionary mapping,
         this routine will retrieve the related model for the ForeignKey
@@ -385 +386 @@
 
         # Constructing and verifying the related model keyword arguments.
         fk_kwargs = {}
+        ogr_values_null = True
         for field_name, ogr_name in rel_mapping.items():
+            ogr_values_null = ogr_values_null and feat[ogr_name].value == ''
             fk_kwargs[field_name] = self.verify_ogr_field(feat[ogr_name], rel_model._meta.get_field(field_name))
 
+        # If the all of the ogr values representing the foreign key are None
+        # and the foreign key field's configuration allows null foreign key values,
+        # then set the foreign key value to None
+        if fk_field.null and ogr_values_null:
+            return None
+
         # Attempting to retrieve and return the related model.
         try:
             return rel_model.objects.using(self.using).get(**fk_kwargs)

django/contrib/gis/tests/layermap/tests.py

@@ -11 +11 @@
 from django.contrib.gis.utils.layermapping import LayerMapping, LayerMapError, InvalidDecimal, MissingForeignKey
 
 from .models import (
-    City, County, CountyFeat, Interstate, ICity1, ICity2, Invalid, State,
+    City, County, CountyNullState, CountyFeat, Interstate, ICity1, ICity2, Invalid, State,
     city_mapping, co_mapping, cofeat_mapping, inter_mapping)
 
 
 shp_path = os.path.realpath(os.path.join(os.path.dirname(__file__), os.pardir, 'data'))
 city_shp = os.path.join(shp_path, 'cities', 'cities.shp')
 co_shp = os.path.join(shp_path, 'counties', 'counties.shp')
+co_shp_null_state = os.path.join(shp_path, 'counties', 'counties_null_state.shp')
 inter_shp = os.path.join(shp_path, 'interstates', 'interstates.shp')
 invalid_shp = os.path.join(shp_path, 'invalid', 'emptypoints.shp')
 
@@ -26 +27 @@
 NUMS   = [1, 2, 1, 19, 1] # Number of polygons for each.
 STATES = ['Texas', 'Texas', 'Texas', 'Hawaii', 'Colorado']
 
+
 class LayerMapTest(TestCase):
 
     def test01_init(self):
@@ -278 +280 @@
         lm = LayerMapping(Invalid, invalid_shp, invalid_mapping,
                           source_srs=4326)
         lm.save(silent=True)
+
+    def test08_null_foreign_key(self):
+        "Tests LayerMapping for models with nullable foreign keys.  See #17018."
+        # Check that a record is successfully added with a null foreign key value when
+        # the model foreign key field allows a null value and mapping value is null
+        lm = LayerMapping(CountyNullState, co_shp_null_state, co_mapping, transform=False, unique='name')
+        lm.save()
+        self.assertEqual(1, CountyNullState.objects.all().count())
+        county = CountyNullState.objects.all()[0]
+        self.assertEqual('Pueblo', county.name)
+        self.assertEqual(None, county.state)
+        CountyNullState.objects.all().delete()
+
+        # Check that MissingForeignKey is raised when
+        # the model foreign key field does not allow a null value and mapping value is null
+        lm = LayerMapping(County, co_shp_null_state, co_mapping, transform=False, unique='name')
+        self.assertRaises(MissingForeignKey, lm.save, silent=True, strict=True)
+
+        # Check that MissingForeignKey is raised when
+        # the model foreign key field allows a null value and there is no foreign record
+        # There are no states populated in this case
+        lm = LayerMapping(CountyNullState, co_shp, co_mapping, transform=False, unique='name')
+        self.assertRaises(MissingForeignKey, lm.save, silent=True, strict=True)

django/contrib/gis/tests/layermap/models.py

@@ -10 +10 @@
     mpoly = models.MultiPolygonField(srid=4269) # Multipolygon in NAD83
     objects = models.GeoManager()
 
+class CountyNullState(models.Model):
+    name = models.CharField(max_length=25)
+    state = models.ForeignKey(State, null=True)
+    mpoly = models.MultiPolygonField(srid=4269) # Multipolygon in NAD83
+    objects = models.GeoManager()
+
 class CountyFeat(models.Model):
     name = models.CharField(max_length=25)
     poly = models.PolygonField(srid=4269)