def test_09_remove_permanent(self):
# Separate an incoming Request from its corresponding PublicAPC, leaving no owners, thus deleting the record
source = RequestFixtureFactory.example()
req = Request(source)
req.owner = "test"
# create a record with 2 distinct apcs from different owners
source2 = PublicAPCFixtureFactory.example()
pub = PublicAPC(source2)
pub.remove_apcs_by_owner("abcdefg") # clear the existing apc record
apc_record = PublicAPCFixtureFactory.apc_record()
del apc_record["ref"] # do this so that the ref gets created correctly later
pub.add_apc_for_owner("test", apc_record) # add a new, known one
pub.save(blocking=True)
# now request the removal
PublicApi.remove(req)
time.sleep(2)
dao = PublicAPC()
pub2 = dao.pull(pub.id)
assert pub2 is None
def test_02_request(self):
# Check we can instantiate and work with a Request
# first make a blank one
req = Request()
# now make one around the fixture
source = RequestFixtureFactory.example()
req = Request(source)
# make one with a broken source
broken = {"whatever" : "broken"}
with self.assertRaises(dataobj.DataStructureException):
req = Request(broken)
# now make one bit by bit
req = Request()
req.record = source.get("record")
req.owner = "test1"
req.action = "update"
req.public_id = "abcdefg"
assert req.owner == "test1"
assert req.action == "update"
assert req.public_id == "abcdefg"
# now make it broken
req = Request()
with self.assertRaises(dataobj.DataStructureException):
req.record = {"random" : "stuff"}
def delete(cls, record, account, public_id=None):
"""
Record a "delete" request, with the associated (minimal) record data, requested by the given account
Delete requests need only come with enough record data to identify the public record
:param record: The mimimal record data for identifying the record
:param account: the account to carry out the request on behalf of
:param public_id: the public id of a public record for which this is a delete request
:return: the Request object that was created
"""
if record is None:
raise RequestAPIException("You can't call 'delete' with a NoneType record argument")
if account is None:
raise RequestAPIException("You can't call 'delete' with a NoneType account argument")
req = Request()
req.record = record
req.owner = account.id
req.action = "delete"
if public_id is not None:
req.public_id = public_id
req.save()
return req
def test_05_request_dao(self):
# Check the DAO methods on the Request object
dao = Request()
source = RequestFixtureFactory.example()
req = Request(source)
req.owner = "test1"
req.action = "update"
req.public_id = "abcdefg"
req.save(blocking=True)
req2 = dao.pull(req.id)
assert req2 is not None
# check successful queries for identifiers
res = dao.find_by_identifier("doi", "10.1234/me", "test1")
assert len(res) == 1
res = dao.find_by_identifier("pmcid", "PMC1234", "test1")
assert len(res) == 1
res = dao.find_by_identifier("pmid", "87654321", "test1")
assert len(res) == 1
res = dao.find_by_identifier("url", "http://example.com/whatever", "test1")
assert len(res) == 1
# check unsuccessful ones
res = dao.find_by_identifier("doi", "10.1234/you", "test1")
assert len(res) == 0
res = dao.find_by_identifier("pmcid", "PMC5678", "test1")
assert len(res) == 0
res = dao.find_by_identifier("pmid", "123456789", "test1")
assert len(res) == 0
res = dao.find_by_identifier("url", "http://example.com/this", "test1")
assert len(res) == 0
# and check using the wrong owner
res = dao.find_by_identifier("doi", "10.1234/me", "test2")
assert len(res) == 0
res = dao.find_by_identifier("pmcid", "PMC1234", "test2")
assert len(res) == 0
res = dao.find_by_identifier("pmid", "87654321", "test2")
assert len(res) == 0
res = dao.find_by_identifier("url", "http://example.com/whatever", "test2")
assert len(res) == 0
def test_06_publish_update(self):
# Publish an update to an existing PublicAPC
merge_source = PublicAPCFixtureFactory.record_merge_source()
merge_target = PublicAPCFixtureFactory.record_merge_target()
apc_record = PublicAPCFixtureFactory.apc_record()
result = PublicAPCFixtureFactory.record_merge_result()
del merge_source["jm:apc"]
del merge_target["jm:apc"]
del result["jm:apc"]
first = deepcopy(apc_record)
second = deepcopy(apc_record)
third = deepcopy(apc_record)
first["organisation_name"] = "First"
del first["ref"]
second["organisation_name"] = "Second"
del second["ref"]
third["organisation_name"] = "Third"
del third["ref"]
req = Request()
req.record = merge_source
req.add_apc_record(first)
req.owner = "11111"
pub = PublicAPC()
pub.record = merge_target
pub.add_apc_for_owner("22222", second)
pub.add_apc_for_owner("11111", third)
pub.save(blocking=True)
PublicApi.publish(req)
dao = PublicAPC()
pub2 = dao.pull(pub.id)
# first check that the apcs are as we would expect
one = pub2.get_apcs_by_owner("11111")
two = pub2.get_apcs_by_owner("22222")
assert len(one) == 1
assert len(two) == 1
assert one[0]["organisation_name"] == "First"
assert two[0]["organisation_name"] == "Second"
# now check that the metadata merge proceeded correctly
record = pub2.record
del record["jm:apc"]
assert record == result
def test_07_separate_records(self):
# Separate an incoming Request from its corresponding PublicAPC
apc_record = PublicAPCFixtureFactory.apc_record()
req = Request()
req.owner = "test"
pub = PublicAPC()
pub.add_apc_for_owner("test", apc_record)
pub.add_apc_for_owner("test", apc_record)
assert len(pub.apc_records) == 2
PublicApi.separate_records(req, pub)
assert not pub.has_apcs()
def update(cls, record, account, public_id=None):
"""
Record an "update" request, with the associated record data, requested by the given account
:param record: The raw dict data (e.g. coming from the web API) which makes up the body of the request
:param account: the account to carry out the request on behalf of
:param public_id: The public id of a public record for which this is an update
:return: the Request object that was created
"""
if record is None:
raise RequestAPIException("You can't call 'update' with a NoneType record argument")
if account is None:
raise RequestAPIException("You can't call 'update' with a NoneType account argument")
req = Request()
req.record = record
req.owner = account.id
req.action = "update"
if public_id is not None:
req.public_id = public_id
req.save()
return req
def test_08_remove_separate(self):
# Separate an incoming Request from its corresponding PublicAPC, leaving only one owner behind
source = RequestFixtureFactory.example()
req = Request(source)
req.owner = "test"
# create a record with 2 distinct apcs from different owners
source2 = PublicAPCFixtureFactory.example()
apc_record = PublicAPCFixtureFactory.apc_record()
del apc_record["ref"] # do this so that the ref gets created correctly later
pub = PublicAPC(source2)
pub.add_apc_for_owner("test", apc_record)
pub.save(blocking=True)
# now request the removal
PublicApi.remove(req)
time.sleep(2)
dao = PublicAPC()
pub2 = dao.pull(pub.id)
assert len(pub2.get_apcs_by_owner("test")) == 0
assert len(pub2.get_apcs_by_owner("abcdefg")) == 1
def test_11_process_requests_cycle(self):
# Run through the process of processing a Request into a PublicAPC
source = RequestFixtureFactory.example()
if "id" in source:
del source["id"]
pub_dao = PublicAPC()
wfs_dao = WorkflowState()
# first make a record for the first time
first = deepcopy(source)
del first["record"]["dc:title"]
req = Request(first)
req.owner = "test"
req.action = "update"
req.save(blocking=True)
# run the job
WorkflowApi.process_requests()
time.sleep(2)
# first check that a public record was made
pubs = pub_dao.find_by_doi("10.1234/me")
assert len(pubs) == 1
assert pubs[0].record.get("dc:title") is None
# check that the workflow state was created
wfs = wfs_dao.pull("requests")
assert wfs is not None
assert wfs.last_request == req.created_date
assert wfs.already_processed == [req.id]
# now run an update with a different date
second = deepcopy(source)
second["record"]["dc:title"] = "Update"
second["created_date"] = "2002-01-01T00:00:00Z"
req2 = Request(second)
req2.owner = "test"
req2.action = "update"
req2.save(blocking=True)
# run the job again
WorkflowApi.process_requests()
time.sleep(2)
# check the public record was updated
pubs = pub_dao.find_by_doi("10.1234/me")
assert len(pubs) == 1
assert pubs[0].record.get("dc:title") == "Update"
# check that the workflow state was updated
wfs = wfs_dao.pull("requests")
assert wfs is not None
assert wfs.last_request == req2.created_date
assert wfs.already_processed == [req2.id]
# now run an update with the same date, to observe the difference in the workflow state
third = deepcopy(source)
third["record"]["dc:title"] = "Update 2"
third["created_date"] = "2002-01-01T00:00:00Z"
req3 = Request(third)
req3.owner = "test"
req3.action = "update"
req3.save(blocking=True)
# run the job again
WorkflowApi.process_requests()
time.sleep(2)
# check the public record was updated
pubs = pub_dao.find_by_doi("10.1234/me")
assert len(pubs) == 1
assert (
pubs[0].record.get("dc:title") == "Update 2"
) # should have been updated, as there are only apc contributions from one source
# check that the workflow state was updated
wfs = wfs_dao.pull("requests")
assert wfs is not None
assert wfs.last_request == req3.created_date
assert wfs.already_processed == [req2.id, req3.id] # processed records should have been appended
# finally issue a delete request
fourth = deepcopy(source)
fourth["created_date"] = "2003-01-01T00:00:00Z"
req4 = Request(fourth)
req4.owner = "test"
req4.action = "delete"
req4.save(blocking=True)
# run the job again
WorkflowApi.process_requests()
time.sleep(2)
# check the public record was updated
pubs = pub_dao.find_by_doi("10.1234/me")
assert len(pubs) == 0
# check that the workflow state was updated
wfs = wfs_dao.pull("requests")
assert wfs is not None
assert wfs.last_request == req4.created_date
assert wfs.already_processed == [req4.id] # processed records should have been appended
