Gitiles
Code Review Sign In
gerrit.nordix.org / onap / sdc / sdc-tosca / a2705637c17beb663c47f82b03279e479ed2f8ca
commita2705637c17beb663c47f82b03279e479ed2f8ca[log] [tgz]
authorYuli Shlosberg <ys9693@att.com>Tue Aug 14 16:52:58 2018 +0300
committerYuli Shlosberg <ys9693@att.com>Tue Aug 14 16:52:58 2018 +0300
tree32e25f1692c718f068ed54657489a5b86a206302
parent9cc8dff8223e03b6a5bc5cfc2c23d31989de2c61 [diff]
Enable types validation feature

InvalidTypeError added to conf

This conf addition will case to parser throw exception in case that invalid type found during parsing process

Change-Id: I6497d32862e64abaeec20d30da50fff4c5964d4e
Issue-ID: SDC-1646
Signed-off-by: Yuli Shlosberg <ys9693@att.com>
14 files changed
tree: 32e25f1692c718f068ed54657489a5b86a206302
  1. docs/
  2. src/
  3. .gitignore
  4. .gitreview
  5. INFO.yaml
  6. LICENSE.TXT
  7. pom.xml
  8. README.md
  9. version.properties
README.md

ONAP SDC-Tosca

Introduction

ONAP SDC-Tosca is delivered as helper JAR that can be used by clients that work with SDC TOSCA CSAR files. It parses the CSAR and returns the model object which represents the CSAR contents, through designated function calls with SDC flavour. It uses the underlying generic JTOSCA parser.

Compiling ONAP JTOSCA

ONAP SDC-Tosca can be compiled easily using maven command: mvn clean install The result is JAR file under "target" folder

Testing a CSAR locally

to run the parser locally you can use the MyTest Junit test to easily execute the parser on your own input.

  1. to run it place your csar in sdc-tosca\src\test\resources\csars

  2. Go to the test class located at sdc-tosca\src\test\java\org\onap\sdc\impl\MyTest.java

  3. un comment the logic ther and update the csar name you plced in the step above:

SdcToscaParserFactory factory = SdcToscaParserFactory.getInstance();
ISdcCsarHelper = getCsarHelper("csars/<your csar name example my.csar>");

//example of functions
//get node type by name
List<NodeTemplate> serviceNodeTemplatesByType = fdntCsarHelper.getServiceNodeTemplatesByType("org.openecomp.nodes.ForwardingPath");
//get node type property
String target_range = fdntCsarHelper.getNodeTemplatePropertyLeafValue(serviceNodeTemplatesByType.get(0), "target_range");

Adding the SDC-Tosca to you project

the SDC tosca is avilalble as a maven depandency. to use add the folowing depandency to your POM file:

<dependency>
  <groupId>org.onap.sdc.sdc-tosca</groupId>
  <artifactId>sdc-tosca</artifactId>
  <version>1.4.1</version>
</dependency>

Getting Help

Mailing list
JIRA
WIKI
TOSCA Prser AID

Release notes

1.4.1

Features:

  1. disable max conformance level validation: until this version the parser had the definition of the max and min conformance level of the CSAR version which it supports. the conformance level is generated by sdc and as a result the two had to be aligned, over wise the CSAR will fail on parsing. from this version the max version will no longer be checked by the parser.
  2. Operations support: add support for parsing the Operations in the tosca models.

1.4.2

Features:

  1. enable types validation from this version all types in CSAR will be verified, all used types should be properly declared in "base" yml files e.g. node.yml , data.yml etc.