def test_list_dirs_remote_dir_not_connected(self):
foo = FtpFileTransfer(None)
self.assertFalse(foo.list_dirs('/foo'))
self.assertEqual(
foo.get_error_msg(), "Unable to get directory list "
"for /foo : 'NoneType' object "
"has no attribute 'list'")
def test_list_dirs_fail(self):
mockftp = MockFtp()
mockftp.list = Mock(side_effect=IOError('error'))
mockftp.close = Mock(return_value=None)
foo = FtpFileTransfer(None)
foo.set_connection(mockftp)
foo.connect()
dirlist = foo.list_dirs('/foo2')
self.assertTrue(dirlist is None)
foo.disconnect()
self.assertEqual(foo.get_error_msg(), 'Unable to get directory list '
'for /foo2 : error')
mockftp.list.assert_called_with('/foo2', extra=True)
def test_list_dirs_success(self):
mockftp = MockFtp()
mockftp.list = Mock(return_value=[{'directory': 'd', 'name': '.'},
{'directory': 'd', 'name': '..'},
{'directory': 'd', 'name': 'foo'},
{'directory': '-', 'name': 'file'}])
mockftp.close = Mock(return_value=None)
foo = FtpFileTransfer(None)
foo.set_connection(mockftp)
foo.connect()
dirlist = foo.list_dirs('/foo')
self.assertTrue(len(dirlist) == 1)
self.assertEqual(dirlist[0], 'foo')
foo.disconnect()
mockftp.list.assert_called_with('/foo', extra=True)
class ExternalDataSubmissionFactory(object):
"""Factory to create ExternalDataSubmissionObjects
"""
DOCKEDRESULTS = '_dockedresults_'
def __init__(self, path, args):
"""Constructor
"""
try:
logger.debug('ftpconfig set to ' + args.ftpconfig)
self._file_transfer = FtpFileTransfer(args.ftpconfig)
except Exception:
logger.exception('Caught exception')
self._file_transfer = None
self._path = path
self._args = args
ctask = ChallengeDataTask(path, args)
self._chall_dir_name = ctask.get_celpp_challenge_data_dir_name()
def get_args(self):
return self._args
def get_path(self):
return self._path
def _get_challenge_package_results_file_name(self, dir_name):
return (self._chall_dir_name +
ExternalDataSubmissionFactory.DOCKEDRESULTS +
dir_name + ChallengeDataTask.TAR_GZ_SUFFIX)
def set_file_transfer(self, filetransfer):
"""Sets file transfer
"""
self._file_transfer = filetransfer
def get_file_transfer(self):
"""Gets file transfer
"""
return self._file_transfer
def _get_submission_dirs(self, remote_dir):
"""Gets list of directories under `remote_dir`
:param remote_dir: path on remote server to examine
:returns: list of directory names without path prefix
:raises AttributeError: if `get_file_transfer()` is None
"""
dlist = self._file_transfer.list_dirs(remote_dir)
if dlist is None:
logger.debug('No directories returned')
return []
logger.debug('Found ' + str(len(dlist)) + ' directories on ' +
remote_dir)
return dlist
def _get_challenge_data_package_file(self, remote_dir, dir_name):
"""Gets challenge data package file under `remote_dir` / `dir_name`
if it exists
:returns: Path to remote challenge file upon success or None if
not found
:raises AttributeError if `get_file_transfer()` is None
"""
ft = self.get_file_transfer()
flist = ft.list_files(os.path.normpath(os.path.join(remote_dir,
dir_name)))
if flist is None:
logger.info('No files found in ' + dir_name)
return None
logger.debug('Found ' + str(len(flist)) + ' files in ' + dir_name)
chall_fname = self._get_challenge_package_results_file_name(dir_name)
logger.debug('Looking for ' + chall_fname + ' file in directory')
for entry in flist:
if entry == chall_fname:
logger.info('Found matching entry ' + entry)
return os.path.normpath(os.path.join(remote_dir,
dir_name,
chall_fname))
else:
logger.debug('Encountered non challenge file: ' + entry)
return None
def _remove_latest_txt(self):
"""Removes the latest.txt file from ftp server if found
"""
try:
ft = self.get_file_transfer()
latest_txt = os.path.join(ft.get_remote_challenge_dir(),
ChallengeDataTask.LATEST_TXT)
logger.info('Attempting to remove ' + latest_txt)
val = ft.delete_file(latest_txt)
logger.info('Return value from delete call ' + str(val))
except Exception:
logger.exception('Caught exception trying to remove latest.txt')
def get_external_data_submissions(self):
"""Generate ExternalDataSubmission objects
Method should examine the submission directory on the
remote server via FtpFileTransfer(args.ftpconfig)
for each directory under submission directory
look for a celpp_weekXX_YYYY_dockedresults_ZZZZ.tar.gz file
where ZZZZ matches name of directory under submission directory
Regardless if its found or not create new ExternalDataSubmission
object and pass ZZZZ for name and path to .tar.gz file as
remotefile if the tar.gz file was found otherwise pass None
along with args. Append this object to list and
return it
"""
task_list = []
try:
self._file_transfer.connect()
self._remove_latest_txt()
subdir = self._file_transfer.get_remote_submission_dir()
dlist = self._get_submission_dirs(subdir)
for d in dlist:
chall_file = self._get_challenge_data_package_file(subdir, d)
if chall_file is not None:
et = ExternalDataSubmissionTask(self.get_path(), d,
chall_file,
self.get_args())
logger.info('Added ExternalData Submission Task: ' +
et.get_dir_name())
task_list.append(et)
except Exception:
logger.exception('Caught exception')
finally:
try:
self._file_transfer.disconnect()
except Exception:
logger.exception('Caught exception disconnecting')
return task_list
def test_list_dirs_remote_dir_none(self):
foo = FtpFileTransfer(None)
self.assertFalse(foo.list_dirs(None))
self.assertEqual(foo.get_error_msg(), 'remote_dir None')
