Provide validate API, added validate example, 0.24.0

Author: barny

.bumpversion.cfg

@@ -1,5 +1,5 @@
 [bumpversion]
-current_version = 0.23.0
+current_version = 0.24.0
 commit = True
 tag = True
 

README.md

@@ -8,15 +8,15 @@
 
  SPDX-License-Identifier: MIT
 
- version="0.23.0"
+ version="0.24.0"
 
 What's New?
 ===========
 
-0.23.0 16-Aug-2023
+0.24.0 16-Aug-2023
 * tested with Python 3.11.4 - worked OOTB. Now developing using 3.11.4 - won't be back-tested with older Pythons but should work back to 3.9 at least.
 
-0.23.0 4-May-2023
+0.24.0 4-May-2023
 * Deprecated RM load_folders() - use find_folder() instead.
 * Added RM create_folder() - this doesn't require doing a forced reload of all folders, because it inserts the new folder into the internal info about folders
 * Added example dn_simple_createfolderpath.py - allows exercising the create_folders() function

elmclient/__meta__.py

@@ -9,7 +9,7 @@
 
 app = 'elmoslcquery'
 description = 'Commandline OSLC query for ELM'
-version = '0.23.0'
+version = '0.24.0'
 license = 'MIT'
 author_name = 'Ian Barnard'
 author_mail = '[email protected]'

elmclient/_app.py

@@ -13,13 +13,14 @@
 from . import oslcqueryapi
 from . import utils
 from . import httpops
+from . import _validate
 
 logger = logging.getLogger(__name__)
 
 #################################################################################################
 # a generic jazz application
 
-class _App( httpops.HttpOperations_Mixin ):
+class _App( httpops.HttpOperations_Mixin, _validate.Validate_Mixin ):
     'A generic Jazz application'
     domain = 'UNSPECIFIED APP DOMAIN'
     project_class = None

elmclient/_queryparser.py

@@ -32,7 +32,7 @@
 #  For DNG You can refer to a foldername using e.g. $"folder name" - this gets converted to the URI of the folder in <> NOT EXTENSIVELY TESTED!
 #  You can refer to a user name using e.g. @"user name" - this gets converted to the server-specific URI of the user
 
-_core_oslc_grammar = """
+_core_oslc_grammar = r"""
 ?compound_term      : simple_term
                     | simple_term boolean_op compound_term                    -> do_oslcand
 
@@ -77,6 +77,7 @@
                     | urioffoldername
                     | uriofuser
                     | uriofmodule
+                    | uriofconfig
 
 valueidentifier     : ( ( URI_REF_ESC | NAME | "'" SPACYNAME "'" ) ":" )? NAME
                     | "'" SPACYNAME "'"
@@ -90,6 +91,8 @@
 
 urioffoldername     : "$" string_esc
 
+uriofconfig         : "#" string_esc
+
 uriofuser           : "@" string_esc
 
 uriofmodule         : "^" string_esc
@@ -174,6 +177,7 @@ def __init__(self,resolverobject):
         self.mapping_users = {} # contains both: key name->uri and key uri->name (uris and names never overlap)
         self.mapping_modules = {} # contains both: key name->uri and key uri->name (uris and names never overlap)
         self.mapping_projects = {} # contains both: key name->uri and key uri->name (uris and names never overlap)
+        self.mapping_configs = {} # contains both: key name->uri and key uri->name (uris and names never overlap)
 
     def where_expression(self, s):
         logger.debug( f"where_expression {s=}" )
@@ -265,7 +269,7 @@ def term(self, s):
             else:
                 t1 = type(value)
                 logger.info( f"t1 {value} {t1=}" )
-                if isinstance(value, str) and not value.startswith('"') and not value.startswith("'") and ':' not in value and not re.match("\d",value):
+                if isinstance(value, str) and not value.startswith('"') and not value.startswith("'") and ':' not in value and not re.match(r"\d",value):
                     # this is a valueidentifier - try to resolve it as an enum in the context of identifier
                     if self.resolverobject.resolve_enum_name_to_uri is not None:
                         result = self.resolverobject.resolve_enum_name_to_uri(value, identifier)
@@ -371,6 +375,21 @@ def uriofmodule(self,s):
             raise Exception( "This application doesn't support module names!" )
         return result
 
