test_installation.py

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

import ast
import os
import subprocess
import sys

import pytest

from test.lib import TestBase, VirtualEnvironment, with_rw_directory


class TestInstallation(TestBase):
    @pytest.mark.xfail(
        sys.platform == "cygwin" and "CI" in os.environ,
        reason="Trouble with pip on Cygwin CI, see issue #2004",
        raises=subprocess.CalledProcessError,
    )
    @with_rw_directory
    def test_installation(self, rw_dir):
        venv = self._set_up_venv(rw_dir)

        result = subprocess.run(
            [venv.pip, "install", "."],
            stdout=subprocess.PIPE,
            cwd=venv.sources,
        )
        self.assertEqual(
            0,
            result.returncode,
            msg=result.stderr or result.stdout or "Can't install project",
        )

        result = subprocess.run(
            [venv.python, "-c", "import git"],
            stdout=subprocess.PIPE,
            cwd=venv.sources,
        )
        self.assertEqual(
            0,
            result.returncode,
            msg=result.stderr or result.stdout or "Self-test failed",
        )

        result = subprocess.run(
            [venv.python, "-c", "import gitdb; import smmap"],
            stdout=subprocess.PIPE,
            cwd=venv.sources,
        )
        self.assertEqual(
            0,
            result.returncode,
            msg=result.stderr or result.stdout or "Dependencies not installed",
        )

        # Even IF gitdb or any other dependency is supplied during development by
        # inserting its location into PYTHONPATH or otherwise patched into sys.path,
        # make sure it is not wrongly inserted as the *first* entry.
        result = subprocess.run(
            [venv.python, "-c", "import sys; import git; print(sys.path)"],
            stdout=subprocess.PIPE,
            cwd=venv.sources,
        )
        syspath = result.stdout.decode("utf-8").splitlines()[0]
        syspath = ast.literal_eval(syspath)
        self.assertEqual(
            "",
            syspath[0],
            msg="Failed to follow the conventions for https://docs.python.org/3/library/sys.html#sys.path",
        )

    @staticmethod
    def _set_up_venv(rw_dir):
        venv = VirtualEnvironment(rw_dir, with_pip=True)
        os.symlink(
            os.path.dirname(os.path.dirname(__file__)),
            venv.sources,
            target_is_directory=True,
        )
        return venv