add first functional DS web service with user, experiment and auth controllers...

add first functional DS web service with user, experiment and auth controllers that allow retrieving user and experiment information from the db, start/stop experiment, and principal authorization; added corresponding API and CLI classes; added storage manager skeleton

src/python/dm/ds_web_service/api/authRestApi.py

+#!/usr/bin/env python
+
+import os
+import urllib
+
+from dm.common.utility.encoder import Encoder
+from dm.common.exceptions.dmException import DmException
+from dm.common.exceptions.invalidRequest import InvalidRequest
+from dm.common.objects.authorizationPrincipal import AuthorizationPrincipal
+from dsRestApi import DsRestApi
+
+class AuthRestApi(DsRestApi):
+   
+    def __init__(self, username=None, password=None, host=None, port=None, protocol=None):
+        DsRestApi.__init__(self, username, password, host, port, protocol)
+
+    @DsRestApi.execute
+    def getAuthorizationPrincipal(self, username):
+        if username is None:
+            raise InvalidRequest('Username must be provided.')
+        url = '%s/authorizationPrincipals/%s' % (self.getContextRoot(), username)
+        self.logger.debug('Retrieving principal for user %s' % (username))
+        responseData = self.sendSessionRequest(url=url, method='GET')
+        return AuthorizationPrincipal(responseData)
+
+#######################################################################
+# Testing.
+
+if __name__ == '__main__':
+    api = AuthRestApi('dm', 'dm', 'zagreb.svdev.net', 22236, 'http')
+    print api.authenticateUser('sveseli', 'sv')
+        
+
+
+

src/python/dm/ds_web_service/api/dsRestApi.py

+#!/usr/bin/env python
+
+from dm.common.api.dmRestApi import DmRestApi
+
+class DsRestApi(DmRestApi):
+    """ Base DS DM REST api class. """
+
+    def __init__(self, username=None, password=None, host=None, port=None, protocol=None):
+        if host == None:
+            host = self.configurationManager.getDsWebServiceHost()
+        if port == None:
+            port = self.configurationManager.getDsWebServicePort()
+        DmRestApi.__init__(self, username, password, host, port, protocol)
+
+#######################################################################
+# Testing.
+
+if __name__ == '__main__':
+    pass
+
+

src/python/dm/ds_web_service/api/dsRestApiFactory.py

+#!/usr/bin/env python
+
+from dm.common.utility.loggingManager import LoggingManager
+from dm.common.utility.configurationManager import ConfigurationManager
+
+class DsRestApiFactory:
+
+    CONFIG_SECTION_NAME = 'DsRestApiFactory'
+    USERNAME_KEY = 'username'
+    PASSWORD_FILE_KEY = 'passwordfile'
+    HOST_KEY = 'host'
+    PORT_KEY = 'port'
+    PROTOCOL_KEY = 'protocol'
+
+    __logger = None
+    __username = None
+    __password = None
+    __host = None
+    __port = None
+    __protocol = None
+
+    @classmethod
+    def getLogger(cls):
+        if cls.__logger is None:
+            cls.__logger = LoggingManager.getInstance().getLogger(cls.__name__)
+        return cls.__logger
+
+    @classmethod
+    def __getConfiguration(cls):
+        if cls.__username is None:
+            cls.__username = ConfigurationManager.getInstance().getConfigOption(cls.CONFIG_SECTION_NAME, cls.USERNAME_KEY)
+            cls.__password = open(ConfigurationManager.getInstance().getConfigOption(cls.CONFIG_SECTION_NAME, cls.PASSWORD_FILE_KEY)).read().strip()
+            cls.__host = ConfigurationManager.getInstance().getConfigOption(cls.CONFIG_SECTION_NAME, cls.HOST_KEY)
+            cls.__port = ConfigurationManager.getInstance().getConfigOption(cls.CONFIG_SECTION_NAME, cls.PORT_KEY)
+            cls.__protocol = ConfigurationManager.getInstance().getConfigOption(cls.CONFIG_SECTION_NAME, cls.PROTOCOL_KEY)
+        return (cls.__username, cls.__password, cls.__host, cls.__port, cls.__protocol)
+
+    @classmethod
+    def getUserRestApi(cls):
+        from userRestApi import UserRestApi
+        (username, password, host, port, protocol) = cls.__getConfiguration()
+        api = UserRestApi(username, password, host, port, protocol)
+        return api
+
+    @classmethod
+    def getAuthRestApi(cls):
+        from authRestApi import AuthRestApi
+        (username, password, host, port, protocol) = cls.__getConfiguration()
+        api = AuthRestApi(username, password, host, port, protocol)
+        return api
+
+####################################################################
+# Testing
+
+if __name__ == '__main__':
+    pass
+

