moved to new env

Author: barny

elmclient/_config.py

@@ -0,0 +1,84 @@
+##
+## © Copyright 2021- IBM Inc. All rights reserved
+# SPDX-License-Identifier: MIT
+##
+
+import datetime
+import logging
+import re
+import sys
+
+import anytree
+import dateutil.parser
+import dateutil.tz
+import lxml.etree as ET
+import requests
+import tqdm
+import pytz
+
+from . import _app
+from . import _project
+from . import _typesystem
+from . import oslcqueryapi
+from . import rdfxml
+from . import server
+from . import utils
+
+#################################################################################################
+
+logger = logging.getLogger(__name__)
+
+#################################################################################################
+
+BASELINE  = 1
+STREAM    = 2
+CHANGESET = 3
+
+class _Config():
+    configtype = None
+    def __init__(self, *ags, **kwargs ):
+        print( f"Config init {self=}" )
+        pass
+    def is_stream(self):
+        return self.configtype == STREAM
+    def is_baseline(self):
+        return self.configtype == BASELINE
+    def is_changeset(self):
+        return self.configtype == CHANGESET
+
+class _Stream(_Config):
+    configtype = STREAM
+    from_baseline = None
+    baselines = []
+    changesets = []
+    def __init__( self, *args, **kwargs ):
+        super().__init__( *args, **kwargs )
+        
+    def create_baseline(self):
+        pass
+    def create_changeset(self):
+        pass
+    pass
+
+class _Baseline(_Config):
+    configtype = BASELINE
+    instream = None
+    streams = []
+    
+    def __init__( self, *args, **kwargs ):
+        super().__init__( *args, **kwargs )
+    def create_stream(self):
+        pass
+
+class _Changeset(_Config):
+    configtype = CHANGESET
+    instream=None
+    def __init__( self, *args, **kwargs ):
+        super().__init__( *args, **kwargs )
+        
+    def deliver(self):
+        pass
+    def discard(self):
+        pass
+        
+

elmclient/_project.py

