Tests: make factories default to populating dependent objects #1944
Conversation
|
currently using this in an open PR: #1916; more specifically, https://github.com/mitodl/micromasters/pull/1916/files#diff-b92d8d54bd10dd2713c797bdffeb0b90R41 surely there's some way that we can keep something around that accomplishes the goal of this code (reduce the large amount of boilerplate to create a program/course/course run with ancillary records like course price/tier program where needed) instead of removing it entirely |
|
maybe creating a different factory class for the 'full' Program factory is more easily understood and implemented |
Current coverage is 93.93% (diff: 100%)
|
singingwolfboy
force-pushed
the
remove-program-factory-full-create
branch
from
8e380d8
to
352563b
Compare
singingwolfboy
force-pushed
the
remove-program-factory-full-create
branch
from
8b6ecf2
to
96a5015
Compare
|
@singingwolfboy what's going on with this pull request? did you see my comments above? also, there's a bunch of work around the |
singingwolfboy
changed the title
singingwolfboy
changed the title
|
@gsidebo Yes, I saw your comment -- sorry for not responding. I started exploring ways to make this work more cleanly, and I learned about Factory Boy's RelatedFactory attribute, which solves this case very neatly. I've updated the description of this pull request to make it more accurate. Does that make the situation more clear? |
singingwolfboy
force-pushed
the
remove-program-factory-full-create
branch
from
a0f6dcf
to
414ba2a
Compare
singingwolfboy
force-pushed
the
remove-program-factory-full-create
branch
from
414ba2a
to
c8e8d60
Compare
| course_price = CoursePriceFactory.create(course_run=course_run, is_valid=True) | ||
| if program.financial_aid_availability: | ||
| from financialaid.factories import TierProgramFactory | ||
| @factory.post_generation |
There was a problem hiding this comment.
see, this is what i really wanted when i wrote that full=True nonsense :) thanks for finding this! i'll try to get to this PR today
|
This ended up being more work than I anticipated, for comparatively little benefit. I'm going to close this pull request, but leave the branch around at least for now. If we want to pick this up again in the future, we can do so. |
The Factory Boy library, which we're using for making test data, has some nice utilities for automatically populating dependent objects in a data model. In particular, we can use
SubFactoryto create a dependent object before the target object is finished being created, and we can useRelatedFactoryto create a dependent object after the target object is finished being created. In both cases, it's easy to indicate that the dependent object shouldn't be created at all, simply by passing<dependent>=Noneas keyword arguments when creating the target object.For example, when creating a Program object, you'll probably also want to create a Course object for it, and a CourseRun object for the Course, and perhaps even a CoursePrice object for the CourseRun. Previously, this was handled by passing a
full=Trueparameter to theProgramFactoryclass, which was detected by overriding the_create()method. Now, creating these dependent objects is the default usage. If you don't want to create a Course object, you can callProgramFactory.create(course=None), and you'll just get a Program object. If you want a Program and a Course but not a CourseRun, you can callProgramFactory.create(course__course_run=None). You'll still get a Program object, and a Course object will be created for you, but a CourseRun object will not be created.This pull request is still in progress, because there are a few tests in the codebase that need to be changed to accommodate this new assumption. However, it's mostly working already.