def __run_resource_and_result_test(self):
global CURRENT_REQUEST
# go through each file and result object
for path, comparison in RESOURCE_AND_RESULT.iteritems():
# construct a request object, using the provenance/source url as the provider url
record = {}
record['bibjson'] = {}
record['provider'] = {}
record['provider']['url'] = [comparison['provenance']['source']]
record = models.MessageObject(record=record)
# set the current request so that the monkey patch knows how to respond
CURRENT_REQUEST = comparison['provenance']['source']
# run the plugin
p = MyPlugin()
p.license_detect(record)
record = record.record
# check if all the top-level keys were created
assert "bibjson" in record
assert "license" in record['bibjson'], 'While testing with ' + path
assert record['bibjson']['license'] is not None
assert len(record['bibjson']['license']) == 1 # only 1
# license was detected
# The rules for the comparison licence object are:
# - if a key has a value, there resulting object's value must match exactly
# - if a key has been omitted, it will not be tested
# - if a key's value is the empty string, the resulting object's key's value must be the empty string
# - if a key's value is None, the resulting object MUST NOT have the key or MUST be the empty string
# - if a key's value is -1, the resulting object MUST have the key
licence = record['bibjson']['license'][0]
for key, value in comparison.iteritems():
if key == "provenance":
# for better layout of code, let's do provenance separately
continue
if value is None:
# the resulting object MUST NOT have the key or MUST be the empty string
assert key not in licence or licence.get(key) == "", ((key, value), licence.get(key))
elif value == -1:
# the resulting object MUST have the key
assert key in licence, ((key, value), licence.get(key))
else:
# the resulting object must match the comparison object
assert value == licence.get(key), ((key, value), licence.get(key))
prov = licence.get("provenance", {})
for key, value in comparison.get("provenance", {}).iteritems():
if value is None:
# the resulting object MUST NOT have the key
assert key not in prov or prov.get(key) == "", ((key, value), prov.get(key))
elif value == -1:
# the resulting object MUST have the key
assert key in prov, ((key, value), prov.get(key))
else:
# the resulting object must match the comparison object
assert value == prov.get(key), ((key, value), prov.get(key))
def test_03_name_and_version(self):
"""
Take an example supported article and check just the handler fields
"""
record = {}
record['bibjson'] = {}
record['provider'] = {}
record['provider']['url'] = ['http://www.bmj.com/content/345/bmj.e8050']
record = models.MessageObject(record=record)
bmj = BMJPlugin()
bmj.license_detect(record)
record = record.record
# just barebones checks to make sure the license and provenance objects
# exist in the first place so the handler fields can be checked
assert record['bibjson'].has_key('license')
assert record['bibjson']['license']
assert 'provenance' in record['bibjson']['license'][-1]
assert 'handler' in record['bibjson']['license'][-1]['provenance']
assert record['bibjson']['license'][-1]['provenance']['handler'] == 'bmj'
assert record['bibjson']['license'][-1]['provenance']['handler_version'] == '0.1'
def test_05_bmj_NC3_license(self):
record = {}
record['bibjson'] = {}
record['provider'] = {}
record['provider']['url'] = ['http://thorax.bmj.com/content/68/1/82']
record = models.MessageObject(record=record)
bmj = BMJPlugin()
bmj.license_detect(record)
record = record.record
# check if all the important keys were created
assert record['bibjson'].has_key('license')
assert record['bibjson']['license']
# NB: some examples may fail the 'url' test since the Open Definition
# data we're using as the basis for our licenses dictionary does not
# have 'url' for all licenses. Fix by modifying licenses.py - add the data.
assert all (key in record['bibjson']['license'][-1] for key in keys_in_license)
assert all (key in record['bibjson']['license'][-1]['provenance'] for key in keys_in_provenance)
# some content checks now
assert record['bibjson']['license'][-1]['type'] == 'cc-nc'
assert record['bibjson']['license'][-1]['version'] == '3.0'
assert 'id' not in record['bibjson']['license'][-1] # should not have "id" - due to bibserver
assert not record['bibjson']['license'][-1]['jurisdiction']
assert not record['bibjson']['license'][-1]['open_access']
assert record['bibjson']['license'][-1]['BY']
assert record['bibjson']['license'][-1]['NC']
assert not record['bibjson']['license'][-1]['SA']
assert not record['bibjson']['license'][-1]['ND']
# In this case we also expect the BMJ plugin to overwrite the ['license']['url']
# property with a more specific one from the license statement.
assert record['bibjson']['license'][-1]['url'] == 'http://creativecommons.org/licenses/by-nc/3.0'
assert record['bibjson']['license'][-1]['provenance']['agent'] == config.agent
assert record['bibjson']['license'][-1]['provenance']['source'] == record['provider']['url'][0]
assert record['bibjson']['license'][-1]['provenance']['date']
assert record['bibjson']['license'][-1]['provenance']['category'] == 'page_scrape'
assert record['bibjson']['license'][-1]['provenance']['description'] == 'License decided by scraping the resource at ' + record['provider']['url'][0] + ' and looking for the following license statement: "' \
+ 'This is an open-access article distributed under the terms of the Creative Commons Attribution Non-commercial License, which permits use, distribution, and reproduction in any medium, provided the original work is properly cited, the use is non commercial and is otherwise in compliance with the license. See: <a href="http://creativecommons.org/licenses/by-nc/3.0/">http://creativecommons.org/licenses/by-nc/3.0/</a>".'
def test_04_bmj_standard_OA_license_example1(self):
record = {}
record['bibjson'] = {}
record['provider'] = {}
record['provider']['url'] = ['http://gut.bmj.com/content/early/2013/08/20/gutjnl-2013-305008']
record = models.MessageObject(record=record)
bmj = BMJPlugin()
bmj.license_detect(record)
record = record.record
# check if all the important keys were created
assert record['bibjson'].has_key('license')
assert record['bibjson']['license']
# NB: some examples may fail the 'url' test since the Open Definition
# data we're using as the basis for our licenses dictionary does not
# have 'url' for all licenses. Fix by modifying licenses.py - add the data.
assert all (key in record['bibjson']['license'][-1] for key in keys_in_license)
assert all (key in record['bibjson']['license'][-1]['provenance'] for key in keys_in_provenance)
# some content checks now
assert record['bibjson']['license'][-1]['type'] == 'cc-by'
assert record['bibjson']['license'][-1]['version'] == '3.0'
assert 'id' not in record['bibjson']['license'][-1] # should not have "id" - due to bibserver
assert not record['bibjson']['license'][-1]['jurisdiction']
assert record['bibjson']['license'][-1]['open_access']
assert record['bibjson']['license'][-1]['BY']
assert not record['bibjson']['license'][-1]['NC']
assert not record['bibjson']['license'][-1]['SA']
assert not record['bibjson']['license'][-1]['ND']
# In this case we also expect the BMJ plugin to overwrite the ['license']['url']
# property with a more specific one from the license statement.
assert record['bibjson']['license'][-1]['url'] == 'http://creativecommons.org/licenses/by/3.0/'
assert record['bibjson']['license'][-1]['provenance']['agent'] == config.agent
assert record['bibjson']['license'][-1]['provenance']['source'] == record['provider']['url'][0]
assert record['bibjson']['license'][-1]['provenance']['date']
assert record['bibjson']['license'][-1]['provenance']['category'] == 'page_scrape'
assert record['bibjson']['license'][-1]['provenance']['description'] == 'License decided by scraping the resource at ' + record['provider']['url'][0] + ' and looking for the following license statement: "' \
+ 'This is an Open Access article distributed in accordance with the terms of the Creative Commons Attribution (CC BY 3.0) license, which permits others to distribute, remix, adapt and build upon this work, for commercial use, provided the original work is properly cited. See: <a href="http://creativecommons.org/licenses/by/3.0/">http://creativecommons.org/licenses/by/3.0/</a>".'
def test_02_bmj_supports_fail(self):
bmj = BMJPlugin()
test_urls = ["http://www.plosone.org/", "www.biomedcentral.com", "askjdfsakjdhfsa",
"https://www.biology.oxfordjournals.org/jsafkjsaf"]
for url in test_urls:
assert not bmj.supports({"url" : [url]})
def test_01_bmj_supports_success(self):
bmj = BMJPlugin()
test_urls = ["http://www.bmj.com/content/345/bmj.e8050",
"http://gut.bmj.com/content/early/2013/08/20/gutjnl-2013-305008"]
for url in test_urls:
assert bmj.supports({"url" : [url]}), 'Failed url: ' + url
def test_02_supports_fail(self):
p = MyPlugin()
for url in UNSUPPORTED_URLS:
assert not p.supports({"url" : [url]}), "Failed with URL " + url
def test_01_supports_success(self):
p = MyPlugin()
for url in SUPPORTED_URLS:
assert p.supports({"url" : [url]})