blob: a1f6ed49ffb6549d06e300d5d558b8ed28adf23a [file] [log] [blame]
# Copyright (c) 2010 The Chromium OS Authors. All rights reserved.
# Use of this source code is governed by a BSD-style license that can be
# found in the LICENSE file.
gft_upload: Provides various protocols for uploading report files.
import ftplib
import os
import re
import sys
import time
import urllib
import urlparse
import xmlrpclib
import gft_common
from gft_common import DebugMsg, ErrorDie, ErrorMsg, VerboseMsg, WarningMsg
# Constants
def RetryCommand(callback, message_prefix, interval):
"""Retries running some commands until success.
callback: A callback function to execute specified command, and return
if the result is success. Callback accepts a param to hold session
states, including two special values:
'message' to be logged, and 'abort' to return immediately.
message_prefix: Prefix string to be displayed.
interval: Duration (in seconds) between each retry (0 to disable).
results = {}
# Currently we do endless retry, if interval is assigned.
while not callback(results):
message = results.get('message', 'unknown')
abort = results.get('abort', False)
if (not interval) or abort:
ErrorDie('%s: %s' % (message_prefix, message))
ErrorMsg('%s: %s' % (message_prefix, message))
for i in range(interval, 0, -1):
if i % 10 == 0:
sys.stderr.write(" Retry in %d seconds...\n" % i)
return True
def CustomUpload(source_path, custom_command):
"""Uploads the source file by a customized shell command.
source_path: File to upload.
custom_command: A shell script command to invoke.
if not custom_command:
ErrorDie('CustomUpload: need a shell command for customized uploading.')
cmd = '%s %s' % (custom_command, source_path)
DebugMsg('CustomUpload: custom: %s' % cmd)
if os.system(cmd) != 0:
ErrorDie('CustomUpload: failed: %s' % cmd)
VerboseMsg('CustomUpload: successfully invoked command: %s.' % cmd)
return True
def ShopFloorUpload(source_path, remote_spec,
if '#' not in remote_spec:
ErrorDie('ShopFloorUpload: need a valid parameter in URL#SN format.')
(server_url, _, serial_number) = remote_spec.partition('#')
DebugMsg("ShopFloorUpload: [%s].UploadReport(%s, %s)" %
(server_url, serial_number, source_path))
instance = xmlrpclib.ServerProxy(server_url, allow_none=True, verbose=False)
remote_name = os.path.basename(source_path)
with open(source_path, 'rb') as source_handle:
blob = xmlrpclib.Binary(
def ShopFloorCallback(result):
abort = False
message = None
instance.UploadReport(serial_number, blob, remote_name)
return True
except xmlrpclib.Fault, err:
result['message'] = 'Remote server fault #%d: %s' % (err.faultCode,
result['abort'] = True
result['message'] = sys.exc_info()[1]
result['abort'] = False
RetryCommand(ShopFloorCallback, 'ShopFloorUpload', interval=retry_interval)
VerboseMsg('ShopFloorUpload: successfully uploaded to: %s' % remote_spec)
return True
def CurlCommand(curl_command, success_string=None, abort_string=None,
"""Performs arbitrary curl command with retrying.
curl_command: Parameters to be invoked with curl.
success_string: String to be recognized as "uploaded successfully".
if not curl_command:
ErrorDie('CurlCommand: need parameters for curl.')
cmd = 'curl -s -S %s' % curl_command
DebugMsg('CurlCommand: %s' % cmd)
# man curl(1) for EXIT CODES not related to temporary network failure.
curl_abort_exit_codes = [1, 2, 3, 27, 37, 43, 45, 53, 54, 58, 59, 63]
def CurlCallback(result):
(exit_code, stdout, stderr) = (
gft_common.ShellExecution(cmd, ignore_status=True))
abort = False
message = None
if exit_code == 0:
if abort_string and stdout.find(abort_string) >= 0:
message = "Abort: Found abort pattern: %s" % abort_string
elif (not success_string) or (stdout.find(success_string) >= 0):
return True
message = "Retry: No valid pattern (%s) in response." % success_string
DebugMsg("CurlCallback: original response: %s" %
' '.join(stdout.splitlines()))
message = '#%d %s' % (exit_code, stderr if stderr else stdout)
if exit_code in curl_abort_exit_codes:
abort = True
result['abort'] = abort
result['message'] = message
RetryCommand(CurlCallback, 'CurlCommand', interval=retry_interval)
VerboseMsg('CurlCommand: successfully executed: %s' % cmd)
return True
def CurlUrlUpload(source_path, params, **kargs):
"""Uploads the source file with URL-like protocols by curl.
source_path: File to upload.
params: Parameters to be invoked with curl.
retry: Duration (in secnods) for retry.
return CurlCommand('--ftp-ssl -T "%s" %s' % (source_path, params), **kargs)
def CpfeUpload(source_path, cpfe_url, **kargs):
"""Uploads the source file to ChromeOS Partner Front End site.
source_path: File to upload.
cpfe_url: URL to CPFE.
retry: Duration (in secnods) for retry.
curl_command = '--form "report_file=@%s" %s' % (source_path, cpfe_url)
return CurlCommand(curl_command, success_string=CPFE_SUCCESS,
abort_string=CPFE_ABORT, **kargs)
def FtpUpload(source_path, ftp_url, retry_interval=DEFAULT_RETRY_INTERVAL,
"""Uploads the source file to a FTP url.
source_path: File to upload.
ftp_url: A ftp url in ftp://user@pass:host:port/path format.
retry_interval: A number in seconds for retry duration. 0 to prevent retry.
retry_timeout: A number in seconds for connection timeout.
GFTError: When input url is invalid, or if network issue without retry.
# scheme: ftp, netloc: user:pass@host:port, path: /...
url_struct = urlparse.urlparse(ftp_url)
tokens = re.match('(([^:]*)(:([^@]*))?@)?([^:]*)(:(.*))?', url_struct.netloc)
userid =
passwd =
host =
port =
# Check and specify default parameters
if not host:
ErrorDie('FtpUpload: invalid ftp url: %s' % ftp_url)
if not port:
port = ftplib.FTP_PORT
if not userid:
userid = 'anonymous'
if not passwd:
passwd = ''
# Parse destination path: According to RFC1738, 3.2.2,
# Starting with %2F means absolute path, otherwise relative.
path = urllib.unquote(url_struct.path)
assert path[0] == '/', 'Unknown FTP URL path.'
path = path[1:]
source_name = os.path.split(source_path)[1]
dest_name = os.path.split(path)[1]
DebugMsg('source name: %s, dest_name: %s -> %s' % (source_name, path,
if source_name and (not dest_name):
path = os.path.join(path, source_name)
ftp = ftplib.FTP()
url = 'ftp://%s:%s@%s:%s/ %s' % (userid, passwd, host, port, path)
VerboseMsg('FtpUpload: target is %s' % url)
def FtpCallback(result):
ftp.connect(host=host, port=port, timeout=retry_timeout)
return True
except Exception, e:
result['message'] = '%s' % e
RetryCommand(FtpCallback, 'FtpUpload', interval=retry_interval)
# Ready for copying files
DebugMsg('FtpUpload: connected, uploading to %s...' % path)
ftp.login(user=userid, passwd=passwd)
with open(source_path, 'rb') as fileobj:
ftp.storbinary('STOR %s' % path, fileobj)
DebugMsg('FtpUpload: upload complete.')
VerboseMsg('FtpUpload: successfully uploaded to %s' % ftp_url)
return True
def NoneUpload(source_path, **kargs):
""" Dummy function for bypassing uploads """
WarningMsg('NoneUpload%s: skipped uploading %s' % (kargs, source_path))
return True
def Upload(path, method, **kargs):
"""Uploads a file by given method.
path: File path to be uploaded.
method: A string to specify the method to upload files.
args = method.split(':', 1)
method = args[0]
param = args[1] if len(args) > 1 else None
if method == 'none':
return NoneUpload(path, **kargs)
elif method == 'custom':
return CustomUpload(path, param, **kargs)
elif method == 'shopfloor':
return ShopFloorUpload(path, param, **kargs)
elif method == 'ftp':
return FtpUpload(path, 'ftp:' + param, **kargs)
elif method == 'ftps':
return CurlUrlUpload(path, '--ftp-ssl-reqd ftp:%s' % param, **kargs)
elif method == 'curl' and param.startswith('ftp://'):
return CurlUrlUpload(path, param, **kargs)
elif method == 'curl' and param.startswith('ftps://'):
return CurlUrlUpload(path, '--ftp-ssl-reqd ' + param, **kargs)
elif method == 'cpfe':
return CpfeUpload(path, param, **kargs)
ErrorDie('Upload: unknown method: %s' % method)
return False
# Console main entry
def main():
# gft_common.SetDebugLevel(True)
if len(sys.argv) != 3:
print "Usage: %s upload_file_path upload_method" % sys.argv[0]
print """
Supported values for upload_method:
Do nothing.
Upload to a FTP site using python ftplib (for backward compatible and
better connection status checking).
ftps://userid:passwd@host:port/path [curl_options]
Upload by FTP-SSL protocol using curl.
curl:ftp[s]://userid:passwd@host:port/path [curl_options]
Upload by FTP(s) protocol using curl, allowing customized curl
parameters like --ftp-create-dirs.
cpfe:cpfe_url [curl_options]
Upload to Google ChromeOS Partner Front End.
Upload to ChromeOS factory shop floor XMLRPC interface (more info in
Invoke a shell command to upload the file.
if not Upload(sys.argv[1], sys.argv[2]):
ErrorDie('ftp_upload: FAILED.')
if __name__ == '__main__':