{"id":11448,"date":"2020-02-06T07:19:55","date_gmt":"2020-02-06T12:19:55","guid":{"rendered":"https:\/\/qxf2.com\/blog\/?p=11448"},"modified":"2021-04-21T08:55:39","modified_gmt":"2021-04-21T12:55:39","slug":"unit-testing-using-mock-python","status":"publish","type":"post","link":"https:\/\/qxf2.com\/blog\/unit-testing-using-mock-python\/","title":{"rendered":"Getting started with Unit Testing using mock in Python"},"content":{"rendered":"

Unit testing is considered as a vital phase in software testing. Anyone who has been involved in the software development life cycle will have encountered some form of testing. Although the aim of testing is to find bugs, it cannot guarantee the absence of other faults, no matter how creative the test cases are designed. Unit testing enables a more thorough level of acceptance mechanism.<\/p>\n

This post will give you a brief introduction on how to start with unit testing using the mock module in python.<\/p>\n

What is Unit testing and why do we need it?<\/h3>\n

Unit testing\u00a0is a type of software testing where individual units or components of a software are tested. The purpose is to validate whether each unit of the software code performs as expected.\u00a0 Unit tests isolate a section of code and verify its correctness.
\nMock is a library for testing in Python. It helps you to replace real objects in your code with mock instances and make assertions about how they have been used.<\/span><\/p>\n

Getting started:<\/h3>\n

Step 1. Install mock<\/strong>
\nGet started by installing the mock module. To do this simply open command prompt and type:<\/p>\n

pip install -U mock<\/pre>\n
Step 2. Select the application you want to test.<\/strong><\/p>\n
Pick the application that you would like to test. In my case, I will be using Qxf2’s interview scheduler application. You can find it here:\u00a0Interview Scheduler<\/a><\/p>\n
Step 3. Choose a method which you want to write the unit test for:<\/strong><\/p>\n
Now, decide on the method for which you want to write the unit test. Go through the method and find out what it does.
\nThen choose a method call that you want to mock.
\nIn my case, I’m choosing the is_past_date()<\/code> method from the qxf2_scheduler.py<\/code> file. It’s a simple method that tells us if the selected date is a past date or not.<\/p>\n
\r\ndef is_past_date(date):\r\n    \"Is this date in the past?\"\r\n\r\n    result_flag = True\r\n    date = gcal.process_date_string(date)\r\n    today = gcal.get_today()\r\n    \r\n    if date > = today:\r\n        result_flag = False\r\n    \r\n    return result_flag\r\n<\/pre>\n
Writing the Unit test<\/h3>\n
Step 1. Create a new python file to write the unit test<\/strong><\/p>\n
Ideally, you name your unit test as ‘test_<\/em><\/strong>‘\u00a0 followed by whatever name you want. I am going to name it “test_check_past_date”<\/strong><\/em><\/p>\n
Step 2. Import the required modules<\/strong><\/p>\n
The first step in writing our unit test is to import the unit test and mock modules.<\/p>\n
import unittest, mock<\/code><\/p>\n
Then import the function that you would like to test. In my case, it is –<\/p>\n
from qxf2_scheduler.qxf2_scheduler import is_past_date<\/code><\/p>\n
I will also be importing the date parser for converting the date from string format to DateTime format before passing it to the method.<\/p>\n
Step 3. Create a Class to hold the various unit test methods<\/strong><\/p>\n
Once you have imported the required modules, go ahead and create a class to hold the various unit test methods. Make sure to include the subclass “unittest.TestCase” while creating the test case. Your class declaration should look similar as below:<\/p>\n
class Check_is_past_date(unittest.TestCase):<\/code><\/p>\n
Step 4. Patch the\u00a0function that you want to mock using ‘mock.patch() decorator’<\/strong><\/p>\n
The mock.patch()<\/em> decorator helps us mock any function we need. In other sense, we can replicate the action performed by that function and have the function return any value of our choice. In this case, I am going to mock gcal.get_today() method and make it return a value of my choice.<\/p>\n
I will be using the following command to mock the method:<\/p>\n
@mock.patch('qxf2_scheduler.qxf2_scheduler.gcal.get_today',return_value=parse(\"2020-01-22\"))<\/code><\/p>\n
As you can see above, I have passed the path of the function to be mocked as the first argument and the return value I want as the second argument.<\/p>\n
Step 5. Define a method for writing the test<\/strong><\/p>\n
The next step is creating a method where you’ll be writing your test conditions. The method name must start with “test_<\/strong><\/em>” followed by any name you want. I will name my method “test_check_if_past_date<\/strong><\/em>“. Pass the mock variable as an argument to the method.<\/p>\n
Your method definition should look similar as below:<\/p>\n
def test_check_if_past_date(self, mock_today):<\/code><\/p>\n
Step 6. Add your required test conditions inside the method:<\/strong><\/p>\n
Add your required test scenarios inside the method. You can refer to this<\/em><\/strong><\/a> documentation to know more about the unit test commands.
\nHere, I will use the mock function to return a past date and verify if the method returns a false value.<\/span><\/p>\n
assert is_past_date(self.date)==False<\/code><\/p>\n
Step 7. Call the unittest in the main method<\/strong><\/p>\n
The final step is to add the main function and call the unittest from it.
\n
\nif __name__==\"__main__\":
\nunittest.main()
\n<\/code><\/p>\n
Here is the final code:<\/p>\n
import unittest, mock\r\nimport os,sys\r\nsys.path.append(os.path.dirname(os.path.dirname(os.path.abspath(__file__))))\r\nfrom qxf2_scheduler.qxf2_scheduler import is_past_date\r\nfrom dateutil.parser import parse\r\n\r\nclass Check_is_past_date(unittest.TestCase):\r\n\"\"\"\r\nThis class contains unit test for is_past_date method in qxf2_scheduler module\r\n\"\"\"\r\n    #hardcoding the date\r\n    date='03\/04\/2020'\r\n\r\n    #mocking gcal.get_today() method\r\n    @mock.patch('qxf2_scheduler.qxf2_scheduler.gcal.get_today',return_value=parse(\"2020-01-22\"))\r\n    def test_check_if_past_date(self, mock_today):\r\n    \"\"\"\r\n    This method tests whether the function returns false if the given date is not a past date\r\n    \"\"\"\r\n        assert is_past_date(self.date)==False\r\n\r\nif __name__==\"__main__\":\r\n    unittest.main()\r\n<\/pre>\n
\"\"<\/a>
Result of the unit test<\/figcaption><\/figure>\n
And voila! You just ran a unit check on your application!!<\/p>\n
I hope you found this blog helpful. Here are some other posts which I found helpful in making of this blog,
\nGuide to unit testing<\/a>
\nPython unit tests using mock<\/a><\/p>\n","protected":false},"excerpt":{"rendered":"
Unit testing is considered as a vital phase in software testing. Anyone who has been involved in the software development life cycle will have encountered some form of testing. Although the aim of testing is to find bugs, it cannot guarantee the absence of other faults, no matter how creative the test cases are designed. Unit testing enables a more […]<\/p>\n","protected":false},"author":29,"featured_media":0,"comment_status":"open","ping_status":"open","sticky":false,"template":"","format":"standard","meta":{"footnotes":""},"categories":[38,64,18,61,66],"tags":[],"class_list":["post-11448","post","type-post","status-publish","format-standard","hentry","category-automation","category-mock","category-python","category-testing","category-unit-testing"],"_links":{"self":[{"href":"https:\/\/qxf2.com\/blog\/wp-json\/wp\/v2\/posts\/11448","targetHints":{"allow":["GET"]}}],"collection":[{"href":"https:\/\/qxf2.com\/blog\/wp-json\/wp\/v2\/posts"}],"about":[{"href":"https:\/\/qxf2.com\/blog\/wp-json\/wp\/v2\/types\/post"}],"author":[{"embeddable":true,"href":"https:\/\/qxf2.com\/blog\/wp-json\/wp\/v2\/users\/29"}],"replies":[{"embeddable":true,"href":"https:\/\/qxf2.com\/blog\/wp-json\/wp\/v2\/comments?post=11448"}],"version-history":[{"count":22,"href":"https:\/\/qxf2.com\/blog\/wp-json\/wp\/v2\/posts\/11448\/revisions"}],"predecessor-version":[{"id":15232,"href":"https:\/\/qxf2.com\/blog\/wp-json\/wp\/v2\/posts\/11448\/revisions\/15232"}],"wp:attachment":[{"href":"https:\/\/qxf2.com\/blog\/wp-json\/wp\/v2\/media?parent=11448"}],"wp:term":[{"taxonomy":"category","embeddable":true,"href":"https:\/\/qxf2.com\/blog\/wp-json\/wp\/v2\/categories?post=11448"},{"taxonomy":"post_tag","embeddable":true,"href":"https:\/\/qxf2.com\/blog\/wp-json\/wp\/v2\/tags?post=11448"}],"curies":[{"name":"wp","href":"https:\/\/api.w.org\/{rel}","templated":true}]}}