Rework django_use_model to fix issues noted in pytest-dev#270

Author: timb07

docs/helpers.rst

@@ -97,9 +97,9 @@ when trying to access the database.
 ``pytest.mark.django_use_model`` - force model creation for unmanaged models
 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
 
-.. py:function:: pytest.mark.django_use_model(model)
+.. py:function:: pytest.mark.django_use_model(model=ModelClass)
 
-   :type model: django model or list of django models
+   :type model: django model or list of django models, as kwarg
    :param model:
      Model or models to be created, should be used only with models that
      have ``Meta.managed = False``
@@ -115,7 +115,7 @@ when trying to access the database.
   Example usage::
 
      @pytest.mark.django_db
-     @pytest.mark.django_use_model(Unmanaged)
+     @pytest.mark.django_use_model(model=Unmanaged)
      def test_unmanaged():
         assert Unmanaged.objects.count() >= 0
 

pytest_django/plugin.py

@@ -402,7 +402,7 @@ def _django_use_model(request):
     The test unit should be decorated:
 
     @pytest.mark.django_db
-    @pytest.mark.django_use_model(model)
+    @pytest.mark.django_use_model(model=ModelClass)
 
     :model: ModelClass, one or many
     """
@@ -411,22 +411,22 @@ def _django_use_model(request):
         return
     from django.db import connection
 
-    model = request.getfuncargvalue('model')
+    model = marker.kwargs['model']
 
     if isinstance(model, (list, tuple)):
         models = model
     else:
         models = (model,)
 
-    with contextlib.closing(connection.schema_editor()) as schema:
+    with connection.schema_editor() as schema:
         schema.deferred_sql = []
         for model_class in models:
             if not hasattr(model, '_meta'):
                 raise ValueError('"model" must be a valid model class')
             schema.create_model(model_class)
 
     def drop():
-        with contextlib.closing(connection.schema_editor()) as schema:
+        with connection.schema_editor() as schema:
             for model_class in models:
                 schema.delete_model(model_class)
 

tests/test_database.py

@@ -141,6 +141,8 @@ def test_transactions_enabled(self):
         assert not connection.in_atomic_block
 
 
+@pytest.mark.skipif(not hasattr(connection, 'schema_editor'),
+                    reason="This Django version does not support SchemaEditor")
 @pytest.mark.django_db
 class TestUseModel:
     """Tests for django_use_model marker"""
@@ -153,7 +155,7 @@ def test_unmanaged_missing(self):
             # Probably nothing else can be asserted here.
             Unmanaged.objects.exists()
 
-    @pytest.mark.django_use_model(Unmanaged)
+    @pytest.mark.django_use_model(model=Unmanaged)
     def test_unmanaged_created(self):
         """Make sure unmanaged models are created"""
         assert Unmanaged.objects.count() == 0
@@ -163,10 +165,20 @@ def test_unmanaged_destroyed(self):
         self.test_unmanaged_missing()
 
 
-
-@pytest.mark.django_use_model(Unmanaged)
+# TODO: Remove this next test before release
+@pytest.mark.skipif(not hasattr(connection, 'schema_editor'),
+                    reason="This Django version does not support SchemaEditor")
+@pytest.mark.django_db
+@pytest.mark.django_use_model(model=Unmanaged)
 def test_marked_test_not_get_hit():
-    assert True is False
+    """
+    A failing test like this was originally added to demonstrate that adding
+    "@pytest.mark.django_use_model(ModelClass)" caused a test not to be
+    collected. It's left here to demonstrate that it's now being collected
+    when called with model=ModelClass instead; it should be removed before
+    the next release.
+    """
+    assert "This test failing shows that it is being collected and run" is False
 
 
 def test_unittest_interaction(django_testdir):