Merge pull request #10429 from jdufresne/pretend

Replace use of pretend library with unitest.mock in tests

Author: pradyunsg

docs/html/development/getting-started.rst

@@ -59,9 +59,9 @@ You can then invoke your local source tree pip normally.
 Running Tests
 =============
 
-pip's tests are written using the :pypi:`pytest` test framework, :pypi:`mock`
-and :pypi:`pretend`. :pypi:`tox` is used to automate the setup and execution of
-pip's tests.
+pip's tests are written using the :pypi:`pytest` test framework and
+:mod:`unittest.mock`. :pypi:`tox` is used to automate the setup and execution
+of pip's tests.
 
 It is preferable to run the tests in parallel for better experience during development,
 since the tests can take a long time to finish when run sequentially.

news/7ecf31fa-f1eb-4735-8c89-2a64f1bb2741.trivial.rst

@@ -1,6 +1,6 @@
 import logging
+from unittest import mock
 
-import pretend
 import pytest
 
 from pip._internal.cli.status_codes import NO_MATCHES_FOUND, SUCCESS
@@ -156,18 +156,18 @@ def test_latest_prerelease_install_message(caplog, monkeypatch):
         }
     ]
 
-    installed_package = pretend.stub(project_name="ni")
+    installed_package = mock.Mock(project_name="ni")
     monkeypatch.setattr("pip._vendor.pkg_resources.working_set", [installed_package])
 
-    dist = pretend.stub(version="1.0.0")
-    get_dist = pretend.call_recorder(lambda x: dist)
+    get_dist = mock.Mock()
+    get_dist.return_value = mock.Mock(version="1.0.0")
     monkeypatch.setattr("pip._internal.commands.search.get_distribution", get_dist)
     with caplog.at_level(logging.INFO):
         print_results(hits)
 
     message = caplog.records[-1].getMessage()
     assert 'pre-release; install with "pip install --pre"' in message
-    assert get_dist.calls == [pretend.call("ni")]
+    assert get_dist.call_args_list == [mock.call("ni")]
 
 
 @pytest.mark.search

tests/functional/test_search.py

@@ -4,8 +4,8 @@
 import textwrap
 from os.path import join, normpath
 from tempfile import mkdtemp
+from unittest.mock import Mock
 
-import pretend
 import pytest
 
 from pip._internal.req.constructors import install_req_from_line
@@ -467,14 +467,13 @@ def test_uninstall_non_local_distutils(caplog, monkeypatch, tmpdir):
     with open(einfo, "wb"):
         pass
 
