"""

Unit tests for vcs_ library.

In order to run tests we need to prepare our environment first. Tests would be

run for each engine listed at ``conf.SCM_TESTS`` - keys are aliases from

``vcs.backends.BACKENDS``.

For each SCM we run tests for, we need some repository. We would use

repositories location from system environment variables or test suite defaults

- see ``conf`` module for more detail. We simply try to check if repository at

certain location exists, if not we would try to fetch them. At ``test_vcs`` or

``test_common`` we run unit tests common for each repository type and for

example specific mercurial tests are located at ``test_hg`` module.

Oh, and tests are run with ``unittest.collector`` wrapped by ``collector``

function at ``tests/__init__.py``.

.. _vcs: http://bitbucket.org/marcinkuzminski/vcs

.. _unittest: http://pypi.python.org/pypi/unittest

"""

from kallithea.tests.base import TEST_HG_REPO, HG_REMOTE_REPO, TEST_GIT_REPO, GIT_REMOTE_REPO

from kallithea.tests.vcs.utils import SCMFetcher

from kallithea.tests.base import *

def setup_package():

    """

    Prepares whole package for tests which mainly means it would try to fetch

    test repositories or use already existing ones.

    """

    fetchers = {

        'hg': {

            'alias': 'hg',

            'test_repo_path': TEST_HG_REPO,

            'remote_repo': HG_REMOTE_REPO,

            'clone_cmd': 'hg clone --insecure',

        },

        'git': {

            'alias': 'git',

            'test_repo_path': TEST_GIT_REPO,

            'remote_repo': GIT_REMOTE_REPO,

            'clone_cmd': 'git clone --bare',

        },

    }

    for scm, fetcher_info in fetchers.items():

        fetcher = SCMFetcher(**fetcher_info)

        fetcher.setup()

"""

Unit tests configuration module for vcs.

"""

import os

import uuid

# Retrieve the necessary configuration options from the test base

# module. Some of these configuration options are subsequently

# consumed by the VCS test module.

from kallithea.tests.base import (

    TESTS_TMP_PATH, SCM_TESTS,

    TEST_HG_REPO, HG_REMOTE_REPO,

    TEST_GIT_REPO, GIT_REMOTE_REPO,

)

__all__ = (

    'TEST_HG_REPO', 'TEST_GIT_REPO', 'HG_REMOTE_REPO', 'GIT_REMOTE_REPO',

    'SCM_TESTS',

)

def get_new_dir(title=None):

    """

    Calculates a path for a new, non-existant, unique sub-directory in TESTS_TMP_PATH.

    Resulting directory name will have format:

    vcs-test-[title-]hexuuid

    The "hexuuid" is a hexadecimal value of a randomly generated

    UUID. Title will be added if specified.

    Args:

        title: Custom title to include as part of the resulting sub-directory

            name. Can be useful for debugging to identify destination. Defaults

            to None.

    Returns:

        Path to the new directory as a string.

    """

    test_repo_prefix = 'vcs-test'

    if title:

        name = "%s-%s" % (test_repo_prefix, title)

    else:

        name = test_repo_prefix

    path = os.path.join(TESTS_TMP_PATH, name)

    # Generate new hexes until we get a unique name (just in case).

    hex_uuid = uuid.uuid4().hex

    while os.path.exists("%s-%s" % (path, hex_uuid)):

        hex_uuid = uuid.uuid4().hex

    return "%s-%s" % (path, hex_uuid)

# overide default configurations with kallithea ones

from kallithea.tests.base import *

import datetime

from kallithea.tests.vcs.base import _BackendTestMixin

from kallithea.tests.vcs.conf import SCM_TESTS

from kallithea.lib.vcs.nodes import FileNode

from kallithea.lib.vcs.utils.compat import unittest

from kallithea.lib.vcs.exceptions import ChangesetDoesNotExistError

class RepositoryBaseTest(_BackendTestMixin):

    recreate_repo_per_test = False

    @classmethod

    def _get_commits(cls):

        return super(RepositoryBaseTest, cls)._get_commits()[:1]

    def test_get_config_value(self):

        self.assertEqual(self.repo.get_config_value('universal', 'foo',

            TEST_USER_CONFIG_FILE), 'bar')

    def test_get_config_value_defaults_to_None(self):

        self.assertEqual(self.repo.get_config_value('universal', 'nonexist',

            TEST_USER_CONFIG_FILE), None)

    def test_get_user_name(self):

        self.assertEqual(self.repo.get_user_name(TEST_USER_CONFIG_FILE),

            'Foo Bar')