src/python/dm/ds_web_service/api/experimentRestApi.py

+#!/usr/bin/env python
+
+import os
+import urllib
+
+from dm.common.utility.encoder import Encoder
+from dm.common.exceptions.dmException import DmException
+from dm.common.objects.experiment import Experiment
+from dm.common.objects.experimentType import ExperimentType
+from dsRestApi import DsRestApi
+
+class ExperimentRestApi(DsRestApi):
+    
+    def __init__(self, username=None, password=None, host=None, port=None, protocol=None):
+        DsRestApi.__init__(self, username, password, host, port, protocol)
+
+    @DsRestApi.execute
+    def getExperimentTypes(self):
+        url = '%s/experimentTypes' % (self.getContextRoot())
+        responseData = self.sendSessionRequest(url=url, method='GET')
+        return self.toDmObjectList(responseData, ExperimentType)
+
+    @DsRestApi.execute
+    def getExperiments(self):
+        url = '%s/experiments' % (self.getContextRoot())
+        responseData = self.sendSessionRequest(url=url, method='GET')
+        return self.toDmObjectList(responseData, Experiment)
+
+    @DsRestApi.execute
+    def getExperimentByName(self, name):
+        url = '%s/experimentsByName/%s' % (self.getContextRoot(), name)
+        if name is None or not len(name):
+            raise InvalidRequest('Experiment name must be provided.')
+        responseDict = self.sendSessionRequest(url=url, method='GET')
+        return Experiment(responseDict)
+
+    @DsRestApi.execute
+    def getExperimentById(self, id):
+        url = '%s/experiments/%s' % (self.getContextRoot(), id)
+        if id is None:
+            raise InvalidRequest('Experiment id must be provided.')
+        responseDict = self.sendSessionRequest(url=url, method='GET')
+        return Experiment(responseDict)
+
+    @DsRestApi.execute
+    def startExperiment(self, name):
+        url = '%s/experiments/start' % (self.getContextRoot())
+        if name is None or not len(name):
+            raise InvalidRequest('Experiment name must be provided.')
+        url += '?name=%s' % Encoder.encode(name)
+        responseDict = self.sendSessionRequest(url=url, method='PUT')
+        return Experiment(responseDict)
+
+    @DsRestApi.execute
+    def stopExperiment(self, name):
+        url = '%s/experiments/stop' % (self.getContextRoot())
+        if name is None or not len(name):
+            raise InvalidRequest('Experiment name must be provided.')
+        url += '?name=%s' % Encoder.encode(name)
+        responseDict = self.sendSessionRequest(url=url, method='PUT')
+        return Experiment(responseDict)
+
+    @DsRestApi.execute
+    def addExperiment(self, name, experimentTypeId, description):
+        url = '%s/experiments' % (self.getContextRoot())
+        if name is None or not len(name):
+            raise InvalidRequest('Experiment name must be provided.')
+        url += '?name=%s' % Encoder.encode(name)
+        if experimentTypeId is None:
+            raise InvalidRequest('Experiment type id must be provided.')
+        url += '&experimentTypeId=%s' % experimentTypeId
+        if description is not None:
+            url += '&description=%s' % Encoder.encode(description)
+        responseDict = self.sendSessionRequest(url=url, method='POST')
+        return Experiment(responseDict)
+
+#######################################################################
+# Testing.
+
+if __name__ == '__main__':
+    api = ExperimentRestApi('sveseli', 'sveseli', 'zagreb.svdev.net', 33336, 'http')
+    print api.startExperiment('experiment1')
+

src/python/dm/ds_web_service/api/userRestApi.py

+#!/usr/bin/env python
+
+import os
+import urllib
+
+from dm.common.utility.encoder import Encoder
+from dm.common.exceptions.dmException import DmException
+from dm.common.exceptions.invalidRequest import InvalidRequest
+from dm.common.objects.userInfo import UserInfo
+from dsRestApi import DsRestApi
+
+class UserRestApi(DsRestApi):
+    
+    def __init__(self, username=None, password=None, host=None, port=None, protocol=None):
+        DsRestApi.__init__(self, username, password, host, port, protocol)
+
+    @DsRestApi.execute
+    def getUsers(self):
+        url = '%s/users' % (self.getContextRoot())
+        responseData = self.sendSessionRequest(url=url, method='GET')
+        return self.toDmObjectList(responseData, UserInfo)
+
+    @DsRestApi.execute
+    def getUserById(self, id):
+        if id is None:
+            raise InvalidRequest('User id must be provided.')
+        url = '%s/users/%s' % (self.getContextRoot(), id)
+        responseData = self.sendSessionRequest(url=url, method='GET')
+        return UserInfo(responseData)
+
+    @DsRestApi.execute
+    def getUserByUsername(self, username):
+        if username is None:
+            raise InvalidRequest('Username must be provided.')
+        url = '%s/usersByUsername/%s' % (self.getContextRoot(), username)
+        responseData = self.sendSessionRequest(url=url, method='GET')
+        return UserInfo(responseData)
+
+#######################################################################
+# Testing.
+
+if __name__ == '__main__':
+    pass
+
+
+

