Move custom tempdir logic to test utils

Author: duckontheweb

tests/data-files/get_examples.py

@@ -5,13 +5,13 @@
 import os
 import argparse
 import json
-from tempfile import TemporaryDirectory
 from subprocess import call
 from typing import Any, Dict, List, Optional
 from urllib.error import HTTPError
 
 import pystac
 from pystac.serialization import identify_stac_object
+from tests.utils import TemporaryDirectory
 
 
 def remove_bad_collection(js: Dict[str, Any]) -> Dict[str, Any]:
@@ -50,7 +50,7 @@ def remove_bad_collection(js: Dict[str, Any]) -> Dict[str, Any]:
 
     examples_dir = os.path.abspath(os.path.join(os.path.dirname(__file__), "examples"))
 
-    with TemporaryDirectory(dir=os.getcwd()) as tmp_dir:
+    with TemporaryDirectory() as tmp_dir:
         call(
             [
                 "git",

tests/extensions/test_label.py

@@ -1,7 +1,6 @@
 import json
 import os
 import unittest
-from tempfile import TemporaryDirectory
 
 import pystac
 from pystac import Catalog, Item, CatalogType
@@ -16,7 +15,7 @@
 )
 import pystac.validation
 from pystac.utils import get_opt
-from tests.utils import TestCases, assert_to_from_dict
+from tests.utils import TestCases, assert_to_from_dict, TemporaryDirectory
 
 
 class LabelTest(unittest.TestCase):
@@ -86,7 +85,7 @@ def test_validate_label(self) -> None:
             label_example_1_dict, pystac.STACObjectType.ITEM
         )
 
-        with TemporaryDirectory(dir=os.getcwd()) as tmp_dir:
+        with TemporaryDirectory() as tmp_dir:
             cat_dir = os.path.join(tmp_dir, "catalog")
             catalog = TestCases.test_case_1()
             catalog.normalize_and_save(cat_dir, catalog_type=CatalogType.SELF_CONTAINED)

tests/test_catalog.py

@@ -2,7 +2,6 @@
 import json
 from typing import Any, Dict, List, Tuple, Union, cast
 import unittest
-from tempfile import TemporaryDirectory
 from datetime import datetime
 from collections import defaultdict
 
@@ -18,13 +17,19 @@
 )
 from pystac.extensions.label import LabelClasses, LabelExtension, LabelType
 from pystac.utils import is_absolute_href, join_path_or_url, JoinType
-from tests.utils import TestCases, ARBITRARY_GEOM, ARBITRARY_BBOX, MockStacIO
+from tests.utils import (
+    TestCases,
+    ARBITRARY_GEOM,
+    ARBITRARY_BBOX,
+    MockStacIO,
+    TemporaryDirectory,
+)
 
 
 class CatalogTypeTest(unittest.TestCase):
     def test_determine_type_for_absolute_published(self) -> None:
         cat = TestCases.test_case_1()
