Skip to content
Snippets Groups Projects
Commit b97af394 authored by sveseli's avatar sveseli
Browse files

refactored some of the cdb python classes (utility, base api and cli classes,...

refactored some of the cdb python classes (utility, base api and cli classes, exceptions, constants)
parent cc778219
No related branches found
No related tags found
No related merge requests found
Showing
with 689 additions and 0 deletions
__version__ = "Development Snapshot (2015.03.31)"
#!/usr/bin/env python
import json
from dm.common.exceptions.dmException import DmException
from dm.common.utility.loggingManager import LoggingManager
class DmApi(object):
""" Base dm api class. """
def __init__(self, username = None, password = None):
self.logger = LoggingManager.getInstance().getLogger(self.__class__.__name__)
@classmethod
def getLogger(cls):
logger = LoggingManager.getInstance().getLogger(cls.__name__)
return logger
@classmethod
def toDmObjectList(cls, dictList, dmObjectClass):
dmObjectList = []
for dict in dictList:
dmObjectList.append(dmObjectClass(dict))
return dmObjectList
# Exception decorator for all api calls
@classmethod
def execute(cls, func):
def decorate(*args, **kwargs):
try:
response = func(*args, **kwargs)
return response
except DmException, ex:
raise
except Exception, ex:
cls.getLogger().exception('%s' % ex)
raise DmException(exception=ex)
return decorate
#!/usr/bin/env python
import socket
import json
from dm.common.utility.loggingManager import LoggingManager
from dm.common.client.sessionManager import SessionManager
from dm.common.utility.configurationManager import ConfigurationManager
from dm.common.exceptions.authorizationError import AuthorizationError
from dm.common.api.dmApi import DmApi
class DmRestApi(DmApi):
""" Base dm REST api class. """
def __init__(self, username=None, password=None, host=None, port=None, protocol=None):
DmApi.__init__(self)
self.configurationManager = ConfigurationManager.getInstance()
if username == None and password == None:
username = self.configurationManager.getServiceUsername()
password = self.configurationManager.getServicePassword()
if host == None:
host = self.configurationManager.getServiceHost()
if port == None:
port = self.configurationManager.getServicePort()
if protocol == None:
protocol = self.configurationManager.getServiceProtocol()
self.username = username
self.password = password
self.host = host
self.port = port
self.protocol = protocol
self.sessionManager = None
@classmethod
def toJson(cls, o):
return json.dumps(o)
@classmethod
def fromJson(cls, s):
return json.loads(s)
def __getWebServiceUrl(self, url):
if url.find('://') < 0:
return '%s://%s:%s' % (self.protocol, socket.gethostbyname(self.host), self.port)
# Break the URL down into component pieces
from urlparse import urlparse
o = urlparse(url)
wsUrl = '%s://%s' % (o[0], o[1])
return wsUrl
def getContextRoot(self):
return self.configurationManager.getContextRoot()
def setUsername(self, username):
self.username = username
def getUsername(self):
return self.username
def setPassword(self, password):
self.password = password
def getPassword(self):
return self.password
def setHost(self, host):
self.host = host
def getHost(self):
return self.host
def setPort(self, port):
self.port = port
def getPort(self):
return self.port
def setProtocol(self, protocol):
self.protocol = protocol
def getProtocol(self):
return self.protocol
def getSessionManager(self):
if not self.sessionManager:
self.sessionManager = SessionManager()
return self.sessionManager
def getConfigManager(self):
return self.configurationManager
def sendSessionRequest(self, url, method, contentType='html', data={}):
""" Send authorized session request. """
sm = self.getSessionManager()
if not sm.hasSession():
if self.username == None:
raise AuthorizationError('Username not supplied.')
if self.password == None:
raise AuthorizationError('Password not supplied.')
wsUrl = self.__getWebServiceUrl(url)
# establishSession() sets the 'wsUrl' so the explicit call
# to setHost() is not required
sm.establishSession(wsUrl, self.username, self.password)
(response, responseData) = sm.sendSessionRequest(url, method, contentType, data)
return json.loads(responseData)
def sendRequest(self, url, method, contentType='html', data={}):
""" Send non-authorized request. """
sm = self.getSessionManager()
# Because there's no call to establishSession(), explicitly call
# setHost()
sm.setHost(self.__getWebServiceUrl(url))
(response, responseData) = self.getSessionManager().sendRequest(url, method, contentType, data)
return json.loads(responseData)
#######################################################################
# Testing.
if __name__ == '__main__':
api = DmRestApi('sveseli', 'sveseli')
#api.sendRequest('https://zagreb.svdev.net:10232/dm/directory/list', 'GET', data='')
import urllib
from dm.common.utility.configurationManager import ConfigurationManager
cm = ConfigurationManager.getInstance()
cm.setSessionCacheFile('/tmp/session')
#print 'Non-session request'
#print api.sendRequest('https://zagreb.svdev.net:10232/dm/directory/list?path=/tmp', 'GET')
print 'Session request'
data = { 'path' : '/tmp/xyz' }
#print api.sendSessionRequest('https://zagreb.svdev.net:10232/dm/file/write?path=/tmp/xyz&content=xyz', 'POST', contentType='application/x-www-form-urlencoded', data=urllib.urlencode(data))
#print api.sendSessionRequest('https://zagreb.svdev.net:10232/dm/file/write', 'POST', data=data)
postdata='path=/tmp/xyz'
postdata+='&content=%s' % urllib.quote_plus('Hey there')
print api.sendSessionRequest('https://zagreb.svdev.net:10232/dm/file/write', 'POST', contentType='application/x-www-form-urlencoded', data=postdata)
#!/usr/bin/env python
import sys
import os
import os.path
import stat
from optparse import OptionGroup
import dm
from dm.common.utility.loggingManager import LoggingManager
from dm.common.utility.configurationManager import ConfigurationManager
from dm.common.utility.osUtility import OsUtility
from dm.common.objects.dmObject import DmObject
from dm.common.exceptions.dmException import DmException
from dm.common.exceptions.invalidRequest import InvalidRequest
from dm.common.exceptions.invalidArgument import InvalidArgument
from dm.common.exceptions.internalError import InternalError
from dm.common.cli.dmOptionParser import DmOptionParser
from dm.common.constants import dmStatus
class DmCli(object):
""" Base dm command line interface class. """
DEFAULT_SESSION_CACHE_FILE = OsUtility.getUserHomeDir() + '/.dm/.session.cache'
def __init__(self, validArgCount=0):
self.logger = LoggingManager.getInstance().getLogger(self.__class__.__name__)
# Do not log into a file for CLIs
LoggingManager.getInstance().setFileLogLevel('CRITICAL')
LoggingManager.getInstance().setConsoleLogLevel('CRITICAL')
self.parser = DmOptionParser()
self.options = {}
self.args = []
self.validArgCount = validArgCount
self.serviceHost = None
self.servicePort = None
self.optionGroupDict = {}
commonGroup = 'Common Options'
self.addOptionGroup(commonGroup, None)
self.addOptionToGroup(commonGroup, '-h', '--help', action='help', help='Show this help message and exit.')
self.addOptionToGroup(commonGroup, '-?', '', action='help', help='Show this help message and exit.')
self.addOptionToGroup(commonGroup, '-v', '--version', action='store_true', dest='version', default=False, help='Print version and exit.')
self.addOptionToGroup(commonGroup, '-d', '--debug', dest='consoleLogLevel', help='Set debug level (valid values: CRITICAL, ERROR, WARNING, INFO, DEBUG). Console log level can also be set via DM_CONSOLE_LOG_LEVEL environment variable,')
self.addOptionToGroup(commonGroup, '', '--display-format', dest='displayFormat', default=DmObject.TEXT_DISPLAY_FORMAT, help='Display format for output objects. Possible options are: %s, %s, and %s (default: %s).' % (DmObject.TEXT_DISPLAY_FORMAT, DmObject.DICT_DISPLAY_FORMAT, DmObject.JSON_DISPLAY_FORMAT, DmObject.TEXT_DISPLAY_FORMAT))
self.addOptionToGroup(commonGroup, '', '--display-keys', dest='displayKeys', default=DmObject.DEFAULT_KEYS, help='List of output object keys to display. Possible options are: %s, %s, and string containing comma-separated keys (default: %s, represents class default keys).' % (DmObject.DEFAULT_KEYS, DmObject.ALL_KEYS, DmObject.DEFAULT_KEYS))
# These will be set via env variables
self.addOptionToGroup(commonGroup, '', '--service-host', dest='serviceHost', default=self.getDefaultServiceHost(), help='Service host (default: %s, can be set via DM_SERVICE_HOST environment variable).' % self.getDefaultServiceHost())
self.addOptionToGroup(commonGroup, '', '--service-port', dest='servicePort', default=self.getDefaultServicePort(), help='Service port (default: %s, can be set via DM_SERVICE_PORT environment variable).' % self.getDefaultServicePort())
self.addOptionToGroup(commonGroup, '', '--service-protocol', dest='serviceProtocol', default=self.getDefaultServiceProtocol(), help='Service protocol (default: %s, can be set via DM_SERVICE_PROTOCOL environment variable).' % self.getDefaultServiceProtocol())
# SSL options, disabled for now.
#self.addOptionToGroup(commonGroup, '', '--ssl-key', dest='sslKeyFile', help='SSL key file (needed if service requires peer verification, can be set via DM_SSL_KEY_FILE environment variable).')
#self.addOptionToGroup(commonGroup, '', '--ssl-cert', dest='sslCertFile', help='SSL certificate file (needed if service requires peer verification, can be set via DM_SSL_CERT_FILE environment variable).')
#self.addOptionToGroup(commonGroup, '', '--ssl-ca-cert', dest='sslCaCertFile', help='SSL CA certificate file (needed if client requires peer verification, can be set via DM_SSL_CA_CERT_FILE environment variable).')
def getDefaultServiceHost(self):
return ConfigurationManager.getInstance().getServiceHost()
def getDefaultServicePort(self):
return ConfigurationManager.getInstance().getServicePort()
def getDefaultServiceProtocol(self):
return ConfigurationManager.getInstance().getServiceProtocol()
def getUsername(self):
return None
def getPassword(self):
return None
def getDisplayFormat(self):
return self.options.displayFormat
def getDisplayKeys(self):
return self.options.displayKeys
def getLogger(self):
return self.logger
def getParser(self):
return self.parser
def addOption(self, *args, **kwargs):
self.parser.add_option(*args, **kwargs)
def addOptionToGroup(self, groupName, *args, **kwargs):
""" Add group option. Group must be created using addOptionGroup(). """
group = self.optionGroupDict.get(groupName)
group.add_option(*args, **kwargs)
def addOptionGroup(self, groupName, desc):
group = OptionGroup(self.parser, groupName, desc)
self.parser.add_option_group(group)
self.optionGroupDict[groupName] = group
def processArgs(self):
pass
def parseArgs(self, usage=None):
if usage:
self.parser.usage = usage
try:
(self.options, self.args) = self.parser.parse_args()
self.processArgs()
except SystemExit, rc:
sys.stdout.flush()
sys.stderr.flush()
sys.exit(int(str(rc)))
if self.validArgCount < len(self.args):
# Positional args are not enabled and we have some
msg = 'Invalid positional argument(s):'
for arg in self.args[self.validArgCount:]:
msg += ' ' + arg
msg += ' (This command allows %s positional arguments.)' % self.validArgCount
raise InvalidArgument(msg)
optDict = self.options.__dict__
if optDict.get('version'):
print 'DM Software Version: %s' % (dm.__version__)
sys.exit(0)
# Logging level. First try from command line, then from env variable.
consoleLogLevel = optDict.get('consoleLogLevel', None)
if consoleLogLevel:
LoggingManager.getInstance().setConsoleLogLevel(consoleLogLevel)
else:
consoleLogLevel = ConfigurationManager.getInstance().getConsoleLogLevelFromEnvVar()
if consoleLogLevel:
LoggingManager.getInstance().setConsoleLogLevel(consoleLogLevel)
# Service host, port, etc.
configManager = ConfigurationManager.getInstance()
self.serviceHost = self.options.serviceHost
configManager.setServiceHost(self.serviceHost)
self.servicePort = self.options.servicePort
configManager.setServicePort(self.servicePort)
self.serviceProtocol = self.options.serviceProtocol
configManager.setServiceProtocol(self.serviceProtocol)
# SSL options, comment out for now
#self.sslCaCertFile = self.options.sslCaCertFile
#if self.sslCaCertFile:
# configManager.setSslCaCertFile(self.sslCaCertFile)
#self.sslCertFile = self.options.sslCertFile
#if self.sslCertFile:
# configManager.setSslCertFile(self.sslCertFile)
#self.sslKeyFile = self.options.sslKeyFile
#if self.sslKeyFile:
# configManager.setSslKeyFile(self._sslKeyFile)
# Check session cache.
try:
self.checkSessionCache()
except Exception, ex:
self.logger.warn('Disabling session cache: %s' % ex)
configManager.setSessionCacheFile(None)
return (self.options, self.args)
def checkSessionCache(self):
configManager = ConfigurationManager.getInstance()
sessionCacheFile = configManager.getSessionCacheFile()
if sessionCacheFile is None:
sessionCacheFile = DmCli.DEFAULT_SESSION_CACHE_FILE
sessionCacheFile = sessionCacheFile.strip()
if len(sessionCacheFile):
sessionCacheDir = os.path.dirname(sessionCacheFile)
OsUtility.createDir(sessionCacheDir, stat.S_IRUSR|stat.S_IWUSR|stat.S_IXUSR)
configManager.setSessionCacheFile(sessionCacheFile)
configManager.setRequireSessionCredentials(True)
def usage(self, s=None):
""" Print help provided by optparse. """
if s:
print >>sys.stderr, 'Error: ', s, '\n'
self.parser.print_help()
sys.exit(dmStatus.DM_ERROR)
def getOptions(self):
return self.options
def getNArgs(self):
""" Returns the number of command line arguments. """
return len(self.args)
def getArgs(self):
""" Returns the command line argument list. """
return self.args
def getArg(self, i):
""" Returns the i-th command line argument. """
return self.args[i]
def getServiceHost(self):
#return self.serviceHost
return ConfigurationManager.getInstance().getServiceHost()
def getServicePort(self):
#return self.servicePort
return ConfigurationManager.getInstance().getServicePort()
def getServiceProtocol(self):
#return self.serviceProtocol
return ConfigurationManager.getInstance().getServiceProtocol()
def getSslCaCertFile(self):
return self.sslCaCertFile
def getSslCertFile(self):
return self.sslCertFile
def getSslKeyFile(self):
return self.sslKeyFile
def displayDmObject(self, dmObject):
if isinstance(dmObject, dmObject):
return '%s' % dmObject.getJsonRep()
else:
return '%s' % dmObject
def runCommand(self):
""" This method must be implemented by the derived class. """
raise InternalError('Method runCommand() must be overriden in the derived class.')
def run(self):
""" This method invokes runCommand() and handles any exceptions. """
try:
self.runCommand()
except DmException, ex:
self.logger.exception('%s' % ex)
print '%s' % ex.getErrorMessage()
raise SystemExit(ex.getErrorCode())
except SystemExit, ex:
raise
except Exception, ex:
self.logger.exception('%s' % ex)
print >>sys.stderr, '%s' % ex
raise SystemExit(dmStatus.DM_ERROR)
def getId(self):
id = self.options.id
if id == None:
raise InvalidRequest('Missing id.')
return id
def displayDmObject(self, dmObject):
optDict = self._options.__dict__
if isinstance(dmObject, DmObject):
if optDict.get('dict'):
return '%s' % dmObject
else:
return dmObject.display()
else:
return '%s' % dmObject
#######################################################################
# Testing
if __name__ == '__main__':
cli = DmCli(3)
cli.addOption("-f", "--file", dest="filename", help="write report to FILE", metavar="FILE")
cli.addOption("-q", "--quiet", action="store_false", dest="verbose", default=True, help="don't print log messages to stdout")
(options, args) = cli.parseArgs()
print 'After parse:'
print 'OPTIONS: ', options
print 'ARGS: ', args
print 'From CLI'
print 'OPTIONS: ', cli.getOptions()
print 'ARGS: ', cli.getArgs()
print
print 'FILENAME'
print 'options.filename', options.filename
print 'cli.getOptions().filename', cli.getOptions().filename
o = cli.getOptions()
print 'o.filename', o.filename
print 'cli.getArgs()', cli.getArgs()
print 'len(cli.getArgs())', len(cli.getArgs())
for a in cli.getArgs():
print 'arg', a
first_arg = cli.getArg(0)
print 'first_arg', first_arg
second_arg = cli.getArg(1)
print 'second_arg', second_arg
try:
third_arg = cli.getArg(2)
print 'third_arg', third_arg
except:
print 'no third arg'
#!/usr/bin/env python
import sys
from optparse import OptionParser
from cStringIO import StringIO
class DmOptionParser(OptionParser):
def __init__(self):
OptionParser.__init__(self, add_help_option=False)
def replaceKeys(self, output):
replacementMap = {
'usage:' : 'Usage:',
'options:' : 'Options:',
}
result = output
for (key, value) in replacementMap.items():
result = result.replace(key, value)
return result
def printUsage(self, file=None):
self.print_usage(file)
# Replaces base class method
def print_usage(self, file=None):
sysStdout = sys.stdout
cliStdout = StringIO()
sys.stdout = cliStdout
OptionParser.print_usage(self, file)
sys.stdout = sysStdout
print self.replaceKeys(cliStdout.getvalue())
def printHelp(self, file=None):
self.printHelp(file)
# Replaces base class method
def print_help(self, file=None):
sysStdout = sys.stdout
cliStdout = StringIO()
sys.stdout = cliStdout
OptionParser.print_help(self, file)
sys.stdout = sysStdout
print self.replaceKeys(cliStdout.getvalue())
#######################################################################
# Testing
if __name__ == '__main__':
p = DmOptionParser()
p.add_option('-f', '--file', dest='filename',
help='write report to FILE', metavar='FILE')
p.add_option('-q', '--quiet',
action='store_false', dest='verbose', default=True,
help='do not print log messages to standard output')
p.parse_args()
p.print_usage()
p.print_help()
#!/usr/bin/env python
from dm.common.cli.dmCli import DmCli
class DmRestCli(DmCli):
""" Base dm REST cli class. """
def __init__(self, validArgCount=0):
DmCli.__init__(self, validArgCount)
#!/usr/bin/env python
from dm.common.cli.dmRestCli import DmRestCli
class DmRestSessionCli(DmRestCli):
""" Base dm session cli class. """
def __init__(self, validArgCount=0):
DmRestCli.__init__(self, validArgCount)
self.username = None
self.password = None
loginGroup = 'Login Options'
self.addOptionGroup(loginGroup, None)
self.addOptionToGroup(loginGroup, '', '--username', dest='username', help='Login username.')
self.addOptionToGroup(loginGroup, '', '--password', dest='password', help='Login password.')
def parseArgs(self, usage=None):
DmRestCli.parseArgs(self, usage)
self.username = self.options.username
self.password = self.options.password
return (self.options, self.args)
def getUsername(self):
return self.username
def getPassword(self):
return self.password
def hasCredentials(self):
return (self.username != None and self.password != None)
#######################################################################
# Testing
if __name__ == '__main__':
pass
#!/usr/bin/env python
#######################################################################
DM_SESSION_ROLE_HTTP_HEADER = 'Dm-Session-Role'
DM_STATUS_CODE_HTTP_HEADER = 'Dm-Status-Code'
DM_STATUS_MESSAGE_HTTP_HEADER = 'Dm-Status-Message'
DM_EXCEPTION_TYPE_HTTP_HEADER = 'Dm-Exception-Type'
#!/usr/bin/env python
DM_HTTP_OK = 200
DM_HTTP_UNAUTHORIZED = 401
DM_HTTP_INTERNAL_ERROR = 500
#!/usr/bin/env python
#######################################################################
DM_ADMIN_ROLE = 'admin'
DM_USER_ROLE = 'user'
#!/usr/bin/env python
#######################################################################
DM_SERVICE_PROTOCOL_HTTP = 'http'
DM_SERVICE_PROTOCOL_HTTPS = 'https'
#!/usr/bin/env python
#######################################################################
DM_OK = 0
DM_ERROR = 1
DM_INTERNAL_ERROR = 2
DM_COMMUNICATION_ERROR = 3
DM_CONFIGURATION_ERROR = 4
DM_AUTHORIZATION_ERROR = 5
DM_AUTHENTICATION_ERROR = 6
DM_DB_ERROR = 7
DM_URL_ERROR = 8
DM_TIMEOUT = 9;
DM_INVALID_ARGUMENT = 10
DM_INVALID_REQUEST = 11
DM_INVALID_SESSION = 12;
DM_COMMAND_FAILED =13
DM_OBJECT_NOT_FOUND = 14
DM_OBJECT_ALREADY_EXISTS = 15
DM_INVALID_OBJECT_STATE = 16;
#!/usr/bin/env python
#
# Authentication error class.
#
#######################################################################
from dm.common.constants import dmStatus
from dm.common.exceptions.dmException import DmException
#######################################################################
class AuthenticationError(DmException):
def __init__ (self, error='', **kwargs):
DmException.__init__(self, error, dmStatus.DM_AUTHENTICATION_ERROR, **kwargs)
#!/usr/bin/env python
#
# Authorization error class.
#
#######################################################################
from dm.common.constants import dmStatus
from dm.common.exceptions.dmException import DmException
#######################################################################
class AuthorizationError(DmException):
def __init__ (self, error='', **kwargs):
DmException.__init__(self, error, dmStatus.DM_AUTHORIZATION_ERROR, **kwargs)
#!/usr/bin/env python
#
# Command failed exception class.
#
#######################################################################
from dm.common.constants import dmStatus
from dm.common.exceptions.dmException import DmException
#######################################################################
class CommandFailed(DmException):
def __init__ (self, error='', **kwargs):
DmException.__init__(self, error, dmStatus.DM_COMMAND_FAILED, **kwargs)
#!/usr/bin/env python
#
# Communication error class.
#
#######################################################################
from dm.common.constants import dmStatus
from dm.common.exceptions.dmException import DmException
#######################################################################
class CommunicationError(DmException):
def __init__ (self, error='', **kwargs):
DmException.__init__(self, error, dmStatus.DM_COMMUNICATION_ERROR, **kwargs)
0% Loading or .
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment