def test_extension_not_implemented(self) -> None:
# Should raise exception if Item does not include extension URI
item = pystac.Item.from_file(self.example_item_uri)
item.stac_extensions.remove(ScientificExtension.get_schema_uri())
with self.assertRaises(pystac.ExtensionNotImplemented):
_ = ScientificExtension.ext(item)
def test_extension_not_implemented(self) -> None:
# Should raise exception if Collection does not include extension URI
collection = pystac.Collection.from_file(self.example_collection_uri)
collection.stac_extensions.remove(ScientificExtension.get_schema_uri())
with self.assertRaises(pystac.ExtensionNotImplemented):
_ = ScientificExtension.ext(collection)
def test_citation(self) -> None:
ScientificExtension.ext(self.collection).apply(citation=CITATION)
self.assertEqual(CITATION,
ScientificExtension.ext(self.collection).citation)
self.assertIn(scientific.CITATION_PROP, self.collection.extra_fields)
self.assertFalse(self.collection.get_links(ScientificRelType.CITE_AS))
self.collection.validate()
def test_remove_all_publications_with_none(self) -> None:
ScientificExtension.ext(self.collection).apply(DOI)
ScientificExtension.ext(self.collection).remove_publication()
self.assertFalse(ScientificExtension.ext(self.collection).publications)
links = self.collection.get_links(ScientificRelType.CITE_AS)
self.assertEqual(1, len(links))
self.assertEqual(DOI_URL, links[0].target)
self.collection.validate()
def test_remove_all_publications_with_some(self) -> None:
ScientificExtension.ext(self.item).apply(DOI,
publications=PUBLICATIONS)
ScientificExtension.ext(self.item).remove_publication()
self.assertFalse(ScientificExtension.ext(self.item).publications)
links = self.item.get_links(ScientificRelType.CITE_AS)
self.assertEqual(1, len(links))
self.assertEqual(DOI_URL, links[0].target)
self.item.validate()
def test_set_doi_summaries(self) -> None:
collection = self.collection.clone()
sci_summaries = ScientificExtension.summaries(collection)
sci_summaries.doi = [PUB2_DOI]
new_dois = ScientificExtension.summaries(collection).doi
assert new_dois is not None
self.assertListEqual([PUB2_DOI], new_dois)
def test_ext_add_to(self) -> None:
collection = pystac.Collection.from_file(self.example_collection_uri)
collection.stac_extensions.remove(ScientificExtension.get_schema_uri())
self.assertNotIn(ScientificExtension.get_schema_uri(),
collection.stac_extensions)
_ = ScientificExtension.ext(collection, add_if_missing=True)
self.assertIn(ScientificExtension.get_schema_uri(),
collection.stac_extensions)
def test_ext_add_to(self) -> None:
item = pystac.Item.from_file(self.example_item_uri)
item.stac_extensions.remove(ScientificExtension.get_schema_uri())
self.assertNotIn(ScientificExtension.get_schema_uri(),
item.stac_extensions)
_ = ScientificExtension.ext(item, add_if_missing=True)
self.assertIn(ScientificExtension.get_schema_uri(),
item.stac_extensions)
def test_remove_publication_one(self) -> None:
publications = PUBLICATIONS[:1]
ScientificExtension.ext(self.collection).apply(
DOI, publications=publications)
ScientificExtension.ext(self.collection).remove_publication(
publications[0])
self.assertFalse(ScientificExtension.ext(self.collection).publications)
links = self.collection.get_links(ScientificRelType.CITE_AS)
self.assertEqual(1, len(links))
self.assertEqual(DOI_URL, links[0].target)
self.collection.validate()
def test_publications(self) -> None:
ScientificExtension.ext(self.item).apply(publications=PUBLICATIONS)
self.assertEqual(PUBLICATIONS,
ScientificExtension.ext(self.item).publications)
self.assertIn(scientific.PUBLICATIONS_PROP, self.item.properties)
links = self.item.get_links(ScientificRelType.CITE_AS)
doi_urls = [link.get_href() for link in links]
expected = [PUB1_DOI_URL, PUB2_DOI_URL]
self.assertCountEqual(expected, doi_urls)
self.item.validate()
def make_item() -> pystac.Item:
asset_id = "USGS/GAP/CONUS/2011"
start = datetime.datetime(2011, 1, 2)
item = pystac.Item(id=asset_id,
geometry=None,
bbox=None,
datetime=start,
properties={})
item.set_self_href(URL_TEMPLATE % 2011)
ScientificExtension.add_to(item)
return item
def make_collection() -> pystac.Collection:
asset_id = "my/thing"
start = datetime.datetime(2018, 8, 24)
end = start + datetime.timedelta(5, 4, 3, 2, 1)
bboxes = [[-180.0, -90.0, 180.0, 90.0]]
spatial_extent = pystac.SpatialExtent(bboxes)
intervals: List[List[Optional[datetime.datetime]]] = [[start, end]]
temporal_extent = pystac.TemporalExtent(intervals)
extent = pystac.Extent(spatial_extent, temporal_extent)
collection = pystac.Collection(asset_id, "desc", extent)
collection.set_self_href(URL_TEMPLATE % 2019)
ScientificExtension.add_to(collection)
return collection
def test_publications_one(self) -> None:
publications = PUBLICATIONS[:1]
ScientificExtension.ext(
self.collection).apply(publications=publications)
self.assertEqual(publications,
ScientificExtension.ext(self.collection).publications)
self.assertIn(scientific.PUBLICATIONS_PROP,
self.collection.extra_fields)
links = self.collection.get_links(ScientificRelType.CITE_AS)
doi_urls = [link.get_href() for link in links]
expected = [PUB1_DOI_URL]
self.assertCountEqual(expected, doi_urls)
self.collection.validate()
def test_summaries_adds_uri(self) -> None:
collection = self.collection.clone()
collection.stac_extensions = []
self.assertRaisesRegex(
pystac.ExtensionNotImplemented,
r"Could not find extension schema URI.*",
ScientificExtension.summaries,
collection,
False,
)
_ = ScientificExtension.summaries(collection, True)
self.assertIn(ScientificExtension.get_schema_uri(),
collection.stac_extensions)
ScientificExtension.remove_from(collection)
self.assertNotIn(ScientificExtension.get_schema_uri(),
collection.stac_extensions)
def test_doi(self) -> None:
ScientificExtension.ext(self.item).apply(DOI)
self.assertEqual(DOI, ScientificExtension.ext(self.item).doi)
self.assertIn(scientific.DOI_PROP, self.item.properties)
link = self.item.get_links(ScientificRelType.CITE_AS)[0]
self.assertEqual(DOI_URL, link.get_href())
self.item.validate()
# Check that setting the doi does not cause extra links.
# Same doi.
ScientificExtension.ext(self.item).doi = DOI
self.assertEqual(1,
len(self.item.get_links(ScientificRelType.CITE_AS)))
self.item.validate()
# Different doi.
ScientificExtension.ext(self.item).doi = PUB1_DOI
self.assertEqual(1,
len(self.item.get_links(ScientificRelType.CITE_AS)))
link = self.item.get_links(ScientificRelType.CITE_AS)[0]
self.assertEqual(PUB1_DOI_URL, link.get_href())
self.item.validate()
def test_remove_publication_forward(self) -> None:
ScientificExtension.ext(self.item).apply(DOI,
publications=PUBLICATIONS)
ScientificExtension.ext(self.item).remove_publication(PUBLICATIONS[0])
self.assertEqual([PUBLICATIONS[1]],
ScientificExtension.ext(self.item).publications)
links = self.item.get_links(ScientificRelType.CITE_AS)
self.assertEqual(2, len(links))
self.assertEqual(DOI_URL, links[0].target)
self.assertEqual(PUB2_DOI_URL, links[1].target)
self.item.validate()
ScientificExtension.ext(self.item).remove_publication(PUBLICATIONS[1])
self.assertFalse(ScientificExtension.ext(self.item).publications)
links = self.item.get_links(ScientificRelType.CITE_AS)
self.assertEqual(1, len(links))
self.assertEqual(DOI_URL, links[0].target)
self.item.validate()
def test_remove_publication_reverse(self) -> None:
ScientificExtension.ext(self.collection).apply(
DOI, publications=PUBLICATIONS)
ScientificExtension.ext(self.collection).remove_publication(
PUBLICATIONS[1])
self.assertEqual([PUBLICATIONS[0]],
ScientificExtension.ext(self.collection).publications)
links = self.collection.get_links(ScientificRelType.CITE_AS)
self.assertEqual(2, len(links))
self.assertEqual(PUB1_DOI_URL, links[1].target)
self.collection.validate()
ScientificExtension.ext(self.collection).remove_publication(
PUBLICATIONS[0])
links = self.collection.get_links(ScientificRelType.CITE_AS)
self.assertEqual(1, len(links))
self.assertEqual(DOI_URL, links[0].target)
self.collection.validate()
def process_scientific(item, granule):
scientific_extension = ScientificExtension.ext(item, add_if_missing=True)
for attribute in granule.AdditionalAttributes.AdditionalAttribute:
if attribute.Name == "IDENTIFIER_PRODUCT_DOI":
scientific_extension.doi = attribute.Values.Value.cdata
def test_stac_extensions(self) -> None:
self.assertTrue(ScientificExtension.has_extension(self.item))
def test_citation(self) -> None:
ScientificExtension.ext(self.item).apply(citation=CITATION)
self.assertEqual(CITATION, ScientificExtension.ext(self.item).citation)
self.assertIn(scientific.CITATION_PROP, self.item.properties)
self.assertFalse(self.item.get_links(ScientificRelType.CITE_AS))
self.item.validate()
def test_get_citation_summaries(self) -> None:
citations = ScientificExtension.summaries(self.collection).citation
assert citations is not None
self.assertListEqual([CITATION], citations)
def test_get_doi_summaries(self) -> None:
dois = ScientificExtension.summaries(self.collection).doi
assert dois is not None
self.assertListEqual([PUB1_DOI, PUB2_DOI], dois)
def test_set_citation_summaries(self) -> None:
collection = self.collection.clone()
sci_summaries = ScientificExtension.summaries(collection)
sci_summaries.citation = None
self.assertIsNone(sci_summaries.citation)