src/python/dm/ds_web_service/cli/addExperimentCli.py

+#!/usr/bin/env python
+
+from dm.ds_web_service.api.experimentRestApi import ExperimentRestApi
+from dm.common.exceptions.invalidRequest import InvalidRequest
+from dsWebServiceSessionCli import DsWebServiceSessionCli
+
+class AddExperimentCli(DsWebServiceSessionCli):
+    def __init__(self):
+        DsWebServiceSessionCli.__init__(self)
+        self.addOption('', '--name', dest='name', help='Experiment name.')
+        self.addOption('', '--type-id', dest='typeId', help='Experiment type id.')
+        self.addOption('', '--description', dest='description', help='Experiment description.')
+
+    def checkArgs(self):
+        if self.options.name is None:
+            raise InvalidRequest('Experiment name must be provided.')
+        if self.options.typeId is None:
+            raise InvalidRequest('Experiment type id must be provided.')
+
+
+    def getName(self):
+        return self.options.name
+
+    def getTypeId(self):
+        return self.options.typeId
+
+    def getDescription(self):
+        return self.options.description
+
+    def runCommand(self):
+        self.parseArgs(usage="""
+    dm-get-experiment --name=NAME --type-id=TYPEID
+        [--description=DESCRIPTION]
+
+Description:
+    Add new experiment to the DM database. 
+        """)
+        self.checkArgs()
+        api = ExperimentRestApi(self.getLoginUsername(), self.getLoginPassword(), self.getServiceHost(), self.getServicePort(), self.getServiceProtocol())
+        experiment = api.addExperiment(self.getName(), self.getTypeId(), self.getDescription())
+        print experiment.getDisplayString(self.getDisplayKeys(), self.getDisplayFormat())
+
+#######################################################################
+# Run command.
+if __name__ == '__main__':
+    cli = AddExperimentCli()
+    cli.run()
+

src/python/dm/ds_web_service/cli/dsWebServiceCli.py

