squashing bugs

Author: barny

README.md

@@ -135,26 +135,43 @@ ELM APIs
 This code provides examples of using various ELM APIs:
 
 * DN
+
 ** Process - `elmclient`
+
 ** OSLC including OSLC Query - `oslcquery.py` for user use, internally `oslcqueryapi.py` implements OSLC Query parsing and querying
+
 ** Module Structure - `dn_simple_modulestructure.py` - currently external to `elmclient`
+
 ** ReqIF - `reqif_io.py` - currently reqif API is external to `elmclient`
+
 ** Reportable REST (incomplete for qm and ccm) - `represt.py` for user use, internally for each application in `_rm.py`, `_ccm.py`, `_qm.py` 
 
+
 * ETM
+
 ** Process - `elmclient`
+
 ** OSLC including OSLC Query - `oslcquery.py` for user use, internally `oslcqueryapi.py` implements OSLC Query parsing and querying
+
 ** Reportable REST (incomplete for qm and ccm) - `represt.py` for user use, internally for each application in `_rm.py`, `_ccm.py`, `_qm.py` 
 
+
 * EWM
+
 ** Process - `elmclient`
+
 ** OSLC including OSLC Query - `oslcquery.py` for user use, internally `oslcqueryapi.py` implements OSLC Query parsing and querying
+
 ** Reportable REST (incomplete for qm and ccm) - `represt.py` for user use, internally for each application in `_rm.py`, `_ccm.py`, `_qm.py` 
 
+
 * GCM
+
 ** Process - `elmclient`
+
 ** OSLC including OSLC Query - `oslcquery.py` for user use, internally `oslcqueryapi.py` implements OSLC Query parsing and querying
 
+
 Reporting issues, and contributing
 ==================================
 

elmclient/__init__.py

@@ -15,6 +15,7 @@
 from ._rm import *
 from ._gcm import *
 from ._qm import *
+from ._relm import *
 from .__meta__ import *
 
 __app__ = __meta__.app

elmclient/_app.py

@@ -16,7 +16,6 @@
 
 logger = logging.getLogger(__name__)
 
-
 #################################################################################################
 # a generic jazz application
 
@@ -122,10 +121,12 @@ def _load_projects(self,include_archived=False,force=False):
         if include_archived:
             params['includeArchived'] = 'true'
         self.project_areas_xml = self.execute_get_xml(uri, params=params)
-
+        logger.debug( f"{self.project_areas_xml=}" )
         for projectel in rdfxml.xml_find_elements(self.project_areas_xml,".//jp06:project-area" ):
+            logger.debug( f"{projectel=}" )
             projectu = rdfxml.xmlrdf_get_resource_text(projectel,".//jp06:url")
             projectname = rdfxml.xmlrdf_get_resource_uri(projectel,attrib='jp06:name')
+            logger.debug( f"{projectname=}" )
             is_optin = False
             singlemode = False
             if self.supports_configs:
@@ -152,6 +153,7 @@ def find_project(self, projectname_or_uri, include_archived=False):
         else:
             # must be a name
             projectu = self._projects.get(projectname_or_uri)
+            print( f"{projectu=}" )
             if projectu is None:
                 res = None
             else:

elmclient/_project.py

@@ -41,8 +41,6 @@ def __init__(self, name, project_uri, app, is_optin=False, singlemode=False,defa
         self.services_xml = None
         self.services_uri = None
         self.appcatalog_xml = None
-#        self._type_system = _typesystem.Type_System()
-#        self._gettypecache = {}
         self.hooks = []
         # copy the server from the app - this is so OSLC query can be done on either a project including component) or app
         self.server = app.server

elmclient/_relm.py

@@ -0,0 +1,77 @@
+##
+## © Copyright 2021- IBM Inc. All rights reserved
+# SPDX-License-Identifier: MIT
+##
+
+
+#################################################################################################
+
+# ENI/RELM application
+
+#
+# This is a skeleton implementation for ENI/RELM - just enough to support finding a project
+#
+
+#################################################################################################
+
+import logging
+
+import requests
+import lxml.etree as ET
+import tqdm
+
+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__)
+
+#################################################################################################
+
+class _RELMProject(_project._Project):
+    def __init__(self, name, project_uri, app, is_optin=False, singlemode=False,defaultinit=False):
+        super().__init__(name, project_uri, app, is_optin,singlemode, defaultinit=defaultinit)
+        self.hooks = []
+        self._components = None  # will become a dict keyed on component uri
+        self._configurations = None # keyed on the config name
+        self.default_query_resource = 'oslc_config:Configuration'
+
+
+#################################################################################################
+
+#@utils.mixinomatic
+class RELMApp(_app._App):
+    domain = 'relm'
+    project_class = _RELMProject
+    supports_configs = False
+    supports_components = False
+    supports_reportable_rest = False
+
+    relprefixes = (
+        )
+
+#    identifier_name = 'Short ID'
+#    identifier_uri = 'Identifier'
+
+    def __init__(self, server, contextroot, jts=None):
+        super().__init__(server, contextroot, jts=jts)
+
+        self.rootservices_xml = self.execute_get_xml(self.reluri('rootservices'))
+#        self.serviceproviders = 'gc:globalConfigServiceProviders'
+#        self.default_query_resource = 'oslc_config:Configuration'
+        # register some app-specific namespaces
+        for prefix,reluri in self.relprefixes:
+            rdfxml.addprefix(prefix,self.baseurl+reluri)
+        self.hooks = []
+
+    def _get_headers(self, headers=None):
+        result = super()._get_headers()
+        result['net.jazz.jfs.owning-context'] = self.baseurl
+        if headers:
+            result.update(headers)
+        return result
+

elmclient/_rm.py

@@ -363,7 +363,7 @@ def load_components_and_configurations(self,force=False):
         return (ncomps, nconfs)
 
     def get_local_config(self, name_or_uri):
-#        self.load_components_and_configurations()
+        self.load_components_and_configurations()
         result = None
         filter = None
         if name_or_uri.startswith("S:"):
@@ -931,7 +931,9 @@ def process_represt_arguments( self, args, allapps ):
                 for k,v in modules.items():
                     print( f'{k} {v.get("dcterms:title","")}' )
                 raise Exception( "More than one module with that name in {args.project} {args.component}" )
-            queryparams['moduleUri'] = list(modules.keys())[0]
+            moduleuuid = list(modules.keys())[0].rsplit("/",1)[1]
+#            queryparams['moduleUri'] = list(modules.keys())[0]
+            queryparams['moduleUri'] = moduleuuid
 
         if args.collection:
             raise Exception( "Not implemented yet" )
@@ -1007,7 +1009,7 @@ def process_represt_arguments( self, args, allapps ):
 
         if args.history:
             queryparams['history'] = True
-            
+          
         queryurl = self.reluri(self.reportablerestbase) + "/"+ args.artifact_format
 
         if args.all:

elmclient/examples/OSLCQUERY.md

@@ -182,7 +182,9 @@ BEFORE you start:
 
 * If an option includes spaces surround it with " "
 
-* On Windows at least, on the command line it is necessary to put " around values that include ", < or > and then double any " within a string. So a query like State="New" has to be entered as "State=""New""", or dcterms:identifier<23 has to be entered as "dcterms:identifier<23"
+* On Windows at least, on the command line it is necessary to put " around values that include space, ", < or > and then double any " within a string. So a query like State="New" has to be entered as "State=""New""", or dcterms:identifier<23 has to be entered as "dcterms:identifier<23"
+
+* On Windows at least, if for example a title that you're searching for includes an embedded double-quote " then you have to escape each with a backslash \. Because of the way the Windows commandline works, this means you have to replace each embedded " with \\"". For example to query for a title `A "specification"` you have to put `"dcterms:title=""A \\""specification\\"""""`
 
 * The query specified with the '-q' option supports extended OSLC query syntax, described below - in particular this adds syntactic support for referencing definition names, user names and folder names, and also allows combining results from two or more OSLC queries using set union (denoted by ||) and intersection (denoted by &&).
 
@@ -356,6 +358,8 @@ If your DN application is not on context root /rm then use the -A option for exa
 
 Use the typesystem report to see all the shapes, properties and enumeration names in your project: add `-typesystemreport file.html` to the commandline. Note not all properties are queryable.
 
+If the title of a module (or anything) includes a double-quote " then you have to escape it with \\ and double the quote to "" so it becomes \\"" in the command line. For example to find a module with title `A "specification"` use `-q "dcterms:title=""A \\""specification\"""""`
+
 You can add a filter like `-v rm_nav:parent` to only show results where parent isn't empty - i.e. to get only core artifacts - unfortunately this filters can only be done is by postprocessing the query results so it doesn't speed up the query itself.
 
 The converse filter is `-n rm_nav:parent`, which filters out results where parent is empty, i.e. only returns module artifacts. You can use -n and -v but that only makes sense (i.e. if you want to possibly get some results) if they reference different attributes.