From e872f7222a220ae47d65ff78f90ea435fc65fa38 Mon Sep 17 00:00:00 2001 From: Lianhao Lu Date: Fri, 1 Sep 2017 10:36:01 +0800 Subject: Decouple aria parser Use stevedore to make the aria parser as a plugin of the vnfsdk package tool. Currently, the aria parser is still the default parser but 3rd party developer can add other plugins as a parser to validate the csar packages. Change-Id: I4a1a1c5e65103fb93fa8aebf3d683781f4888ea4 Signed-off-by: Lianhao Lu Issue-Id: VNFSDK-60 --- cli/__main__.py | 28 +++++++++----------------- requirements.txt | 1 + setup.py | 9 +++++++-- validator/__init__.py | 49 +++++++++++++++++++++++++++++++++++++++++++++ validator/aria_validator.py | 43 +++++++++++++++++++++++++++++++++++++++ 5 files changed, 109 insertions(+), 21 deletions(-) create mode 100644 validator/__init__.py create mode 100644 validator/aria_validator.py diff --git a/cli/__main__.py b/cli/__main__.py index 2fe4d68..2ae0078 100644 --- a/cli/__main__.py +++ b/cli/__main__.py @@ -22,15 +22,8 @@ from aria import install_aria_extensions import os import shutil import tempfile -from aria.parser.loading import LiteralLocation -from aria.parser.consumption import ( - ConsumptionContext, - ConsumerChain, - Read, - Validate, - ServiceTemplate, - ServiceInstance -) + +import validator def csar_create_func(namespace): csar.write(namespace.source, @@ -48,16 +41,9 @@ def csar_validate_func(namespace): reader = csar.read(namespace.source, workdir, logging) - context = ConsumptionContext() - context.loading.prefixes += [os.path.join(reader.destination, 'definitions')] - context.presentation.location = LiteralLocation(reader.entry_definitions_yaml) - print reader.entry_definitions_yaml - chain = ConsumerChain(context, (Read, Validate, ServiceTemplate, ServiceInstance)) - chain.consume() - if context.validation.dump_issues(): - raise RuntimeError('Validation failed') - dumper = chain.consumers[-1] - dumper.dump() + + driver = validator.get_validator(namespace.parser) + driver.validate(reader) finally: shutil.rmtree(workdir, ignore_errors=True) @@ -104,6 +90,10 @@ def parse_args(args_list): csar_validate.add_argument( 'source', help='CSAR file location') + csar_validate.add_argument( + '-p', '--parser', + default='aria', + help='use which csar parser to validate') return parser.parse_args(args_list) diff --git a/requirements.txt b/requirements.txt index 245c3b4..0153edc 100644 --- a/requirements.txt +++ b/requirements.txt @@ -1,3 +1,4 @@ ruamel.yaml<0.12.0,>=0.11.12 requests<2.14.0,>=2.3.0 apache-ariatosca==0.1.1 +stevedore >= 1.9.0 diff --git a/setup.py b/setup.py index ab56412..61c8ec1 100644 --- a/setup.py +++ b/setup.py @@ -73,17 +73,22 @@ setup( packages=[ 'packager', - 'cli' + 'cli', + 'validator' ], package_dir={ 'packager': 'packager', 'cli': 'cli', + 'validator': 'validator' }, entry_points={ 'console_scripts': [ - 'vnfsdk = cli.__main__:main'] + 'vnfsdk = cli.__main__:main'], + 'vnfsdk.validator': [ + 'aria = validator.aria_validator:AriaValidator' + ] }, include_package_data=True, diff --git a/validator/__init__.py b/validator/__init__.py new file mode 100644 index 0000000..d33dcdf --- /dev/null +++ b/validator/__init__.py @@ -0,0 +1,49 @@ +# Copyright (c) 2017 Intel Corp. All rights reserved. +# +# Licensed under the Apache License, Version 2.0 (the "License"); you may +# not use this file except in compliance with the License. You may obtain +# a copy of the License at +# +# http://www.apache.org/licenses/LICENSE-2.0 +# +# Unless required by applicable law or agreed to in writing, software +# distributed under the License is distributed on an "AS IS" BASIS, WITHOUT +# WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the +# License for the specific language governing permissions and limitations +# under the License. +# + +import abc + +import six +from stevedore import driver + + +VALIDATOR_NS = "vnfsdk.validator" + +def get_validator(params): + """Get validate driver and load it. + + :param params: parameters to decide which validator to load + """ + + loaded_driver = driver.DriverManager(VALIDATOR_NS, + params, + invoke_on_load=True) + return loaded_driver.driver + + +@six.add_metaclass(abc.ABCMeta) +class ValidatorBase(object): + """Base class for validators.""" + + def __init__(self): + pass + + + @abc.abstractmethod + def validate(self, reader): + """Validate the csar package. + + :param reader: instance of package.csar._CSARReader + """ diff --git a/validator/aria_validator.py b/validator/aria_validator.py new file mode 100644 index 0000000..6149790 --- /dev/null +++ b/validator/aria_validator.py @@ -0,0 +1,43 @@ +# Copyright (c) 2017 Intel Corp. All rights reserved. +# +# Licensed under the Apache License, Version 2.0 (the "License"); you may +# not use this file except in compliance with the License. You may obtain +# a copy of the License at +# +# http://www.apache.org/licenses/LICENSE-2.0 +# +# Unless required by applicable law or agreed to in writing, software +# distributed under the License is distributed on an "AS IS" BASIS, WITHOUT +# WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the +# License for the specific language governing permissions and limitations +# under the License. +# + +import os + +from aria.parser.loading import LiteralLocation +from aria.parser.consumption import ( + ConsumptionContext, + ConsumerChain, + Read, + Validate, + ServiceTemplate, + ServiceInstance +) + +import validator + + +class AriaValidator(validator.ValidatorBase): + def validate(self, reader): + context = ConsumptionContext() + context.loading.prefixes += [os.path.join(reader.destination, 'definitions')] + context.presentation.location = LiteralLocation(reader.entry_definitions_yaml) + print reader.entry_definitions_yaml + chain = ConsumerChain(context, (Read, Validate, ServiceTemplate, ServiceInstance)) + chain.consume() + if context.validation.dump_issues(): + raise RuntimeError('Validation failed') + dumper = chain.consumers[-1] + dumper.dump() + -- cgit 1.2.3-korg