@@ -55,6 +55,9 @@ def __init__(self, name, project_uri, app, is_optin=False, singlemode=False,defa
             # the services.xml will be retrieved later when needed, because the config to retrieve it in isn't currently known there's no point retrieving it now
         return
 
+    def listmembers( self ):
+        pass
+
     def load_types(self):
         self._load_types()
 

elmclient/_queryparser.py

@@ -317,6 +317,7 @@ def dottedname(self,s):
 
     def identifier(self, s):
         logger.info( f"Identifier {s=}" )
+        print( f"Identifier {s=}" )
         if len(s) == 1:
             if type(s[0])==str:
                 result = s[0]

elmclient/_rm.py

@@ -17,6 +17,7 @@
 import pytz
 
 from . import _app
+from . import _config
 from . import _project
 from . import _typesystem
 from . import oslcqueryapi
@@ -39,6 +40,20 @@ def __init__(self, name=None, folderuri=None, parent=None):
 
 #################################################################################################
 
+if False:
+    @utils.mixinomatic
+    class _RM_PA_stream( _config._Stream,_RMProject ):
+        pass
+
+    @utils.mixinomatic
+    class _RM_PA_baseline( _config._Baseline,_RMProject ):
+        pass
+        
+    @utils.mixinomatic
+    class _RM_PA_changeset( _config._Changeset,_RMProject):
+        pass
+
+@utils.mixinomatic
 class _RMProject(_project._Project):
     # A project
     # NOTE there is a derived class RMComponent used for RM components - it doesn't offer any
@@ -47,7 +62,7 @@ class _RMProject(_project._Project):
     # For full optin there are as many components as real components; for <=6.0.3 Cfgm-enabled and for >=7.0
     #   CfgM-disabled (called single mode), there's only ever a single component
     def __init__(self, name, project_uri, app, is_optin=False, singlemode=False,defaultinit=True):
-        super().__init__(name, project_uri, app, is_optin,singlemode,defaultinit=defaultinit)
+#        super().__init__(name, project_uri, app, is_optin,singlemode,defaultinit=defaultinit)
 #        self.oslcquery = oslcqueryapi._OSLCOperations(self.app.server,self)
         self._components = None  # keyed on component uri
         self._configurations = None # keyed on the config name
@@ -290,7 +305,7 @@ def load_components_and_configurations(self,force=False):
 
                 for component_el in rdfxml.xml_find_elements(crx, './/ldp:contains'):
                     compu = component_el.get("{%s}resource" % rdfxml.RDF_DEFAULT_PREFIX["rdf"])
-                    compx = self.execute_get_rdf_xml(compu, intent="Retrieve component definition to find configurations")
+                    compx = self.execute_get_rdf_xml(compu, intent="Retrieve component definition to find all configurations", action="Retrieve each configuration")
                     comptitle = rdfxml.xmlrdf_get_resource_text(compx, './/dcterms:title')
 
                     self._components[compu] = {'name': comptitle, 'configurations': {}}
@@ -676,7 +691,7 @@ def get_default_stream_name( self ):
 class _RMComponent(_RMProject):
     def __init__(self, name, project_uri, app, is_optin=False, singlemode=False,defaultinit=True, project=None):
         if not project:
-            raise Exception( "You mist provide a project instance when creating a component" )
+            raise Exception( "You must provide a project instance when creating a component" )
         super().__init__(name, project_uri, app, is_optin,singlemode,defaultinit=defaultinit)
         self.component_project = project
         self.services_uri = project.services_uri    # needed for reqif which wants to put the services.xml URI into created XML for new definitions
@@ -693,7 +708,7 @@ class _RMApp(_app._App, _typesystem.No_Type_System_Mixin):
     supports_components = True
     supports_reportable_rest = True
     reportablerestbase='publish'
-    reportable_rest_status = "Supported by applicaiton and implemented here"
+    reportable_rest_status = "Supported by application and implemented here"
     artifact_formats = [ # For RR
             'collections'
             ,'comments'
@@ -717,7 +732,7 @@ class _RMApp(_app._App, _typesystem.No_Type_System_Mixin):
 
     def __init__(self, server, contextroot, jts=None):
         super().__init__(server, contextroot, jts=jts)
-        self.rootservices_xml = self.execute_get_xml(self.reluri('rootservices'), intent="Retrieve RM application rootservices" )
+        self.rootservices_xml = self.execute_get_xml(self.reluri('rootservices'), intent="Retrieve RM application rootservices", action="Locate project areas URL using tag jp06:projectAreas" )
         self.serviceproviders = 'oslc_rm_10:rmServiceProviders'
         self.version = rdfxml.xmlrdf_get_resource_text(self.rootservices_xml,'.//oslc_rm_10:version')
         self.majorversion = rdfxml.xmlrdf_get_resource_text(self.rootservices_xml,'.//oslc_rm_10:majorVersion')

elmclient/examples/REQIF_IO.md

@@ -277,7 +277,7 @@ To erase obfuscated credentials use option -2 then the credentials filename:
 reqif_io -2 .mycreds
 ```
 
-TO BE CLEAR: **NOTE the credentials file is only obfuscated unless you use the runtime prompt option -4, i.e. it's pretty easy to decode once you have the python source code**
+TO BE CLEAR: **NOTE the credentials file is only obfuscated: unless you use the runtime prompt option -4 to encrypt it, it's pretty easy to decode once you have the python source code**
 
 
 Future work

elmclient/examples/dn_simple_typesystemimport.py

@@ -6,10 +6,8 @@
 # example of using the type system import API
 # also see https://jazz.net/wiki/bin/view/Main/DNGTypeImport
 
-# the names for projects/configs involved are hard-coded for simplicity
+# the names for project/component/configs involved are hard-coded for simplicity
 
-# IMPORTANT NOTE this hardcodes the url for creating a type import session.
-# This should really be done by discovery looking in the component's config-specific services.xml for a CreationFactory for resourceType http://www.ibm.com/xmlns/rdm/types/TypeImportSession
 
 import csv
 import logging
@@ -101,6 +99,9 @@
 
     if tgt_config_u is None or src_config_u is None:
         raise Exception( "Source or target config not found!" )
+        
+    # find the CreationFactory URI for type-delivery session
+    typeimport_u = tgt_c.get_factory_uri( resource_type="http://www.ibm.com/xmlns/rdm/types/TypeImportSession" )
 
     # create the RDF body with the source and target configurations
     content = f"""<rdf:RDF xmlns:rdf="http://www.w3.org/1999/02/22-rdf-syntax-ns#" xmlns:types="http://www.ibm.com/xmlns/rdm/types/">
@@ -111,7 +112,7 @@
 </rdf:RDF>"""
 
     # initiate the delivery session - if successful will return 202 with a task tracker location
-    response = tgt_c.execute_post_rdf_xml( reluri="type-import-sessions", data=content, cacheable=False, intent="Initiate typesystem import" )
+    response = tgt_c.execute_post_rdf_xml( reluri=typeimport_u, data=content, cacheable=False, intent="Initiate typesystem import",action='start following task tracker' )
     logger.debug( f" {response.status_code=} {response=}" )
 
     # get the location

elmclient/examples/log2seq.py

@@ -22,11 +22,44 @@
 
 import jinja2
 
+#
+# Example of syntax (from https://bramp.github.io/js-sequence-diagrams/):
+# 
+# Title: Here is a title
+# A->B: Normal line
+# B-->C: Dashed line
+# C->>D: Open arrow
+# D-->>A: Dashed open arrow
+# # Example of a comment.
+# Note left of A: Note to the\n left of A
+# Note right of A: Note to the\n right of A
+# Note over A: Note over A
+# Note over A,B: Note over both A and B
+#
+
 JINJA_TEMPLATE = """
 <!doctype html>
 <html>
 <head>
     <link rel="stylesheet" type="text/css" href=""https://bramp.github.io/js-sequence-diagrams/css/sequence-diagram-min.css" media="screen" />
+<style>
+    .signal text {
+    fill: #000000;
+}
+.signal text:hover {
+    fill: #aaaaaa
+}
+.note rect, .note path {
+    fill: #ffff80;
+}
+.title rect, .title path{
+    fill: #ff80ff;
+}
+.actor rect, .actor path {
+    fill: #80ffff
+}
+
+</style>
 </head>
 <body onload='showseq();'>
 <p>Sequence diagram from emlclient log {{ logfilename }} - wait a few seconds for the diagram to appear...</p>
@@ -145,27 +178,34 @@ def addheaders(events,msgheaders,headerstoshow,direction):
         events.append( f"Note {direction}: {text}" )
     return
 
-# parse a message from the logfile into a reqat/response tuple
+# parse a message from the logfile into a request/response tuple
 def decodemessage(msg):
     request = {'intent':None,'method': None, 'url': None, 'headers':[], 'body':None}
-    response = {'status': None,'headers':[], 'body':None}
-    parts = re.search( r"^(?:INTENT: (.*?)\n\n)?(GET|PUT|POST|HEAD|DELETE|POST) +(\S+)\n( .*?)\n\n(?::+?=\n(.*?)\n-+?=\n)?.*?\n\nResponse: (\d+)\n( .*?)\n\n(?::+?@\n(.*?)\n-+?@\n)?",msg, flags=re.DOTALL+re.MULTILINE )
+    response = {'status': None,'headers':[], 'body':None, 'action':None }
+    parts = re.search( r"\n*(?:INTENT: ([^\n]*?)\n+)?(?:(?:(GET|PUT|POST|HEAD|DELETE|POST) +(\S+)\n((?: +.*?\n)+)\n*)(?::+?=\n(.*?)\n-+?=\n)?.*?\n+Response: (\d+?)\n( .*?)\n\n(?::+?@\n(.*?)\n-+?@\n+)?)?(?:ACTION: (.*?)\n)?",msg, flags=re.DOTALL )
+    if parts.group(0) == '':
+        burp
+#    for l,g in enumerate(parts.groups()):
+#        print( f"{l=} {g=}" )
     request['intent'] = parts.group(1)
     request['method'] = parts.group(2)
     request['url'] = parts.group(3)
-    for hdrline in parts.group(4).split( "\n" ):
-        hsplit = hdrline.strip().split(": ",1)
-        hsplit.append("")
-        hdr, value = hsplit[0],hsplit[1]
-        request['headers'].append( (hdr,value) )
+    if parts.group(4) is not None:
+        for hdrline in parts.group(4).split( "\n" ):
+            hsplit = hdrline.strip().split(": ",1)
+            hsplit.append("")
+            hdr, value = hsplit[0],hsplit[1]
+            request['headers'].append( (hdr,value) )
     request['body'] = parts.group(5).strip() if parts.group(5) else None
     response['status'] = parts.group(6)
-    for hdrline in parts.group(7).split( "\n" ):
-        hsplit = hdrline.strip().split(": ",1)
-        hsplit.append("")
-        hdr, value = hsplit[0],hsplit[1]
-        response['headers'].append( (hdr,value) )
+    if parts.group(7) is not None:
+        for hdrline in parts.group(7).split( "\n" ):
+            hsplit = hdrline.strip().split(": ",1)
+            hsplit.append("")
+            hdr, value = hsplit[0],hsplit[1]
+            response['headers'].append( (hdr,value) )
     response['body'] = parts.group(8).strip() if parts.group(8) else None
+    response['action'] = parts.group(9)
     return (request,response)
 
 def findheader(hdrname,requestorresponse,notfoundreturn=None):
@@ -257,44 +297,51 @@ def main():
 
         for i,msg in enumerate(msgs):
             request,response = decodemessage(msg)
-            #  if INTENT: then add a note for it
-
+#            print( f"{request=}" )
+#            print( f"{response=}" )
             line = i
-
-            reqparts = urllib.parse.urlparse(request['url'])
 
-            path = reqparts.path
-            if reqparts.query:
-                path += "?"+reqparts.query
+            if request['method']:
 
-            if request['intent']:
-                events.append( f"Note left of me: INTENT: {request['intent']}" )
+                reqparts = urllib.parse.urlparse(request['url'])
 
-            events.append( f"me->{host}: {request['method']} {sanitise(path,wrap=True)}" )
-            
-            addheaders(events,request['headers'],reqshowheaders,"left of me" )
-            
-            if request['body']:
-                if contentshouldbeshown(request):
-                    reqbody = sanitise(request['body'], wrap=True)
-                else:
-                    reqbody = sanitise(request['body'], wrap=False, maxlines=5)
-                    
-                if reqbody:
-                    events.append( f"Note left of me: {reqbody}" )
+                path = reqparts.path
+                if reqparts.query:
+                    path += "?"+reqparts.query
+
+                #  if INTENT: then add a note for it
+                if request['intent']:
+                    events.append( f"Note left of me: INTENT: {request['intent']}" )
 
-            events.append( f"{host}-->me: {response['status']}" )
-            
-            addheaders(events,response['headers'],respshowheaders,f"right of {host}" )
-            
-            if response['body']:
-                if contentshouldbeshown(response):
-                    respbody = sanitise(response['body'], wrap=False)
-                else:
-                    respbody = sanitise(response['body'], wrap=False, maxlines=5)
-#                    respbody = "Content type not shown..."
-               
-                events.append( f"Note right of {host}: {respbody}" )
+                events.append( f"me->{host}: {request['method']} {sanitise(path,wrap=True)}" )
+                
+                addheaders(events,request['headers'],reqshowheaders,"left of me" )
+                
+                if request['body']:
+                    if contentshouldbeshown(request):
+                        reqbody = sanitise(request['body'], wrap=True)
+                    else:
+                        reqbody = sanitise(request['body'], wrap=False, maxlines=5)
+                        
+                    if reqbody:
+                        events.append( f"Note left of me: {reqbody}" )
+                        
+                events.append( f"{host}-->me: {response['status']}" )
+                
+                addheaders(events,response['headers'],respshowheaders,f"right of {host}" )
+                
+                if response['body']:
+                    if contentshouldbeshown(response):
+                        respbody = sanitise(response['body'], wrap=False)
+                    else:
+                        respbody = sanitise(response['body'], wrap=False, maxlines=5)
+    #                    respbody = "Content type not shown..."
+                   
+                    events.append( f"Note right of {host}: {respbody}" )
+                
+            #  if ACTION: then add a note for it
+            if response['action']:
+                events.append( f"Note over me: {response['action']}" )
 
         j2_template = jinja2.Template(JINJA_TEMPLATE)
         data = {