Merge branch 'validation' into '3.3.1-dev'

Validation

See merge request !1

.jenkins.sh

+#!/bin/bash
+# Copyright ETSI 2017
+# See: https://forge.etsi.org/etsi-forge-copyright-statement.txt
+
+cd "$(dirname "$0")"
+
+run_dir="$(pwd)"
+
+rm build/*-API.yaml
+rm build/*-API.json
+
+cd docker
+
+./build-container.sh
+
+./run-container.sh "${run_dir}"
+OUTCOME=$?
+
+exit $OUTCOME

docker/Dockerfile

+# Copyright ETSI 2017
+# See: https://forge.etsi.org/etsi-forge-copyright-statement.txt
+
+FROM alpine:3.6
+
+RUN env
+RUN apk update
+RUN apk add bash
+RUN apk add nodejs
+RUN apk add nodejs-npm
+RUN apk add asciidoctor
+RUN apk add openjdk8
+RUN apk add ca-certificates wget && update-ca-certificates 
+RUN apk add openssl
+RUN gem install rdoc --pre || gem install rdoc --pre
+RUN gem install asciidoctor-pdf-cjk
+RUN wget https://forge.etsi.org/swagger2markup-cli-1.3.2.jar
+RUN npm config set proxy $http_proxy
+RUN npm install -g swagger-cli@0.10.3
+RUN npm install -g json-refs@3.0.2
+RUN npm install -g yamljs@0.3.0
+
+ADD validate-in-docker.sh /validate-in-docker.sh
+RUN chmod +x /validate-in-docker.sh
+
+ADD swg2mrkup /bin/swg2mrkup
+RUN chmod +x /bin/swg2mrkup
+
+ADD oas2pdf /bin/oas2pdf
+RUN chmod +x /bin/oas2pdf
+
+ENTRYPOINT ["/validate-in-docker.sh"]
+

docker/build-container.sh

+#!/bin/bash
+# Copyright ETSI 2017
+# See: https://forge.etsi.org/etsi-forge-copyright-statement.txt
+
+#set -x
+
+proxy = ""
+if [[ ! -v http_proxy ]]; then
+    echo "http_proxy is not set"
+elif [[ -z "$http_proxy" ]]; then
+    echo "http_proxy is empty"
+else
+    echo "http_proxy is set to $http_proxy"
+    if [[ $http_proxy =~ ^http:\/\/[0-9] ]]; then
+        echo "starts with http"
+        proxy=$http_proxy
+    elif [[ $http_proxy =~ ^[0-9] ]]; then
+        echo "starts with number"
+        proxy=http://$http_proxy
+    fi
+fi
+
+echo "Proxy set to $proxy"
+
+docker build --build-arg http_proxy=$proxy --build-arg https_proxy=$proxy -t openapivalidator .
\ No newline at end of file

docker/oas2pdf

+#!/bin/bash
+#Copyright (c) ETSI 2017.
+
+# This software is subject to copyrights owned by ETSI. Non-exclusive permission 
+# is hereby granted, free of charge, to copy, reproduce and amend this file 
+# under the following conditions: It is provided "as is", without warranty of any 
+# kind, expressed or implied. 
+
+# ETSI shall never be liable for any claim, damages, or other liability arising 
+# from its use or inability of use.This permission does not apply to any documentation 
+# associated with this file for which ETSI keeps all rights reserved. The present 
+# copyright notice shall be included in all copies of whole or part of this 
+# software and shall not imply any sub-license right.
+#
+# Author: michele.carignani@etsi.org
+#
+# This script takes an OpenAPI file in input and creates
+# a PDF file with the content.
+#
+# Prerequisites: 
+#  - https://github.com/Swagger2Markup/swagger2markup-cli
+#  - Asciidoctor (sudo apt-get install asciidoctor)
+#  - Asciidoctor-pdf (sudo gem install asciidoctor-pdf)
+#
+# Usage:
+#    oas2pdf <oasfile> (e.g. myapi.json)
+#
+# Result:
+#    A new pdf file is created in the working directory (e.g. myapi.pdf)
+#
+#
+#
+#
+
+# Configuration
+
+# Change this if needed
+SWG2MRKUP=swg2mrkup
+ASCIIDOCPDF=asciidoctor-pdf
+
+# Setup
+WD=$(pwd)
+TWD=$(mktemp -d)
+
+INFILE=$(basename ${1?"Error: missing input file name"} )
+OUTFILE="${INFILE%.*}"
+
+echo "$INFILE, $OUTFILE"
+
+echo "Converting to asciidoc.."
+${SWG2MRKUP} convert -i "$1" -f "$TWD/$OUTFILE"
+echo
+
+echo "Converting to PDF.."
+"${ASCIIDOCPDF}" "$TWD/${OUTFILE}.adoc" -o "$WD/${OUTFILE}.pdf"
+echo
+
+echo "Done."
+# Clean up
+rm -r $TWD
+

docker/run-container.sh

+#!/bin/bash
+# Copyright ETSI 2017
+# See: https://forge.etsi.org/etsi-forge-copyright-statement.txt
+
+# Change this variable to true if you want
+# to copy the created yaml files to a web served directory
+#
+#
+WEB_PUBLISH=true
+
+f="${1:-`pwd`}"
+filter="$2"
+
+echo "Mounting dir $f as /work"
+
+if [ -n "$JOB_BASE_NAME" -a "$WEB_PUBLISH" = true ] ; then 
+  s="/var/www/html/api/nfv/$JOB_BASE_NAME/$BUILD_NUMBER"
+  mkdir -v -p "$s"
+  echo "Mounting dir $s as /storage"  
+  docker run -v "$f":/work -v "$s":/storage openapivalidator "/work" "/storage" "$filter"
+else
+  docker run -v "$f":/work openapivalidator "/work" "/storage" "$filter"
+fi 
+
+
+
+

docker/swg2mrkup

+#!/bin/bash
+#Copyright (c) ETSI 2017.
+
+# This software is subject to copyrights owned by ETSI. Non-exclusive permission 
+# is hereby granted, free of charge, to copy, reproduce and amend this file 
+# under the following conditions: It is provided "as is", without warranty of any 
+# kind, expressed or implied. 
+
+# ETSI shall never be liable for any claim, damages, or other liability arising 
+# from its use or inability of use.This permission does not apply to any documentation 
+# associated with this file for which ETSI keeps all rights reserved. The present 
+# copyright notice shall be included in all copies of whole or part of this 
+# software and shall not imply any sub-license right.
+#
+# Author: michele.carignani@etsi.org
+
+java -jar /swagger2markup-cli-1.3.2.jar $@

docker/validate-in-docker.sh

+#!/bin/bash
+# Copyright ETSI 2017
+# See: https://forge.etsi.org/etsi-forge-copyright-statement.txt
+
+# Merges OpenAPIs interfaces in the working directory
+# and validates them individually.
+# Exit status is 0 if all validation passed, 1 otherwise
+
+# Usage:
+# $0 <working-directory> <storage-dir>
+
+#set -x
+
+function store_api () {
+	f="$1"
+	cp -v "$1" "${storage_dir}/"
+}
+
+function validate_api () {
+  file="$1"
+  api="$2"
+  deliverable="$3"
+  echo "--- Merging file."
+  merged_file="../build/${deliverable}-${api}-API.yaml"
+  json_file="../build/${deliverable}-${api}-API.json"
+  json-refs resolve "${file}" > "${merged_file}"
+  yaml2json "${merged_file}" > "${json_file}"
+  
+  # Create the PDF version
+  echo "--- Create PDF..."
+  oas2pdf "${json_file}" 2>/dev/null 1>/dev/null 
+  mv "${deliverable}-${api}-API.pdf" "../build/"
+
+  echo "--- Validating ${merged_file}"
+  swagger-cli validate "${merged_file}"
+  vres=$?
+  echo "--- Validation done ($vres)."
+
+  # If validation succedes, store the generated file
+  [ $vres -a -d "/storage" ] && store_api "${merged_file}"
+  [ $vres -a -d "/storage" ] && store_api "${json_file}"
+  [ $vres -a -d "/storage" ] && store_api "../build/${deliverable}-${api}-API.pdf"
+  
+  
+  return $vres
+}
+
+# usage get_api_from_fn <file_name>
+#  e.g. get_api_from_fn /path/to/SOL003/Api1/Api1.yaml returns Api1
+function get_api_from_fn () {
+  echo "$(basename $(dirname $1))"
+}
+
+# usage get_api_from_fn <file_name>
+#  e.g. get_api_from_fn /path/to/SOL003/Api1/Api1.yaml returns Api1
+function get_deliverable_from_fn () {
+  echo "$(basename $(dirname $(dirname $1 )))"
+}
+
+## Main ##
+
+wd="${1?"Usage: $0 <working-directory> <storage-directory> [<filter_regex>]"}"
+storage_dir="${2?"Usage: $0 <working-directory> <storage-directory> [<filter_regex>]"}"
+
+filter="$3"
+echo "Using filter '$filter'"
+echo
+
+mkdir -p "$wd/build"
+
+echo "Entering dir $wd/src"
+cd "$wd/src"
+
+# Stores the overall validation result
+# (single results in OR)
+fres=0
+
+
+for f in $(find -name "*.yaml") ; do
+      # echo "Found yaml file: $f"
+      file=$(basename "$f")
+      api=$(get_api_from_fn $f)
+      deliverable=$(get_deliverable_from_fn $f)
+      if [ "$file" = "$api.yaml" ]; then
+          if [[ -n "$filter" &&  ! "$f" =~ ^[a-zA-Z0-9\.\/\-]*$filter[a-zA-Z\.\/0-9\-]*$ ]] ; then 
+            echo "Filtered out: $f (api: $api) (deliverable:$deliverable)."
+          else 
+            echo "-- Will validate: $f (api: $api) (deliverable:$deliverable)"         
+            validate_api "$f" "$api" "$deliverable"
+            res=$?
+            fres=$(($fres||$res))
+          fi
+      fi
+done
+
+chmod -R o+w "$wd/build"
+
+# Exit code needed for jenkins to know the verdict of the build
+echo "-- Final validator returns $fres."
+exit $fres