oslcquery: added clean handling of archived components/configs (no 404 error!)

Author: barny

elmclient/_app.py

@@ -310,6 +310,14 @@ def resolve_project_nametouri(self, name, raiseifinvalid=True):
         logger.debug( f"resolve_project_nametouri {name} {result}" )
         return result
 
+    # return True if the uri can be accessed (used e.g. to detect archived components/configs)
+    def is_accessible( self, uri ):
+        try:
+            res = self.execute_get( uri )
+            return True
+        except requests.exceptions.HTTPError as e:
+            return False
+            
 #################################################################################################
 
 class JTSApp(_App):

elmclient/_rm.py

@@ -380,6 +380,22 @@ def load_components_and_configurations(self,force=False):
             self._confs_to_load.extend(self._components[cu]['confs_to_load'])
             self._components[cu]['component'] = c
         return (ncomps, nconfs)
+        
+    def add_external_component(self,compu):
+        # this is only ever used for opt-in projects!
+        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')
+        confu = rdfxml.xmlrdf_get_resource_uri(compx, './/oslc_config:configurations')
+        self._components[compu] = {'name': comptitle, 'configurations': {}, 'confs_to_load': [confu]}
+
+        cname = comptitle
+        cconfs_to_load = [confu]
+        c = self._create_component_api(compu, cname, cconfs_to_load)
+        c._configurations = self._components[compu]['configurations']
+        c._confs_to_load = self._components[compu]['confs_to_load']
+        self._confs_to_load.extend(self._components[compu]['confs_to_load'])
+        self._components[compu]['component'] = c
+        return c
 
     def load_configs(self):
         # load configurations

elmclient/examples/oslcquery.py

@@ -109,6 +109,7 @@ def do_oslc_query(inputargs=None):
     parser.add_argument('--saveprocessedresults', default=None, help="Save the processed results as JSON to this path/file" )
     parser.add_argument('--percontribution', action="store_true", help="When querying a GC, query once for each app-domain contribution in the GC tree, with added component and configuration columns in the result")
     parser.add_argument('--cacheable', action="store_true", help="Query results can be cached - use when you know the data isn't changing and you need faster re-run")
+    parser.add_argument('--crossproject', action="store_true", help="For --percontriubtion GC queries follow gc contributions to other projects and query those too (requires access permission of course)")
 
     # saved credentials
     parser.add_argument('-0', '--savecreds', default=None, help="Save obfuscated credentials file for use with readcreds, then exit - this stores jazzurl, appstring, username and password")
@@ -479,7 +480,25 @@ def do_oslc_query(inputargs=None):
             queryon = p.find_local_component(compuri)
             if queryon is None:
                 print( f"Component not found from {compuri}" )
+                if args.crossproject:
+                    # this component isn't in our current project
+                    # try to create a component for it and add to current project
+                    queryon = p.add_external_component(compuri)
+                    if queryon is None:
+                        burp
+                        continue
+                    else:
+                        print( f"Added external component {queryon=}" )
+            # check the comonent is accessible (may have been achived!)
+            if not app.is_accessible( compuri ):
+                print( f"Archived component {compuri} !")
                 continue
+            # check if the config is accessible (may have been archived!)
+            if not app.is_accessible( contriburi ):
+                print( f"Archived configuration {contriburi} !")
+                continue
+            
+            # set the config ready to do the query
             queryon.set_local_config(contriburi)
             # now do a query for each contribution
             thisresults = queryon.do_complex_query( args.resourcetype, querystring=args.query, searchterms=args.searchterms, select=args.select, isnulls=args.null, isnotnulls=args.value