2 * ============LICENSE_START=======================================================
4 * ================================================================================
5 * Copyright © 2017-2018 AT&T Intellectual Property. All rights reserved.
6 * ================================================================================
7 * Licensed under the Apache License, Version 2.0 (the "License");
8 * you may not use this file except in compliance with the License.
9 * You may obtain a copy of the License at
11 * http://www.apache.org/licenses/LICENSE-2.0
13 * Unless required by applicable law or agreed to in writing, software
14 * distributed under the License is distributed on an "AS IS" BASIS,
15 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
16 * See the License for the specific language governing permissions and
17 * limitations under the License.
18 * ============LICENSE_END=========================================================
20 package org.onap.aai.util;
22 import static org.junit.Assert.*;
24 import java.io.StringReader;
26 import javax.xml.XMLConstants;
27 import javax.xml.parsers.DocumentBuilder;
28 import javax.xml.parsers.DocumentBuilderFactory;
30 import org.hamcrest.CoreMatchers;
31 import org.junit.Assert;
32 import org.junit.Before;
33 import org.junit.Rule;
34 import org.junit.Test;
35 import org.junit.runner.RunWith;
37 import org.w3c.dom.Document;
38 import org.w3c.dom.Element;
39 import org.w3c.dom.NodeList;
40 import org.xml.sax.InputSource;
42 import org.onap.aai.introspection.Version;
45 public class GenerateXsdTest {
46 private static final int maxSizeForXml = 20000;
47 private String testXML;
50 public void setUp() throws Exception {
51 //PowerMockito.mockStatic(GenerateXsd.class);
52 StringBuilder sb = new StringBuilder(maxSizeForXml);
54 addRelationshipList(sb);
56 addRelatedToProperty(sb);
57 addRelationshipData(sb);
61 addServiceSubscriptions(sb);
62 addServiceSubscription(sb);
64 testXML = sb.toString();
67 private void addNamespace(StringBuilder sb){
68 sb.append("<xml-bindings xmlns=\"http://www.eclipse.org/eclipselink/xsds/persistence/oxm\" package-name=\"inventory.aai.onap.org.v11\" xml-mapping-metadata-complete=\"true\">\n");
69 sb.append("<xml-schema element-form-default=\"QUALIFIED\">\n");
70 sb.append("<xml-ns namespace-uri=\"http://org.onap.aai.inventory/v11\" />\n");
71 sb.append("</xml-schema>\n");
72 sb.append("<java-types>\n");
73 sb.append("<java-type name=\"Inventory\">\n");
74 sb.append("<xml-root-element name=\"inventory\" />\n");
75 sb.append("<java-attributes>\n");
76 sb.append("<xml-element java-attribute=\"business\" name=\"business\" type=\"inventory.aai.onap.org.v11.Business\" />\n");
77 sb.append("</java-attributes>\n");
78 sb.append("</java-type>\n");
81 private void addRelationshipList(StringBuilder sb ) {
82 sb.append("<java-type name=\"RelationshipList\">\n");
83 sb.append("<xml-root-element name=\"relationship-list\" />\n");
84 sb.append("<java-attributes>\n");
85 sb.append("<xml-element container-type=\"java.util.ArrayList\" java-attribute=\"relationship\" name=\"relationship\" type=\"inventory.aai.onap.org.v11.Relationship\" />/n");
86 sb.append("</java-attributes>\n");
87 sb.append("</java-type>\n");
90 private void addRelationship(StringBuilder sb ) {
91 sb.append("<java-type name=\"Relationship\">\n");
92 sb.append("<xml-root-element name=\"relationship\" />\n");
93 sb.append("<java-attributes>\n");
94 sb.append("<xml-element java-attribute=\"relatedTo\" name=\"related-to\" type=\"java.lang.String\">\n");
95 sb.append("<xml-properties>\n");
96 sb.append("<xml-property name=\"description\" value=\"A keyword provided by A&AI to indicate type of node.\" />\n");
97 sb.append("</xml-properties>\n");
98 sb.append("</xml-element>\n");
99 sb.append("<xml-element java-attribute=\"relatedLink\" name=\"related-link\" type=\"java.lang.String\">\n");
100 sb.append("<xml-properties>\n");
101 sb.append("<xml-property name=\"description\" value=\"URL to the object in A&AI.\" />");
102 sb.append("</xml-properties>\n");
103 sb.append("</xml-element>\n");
104 sb.append("<xml-element container-type=\"java.util.ArrayList\" java-attribute=\"relationshipData\" name=\"relationship-data\" type=\"inventory.aai.onap.org.v11.RelationshipData\" />\n");
105 sb.append("<xml-element container-type=\"java.util.ArrayList\" java-attribute=\"relatedToProperty\" name=\"related-to-property\" type=\"inventory.aai.onap.org.v11.RelatedToProperty\" />\n");
106 sb.append("</java-attributes>\n");
107 sb.append("</java-type>\n");
110 private void addRelatedToProperty(StringBuilder sb) {
111 sb.append("<java-type name=\"RelatedToProperty\">\n");
112 sb.append("<xml-root-element name=\"related-to-property\" />\n");
113 sb.append("<java-attributes>\n");
114 sb.append("<xml-element java-attribute=\"propertyKey\" name=\"property-key\" type=\"java.lang.String\">\n");
115 sb.append("<xml-properties>\n");
116 sb.append("<xml-property name=\"description\" value=\"Key part of a key/value pair\" />\n");
117 sb.append("</xml-properties>\n");
118 sb.append("</xml-element>\n");
119 sb.append("<xml-element java-attribute=\"propertyValue\" name=\"property-value\" type=\"java.lang.String\">\n");
120 sb.append("<xml-properties>\n");
121 sb.append("<xml-property name=\"description\" value=\"Value part of a key/value pair\" />\n");
122 sb.append("</xml-properties>\n");
123 sb.append("</xml-element>\n");
124 sb.append("</java-attributes>\n");
125 sb.append("</java-type>\n");
128 private void addRelationshipData(StringBuilder sb){
129 sb.append("<java-type name=\"RelationshipData\">\n");
130 sb.append("<xml-root-element name=\"relationship-data\" />\n");
131 sb.append("<java-attributes>\n");
132 sb.append("<xml-element java-attribute=\"relationshipKey\" name=\"relationship-key\" required=\"true\" type=\"java.lang.String\">\n");
133 sb.append("<xml-properties>\n");
134 sb.append("<xml-property name=\"description\" value=\"A keyword provided by A&AI to indicate an attribute.\" />\n");
135 sb.append("</xml-properties>\n");
136 sb.append("</xml-element>\n");
137 sb.append("<xml-element java-attribute=\"relationshipValue\" name=\"relationship-value\" required=\"true\" type=\"java.lang.String\">\n");
138 sb.append("<xml-properties>\n");
139 sb.append("<xml-property name=\"description\" value=\"Value of the attribute.\" />\n");
140 sb.append("</xml-properties>\n");
141 sb.append("</xml-element>\n");
142 sb.append("</java-attributes>\n");
143 sb.append("</java-type>\n");
146 private void addBusiness(StringBuilder sb){
147 sb.append("<java-type name=\"Business\">\n");
148 sb.append("<xml-properties>\n");
149 sb.append("<xml-property name=\"description\" value=\"Namespace for business related constructs\" />\n");
150 sb.append("</xml-properties>\n");
151 sb.append("<xml-root-element name=\"business\" />\n");
152 sb.append("<java-attributes>\n");
153 sb.append("<xml-element java-attribute=\"customers\" name=\"customers\" type=\"inventory.aai.onap.org.v11.Customers\" />\n");
154 sb.append("</java-attributes>\n");
155 sb.append("</java-type>\n");
158 private void addCustomers(StringBuilder sb){
159 sb.append("<java-type name=\"Customers\">\n");
160 sb.append("<xml-properties>\n");
161 sb.append("<xml-property name=\"description\" value=\"Collection of customer identifiers to provide linkage back to BSS information.\" />\n");
162 sb.append("</xml-properties>\n");
163 sb.append("<xml-root-element name=\"customers\" />\n");
164 sb.append("<java-attributes>\n");
165 sb.append("<xml-element container-type=\"java.util.ArrayList\" java-attribute=\"customer\" name=\"customer\" type=\"inventory.aai.onap.org.v11.Customer\" />\n");
166 sb.append("</java-attributes>\n");
167 sb.append("<xml-properties>\n");
168 sb.append("<xml-property name=\"maximumDepth\" value=\"0\" />\n");
169 sb.append("</xml-properties>\n");
170 sb.append("</java-type>\n");
173 private void addCustomer(StringBuilder sb){
174 sb.append("<java-type name=\"Customer\">\n");
175 sb.append("<xml-root-element name=\"customer\" />\n");
176 sb.append("<java-attributes>\n");
177 sb.append("<xml-element java-attribute=\"globalCustomerId\" name=\"global-customer-id\" required=\"true\" type=\"java.lang.String\" xml-key=\"true\">\n");
178 sb.append("<xml-properties>\n");
179 sb.append("<xml-property name=\"description\" value=\"Global customer id used across ECOMP to uniquely identify customer.\" />\n");
180 sb.append("</xml-properties>\n");
181 sb.append("</xml-element>\n");
182 sb.append("<xml-element java-attribute=\"subscriberName\" name=\"subscriber-name\" required=\"true\" type=\"java.lang.String\">\n");
183 sb.append("<xml-properties>\n");
184 sb.append("<xml-property name=\"description\" value=\"Subscriber name, an alternate way to retrieve a customer.\" />\n");
185 sb.append("</xml-properties>\n");
186 sb.append("</xml-element>\n");
187 sb.append("<xml-element java-attribute=\"subscriberType\" name=\"subscriber-type\" required=\"true\" type=\"java.lang.String\">\n");
188 sb.append("<xml-properties>\n");
189 sb.append("<xml-property name=\"description\" value=\"Subscriber type, a way to provide VID with only the INFRA customers.\" />\n");
190 sb.append("<xml-property name=\"defaultValue\" value=\"CUST\" />\n");
191 sb.append("</xml-properties>\n");
192 sb.append("</xml-element>\n");
193 sb.append("<xml-element java-attribute=\"resourceVersion\" name=\"resource-version\" type=\"java.lang.String\">\n");
194 sb.append("<xml-properties>\n");
195 sb.append("<xml-property name=\"description\" value=\"Used for optimistic concurrency. Must be empty on create, valid on update and delete.\" />\n");
196 sb.append("</xml-properties>\n");
197 sb.append("</xml-element>\n");
198 sb.append("<xml-element java-attribute=\"serviceSubscriptions\" name=\"service-subscriptions\" type=\"inventory.aai.onap.org.v11.ServiceSubscriptions\" />\n");
199 sb.append("<xml-element java-attribute=\"relationshipList\" name=\"relationship-list\" type=\"inventory.aai.onap.org.v11.RelationshipList\" />\n");
200 sb.append("</java-attributes>\n");
201 sb.append("<xml-properties>\n");
202 sb.append("<xml-property name=\"description\" value=\"customer identifiers to provide linkage back to BSS information.\" />\n");
203 sb.append("<xml-property name=\"nameProps\" value=\"subscriber-name\" />\n");
204 sb.append("<xml-property name=\"indexedProps\" value=\"subscriber-name,global-customer-id,subscriber-type\" />\n");
205 sb.append("<xml-property name=\"searchable\" value=\"global-customer-id,subscriber-name\" />\n");
206 sb.append("<xml-property name=\"uniqueProps\" value=\"global-customer-id\" />\n");
207 sb.append("<xml-property name=\"container\" value=\"customers\" />\n");
208 sb.append("<xml-property name=\"namespace\" value=\"business\" />\n");
209 sb.append("</xml-properties>\n");
210 sb.append("</java-type>\n");
213 private void addServiceSubscriptions(StringBuilder sb){
214 sb.append("<java-type name=\"ServiceSubscriptions\">\n");
215 sb.append("<xml-properties>\n");
216 sb.append("<xml-property name=\"description\" value=\"Collection of objects that group service instances.\" />\n");
217 sb.append("</xml-properties>\n");
218 sb.append("<xml-root-element name=\"service-subscriptions\" />\n");
219 sb.append("<java-attributes>\n");
220 sb.append("<xml-element container-type=\"java.util.ArrayList\" java-attribute=\"serviceSubscription\" name=\"service-subscription\" type=\"inventory.aai.onap.org.v11.ServiceSubscription\" />\n");
221 sb.append("</java-attributes>\n");
222 sb.append("</java-type>\n");
224 private void addServiceSubscription(StringBuilder sb){
225 sb.append("<java-type name=\"ServiceSubscription\">\n");
226 sb.append("<xml-root-element name=\"service-subscription\" />\n");
227 sb.append("<java-attributes>\n");
228 sb.append("<xml-element java-attribute=\"serviceType\" name=\"service-type\" required=\"true\" type=\"java.lang.String\" xml-key=\"true\">\n");
229 sb.append("<xml-properties>\n");
230 sb.append("<xml-property name=\"description\" value=\"Value defined by orchestration to identify this service across ECOMP.\" />\n");
231 sb.append("</xml-properties>\n");
232 sb.append("</xml-element>\n");
233 sb.append("<xml-element java-attribute=\"tempUbSubAccountId\" name=\"temp-ub-sub-account-id\" type=\"java.lang.String\">\n");
234 sb.append("<xml-properties>\n");
235 sb.append("<xml-property name=\"description\" value=\"This property will be deleted from A&AI in the near future. Only stop gap solution.\" />\n");
236 sb.append("</xml-properties>\n");
237 sb.append("</xml-element>\n");
238 sb.append("<xml-element java-attribute=\"resourceVersion\" name=\"resource-version\" type=\"java.lang.String\">\n");
239 sb.append("<xml-properties>\n");
240 sb.append("<xml-property name=\"description\" value=\"Used for optimistic concurrency. Must be empty on create, valid on update and delete.\" />\n");
241 sb.append("</xml-properties>\n");
242 sb.append("</xml-element>\n");
243 sb.append("<xml-element java-attribute=\"relationshipList\" name=\"relationship-list\" type=\"inventory.aai.onap.org.v11.RelationshipList\" />\n");
244 sb.append("</java-attributes>\n");
245 sb.append("<xml-properties>\n");
246 sb.append("<xml-property name=\"description\" value=\"Object that group service instances.\" />\n");
247 sb.append("<xml-property name=\"indexedProps\" value=\"service-type\" />\n");
248 sb.append("<xml-property name=\"dependentOn\" value=\"customer\" />\n");
249 sb.append("<xml-property name=\"container\" value=\"service-subscriptions\" />\n");
250 sb.append("<xml-property name=\"crossEntityReference\" value=\"service-instance,service-type\" />\n");
251 sb.append("</xml-properties>\n");
252 sb.append("</java-type>\n");
255 private void addEndOfXML(StringBuilder sb){
256 sb.append("</java-types>\n");
257 sb.append("</xml-bindings>\n");
262 public void test_processOxmFile() {
265 GenerateXsd generateXsd = new GenerateXsd();
267 //GenerateXsd generateXsdSpy = PowerMockito.spy(generateXsd);
269 //generateXsdSpy.processOxmFile(null, Version.getLatest(), testXML);
271 String xsdResult = generateXsd.processOxmFile(null, Version.getLatest(), testXML);
273 String relationshipListExpected = " <xs:element name=\"relationship-list\">\n <xs:complexType>\n <xs:sequence>\n <xs:element ref=\"tns:relationship\" minOccurs=\"0\" maxOccurs=\"unbounded\"/>\n </xs:sequence>\n </xs:complexType>\n </xs:element>";
274 String relatedToPropertyExpected = " <xs:element name=\"related-to-property\">\n <xs:complexType>\n <xs:sequence>\n <xs:element name=\"property-key\" type=\"xs:string\" minOccurs=\"0\">\n <xs:annotation>\r\n <xs:appinfo>\r\n <annox:annotate target=\"field\">@org.onap.aai.annotations.Metadata(description=\"Key part of a key/value pair\")</annox:annotate>\r\n </xs:appinfo>\r\n </xs:annotation>\r\n </xs:element>\n"
275 + " <xs:element name=\"property-value\" type=\"xs:string\" minOccurs=\"0\">\n <xs:annotation>\r\n <xs:appinfo>\r\n <annox:annotate target=\"field\">@org.onap.aai.annotations.Metadata(description=\"Value part of a key/value pair\")</annox:annotate>\r\n </xs:appinfo>\r\n </xs:annotation>\r\n </xs:element>\n </xs:sequence>\n </xs:complexType>\n </xs:element>";
276 assertNotNull(xsdResult);
279 public void test_generateSwaggerFromOxmFile( ) {
282 GenerateXsd generateXsd = new GenerateXsd();
284 String customerOperation = " /business/customers/customer/{global-customer-id}:\n get:\n tags:\n - Business\n summary: returns customer";
285 String relationshipListDefinition = " relationship-list:\n properties:\n relationship:\n type: array\n items: \n $ref: \"#/definitions/relationship\"";
286 String swaggerResult = generateXsd.generateSwaggerFromOxmFile(null, testXML);
287 assertNotNull(swaggerResult);