Skip to main content

Mocks that whitelist its interface

Project description

Build Status # Sealed Mock Whitelist the attributes/methods of your mocks instead of just letting it create new mock objects.

SealedMock allows specify when you are done defining the mock, ensuring that any unexpected call to the mock is cached.

Sample:

import sealedmock
m = sealedmock.SealedMock()
m.method1.return_value.attr1.method2.return_value = 1
m.sealed = True
m.method1().attr1.method2()
# 1
m.method1().attr2
# Exception: SealedMockAttributeAccess: mock.method1().attr2

Install

pip install sealedmock

Usage

Given you have a file like:

import urllib2

class SampleCodeClass(object):
    """This is sample code"""
    def calling_urlopen(self):
        return urllib2.urlopen("http://chooserandom.com")

    def calling_splithost(self):
        return urllib2.splithost("//host:port/path")

You can write a test like:

from sealedmock import patch
@patch("tests.sample_code.urllib2")
def test_using_decorator(mock):
        sample = sample_code.SampleCodeClass()
        mock.urlopen.return_value = 2

        mock.sealed = True  # No new attributes can be declared

        # calling urlopen succeeds as mock.urlopen has been defined
        assert sample.calling_urlopen()

        # This will fail as mock.splithost has not been defined
        sample.calling_splithost()

If you use an common Mock the second part will pass as it will create a mock for you and return it. With SealedMock you can choose when to stop that behaviour.

This is recursive so you can write:

@patch("sample_code.secret")
def test_recursive(mock):
        sample = sample_code.SampleCodeClass()
        mock.secret.call1.call2.call3.return_value = 1
        mock.sealed = True  # No new attributes can be declared

        # If secret is not used as specified above it will fail
        # ex: if do_stuff also calls secret.call1.call9
        sample.do_stuff()

It also prevents typos on tests if used like this:

@patch("sample_code.secret")
def test_recursive(mock):
        sample = sample_code.SampleCodeClass()

        sample.do_stuff()

        mock.sealed = True
        mock.asert_called_with(1)
        # Note the typo in asert (should be assert)
        # Sealed mock will rise, normal mock won't

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

sealedmock-0.3.0.tar.gz (3.4 kB view details)

Uploaded Source

File details

Details for the file sealedmock-0.3.0.tar.gz.

File metadata

  • Download URL: sealedmock-0.3.0.tar.gz
  • Upload date:
  • Size: 3.4 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No

File hashes

Hashes for sealedmock-0.3.0.tar.gz
Algorithm Hash digest
SHA256 417376b5d1b2a6594fce8da6d258df4ef1ae6e37f62fab37de0f6bcd8e7a4768
MD5 ef54215d03e4d02b74950fc835880ccb
BLAKE2b-256 de9e4a5f109d00852983d8a0d29f662863446d2cd81d036828a649d7aa8daae7

See more details on using hashes here.

Supported by

AWS AWS Cloud computing and Security Sponsor Datadog Datadog Monitoring Fastly Fastly CDN Google Google Download Analytics Microsoft Microsoft PSF Sponsor Pingdom Pingdom Monitoring Sentry Sentry Error logging StatusPage StatusPage Status page