Ginger
Ginger

Reputation: 8630

How to mock sqlite3.connect in Python

I am using Python 3.3, under the Anaconda environment.

I would like to mock sqlite3.connect. For example in MyTests (see below), I would like test_sqlite3_connect to return the string connection rather than an actual sqlite3.Connection object.

I have tried patching it, but that does not work.

from unittest.mock import patch
import unittest

import sqlite3

@patch('sqlite3.connect')
def sqlite3_connect(self,connection_string):
    print('connect with : {0}'.format(connection_string))
    return 'connection '

class MyTests(unittest.TestCase):

    def test_sqlite3_connect(self):

        print('testing connection')

        dbc = DataBaseClass()


class DataBaseClass():

    def __init__(self):
        print('initialising database class')
        self.connection = sqlite3.connect('test database')

Upvotes: 5

Views: 6638

Answers (1)

Ginger
Ginger

Reputation: 8630

I managed to solve the question using information from the Quick Guide section of

http://www.voidspace.org.uk/python/mock/

The following code shows two ways of mocking sqlite3.connect.

''' An example of how to mock the sqlite3.connection method '''

from unittest.mock import MagicMock,Mock
import unittest
import sqlite3

class MyTests(unittest.TestCase):

    def test_sqlite3_connect_success(self):

        sqlite3.connect = MagicMock(return_value='connection succeeded')

        dbc = DataBaseClass()
        sqlite3.connect.assert_called_with('test_database')
        self.assertEqual(dbc.connection,'connection succeeded')


    def test_sqlite3_connect_fail(self):

        sqlite3.connect = MagicMock(return_value='connection failed')

        dbc = DataBaseClass()
        sqlite3.connect.assert_called_with('test_database')
        self.assertEqual(dbc.connection, 'connection failed')

    def test_sqlite3_connect_with_sideaffect(self):

        self._setup_mock_sqlite3_connect()

        dbc = DataBaseClass('good_connection_string')
        self.assertTrue(dbc.connection)
        sqlite3.connect.assert_called_with('good_connection_string')

        dbc = DataBaseClass('bad_connection_string')
        self.assertFalse(dbc.connection)
        sqlite3.connect.assert_called_with('bad_connection_string')

    def _setup_mock_sqlite3_connect(self):

        values = {'good_connection_string':True,
                  'bad_connection_string':False}

        def side_effect(arg):
            return values[arg]

        sqlite3.connect = Mock(side_effect=side_effect)


class DataBaseClass():

    def __init__(self,connection_string='test_database'):        
        self.connection = sqlite3.connect(connection_string)

Upvotes: 5

Related Questions