Generating Fake bulk data using Factory-Boy in Python

0468

You often need fake data to test against. You can, of course, use some sample data in your tests. But what if you need hundreds of records, or even thousands of records, of test data? Then it can get tedious to create and maintain. Sometimes you just need a fake version of a class in your program but you want to have it be realistic data that behaves like the real class. Factories and fakes make this all possible.

In this article we will be using Factory-boy a package in Python for generating fake data.

Please make sure that you install the correct version of factory-boy using the command pip install factory-boy==2.12.0

Let’s try to generate some fake data using factory boy 

<span>import</span> <span>factory</span> <span>#import factory-boy </span><span>name</span> <span>=</span> <span>factory</span><span>.</span><span>Faker</span><span>(</span><span>'</span><span>name</span><span>'</span><span>)</span> <span>#create Faker object with 'name' provider </span><span>for</span> <span>_</span> <span>in</span> <span>range</span><span>(</span><span>5</span><span>):</span>
    <span>print</span><span>(</span><span>name</span><span>.</span><span>generate</span><span>())</span> <span>#generate and print 5 unique names </span>
<span>import</span> <span>factory</span> <span>#import factory-boy </span><span>name</span> <span>=</span> <span>factory</span><span>.</span><span>Faker</span><span>(</span><span>'</span><span>name</span><span>'</span><span>)</span> <span>#create Faker object with 'name' provider </span><span>for</span> <span>_</span> <span>in</span> <span>range</span><span>(</span><span>5</span><span>):</span>
    <span>print</span><span>(</span><span>name</span><span>.</span><span>generate</span><span>())</span> <span>#generate and print 5 unique names </span>
import factory #import factory-boy name = factory.Faker('name') #create Faker object with 'name' provider for _ in range(5):
    print(name.generate()) #generate and print 5 unique names

Enter fullscreen mode Exit fullscreen mode

Results:

factory.Faker() accepts an argument which is called provider and is used for generating the type of data e.g ‘name’ provider will be used for generating names, ’email’ provider will be used for generating email etc.
Let’s try using some more providers 

<span>import</span> <span>factory</span> <span>#import factory-boy </span><span>name</span> <span>=</span> <span>factory</span><span>.</span><span>Faker</span><span>(</span><span>'</span><span>name</span><span>'</span><span>)</span> <span>#create Faker object with 'name' provider </span><span>country</span> <span>=</span> <span>factory</span><span>.</span><span>Faker</span><span>(</span><span>'</span><span>country</span><span>'</span><span>)</span> <span>#create Faker object with 'country' provider </span><span>email</span> <span>=</span> <span>factory</span><span>.</span><span>Faker</span><span>(</span><span>'</span><span>email</span><span>'</span><span>)</span> <span>#create Faker object with 'email' provider </span>
<span>for</span> <span>_</span> <span>in</span> <span>range</span><span>(</span><span>3</span><span>):</span>
    <span>print</span><span>(</span><span>f</span><span>'''</span><span> My name is </span><span>{</span><span>name</span><span>.</span><span>generate</span><span>()</span><span>}</span><span> I live in </span><span>{</span><span>country</span><span>.</span><span>generate</span><span>()</span><span>}</span><span> Reach out to me at </span><span>{</span><span>email</span><span>.</span><span>generate</span><span>()</span><span>}</span><span>'''</span><span>)</span>
<span>import</span> <span>factory</span> <span>#import factory-boy </span><span>name</span> <span>=</span> <span>factory</span><span>.</span><span>Faker</span><span>(</span><span>'</span><span>name</span><span>'</span><span>)</span> <span>#create Faker object with 'name' provider </span><span>country</span> <span>=</span> <span>factory</span><span>.</span><span>Faker</span><span>(</span><span>'</span><span>country</span><span>'</span><span>)</span> <span>#create Faker object with 'country' provider </span><span>email</span> <span>=</span> <span>factory</span><span>.</span><span>Faker</span><span>(</span><span>'</span><span>email</span><span>'</span><span>)</span> <span>#create Faker object with 'email' provider </span>
<span>for</span> <span>_</span> <span>in</span> <span>range</span><span>(</span><span>3</span><span>):</span>
    <span>print</span><span>(</span><span>f</span><span>'''</span><span> My name is </span><span>{</span><span>name</span><span>.</span><span>generate</span><span>()</span><span>}</span><span> I live in </span><span>{</span><span>country</span><span>.</span><span>generate</span><span>()</span><span>}</span><span> Reach out to me at </span><span>{</span><span>email</span><span>.</span><span>generate</span><span>()</span><span>}</span><span>'''</span><span>)</span>
import factory #import factory-boy name = factory.Faker('name') #create Faker object with 'name' provider country = factory.Faker('country') #create Faker object with 'country' provider email = factory.Faker('email') #create Faker object with 'email' provider 
for _ in range(3):
    print(f''' My name is {name.generate()} I live in {country.generate()} Reach out to me at {email.generate()}''')

Enter fullscreen mode Exit fullscreen mode

Results:

Along with Faker class, factory-boy has another module which is Fuzzy, let’s take a look at how it works 

<span>import</span> <span>factory</span> <span>#import factory-boy module </span><span>import</span> <span>factory.fuzzy</span> <span>#import fuzzy module </span><span>name</span> <span>=</span> <span>factory</span><span>.</span><span>Faker</span><span>(</span><span>'</span><span>name</span><span>'</span><span>)</span> <span>#create Faker object with 'name' provider </span><span>gender</span> <span>=</span> <span>factory</span><span>.</span><span>fuzzy</span><span>.</span><span>FuzzyChoice</span><span>(</span><span>choices</span><span>=</span><span>[</span><span>'</span><span>girl</span><span>'</span><span>,</span><span>'</span><span>boy</span><span>'</span><span>])</span> <span>#create fuzzyChoice object which selects from the given options </span><span>grade</span> <span>=</span> <span>factory</span><span>.</span><span>fuzzy</span><span>.</span><span>FuzzyFloat</span><span>(</span><span>30</span><span>,</span><span>80</span><span>)</span> <span>#create FuzzyFloat object which generates a random float number between the lower and upper limit </span><span>age</span> <span>=</span> <span>factory</span><span>.</span><span>fuzzy</span><span>.</span><span>FuzzyInteger</span><span>(</span><span>12</span><span>,</span><span>18</span><span>)</span> <span>#create FuzzyInteger object which generates a random float numbeer between the lower and upper limit </span>
<span>for</span> <span>_</span> <span>in</span> <span>range</span><span>(</span><span>3</span><span>):</span>
    <span>print</span><span>(</span><span>f</span><span>'''</span><span>My name is </span><span>{</span><span>name</span><span>.</span><span>generate</span><span>()</span><span>}</span><span>, I am a </span><span>{</span><span>gender</span><span>.</span><span>fuzz</span><span>()</span><span>}</span><span> I got a grade of </span><span>{</span><span>grade</span><span>.</span><span>fuzz</span><span>()</span><span>:</span><span>.</span><span>2</span><span>f</span><span>}</span><span>% and my age is </span><span>{</span><span>age</span><span>.</span><span>fuzz</span><span>()</span><span>}</span><span> </span><span>'''</span><span>)</span>