+#!/usr/bin/env python
+
+from dm.common.cli.dmRestCli import DmRestCli
+from dm.common.utility.configurationManager import ConfigurationManager
+
+class DsWebServiceCli(DmRestCli):
+    """ DM DS web service cli class. """
+
+    def __init__(self, validArgCount=0):
+        DmRestCli.__init__(self, validArgCount)
+
+    def getDefaultServiceHost(self):
+        return ConfigurationManager.getInstance().getDsWebServiceHost()
+
+    def getDefaultServicePort(self):
+        return ConfigurationManager.getInstance().getDsWebServicePort()
+                        `

src/python/dm/ds_web_service/cli/dsWebServiceSessionCli.py

+#!/usr/bin/env python
+
+from dm.common.cli.dmRestSessionCli import DmRestSessionCli
+from dm.common.utility.osUtility import OsUtility
+from dm.common.utility.configurationManager import ConfigurationManager
+
+class DsWebServiceSessionCli(DmRestSessionCli):
+    """ DM DS web service session cli class. """
+
+    DEFAULT_SESSION_CACHE_FILE = OsUtility.getUserHomeDir() + '/.dm/.ds.session.cache'
+
+    def __init__(self, validArgCount=0):
+        DmRestSessionCli.__init__(self, validArgCount)
+        ConfigurationManager.getInstance().setSessionCacheFile(DsWebServiceSessionCli.DEFAULT_SESSION_CACHE_FILE)
+
+    def getDefaultServiceHost(self):
+        return ConfigurationManager.getInstance().getDsWebServiceHost()
+
+    def getDefaultServicePort(self):
+        return ConfigurationManager.getInstance().getDsWebServicePort()
+

src/python/dm/ds_web_service/cli/getExperimentCli.py

+#!/usr/bin/env python
+
+from dm.common.exceptions.invalidRequest import InvalidRequest
+from dm.ds_web_service.api.userRestApi import ExperimentRestApi
+from dsWebServiceSessionCli import DsWebServiceSessionCli
+
+class GetExperimentCli(DsWebServiceSessionCli):
+    def __init__(self):
+        DsWebServiceSessionCli.__init__(self)
+        self.addOption('', '--id', dest='id', help='Experiment id. Either id or name must be provided. If both are provided, id takes precedence.')
+        self.addOption('', '--name', dest='name', help='Experiment name. Either id or name must be provided. If both are provided, id takes precedence.')
+
+    def checkArgs(self):
+        if self.options.id is None and self.options.username is None:
+            raise InvalidRequest('Either user id or username must be provided.')
+
+    def getId(self):
+        return self.options.id
+
+    def getName(self):
+        return self.options.name
+
+    def runCommand(self):
+        self.parseArgs(usage="""
+    dm-get-user --id=ID|--name=NAME
+
+Description:
+    Retrieves experiment information.
+        """)
+        self.checkArgs()
+        api = ExperimentRestApi(self.getLoginUsername(), self.getLoginPassword(), self.getServiceHost(), self.getServicePort(), self.getServiceProtocol())
+        if self.getId() is not None:
+            experiment = api.getExperimentById(self.getId())
+        else:
+            experiment = api.getExperimentByName(self.getName())
+        print experiment.getDisplayString(self.getDisplayKeys(), self.getDisplayFormat())
+
+#######################################################################
+# Run command.
+if __name__ == '__main__':
+    cli = GetExperimentCli()
+    cli.run()
+

src/python/dm/ds_web_service/cli/getExperimentTypesCli.py

+#!/usr/bin/env python
+
+from dm.ds_web_service.api.experimentRestApi import ExperimentRestApi
+from dsWebServiceSessionCli import DsWebServiceSessionCli
+
+class GetExperimentTypesCli(DsWebServiceSessionCli):
+    def __init__(self):
+        DsWebServiceSessionCli.__init__(self)
+
+    def runCommand(self):
+        self.parseArgs(usage="""
+    dm-get-experiment-types 
+
+Description:
+    Retrieves list of known experiment types.
+        """)
+        api = ExperimentRestApi(self.getLoginUsername(), self.getLoginPassword(), self.getServiceHost(), self.getServicePort(), self.getServiceProtocol())
+        experimentTypes = api.getExperimentTypes()
+        for experimentType in experimentTypes:
+            print experimentType.getDisplayString(self.getDisplayKeys(), self.getDisplayFormat())
+
+
+#######################################################################
+# Run command.
+if __name__ == '__main__':
+    cli = GetExperimentTypesCli()
+    cli.run()

src/python/dm/ds_web_service/cli/getExperimentsCli.py

+#!/usr/bin/env python
+
+from dm.ds_web_service.api.experimentRestApi import ExperimentRestApi
+from dsWebServiceSessionCli import DsWebServiceSessionCli
+
+class GetExperimentsCli(DsWebServiceSessionCli):
+    def __init__(self):
+        DsWebServiceSessionCli.__init__(self)
+
+    def runCommand(self):
+        self.parseArgs(usage="""
+    dm-get-experiments 
+
+Description:
+    Retrieves list of known experiments.
+        """)
+        api = ExperimentRestApi(self.getLoginUsername(), self.getLoginPassword(), self.getServiceHost(), self.getServicePort(), self.getServiceProtocol())
+        experiments = api.getExperiments()
+        for experiment in experiments:
+            print experiment.getDisplayString(self.getDisplayKeys(), self.getDisplayFormat())
+
+
+#######################################################################
+# Run command.
+if __name__ == '__main__':
+    cli = GetExperimentsCli()
+    cli.run()

src/python/dm/ds_web_service/cli/getUserCli.py

+#!/usr/bin/env python
+
+from dm.common.exceptions.invalidRequest import InvalidRequest
+from dm.ds_web_service.api.userRestApi import UserRestApi
+from dsWebServiceSessionCli import DsWebServiceSessionCli
+
+class GetUserCli(DsWebServiceSessionCli):
+    def __init__(self):
+        DsWebServiceSessionCli.__init__(self)
+        self.addOption('', '--id', dest='id', help='User id. Either id or username must be provided. If both are provided, id takes precedence.')
+        self.addOption('', '--username', dest='username', help='User username. Either id or username must be provided. If both are provided, id takes precedence.')
+
+    def checkArgs(self):
+        if self.options.id is None and self.options.username is None:
+            raise InvalidRequest('Either user id or username must be provided.')
+
+    def getId(self):
+        return self.options.id
+
+    def getUsername(self):
+        return self.options.username
+
+    def runCommand(self):
+        self.parseArgs(usage="""
+    dm-get-user --id=ID|--username=USERNAME
+
+Description:
+    Retrieves user information.
+        """)
+        self.checkArgs()
+        api = UserRestApi(self.getLoginUsername(), self.getLoginPassword(), self.getServiceHost(), self.getServicePort(), self.getServiceProtocol())
+        if self.getId() is not None:
+            userInfo = api.getUserById(self.getId())
+        else:
+            userInfo = api.getUserByUsername(self.getUsername())
+        print userInfo.getDisplayString(self.getDisplayKeys(), self.getDisplayFormat())
+
+#######################################################################
+# Run command.
+if __name__ == '__main__':
+    cli = GetUserCli()
+    cli.run()

src/python/dm/ds_web_service/cli/getUsersCli.py

+#!/usr/bin/env python
+
+from dm.ds_web_service.api.userRestApi import UserRestApi
+from dsWebServiceSessionCli import DsWebServiceSessionCli
+
+class GetUsersCli(DsWebServiceSessionCli):
+    def __init__(self):
+        DsWebServiceSessionCli.__init__(self)
+
+    def runCommand(self):
+        self.parseArgs(usage="""
+    dm-get-users 
+
+Description:
+    Retrieves list of registered users.
+        """)
+        api = UserRestApi(self.getLoginUsername(), self.getLoginPassword(), self.getServiceHost(), self.getServicePort(), self.getServiceProtocol())
+        users = api.getUsers()
+        for user in users:
+            print user.getDisplayString(self.getDisplayKeys(), self.getDisplayFormat())
+
+
+#######################################################################
+# Run command.
+if __name__ == '__main__':
+    cli = GetUsersCli()
+    cli.run()

src/python/dm/ds_web_service/cli/startExperimentCli.py

+#!/usr/bin/env python
+
+from dm.ds_web_service.api.experimentRestApi import ExperimentRestApi
+from dm.common.exceptions.invalidRequest import InvalidRequest
+from dsWebServiceSessionCli import DsWebServiceSessionCli
+
+class StartExperimentCli(DsWebServiceSessionCli):
+    def __init__(self):
+        DsWebServiceSessionCli.__init__(self)
+        self.addOption('', '--name', dest='name', help='Experiment name.')
+
+    def checkArgs(self):
+        if self.options.name is None:
+            raise InvalidRequest('Experiment name must be provided.')
+
+    def getName(self):
+        return self.options.name
+
+    def runCommand(self):
+        self.parseArgs(usage="""
+    dm-start-experiment --name=NAME
+
+Description:
+    Updates experiment start time in the DM database and prepares experiment data directory.
+        """)
+        self.checkArgs()
+        api = ExperimentRestApi(self.getLoginUsername(), self.getLoginPassword(), self.getServiceHost(), self.getServicePort(), self.getServiceProtocol())
+        experiment = api.startExperiment(self.getName())
+        print experiment.getDisplayString(self.getDisplayKeys(), self.getDisplayFormat())
+
+#######################################################################
+# Run command.
+if __name__ == '__main__':
+    cli = StartExperimentCli()
+    cli.run()
+

src/python/dm/ds_web_service/cli/stopExperimentCli.py

+#!/usr/bin/env python
+
+from dm.ds_web_service.api.experimentRestApi import ExperimentRestApi
+from dm.common.exceptions.invalidRequest import InvalidRequest
+from dsWebServiceSessionCli import DsWebServiceSessionCli
+
+class StopExperimentCli(DsWebServiceSessionCli):
+    def __init__(self):
+        DsWebServiceSessionCli.__init__(self)
+        self.addOption('', '--name', dest='name', help='Experiment name.')
+
+    def checkArgs(self):
+        if self.options.name is None:
+            raise InvalidRequest('Experiment name must be provided.')
+
+    def getName(self):
+        return self.options.name
+
+    def runCommand(self):
+        self.parseArgs(usage="""
+    dm-stop-experiment --name=NAME
+
+Description:
+    Updates experiment end date in the DM database and checks experiment data permissions.
+        """)
+        self.checkArgs()
+        api = ExperimentRestApi(self.getLoginUsername(), self.getLoginPassword(), self.getServiceHost(), self.getServicePort(), self.getServiceProtocol())
+        experiment = api.stopExperiment(self.getName())
+        print experiment.getDisplayString(self.getDisplayKeys(), self.getDisplayFormat())
+
+#######################################################################
+# Run command.
+if __name__ == '__main__':
+    cli = StopExperimentCli()
+    cli.run()
+