oslcquery can now save raw results

Author: barny

elmclient/examples/REQIF_IO.md

@@ -26,6 +26,24 @@ Installation
 
 The `reqif_io` command is installed in your Python scripts folder when installing `elmclient`
 
+TLDR;
+=====
+
+Here's a sequence which lists definitions, creates a new definition for a specific module, exports it to reqifz, reimports the reqifz, and then deletes the definition
+
+NOTE this is so brief because it's using the defaults for server URL and context roots, username and password - see below these sections for how to set these up for your environment.
+NOTE this works when project `rm_optout_p1` was created using the `Systems Requirement Sample`, which has a module `AMR Stakeholder Specification`.
+
+
+```
+reqif_io rm_optout_p1 list
+reqif_io rm_optout_p1 create stk -m "AMR Stakeholder Requirements Specification"
+reqif_io rm_optout_p1 list
+reqif_io rm_optout_p1 export stk
+reqif_io rm_optout_p1 import stk.reqifz
+reqif_io rm_optout_p1 delete stk
+```
+
 
 Usage
 =====

elmclient/examples/oslcquery.py

@@ -105,6 +105,8 @@ def do_oslc_query(inputargs=None):
     parser.add_argument('--pagesize', default=200, type=int, help="Page size for OSLC query (default 200)")
     parser.add_argument('--typesystemreport', default=None, help="Load the specified project/configuration and then produce a simple HTML type system report of resource shapes/properties/enumerations to this file" )
     parser.add_argument('--cachedays', default=1,type=int, help="The number of days for caching received data, default 1. To disable caching use -WW. To keep using a non-default cache period you must specify this value every time" )
+    parser.add_argument('--saverawresults', default=None, help="Save the raw results as XML to this path/file prefix - pages are numbered starting from 0000" )
+    parser.add_argument('--saveprocessedresults', default=None, help="Save the processed results as JSON to this path/file" )
 
     # saved credentials
     parser.add_argument('-0', '--savecreds', default=None, help="Save obfuscated credentials file for use with readcreds, then exit - this stores jazzurl, jts, appstring, username and password")
@@ -456,6 +458,7 @@ def do_oslc_query(inputargs=None):
                     ,pagesize=args.pagesize
                     ,resolvenames = args.resolvenames
                     ,totalize=args.totalize
+                    ,saverawresults=args.saverawresults
                     )
 
     if args.debugprint:
@@ -509,6 +512,9 @@ def safeint(s,nonereturns=0):
 
     resultsentries = "entries" if len(results.keys())!=1 else "entry"
 
+    if args.saveprocessedresults:
+        open(args.saveprocessedresults+"_before.json","wt").write(json.dumps(results))
+        
     print( f"Query result has {len(results.keys())} {resultsentries}" )
 
     # COMPARE IS UNTESTED!
@@ -557,6 +563,9 @@ def safeint(s,nonereturns=0):
                 writer.writeheader()
                 for k, v in results.items():
                     writer.writerow(v)
+                    
+        if args.saveprocessedresults:
+            open(args.saveprocessedresults+"_after.json","wt").write(json.dumps(results))
 
         if args.compareresults:
             # a simple test by comparing the received results with a saved CSV from a previous run
@@ -619,7 +628,7 @@ def safeint(s,nonereturns=0):
             print( f"{len(results.keys())} results and {args.nresults} expected - Passed :-)" )
 
     if args.xmloutputfile is not None:
-    
+        # retrieve all resources in the results to XML
         # ensure output folder exists
         args.xmloutputfile = os.path.abspath(args.xmloutputfile)
         outputpath = os.path.split(args.xmloutputfile)[0]

elmclient/examples/reqif_io.py

@@ -108,8 +108,8 @@ def reqif_main():
     parser_create.add_argument('-s', '--description', default="-", help="Description for the definition")
     parser_create.add_argument('-t', '--tags', action="store_false", help="Don't include tags in the reqif (defaults to including) - if you need this off, specify it on the last update or on the create")
     parser_create.add_argument('-u', '--update', action="store_true", help="Update the named definition by adding things - it must already exist!")
-# NIY    parser_create.add_argument('-p', '--publicviews', nargs='*', default=[], help='* or CSL of public view names')
-# NIY    parser_create.add_argument('-v', '--moduleviews', nargs='*', default=[], help='* or CSL of module view names')
+# TODO: NIY    parser_create.add_argument('-p', '--publicviews', nargs='*', default=[], help='* or CSL of public view names')
+# TODO: NIY    parser_create.add_argument('-v', '--moduleviews', nargs='*', default=[], help='* or CSL of module view names')
 
     parser_delete.add_argument('definitionnames',nargs='*',default=[],help='One or more names of export definitions to delete - this can be a regex where . matches any character, etc. If you want the regex to match a complete name put ^ at the start and $ at the end')
     parser_delete.add_argument('-n', '--noconfirm', action='store_true', help="Don't prompt to confirm each delete (DANGEROUS!)")