OpalClient.py


import sys
import time
import httplib
import os
import getopt
import urllib
import tarfile

#from mglutil.web.services.AppService_client import \
from AppService_client import \
     AppServiceLocator, getAppMetadataRequest, launchJobRequest, \
     queryStatusRequest, getOutputsRequest, \
     launchJobBlockingRequest, getOutputAsBase64ByNameRequest, destroyRequest
#from mglutil.web.services.AppService_types import ns0
from AppService_types import ns0
from ZSI.TC import String


class JobStatus:
    """ This class represents a Opal job status and can be used 
    after launching a job to monitor its execution. A Job Status is 
    returned by a launchJob call, or it can be constructed from a jobID
    and its corresponding Opal Service"""

    def __init__(self, opalService, jobID):
        """ """
        self.opalService = opalService
        self.jobID = jobID
        self.jobStatus = \
            self.opalService.appServicePort.queryStatus(queryStatusRequest(jobID))

    def updateStatus(self):
        """ this function retrives a updated version of the jobStatus 
        from the Opal server """ 
        #import pdb; pdb.set_trace()
        self.jobStatus = \
            self.opalService.appServicePort.queryStatus(queryStatusRequest(self.jobID))

    def getError(self):
        """ It returns the error message of the job """
        return self.jobStatus._message

    def getBaseURL(self):
        """ it returns the URL that contains all the job outputs """
        return self.jobStatus._baseURL

    def getURLstdout(self):
        """ it returns the URL of the stdout"""
        return self.jobStatus._baseURL + "/stdout.txt"

    def getURLstderr(self):
        """ it returns the URL of the stderr"""
        return self.jobStatus._baseURL + "/stderr.txt"

    def getStatus(self):
        """ it returns the numeric representation of the status of the job """
        return self.jobStatus._code

    def getJobId(self):
        """ it returns the jobid of this job """
        return self.jobID

    def getOutputFiles(self):
        """ it returns a list of strings containing the URLs of the output files 
        produced by the job """
        resp = self.opalService.appServicePort.getOutputs(getOutputsRequest(self.jobID))
        outputFile = []
        for i in resp._outputFile:
            outputFile.append(i._url)
        return outputFile

    def downloadOutput(self, baseDir):
        """ download all output files from the job and it places them in the local baseDir 
        (baseDir must exists). This function currently works only with newer opal services,

        @returns: true if the operation was successful false otherwise  """
        fileName = "results.tar.gz"
        tarURL = self.getBaseURL() + "/" + fileName
        outputTar = baseDir + "/" + fileName
        #TODO add support for services without results.tar.gz
        urllib.urlretrieve(tarURL, outputTar)
        tar = tarfile.open(outputTar)
        tar.extractall(path=baseDir)
        tar.close()
        return 
        

    def isRunning(self):
        """ this function returns true is the job is still running false if it finished
        """
        if self.jobStatus._code != 8 and self.jobStatus._code != 4:
            return True
        return False

    def isSuccessful(self):
        """ If the job sucesfully finished its execution, this function returns true """
        if self.jobStatus._code == 8:
            return True
        return False

    def destroyJob(self):
        """ it destroies the running jobs """
        req = destroyRequest(self.jobID)
        self.jobStatus = self.opalService.appServicePort.destroy( req )
		

class OpalService:
    """ This class wrap a single Opal service. You should have one of this class 
    for each Opal Service you want to use.
    """

    def __init__(self, url):
        self.url = url
        appLocator = AppServiceLocator()
        self.appServicePort = appLocator.getAppServicePort(self.url)

    def getServiceMetadata(self):
        """ """
        req = getAppMetadataRequest()
        resp = self.appServicePort.getAppMetadata(req)
        return resp

    def getURL(self):
        """ 
        @return: a string containing the end point URL used by this services """
        return self.url


    def launchJobNB(self, commandline, inFilesPath, numProcs = None, email = None, \
                    passwd=None):
        """ invoke the execution of the remote scientific application
        using Opal a return right away
        
        @returns: a jobStatus Oject which can be used to monitor its execution"""

        inputFiles = []
        if inFilesPath != None:
            for i in inFilesPath:
                inputFile = ns0.InputFileType_Def('inputFile')
                inputFile._name = os.path.basename(i)
                if i.startswith("http:") or i.startswith("https:"):
                    #this is a URL
                    inputFile._location = i
                elif self.isOpal2():
                    #use attachment this is opal2 server
                    if os.name == 'dos' or os.name == 'nt':
                        inputFile._attachment = open(i, "rb")
                    else:
                        inputFile._attachment = open(i, "r")
                else:
                    #it's not a opal2 server don't user attachment
                    infile = open(i, "r")
                    inputFile._contents = infile.read()
                    infile.close()
                inputFiles.append(inputFile)

        req = launchJobRequest()
        req._argList = commandline
        req._inputFile = inputFiles
        if email:
            req._sendNotification = True
            req._userEmail = email
        if passwd:
            req._password = passwd
        if numProcs :
            req._numProcs = numProcs
        jobStatus = self.appServicePort.launchJob(req)
        return JobStatus(self, jobStatus._jobID)
    
    def isOpal2(self):
        """ it returns true if this service points to a opal2 server
            false in the other cases
        """
        if self.url.find("/opal2/") != -1:
            return True
        else:
            return False

    def launchJobBlocking(self, commandline, inFilesPath, numProcs = None):
        """     """
        jobStatus = self.launchJobNB(commandline, inFilesPath, numProcs)
        while jobStatus.isRunning() :
            time.sleep(30)
            jobStatus.updateStatus()
        #ok job is finished
        return jobStatus