def test_get_last_harvest_time_with_objects_in_the_system(
self, mock_client):
"""
SCENARIO: There are valid objects in the system and we ask for the
last harvest time.
EXPECTED RESULT: The last harvest time is earlier than logically
possible.
"""
# We need to dive pretty deep to mock everything out here.
the_time = dt.datetime(1900, 1, 1, 0, 0, 0)
mock_objectInfo = Mock()
mock_objectInfo.return_value.dateSysMetadataModified = the_time
config = {
# So there's at least one object.
'return_value.listObjects.return_value.total':
1,
# That first object has a specific date attached to it.
'return_value.listObjects.return_value.objectInfo':
[mock_objectInfo()], # noqa: E501
}
mock_client.configure_mock(**config)
client_mgr = D1ClientManager(self.gmn_base_url, self.auth_cert,
self.auth_cert_key, self.mock_logger)
time = client_mgr.get_last_harvest_time()
self.assertEqual(time, '1900-01-01T00:00:00Z')
def test_positive_check_if_identifier_exists(self, mock_client):
"""
SCENARIO: An identifier already exists in the system.
EXPECTED RESULT: A dictionary of expected information.
"""
expected_date = '1900-01-01'
expected_version_id = 'v2'
config = {
'return_value.getSystemMetadata.return_value.dateUploaded':
expected_date, # noqa: E501
'return_value.getSystemMetadata.return_value.identifier.value.return_value':
expected_version_id, # noqa: E501
}
mock_client.configure_mock(**config)
# mock_client.return_value.getSystemMetadata.return_value = expected
client_mgr = D1ClientManager(self.gmn_base_url, self.auth_cert,
self.auth_cert_key, self.mock_logger)
actual = client_mgr.check_if_identifier_exists('thing')
expected = {
'outcome': 'yes',
'record_date': expected_date,
'current_version_id': expected_version_id,
}
self.assertEqual(actual, expected)
def test_update_science_metadata_fails(self, mock_client):
"""
SCENARIO: A new science metadata record is not successfully updated
because the update routine errors out for some reason.
EXPECTED RESULT: False, and the failure is logged at the error level.
"""
mock_client.return_value.update.side_effect = RuntimeError(
'something bad happened') # noqa: E501
sci_metadata_bytes = ir.read_binary('tests.data.ieda', '600121iso.xml')
sid = 'i_am_a_sid'
record_date = dt.datetime.now().isoformat()
old_version_pid = 'b645a195302ca652ec39f1bf3b908dbf'
client_mgr = D1ClientManager(self.gmn_base_url, self.auth_cert,
self.auth_cert_key, self.mock_logger)
system_metadata = self._generate_system_metadata(
sci_metadata_bytes, sid, old_version_pid, record_date)
actual = client_mgr.update_science_metadata(
sci_metadata_bytes=sci_metadata_bytes,
native_identifier_sid=sid,
record_date=record_date,
old_version_pid=old_version_pid,
system_metadata=system_metadata)
self.assertFalse(actual)
self.assertEqual(self.mock_logger.error.call_count, 1)
def test_update_science_metadata(self, mock_client):
"""
SCENARIO: A new science metadata record is successfully loaded.
EXPECTED RESULT: True
"""
sci_metadata_bytes = ir.read_binary('tests.data.ieda', '600121iso.xml')
sid = 'i_am_a_sid'
record_date = dt.datetime.now().isoformat()
old_version_pid = 'b645a195302ca652ec39f1bf3b908dbf'
client_mgr = D1ClientManager(
self.gmn_base_url, self.auth_cert, self.auth_cert_key,
self.mock_logger
)
system_metadata = self._generate_system_metadata(sci_metadata_bytes,
sid,
old_version_pid,
record_date)
actual = client_mgr.update_science_metadata(
sci_metadata_bytes=sci_metadata_bytes,
native_identifier_sid=sid,
record_date=record_date,
old_version_pid=old_version_pid,
system_metadata=system_metadata
)
self.assertTrue(actual)
def test_archive_science_metadata(self, mock_client):
"""
SCENARIO: A science metadata record is successfully archived.
EXPECTED RESULT: True
"""
current_version_pid = 'b645a195302ca652ec39f1bf3b908dbf'
client_mgr = D1ClientManager(self.gmn_base_url, self.auth_cert,
self.auth_cert_key, self.mock_logger)
actual = client_mgr.archive_science_metadata(current_version_pid)
self.assertTrue(actual)
def test_verify_tls(self, mock_client):
"""
SCENARIO: Paths to a client side cert and key are provided.
EXPECTED RESULT: No error on initialization.
"""
D1ClientManager(
self.gmn_base_url,
'/path/to/cert', '/path/to/key',
self.mock_logger,
)
self.assertTrue(True)
def test_get_last_harvest_time_shows_no_objects_are_there(
self, mock_client):
"""
SCENARIO: There are no objects in the system and we ask for the last
harvest time.
EXPECTED RESULT: The last harvest time is earlier than logically
possible.
"""
mock_client.return_value.listObjects.return_value.total = 0
client_mgr = D1ClientManager(self.gmn_base_url, self.auth_cert,
self.auth_cert_key, self.mock_logger)
time = client_mgr.get_last_harvest_time()
self.assertEqual(time, '1900-01-01T00:00:00Z')
def test_negative_check_if_identifier_exists(self, mock_client):
"""
SCENARIO: An identifier does not exists in the system.
EXPECTED RESULT: A dictionary of expected information.
"""
mock_client.return_value.getSystemMetadata.side_effect = d1_common.types.exceptions.NotFound(
'bad') # noqa: E501
client_mgr = D1ClientManager(self.gmn_base_url, self.auth_cert,
self.auth_cert_key, self.mock_logger)
actual = client_mgr.check_if_identifier_exists('thing')
expected = {
'outcome': 'no',
}
self.assertEqual(actual, expected)
def test_get_last_harvest_time_fails(self, mock_sys_exit, mock_client):
"""
SCENARIO: We fail to get the last harvest time.
EXPECTED RESULT: There are two calls to the logger at the error level.
The system attempts to exit.
"""
# This causes the failure.
mock_client.return_value.listObjects.side_effect = RuntimeError(
'something bad') # noqa: E501
client_mgr = D1ClientManager(self.gmn_base_url, self.auth_cert,
self.auth_cert_key, self.mock_logger)
client_mgr.get_last_harvest_time()
self.assertEqual(mock_sys_exit.call_count, 1)
self.assertEqual(self.mock_logger.error.call_count, 2)
def test_archive_science_metadata_fails(self, mock_client):
"""
SCENARIO: A science metadata record is not successfully archived
because the archive routine errors out for some reason.
EXPECTED RESULT: False, and the failure is logged at the error level.
"""
mock_client.return_value.archive.side_effect = RuntimeError(
'something bad happened') # noqa: E501
current_version_pid = 'b645a195302ca652ec39f1bf3b908dbf'
client_mgr = D1ClientManager(self.gmn_base_url, self.auth_cert,
self.auth_cert_key, self.mock_logger)
actual = client_mgr.archive_science_metadata(current_version_pid)
self.assertFalse(actual)
self.assertEqual(self.mock_logger.error.call_count, 2)
def test_unknown_exception_check_if_identifier_exists(self, mock_client):
"""
SCENARIO: An unexpected exception happened when we checked for the
given identifier.
EXPECTED RESULT: A dictionary of expected information and the
exception is logged.
"""
mock_client.return_value.getSystemMetadata.side_effect = RuntimeError(
'bad') # noqa: E501
client_mgr = D1ClientManager(self.gmn_base_url, self.auth_cert,
self.auth_cert_key, self.mock_logger)
actual = client_mgr.check_if_identifier_exists('thing')
expected = {
'outcome': 'failed',
}
self.assertEqual(actual, expected)
self.assertEqual(self.mock_logger.error.call_count, 1)