updates to httpops

Started adding AM for OSLC Query - but not working yet!
All HTTP operatoins now include two custom headers to make it easier to see where in the code the message was started from - elmclient-Intent and elmclient-Trace (with a stack trace)
Started adding API demonstrator for the >=7.1 RM types API - not working yet!

Author: barny

elmclient/_ccm.py

@@ -465,10 +465,10 @@ def __init__(self, name, project_uri, app, is_optin,singlemode):
 class AMApp(_app._App, _typesystem.No_Type_System_Mixin):
     domain = 'am'
     project_class = AMProject
-    supports_configs = False
-    supports_components = False
-    supports_reportable_rest = False
-    reportable_rest_status = "Application does not support Reportable REST"
+    supports_configs = True
+    supports_components = True
+    supports_reportable_rest = True
+    reportable_rest_status = "Application does support Reportable REST see https://jazz.net/wiki/bin/view/Main/RMMReportableRestAPI"
     identifier_uri = 'dcterms:identifier'
 
     def __init__(self, server, contextroot, jts=None):

elmclient/_customScenarios.py

@@ -128,7 +128,7 @@ def getRunningScenarios( self ):
     LOGLEVEL    = os.environ.get("QUERY_LOGLEVEL"   ,None )
 
     # setup arghandler
-    parser = argparse.ArgumentParser(description="Test harness for CusgtomScenarios")
+    parser = argparse.ArgumentParser(description="Test harness for CustomScenarios")
 
     parser.add_argument('action', choices=['start','stop','status'], help=f'start/stop/status')
     parser.add_argument('name', default=None, nargs='?', help=f'The anme of the scenario - only relevant for the start and stop actions')

elmclient/_project.py

@@ -75,7 +75,7 @@ def _get_typeuri_rdf(self,uri):
             logger.info( utils.callers() )
             try:
                 # try to retrieve the rdf using no_error_log=True becase some urls don't exist and we don't really mind if it can't be retrieved, e.g. /jts/users/unassigned which never exits in JTS
-                self._gettypecache[realuri] = self.execute_get_rdf_xml(uri, intent="Retrieve type definition", no_error_log=True) if uri.startswith( "https://") else None
+                self._gettypecache[realuri] = self.execute_get_rdf_xml(uri, intent="Retrieve type definition", no_error_log=True, cacheable=True) if uri.startswith( "https://") else None
                 logger.info( f"Retrieved:" )
             except ET.XMLSyntaxError:
                  self._gettypecache[realuri] = None
@@ -256,6 +256,7 @@ def set_local_config(self, name_or_uri, global_config_uri=None):
 #                    print( f"Checking {config=} for {self.project_uri=}" )
                     if config['componentUri'] == self.project_uri:
                         config_uri = config['configurationUri']
+                        break  # first match is correct according to GC SDK https://jazz.net/gc/doc/scenario?id=GetFlatListOfContributionsForGcHiearchy
             if not config_uri:
                 raise Exception( 'Cannot find configuration [%s] in project [%s]' % (name_or_uri, self.uri))
         else:
@@ -293,9 +294,10 @@ def resolve_shape_name_to_uri(self, name, exception_if_not_found=True):
     # the context is the shape definition - can be None, needed to be specified ultimately by the user when property names aren't unique
     def resolve_property_name_to_uri(self, name, shapeuri=None, exception_if_not_found=True):
         logger.info( f"resolve_property_name_to_uri {name=} {shapeuri=}" )
+#        print( f"resolve_property_name_to_uri {name=} {shapeuri=}" )
 #        result = self.get_property_uri(name,shape_uri=shapeuri) or self.get_linktype_uri(name,shape_uri=shapeuri)
         result = self.get_property_uri(name, shape_uri=shapeuri) or self.get_linktype_uri(name)
-        logger.info( f"resolve_property_name_to_uri {name=} {shapeuri=} {result=}" )
+#        print( f"resolve_property_name_to_uri {name=} {shapeuri=} {result=}" )
         return result
 
     # for OSLC query, given an enumeration value name in and context (property uri), return its URI
@@ -487,33 +489,35 @@ def _generic_load_type_from_resource_shape(self, el, supershape=None):
             logger.info( "Starting a property")
             propnodeid = rdfxml.xmlrdf_get_resource_uri( propel, attrib="rdf:nodeID" )
             logger.info( f"{propnodeid=}" )
-            logger.info( f"{propnodeid=}" )
+#            print( f"{propnodeid=}" )
             real_propel_x = rdfxml.xml_find_element( shapedef_x, f'.//rdf:Description[@rdf:nodeID="{propnodeid}"]' )
             logger.info( f"{real_propel_x=}" )
