Load a json for current tests module in tests/fixtures directory.

utils.py

# -*- coding: UTF-8 -*-

from __future__ import (
    absolute_import, division, print_function, unicode_literals
)

import json
import inspect
from os.path import abspath, dirname, join, isdir, isfile, sep


def load_json(path):
    """
    Load a json for current tests module in tests/fixtures directory.
    For instance, consider the fixture:

    foobar/tests/fixtures/some/dir/with/a/deep/tree/fixtures.json

    The test file: foobar/tests/foobar/test_foobar.py

    In foobar.py you load the fixtures.json calling like:

    load_json("some/dir/with/a/deep/tree/fixtures.json")
    """
    # get the filename where load_json was called
    filename = inspect.currentframe().f_back.f_code.co_filename
    directory = dirname(abspath(filename))
    parts = directory.split(sep)

    # assert that there is a tests folder in path
    try:
        test_index = parts.index("tests")
        tests_path = \
            abspath(join(directory, *[".."] * len(parts[test_index:-1])))
        assert isdir(tests_path)
    except (AssertionError, ValueError):
        raise ValueError("Base \"tests\" folder can not be found.")

    # load the fixture
    fixtures_path = abspath(join(tests_path, 'fixtures', path))
    if isfile(fixtures_path):
        with open(fixtures_path, 'r') as f:
            return json.loads(f.read())

    raise IOError("File \"{}\" can't be found.".format(fixtures_path))