mockfs – A simple mock filesystem for unit tests¶

Example Unit Test¶

import os
import unittest

import mockfs

class ExampleTestCase(unittest.TestCase):
    def setUp(self):
        self.mfs = mockfs.install()

    def tearDown(self):
        mockfs.uninstall()

    def test_using_os_path(self):
        self.mfs.add_entries({'/usr/bin/mockfs-magic': ''})
        self.assertEqual(os.listdir('/usr/bin'), ['mockfs-magic'])

Current supported functions:

• os.path.exists()
• os.path.isdir()
• os.path.isfile()
• os.path.islink()
• os.listdir()
• os.walk()

mockfs.install(entries=None, pathmap=None)¶

Replace builtin modules with mockfs equivalents.

Parameter:	entries – Dictionary mapping paths to content
Rtype mockfs:	Newly installed mockfs.mfs.MockFS handler

Example:

import mockfs

mfs = mockfs.install(entries={'/bin/ls': 'content'})

mockfs.uninstall()¶

Restore the original builtin functions.

Developer Documentation¶

• os.path and glob Implementations
• Utility Functions
• File Storage and IO

Indices and tables¶

• Index
• Module Index
• Search Page