-            logger.info( f"{real_propel_x=}" )
+#            print( f"{real_propel_x=}" )
 #            print( "XML==",ET.tostring(real_propel_x) )
             # dcterms:title xml:lang="en"
             property_title_el = rdfxml.xml_find_element( real_propel_x, './dcterms:title[@xml:lang="en"]')
             logger.info( f"1 {property_title_el=}" )
+#            print( f"1 {property_title_el=}" )
             if property_title_el is None:
                 property_title_el = rdfxml.xml_find_element(real_propel_x, './dcterms:title[@rdf:datatype]' )
                 logger.info( f"2 {property_title_el=}" )
+#                print( f"2 {property_title_el=}" )
             if property_title_el is None:
                 property_title_el = rdfxml.xml_find_element( real_propel_x, './oslc:name')
                 logger.info( f"3 {property_title_el=}" )
+#                print( f"3 {property_title_el=}" )
             logger.info( f"{property_title_el=}" )
-            logger.info( f"{property_title_el=}" )
+#            print( f"{property_title_el=}" )
             if property_title_el is None:
                 logger.info( "Skipping shape with no title!" )
-                logger.info( "Skipping shape with no title!" )
-                burp
+#                print( "Skipping shape with no title!" )
                 continue
             property_title = property_title_el.text
             logger.info( f"{property_title=}" )
-            logger.info( f"{property_title=}" )
+#            print( f"{property_title=}" )
             if rdfxml.xmlrdf_get_resource_text(real_propel_x,"oslc:hidden") == "true":
                 logger.info( f"Skipping hidden property {property_title}" )
-                logger.info( f"Skipping hidden property {property_title}" )
+#                print( f"Skipping hidden property {property_title}" )
                 continue
             valueshape_uri = rdfxml.xmlrdf_get_resource_uri( real_propel_x,'./oslc:valueShape' )
             logger.info( f"{valueshape_uri=}" )

elmclient/_qm.py

@@ -159,6 +159,7 @@ def load_components_and_configurations(self,force=False):
             logger.debug( f"full optin" )
             cmsp_xml = self.app.retrieve_cm_service_provider_xml()
             logger.info( f"cmsp=",ET.tostring(cmsp_xml) )
+#            print( f"cmsp=",ET.tostring(cmsp_xml) )
 #  <rdf:Description rdf:nodeID="A4">
 #    <oslc:resourceType rdf:resource="http://open-services.net/ns/config#Component"/>
 #    <oslc:queryBase rdf:resource="https://jazz.ibm.com:9443/qm/oslc_config/resources/com.ibm.team.vvc.Component"/>
@@ -167,11 +168,21 @@ def load_components_and_configurations(self,force=False):
 #    <rdf:type rdf:resource="http://open-services.net/ns/core#QueryCapability"/>
 #  </rdf:Description>
 
-            components_uri = rdfxml.xmlrdf_get_resource_uri(cmsp_xml, './/rdf:Description/rdf:type[@rdf:resource="http://open-services.net/ns/core#QueryCapability"]/../oslc:resourceType[@rdf:resource="http://open-services.net/ns/config#Component"]/../oslc:queryBase')
-            logger.info( f"{components_uri=}" )
-#            print( f"{components_uri=}" )
+            components_x = rdfxml.xml_find_element(cmsp_xml, './/rdf:Description/rdf:type[@rdf:resource="http://open-services.net/ns/core#QueryCapability"]/../oslc:resourceType[@rdf:resource="http://open-services.net/ns/config#Component"]/../oslc:queryBase')
+            component_uri = rdfxml.xmlrdf_get_resource_uri( components_x )
+            logger.info( f"1 {component_uri=}" )
+            if not component_uri:
+                component_x = rdfxml.xml_find_element(cmsp_xml, './/rdf:Description/oslc:resourceType[@rdf:resource="http://open-services.net/ns/config#Component"]/../oslc:queryBase')
+#                component_x = rdfxml.xml_find_element(cmsp_xml, './/rdf:Description/oslc:resourceType[@rdf:resource="http://open-services.net/ns/config#Component"]/../oslc:queryBase')
+#                print( f"{component_x=}" )
+                component_uri = rdfxml.xmlrdf_get_resource_uri(component_x)
+#                print( f"3 {component_uri=}" )
+#                burp
+                
+            logger.info( f"{component_uri=}" )
+#            print( f"2 {component_uri=}" )
             # get all components
-            crx = self.execute_get_xml( components_uri, intent="Retrieve component definition" )
+            crx = self.execute_get_xml( component_uri, intent="Retrieve component definitions" )
             logger.info( f"{crx=}" )
 #      <oslc_config:Component rdf:about="https://jazz.ibm.com:9443/qm/oslc_config/resources/com.ibm.team.vvc.Component/_iw4s4EB3Eeus6Zk4qsm_Cw">
 #        <dcterms:title rdf:parseType="Literal">SGC Agile</dcterms:title>