-    dist = pretend.stub(
+    get_dist = Mock()
+    get_dist.return_value = Mock(
         key="thing",
         project_name="thing",
         egg_info=einfo,
         location=einfo,
-        _provider=pretend.stub(),
     )
-    get_dist = pretend.call_recorder(lambda x: dist)
     monkeypatch.setattr("pip._vendor.pkg_resources.get_distribution", get_dist)
 
     req = install_req_from_line("thing")

tests/functional/test_uninstall.py

@@ -1,6 +1,5 @@
 cryptography
 freezegun
-pretend
 pytest
 pytest-cov
 pytest-rerunfailures

tests/requirements.txt

@@ -2,18 +2,16 @@
 import os
 import posixpath
 import sys
+from unittest import mock
 
-import pretend
 from pip._vendor import appdirs as _appdirs
 
 from pip._internal.utils import appdirs
 
 
 class TestUserCacheDir:
     def test_user_cache_dir_win(self, monkeypatch):
-        @pretend.call_recorder
-        def _get_win_folder(base):
-            return "C:\\Users\\test\\AppData\\Local"
+        _get_win_folder = mock.Mock(return_value="C:\\Users\\test\\AppData\\Local")
 
         monkeypatch.setattr(
             _appdirs,
@@ -28,7 +26,7 @@ def _get_win_folder(base):
             appdirs.user_cache_dir("pip")
             == "C:\\Users\\test\\AppData\\Local\\pip\\Cache"
         )
-        assert _get_win_folder.calls == [pretend.call("CSIDL_LOCAL_APPDATA")]
+        assert _get_win_folder.call_args_list == [mock.call("CSIDL_LOCAL_APPDATA")]
 
     def test_user_cache_dir_osx(self, monkeypatch):
         monkeypatch.setattr(_appdirs, "system", "darwin")
@@ -89,9 +87,7 @@ def my_get_win_folder(csidl_name):
 
 class TestSiteConfigDirs:
     def test_site_config_dirs_win(self, monkeypatch):
-        @pretend.call_recorder
-        def _get_win_folder(base):
-            return "C:\\ProgramData"
+        _get_win_folder = mock.Mock(return_value="C:\\ProgramData")
 
         monkeypatch.setattr(
             _appdirs,
@@ -103,7 +99,7 @@ def _get_win_folder(base):
         monkeypatch.setattr(os, "path", ntpath)
 
         assert appdirs.site_config_dirs("pip") == ["C:\\ProgramData\\pip"]
-        assert _get_win_folder.calls == [pretend.call("CSIDL_COMMON_APPDATA")]
+        assert _get_win_folder.call_args_list == [mock.call("CSIDL_COMMON_APPDATA")]
 
     def test_site_config_dirs_osx(self, monkeypatch):
         monkeypatch.setattr(_appdirs, "system", "darwin")
@@ -146,9 +142,7 @@ def test_site_config_dirs_linux_empty(self, monkeypatch):
 
 class TestUserConfigDir:
     def test_user_config_dir_win_no_roaming(self, monkeypatch):
-        @pretend.call_recorder
-        def _get_win_folder(base):
-            return "C:\\Users\\test\\AppData\\Local"
+        _get_win_folder = mock.Mock(return_value="C:\\Users\\test\\AppData\\Local")
 
         monkeypatch.setattr(
             _appdirs,
@@ -163,12 +157,10 @@ def _get_win_folder(base):
             appdirs.user_config_dir("pip", roaming=False)
             == "C:\\Users\\test\\AppData\\Local\\pip"
         )
-        assert _get_win_folder.calls == [pretend.call("CSIDL_LOCAL_APPDATA")]
+        assert _get_win_folder.call_args_list == [mock.call("CSIDL_LOCAL_APPDATA")]
 
     def test_user_config_dir_win_yes_roaming(self, monkeypatch):
-        @pretend.call_recorder
-        def _get_win_folder(base):
-            return "C:\\Users\\test\\AppData\\Roaming"
+        _get_win_folder = mock.Mock(return_value="C:\\Users\\test\\AppData\\Roaming")
 
         monkeypatch.setattr(
             _appdirs,
@@ -182,7 +174,7 @@ def _get_win_folder(base):
         assert (
             appdirs.user_config_dir("pip") == "C:\\Users\\test\\AppData\\Roaming\\pip"
         )
-        assert _get_win_folder.calls == [pretend.call("CSIDL_APPDATA")]
+        assert _get_win_folder.call_args_list == [mock.call("CSIDL_APPDATA")]
 
     def test_user_config_dir_osx(self, monkeypatch):
         monkeypatch.setattr(_appdirs, "system", "darwin")

tests/unit/test_appdirs.py

@@ -8,7 +8,6 @@
 from unittest import mock
 from unittest.mock import Mock, patch
 
-import pretend
 import pytest
 from pip._vendor import html5lib, requests
 
@@ -518,7 +517,7 @@ def test_request_retries(caplog):
 
 def test_make_html_page():
     headers = {"Content-Type": "text/html; charset=UTF-8"}
-    response = pretend.stub(
+    response = Mock(
         content=b"<content>",
         url="https://example.com/index.html",
         headers=headers,
@@ -604,7 +603,7 @@ def make_fake_html_response(url):
     """
     )
     content = html.encode("utf-8")
-    return pretend.stub(content=content, url=url, headers={})
+    return Mock(content=content, url=url, headers={})
 
 
 def test_get_html_page_directory_append_index(tmpdir):
@@ -636,8 +635,8 @@ def test_collect_sources__file_expand_dir(data):
     Test that a file:// dir from --find-links becomes _FlatDirectorySource
     """
     collector = LinkCollector.create(
-        session=pretend.stub(is_secure_origin=None),  # Shouldn't be used.
-        options=pretend.stub(
+        session=Mock(is_secure_origin=None),  # Shouldn't be used.
+        options=Mock(
             index_url="ignored-by-no-index",
             extra_index_urls=[],
             no_index=True,
@@ -664,8 +663,8 @@ def test_collect_sources__file_not_find_link(data):
     run
     """
     collector = LinkCollector.create(
-        session=pretend.stub(is_secure_origin=None),  # Shouldn't be used.
-        options=pretend.stub(
+        session=Mock(is_secure_origin=None),  # Shouldn't be used.
+        options=Mock(
             index_url=data.index_url("empty_with_pkg"),
             extra_index_urls=[],
             no_index=False,
@@ -688,8 +687,8 @@ def test_collect_sources__non_existing_path():
     Test that a non-existing path is ignored.
     """
     collector = LinkCollector.create(
-        session=pretend.stub(is_secure_origin=None),  # Shouldn't be used.
-        options=pretend.stub(
+        session=Mock(is_secure_origin=None),  # Shouldn't be used.
+        options=Mock(
             index_url="ignored-by-no-index",
             extra_index_urls=[],
             no_index=True,
@@ -810,7 +809,7 @@ def test_link_collector_create(
     """
     expected_find_links, expected_index_urls = expected
     session = PipSession()
-    options = pretend.stub(
+    options = Mock(
         find_links=find_links,
         index_url="default_url",
         extra_index_urls=["url1", "url2"],
@@ -846,7 +845,7 @@ def expand_path(path):
     mock_expanduser.side_effect = expand_path
 
     session = PipSession()
-    options = pretend.stub(
+    options = Mock(
         find_links=["~/temp1", "~/temp2"],
         index_url="default_url",
         extra_index_urls=[],

tests/unit/test_collector.py

@@ -3,10 +3,9 @@
 import os
 import subprocess
 import textwrap
-from unittest.mock import patch
+from unittest import mock
 
 import pytest
-from pretend import stub
 
 import pip._internal.req.req_file  # this will be monkeypatched
 from pip._internal.exceptions import InstallationError, RequirementsFileParseError
@@ -39,7 +38,7 @@ def finder(session):
 
 @pytest.fixture
 def options(session):
-    return stub(
+    return mock.Mock(
         isolated_mode=False,
         index_url="default_url",
         format_control=FormatControl(set(), set()),
@@ -614,7 +613,7 @@ def make_var(name):
         # Construct the session outside the monkey-patch, since it access the
         # env
         session = PipSession()
-        with patch("pip._internal.req.req_file.os.getenv") as getenv:
+        with mock.patch("pip._internal.req.req_file.os.getenv") as getenv:
             getenv.side_effect = lambda n: env_vars[n]
 
             reqs = list(
@@ -640,7 +639,7 @@ def test_expand_missing_env_variables(self, tmpdir, finder):
         # Construct the session outside the monkey-patch, since it access the
         # env
         session = PipSession()
-        with patch("pip._internal.req.req_file.os.getenv") as getenv:
+        with mock.patch("pip._internal.req.req_file.os.getenv") as getenv:
             getenv.return_value = ""
 
             reqs = list(
@@ -761,7 +760,7 @@ def test_install_requirements_with_options(self, tmpdir, finder, session, option
             )
 
         req.source_dir = os.curdir
-        with patch.object(subprocess, "Popen") as popen:
+        with mock.patch.object(subprocess, "Popen") as popen:
             popen.return_value.stdout.readline.return_value = b""
             try:
                 req.install([])

tests/unit/test_req_file.py

@@ -3,9 +3,9 @@
 import json
 import os
 import sys
+from unittest import mock
 
 import freezegun  # type: ignore
-import pretend
 import pytest
 from pip._vendor.packaging.version import parse as parse_version
 
@@ -75,7 +75,7 @@ def get_distribution(self, name):
 def _options():
     """Some default options that we pass to
     self_outdated_check.pip_self_version_check"""
-    return pretend.stub(
+    return mock.Mock(
         find_links=[],
         index_url="default_url",
         extra_index_urls=[],
@@ -124,20 +124,12 @@ def test_pip_self_version_check(
         "PackageFinder",
         MockPackageFinder,
     )
-    monkeypatch.setattr(
-        logger,
-        "warning",
-        pretend.call_recorder(lambda *a, **kw: None),
-    )
-    monkeypatch.setattr(
-        logger,
-        "debug",
-        pretend.call_recorder(lambda s, exc_info=None: None),
-    )
+    monkeypatch.setattr(logger, "warning", mock.Mock())
+    monkeypatch.setattr(logger, "debug", mock.Mock())
 
-    fake_state = pretend.stub(
+    fake_state = mock.Mock(
         state={"last_check": stored_time, "pypi_version": installed_ver},
-        save=pretend.call_recorder(lambda v, t: None),
+        save=mock.Mock(),
     )
     monkeypatch.setattr(self_outdated_check, "SelfCheckState", lambda **kw: fake_state)
 
@@ -156,20 +148,20 @@ def test_pip_self_version_check(
         assert not latest_pypi_version
     # See that we saved the correct version
     elif check_if_upgrade_required:
-        assert fake_state.save.calls == [
-            pretend.call(new_ver, datetime.datetime(1970, 1, 9, 10, 00, 00)),
+        assert fake_state.save.call_args_list == [
+            mock.call(new_ver, datetime.datetime(1970, 1, 9, 10, 00, 00)),
         ]
     else:
         # Make sure no Exceptions
-        assert not logger.debug.calls
+        assert not logger.debug.call_args_list
         # See that save was not called
-        assert fake_state.save.calls == []
+        assert fake_state.save.call_args_list == []
 
     # Ensure we warn the user or not
     if check_warn_logs:
-        assert len(logger.warning.calls) == 1
+        assert logger.warning.call_count == 1
     else:
-        assert len(logger.warning.calls) == 0
+        assert logger.warning.call_count == 0
 
 
 statefile_name_case_1 = "fcd2d5175dd33d5df759ee7b045264230205ef837bf9f582f7c3ada7"