Proposal
The Validation Scripts have historically produced a number of reports geared toward human consumption, but no report has existed that provided a full accounting of results in a machine readable format. A file named failures
was produced in the output directory, but it contained only a subset of information about the execution run. The following proposal is to create a new file ( report.json
) that contains a full account of all available information. It would be produced on every run of the validation scripts, and would be suitable for consumption for tools such as VNFSDK or Dovetail as part of the certification program.
File Specification
The top level will include a summary of available execution metadata.
NOTE: The tests
and requirements
entries are elided in the example below.
{ "version": "dublin", "template_directory": "C:\\Users\\tl2972\\Desktop\\stark_template2", "timestamp": "2019-01-21T02:11:07.305000", "checksum": "6296aa211870634f9b4a23477c5eab28", "profile": "", "outcome": "FAIL", "tests": [], "requirements": [], }
Field Name | Required/ Optional/ Conditional | Datatype | Valid Values | Description |
---|---|---|---|---|
version | Required | string | Version of the validation scripts that produced the report. For now, this is set to the ONAP release name, but it may change to a semantic version number in the future. | |
template_directory | Required | string | Absolute path of the directory containing the Heat templates that were validated | |
timestamp | Required | string | ISO 8601 Timestamp in UTC | |
checksum | Required | string |