<span>import</span> <span>factory</span> <span>#import factory-boy module </span><span>import</span> <span>factory.fuzzy</span> <span>#import fuzzy module </span><span>name</span> <span>=</span> <span>factory</span><span>.</span><span>Faker</span><span>(</span><span>'</span><span>name</span><span>'</span><span>)</span> <span>#create Faker object with 'name' provider </span><span>gender</span> <span>=</span> <span>factory</span><span>.</span><span>fuzzy</span><span>.</span><span>FuzzyChoice</span><span>(</span><span>choices</span><span>=</span><span>[</span><span>'</span><span>girl</span><span>'</span><span>,</span><span>'</span><span>boy</span><span>'</span><span>])</span> <span>#create fuzzyChoice object which selects from the given options </span><span>grade</span> <span>=</span> <span>factory</span><span>.</span><span>fuzzy</span><span>.</span><span>FuzzyFloat</span><span>(</span><span>30</span><span>,</span><span>80</span><span>)</span> <span>#create FuzzyFloat object which generates a random float number between the lower and upper limit </span><span>age</span> <span>=</span> <span>factory</span><span>.</span><span>fuzzy</span><span>.</span><span>FuzzyInteger</span><span>(</span><span>12</span><span>,</span><span>18</span><span>)</span> <span>#create FuzzyInteger object which generates a random float numbeer between the lower and upper limit </span>
<span>for</span> <span>_</span> <span>in</span> <span>range</span><span>(</span><span>3</span><span>):</span>
    <span>print</span><span>(</span><span>f</span><span>'''</span><span>My name is </span><span>{</span><span>name</span><span>.</span><span>generate</span><span>()</span><span>}</span><span>, I am a </span><span>{</span><span>gender</span><span>.</span><span>fuzz</span><span>()</span><span>}</span><span> I got a grade of </span><span>{</span><span>grade</span><span>.</span><span>fuzz</span><span>()</span><span>:</span><span>.</span><span>2</span><span>f</span><span>}</span><span>% and my age is </span><span>{</span><span>age</span><span>.</span><span>fuzz</span><span>()</span><span>}</span><span> </span><span>'''</span><span>)</span>
import factory #import factory-boy module import factory.fuzzy #import fuzzy module name = factory.Faker('name') #create Faker object with 'name' provider gender = factory.fuzzy.FuzzyChoice(choices=['girl','boy']) #create fuzzyChoice object which selects from the given options grade = factory.fuzzy.FuzzyFloat(30,80) #create FuzzyFloat object which generates a random float number between the lower and upper limit age = factory.fuzzy.FuzzyInteger(12,18) #create FuzzyInteger object which generates a random float numbeer between the lower and upper limit 
for _ in range(3):
    print(f'''My name is {name.generate()}, I am a {gender.fuzz()} I got a grade of {grade.fuzz():.2f}% and my age is {age.fuzz()} ''')

Enter fullscreen mode Exit fullscreen mode

Results:

To learn more about the different Classes in fuzzy module and the various options for providers for Faker visit: https://factoryboy.readthedocs.io/en/stable

Now that we know how Factory-boy can mimic data, let’s try mimicking data models which are generally used for creating database tables for applications such as Flask, Django etc.
For this project make a requirements.txt and paste the below contents and then install all the required packages using pip3 install -r requirements.txt 

<span># Pin dependancies that might cause breakage </span><span>Werkzeug</span><span>==</span><span>2.1</span><span>.</span><span>2</span>
<span>SQLAlchemy</span><span>==</span><span>1.4</span><span>.</span><span>46</span>
<span># Dependencies for this project </span><span>Flask</span><span>==</span><span>2.1</span><span>.</span><span>2</span>
<span>Flask</span><span>-</span><span>SQLAlchemy</span><span>==</span><span>2.5</span><span>.</span><span>1</span>
<span># Testing dependencies </span><span>nose</span><span>==</span><span>1.3</span><span>.</span><span>7</span>
<span>pinocchio</span><span>==</span><span>0.4</span><span>.</span><span>3</span>
<span>coverage</span><span>==</span><span>6.3</span><span>.</span><span>2</span>
<span>factory</span><span>-</span><span>boy</span><span>==</span><span>2.12</span><span>.</span><span>0</span>
<span>pylint</span><span>==</span><span>2.14</span><span>.</span><span>0</span>
<span># Pin dependancies that might cause breakage </span><span>Werkzeug</span><span>==</span><span>2.1</span><span>.</span><span>2</span>
<span>SQLAlchemy</span><span>==</span><span>1.4</span><span>.</span><span>46</span>

<span># Dependencies for this project </span><span>Flask</span><span>==</span><span>2.1</span><span>.</span><span>2</span>
<span>Flask</span><span>-</span><span>SQLAlchemy</span><span>==</span><span>2.5</span><span>.</span><span>1</span>

<span># Testing dependencies </span><span>nose</span><span>==</span><span>1.3</span><span>.</span><span>7</span>
<span>pinocchio</span><span>==</span><span>0.4</span><span>.</span><span>3</span>
<span>coverage</span><span>==</span><span>6.3</span><span>.</span><span>2</span>
<span>factory</span><span>-</span><span>boy</span><span>==</span><span>2.12</span><span>.</span><span>0</span>
<span>pylint</span><span>==</span><span>2.14</span><span>.</span><span>0</span>
# Pin dependancies that might cause breakage Werkzeug==2.1.2
SQLAlchemy==1.4.46

# Dependencies for this project Flask==2.1.2
Flask-SQLAlchemy==2.5.1

# Testing dependencies nose==1.3.7
pinocchio==0.4.3
coverage==6.3.2
factory-boy==2.12.0
pylint==2.14.0

Enter fullscreen mode Exit fullscreen mode

