Revert "Allow for generic auth headers with pystac + validators (#316)"

This reverts commit 6a38a74.

Author: gadomski

noxfile.py

@@ -151,7 +151,7 @@ def mypy(session: Session) -> None:
     """Type-check using mypy."""
     args = session.posargs or ["src", "tests", "docs/conf.py"]
     session.install(".")
-    session.install("mypy", "pytest", "types-requests", "types-PyYAML", "typeguard")
+    session.install("mypy", "pytest", "types-requests", "types-PyYAML")
     session.run("mypy", *args)
     if not session.posargs:
         session.run("mypy", f"--python-executable={sys.executable}", "noxfile.py")
@@ -161,7 +161,7 @@ def mypy(session: Session) -> None:
 def tests(session: Session) -> None:
     """Run the test suite."""
     session.install(".")
-    session.install("coverage[toml]", "pytest", "pygments", "typeguard")
+    session.install("coverage[toml]", "pytest", "pygments")
     try:
         session.run("coverage", "run", "--parallel", "-m", "pytest", *session.posargs)
     finally:

src/stac_api_validator/__main__.py

@@ -130,12 +130,6 @@
     "--transaction-collection",
     help="The name of the collection to use for Transaction Extension tests.",
 )
-@click.option(
-    "-H",
-    "--headers",
-    multiple=True,
-    help="Headers to attach to the main request and dependent pystac requests, curl syntax",
-)
 def main(
     log_level: str,
     root_url: str,
@@ -160,21 +154,11 @@ def main(
     query_in_field: Optional[str] = None,
     query_in_values: Optional[str] = None,
     transaction_collection: Optional[str] = None,
-    headers: Optional[List[str]] = None,
 ) -> int:
     """STAC API Validator."""
     logging.basicConfig(stream=sys.stdout, level=log_level)
 
     try:
-        processed_headers = {}
-        if headers:
-            processed_headers.update(
-                {
-                    key.strip(): value.strip()
-                    for key, value in (header.split(":") for header in headers)
-                }
-            )
-
         (warnings, errors) = validate_api(
             root_url=root_url,
             ccs_to_validate=conformance_classes,
@@ -200,7 +184,6 @@ def main(
                 query_in_values,
             ),
             transaction_collection=transaction_collection,
-            headers=processed_headers,
         )
     except Exception as e:
         click.secho(

src/stac_api_validator/validations.py

@@ -26,7 +26,6 @@
 from pystac import Collection
 from pystac import Item
 from pystac import ItemCollection
-from pystac import StacIO
 from pystac import STACValidationError
 from pystac_client import Client
 from requests import Request
@@ -298,16 +297,6 @@ def is_geojson_type(maybe_type: Optional[str]) -> bool:
     )
 
 
-def get_catalog(data_dict: Dict[str, Any], r_session: Session) -> Catalog:
-    stac_io = StacIO.default()
-    if r_session.headers and r_session.headers.get("Authorization"):
-        stac_io.headers = r_session.headers  # noqa, type: ignore
-        stac_io.headers["Accept-Encoding"] = "*"
-    catalog = Catalog.from_dict(data_dict)
-    catalog._stac_io = stac_io
-    return catalog
-
-
 # def is_json_or_geojson_type(maybe_type: Optional[str]) -> bool:
 #     return maybe_type and (is_json_type(maybe_type) or is_geojson_type(maybe_type))
 
@@ -391,8 +380,9 @@ def retrieve(
     additional: Optional[str] = "",
     content_type: Optional[str] = None,
 ) -> Tuple[int, Optional[Dict[str, Any]], Optional[Mapping[str, str]]]:
-    request = Request(method.value, url, headers=headers, params=params, json=body)
-    resp = r_session.send(r_session.prepare_request(request))
+    resp = r_session.send(
+        Request(method.value, url, headers=headers, params=params, json=body).prepare()
+    )
 
     # todo: handle connection exception, etc.
     # todo: handle timeout
@@ -546,7 +536,6 @@ def validate_api(
     validate_pagination: bool,
     query_config: QueryConfig,
     transaction_collection: Optional[str],
-    headers: Optional[Dict[str, str]],
 ) -> Tuple[Warnings, Errors]:
     warnings = Warnings()
     errors = Errors()
@@ -558,9 +547,6 @@ def validate_api(
     if auth_query_parameter and (xs := auth_query_parameter.split("=", 1)):
         r_session.params = {xs[0]: xs[1]}
 
-    if headers:
-        r_session.headers.update(headers)
-
     _, landing_page_body, landing_page_headers = retrieve(
         Method.GET, root_url, errors, Context.CORE, r_session
     )
@@ -717,7 +703,7 @@ def validate_api(
 
     if not errors:
         try:
-            catalog = Client.open(root_url, headers=headers)
+            catalog = Client.open(root_url)
             catalog.validate()
             for child in catalog.get_children():
                 child.validate()
@@ -824,8 +810,7 @@ def validate_core(
     # this validates, among other things, that the child and item link relations reference
     # valid STAC Catalogs, Collections, and/or Items
     try:
-        catalog = get_catalog(root_body, r_session)
-        list(take(1000, catalog.get_all_items()))
+        list(take(1000, Catalog.from_dict(root_body).get_all_items()))
     except pystac.errors.STACTypeError as e:
         errors += (
             f"[{Context.CORE}] Error while traversing Catalog child/item links to find Items: {e} "
@@ -853,15 +838,14 @@ def validate_browseable(
     # check that at least a few of the items that can be reached from child/item link relations
     # can be found through search
     try:
-        catalog = get_catalog(root_body, r_session)
-        for item in take(10, catalog.get_all_items()):
+        for item in take(10, Catalog.from_dict(root_body).get_all_items()):
             if link := link_by_rel(root_body.get("links"), "search"):
                 _, body, _ = retrieve(
                     Method.GET,
                     link["href"],
                     errors,
                     Context.BROWSEABLE,
-                    params={"ids": item.id, "collections": item.collection_id},
+                    params={"ids": item.id, "collections": item.collection},
                     r_session=r_session,
                 )
                 if body and len(body.get("features", [])) != 1:

tests/resources/sample-item.json

@@ -1,6 +1,4 @@
 """Test cases for the __main__ module."""
-import unittest.mock
-
 import pytest
 from click.testing import CliRunner
 
@@ -16,38 +14,3 @@ def runner() -> CliRunner:
 def test_main_fails(runner: CliRunner) -> None:
     result = runner.invoke(__main__.main)
     assert result.exit_code == 2
-
-
-def test_retrieve_called_with_auth_headers(
-    request: pytest.FixtureRequest, runner: CliRunner
-) -> None:
-    if request.config.getoption("typeguard_packages"):
-        pytest.skip(
-            "The import hook that typeguard uses seems to break the mock below."
-        )
-
-    expected_headers = {
-        "User-Agent": "python-requests/2.28.2",
-        "Accept-Encoding": "gzip, deflate",
-        "Accept": "*/*",
-        "Connection": "keep-alive",
-        "Authorization": "api-key fake-api-key-value",
-    }
-
-    with unittest.mock.patch(
-        "stac_api_validator.validations.retrieve"
-    ) as retrieve_mock:
-        runner.invoke(
-            __main__.main,
-            args=[
-                "--root-url",
-                "https://invalid",
-                "--conformance",
-                "core",
-                "-H",
-                "Authorization: api-key fake-api-key-value",
-            ],
-        )
-        assert retrieve_mock.call_count == 1
-        r_session = retrieve_mock.call_args.args[-1]
-        assert r_session.headers == expected_headers