factory_boy icon indicating copy to clipboard operation
factory_boy copied to clipboard

Nested RelatedFactory not working

Open anaprados opened this issue 4 years ago • 3 comments

Description

I have 3 models that need to create each other and I cannot create the third and last model.

To Reproduce

I am trying to create an object of type InvoiceFactory and the creation fails.

Model code
class Tax(models.Model):
    item = models.ForeignKey('Item', on_delete=models.CASCADE, related_name='taxes')
    code = models.CharField(max_length=100)


class Item(models.Model):
    invoice = models.ForeignKey('Invoice', on_delete=models.CASCADE, related_name='items')
    name = models.CharField(max_length=250)


class Invoice(models.Model):
    invoice_id = models.CharField(unique=True, max_length=100)
Factory code
class TaxFactory(DjangoModelFactory):
    code = Faker('word')

    class Meta:
        model = models.Tax


class ItemFactory(DjangoModelFactory):
    name = Faker('word')

    taxes = RelatedFactory(
        TaxFactory,
        factory_related_name='item',
    )

    class Meta:
        model = models.Item


class InvoiceFactory(DjangoModelFactory):
    invoice_id = Faker('word')

    items = RelatedFactory(
        ItemFactory,
        factory_related_name='invoice',
    )

    class Meta:
        model = models.Invoice
The issue
ERROR: Test for string representation.
----------------------------------------------------------------------
Traceback (most recent call last):
  File "/local/invoices/tests/test_models.py", line 17, in test_str
    invoice = factories.InvoiceFactory()
  File "/usr/local/lib/python3.6/site-packages/factory/base.py", line 40, in __call__
    return cls.create(**kwargs)
  File "/usr/local/lib/python3.6/site-packages/factory/base.py", line 528, in create
    return cls._generate(enums.CREATE_STRATEGY, kwargs)
  File "/usr/local/lib/python3.6/site-packages/factory/django.py", line 117, in _generate
    return super()._generate(strategy, params)
  File "/usr/local/lib/python3.6/site-packages/factory/base.py", line 465, in _generate
    return step.build()
  File "/usr/local/lib/python3.6/site-packages/factory/builder.py", line 274, in build
    overrides=declaration.context,
  File "/usr/local/lib/python3.6/site-packages/factory/declarations.py", line 592, in evaluate_post
    return self.call(instance, step, postgen_context)
  File "/usr/local/lib/python3.6/site-packages/factory/declarations.py", line 673, in call
    return step.recurse(factory, passed_kwargs)
  File "/usr/local/lib/python3.6/site-packages/factory/builder.py", line 216, in recurse
    return builder.build(parent_step=self, force_sequence=force_sequence)
  File "/usr/local/lib/python3.6/site-packages/factory/builder.py", line 274, in build
    overrides=declaration.context,
  File "/usr/local/lib/python3.6/site-packages/factory/declarations.py", line 592, in evaluate_post
    return self.call(instance, step, postgen_context)
  File "/usr/local/lib/python3.6/site-packages/factory/declarations.py", line 673, in call
    return step.recurse(factory, passed_kwargs)
  File "/usr/local/lib/python3.6/site-packages/factory/builder.py", line 216, in recurse
    return builder.build(parent_step=self, force_sequence=force_sequence)
  File "/usr/local/lib/python3.6/site-packages/factory/builder.py", line 265, in build
    kwargs=kwargs,
  File "/usr/local/lib/python3.6/site-packages/factory/base.py", line 317, in instantiate
    return self.factory._create(model, *args, **kwargs)
  File "/usr/local/lib/python3.6/site-packages/factory/django.py", line 166, in _create
    return manager.create(*args, **kwargs)
  File "/local/invoices/managers.py", line 19, in create
    return super().create(**kwargs)
  File "/usr/local/lib/python3.6/site-packages/django/db/models/manager.py", line 85, in manager_method
    return getattr(self.get_queryset(), name)(*args, **kwargs)
  File "/usr/local/lib/python3.6/site-packages/django/db/models/query.py", line 447, in create
    obj.save(force_insert=True, using=self.db)
  File "/usr/local/lib/python3.6/site-packages/django/db/models/base.py", line 754, in save
    force_update=force_update, update_fields=update_fields)
  File "/usr/local/lib/python3.6/site-packages/django/db/models/base.py", line 792, in save_base
    force_update, using, update_fields,
  File "/usr/local/lib/python3.6/site-packages/django/db/models/base.py", line 895, in _save_table
    results = self._do_insert(cls._base_manager, using, fields, returning_fields, raw)
  File "/usr/local/lib/python3.6/site-packages/django/db/models/base.py", line 935, in _do_insert
    using=using, raw=raw,
  File "/usr/local/lib/python3.6/site-packages/django/db/models/manager.py", line 85, in manager_method
    return getattr(self.get_queryset(), name)(*args, **kwargs)
  File "/usr/local/lib/python3.6/site-packages/django/db/models/query.py", line 1254, in _insert
    return query.get_compiler(using=using).execute_sql(returning_fields)
  File "/usr/local/lib/python3.6/site-packages/django/db/models/sql/compiler.py", line 1397, in execute_sql
    cursor.execute(sql, params)
  File "/usr/local/lib/python3.6/site-packages/django/db/backends/utils.py", line 66, in execute
    return self._execute_with_wrappers(sql, params, many=False, executor=self._execute)
  File "/usr/local/lib/python3.6/site-packages/django/db/backends/utils.py", line 75, in _execute_with_wrappers
    return executor(sql, params, many, context)
  File "/usr/local/lib/python3.6/site-packages/django/db/backends/utils.py", line 84, in _execute
    return self.cursor.execute(sql, params)
  File "/usr/local/lib/python3.6/site-packages/django/db/utils.py", line 90, in __exit__
    raise dj_exc_value.with_traceback(traceback) from exc_value
  File "/usr/local/lib/python3.6/site-packages/django/db/backends/utils.py", line 84, in _execute
    return self.cursor.execute(sql, params)
  File "/usr/local/lib/python3.6/site-packages/django/db/backends/sqlite3/base.py", line 413, in execute
    return Database.Cursor.execute(self, query, params)
