This repository contains the tng-sdk-validation component that is part of the European H2020 project 5GTANGO NFV SDK. This component can be used to validate the syntax, integrity and topology of 5GTANGO SDK packages, projects, services and functions. This validation tool helps to make sure that the descriptors of different services and functions are valid and will create working service. There is an additional feature to include custom rules in YAML files to validate the descriptors but it is still under development and not available in master.
tng-sdk-validation can be used through the CLI, as service or as a micro-service running inside a docker container.
-
This tool has been designed to be executed in Linux system and Python 3.6 or higher.
-
It is necessary to install tng-sdk-project first as tng-sdk-validation depends on it. Please follow the instructions provided in the Readme file to install it.
-
Clone the master branch of this repository and access the directory.
-
Then install the Python dependencies defined in requierements file.
$ pip3 install -r requirements.txt- The last step is to install tng-sdk-validation tool.
$ python3 setup.py install- Once installed, the command
tng-sdk-validateshould be available in your Linux system.
The CLI interface is designed for developer usage, allowing to quickly validate SDK projects,package descriptors, service descriptors and function descriptors. The different levels of validation, namely syntax, integrity and topology can only be used in the following combinations:
- syntax only:
-sor--syntax - syntax and integrity
-ior--integrity - syntax, integrity and topology
-tor--topology - syntax, integrity, topology and custom_rules
-cor--custom
The tng-sdk-validation CLI tool can be used to validate one of the following components:
-project - to validate an SDK project, the --workspace parameter must be specified, otherwise the default location $ HOME/.tng-workspace is assumed. (still working in this validations)
- service - in service validation, if the chosen level of validation comprises more than syntax (integrity or topology), the
--dpathargument must be specified in order to indicate the location of the VNF descriptor files, referenced in the service (this mustn't be specified in syntax validation). Has a standalone validation of a service, son-validate is not aware of a directory structure, unlike the project validation. Moreover, the--dextparameter should also be specified to indicate the extension of descriptor files. - function - this specifies the validation of an individual VNF. It is also possible to validate multiple functions in bulk contained inside a directory. To if the
--functionis a directory, it will search for descriptor files with the extension specified by parameter--dext.
5gtango@validation-host:# tng-sdk-validate -h
CLI input arguments: []
usage: tng-sdk-validate [-h] [-w WORKSPACE_PATH]
(--project PROJECT_PATH | --service NSD | --function VNFD | --api)
[--dpath DPATH] [--dext DEXT] [--syntax] [--integrity]
[--topology] [--debug] [--mode {stateless,local}]
[--host SERVICE_ADDRESS] [--port SERVICE_PORT]
tng-sdk-validate: error: one of the arguments --project --package --service --function --api is required
root@debian-experiment:/home/quobis/tng-sdk-validation/src/tngsdk/validation/tests# tng-sdk-validate -h
CLI input arguments: ['-h']
usage: tng-sdk-validate [-h] [-w WORKSPACE_PATH]
(--project PROJECT_PATH | --service NSD | --function VNFD | --api)
[--dpath DPATH] [--dext DEXT] [--syntax] [--integrity]
[--topology] [--debug] [--mode {stateless,local}]
[--host SERVICE_ADDRESS] [--port SERVICE_PORT]
5GTANGO SDK validator
optional arguments:
-h, --help show this help message and exit
-w WORKSPACE_PATH, --workspace WORKSPACE_PATH
Specify the directory of the SDK workspace for
validating the SDK project.
--project PROJECT_PATH
Validate the service of the specified SDK project.
--service NSD Validate the specified service descriptor. The
directory of descriptors referenced in the service
descriptor should be specified using the argument '--
path'.
--function VNFD Validate the specified function descriptor. If a
directory is specified, it will search for descriptor
files with extension defined in '--dext'
--api Run validator in service mode with REST API.
--dpath DPATH Specify a directory to search for descriptors.
Particularly useful when using the '--service'
argument.
--dext DEXT Specify the extension of descriptor files.
Particularly useful when using the '--function'
argument
--cfile Specify the rules used to validate.
--syntax, -s Perform a syntax validation.
--integrity, -i Perform an integrity validation.
--topology, -t Perform a network topology validation.
--custom, -c Perform a custom rules validation.
--debug Sets verbosity level to debug
--mode {stateless,local}
Specify the mode of operation. 'stateless' mode will
run as a stateless service only. 'local' mode will run
as a service and will also provide automatic
monitoring and validation of local SDK projects,
services, etc. that are configured in the developer
workspace
--host SERVICE_ADDRESS
Bind address for this service
--port SERVICE_PORT Bind port number
Example usage:
tng-sdk-validate --project /home/sonata/projects/project_X
--workspace /home/sonata/.son-workspace
tng-sdk-validate --service ./nsd_file.yml --path ./vnfds/ --dext yml
tng-sdk-validate --function ./vnfd_file.yml
tng-sdk-validate --function ./vnfds/ --dext yml
Please refer to the wiki of the project for a more detailed documentation.
The tng-sdk-validation is published under Apache 2.0 license. Please see the LICENSE file for more details.
The following lead developers are responsible for this repository and have admin rights. They can, for example, merge pull requests.
- Antón Román Portabales anton.roman@quobis.com
- Ana Pol González ana.pol@quobis.com
- Daniel Fernández Calvo daniel.fernandez@quobis.es
- You may use the mailing list tango-5g-wp4@lists.atosresearch.eu
- GitHub issues