def test_download(self, mockrepo, mockannotate, mockexport,
mocks3_upload):
# use mock to simulate volume being exported
mockobj = MagicMock()
mockobj.pid = 'vol:1'
# use queryset of annotations for testing
annotations = Annotation.objects.all()
mockobj.annotations.return_value.filter.return_value = annotations
mockrepo.return_value.get_object.return_value = mockobj
# s3 upload returns the url where the zipfile can be downloaded
mocks3_upload.return_value = 'http://samp.le/file/download.zip'
Group(u"notify-tester").add(u'test-channel')
Channel('volume-export').send({
'formdata': {
'pid': 'vol:1', 'annotations': 'user', 'mode': 'download',
'page_one': '5', 'image_hosting': 'readux_hosted',
'deep_zoom': 'include'
},
'user': self.testuser.username
})
volume_export(self.get_next_message(u"volume-export", require=True))
mockannotate.annotated_tei.assert_called_with(
mockobj.generate_volume_tei.return_value, annotations)
vol_exporter = mockexport.VolumeExport.return_value
vol_exporter.website_zip.assert_called_with()
export_init_args, export_init_kwargs = mockexport.VolumeExport.call_args
self.assertEqual(mockobj, export_init_args[0])
self.assertEqual(mockannotate.annotated_tei.return_value,
export_init_args[1])
# values from form should be passed through
self.assertEqual(5, export_init_kwargs['page_one'])
self.assertEqual('include', export_init_kwargs['deep_zoom'])
# expected progress updates in order
status_updates = [
'Export started',
AnnotatedVolumeExport.github_account_msg,
'Collected 0 annotations',
'Generating volume TEI',
'Finished generating volume TEI',
'Updating image references in TEI',
'Annotated TEI',
'Generated Jeyll zip file',
'Uploading zip file to Amazon S3',
'Zip file available for download'
]
for expected_msg in status_updates:
msg = json.loads(self.get_next_message(u'test-channel')['text'])
self.assertEqual(expected_msg, msg['message'])
# last message should also have download url
self.assertTrue(msg['download'])
self.assertEqual(mocks3_upload.return_value, msg['download_url'])
def test_invalid(self):
# create a test channel so notify messages can be retrieved
Group(u"notify-tester").add(u'test-channel')
# test invalid form submission
Channel('volume-export').send({
'formdata': {
'pid': 'vol:1', 'annotations': 'user', 'mode': ''
},
'user': self.testuser
})
volume_export(self.get_next_message(u"volume-export", require=True))
msg = json.loads(self.get_next_message(u'test-channel')['text'])
# progress updates - start
self.assertEqual('Export started', msg['message'])
msg = json.loads(self.get_next_message(u'test-channel')['text'])
# progress updates - github account warning
self.assertEqual(AnnotatedVolumeExport.github_account_msg, msg['message'])
self.assertEqual('warning', msg['type'])
# form validation error
msg = json.loads(self.get_next_message(u'test-channel')['text'])
self.assert_('not valid' in msg['message'])
self.assertEqual('error', msg['type'])
self.assert_('form_errors' in msg)
def test_github_update(self, mockrepo, mockannotate, mockexport, mockgithub):
# use mock to simulate volume being exported
mockobj = MagicMock()
mockobj.pid = 'vol:1'
# use queryset of annotations for testing
annotations = Annotation.objects.all()
mockobj.annotations.return_value.filter.return_value = annotations
mockrepo.return_value.get_object.return_value = mockobj
# simulate public repo permissions
mockgithub.GithubApi.connect_as_user.return_value \
.oauth_scopes.return_value = ['public_repo']
# mock url to be returned by export method
pr_url = 'http://github.org/org/repo/pull/1'
vol_exporter = mockexport.VolumeExport.return_value
vol_exporter.update_gitrepo.return_value = pr_url
Group(u"notify-tester").add(u'test-channel')
form_data = {
'pid': 'vol:1', 'annotations': 'user', 'mode': 'github_update',
'page_one': '3', 'update_repo': 'foobar', 'image_hosting': 'readux_hosted',
'deep_zoom': 'include'
}
Channel('volume-export').send({
'formdata': form_data,
'user': self.testuser.username
})
volume_export(self.get_next_message(u"volume-export", require=True))
export_args, export_kwargs = vol_exporter.update_gitrepo.call_args
self.assertEqual(self.testuser, export_args[0])
self.assertEqual('foobar', export_args[1])
# some options now specied when exporter is initalized
export_init_args, export_init_kwargs = mockexport.VolumeExport.call_args
self.assertEqual(mockobj, export_init_args[0])
self.assertEqual(mockannotate.annotated_tei.return_value,
export_init_args[1])
self.assertEqual(3, export_init_kwargs['page_one'])
# check the last message on the notify channel
msg = json.loads(self.get_last_message(u'test-channel')['text'])
self.assertEqual('GitHub jekyll site update completed',
msg['message'])
self.assertTrue(msg['github_update'])
self.assertEqual(pr_url, msg['pullrequest_url'])
self.assertEqual(form_data['update_repo'], msg['repo_url'])
# simulate update error
mockexport.GithubExportException = GithubExportException
vol_exporter.update_gitrepo.side_effect = GithubExportException('Something went wrong')
Channel('volume-export').send({
'formdata': form_data,
'user': self.testuser
})
volume_export(self.get_next_message(u"volume-export", require=True))
msg = json.loads(self.get_last_message(u'test-channel')['text'])
self.assertEqual('Export failed: Something went wrong',
msg['message'])
self.assertEqual('error', msg['type'])
def test_github(self, mockrepo, mockannotate, mockexport, mockgithub):
# use mock to simulate volume being exported
mockobj = MagicMock()
mockobj.pid = 'vol:1'
# use queryset of annotations for testing
annotations = Annotation.objects.all()
mockobj.annotations.return_value.filter.return_value = annotations
mockrepo.return_value.get_object.return_value = mockobj
# mock urls to be returned by export method
repo_url = 'http://github.org/org/repo'
ghpages_url = 'http://org.github.io/repo'
vol_exporter = mockexport.VolumeExport.return_value
vol_exporter.website_gitrepo.return_value = (
repo_url, ghpages_url)
Group(u"notify-tester").add(u'test-channel')
form_data = {
'pid': 'vol:1', 'annotations': 'user', 'mode': 'github',
'page_one': '3', 'github_repo': 'foo', 'image_hosting': 'readux_hosted',
'deep_zoom': 'include'
}
Channel('volume-export').send({
'formdata': form_data,
'user': self.testuser
})
volume_export(self.get_next_message(u"volume-export", require=True))
# insufficient github perms
status_updates = [
'Export started',
AnnotatedVolumeExport.github_scope_msg,
]
for expexted_msg in status_updates:
msg = json.loads(self.get_next_message(u'test-channel')['text'])
self.assertEqual(expexted_msg, msg['message'])
# simulate public repo permissions
mockgithub.GithubApi.connect_as_user.return_value \
.oauth_scopes.return_value = ['public_repo']
Channel('volume-export').send({
'formdata': form_data,
'user': self.testuser
})
volume_export(self.get_next_message(u"volume-export", require=True))
export_args, export_kwargs = vol_exporter.website_gitrepo.call_args
self.assertEqual(self.testuser, export_args[0])
self.assertEqual('foo', export_args[1])
export_init_args, export_init_kwargs = mockexport.VolumeExport.call_args
self.assertEqual(mockobj, export_init_args[0])
self.assertEqual(mockannotate.annotated_tei.return_value,
export_init_args[1])
self.assertEqual(3, export_init_kwargs['page_one'])
status_updates = [
'Export started',
'Collected 0 annotations',
'Generating volume TEI',
'Finished generating volume TEI',
'Updating image references in TEI',
'Annotated TEI',
'Export to GitHub complete',
]
for expexted_msg in status_updates:
msg = json.loads(self.get_next_message(u'test-channel')['text'])
self.assertEqual(expexted_msg, msg['message'])
# last message should also have download url
self.assertTrue(msg['github_export'])
self.assertEqual(repo_url, msg['repo_url'])
self.assertEqual(ghpages_url, msg['ghpages_url'])
# github error
Channel('volume-export').send({
'formdata': form_data,
'user': self.testuser
})
mockexport.GithubExportException = GithubExportException
vol_exporter.website_gitrepo.side_effect = GithubExportException('Repository already exists')
volume_export(self.get_next_message(u"volume-export", require=True))
# the last message on the notify channel should have the error
msg = json.loads(self.get_last_message(u'test-channel')['text'])
self.assertEqual('Export failed: Repository already exists',
msg['message'])
self.assertEqual('error', msg['type'])