From 07a7a7bfa04827c34b115a5adf98037de439d5da Mon Sep 17 00:00:00 2001 From: Alexandru Avadanii Date: Sun, 14 Jan 2018 02:26:05 +0100 Subject: [PATCH] [IDF] Add IDF schema validation based on version - add basic structure for IDF schema validation; - fill in Fuel section; - add stub for Daisy section; - add stub for Compass section; - add stub for net_config; - enable IDF schema validation via `check-schema.sh`; - prepare for new IDF versions with different schemas, while allowing subsection schema reuse from IDF v0.1; - extend validate_schema.py for IDF; Change-Id: I59b1c9d857e9dee9e6ff9956e81b2ae6dc27a767 Signed-off-by: Alexandru Avadanii --- config/pdf/idf-pod1.schema.yaml | 113 ++++++++++++++++++++++++++++++++++++++++ config/utils/check-jinja2.sh | 2 +- config/utils/check-schema.sh | 21 ++++++-- config/utils/validate_schema.py | 2 + 4 files changed, 133 insertions(+), 5 deletions(-) create mode 100644 config/pdf/idf-pod1.schema.yaml diff --git a/config/pdf/idf-pod1.schema.yaml b/config/pdf/idf-pod1.schema.yaml new file mode 100644 index 00000000..78e22042 --- /dev/null +++ b/config/pdf/idf-pod1.schema.yaml @@ -0,0 +1,113 @@ +############################################################################## +# Copyright (c) 2018 Enea AB and others. +# All rights reserved. This program and the accompanying materials +# are made available under the terms of the Apache License, Version 2.0 +# which accompanies this distribution, and is available at +# http://www.apache.org/licenses/LICENSE-2.0 +############################################################################## +--- +$schema: 'http://json-schema.org/schema#' +$id: 'https://github.com/opnfv/pharos/blob/master/config/pdf/pod1.yaml' + +definitions: + net_config: + v0.1: + # NOTE: I hope this is going away soon, so I won't model it yet + type: 'object' + daisy: + v0.1: + type: 'object' + # NOTE: To be properly modeled by Daisy maintainers + compass: + v0.1: + type: 'object' + # NOTE: To be properly modeled by Compass4NFV maintainers + fuel: + v0.1: + type: 'object' + properties: + jumphost: + type: 'object' + properties: + bridges: + type: 'object' + properties: + admin: + type: ['string', 'null'] + mgmt: + type: ['string', 'null'] + private: + type: ['string', 'null'] + public: + type: ['string', 'null'] + required: ['admin', 'mgmt', 'private', 'public'] + additionalProperties: false + required: ['bridges'] + additionalProperties: false + network: + type: 'object' + properties: + node: + type: 'array' + items: + type: 'object' + properties: + interfaces: + type: 'array' + items: + type: ['string', 'null'] + busaddr: + type: 'array' + items: + type: ['string', 'null'] + required: ['interfaces', 'busaddr'] + additionalProperties: false + required: ['node'] + additionalProperties: false + required: ['jumphost', 'network'] + additionalProperties: false + +############################################################################## +# Top-level structure: +# - define all possible top-level and second-level keys, without enforcing a +# schema for second-level, just so we can disallow additional properties; +# - require 'version' and allow dynamically generated 'version_x.y' key; +properties: + idf: + properties: + # version_x.y keys are auto-added by `validate_schema.py` based on 'version' + version_0.1: + type: 'boolean' + version: + type: 'number' + enum: [0.1] + net_config: + type: 'object' + fuel: + type: 'object' + daisy: + type: 'object' + compass: + type: 'object' + required: ['version'] + additionalProperties: false + ############################################################################ + # Schema versioning + # - based on dynamically added 'version_x.y', require additional IDF blocks + # and validate them against the proper schema version; + dependencies: + version_0.1: + properties: + net_config: + $ref: '#/definitions/net_config/v0.1' + fuel: + $ref: '#/definitions/fuel/v0.1' + daisy: + $ref: '#/definitions/daisy/v0.1' + compass: + $ref: '#/definitions/compass/v0.1' + required: ['net_config'] + +# Do not allow any properties not defined here. This lets us catch typos. +additionalProperties: false +required: ['idf'] diff --git a/config/utils/check-jinja2.sh b/config/utils/check-jinja2.sh index 59a6506b..b7fa5912 100755 --- a/config/utils/check-jinja2.sh +++ b/config/utils/check-jinja2.sh @@ -19,7 +19,7 @@ FILTER_LAB=${1:-*} # e.g. 'zte' (glob) FILTER_POD=${2:-(pod|virtual)[[:digit:]]+} # e.g. 'pod1' (regex) FILTER_IA=${3:-*} # e.g. 'fuel' (glob) -GEN_CFG='./config/utils/generate_config.py' +GEN_CFG='python ./config/utils/generate_config.py' INSTALLER_ADAPTERS="./config/installers/${FILTER_IA}" TMPF='/tmp/out.yml' # should be outside Jenkins WS to prevent data leakage RC=0 diff --git a/config/utils/check-schema.sh b/config/utils/check-schema.sh index 61bdec22..0cdc6f29 100755 --- a/config/utils/check-schema.sh +++ b/config/utils/check-schema.sh @@ -9,23 +9,36 @@ export PATH=$PATH:/usr/local/bin/ -VALIDATE_SCHEMA='./config/utils/validate_schema.py' +VALIDATE_SCHEMA='python ./config/utils/validate_schema.py' PDF_SCHEMA='./config/pdf/pod1.schema.yaml' +IDF_SCHEMA='./config/pdf/idf-pod1.schema.yaml' RC=0 +SUMMARY+=";;PDF;IDF;\n" while IFS= read -r lab_config; do pdf_cmd="${VALIDATE_SCHEMA} -s ${PDF_SCHEMA} -y ${lab_config}" + idf_cmd="${VALIDATE_SCHEMA} -s ${IDF_SCHEMA} -y ${lab_config/pod/idf-pod}" echo "###################### ${lab_config} ######################" - pdf_out=$(${pdf_cmd} |& sed 's|ENC\[PKCS.*\][\\n]*|opnfv|g') + pdf_out=$(${pdf_cmd} 2>&1 | sed 's|ENC\[PKCS.*\][\\n]*|opnfv|g') if [ -z "${pdf_out}" ]; then - SUMMARY+=";${lab_config#labs/};OK;\n" + SUMMARY+=";${lab_config#labs/};OK;" echo "[PDF] [OK] ${pdf_cmd}" else - SUMMARY+=";${lab_config#labs/};ERROR;\n" + SUMMARY+=";${lab_config#labs/};ERROR;" RC=1 echo "${pdf_out}" echo "[PDF] [ERROR] ${pdf_cmd}" fi + if [ ! -f "${lab_config/pod/idf-pod}" ]; then + SUMMARY+="-;\n" + elif ${idf_cmd}; then + SUMMARY+="OK;\n" + echo "[IDF] [OK] ${idf_cmd}" + else + SUMMARY+="ERROR;\n" + RC=1 + echo "[IDF] [ERROR] ${idf_cmd}" + fi echo '' done < <(find 'labs' -name 'pod*.yaml') diff --git a/config/utils/validate_schema.py b/config/utils/validate_schema.py index 6bdc3bdb..42f475d8 100755 --- a/config/utils/validate_schema.py +++ b/config/utils/validate_schema.py @@ -34,6 +34,8 @@ def schema_version_workaround(node): if type(item) is dict: schema_version_workaround(item) schema_version_workaround(_DICT) +if 'idf' in _DICT: + schema_version_workaround(_DICT['idf']) _VALIDATOR = jsonschema.Draft4Validator(_SCHEMA) for error in _VALIDATOR.iter_errors(_DICT): -- 2.16.6