wmglobalqueue 2.3.10__py3-none-any.whl

WMCore/GroupUser/CouchObject.py

@@ -0,0 +1,127 @@
+#!/usr/bin/env python
+# encoding: utf-8
+"""
+CouchObject.py
+
+Created by Dave Evans on 2010-07-14.
+Copyright (c) 2010 Fermilab. All rights reserved.
+"""
+from __future__ import print_function
+
+from builtins import str
+import json as jsonlib
+
+import WMCore.Database.CMSCouch as CMSCouch
+import WMCore.GroupUser.Decorators as Decorators
+
+
+class CouchConnectionError(Exception):
+    """docstring for CouchConnectionError"""
+
+    def __init__(self, arg):
+        super(CouchConnectionError, self).__init__()
+        self.arg = arg
+
+
+class CouchObject(dict):
+    """
+    Base class for dictionary derived couch documents for this package.
+    (May even be generally useful...)
+
+    Essentially a specialised dict class that has attributes needed to talk to Couch
+    via the CMSCouch API.
+
+    This class is expected to be overridden and the derived class must override the document_id
+    property to generate the document id from the data within the dictionary.
+    This class assumes some simple mapping is used to generate the document ID as a property, rather
+    on doing anything too fancy
+    """
+
+    def __init__(self):
+        dict.__init__(self)
+        self.couch = None
+        self.cdb_server = None
+        self.cdb_database = None
+        self.cdb_url = None
+        self.cdb_document_id = None
+        self.cdb_document_data = "CouchObject"
+
+    connected = property(lambda x: x.couch is not None)
+    json = property(lambda x: jsonlib.dumps(dict(x)))
+    # doc_id default returns None, which signals use couch-generated doc id
+    document_id = property(lambda x: None)
+
+    def setCouch(self, url, database):
+        """
+        _setCouch_
+
+        Set the contant info for the couch database
+        """
+        self.cdb_url = url
+        self.cdb_database = database
+
+    def connect(self):
+        """
+        _connect_
+
+        Initialise the couch database connection for this object.
+        This gets called automagically by the requireConnected decorator
+        """
+        if self.connected:
+            return
+        if self.cdb_url is None:
+            msg = "url for couch service not provided"
+            raise CouchConnectionError(msg)
+        if self.cdb_database is None:
+            msg = "database name for couch service not provided"
+            raise CouchConnectionError(msg)
+        try:
+            self.cdb_server = CMSCouch.CouchServer(self.cdb_url)
+            self.couch = self.cdb_server.connectDatabase(self.cdb_database)
+        except Exception as ex:
+            msg = "Exception instantiating couch services for :\n"
+            msg += " url = %s\n database = %s\n" % (self.cdb_url, self.cdb_database)
+            msg += " Exception: %s" % str(ex)
+            print(msg)
+            raise CouchConnectionError(msg)
+
+    @Decorators.requireConnection
+    def create(self):
+        """
+        _create_
+
+        Create the couch document for this object.
+        """
+        if not self.couch.documentExists(self.document_id):
+            couchDoc = CMSCouch.Document(self.document_id, {self.cdb_document_data: dict(self)})
+            self.couch.commitOne(couchDoc)
+
+    @Decorators.requireConnection
+    def get(self):
+        """
+        _get_
+
+        given the doc_id generated from the derived class, get the document and update
+        the data in the dictionary from it
+
+        """
+        if not self.couch.documentExists(self.document_id):
+            raise RuntimeError("Document: %s not found" % self.document_id)
+
+        doc = self.couch.document(self.document_id)
+        data = doc.get(self.cdb_document_data, {})
+        dict.update(self, data)
+        return
+
+    @Decorators.requireConnection
+    def drop(self):
+        """
+        _drop_
+
+        remove the doc representing this object, possibly with a chained wipeout
+        of all other docs referencing it by owner or group or whatever, if thats
+        needed, override in the classes derived from this
+        """
+        if not self.couch.documentExists(self.document_id):
+            raise RuntimeError("Document: %s not found" % self.document_id)
+        self.couch.delete_doc(self.document_id)