+    def uriofconfig(self,s):
+        logger.info( f"uriofconfig {s=}" )
+        name=s[0].strip('"')
+        if self.resolverobject.resolve_configname_to_uri is not None:
+            uri = self.resolverobject.resolve_configname_to_uri(name)
+            if uri is None:
+                raise Exception( f"Config {name} not found!" )
+            logger.info( f"uriofconfig {uri=}" )
+            self.mapping_configs[name]=uri
+            self.mapping_configs[uri]=name
+            result = "<"+uri+">"
+        else:
+            raise Exception( "This application doesn't support resolving configuration names!" )
+        return result
+
 #    def uriofproject(self,s):
 #        logger.info( f"uriofproject {s=}" )
 #        name=s[0].strip('"')
@@ -536,7 +555,7 @@ def scoped_term(self, s):
 SPACYNAME           : /[a-zA-Z0-9_][^']*/
 """
 
-_orderby_grammar = """
+_orderby_grammar = r"""
 sort_terms          : sort_term ("," sort_term)*
 sort_term           : scoped_sort_terms | signedterm
 signedterm          : SIGN ( dottedname | identifier )

elmclient/_rm.py

@@ -859,6 +859,23 @@ def resolve_modulename_to_uri( self, modulename ):
             logger.info( f"rmtu {result=}" )
         return result
 
+#    def resolve_configname_to_uri( self, configname ):
+        # configname syntax is domain/project/component/config
+        # for example (remove the')  'rm:rm23/rm_optin_p1/rm_optin_p1 comp2/rm_optin_p1 comp2 Initial Stream'
+#        # get the query capability base URL
+#        qcbase = self.get_query_capability_uri("oslc_rm:Requirement")
+#        results = self.execute_oslc_query( qcbase, whereterms=[['and', ['dcterms:title','=',f'"{modulename}"'],['rdm_types:ArtifactFormat','=','jazz_rm:Module']]], prefixes={rdfxml.RDF_DEFAULT_PREFIX["dcterms"]:'dcterms',rdfxml.RDF_DEFAULT_PREFIX["rdm_types"]:'rdm_types',rdfxml.RDF_DEFAULT_PREFIX["jazz_rm"]:'jazz_rm'})
+#        logger.debug( f"resolve_modulename_to_uri {results=}" )
+#        if len( results.keys() ) == 0:
+#            result = None
+#        else:
+#            if len( results.keys() ) > 1:
+#                raise Exception( f"More than one module named {modulename}!" )
+#            result = list(results.keys())[0]
+#            logger.info( f"rmtu {result=}" )
+#        return result
+
+
     def resolve_uri_to_reqid( self, requri ):
         pass
 

elmclient/_validate.py

@@ -0,0 +1,60 @@
+
+##
+## © Copyright 2021- IBM Inc. All rights reserved
+# SPDX-License-Identifier: MIT
+##
+
+# This mixin implements the validate API (will be used on each app that supports validate)
+# ref https://jazz.net/rm/doc/scenarios
+
+import codecs
+import html.parser
+import http
+import inspect
+import json
+import logging
+import lxml.etree as ET
+import re
+import time
+import urllib
+
+import requests
+import tqdm
+
+from elmclient import rdfxml
+
+logger = logging.getLogger(__name__)
+
+
+class Validate_Mixin():
+    def listFeeds( self ):
+        valuri = self.reluri( 'trs_feed_validation/feeds' )
+#        print( f"{valuri=}" )
+        results = self.execute_get_json( valuri, headers={'Accept': 'application/json' } )
+        # 
+#        print( f"{results=}" )
+        return results
+        
+    def validate( self, feedid, *,  repair=False, resetIncrementalData=False, full=False ):
+        valuri = self.reluri( 'trs_feed_validation/validate' )
+        rep = 'true' if repair else 'false'
+        res = 'true' if resetIncrementalData else 'false'
+        ful = 'true' if full else 'false'
+        response = self.execute_post_content( valuri, params={'id': feedid,'repair': rep,'resetIncrementData': res,'full': ful } )
+#        print( f"{response=}" )
+        
+        # get the location
+        location = response.headers.get('Location')
+        
+        # check for 202 and location
+        if response.status_code == 202 and location is not None:
+            print( f"Polling tracker at {location}" )
+            # wait for the tracker to finished
+            result = self.wait_for_tracker( location, interval=1.0, progressbar=True, msg=f"Validating feed {feedid}",useJson=True,returnFinal=True)
+            # TODO: success result is now the xml of the verdict       
+            # result None is a success!
+            logger.info( f"1 {result=}" )
+            return result
+        else:
+            raise Exception( f"Validate data source {id} failed!" )
+