Merge pull request #66 from DMTF/1.0.0-Tagging

Updated documents for 1.0.0

Author: mraineri

AUTHORS.md

@@ -1,10 +1,4 @@
 # Original Contribution:
+
 * Steve Krig - Intel Corporation
 * Fatima Saleem - Intel Corporation
-
-# Other Key Contributions:
-* 
-
-append new contributions to the bottom
-
-

CHANGELOG.md

@@ -1,6 +1,8 @@
-
 # Change Log
 
+## [1.0.0] - 2018-01-26
+- Various bug fixes; getting into standard release cadence
+
 ## [2016.09] - 2016-09-22
 - Initial Release to public
 
@@ -17,14 +19,14 @@
 
 ## [2016.04] - 2016-04-12
 - Added utility class/function support:
-  	- properties.json controls added: download schema files from dmtf URI/location
+    - properties.json controls added: download schema files from dmtf URI/location
     - utilty functions added to exaustively parse/scan schema/metadata files
 - Added Assertion coverage for section 7 (Data Model & Schema)
-               	3. 
+
 ## [2016.03] - 2016-03-21
 - This tool revision has been run on a second OEM production level Service
-	- Code changes were made to the HTTP connection functions
-    - Assertions were 'normalized' based on the 2 Service interpretations of the Redfish spec 
+- Code changes were made to the HTTP connection functions
+- Assertions were 'normalized' based on the 2 Service interpretations of the Redfish spec 
 - Increased assertion coverage for Sections 6, 8 and 9
 - Utility fuction support for section 7: map schema namespace to URI for related json payload
 
@@ -38,14 +40,7 @@
 - Add user config. parameters for Event Service subscription and Test Event to properties.json
 - Add user config. parameters for Metadata file location to properties.json
 - Support for python 3.4.2 has been added/verified
+
 ## [2016.01] - 2016-01-15
 - Initial push to the DMTF/SPMF repository https://github.com/DMTF/spmf.git. 
 - This tool revision has been verified against only one Redfish Service 1.0 enabled production server (the only one available in Q4'15). 
-
-
-
-
-
-
-
-

README.md

@@ -1,9 +1,13 @@
-Copyright 2016 Distributed Management Task Force, Inc. All rights reserved.
+Copyright 2016-2018 Distributed Management Task Force, Inc. All rights reserved.
+
 # Redfish Service Conformance Check Tool
+
 This tool checks an operational Redfish Service to see that it conforms to the normative statements from the Redfish specification (see assertions in redfish-assertions.xlxs).   Assertion coverage is growing (development in process) and future revisions of the tool will increase coverage of the Assertions. To see which Assertions are covered by a revision - run the tool and look at the markup to the SUTs copy of the xlxs file after the check is run.
 
 This program has been tested with Python 2.7.10 and 3.4.3.
-## Installation and Invocation ##
+
+## Installation and Invocation
+
 1. Install one of the python revisions noted as 'verified' (any 2.7+ or 3.4+ "should" work... but the current release was checked only with the 'Verified/operational' ones)
 2. This tool imports `openpyxl`, `requests` and `beautifulsoup4`, which are not installed by default in python. You will need to install them using 'pip'. Execute the following command:
 
@@ -23,15 +27,15 @@ This program has been tested with Python 2.7.10 and 3.4.3.
 	- Set the parameters for Event Subscription and related Test Event generation. Note that the Event related assertions do not verify that a Test Event actually gets delivered to the "Destination" you specify - but the assertions will create a Subscription and request that the Service issue a Test Event to the Subscription "Destination" using the Test Event parameters you set here
 5. For operational results, open a DOS box and cd to the directory where you placed the files included with this package (example C:\rf_client_dir) and then run rf_client.py. (Make sure openpyxl is installed with this version of python else it will error out.)
 
-    C:\rf_client_dir> python rf_client.py 
+    `C:\rf_client_dir> python rf_client.py` 
 6. Check results:
-	- rf_client.py will log results to rf-assertions-log.txt (append) and creates a <timestamp>_rf-assertions-run.xlxs under script_dir/logs/<DisplayName>/ folder.
-    - The text log is an appended log for all test runs for SUT <DisplayName> but the xlxs files are created each time assertions are run for <DisplayName>.
-    	- For example, if properties.json has SUTs['DisplayName'] "Contoso_server1" then "log/ContosoServer1/ will be created and <timestamp>_rf-assertions-run.xlxs" will be created each time you run rf_client.py with "ContosoServer1" configured in properties.json.
+    - rf_client.py will log results to rf-assertions-log.txt (append) and creates \<timestamp\>_rf-assertions-run.xlxs under script_dir/logs/\<DisplayName\>/ folder.
+    - The text log is an appended log for all test runs for SUT \<DisplayName\> but the xlxs files are created each time assertions are run for \<DisplayName\>.
+        - For example, if properties.json has SUTs['DisplayName'] "Contoso_server1" then "log/ContosoServer1/ will be created and \<timestamp\>_rf-assertions-run.xlxs" will be created each time you run rf_client.py with "ContosoServer1" configured in properties.json.
     - Red/Yellow/Green = Fail/Warn/Pass.
     - The Assertions which are not covered by the check are not color marked in the xlxs.
 
-
 ## Work in progress items/limitations:
+
 1. Work in progress items are either annotated with 'WIP' or 'todo'. They dont affect the completed portion of the tool which should successfully run.
 2. Current implementation for schemas found in local directory (or remotely retrieved) does not guarantee that SUT service is using the same version of the schema files. It is a WIP for this tool. Please make sure that schema file version found in $metadata for SUT is the same as the version of files in the directory to get correct results