Merge pull request #4 from DMTF/1.0.0-Tagging

1.0.0 Versioning

Author: mraineri

AUTHORS.md

@@ -1,5 +1,5 @@
 # Original Contribution:
 
-* Paul Vancil- Dell ESI -- tool definition 
-* Jon Hass   - Dell CTO -- tool definition 
+* Paul Vancil - Dell ESI -- tool definition 
+* Jon Hass - Dell CTO -- tool definition 
 * John Watts - Dell ESI tools contractor -- initial implementation

CHANGELOG.md

@@ -1,5 +1,8 @@
-
 # Change Log
 
-## [Unreleased 0.9.0] - 2017-09-28
-- Initial upload to DMTF/spmf-tools private repo
+## [1.0.0] - 2018-08-17
+- Error message improvements
+- Added support for caching of schemas
+
+## [0.9.0] - 2017-09-28
+- Initial version

README.md

@@ -1,10 +1,10 @@
-# Redfish-JsonSchema-ResponseValidator 
+Copyright 2017-2018 DMTF. All rights reserved.
 
-Copyright 2017 Distributed Management Task Force, Inc. All rights reserved.
+# Redfish-JsonSchema-ResponseValidator 
 
 ## About
 
-***Redfish-JsonSchema-ResponseValidator.py*** is a Python3 utility used to validate any JSON resource against DMTF provided JSON schemas
+***Redfish-JsonSchema-ResponseValidator.py*** is a Python3 utility used to validate any JSON resource against DMTF provided JSON schemas.
 
 ### To run:
 
@@ -44,7 +44,6 @@ NOTE: if -v is specified, resource JSON will be
 NOTE: if -g is specified, input files will be the files
        found in a previous error file. If used with -v,
        the output will include the resource JSON and the Schema
-
 ```
 
 ## Installation, Path, and Dependencies:
@@ -77,8 +76,6 @@ Redfish-JsonSchema-ResponseValidator.py -g -v [-e errorfile] > saveout
        saves the standard out to be examined with an editor
 
 NOTE: here is a shortcut bash script
-
-
 ```
 
 ## Known Issues

Redfish-JsonSchema-ResponseValidator.py

@@ -12,12 +12,12 @@
 The purpose of this program is to validate
 redfish resources against DMTF json schemas.
 There are three ways to run this:
-1) against a directory of all 
+1) against a directory of all
      resources created by the mockup creator
 2) selecting individual resources from
-     that same directory 
+     that same directory
      ( the -f option )
-3) pulling a resource from an actual host 
+3) pulling a resource from an actual host
      of a redfish service.
      ( -r and -i options )
 
@@ -32,7 +32,7 @@
 #!/usr/bin/env bash
 cmd="/usr/bin/scl enable rh-python34"
 args="$@"
-$cmd "./resourceValidate.py $args " 
+$cmd "./resourceValidate.py $args "
 
 '''
 
@@ -44,20 +44,21 @@
 import getopt
 import requests
 
+tool_version = '1.0.0'
 
 def usage():
-    print ('\nresourceValidate.py usage:')
-    print ('  -h   display usage and exit')  
-    print ('  -v   verbose')  
-    print ('  -m   directory path to a mockup tree to validate against, default ./mockup-sim-pull')  
-    print ('  -s   path to a local dir containing the json schema files to validate against, default ./DMTFSchemas')  
+    print ('\nRedfish-JsonSchema-ResponseValidator.py usage:')
+    print ('  -h   display usage and exit')
+    print ('  -v   verbose')
+    print ('  -m   directory path to a mockup tree to validate against, default ./mockup-sim-pull')
+    print ('  -s   path to a local dir containing the json schema files to validate against, default ./DMTFSchemas')
     print ('  -S   tell resourceValidate to get the schemaFiles from http://redfish.dmtf.org/schemas/v1/')
-    print ('  -u   user name, default root')  
-    print ('  -p   password, default calvin')  
-    print ('  -e   error output file, default ./validate_errs')  
-    print ('  -f   comma separated list of files to validate. if no -f, it validates entire mockup')  
+    print ('  -u   user name, default root')
+    print ('  -p   password, default calvin')
+    print ('  -e   error output file, default ./validate_errs')
+    print ('  -f   comma separated list of files to validate. if no -f, it validates entire mockup')
     print ('  -r   hostname or IP address [:portno], default None')
-    print ('  -i   url, --used with -r option to specify url for a live system. default /redfish/v1') 
+    print ('  -i   url, --used with -r option to specify url for a live system. default /redfish/v1')
     print ('  -x   comma separated list of patterns to exclude from errors') 
     print ('  -g   validate only resources which failed a previous run')
     print ('\n')
@@ -136,7 +137,7 @@ def __init__(self, argv):
         elif self.files:
             self.traverseFiles()
         else:
-            self.traverseDir()        
+            self.traverseDir()
 
         print ('\n{} resources validated.'.format(self.rescount))
         if self.errcount:
@@ -158,7 +159,6 @@ def doErrors(self):
                 line = line.replace('/index.json','')
                 self.files += line + ','
         self.traverseFiles()
-        
 
     def valFromHost(self):
         ''' GET one resource from a host (rackmanager?)
@@ -189,7 +189,6 @@ def valFromHost(self):
         self.rescount += 1
         self.validate(data,schname,self.url)
 
-
     def traverseFiles(self):
         ''' read a list of resources specified
             with the -f option,
@@ -230,7 +229,7 @@ def traverseFiles(self):
             self.validate(data,schname,fname)
 
     def traverseDir(self):
-        ''' walk a directory of resources,i.e a "mockup" 
+        ''' walk a directory of resources,i.e a "mockup"
             and validate against a DTMF schema.
         '''
         for dirn, subdir, filelist in  os.walk(self.mockdir):
@@ -390,7 +389,7 @@ def parseOdataType(self,resource):
             return(None,None,None)
 
         resourceOdataType=resource["@odata.type"]
-    
+
         #the odataType format is:  <namespace>.<version>.<type>   where version may have periods in it 
         odataTypeMatch = re.compile('^#([a-zA-Z0-9]*)\.([a-zA-Z0-9\._]*)\.([a-zA-Z0-9]*)$')  
         resourceMatch = re.match(odataTypeMatch, resourceOdataType)
@@ -413,6 +412,5 @@ def parseOdataType(self,resource):
         return(namespace, version, resourceType)
 
 if __name__ == '__main__':
+    print( "Redfish-JsonSchema-ResponseValidator version {}".format( tool_version ) )
     rv = ResourceValidate(sys.argv)
-
-