WMCore/GroupUser/Decorators.py

@@ -0,0 +1,51 @@
+#!/usr/bin/env python
+# encoding: utf-8
+"""
+Decorators.py
+
+Decorator Utils for GroupUser modules
+
+Created by Dave Evans on 2010-07-20.
+Copyright (c) 2010 Fermilab. All rights reserved.
+"""
+
+def requireConnection(funcRef):
+    """
+    _requireConnection_
+
+    Decorator method to connect the function's class object to couch
+    """
+    def wrapper(self, *args, **opts):
+        if not self.connected:
+            self.connect()
+        return funcRef(self, *args, **opts)
+    return wrapper
+
+def requireGroup(funcRef):
+    """
+    _requireGroup_
+
+    Decorator method to enforce setting a group attribute
+
+    """
+    def wrapper(self, *args, **opts):
+        if getattr(self, "group", None) == None:
+            msg = "Group Attribute not present/set"
+            raise RuntimeError(msg)
+        return funcRef(self, *args, **opts)
+    return wrapper
+
+
+def requireUser(funcRef):
+    """
+    _requireUser_
+
+    Decorator method to enforce setting a user attribute for another
+    object
+    """
+    def wrapper(self, *args, **opts):
+        if getattr(self, "owner", None) == None:
+            msg = "Group Attribute not present/set"
+            raise RuntimeError(msg)
+        return funcRef(self, *args, **opts)
+    return wrapper

WMCore/GroupUser/Group.py

@@ -0,0 +1,33 @@
+#!/usr/bin/env python
+# encoding: utf-8
+"""
+Group.py
+
+Created by Dave Evans on 2010-07-14.
+Copyright (c) 2010 Fermilab. All rights reserved.
+"""
+
+
+
+import json
+
+from WMCore.GroupUser.CouchObject import CouchObject
+
+
+class Group(CouchObject):
+    """
+    _Group_
+
+    Dictionary object containing attributes of a group
+
+    """
+    def __init__(self, **options):
+        CouchObject.__init__(self)
+        self.cdb_document_data = "group"
+        self.setdefault('name', None)
+        self.setdefault('administrators', [])
+        self.setdefault('associated_sites', {})
+        self.update(options)
+
+    document_id = property(lambda x : "group-%s" % x['name'] )
+    name = property(lambda x: x['name'])

WMCore/GroupUser/Interface.py

@@ -0,0 +1,73 @@
+#!/usr/bin/env python
+# encoding: utf-8
+"""
+Interface.py
+
+Created by Dave Evans on 2010-07-21.
+Copyright (c) 2010 Fermilab. All rights reserved.
+"""
+from __future__ import print_function
+
+
+
+from builtins import str, object
+
+import WMCore.Database.CMSCouch as CMSCouch
+
+class CouchConnectionError(Exception):
+    """docstring for CouchConnectionError"""
+    def __init__(self, arg):
+        super(CouchConnectionError, self).__init__()
+        self.arg = arg
+
+
+class Interface(object):
+    def __init__(self, couchUrl, couchDatabase):
+        self.cdb_url = couchUrl
+        self.cdb_database = couchDatabase
+        try:
+            self.cdb_server = CMSCouch.CouchServer(self.cdb_url)
+            self.couch = self.cdb_server.connectDatabase(self.cdb_database)
+        except Exception as ex:
+            msg = "Exception instantiating couch services for :\n"
+            msg += " url = %s\n database = %s\n" % (self.cdb_url, self.cdb_database)
+            msg += " Exception: %s" % str(ex)
+            print(msg)
+            raise CouchConnectionError(msg)
+
+
+    def documentsOwned(self, group, user):
+        """
+        _documentsOwned_
+
+        Get a list of doc IDs that are owned by the group/user pair
+
+        """
+        result = self.couch.loadView("GroupUser", 'owner_group_user',
+                 {'startkey' :[group, user],
+                   'endkey' : [group, user]}, []
+                )
+        output = [str(x[u'id']) for x in result[u'rows']]
+        return output
+
+
+
+    def callUpdate(self, update, document, **args ):
+        """
+        _callUpdate_
+
+        Wrapper primarily for calling/testing update methods on the groupuser couchapp
+
+         * update - name of the update method in the couchapp
+         * document - ID of the document to be updated
+         * args  - key:value dict of args to be encoded in the PUT request
+
+        """
+        updateUri = "/" + self.couch.name + "/_design/GroupUser/_update/"+ update + "/" + document
+        argsstr = "?"
+        for k, v in list(args.items()):
+            argsstr += "%s=%s&" % (k, v)
+        updateUri += argsstr
+        updateUri= updateUri[:-1]
+        self.couch.makeRequest(uri = updateUri, type = "PUT", decode = False)
+        return

