repos/gitpython-developers-GitPython-0a5250e/test/performance/lib.py

# This module is part of GitPython and is released under the
# 3-Clause BSD License: https://opensource.org/license/bsd-3-clause/

"""Support library for performance tests."""

import logging
import os
import os.path as osp
import tempfile

from git import Repo
from git.db import GitCmdObjectDB, GitDB
from git.util import rmtree

from test.lib import TestBase

# { Invariants

k_env_git_repo = "GIT_PYTHON_TEST_GIT_REPO_BASE"

# } END invariants


# { Base Classes


class TestBigRepoR(TestBase):
    """TestCase providing access to readonly 'big' repositories using the following
    member variables:

    * gitrorepo:
      Read-Only git repository - actually (by default) the repo of GitPython itself.

    * puregitrorepo:
      Like gitrorepo, but uses a pure Python implementation for its object database.
    """

    def setUp(self):
        super().setUp()

        repo_path = os.environ.get(k_env_git_repo)
        if repo_path is None:
            logging.info(
                "You can set the %s environment variable to a .git repository of your"
                " choice - defaulting to the GitPython repository",
                k_env_git_repo,
            )
            repo_path = osp.dirname(__file__)
        # END set some repo path
        self.gitrorepo = Repo(repo_path, odbt=GitCmdObjectDB, search_parent_directories=True)
        self.puregitrorepo = Repo(repo_path, odbt=GitDB, search_parent_directories=True)

    def tearDown(self):
        self.gitrorepo.git.clear_cache()
        self.gitrorepo = None
        self.puregitrorepo.git.clear_cache()
        self.puregitrorepo = None


class TestBigRepoRW(TestBigRepoR):
    """Like :class:`TestBigRepoR`, but provides a big repository that we can write to.

    Provides ``self.gitrwrepo`` and ``self.puregitrwrepo``.
    """

    def setUp(self):
        self.gitrwrepo = None
        super().setUp()
        dirname = tempfile.mkdtemp()
        self.gitrwrepo = self.gitrorepo.clone(dirname, shared=True, bare=True, odbt=GitCmdObjectDB)
        self.puregitrwrepo = Repo(dirname, odbt=GitDB)

    def tearDown(self):
        super().tearDown()
        if self.gitrwrepo is not None:
            rmtree(self.gitrwrepo.working_dir)
            self.gitrwrepo.git.clear_cache()
        self.gitrwrepo = None
        self.puregitrwrepo.git.clear_cache()
        self.puregitrwrepo = None


# } END base classes