README.md

   1 # ONAP SDC-Tosca
   2
   3
   4 ---
   5 ---
   6
   7 # Introduction
   8
   9 ONAP SDC-Tosca is delivered as helper JAR that can be used by clients that work with SDC TOSCA CSAR files.
  10 It parses the CSAR and returns the model object which represents the CSAR contents, through designated function calls with SDC flavour.
  11 It uses the underlying generic JTOSCA parser.
  12
  13
  14 # Compiling ONAP JTOSCA
  15
  16 ONAP SDC-Tosca can be compiled easily using maven command: `mvn clean install`
  17 The result is JAR file under "target" folder
  18
  19 # Testing a CSAR locally
  20 to run the parser locally you can use the MyTest Junit test to easily execute the parser on your own input.
  21
  22 1. to run it place your csar in **sdc-tosca\src\test\resources\csars**
  23
  24 2. Go to the test class located at **sdc-tosca\src\test\java\org\onap\sdc\impl\MyTest.java**
  25
  26 3. un comment the logic ther and update the csar name you plced in the step above:
  27 ```java
  28 SdcToscaParserFactory factory = SdcToscaParserFactory.getInstance();
  29 ISdcCsarHelper = getCsarHelper("csars/<your csar name example my.csar>");
  30
  31 //example of functions
  32 //get node type by name
  33 List<NodeTemplate> serviceNodeTemplatesByType = fdntCsarHelper.getServiceNodeTemplatesByType("org.openecomp.nodes.ForwardingPath");
  34 //get node type property
  35 String target_range = fdntCsarHelper.getNodeTemplatePropertyLeafValue(serviceNodeTemplatesByType.get(0), "target_range");
  36
  37 ```
  38
  39 # Getting Help
  40
  41
  42 ##### [Mailing list](mailto:onap-sdc@lists.onap.org)
  43
  44
  45
  46 ##### [JIRA](http://jira.onap.org)
  47
  48
  49
  50 ##### [WIKI](https://wiki.onap.org/display/DW/Service+Design+and+Creation+%28SDC%29+Portal)
  51
  52 ##### [TOSCA Prser AID]((https://wiki.onap.org/display/DW/Service+Design+and+Creation+%28SDC%29+Portal))
  53
  54
  55
  56
  57
  58
  59 # Release notes
  60
  61 ## 1.4.1
  62
  63 ### Features:
  64 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.
  65    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.
  66    from this version the max version will no longer be checked by the parser.
  67 2. **Operations support**: add support for parsing the Operations in the tosca models.
  68
  69
  70
  71