-        with TemporaryDirectory(dir=os.getcwd()) as tmp_dir:
+        with TemporaryDirectory() as tmp_dir:
             cat.normalize_and_save(tmp_dir, catalog_type=CatalogType.ABSOLUTE_PUBLISHED)
             cat_json = pystac.StacIO.default().read_json(
                 os.path.join(tmp_dir, "catalog.json")
@@ -35,7 +40,7 @@ def test_determine_type_for_absolute_published(self) -> None:
 
     def test_determine_type_for_relative_published(self) -> None:
         cat = TestCases.test_case_2()
-        with TemporaryDirectory(dir=os.getcwd()) as tmp_dir:
+        with TemporaryDirectory() as tmp_dir:
             cat.normalize_and_save(tmp_dir, catalog_type=CatalogType.RELATIVE_PUBLISHED)
             cat_json = pystac.StacIO.default().read_json(
                 os.path.join(tmp_dir, "catalog.json")
@@ -63,7 +68,7 @@ def test_determine_type_for_unknown(self) -> None:
 
 class CatalogTest(unittest.TestCase):
     def test_create_and_read(self) -> None:
-        with TemporaryDirectory(dir=os.getcwd()) as tmp_dir:
+        with TemporaryDirectory() as tmp_dir:
             cat_dir = os.path.join(tmp_dir, "catalog")
             catalog = TestCases.test_case_1()
 
@@ -283,7 +288,7 @@ def test_clone_generates_correct_links(self) -> None:
     def test_save_uses_previous_catalog_type(self) -> None:
         catalog = TestCases.test_case_1()
         assert catalog.catalog_type == CatalogType.SELF_CONTAINED
-        with TemporaryDirectory(dir=os.getcwd()) as tmp_dir:
+        with TemporaryDirectory() as tmp_dir:
             catalog.normalize_hrefs(tmp_dir)
             href = catalog.self_href
             catalog.save()
@@ -360,7 +365,7 @@ def test_generate_subcatalogs_does_not_change_item_count(self) -> None:
 
         catalog.generate_subcatalogs("${year}/${day}")
 
-        with TemporaryDirectory(dir=os.getcwd()) as tmp_dir:
+        with TemporaryDirectory() as tmp_dir:
             catalog.normalize_hrefs(tmp_dir)
             catalog.save(pystac.CatalogType.SELF_CONTAINED)
 
@@ -489,7 +494,7 @@ def item_mapper(item: pystac.Item) -> pystac.Item:
             item.properties["ITEM_MAPPER"] = "YEP"
             return item
 
-        with TemporaryDirectory(dir=os.getcwd()) as tmp_dir:
+        with TemporaryDirectory() as tmp_dir:
             catalog = TestCases.test_case_1()
 
             new_cat = catalog.map_items(item_mapper)
@@ -513,7 +518,7 @@ def item_mapper(item: pystac.Item) -> List[pystac.Item]:
             item2.properties["ITEM_MAPPER_2"] = "YEP"
             return [item, item2]
 
-        with TemporaryDirectory(dir=os.getcwd()) as tmp_dir:
+        with TemporaryDirectory() as tmp_dir:
             catalog = TestCases.test_case_1()
             catalog_items = catalog.get_all_items()
 
@@ -618,7 +623,7 @@ def asset_mapper(key: str, asset: pystac.Asset) -> pystac.Asset:
 
             return asset
 
-        with TemporaryDirectory(dir=os.getcwd()) as tmp_dir:
+        with TemporaryDirectory() as tmp_dir:
             catalog = TestCases.test_case_2()
 
             new_cat = catalog.map_assets(asset_mapper)
@@ -651,7 +656,7 @@ def asset_mapper(
             else:
                 return asset
 
-        with TemporaryDirectory(dir=os.getcwd()) as tmp_dir:
+        with TemporaryDirectory() as tmp_dir:
             catalog = TestCases.test_case_2()
 
             new_cat = catalog.map_assets(asset_mapper)
@@ -691,7 +696,7 @@ def asset_mapper(
             else:
                 return asset
 
-        with TemporaryDirectory(dir=os.getcwd()) as tmp_dir:
+        with TemporaryDirectory() as tmp_dir:
             catalog = TestCases.test_case_2()
 
             new_cat = catalog.map_assets(asset_mapper)
@@ -766,7 +771,7 @@ def check_all_absolute(cat: Catalog) -> None:
         test_cases = TestCases.all_test_catalogs()
 
         for catalog in test_cases:
-            with TemporaryDirectory(dir=os.getcwd()) as tmp_dir:
+            with TemporaryDirectory() as tmp_dir:
                 c2 = catalog.full_copy()
                 c2.normalize_hrefs(tmp_dir)
                 c2.catalog_type = CatalogType.RELATIVE_PUBLISHED
@@ -792,7 +797,7 @@ def test_extra_fields(self) -> None:
 
         catalog.extra_fields["type"] = "FeatureCollection"
 
-        with TemporaryDirectory(dir=os.getcwd()) as tmp_dir:
+        with TemporaryDirectory() as tmp_dir:
             p = os.path.join(tmp_dir, "catalog.json")
             catalog.save_object(include_self_link=False, dest_href=p)
             with open(p) as f:
@@ -817,7 +822,7 @@ def test_validate_all(self) -> None:
         item = cat.get_item("area-1-1-labels", recursive=True)
         assert item is not None
         item.geometry = {"type": "INVALID", "coordinates": "NONE"}
-        with TemporaryDirectory(dir=os.getcwd()) as tmp_dir:
+        with TemporaryDirectory() as tmp_dir:
             cat.normalize_hrefs(tmp_dir)
             cat.save(catalog_type=pystac.CatalogType.SELF_CONTAINED)
 
@@ -838,7 +843,7 @@ def test_set_hrefs_manually(self) -> None:
             year += 1
             month += 1
 
-        with TemporaryDirectory(dir=os.getcwd()) as tmp_dir:
+        with TemporaryDirectory() as tmp_dir:
             for root, _, items in catalog.walk():
 
                 # Set root's HREF based off the parent
@@ -928,7 +933,7 @@ def test_reading_iterating_and_writing_works_as_expected(self) -> None:
         for item in cat.get_all_items():
             pass
 
-        with TemporaryDirectory(dir=os.getcwd()) as tmp_dir:
+        with TemporaryDirectory() as tmp_dir:
             new_stac_uri = os.path.join(tmp_dir, "test-case-6")
             cat.normalize_hrefs(new_stac_uri)
             cat.save(catalog_type=CatalogType.SELF_CONTAINED)
@@ -998,7 +1003,7 @@ def check_catalog(self, c: Catalog, tag: str) -> None:
             self.check_item(item, tag)
 
     def test_full_copy_1(self) -> None:
-        with TemporaryDirectory(dir=os.getcwd()) as tmp_dir:
+        with TemporaryDirectory() as tmp_dir:
             cat = Catalog(id="test", description="test catalog")
 
             item = Item(
@@ -1019,7 +1024,7 @@ def test_full_copy_1(self) -> None:
             self.check_catalog(cat2, "dest")
 
     def test_full_copy_2(self) -> None:
-        with TemporaryDirectory(dir=os.getcwd()) as tmp_dir:
+        with TemporaryDirectory() as tmp_dir:
             cat = Catalog(id="test", description="test catalog")
             image_item = Item(
                 id="Imagery",
@@ -1066,7 +1071,7 @@ def test_full_copy_2(self) -> None:
             self.check_catalog(cat2, "dest")
 
     def test_full_copy_3(self) -> None:
-        with TemporaryDirectory(dir=os.getcwd()) as tmp_dir:
+        with TemporaryDirectory() as tmp_dir:
             root_cat = TestCases.test_case_1()
             root_cat.normalize_hrefs(
                 os.path.join(tmp_dir, "catalog-full-copy-3-source")
@@ -1080,7 +1085,7 @@ def test_full_copy_3(self) -> None:
             self.check_catalog(cat2, "dest")
 
     def test_full_copy_4(self) -> None:
-        with TemporaryDirectory(dir=os.getcwd()) as tmp_dir:
+        with TemporaryDirectory() as tmp_dir:
             root_cat = TestCases.test_case_2()
             root_cat.normalize_hrefs(
                 os.path.join(tmp_dir, "catalog-full-copy-4-source")

tests/test_collection.py

@@ -1,7 +1,6 @@
 import unittest
 import os
 import json
-from tempfile import TemporaryDirectory
 from datetime import datetime
 from dateutil import tz
 
@@ -10,7 +9,7 @@
 from pystac.validation import validate_dict
 from pystac import Collection, Item, Extent, SpatialExtent, TemporalExtent, CatalogType
 from pystac.utils import datetime_to_str
-from tests.utils import TestCases, ARBITRARY_GEOM, ARBITRARY_BBOX
+from tests.utils import TestCases, ARBITRARY_GEOM, ARBITRARY_BBOX, TemporaryDirectory
 
 TEST_DATETIME = datetime(2020, 3, 14, 16, 32)
 
@@ -35,7 +34,7 @@ def test_save_uses_previous_catalog_type(self) -> None:
         collection = TestCases.test_case_8()
         assert collection.STAC_OBJECT_TYPE == pystac.STACObjectType.COLLECTION
         self.assertEqual(collection.catalog_type, CatalogType.SELF_CONTAINED)
-        with TemporaryDirectory(dir=os.getcwd()) as tmp_dir:
+        with TemporaryDirectory() as tmp_dir:
             collection.normalize_hrefs(tmp_dir)
             href = collection.self_href
             collection.save()
@@ -84,7 +83,7 @@ def test_extra_fields(self) -> None:
 
         collection.extra_fields["test"] = "extra"
 
-        with TemporaryDirectory(dir=os.getcwd()) as tmp_dir:
+        with TemporaryDirectory() as tmp_dir:
             p = os.path.join(tmp_dir, "collection.json")
             collection.save_object(include_self_link=False, dest_href=p)
             with open(p) as f:

tests/test_item.py

@@ -3,15 +3,14 @@
 import json
 from typing import Any, Dict, List
 import unittest
-from tempfile import TemporaryDirectory
 
 import pystac
 from pystac import Asset, Item, Provider
 from pystac.validation import validate_dict
 import pystac.serialization.common_properties
 from pystac.item import CommonMetadata
 from pystac.utils import datetime_to_str, get_opt, str_to_datetime, is_absolute_href
-from tests.utils import TestCases, assert_to_from_dict
+from tests.utils import TestCases, assert_to_from_dict, TemporaryDirectory
 
 
 class ItemTest(unittest.TestCase):
@@ -73,7 +72,7 @@ def test_extra_fields(self) -> None:
 
         item.extra_fields["test"] = "extra"
 
-        with TemporaryDirectory(dir=os.getcwd()) as tmp_dir:
+        with TemporaryDirectory() as tmp_dir:
             p = os.path.join(tmp_dir, "item.json")
             item.save_object(include_self_link=False, dest_href=p)
             with open(p) as f:

tests/test_writing.py

@@ -1,14 +1,12 @@
-import os
 import unittest
-from tempfile import TemporaryDirectory
 from typing import Any, List
 
 import pystac
 from pystac import Collection, CatalogType, HIERARCHICAL_LINKS
 from pystac.utils import is_absolute_href, make_absolute_href, make_relative_href
 from pystac.validation import validate_dict
 
-from tests.utils import TestCases
+from tests.utils import TestCases, TemporaryDirectory
 
 
 class STACWritingTest(unittest.TestCase):
@@ -106,7 +104,7 @@ def validate_catalog_link_type(
     def do_test(
         self, catalog: pystac.Catalog, catalog_type: pystac.CatalogType
     ) -> None:
-        with TemporaryDirectory(dir=os.getcwd()) as tmp_dir:
+        with TemporaryDirectory() as tmp_dir:
             catalog.normalize_hrefs(tmp_dir)
             self.validate_catalog(catalog)
 

tests/utils/__init__.py

@@ -1,6 +1,8 @@
 # flake8: noqa
 
-from typing import Any, Dict, Type
+import os
+import tempfile
+from typing import Any, Dict, Type, Optional
 import unittest
 from tests.utils.test_cases import (
     TestCases,
@@ -41,3 +43,18 @@ def _parse_times(a_dict: Dict[str, Any]) -> None:
     _parse_times(d1)
     _parse_times(d2)
     test_class.assertDictEqual(d1, d2)
+
+
+# Mypy raises an error for this class:
+#  error: Missing type parameters for generic type "TemporaryDirectory"  [type-arg]
+# Trying to add a concrete type (e.g. TemporaryDirectory[str]) satisfies mypy, but
+# raises a runtime exception:
+#  TypeError: 'type' object is not subscriptable
+class TemporaryDirectory(tempfile.TemporaryDirectory):  # type: ignore [type-arg]
+    def __init__(self, suffix: Optional[str] = None, prefix: Optional[str] = None):
+        """In the GitHub Actions Windows runner the default TMPDIR directory is on a
+        different drive (C:\\) than the code and test data files (D:\\). This was causing
+        failures in os.path.relpath on Windows, so we put the temp directories in the
+        current working directory instead. There os a "tmp*" line in the .gitignore file
+        that ignores these directories."""
+        super().__init__(suffix=suffix, prefix=prefix, dir=os.getcwd())

tests/validation/test_validate.py

@@ -5,15 +5,14 @@
 from pystac.utils import get_opt
 import shutil
 import unittest
-from tempfile import TemporaryDirectory
 
 import jsonschema
 
 import pystac
 import pystac.validation
 from pystac.cache import CollectionCache
 from pystac.serialization.common_properties import merge_common_properties
-from tests.utils import TestCases
+from tests.utils import TestCases, TemporaryDirectory
 
 
 class ValidateTest(unittest.TestCase):
@@ -99,7 +98,7 @@ def test_validate_all(self) -> None:
         # Modify a 0.8.1 collection in a catalog to be invalid with a
         # since-renamed extension and make sure it catches the validation error.
 
-        with TemporaryDirectory(dir=os.getcwd()) as tmp_dir:
+        with TemporaryDirectory() as tmp_dir:
             dst_dir = os.path.join(tmp_dir, "catalog")
             # Copy test case 7 to the temporary directory
             catalog_href = get_opt(TestCases.test_case_7().get_self_href())