Python mock Patch os.environ and return value

PythonUnit TestingPython 3.xDependency InjectionMocking

Python Problem Overview


Unit testing conn() using mock:

app.py

import mysql.connector
import os, urlparse


def conn():
    if "DATABASE_URL" in os.environ:
        url = urlparse(os.environ["DATABASE_URL"])
        g.db = mysql.connector.connect(
            user=url.username,
            password=url.password,
            host=url.hostname,
            database=url.path[1:],
        )
    else:
        return "Error"

test.py

def test_conn(self):
    with patch(app.mysql.connector) as mock_mysql:
        with patch(app.os.environ) as mock_environ:
            con()
            mock_mysql.connect.assert_callled_with("credentials")

Error: Assertion mock_mysql.connect.assert_called_with is not called.

which i believe it is because 'Database_url' is not in my patched os.environ and because of that test call is not made to mysql_mock.connect.

Questions:

1 what changes i need to make to make this test code work?

2.Do i also have to patch 'urlparse'?

Python Solutions


Solution 1 - Python

You can try unittest.mock.patch.dict solution. Just call conn with a dummy argument:

import mysql.connector
import os, urlparse


@mock.patch.dict(os.environ, {"DATABASE_URL": "mytemp"}, clear=True)  # why need clear=True explained here https://stackoverflow.com/a/67477901/248616
def conn(mock_A):
    print os.environ["mytemp"]
    if "DATABASE_URL" in os.environ:
        url = urlparse(os.environ["DATABASE_URL"])
        g.db = mysql.connector.connect(
            user=url.username,
            password=url.password,
            host=url.hostname,
            database=url.path[1:],
        )
    else:
        return "Error"

Or if you don't want to modify your original function try this solution:

def func():
    print os.environ["mytemp"]


def test_func():
    k = mock.patch.dict(os.environ, {"mytemp": "mytemp"})
    k.start()
    func()
    k.stop()


test_func()

Solution 2 - Python

For this, I find that pytest's monkeypatch fixture leads to better code when you need to set environment variables:

def test_conn(monkeypatch):
    monkeypatch.setenv('DATABASE_URL', '<URL WITH CREDENTIAL PARAMETERS>')
    with patch(app.mysql.connector) as mock_mysql:
        conn()
    mock_mysql.connect.assert_called_with(<CREDENTIAL PARAMETERS>)

Solution 3 - Python

In my use case, I was trying to mock having NO environmental variable set. To do that, make sure you add clear=True to your patch.

with patch.dict(os.environ, {}, clear=True):
    func()

Solution 4 - Python

The accepted answer is correct. Here's a decorator @mockenv to do the same.

def mockenv(**envvars):
    return mock.patch.dict(os.environ, envvars)


@mockenv(DATABASE_URL="foo", EMAIL="[email protected]")
def test_something():
    assert os.getenv("DATABASE_URL") == "foo"

Solution 5 - Python

At the head of your file mock environ before importing your module:

with patch.dict(os.environ, {'key': 'mock-value'}):
    import your.module

Solution 6 - Python

You can also use something like the modified_environ context manager describe in this question to set/restore the environment variables.

with modified_environ(DATABASE_URL='mytemp'):
    func()

Attributions

All content for this solution is sourced from the original question on Stackoverflow.

The content on this page is licensed under the Attribution-ShareAlike 4.0 International (CC BY-SA 4.0) license.

Content TypeOriginal AuthorOriginal Content on Stackoverflow
QuestionimmrsteelView Question on Stackoverflow
Solution 1 - PythonvksView Answer on Stackoverflow
Solution 2 - PythonTooteView Answer on Stackoverflow
Solution 3 - PythonCaleb RobinsonView Answer on Stackoverflow
Solution 4 - PythonAdam HughesView Answer on Stackoverflow
Solution 5 - Python0script0View Answer on Stackoverflow
Solution 6 - PythonLaurent LAPORTEView Answer on Stackoverflow