Mocking Data

Because we want our tests to stand on their own, if they rely on data from an external source, we should mock the responses.

The unittest module provides a way to do this.

Overview

from tests.base_test import BaseTest
from unittest.mock import patch

from crc import app
from crc.services.protocol_builder import ProtocolBuilderService


class TestProtocolBuilder(BaseTest):
    test_uid = "dhf8r"
    test_study_id = 1

    @patch('crc.services.protocol_builder.requests.get')
    def test_get_studies(self, mock_get):
        app.config['PB_ENABLED'] = True
        mock_get.return_value.ok = True
        mock_get.return_value.text = self.protocol_builder_response('user_studies.json')
        response = ProtocolBuilderService.get_studies(self.test_uid)
        self.assertIsNotNone(response)

    @patch('crc.services.protocol_builder.requests.get')
    def test_get_investigators(self, mock_get):
        app.config['PB_ENABLED'] = True
        mock_get.return_value.ok = True
        mock_get.return_value.text = self.protocol_builder_response('investigators.json')
        response = ProtocolBuilderService.get_investigators(self.test_study_id)
        self.assertIsNotNone(response)
        self.assertEqual(5, len(response))
        self.assertEqual("DC", response[0]["INVESTIGATORTYPE"])
        self.assertEqual("Department Contact", response[0]["INVESTIGATORTYPEFULL"])
        self.assertEqual("asd3v", response[0]["NETBADGEID"])

    @patch('crc.services.protocol_builder.requests.get')
    def test_get_required_docs(self, mock_get):
        app.config['PB_ENABLED'] = True
        mock_get.return_value.ok = True
        mock_get.return_value.text = self.protocol_builder_response('required_docs.json')
        response = ProtocolBuilderService.get_required_docs(self.test_study_id)
        self.assertIsNotNone(response)
        self.assertEqual(5, len(response))
        self.assertEqual(6, response[0]['AUXDOCID'])

    @patch('crc.services.protocol_builder.requests.get')
    def test_get_details(self, mock_get):
        app.config['PB_ENABLED'] = True
        mock_get.return_value.ok = True
        mock_get.return_value.text = self.protocol_builder_response('study_details.json')
        response = ProtocolBuilderService.get_study_details(self.test_study_id)
        self.assertIsNotNone(response)
        self.assertEqual(64, len(response))
        self.assertEqual('1234', response['IND_1'])

    @patch('crc.services.protocol_builder.requests.get')
    def test_get_study_sponsors(self, mock_get):
        app.config['PB_ENABLED'] = True
        mock_get.return_value.ok = True
        mock_get.return_value.text = self.protocol_builder_response('sponsors.json')
        response = ProtocolBuilderService.get_sponsors(self.test_study_id)
        self.assertIsNotNone(response)
        self.assertEqual(3, len(response))
        self.assertEqual(2, response[0]["SS_STUDY"])
        self.assertEqual(2453, response[0]["SPONSOR_ID"])
        self.assertEqual("Abbott Ltd", response[0]["SP_NAME"])

    @patch('crc.services.protocol_builder.requests.get')
    def test_get_irb_info(self, mock_get):
        app.config['PB_ENABLED'] = True
        mock_get.return_value.ok = True
        mock_get.return_value.text = self.protocol_builder_response('irb_info.json')
        response = ProtocolBuilderService.get_irb_info(self.test_study_id)
        self.assertIsNotNone(response)
        self.assertEqual(3, len(response))
        self.assertEqual('IRB Event 1', response[0]["IRBEVENT"])
        self.assertEqual('IRB Event 2', response[1]["IRBEVENT"])
        self.assertEqual('IRB Event 3', response[2]["IRBEVENT"])

Detail

We import patch from unittest.mock, and tell each test that we want to mock a get request for the protocol_builder service.

@patch('crc.services.protocol_builder.requests.get')

Notice that our test receives a new argument mock_get.

def test_get_studies(self, mock_get):

We then tell mock_get where to get the mocked data.

mock_get.return_value.text = self.protocol_builder_response('user_studies.json')

or

mock_get.return_value.text = self.protocol_builder_response('investigators.json')

We then make whatever assertions we need.

Mocked Data

The mocked data is stored in the tests/data/pb_responses directory

$ ls tests/data/pb_responses/
investigators.json irb_info.json      required_docs.json sponsors.json      study_details.json user_studies.json

$ cat tests/data/pb_responses/investigators.json
[
  {
    "INVESTIGATORTYPE": "DC",
    "INVESTIGATORTYPEFULL": "Department Contact",
    "NETBADGEID": "asd3v"
  },
  {
    "INVESTIGATORTYPE": "IRBC",
    "INVESTIGATORTYPEFULL": "IRB Coordinator",
    "NETBADGEID": "asdf32"
  },
  {
    "INVESTIGATORTYPE": "PI",
    "INVESTIGATORTYPEFULL": "Primary Investigator",
    "NETBADGEID": "dhf8r"
  },
    {
    "INVESTIGATORTYPE": "SI",
    "INVESTIGATORTYPEFULL": "Sub Investigator",
    "NETBADGEID": "ajl2j"
  },
  {
    "INVESTIGATORTYPE": "SI",
    "INVESTIGATORTYPEFULL": "Sub Investigator",
    "NETBADGEID": "cah3us"
  }
]