class TestFilesViews(OsfTestCase):
def setUp(self):
super(TestFilesViews, self).setUp()
self.user = AuthUserFactory()
self.auth = ('test', self.user.api_keys[0]._primary_key)
self.consolidated_auth = Auth(user=self.user)
self.project = ProjectFactory(creator=self.user)
self.project.add_addon('osffiles', auth=self.consolidated_auth)
self.node_settings = self.project.get_addon('osffiles')
self.fid = 'firstfile'
self._upload_file(self.fid, 'firstcontent')
def _upload_file(self, name, content, **kwargs):
url = self.project.api_url + 'osffiles/'
res = self.app.post(url,
upload_files=[
('file', name, content),
],
auth=self.auth,
**kwargs)
self.project.reload()
return res
def test_download_file(self):
url = self.project.uploads[0].download_url(self.project)
res = self.app.get(url, auth=self.user.auth).maybe_follow()
assert_equal(res.body, 'firstcontent')
def test_download_file_by_version_with_bad_version_value(self):
url = self.project.web_url_for('download_file_by_version',
fid=self.fid,
vid='bad')
res = self.app.get(url, auth=self.user.auth, expect_errors=True)
assert_equal(res.status_code, 400)
assert_in('Invalid version', res.body)
def test_download_file_by_version_with_nonexistent_file(self):
url = self.project.web_url_for('download_file_by_version',
fid='notfound',
vid=0)
res = self.app.get(url, auth=self.user.auth, expect_errors=True)
assert_equal(res.status_code, 404)
def test_download_file_by_version_with_bad_version_number(self):
url = self.project.web_url_for('download_file_by_version',
fid=self.fid,
vid=9999)
res = self.app.get(url, auth=self.user.auth, expect_errors=True)
assert_equal(res.status_code, 404)
def test_download_file_by_version_with_negative_version_number(self):
url = self.project.web_url_for('download_file_by_version',
fid=self.fid,
vid=-1)
res = self.app.get(url, auth=self.user.auth, expect_errors=True)
assert_equal(res.status_code, 400)
def test_upload_file(self):
node_addon = self.project.get_addon('osffiles')
res = self._upload_file('newfile',
'a' * (node_addon.config.max_file_size))
self.project.reload()
assert_equal(self.project.logs[-1].action, 'file_added')
assert_equal(res.status_code, 201)
assert_true(isinstance(res.json, dict), 'return value is a dict')
assert_equal(res.json['name'], 'newfile')
assert_in('newfile', self.project.files_current)
def test_upload_file_unicode_name(self):
node_addon = self.project.get_addon('osffiles')
res = self._upload_file('_néwfile',
'a' * (node_addon.config.max_file_size))
self.project.reload()
assert_equal(self.project.logs[-1].action, 'file_added')
assert_equal(res.status_code, 201)
assert_true(isinstance(res.json, dict), 'return value is a dict')
assert_equal(res.json['name'], '_newfile')
assert_in('_newfile', self.project.files_current)
def test_upload_file_too_large(self):
node_addon = self.project.get_addon('osffiles')
res = self._upload_file(
'newfile',
'a' * (node_addon.config.max_file_size + 1),
expect_errors=True,
)
self.project.reload()
assert_equal(res.status_code, 400)
assert_not_in('newfile', self.project.files_current)
def test_file_info(self):
# Upload a new version of firstfile
self._upload_file(self.fid, 'secondcontent')
url = self.project.api_url_for('file_info',
fid=self.project.uploads[0].filename)
res = self.app.get(url, auth=self.user.auth)
assert_equal(res.status_code, 200)
file_obj = self.project.get_file_object(self.fid, version=1)
data = res.json
assert_equal(data['file_name'], self.fid)
assert_equal(data['registered'], self.project.is_registration)
assert_equal(len(data['versions']), 2)
assert_equal(data['urls']['files'],
self.project.web_url_for('collect_file_trees'))
assert_equal(data['urls']['latest']['download'],
file_obj.download_url(self.project))
assert_equal(data['urls']['api'], file_obj.api_url(self.project))
version = res.json['versions'][0]
assert_equal(version['file_name'], self.fid)
assert_equal(version['version_number'], 2)
assert_equal(version['modified_date'],
file_obj.date_uploaded.strftime('%Y/%m/%d %I:%M %p'))
assert_in('downloads', version)
assert_equal(version['committer_name'], file_obj.uploader.fullname)
assert_equal(version['committer_url'], file_obj.uploader.url)
def test_file_info_with_anonymous_link(self):
link = PrivateLinkFactory(anonymous=True)
link.nodes.append(self.project)
link.save()
self._upload_file('firstfile', 'secondcontent')
url = self.project.api_url_for('file_info',
fid=self.project.uploads[0].filename)
res = self.app.get(url, {'view_only': link.key})
assert_not_in(self.user.fullname, res.body)
assert_not_in(self.user._id, res.body)
def test_delete_file(self):
url = self.project.api_url_for('delete_file', fid=self.fid)
res = self.app.delete(url, auth=self.auth).maybe_follow()
assert_equal(res.status_code, 200)
self.project.reload()
assert_not_in('firstfile', self.project.files_current)
def test_delete_file_returns_404_when_file_is_already_deleted(self):
self.project.remove_file(Auth(self.project.creator), self.fid)
url = self.project.api_url_for('delete_file', fid=self.fid)
res = self.app.delete_json(url,
auth=self.user.auth,
expect_errors=True)
assert_equal(res.status_code, 404)
def test_file_urls(self):
url = self.project.api_url + 'osffiles/hgrid/'
res = self.app.get(url, auth=self.auth).maybe_follow()
assert_equal(len(res.json), 1)
for url in ['view', 'download', 'delete']:
assert_in(self.project._id, res.json[0]['urls'][url])
def test_file_urls_fork(self):
fork = self.project.fork_node(auth=Auth(user=self.user))
url = fork.api_url + 'osffiles/hgrid/'
res = self.app.get(url, auth=self.auth).maybe_follow()
assert_equal(len(res.json), 1)
for url in ['view', 'download', 'delete']:
assert_in(fork._id, res.json[0]['urls'][url])
def test_file_urls_registration(self):
registration = self.project.register_node(None, Auth(user=self.user),
'', '')
url = registration.api_url + 'osffiles/hgrid/'
res = self.app.get(url, auth=self.auth).maybe_follow()
assert_equal(len(res.json), 1)
for url in ['view', 'download', 'delete']:
assert_in(registration._id, res.json[0]['urls'][url])
def test_view_creates_guid(self):
guid_fid = 'unique'
guid_content = 'snowflake'
self._upload_file(guid_fid, guid_content)
node_file = NodeFile.load(self.project.files_current[guid_fid])
guid_count = OsfGuidFile.find().count()
# View file for the first time
url = node_file.url(self.project)
res = self.app.get(
url,
auth=self.user.auth,
).follow(auth=self.user.auth, )
guid = OsfGuidFile.find_one(
Q('node', 'eq', self.project) & Q('name', 'eq', guid_fid))
# GUID count has been incremented by one
assert_equal(OsfGuidFile.find().count(), guid_count + 1)
# Client has been redirected to GUID
assert_equal(
res.request.path.strip('/'),
guid._id,
)
# View file for the second time
self.app.get(
url,
auth=self.user.auth,
).follow(auth=self.user.auth, )
# GUID count has not been incremented
assert_equal(OsfGuidFile.find().count(), guid_count + 1)
def test_guid_url_returns_404(self):
f = NodeFile()
f.save()
url = '/{}/'.format(f._id)
res = self.app.get(url, expect_errors=True)
assert_equal(res.status_code, 404)
def test_sees_delete_button_if_can_write(self):
url = self.project.uploads[0].url(self.project)
res = self.app.get(
url,
auth=self.user.auth,
).maybe_follow(auth=self.user.auth, )
assert_in('Download', res)
assert_in('Delete', res)
def test_does_not_see_delete_button_if_cannot_write(self):
self.project.is_public = True
self.project.save()
user2 = AuthUserFactory()
url = self.project.uploads[0].url(self.project)
res = self.app.get(
url,
auth=user2.auth,
).maybe_follow(auth=user2.auth, )
assert_in('Download', res)
assert_not_in('Delete', res)
class TestFilesViews(OsfTestCase):
def setUp(self):
super(TestFilesViews, self).setUp()
self.user = AuthUserFactory()
self.auth = ('test', self.user.api_keys[0]._primary_key)
self.consolidated_auth = Auth(user=self.user)
self.project = ProjectFactory(creator=self.user)
self.project.add_addon('osffiles', auth=self.consolidated_auth)
self.node_settings = self.project.get_addon('osffiles')
self.fid = 'firstfile'
self._upload_file(self.fid, 'firstcontent')
def _upload_file(self, name, content, **kwargs):
url = self.project.api_url + 'osffiles/'
res = self.app.post(
url,
upload_files=[
('file', name, content),
],
auth=self.auth,
**kwargs
)
self.project.reload()
return res
def test_download_file(self):
url = self.project.uploads[0].download_url(self.project)
res = self.app.get(url, auth=self.user.auth).maybe_follow()
assert_equal(res.body, 'firstcontent')
def test_download_file_by_version_with_bad_version_value(self):
url = self.project.web_url_for('download_file_by_version',
fid=self.fid,
vid='bad'
)
res = self.app.get(url, auth=self.user.auth, expect_errors=True)
assert_equal(res.status_code, 400)
assert_in('Invalid version', res.body)
def test_download_file_by_version_with_nonexistent_file(self):
url = self.project.web_url_for(
'download_file_by_version',
fid='notfound',
vid=0
)
res = self.app.get(url, auth=self.user.auth, expect_errors=True)
assert_equal(res.status_code, 404)
def test_download_file_by_version_with_bad_version_number(self):
url = self.project.web_url_for(
'download_file_by_version',
fid=self.fid,
vid=9999
)
res = self.app.get(url, auth=self.user.auth, expect_errors=True)
assert_equal(res.status_code, 404)
def test_download_file_by_version_with_negative_version_number(self):
url = self.project.web_url_for(
'download_file_by_version',
fid=self.fid,
vid=-1
)
res = self.app.get(url, auth=self.user.auth, expect_errors=True)
assert_equal(res.status_code, 400)
def test_upload_file(self):
node_addon = self.project.get_addon('osffiles')
res = self._upload_file(
'newfile',
'a' * (node_addon.config.max_file_size)
)
self.project.reload()
assert_equal(
self.project.logs[-1].action,
'file_added'
)
assert_equal(res.status_code, 201)
assert_true(isinstance(res.json, dict), 'return value is a dict')
assert_equal(res.json['name'], 'newfile')
assert_in('newfile', self.project.files_current)
def test_upload_file_unicode_name(self):
node_addon = self.project.get_addon('osffiles')
res = self._upload_file(
'_néwfile',
'a' * (node_addon.config.max_file_size)
)
self.project.reload()
assert_equal(
self.project.logs[-1].action,
'file_added'
)
assert_equal(res.status_code, 201)
assert_true(isinstance(res.json, dict), 'return value is a dict')
assert_equal(res.json['name'], '_newfile')
assert_in('_newfile', self.project.files_current)
def test_upload_file_too_large(self):
node_addon = self.project.get_addon('osffiles')
res = self._upload_file(
'newfile',
'a' * (node_addon.config.max_file_size + 1),
expect_errors=True,
)
self.project.reload()
assert_equal(res.status_code, 400)
assert_not_in('newfile', self.project.files_current)
def test_file_info(self):
# Upload a new version of firstfile
self._upload_file(self.fid, 'secondcontent')
url = self.project.api_url_for('file_info', fid=self.project.uploads[0].filename)
res = self.app.get(url, auth=self.user.auth)
assert_equal(res.status_code, 200)
file_obj = self.project.get_file_object(self.fid, version=1)
data = res.json
assert_equal(data['file_name'], self.fid)
assert_equal(data['registered'], self.project.is_registration)
assert_equal(len(data['versions']), 2)
assert_equal(data['urls']['files'], self.project.web_url_for('collect_file_trees'))
assert_equal(data['urls']['latest']['download'], file_obj.download_url(self.project))
assert_equal(data['urls']['api'], file_obj.api_url(self.project))
version = res.json['versions'][0]
assert_equal(version['file_name'], self.fid)
assert_equal(version['version_number'], 2)
assert_equal(version['modified_date'], file_obj.date_uploaded.strftime('%Y/%m/%d %I:%M %p'))
assert_in('downloads', version)
assert_equal(version['committer_name'], file_obj.uploader.fullname)
assert_equal(version['committer_url'], file_obj.uploader.url)
def test_file_info_with_anonymous_link(self):
link = PrivateLinkFactory(anonymous=True)
link.nodes.append(self.project)
link.save()
self._upload_file('firstfile', 'secondcontent')
url = self.project.api_url_for(
'file_info', fid=self.project.uploads[0].filename
)
res = self.app.get(url, {'view_only': link.key})
assert_not_in(self.user.fullname, res.body)
assert_not_in(self.user._id, res.body)
def test_delete_file(self):
url = self.project.api_url_for('delete_file', fid=self.fid)
res = self.app.delete(url, auth=self.auth).maybe_follow()
assert_equal(res.status_code, 200)
self.project.reload()
assert_not_in('firstfile', self.project.files_current)
def test_delete_file_returns_404_when_file_is_already_deleted(self):
self.project.remove_file(Auth(self.project.creator), self.fid)
url = self.project.api_url_for('delete_file', fid=self.fid)
res = self.app.delete_json(url, auth=self.user.auth, expect_errors=True)
assert_equal(res.status_code, 404)
def test_file_urls(self):
url = self.project.api_url + 'osffiles/hgrid/'
res = self.app.get(url, auth=self.auth).maybe_follow()
assert_equal(len(res.json), 1)
for url in ['view', 'download', 'delete']:
assert_in(
self.project._id,
res.json[0]['urls'][url]
)
def test_file_urls_fork(self):
fork = self.project.fork_node(auth=Auth(user=self.user))
url = fork.api_url + 'osffiles/hgrid/'
res = self.app.get(url, auth=self.auth).maybe_follow()
assert_equal(len(res.json), 1)
for url in ['view', 'download', 'delete']:
assert_in(
fork._id,
res.json[0]['urls'][url]
)
def test_file_urls_registration(self):
registration = self.project.register_node(
None, Auth(user=self.user), '', ''
)
url = registration.api_url + 'osffiles/hgrid/'
res = self.app.get(url, auth=self.auth).maybe_follow()
assert_equal(len(res.json), 1)
for url in ['view', 'download', 'delete']:
assert_in(
registration._id,
res.json[0]['urls'][url]
)
def test_view_creates_guid(self):
guid_fid = 'unique'
guid_content = 'snowflake'
self._upload_file(guid_fid, guid_content)
node_file = NodeFile.load(self.project.files_current[guid_fid])
guid_count = OsfGuidFile.find().count()
# View file for the first time
url = node_file.url(self.project)
res = self.app.get(
url,
auth=self.user.auth,
).follow(
auth=self.user.auth,
)
guid = OsfGuidFile.find_one(
Q('node', 'eq', self.project) &
Q('name', 'eq', guid_fid)
)
# GUID count has been incremented by one
assert_equal(
OsfGuidFile.find().count(),
guid_count + 1
)
# Client has been redirected to GUID
assert_equal(
res.request.path.strip('/'),
guid._id,
)
# View file for the second time
self.app.get(
url,
auth=self.user.auth,
).follow(
auth=self.user.auth,
)
# GUID count has not been incremented
assert_equal(
OsfGuidFile.find().count(),
guid_count + 1
)
def test_guid_url_returns_404(self):
f = NodeFile()
f.save()
url = '/{}/'.format(f._id)
res = self.app.get(url, expect_errors=True)
assert_equal(res.status_code, 404)
def test_sees_delete_button_if_can_write(self):
url = self.project.uploads[0].url(self.project)
res = self.app.get(
url,
auth=self.user.auth,
).maybe_follow(
auth=self.user.auth,
)
assert_in('Download', res)
assert_in('Delete', res)
def test_does_not_see_delete_button_if_cannot_write(self):
self.project.is_public = True
self.project.save()
user2 = AuthUserFactory()
url = self.project.uploads[0].url(self.project)
res = self.app.get(
url,
auth=user2.auth,
).maybe_follow(
auth=user2.auth,
)
assert_in('Download', res)
assert_not_in('Delete', res)