And since we would be running unit tests using nosetests please review my previous article – “Test-Driven Development in Python using Unittest and Nose” (https://dev.to/h4ck3rd33p/test-driven-development-in-python-using-unittest-and-nosetest-24ck)

create a setup.cfg file for nosetests configuration and paste the below contents 

<span>[</span><span>nosetests</span><span>]</span>
<span>verbosity=2</span>
<span>with-spec=1</span>
<span>spec-color=1</span>
<span>with-coverage=1</span>
<span>cover-erase=1</span>
<span>cover-package=models</span>
<span>[</span><span>coverage</span><span>:</span><span>report</span><span>]</span>
<span>show_missing = True</span>
<span>[</span><span>nosetests</span><span>]</span>
<span>verbosity=2</span>
<span>with-spec=1</span>
<span>spec-color=1</span>
<span>with-coverage=1</span>
<span>cover-erase=1</span>
<span>cover-package=models</span>

<span>[</span><span>coverage</span><span>:</span><span>report</span><span>]</span>
<span>show_missing = True</span>
[nosetests]
verbosity=2
with-spec=1
spec-color=1
with-coverage=1
cover-erase=1
cover-package=models

[coverage:report]
show_missing = True

Enter fullscreen mode Exit fullscreen mode

now create two folders models which will contain the data model in account.py and the basic setup in __init__.py and tests which will contain the factory model which will mimic the actual model in factories.py and the associated unit tests for testing the application in test_account.py.
Eventually your folder structure should look like this: 

.
├── models
│   ├── account.py
│   └── __init__.py
├── requirements.txt
├── setup.cfg
└── tests
    ├── factories.py
    └── test_account.py
2 directories, 6 files
.
├── models
│   ├── account.py
│   └── __init__.py
├── requirements.txt
├── setup.cfg
└── tests
    ├── factories.py
    └── test_account.py

2 directories, 6 files
.
├── models
│   ├── account.py
│   └── __init__.py
├── requirements.txt
├── setup.cfg
└── tests
    ├── factories.py
    └── test_account.py

2 directories, 6 files

Enter fullscreen mode Exit fullscreen mode

Let’s say we need to test a data model that handles customer accounts. We’ll start by creating this data model. We will use a popular object relational mapper called SQLAlchemy and so we create a db instance of the SQLAlchemy class. Now we build our model. We create a class called Accounts that inherits from the base model of SQLAlchemy. Now we can add our columns, which will be represented as class variables. We add an id. It will serve as a non-information bearing key so we label the id as the primary key. We add a name as a string and an email field as a string. We also add a phone number as a string. We make that phone number optional, so we set nullable to True. Let’s add a Boolean field to determine if this account is disabled, and let’s make the default False. And finally, we’ll add a date joined column as a DateTime and make it optional as well.

models > __init__.py 

<span>"""</span><span> Data Models </span><span>"""</span>
<span>from</span> <span>flask</span> <span>import</span> <span>Flask</span>
<span>from</span> <span>flask_sqlalchemy</span> <span>import</span> <span>SQLAlchemy</span>
<span>app</span> <span>=</span> <span>Flask</span><span>(</span><span>__name__</span><span>)</span>
<span>app</span><span>.</span><span>config</span><span>[</span><span>'</span><span>SQLALCHEMY_TRACK_MODIFICATIONS</span><span>'</span><span>]</span> <span>=</span> <span>False</span>
<span>app</span><span>.</span><span>config</span><span>[</span><span>'</span><span>SQLALCHEMY_DATABASE_URI</span><span>'</span><span>]</span> <span>=</span> <span>'</span><span>sqlite:///test.db</span><span>'</span>
<span>db</span> <span>=</span> <span>SQLAlchemy</span><span>(</span><span>app</span><span>)</span>
<span>"""</span><span> Data Models </span><span>"""</span>
<span>from</span> <span>flask</span> <span>import</span> <span>Flask</span>
<span>from</span> <span>flask_sqlalchemy</span> <span>import</span> <span>SQLAlchemy</span>

<span>app</span> <span>=</span> <span>Flask</span><span>(</span><span>__name__</span><span>)</span>
<span>app</span><span>.</span><span>config</span><span>[</span><span>'</span><span>SQLALCHEMY_TRACK_MODIFICATIONS</span><span>'</span><span>]</span> <span>=</span> <span>False</span>
<span>app</span><span>.</span><span>config</span><span>[</span><span>'</span><span>SQLALCHEMY_DATABASE_URI</span><span>'</span><span>]</span> <span>=</span> <span>'</span><span>sqlite:///test.db</span><span>'</span>
<span>db</span> <span>=</span> <span>SQLAlchemy</span><span>(</span><span>app</span><span>)</span>
""" Data Models """
from flask import Flask
from flask_sqlalchemy import SQLAlchemy

app = Flask(__name__)
app.config['SQLALCHEMY_TRACK_MODIFICATIONS'] = False
app.config['SQLALCHEMY_DATABASE_URI'] = 'sqlite:///test.db'
db = SQLAlchemy(app)

Enter fullscreen mode Exit fullscreen mode

models > account.py 

<span>"""</span><span> Account class </span><span>"""</span>
<span>import</span> <span>logging</span>
<span>from</span> <span>sqlalchemy.sql</span> <span>import</span> <span>func</span>
<span>from</span> <span>models</span> <span>import</span> <span>db</span>
<span>logger</span> <span>=</span> <span>logging</span><span>.</span><span>getLogger</span><span>()</span>
<span>class</span> <span>DataValidationError</span><span>(</span><span>Exception</span><span>):</span>
    <span>"""</span><span>Used for an data validation errors when deserializing</span><span>"""</span>
<span>class</span> <span>Account</span><span>(</span><span>db</span><span>.</span><span>Model</span><span>):</span>
    <span>"""</span><span> Class that represents an Account </span><span>"""</span>
    <span>id</span> <span>=</span> <span>db</span><span>.</span><span>Column</span><span>(</span><span>db</span><span>.</span><span>Integer</span><span>,</span> <span>primary_key</span><span>=</span><span>True</span><span>)</span>
    <span>name</span> <span>=</span> <span>db</span><span>.</span><span>Column</span><span>(</span><span>db</span><span>.</span><span>String</span><span>(</span><span>64</span><span>))</span>
    <span>email</span> <span>=</span> <span>db</span><span>.</span><span>Column</span><span>(</span><span>db</span><span>.</span><span>String</span><span>(</span><span>64</span><span>))</span>
    <span>phone_number</span> <span>=</span> <span>db</span><span>.</span><span>Column</span><span>(</span><span>db</span><span>.</span><span>String</span><span>(</span><span>32</span><span>),</span> <span>nullable</span><span>=</span><span>True</span><span>)</span>
    <span>disabled</span> <span>=</span> <span>db</span><span>.</span><span>Column</span><span>(</span><span>db</span><span>.</span><span>Boolean</span><span>(),</span> <span>nullable</span><span>=</span><span>False</span><span>,</span> <span>default</span><span>=</span><span>False</span><span>)</span>
    <span>date_joined</span> <span>=</span> <span>db</span><span>.</span><span>Column</span><span>(</span><span>db</span><span>.</span><span>Date</span><span>,</span> <span>nullable</span><span>=</span><span>False</span><span>,</span> <span>server_default</span><span>=</span><span>func</span><span>.</span><span>now</span><span>())</span>
    <span>def</span> <span>__repr__</span><span>(</span><span>self</span><span>):</span>
        <span>return</span> <span>'</span><span><Account %r></span><span>'</span> <span>%</span> <span>self</span><span>.</span><span>name</span>
    <span>def</span> <span>to_dict</span><span>(</span><span>self</span><span>)</span> <span>-></span> <span>dict</span><span>:</span>
        <span>"""</span><span>Serializes the class as a dictionary</span><span>"""</span>
        <span>return</span> <span>{</span><span>c</span><span>.</span><span>name</span><span>:</span> <span>getattr</span><span>(</span><span>self</span><span>,</span> <span>c</span><span>.</span><span>name</span><span>)</span> <span>for</span> <span>c</span> <span>in</span> <span>self</span><span>.</span><span>__table__</span><span>.</span><span>columns</span><span>}</span>
    <span>def</span> <span>from_dict</span><span>(</span><span>self</span><span>,</span> <span>data</span><span>:</span> <span>dict</span><span>)</span> <span>-></span> <span>None</span><span>:</span>
        <span>"""</span><span>Sets attributes from a dictionary</span><span>"""</span>
        <span>for</span> <span>key</span><span>,</span> <span>value</span> <span>in</span> <span>data</span><span>.</span><span>items</span><span>():</span>
            <span>setattr</span><span>(</span><span>self</span><span>,</span> <span>key</span><span>,</span> <span>value</span><span>)</span>
    <span>def</span> <span>create</span><span>(</span><span>self</span><span>):</span>
        <span>"""</span><span>Creates a Account to the database</span><span>"""</span>
        <span>logger</span><span>.</span><span>info</span><span>(</span><span>"</span><span>Creating %s</span><span>"</span><span>,</span> <span>self</span><span>.</span><span>name</span><span>)</span>
        <span>db</span><span>.</span><span>session</span><span>.</span><span>add</span><span>(</span><span>self</span><span>)</span>
        <span>db</span><span>.</span><span>session</span><span>.</span><span>commit</span><span>()</span>
    <span>def</span> <span>update</span><span>(</span><span>self</span><span>):</span>
        <span>"""</span><span>Updates a Account to the database</span><span>"""</span>
        <span>logger</span><span>.</span><span>info</span><span>(</span><span>"</span><span>Saving %s</span><span>"</span><span>,</span> <span>self</span><span>.</span><span>name</span><span>)</span>
        <span>if</span> <span>not</span> <span>self</span><span>.</span><span>id</span><span>:</span>
            <span>raise</span> <span>DataValidationError</span><span>(</span><span>"</span><span>Update called with empty ID field</span><span>"</span><span>)</span>
        <span>db</span><span>.</span><span>session</span><span>.</span><span>commit</span><span>()</span>
    <span>def</span> <span>delete</span><span>(</span><span>self</span><span>):</span>
        <span>"""</span><span>Removes a Account from the data store</span><span>"""</span>
        <span>logger</span><span>.</span><span>info</span><span>(</span><span>"</span><span>Deleting %s</span><span>"</span><span>,</span> <span>self</span><span>.</span><span>name</span><span>)</span>
        <span>db</span><span>.</span><span>session</span><span>.</span><span>delete</span><span>(</span><span>self</span><span>)</span>
        <span>db</span><span>.</span><span>session</span><span>.</span><span>commit</span><span>()</span>
    <span>################################################## </span>    <span># CLASS METHODS </span>    <span>################################################## </span>
    <span>@classmethod</span>
    <span>def</span> <span>all</span><span>(</span><span>cls</span><span>)</span> <span>-></span> <span>list</span><span>:</span>
        <span>"""</span><span>Returns all of the Accounts in the database</span><span>"""</span>
        <span>logger</span><span>.</span><span>info</span><span>(</span><span>"</span><span>Processing all Accounts</span><span>"</span><span>)</span>
        <span>return</span> <span>cls</span><span>.</span><span>query</span><span>.</span><span>all</span><span>()</span>
    <span>@classmethod</span>
    <span>def</span> <span>find</span><span>(</span><span>cls</span><span>,</span> <span>account_id</span><span>:</span> <span>int</span><span>):</span>
        <span>"""</span><span>Finds a Account by it</span><span>'</span><span>s ID :param account_id: the id of the Account to find :type account_id: int :return: an instance with the account_id, or None if not found :rtype: Account </span><span>"""</span>
        <span>logger</span><span>.</span><span>info</span><span>(</span><span>"</span><span>Processing lookup for id %s ...</span><span>"</span><span>,</span> <span>account_id</span><span>)</span>
        <span>return</span> <span>cls</span><span>.</span><span>query</span><span>.</span><span>get</span><span>(</span><span>account_id</span><span>)</span>
<span>"""</span><span> Account class </span><span>"""</span>
<span>import</span> <span>logging</span>
<span>from</span> <span>sqlalchemy.sql</span> <span>import</span> <span>func</span>
<span>from</span> <span>models</span> <span>import</span> <span>db</span>

<span>logger</span> <span>=</span> <span>logging</span><span>.</span><span>getLogger</span><span>()</span>


<span>class</span> <span>DataValidationError</span><span>(</span><span>Exception</span><span>):</span>
    <span>"""</span><span>Used for an data validation errors when deserializing</span><span>"""</span>


<span>class</span> <span>Account</span><span>(</span><span>db</span><span>.</span><span>Model</span><span>):</span>
    <span>"""</span><span> Class that represents an Account </span><span>"""</span>

    <span>id</span> <span>=</span> <span>db</span><span>.</span><span>Column</span><span>(</span><span>db</span><span>.</span><span>Integer</span><span>,</span> <span>primary_key</span><span>=</span><span>True</span><span>)</span>
    <span>name</span> <span>=</span> <span>db</span><span>.</span><span>Column</span><span>(</span><span>db</span><span>.</span><span>String</span><span>(</span><span>64</span><span>))</span>
    <span>email</span> <span>=</span> <span>db</span><span>.</span><span>Column</span><span>(</span><span>db</span><span>.</span><span>String</span><span>(</span><span>64</span><span>))</span>
    <span>phone_number</span> <span>=</span> <span>db</span><span>.</span><span>Column</span><span>(</span><span>db</span><span>.</span><span>String</span><span>(</span><span>32</span><span>),</span> <span>nullable</span><span>=</span><span>True</span><span>)</span>
    <span>disabled</span> <span>=</span> <span>db</span><span>.</span><span>Column</span><span>(</span><span>db</span><span>.</span><span>Boolean</span><span>(),</span> <span>nullable</span><span>=</span><span>False</span><span>,</span> <span>default</span><span>=</span><span>False</span><span>)</span>
    <span>date_joined</span> <span>=</span> <span>db</span><span>.</span><span>Column</span><span>(</span><span>db</span><span>.</span><span>Date</span><span>,</span> <span>nullable</span><span>=</span><span>False</span><span>,</span> <span>server_default</span><span>=</span><span>func</span><span>.</span><span>now</span><span>())</span>

    <span>def</span> <span>__repr__</span><span>(</span><span>self</span><span>):</span>
        <span>return</span> <span>'</span><span><Account %r></span><span>'</span> <span>%</span> <span>self</span><span>.</span><span>name</span>

    <span>def</span> <span>to_dict</span><span>(</span><span>self</span><span>)</span> <span>-></span> <span>dict</span><span>:</span>
        <span>"""</span><span>Serializes the class as a dictionary</span><span>"""</span>
        <span>return</span> <span>{</span><span>c</span><span>.</span><span>name</span><span>:</span> <span>getattr</span><span>(</span><span>self</span><span>,</span> <span>c</span><span>.</span><span>name</span><span>)</span> <span>for</span> <span>c</span> <span>in</span> <span>self</span><span>.</span><span>__table__</span><span>.</span><span>columns</span><span>}</span>

    <span>def</span> <span>from_dict</span><span>(</span><span>self</span><span>,</span> <span>data</span><span>:</span> <span>dict</span><span>)</span> <span>-></span> <span>None</span><span>:</span>
        <span>"""</span><span>Sets attributes from a dictionary</span><span>"""</span>
        <span>for</span> <span>key</span><span>,</span> <span>value</span> <span>in</span> <span>data</span><span>.</span><span>items</span><span>():</span>
            <span>setattr</span><span>(</span><span>self</span><span>,</span> <span>key</span><span>,</span> <span>value</span><span>)</span>

    <span>def</span> <span>create</span><span>(</span><span>self</span><span>):</span>
        <span>"""</span><span>Creates a Account to the database</span><span>"""</span>
        <span>logger</span><span>.</span><span>info</span><span>(</span><span>"</span><span>Creating %s</span><span>"</span><span>,</span> <span>self</span><span>.</span><span>name</span><span>)</span>
        <span>db</span><span>.</span><span>session</span><span>.</span><span>add</span><span>(</span><span>self</span><span>)</span>
        <span>db</span><span>.</span><span>session</span><span>.</span><span>commit</span><span>()</span>

    <span>def</span> <span>update</span><span>(</span><span>self</span><span>):</span>
        <span>"""</span><span>Updates a Account to the database</span><span>"""</span>
        <span>logger</span><span>.</span><span>info</span><span>(</span><span>"</span><span>Saving %s</span><span>"</span><span>,</span> <span>self</span><span>.</span><span>name</span><span>)</span>
        <span>if</span> <span>not</span> <span>self</span><span>.</span><span>id</span><span>:</span>
            <span>raise</span> <span>DataValidationError</span><span>(</span><span>"</span><span>Update called with empty ID field</span><span>"</span><span>)</span>
        <span>db</span><span>.</span><span>session</span><span>.</span><span>commit</span><span>()</span>

    <span>def</span> <span>delete</span><span>(</span><span>self</span><span>):</span>
        <span>"""</span><span>Removes a Account from the data store</span><span>"""</span>
        <span>logger</span><span>.</span><span>info</span><span>(</span><span>"</span><span>Deleting %s</span><span>"</span><span>,</span> <span>self</span><span>.</span><span>name</span><span>)</span>
        <span>db</span><span>.</span><span>session</span><span>.</span><span>delete</span><span>(</span><span>self</span><span>)</span>
        <span>db</span><span>.</span><span>session</span><span>.</span><span>commit</span><span>()</span>

    <span>################################################## </span>    <span># CLASS METHODS </span>    <span>################################################## </span>
    <span>@classmethod</span>
    <span>def</span> <span>all</span><span>(</span><span>cls</span><span>)</span> <span>-></span> <span>list</span><span>:</span>
        <span>"""</span><span>Returns all of the Accounts in the database</span><span>"""</span>
        <span>logger</span><span>.</span><span>info</span><span>(</span><span>"</span><span>Processing all Accounts</span><span>"</span><span>)</span>
        <span>return</span> <span>cls</span><span>.</span><span>query</span><span>.</span><span>all</span><span>()</span>

    <span>@classmethod</span>
    <span>def</span> <span>find</span><span>(</span><span>cls</span><span>,</span> <span>account_id</span><span>:</span> <span>int</span><span>):</span>
        <span>"""</span><span>Finds a Account by it</span><span>'</span><span>s ID :param account_id: the id of the Account to find :type account_id: int :return: an instance with the account_id, or None if not found :rtype: Account </span><span>"""</span>
        <span>logger</span><span>.</span><span>info</span><span>(</span><span>"</span><span>Processing lookup for id %s ...</span><span>"</span><span>,</span> <span>account_id</span><span>)</span>
        <span>return</span> <span>cls</span><span>.</span><span>query</span><span>.</span><span>get</span><span>(</span><span>account_id</span><span>)</span>
""" Account class """
import logging
from sqlalchemy.sql import func
from models import db

logger = logging.getLogger()


class DataValidationError(Exception):
    """Used for an data validation errors when deserializing"""


class Account(db.Model):
    """ Class that represents an Account """

    id = db.Column(db.Integer, primary_key=True)
    name = db.Column(db.String(64))
    email = db.Column(db.String(64))
    phone_number = db.Column(db.String(32), nullable=True)
    disabled = db.Column(db.Boolean(), nullable=False, default=False)
    date_joined = db.Column(db.Date, nullable=False, server_default=func.now())

    def __repr__(self):
        return '<Account %r>' % self.name

    def to_dict(self) -> dict:
        """Serializes the class as a dictionary"""
        return {c.name: getattr(self, c.name) for c in self.__table__.columns}

    def from_dict(self, data: dict) -> None:
        """Sets attributes from a dictionary"""
        for key, value in data.items():
            setattr(self, key, value)

    def create(self):
        """Creates a Account to the database"""
        logger.info("Creating %s", self.name)
        db.session.add(self)
        db.session.commit()

    def update(self):
        """Updates a Account to the database"""
        logger.info("Saving %s", self.name)
        if not self.id:
            raise DataValidationError("Update called with empty ID field")
        db.session.commit()

    def delete(self):
        """Removes a Account from the data store"""
        logger.info("Deleting %s", self.name)
        db.session.delete(self)
        db.session.commit()

    ##################################################     # CLASS METHODS     ################################################## 
    @classmethod
    def all(cls) -> list:
        """Returns all of the Accounts in the database"""
        logger.info("Processing all Accounts")
        return cls.query.all()

    @classmethod
    def find(cls, account_id: int):
        """Finds a Account by it's ID :param account_id: the id of the Account to find :type account_id: int :return: an instance with the account_id, or None if not found :rtype: Account """
        logger.info("Processing lookup for id %s ...", account_id)
        return cls.query.get(account_id)

Enter fullscreen mode Exit fullscreen mode

Now let’s create the fake class that mimics the original Account class. Let’s name it AccountFactory. Also make a inner class Meta and make an attribute model and set it to Account which will let Factory-Boy know exactly which data class it has to mimic and thus AccountFactory will now have all the methods automatically that Account class has.

tests > factories.py 

<span>"""</span><span> AccountFactory class using FactoryBoy </span><span>"""</span>
<span>import</span> <span>factory</span>
<span>from</span> <span>datetime</span> <span>import</span> <span>date</span>
<span>from</span> <span>factory.fuzzy</span> <span>import</span> <span>FuzzyChoice</span><span>,</span> <span>FuzzyDate</span>
<span>from</span> <span>models.account</span> <span>import</span> <span>Account</span>
<span>class</span> <span>AccountFactory</span><span>(</span><span>factory</span><span>.</span><span>Factory</span><span>):</span>
    <span>"""</span><span> Creates fake Accounts </span><span>"""</span>
    <span>class</span> <span>Meta</span><span>:</span>
        <span>model</span> <span>=</span> <span>Account</span>
    <span>id</span> <span>=</span> <span>factory</span><span>.</span><span>Sequence</span><span>(</span><span>lambda</span> <span>n</span><span>:</span> <span>n</span><span>)</span>
    <span>name</span> <span>=</span> <span>factory</span><span>.</span><span>Faker</span><span>(</span><span>"</span><span>name</span><span>"</span><span>)</span>
    <span>email</span> <span>=</span> <span>factory</span><span>.</span><span>Faker</span><span>(</span><span>"</span><span>email</span><span>"</span><span>)</span>
    <span>phone_number</span> <span>=</span> <span>factory</span><span>.</span><span>Faker</span><span>(</span><span>"</span><span>phone_number</span><span>"</span><span>)</span>
    <span>disabled</span> <span>=</span> <span>FuzzyChoice</span><span>(</span><span>choices</span><span>=</span><span>[</span><span>True</span><span>,</span> <span>False</span><span>])</span>
    <span>date_joined</span> <span>=</span> <span>FuzzyDate</span><span>(</span><span>date</span><span>(</span><span>2008</span><span>,</span> <span>1</span><span>,</span> <span>1</span><span>))</span>
<span>"""</span><span> AccountFactory class using FactoryBoy </span><span>"""</span>
<span>import</span> <span>factory</span>
<span>from</span> <span>datetime</span> <span>import</span> <span>date</span>
<span>from</span> <span>factory.fuzzy</span> <span>import</span> <span>FuzzyChoice</span><span>,</span> <span>FuzzyDate</span>
<span>from</span> <span>models.account</span> <span>import</span> <span>Account</span>

<span>class</span> <span>AccountFactory</span><span>(</span><span>factory</span><span>.</span><span>Factory</span><span>):</span>
    <span>"""</span><span> Creates fake Accounts </span><span>"""</span>

    <span>class</span> <span>Meta</span><span>:</span>
        <span>model</span> <span>=</span> <span>Account</span>

    <span>id</span> <span>=</span> <span>factory</span><span>.</span><span>Sequence</span><span>(</span><span>lambda</span> <span>n</span><span>:</span> <span>n</span><span>)</span>
    <span>name</span> <span>=</span> <span>factory</span><span>.</span><span>Faker</span><span>(</span><span>"</span><span>name</span><span>"</span><span>)</span>
    <span>email</span> <span>=</span> <span>factory</span><span>.</span><span>Faker</span><span>(</span><span>"</span><span>email</span><span>"</span><span>)</span>
    <span>phone_number</span> <span>=</span> <span>factory</span><span>.</span><span>Faker</span><span>(</span><span>"</span><span>phone_number</span><span>"</span><span>)</span>
    <span>disabled</span> <span>=</span> <span>FuzzyChoice</span><span>(</span><span>choices</span><span>=</span><span>[</span><span>True</span><span>,</span> <span>False</span><span>])</span>
    <span>date_joined</span> <span>=</span> <span>FuzzyDate</span><span>(</span><span>date</span><span>(</span><span>2008</span><span>,</span> <span>1</span><span>,</span> <span>1</span><span>))</span>
""" AccountFactory class using FactoryBoy """
import factory
from datetime import date
from factory.fuzzy import FuzzyChoice, FuzzyDate
from models.account import Account

class AccountFactory(factory.Factory):
    """ Creates fake Accounts """

    class Meta:
        model = Account

    id = factory.Sequence(lambda n: n)
    name = factory.Faker("name")
    email = factory.Faker("email")
    phone_number = factory.Faker("phone_number")
    disabled = FuzzyChoice(choices=[True, False])
    date_joined = FuzzyDate(date(2008, 1, 1))

Enter fullscreen mode Exit fullscreen mode

id = factory.Sequence(lambda n: n) will generate continuous sequence of numbers 0,1,2…

Now let’s write the unit tests for testing our AccountFactory

Test-fixtures: These are methods that are run to set up the state of the system before and after running test cases.

  • setUpClass(cls): This is used to set the system state before running any test cases in the class. In our example, it is creating the DB and the tables.

  • tearDownClass(cls): This is used to clean up the system after running all the test cases in the current class. In our example, it is deleting any remaining test data and disconnecting from the database.

  • setUp(self): This is used to set up the system before running an individual test case. In our example, it is deleting the data and saving it.

  • tearDown(self): This is used to reset the system state after running an individual test case. In our example, it is closing the current database session.

  • setUpAll: This is used to set up the system state before even going into any class. We haven’t used this in our example

  • tearDownAll: This is used to reset the system state after finishing with all the classes. We haven’t used this in our example

tests > test_account.py 

<span>"""</span><span> Test Cases TestAccountModel </span><span>"""</span>
<span>from</span> <span>random</span> <span>import</span> <span>randrange</span>
<span>from</span> <span>unittest</span> <span>import</span> <span>TestCase</span>
<span>from</span> <span>models</span> <span>import</span> <span>db</span>
<span>from</span> <span>models.account</span> <span>import</span> <span>Account</span><span>,</span> <span>DataValidationError</span>
<span>from</span> <span>factories</span> <span>import</span> <span>AccountFactory</span>
<span>class</span> <span>TestAccountModel</span><span>(</span><span>TestCase</span><span>):</span>
    <span>"""</span><span>Test Account Model</span><span>"""</span>
    <span>@classmethod</span>
    <span>def</span> <span>setUpClass</span><span>(</span><span>cls</span><span>):</span> <span>#Runs before running any unit test </span>        <span>"""</span><span> Create table </span><span>"""</span>
        <span>db</span><span>.</span><span>create_all</span><span>()</span>  <span># make our sqlalchemy tables </span>
    <span>@classmethod</span>
    <span>def</span> <span>tearDownClass</span><span>(</span><span>cls</span><span>):</span> <span>#Runs after running all the tests </span>        <span>"""</span><span>Delete test data and Disconnext from database</span><span>"""</span>
        <span>db</span><span>.</span><span>session</span><span>.</span><span>query</span><span>(</span><span>Account</span><span>).</span><span>delete</span><span>()</span>
        <span>db</span><span>.</span><span>session</span><span>.</span><span>close</span><span>()</span>
    <span>def</span> <span>setUp</span><span>(</span><span>self</span><span>):</span> <span>#Runs before running every individual test </span>        <span>"""</span><span>Drop the table</span><span>"""</span>
        <span>db</span><span>.</span><span>session</span><span>.</span><span>query</span><span>(</span><span>Account</span><span>).</span><span>delete</span><span>()</span>
        <span>db</span><span>.</span><span>session</span><span>.</span><span>commit</span><span>()</span>
    <span>def</span> <span>tearDown</span><span>(</span><span>self</span><span>):</span> <span>#Runs after ruunning every individual test </span>        <span>"""</span><span>Remove the session</span><span>"""</span>
        <span>db</span><span>.</span><span>session</span><span>.</span><span>remove</span><span>()</span>
    <span>###################################################################### </span>    <span># T E S T C A S E S </span>    <span>###################################################################### </span>
    <span>def</span> <span>test_create_all_accounts</span><span>(</span><span>self</span><span>):</span>
        <span>"""</span><span> Test creating multiple Accounts </span><span>"""</span>
        <span>for</span> <span>_</span> <span>in</span> <span>range</span><span>(</span><span>10</span><span>):</span>
            <span>account</span> <span>=</span> <span>AccountFactory</span><span>()</span>
            <span>account</span><span>.</span><span>create</span><span>()</span>
        <span>self</span><span>.</span><span>assertEqual</span><span>(</span><span>len</span><span>(</span><span>Account</span><span>.</span><span>all</span><span>()),</span> <span>10</span><span>)</span>
    <span>def</span> <span>test_create_an_account</span><span>(</span><span>self</span><span>):</span>
        <span>"""</span><span> Test Account creation using known data </span><span>"""</span>
        <span>account</span> <span>=</span> <span>AccountFactory</span><span>()</span>
        <span>account</span><span>.</span><span>create</span><span>()</span>
        <span>self</span><span>.</span><span>assertEqual</span><span>(</span><span>len</span><span>(</span><span>Account</span><span>.</span><span>all</span><span>()),</span> <span>1</span><span>)</span>
    <span>def</span> <span>test_repr</span><span>(</span><span>self</span><span>):</span>
        <span>"""</span><span>Test the representation of an account</span><span>"""</span>
        <span>account</span> <span>=</span> <span>Account</span><span>()</span>
        <span>account</span><span>.</span><span>name</span> <span>=</span> <span>"</span><span>Foo</span><span>"</span>
        <span>self</span><span>.</span><span>assertEqual</span><span>(</span><span>str</span><span>(</span><span>account</span><span>),</span> <span>"</span><span><Account </span><span>'</span><span>Foo</span><span>'</span><span>></span><span>"</span><span>)</span>
    <span>def</span> <span>test_to_dict</span><span>(</span><span>self</span><span>):</span>
        <span>"""</span><span> Test account to dict </span><span>"""</span>
        <span>account</span> <span>=</span> <span>AccountFactory</span><span>()</span>
        <span>result</span> <span>=</span> <span>account</span><span>.</span><span>to_dict</span><span>()</span>
        <span>self</span><span>.</span><span>assertEqual</span><span>(</span><span>account</span><span>.</span><span>name</span><span>,</span> <span>result</span><span>[</span><span>"</span><span>name</span><span>"</span><span>])</span>
        <span>self</span><span>.</span><span>assertEqual</span><span>(</span><span>account</span><span>.</span><span>email</span><span>,</span> <span>result</span><span>[</span><span>"</span><span>email</span><span>"</span><span>])</span>
        <span>self</span><span>.</span><span>assertEqual</span><span>(</span><span>account</span><span>.</span><span>phone_number</span><span>,</span> <span>result</span><span>[</span><span>"</span><span>phone_number</span><span>"</span><span>])</span>
        <span>self</span><span>.</span><span>assertEqual</span><span>(</span><span>account</span><span>.</span><span>disabled</span><span>,</span> <span>result</span><span>[</span><span>"</span><span>disabled</span><span>"</span><span>])</span>
        <span>self</span><span>.</span><span>assertEqual</span><span>(</span><span>account</span><span>.</span><span>date_joined</span><span>,</span> <span>result</span><span>[</span><span>"</span><span>date_joined</span><span>"</span><span>])</span>
    <span>def</span> <span>test_from_dict</span><span>(</span><span>self</span><span>):</span>
        <span>"""</span><span> Test account from dict </span><span>"""</span>
        <span>data</span> <span>=</span> <span>AccountFactory</span><span>().</span><span>to_dict</span><span>()</span>
        <span>account</span> <span>=</span> <span>Account</span><span>()</span>
        <span>account</span><span>.</span><span>from_dict</span><span>(</span><span>data</span><span>)</span>
        <span>self</span><span>.</span><span>assertEqual</span><span>(</span><span>account</span><span>.</span><span>name</span><span>,</span> <span>data</span><span>[</span><span>"</span><span>name</span><span>"</span><span>])</span>
        <span>self</span><span>.</span><span>assertEqual</span><span>(</span><span>account</span><span>.</span><span>email</span><span>,</span> <span>data</span><span>[</span><span>"</span><span>email</span><span>"</span><span>])</span>
        <span>self</span><span>.</span><span>assertEqual</span><span>(</span><span>account</span><span>.</span><span>phone_number</span><span>,</span> <span>data</span><span>[</span><span>"</span><span>phone_number</span><span>"</span><span>])</span>
        <span>self</span><span>.</span><span>assertEqual</span><span>(</span><span>account</span><span>.</span><span>disabled</span><span>,</span> <span>data</span><span>[</span><span>"</span><span>disabled</span><span>"</span><span>])</span>
    <span>def</span> <span>test_update_an_account</span><span>(</span><span>self</span><span>):</span>
        <span>"""</span><span> Test Account update using known data </span><span>"""</span>
        <span>account</span> <span>=</span> <span>AccountFactory</span><span>()</span>
        <span>account</span><span>.</span><span>create</span><span>()</span>
        <span>self</span><span>.</span><span>assertIsNotNone</span><span>(</span><span>account</span><span>.</span><span>id</span><span>)</span>
        <span>account</span><span>.</span><span>name</span> <span>=</span> <span>"</span><span>Rumpelstiltskin</span><span>"</span>
        <span>account</span><span>.</span><span>update</span><span>()</span>
        <span>found</span> <span>=</span> <span>Account</span><span>.</span><span>find</span><span>(</span><span>account</span><span>.</span><span>id</span><span>)</span>
        <span>self</span><span>.</span><span>assertEqual</span><span>(</span><span>found</span><span>.</span><span>name</span><span>,</span> <span>account</span><span>.</span><span>name</span><span>)</span>
        <span>self</span><span>.</span><span>assertIsNotNone</span><span>(</span><span>account</span><span>.</span><span>id</span><span>)</span>
        <span>account</span><span>.</span><span>name</span> <span>=</span> <span>"</span><span>Rumpelstiltskin</span><span>"</span>
        <span>account</span><span>.</span><span>update</span><span>()</span>
        <span>found</span> <span>=</span> <span>Account</span><span>.</span><span>find</span><span>(</span><span>account</span><span>.</span><span>id</span><span>)</span>
        <span>self</span><span>.</span><span>assertEqual</span><span>(</span><span>found</span><span>.</span><span>name</span><span>,</span> <span>account</span><span>.</span><span>name</span><span>)</span>
    <span>def</span> <span>test_invalid_id_on_update</span><span>(</span><span>self</span><span>):</span>
        <span>"""</span><span> Test invalid ID update </span><span>"""</span>
        <span>account</span> <span>=</span> <span>AccountFactory</span><span>()</span>
        <span>account</span><span>.</span><span>id</span> <span>=</span> <span>None</span>
        <span>self</span><span>.</span><span>assertRaises</span><span>(</span><span>DataValidationError</span><span>,</span> <span>account</span><span>.</span><span>update</span><span>)</span>
    <span>def</span> <span>test_delete_an_account</span><span>(</span><span>self</span><span>):</span>
        <span>"""</span><span> Test Account update using known data </span><span>"""</span>
        <span>account</span> <span>=</span> <span>AccountFactory</span><span>()</span>
        <span>account</span><span>.</span><span>create</span><span>()</span>
        <span>self</span><span>.</span><span>assertEqual</span><span>(</span><span>len</span><span>(</span><span>Account</span><span>.</span><span>all</span><span>()),</span> <span>1</span><span>)</span>
        <span>account</span><span>.</span><span>delete</span><span>()</span>
        <span>self</span><span>.</span><span>assertEqual</span><span>(</span><span>len</span><span>(</span><span>Account</span><span>.</span><span>all</span><span>()),</span> <span>0</span><span>)</span>
<span>"""</span><span> Test Cases TestAccountModel </span><span>"""</span>

<span>from</span> <span>random</span> <span>import</span> <span>randrange</span>
<span>from</span> <span>unittest</span> <span>import</span> <span>TestCase</span>
<span>from</span> <span>models</span> <span>import</span> <span>db</span>
<span>from</span> <span>models.account</span> <span>import</span> <span>Account</span><span>,</span> <span>DataValidationError</span>
<span>from</span> <span>factories</span> <span>import</span> <span>AccountFactory</span>


<span>class</span> <span>TestAccountModel</span><span>(</span><span>TestCase</span><span>):</span>
    <span>"""</span><span>Test Account Model</span><span>"""</span>

    <span>@classmethod</span>
    <span>def</span> <span>setUpClass</span><span>(</span><span>cls</span><span>):</span> <span>#Runs before running any unit test </span>        <span>"""</span><span> Create table </span><span>"""</span>
        <span>db</span><span>.</span><span>create_all</span><span>()</span>  <span># make our sqlalchemy tables </span>
    <span>@classmethod</span>
    <span>def</span> <span>tearDownClass</span><span>(</span><span>cls</span><span>):</span> <span>#Runs after running all the tests </span>        <span>"""</span><span>Delete test data and Disconnext from database</span><span>"""</span>
        <span>db</span><span>.</span><span>session</span><span>.</span><span>query</span><span>(</span><span>Account</span><span>).</span><span>delete</span><span>()</span>
        <span>db</span><span>.</span><span>session</span><span>.</span><span>close</span><span>()</span>

    <span>def</span> <span>setUp</span><span>(</span><span>self</span><span>):</span> <span>#Runs before running every individual test </span>        <span>"""</span><span>Drop the table</span><span>"""</span>
        <span>db</span><span>.</span><span>session</span><span>.</span><span>query</span><span>(</span><span>Account</span><span>).</span><span>delete</span><span>()</span>
        <span>db</span><span>.</span><span>session</span><span>.</span><span>commit</span><span>()</span>

    <span>def</span> <span>tearDown</span><span>(</span><span>self</span><span>):</span> <span>#Runs after ruunning every individual test </span>        <span>"""</span><span>Remove the session</span><span>"""</span>
        <span>db</span><span>.</span><span>session</span><span>.</span><span>remove</span><span>()</span>

    <span>###################################################################### </span>    <span># T E S T C A S E S </span>    <span>###################################################################### </span>
    <span>def</span> <span>test_create_all_accounts</span><span>(</span><span>self</span><span>):</span>
        <span>"""</span><span> Test creating multiple Accounts </span><span>"""</span>
        <span>for</span> <span>_</span> <span>in</span> <span>range</span><span>(</span><span>10</span><span>):</span>
            <span>account</span> <span>=</span> <span>AccountFactory</span><span>()</span>
            <span>account</span><span>.</span><span>create</span><span>()</span>
        <span>self</span><span>.</span><span>assertEqual</span><span>(</span><span>len</span><span>(</span><span>Account</span><span>.</span><span>all</span><span>()),</span> <span>10</span><span>)</span>

    <span>def</span> <span>test_create_an_account</span><span>(</span><span>self</span><span>):</span>
        <span>"""</span><span> Test Account creation using known data </span><span>"""</span>
        <span>account</span> <span>=</span> <span>AccountFactory</span><span>()</span>
        <span>account</span><span>.</span><span>create</span><span>()</span>
        <span>self</span><span>.</span><span>assertEqual</span><span>(</span><span>len</span><span>(</span><span>Account</span><span>.</span><span>all</span><span>()),</span> <span>1</span><span>)</span>

    <span>def</span> <span>test_repr</span><span>(</span><span>self</span><span>):</span>
        <span>"""</span><span>Test the representation of an account</span><span>"""</span>
        <span>account</span> <span>=</span> <span>Account</span><span>()</span>
        <span>account</span><span>.</span><span>name</span> <span>=</span> <span>"</span><span>Foo</span><span>"</span>
        <span>self</span><span>.</span><span>assertEqual</span><span>(</span><span>str</span><span>(</span><span>account</span><span>),</span> <span>"</span><span><Account </span><span>'</span><span>Foo</span><span>'</span><span>></span><span>"</span><span>)</span>

    <span>def</span> <span>test_to_dict</span><span>(</span><span>self</span><span>):</span>
        <span>"""</span><span> Test account to dict </span><span>"""</span>
        <span>account</span> <span>=</span> <span>AccountFactory</span><span>()</span>
        <span>result</span> <span>=</span> <span>account</span><span>.</span><span>to_dict</span><span>()</span>
        <span>self</span><span>.</span><span>assertEqual</span><span>(</span><span>account</span><span>.</span><span>name</span><span>,</span> <span>result</span><span>[</span><span>"</span><span>name</span><span>"</span><span>])</span>
        <span>self</span><span>.</span><span>assertEqual</span><span>(</span><span>account</span><span>.</span><span>email</span><span>,</span> <span>result</span><span>[</span><span>"</span><span>email</span><span>"</span><span>])</span>
        <span>self</span><span>.</span><span>assertEqual</span><span>(</span><span>account</span><span>.</span><span>phone_number</span><span>,</span> <span>result</span><span>[</span><span>"</span><span>phone_number</span><span>"</span><span>])</span>
        <span>self</span><span>.</span><span>assertEqual</span><span>(</span><span>account</span><span>.</span><span>disabled</span><span>,</span> <span>result</span><span>[</span><span>"</span><span>disabled</span><span>"</span><span>])</span>
        <span>self</span><span>.</span><span>assertEqual</span><span>(</span><span>account</span><span>.</span><span>date_joined</span><span>,</span> <span>result</span><span>[</span><span>"</span><span>date_joined</span><span>"</span><span>])</span>

    <span>def</span> <span>test_from_dict</span><span>(</span><span>self</span><span>):</span>
        <span>"""</span><span> Test account from dict </span><span>"""</span>
        <span>data</span> <span>=</span> <span>AccountFactory</span><span>().</span><span>to_dict</span><span>()</span>
        <span>account</span> <span>=</span> <span>Account</span><span>()</span>
        <span>account</span><span>.</span><span>from_dict</span><span>(</span><span>data</span><span>)</span>
        <span>self</span><span>.</span><span>assertEqual</span><span>(</span><span>account</span><span>.</span><span>name</span><span>,</span> <span>data</span><span>[</span><span>"</span><span>name</span><span>"</span><span>])</span>
        <span>self</span><span>.</span><span>assertEqual</span><span>(</span><span>account</span><span>.</span><span>email</span><span>,</span> <span>data</span><span>[</span><span>"</span><span>email</span><span>"</span><span>])</span>
        <span>self</span><span>.</span><span>assertEqual</span><span>(</span><span>account</span><span>.</span><span>phone_number</span><span>,</span> <span>data</span><span>[</span><span>"</span><span>phone_number</span><span>"</span><span>])</span>
        <span>self</span><span>.</span><span>assertEqual</span><span>(</span><span>account</span><span>.</span><span>disabled</span><span>,</span> <span>data</span><span>[</span><span>"</span><span>disabled</span><span>"</span><span>])</span>

    <span>def</span> <span>test_update_an_account</span><span>(</span><span>self</span><span>):</span>
        <span>"""</span><span> Test Account update using known data </span><span>"""</span>
        <span>account</span> <span>=</span> <span>AccountFactory</span><span>()</span>
        <span>account</span><span>.</span><span>create</span><span>()</span>
        <span>self</span><span>.</span><span>assertIsNotNone</span><span>(</span><span>account</span><span>.</span><span>id</span><span>)</span>
        <span>account</span><span>.</span><span>name</span> <span>=</span> <span>"</span><span>Rumpelstiltskin</span><span>"</span>
        <span>account</span><span>.</span><span>update</span><span>()</span>
        <span>found</span> <span>=</span> <span>Account</span><span>.</span><span>find</span><span>(</span><span>account</span><span>.</span><span>id</span><span>)</span>
        <span>self</span><span>.</span><span>assertEqual</span><span>(</span><span>found</span><span>.</span><span>name</span><span>,</span> <span>account</span><span>.</span><span>name</span><span>)</span>
        <span>self</span><span>.</span><span>assertIsNotNone</span><span>(</span><span>account</span><span>.</span><span>id</span><span>)</span>
        <span>account</span><span>.</span><span>name</span> <span>=</span> <span>"</span><span>Rumpelstiltskin</span><span>"</span>
        <span>account</span><span>.</span><span>update</span><span>()</span>
        <span>found</span> <span>=</span> <span>Account</span><span>.</span><span>find</span><span>(</span><span>account</span><span>.</span><span>id</span><span>)</span>
        <span>self</span><span>.</span><span>assertEqual</span><span>(</span><span>found</span><span>.</span><span>name</span><span>,</span> <span>account</span><span>.</span><span>name</span><span>)</span>

    <span>def</span> <span>test_invalid_id_on_update</span><span>(</span><span>self</span><span>):</span>
        <span>"""</span><span> Test invalid ID update </span><span>"""</span>
        <span>account</span> <span>=</span> <span>AccountFactory</span><span>()</span>
        <span>account</span><span>.</span><span>id</span> <span>=</span> <span>None</span>
        <span>self</span><span>.</span><span>assertRaises</span><span>(</span><span>DataValidationError</span><span>,</span> <span>account</span><span>.</span><span>update</span><span>)</span>

    <span>def</span> <span>test_delete_an_account</span><span>(</span><span>self</span><span>):</span>
        <span>"""</span><span> Test Account update using known data </span><span>"""</span>
        <span>account</span> <span>=</span> <span>AccountFactory</span><span>()</span>
        <span>account</span><span>.</span><span>create</span><span>()</span>
        <span>self</span><span>.</span><span>assertEqual</span><span>(</span><span>len</span><span>(</span><span>Account</span><span>.</span><span>all</span><span>()),</span> <span>1</span><span>)</span>
        <span>account</span><span>.</span><span>delete</span><span>()</span>
        <span>self</span><span>.</span><span>assertEqual</span><span>(</span><span>len</span><span>(</span><span>Account</span><span>.</span><span>all</span><span>()),</span> <span>0</span><span>)</span>
""" Test Cases TestAccountModel """

from random import randrange
from unittest import TestCase
from models import db
from models.account import Account, DataValidationError
from factories import AccountFactory


class TestAccountModel(TestCase):
    """Test Account Model"""

    @classmethod
    def setUpClass(cls): #Runs before running any unit test         """ Create table """
        db.create_all()  # make our sqlalchemy tables 
    @classmethod
    def tearDownClass(cls): #Runs after running all the tests         """Delete test data and Disconnext from database"""
        db.session.query(Account).delete()
        db.session.close()

    def setUp(self): #Runs before running every individual test         """Drop the table"""
        db.session.query(Account).delete()
        db.session.commit()

    def tearDown(self): #Runs after ruunning every individual test         """Remove the session"""
        db.session.remove()

    ######################################################################     # T E S T C A S E S     ###################################################################### 
    def test_create_all_accounts(self):
        """ Test creating multiple Accounts """
        for _ in range(10):
            account = AccountFactory()
            account.create()
        self.assertEqual(len(Account.all()), 10)

    def test_create_an_account(self):
        """ Test Account creation using known data """
        account = AccountFactory()
        account.create()
        self.assertEqual(len(Account.all()), 1)

    def test_repr(self):
        """Test the representation of an account"""
        account = Account()
        account.name = "Foo"
        self.assertEqual(str(account), "<Account 'Foo'>")

    def test_to_dict(self):
        """ Test account to dict """
        account = AccountFactory()
        result = account.to_dict()
        self.assertEqual(account.name, result["name"])
        self.assertEqual(account.email, result["email"])
        self.assertEqual(account.phone_number, result["phone_number"])
        self.assertEqual(account.disabled, result["disabled"])
        self.assertEqual(account.date_joined, result["date_joined"])

    def test_from_dict(self):
        """ Test account from dict """
        data = AccountFactory().to_dict()
        account = Account()
        account.from_dict(data)
        self.assertEqual(account.name, data["name"])
        self.assertEqual(account.email, data["email"])
        self.assertEqual(account.phone_number, data["phone_number"])
        self.assertEqual(account.disabled, data["disabled"])

    def test_update_an_account(self):
        """ Test Account update using known data """
        account = AccountFactory()
        account.create()
        self.assertIsNotNone(account.id)
        account.name = "Rumpelstiltskin"
        account.update()
        found = Account.find(account.id)
        self.assertEqual(found.name, account.name)
        self.assertIsNotNone(account.id)
        account.name = "Rumpelstiltskin"
        account.update()
        found = Account.find(account.id)
        self.assertEqual(found.name, account.name)

    def test_invalid_id_on_update(self):
        """ Test invalid ID update """
        account = AccountFactory()
        account.id = None
        self.assertRaises(DataValidationError, account.update)

    def test_delete_an_account(self):
        """ Test Account update using known data """
        account = AccountFactory()
        account.create()
        self.assertEqual(len(Account.all()), 1)
        account.delete()
        self.assertEqual(len(Account.all()), 0)

Enter fullscreen mode Exit fullscreen mode

Read the comments to understand more about the test cases. Now let’s run nosetests

Congratulations! All the test cases have been passed and hence we can conclude that our AccountFactory works exactly like Account class and have tested the application using fake data using Factory-Boy!

原文链接：Generating Fake bulk data using Factory-Boy in Python

展开阅读全文
© 版权声明
文章版权声明 1、本网站名称：拾光赋
2、本站永久网址：https://www.blogs.ink
3、本网站的文章部分内容可能来源于网络，仅供大家学习与参考，如有侵权，请联系站长QQ：805375623进行删除处理。
4、本站一切资源不代表本站立场，并不代表本站赞同其观点和对其真实性负责。
5、本站一律禁止以任何方式发布或转载任何违法的相关信息，访客发现请向站长举报
6、本站资源大多存储在云盘，如发现链接失效，请联系我们我们会第一时间更新。

THE END
Python（EN）
# python# programming# testing
喜欢就支持一下吧
点赞8 分享
The sacrifices you make today will pay dividends in the future.
今天的牺牲和努力未来都会有回报
评论 抢沙发

请登录后发表评论

    暂无评论内容

kity的头像-拾光赋
今日剩余 2.6%
本周剩余 43.2%
本月剩余 43.4%
本年剩余 70.7%
最近评论
杀人蜂的头像-拾光赋

杀人蜂4天前0

我很好奇这个网站能提供什么
Vito的头像-拾光赋

Vito6个月前2

你就是我心中的那首忐忑，总是让我惊心动魄
Jason.Meng的头像-拾光赋钻石会员

Jason.Meng徽章-人气大使-拾光赋6个月前2

总是会在人生的不同阶段反复爱上大佬的文章~
每日一言
To the path of timber, iron and steel will never regret bright spray of molten steel was abandoned.
为了走上成材的道路，钢铁决不惋惜璀璨的钢花被遗弃