commit	5fb70e85c56490ff1adbcf0b7b2caedd646d9c42	[log] [tgz]
author	Manzon, Inna (im453s) <im453s@intl.att.com>	Thu Oct 04 16:36:16 2018 +0300
committer	Manzon, Inna (im453s) <im453s@intl.att.com>	Thu Oct 04 16:36:16 2018 +0300
tree	2388915fddffa5188b02a64725fa621077ce8416
parent	6d63aa53f4b14b4b41ec3a4734c5c62ab6c68b3a [diff]

tree: 2388915fddffa5188b02a64725fa621077ce8416

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.

to run it place your csar in sdc-tosca\src\test\resources\csars
Go to the test class located at sdc-tosca\src\test\java\org\onap\sdc\impl\MyTest.java
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:

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.
Operations support: add support for parsing the Operations in the tosca models.

1.4.2

Features:

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.

1.4.3

Bug fix:

validation fix Maximum nodeTypes we allowed in CSAR file was increased from 10 to 20.

1.4.4

Features:

list support for get input until know the get input was only supported in the following format get_input [ , index ] this way was the only option for using a list typed property and retrieving its value for a use in a property , from this release you can use get input < list> to retrieve the whole list.

example:

properties:
  # the property type is list
  related_networks:
    #this is now supoorted you can retrive the whole list
    get_input: port_vpg_private_0_port_related_networks
  # the property type is string
  network:
    # this will retrive a value from the list
    get_input:
    - port_vpg_private_0_port_network
    - index_value

1.4.5

Features:

getPropertyLeafValueByPropertyNamePathAndNodeTemplatePath API The new Tosca Parser API resolves property value by path in the model (including nested nodes with # delimiter) and property name. It resolves value of the property if it is defined as get input.