More tests on successful scenarios, fix docstrings

Author: uranusjr

src/pip/_internal/index.py

@@ -72,7 +72,7 @@ def _match_vcs_scheme(url):
 
 
 def _is_url_like_archive(url):
-    """Check whether the URL looks like an archive.
+    """Return whether the URL looks like an archive.
     """
     filename = Link(url).filename
     for bad_ext in ARCHIVE_EXTENSIONS:
@@ -128,8 +128,8 @@ def _get_html_response(url, session):
        Raise `_NotHTTP` if the content type cannot be determined, or
        `_NotHTML` if it is not HTML.
     2. Actually perform the request. Raise HTTP exceptions on network failures.
-    3. Check whether Content-Type header to make sure the thing we got is HTML,
-       and raise `_NotHTML` if it's not.
+    3. Check the Content-Type header to make sure we got HTML, and raise
+       `_NotHTML` otherwise.
     """
     if _is_url_like_archive(url):
         _ensure_html_response(url, session=session)

tests/unit/test_index_html_page.py

@@ -6,8 +6,7 @@
 
 from pip._internal.download import PipSession
 from pip._internal.index import (
-    Link, PackageFinder, _determine_base_url, _get_html_page,
-    _get_html_response, _NotHTML, _NotHTTP, egg_info_matches,
+    Link, _get_html_page, _get_html_response, _NotHTML, _NotHTTP,
 )
 
 
@@ -36,8 +35,8 @@ def test_get_html_response_archive_to_naive_scheme(url):
 )
 def test_get_html_response_archive_to_http_scheme(url, content_type):
     """
-    `_get_html_response()` should send a HEAD request on and archive-like URL
-    if the scheme supports it.
+    `_get_html_response()` should send a HEAD request on an archive-like URL
+    if the scheme supports it, and raise `_NotHTML` if the response isn't HTML.
     """
     session = mock.Mock(PipSession)
     session.head.return_value = mock.Mock(**{
@@ -54,6 +53,71 @@ def test_get_html_response_archive_to_http_scheme(url, content_type):
     assert ctx.value.args == (content_type, "HEAD")
 
 
+@pytest.mark.parametrize(
+    "url",
+    [
+        "http://python.org/python-3.7.1.zip",
+        "https://pypi.org/pip-18.0.tar.gz",
+    ],
+)
+def test_get_html_response_archive_to_http_scheme_is_html(url):
+    """
+    `_get_html_response()` should work with archive-like URLs if the HEAD
+    request is responded with text/html.
+    """
+    session = mock.Mock(PipSession)
+    session.head.return_value = mock.Mock(**{
+        "request.method": "HEAD",
+        "headers": {"Content-Type": "text/html"},
+    })
+    session.get.return_value = mock.Mock(headers={"Content-Type": "text/html"})
+
+    resp = _get_html_response(url, session=session)
+
+    assert resp is not None
+    assert session.mock_calls == [
+        mock.call.head(url, allow_redirects=True),
+        mock.call.head().raise_for_status(),
+        mock.call.get(url, headers={
+            "Accept": "text/html", "Cache-Control": "max-age=0",
+        }),
+        mock.call.get().raise_for_status(),
+    ]
+
+
+@pytest.mark.parametrize(
+    "url",
+    [
+        "https://pypi.org/simple/pip",
+        "https://pypi.org/simple/pip/",
+        "https://python.org/sitemap.xml",
+    ],
+)
+def test_get_html_response_no_head(url):
+    """
+    `_get_html_response()` shouldn't send a HEAD request if the URL does not
+    look like an archive, only the GET request that retrieves data.
+    """
+    session = mock.Mock(PipSession)
+
+    # Mock the headers dict to ensure it is accessed.
+    session.get.return_value = mock.Mock(headers=mock.Mock(**{
+        "get.return_value": "text/html",
+    }))
+
+    resp = _get_html_response(url, session=session)
+
+    assert resp is not None
+    assert session.head.call_count == 0
+    assert session.get.mock_calls == [
+        mock.call(url, headers={
+            "Accept": "text/html", "Cache-Control": "max-age=0",
+        }),
+        mock.call().raise_for_status(),
+        mock.call().headers.get("Content-Type", ""),
+    ]
+
+
 @pytest.mark.parametrize(
     "url, vcs_scheme",
     [