@@ -185,11 +196,13 @@ def load_components_and_configurations(self,force=False):
 #        <dcterms:relation rdf:resource="https://jazz.ibm.com:9443/qm/service/com.ibm.rqm.integration.service.IIntegrationService/resources/_rikP0EB1Eeus6Zk4qsm_Cw/component/_iw4s4EB3Eeus6Zk4qsm_Cw"/>
 #      </oslc_config:Component>
 
-            for component_el in rdfxml.xml_find_elements(crx, f'.//oslc_config:Component/process:projectArea[@rdf:resource="{self.project_uri}"]/..'):
+            for component_el in rdfxml.xml_find_elements(crx, f'.//oslc_config:Component/process:projectArea[@rdf:resource="{self.project_uri}"]/..') or rdfxml.xml_find_elements(crx, f'.//rdf:Description/process:projectArea[@rdf:resource="{self.project_uri}"]/..'):
                 logger.info( f"{component_el=}" )
+#                print( f"{component_el=}" )
                 compu = rdfxml.xmlrdf_get_resource_uri(component_el)
                 comptitle = rdfxml.xmlrdf_get_resource_text(component_el, './/dcterms:title')
                 logger.info( f"Found component {comptitle}" )
+#                print( f"Found component {comptitle}" )
                 ncomps += 1
                 confu = rdfxml.xmlrdf_get_resource_uri(component_el, './/oslc_config:configurations')
                 self._components[compu] = {'name': comptitle, 'configurations': {}, 'confs_to_load': [confu]}
@@ -498,7 +511,7 @@ def queryResourcesByIDs( self, identifiers, *, querytype=None, filterFunction=No
         identifiers = [str(i) for i in identifiers]
 #        print( f"{identifiers=}" )
         for i in identifiers:
-            print( f"{i=}" )
+#            print( f"{i=}" )
             if not utils.isint( str(i) ):
                 raise Exception( "value '{i}' is not an integer!" )
 

elmclient/_queryparser.py

@@ -294,6 +294,7 @@ def simpleidentifier(self,s):
             raise Exception( "Bad simpleidentifier" )
         resultname = s[0].value
         # look it up and if necessary store to mapping
+#        print( f"{self=} {self.resolverobject=} {self.resolverobject.resolve_property_name_to_uri=} {resultname=}" )
         result = self.resolverobject.resolve_property_name_to_uri(resultname)
         if result is None:
             raise Exception("Name resolution for %s failed!" % (resultname))

elmclient/_rm.py

@@ -27,6 +27,7 @@
 from . import utils
 from . import _newtypesystem
 from . import resource
+from . import _rmtypesapi
 
 # used for OSLC Query on types
 typeresources = {
@@ -39,17 +40,50 @@
 
 class CoreResource( resource.Resource ):
     name = "Core"
+    def getBindings( self ):
+        raise Exception( "Save not implemented yet" )
+        pass
 
 class BindingResource( resource.Resource):
     name = "Binding"
-    
+    moduleResource=None
+    coreResource=None
+    def _getSection():
+        pass
+    def _getCoreResource(self):
+        pass
+    def _getParent(self):
+        pass
+    def _getChildren( self):
+        pass
+    def addBelow(self,coreid_or_coreresource_or_artifacttype):
+        # add new binding below
+        pass
+    def addAfter( self,coreid_or_coreresource_or_artifacttype ):
+        # add new binding after
+        pass
+    def moveAfter( self, binding ):
+        # move self and all children
+        pass
+    def moveBelow( self, binding ):
+        # move self and all children
+        pass
+    def delete( self ):
+        # delete self and all children
+        pass
+        
 class ModuleResource( resource.Resource ):
     name = "Module"
-    
+    structureResource=None
+    bindingHierarchyRoot=None # this will be an AnyTree, each entry pointing at a BindingResource
     def getModuleBindings( self ):
         raise Exception( "Save not implemented yet" )
         pass
-
+    def findBindingBySection( self, section ):
+        pass
+    def iterateHierarchy( self ):
+        pass
+        
 class WrapperResource( resource.Resource ):
     name="Wrapper"
 
@@ -210,7 +244,7 @@ class _RM_PA_changeset( _config._Changeset,_RMProject):
         pass
 
 @utils.mixinomatic
-class RMProject(_project._Project, resource.Resources_Mixin ):
+class RMProject(_project._Project, resource.Resources_Mixin, _rmtypesapi.RMTypes_Mixin ):
     # A project
     # NOTE there is a derived class RMComponent used for RM components - it doesn't offer any
     #   functionality, and is a separate class only so it's easier to see whether an instance is a component or the overall project