WMCore/GroupUser/User.py

@@ -0,0 +1,96 @@
+#!/usr/bin/env python
+# encoding: utf-8
+"""
+User.py
+
+Created by Dave Evans on 2010-07-14.
+Copyright (c) 2010 Fermilab. All rights reserved.
+"""
+
+from WMCore.GroupUser.CouchObject import CouchObject
+import WMCore.GroupUser.Decorators as Decorators
+from WMCore.GroupUser.Group import Group
+
+
+
+class User(CouchObject):
+    """
+    _User_
+
+
+    """
+    def __init__(self, **options):
+        CouchObject.__init__(self)
+        self.cdb_document_data = "user"
+        self.setdefault('name', None)
+        self.setdefault('proxy', {})
+        self.couch_url = None
+        self.couch_db = None
+        self.group = None
+        self.update(options)
+
+    document_id = property(lambda x : "user-%s" % x['name'] )
+    name = property(lambda x: x['name'])
+
+    def setGroup(self, groupInstance):
+        """
+        _setGroup_
+
+        Set the group attribute of this object
+        """
+        self.group = groupInstance
+        self['group'] = groupInstance['name']
+        if groupInstance.connected:
+            # if the group already has the couch instance in it, borrow those settings
+            self.setCouch(groupInstance.cdb_url, groupInstance.cdb_database)
+
+    @Decorators.requireConnection
+    @Decorators.requireGroup
+    def ownThis(self, document):
+        """
+        _ownThis_
+
+        Given a Couch Document, insert the details of this owner in a standard
+        way so that the document can be found using the standard group/user views
+        Note: if doc doesnt have both _id and _rev keys this change wont stick
+        """
+        document['owner'] = {}
+        document['owner']['user'] = self['name']
+        document['owner']['group'] = self.group['name']
+
+        retval = self.couch.commitOne(document)
+        document["_id"] = retval[0]["id"]
+        document["_rev"] = retval[0]["rev"]
+        return
+
+    @Decorators.requireConnection
+    @Decorators.requireGroup
+    def create(self):
+        """
+        _create_
+
+        Overide the base class create to make sure the group exists when adding the user
+        (Note: Overriding wipes out decorators...)
+        """
+        if not self.couch.documentExists(self.group.document_id):
+            # no group => create group
+            self.group.create()
+        # call base create to make user
+        CouchObject.create(self)
+
+#ToDo: Override drop to drop all documents owned by the owner...
+
+def makeUser(groupname, username, couchUrl = None, couchDatabase = None):
+    """
+    _makeUser_
+
+    factory like util that creates a user and group object
+
+    """
+    group = Group(name = groupname)
+    if couchUrl != None:
+        group.setCouch(couchUrl, couchDatabase)
+        group.connect()
+    user  = User(name = username)
+    user.setGroup(group)
+    return user

WMCore/GroupUser/__init__.py

@@ -0,0 +1,11 @@
+#!/usr/bin/env python
+# encoding: utf-8
+"""
+__init__.py
+
+Created by Dave Evans on 2010-07-14.
+Copyright (c) 2010 Fermilab. All rights reserved.
+"""
+
+import sys
+import os