django.db.utils.IntegrityError: NOT NULL constraint failed: invoices_tax.item_id
Notes

The traces show these messages:

factory.generate: DEBUG: RelatedFactory: Generating invoices.tests.factories.ItemFactory(<BuildStep for <StepBuilder(<DjangoOptions for InvoiceFactory>, strategy='create')>>, invoice=<Invoice: Invoice object (1)>)
factory.generate: DEBUG: RelatedFactory: Generating invoices.tests.factories.TaxFactory(<BuildStep for <StepBuilder(<DjangoOptions for ItemFactory>, strategy='create')>>, item=None)

Thanks!

anaprados avatar Jun 14 '21 10:06 anaprados

Hi!

First, thanks a lot for the very detailed traceback, it makes it much easier to see what might be the cause.

From the traces, it seems that the item= parameter is lost somewhere in the call stack; I'm wondering if this could happen in this bit:

  File "/local/invoices/managers.py", line 19, in create
    return super().create(**kwargs)

Do you have the code for that function? Is it swallowing the item parameter somehow?

rbarrois avatar Jun 14 '21 15:06 rbarrois

Hi!

Thanks for your answer 🥳.

I have a custom manager just for the traces, here is the code:

class TaxManager(models.Manager):
    def create(self, **kwargs):
        print('### kwargs tax', kwargs)
        return super().create(**kwargs)

And it shows: ### kwargs tax {'code': 'will', 'item': None}

anaprados avatar Jun 15 '21 09:06 anaprados

That's quite surprising 🤔 What happens if you call ItemFactory()? Does it work on its own?

rbarrois avatar Jun 15 '21 13:06 rbarrois