Bug 3800 - Fix usage of global SimpleDateFormat
[controller.git] / opendaylight / md-sal / sal-rest-docgen / src / main / java / org / opendaylight / controller / sal / rest / doc / impl / BaseYangSwaggerGenerator.java
1 /*
2  * Copyright (c) 2014 Brocade Communications Systems, Inc. and others.  All rights reserved.
3  *
4  * This program and the accompanying materials are made available under the
5  * terms of the Eclipse Public License v1.0 which accompanies this distribution,
6  * and is available at http://www.eclipse.org/legal/epl-v10.html
7  */
8 package org.opendaylight.controller.sal.rest.doc.impl;
9
10 import static org.opendaylight.controller.sal.rest.doc.util.RestDocgenUtil.resolvePathArgumentsName;
11 import com.fasterxml.jackson.databind.ObjectMapper;
12 import com.fasterxml.jackson.databind.SerializationFeature;
13 import com.fasterxml.jackson.datatype.jsonorg.JsonOrgModule;
14 import com.google.common.base.Preconditions;
15 import java.io.IOException;
16 import java.net.URI;
17 import java.text.ParseException;
18 import java.util.ArrayList;
19 import java.util.Arrays;
20 import java.util.Calendar;
21 import java.util.Collection;
22 import java.util.Collections;
23 import java.util.Comparator;
24 import java.util.Date;
25 import java.util.GregorianCalendar;
26 import java.util.List;
27 import java.util.Set;
28 import java.util.SortedSet;
29 import java.util.TreeSet;
30 import javax.ws.rs.core.UriInfo;
31 import org.json.JSONException;
32 import org.json.JSONObject;
33 import org.opendaylight.controller.sal.rest.doc.model.builder.OperationBuilder;
34 import org.opendaylight.controller.sal.rest.doc.swagger.Api;
35 import org.opendaylight.controller.sal.rest.doc.swagger.ApiDeclaration;
36 import org.opendaylight.controller.sal.rest.doc.swagger.Operation;
37 import org.opendaylight.controller.sal.rest.doc.swagger.Parameter;
38 import org.opendaylight.controller.sal.rest.doc.swagger.Resource;
39 import org.opendaylight.controller.sal.rest.doc.swagger.ResourceList;
40 import org.opendaylight.yangtools.yang.common.QName;
41 import org.opendaylight.yangtools.yang.common.SimpleDateFormatUtil;
42 import org.opendaylight.yangtools.yang.model.api.ContainerSchemaNode;
43 import org.opendaylight.yangtools.yang.model.api.DataNodeContainer;
44 import org.opendaylight.yangtools.yang.model.api.DataSchemaNode;
45 import org.opendaylight.yangtools.yang.model.api.LeafSchemaNode;
46 import org.opendaylight.yangtools.yang.model.api.ListSchemaNode;
47 import org.opendaylight.yangtools.yang.model.api.Module;
48 import org.opendaylight.yangtools.yang.model.api.RpcDefinition;
49 import org.opendaylight.yangtools.yang.model.api.SchemaContext;
50 import org.slf4j.Logger;
51 import org.slf4j.LoggerFactory;
52
53 public class BaseYangSwaggerGenerator {
54
55     private static final Logger LOG = LoggerFactory.getLogger(BaseYangSwaggerGenerator.class);
56
57     protected static final String API_VERSION = "1.0.0";
58     protected static final String SWAGGER_VERSION = "1.2";
59     protected static final String RESTCONF_CONTEXT_ROOT = "restconf";
60
61     static final String MODULE_NAME_SUFFIX = "_module";
62     private final ModelGenerator jsonConverter = new ModelGenerator();
63
64     // private Map<String, ApiDeclaration> MODULE_DOC_CACHE = new HashMap<>()
65     private final ObjectMapper mapper = new ObjectMapper();
66
67     protected BaseYangSwaggerGenerator() {
68         mapper.registerModule(new JsonOrgModule());
69         mapper.configure(SerializationFeature.INDENT_OUTPUT, true);
70     }
71
72     /**
73      *
74      * @param uriInfo
75      * @param operType
76      * @return list of modules converted to swagger compliant resource list.
77      */
78     public ResourceList getResourceListing(final UriInfo uriInfo, final SchemaContext schemaContext, final String context) {
79
80         final ResourceList resourceList = createResourceList();
81
82         final Set<Module> modules = getSortedModules(schemaContext);
83
84         final List<Resource> resources = new ArrayList<>(modules.size());
85
86         LOG.info("Modules found [{}]", modules.size());
87
88         for (final Module module : modules) {
89             final String revisionString = SimpleDateFormatUtil.getRevisionFormat().format(module.getRevision());
90             final Resource resource = new Resource();
91             LOG.debug("Working on [{},{}]...", module.getName(), revisionString);
92             final ApiDeclaration doc = getApiDeclaration(module.getName(), revisionString, uriInfo, schemaContext, context);
93
94             if (doc != null) {
95                 resource.setPath(generatePath(uriInfo, module.getName(), revisionString));
96                 resources.add(resource);
97             } else {
98                 LOG.debug("Could not generate doc for {},{}", module.getName(), revisionString);
99             }
100         }
101
102         resourceList.setApis(resources);
103
104         return resourceList;
105     }
106
107     protected ResourceList createResourceList() {
108         final ResourceList resourceList = new ResourceList();
109         resourceList.setApiVersion(API_VERSION);
110         resourceList.setSwaggerVersion(SWAGGER_VERSION);
111         return resourceList;
112     }
113
114     protected String generatePath(final UriInfo uriInfo, final String name, final String revision) {
115         final URI uri = uriInfo.getRequestUriBuilder().path(generateCacheKey(name, revision)).build();
116         return uri.toASCIIString();
117     }
118
119     public ApiDeclaration getApiDeclaration(final String module, final String revision, final UriInfo uriInfo, final SchemaContext schemaContext, final String context) {
120         Date rev = null;
121
122         try {
123             if(revision != null && !revision.equals("0000-00-00")) {
124                 rev = SimpleDateFormatUtil.getRevisionFormat().parse(revision);
125             }
126         } catch (final ParseException e) {
127             throw new IllegalArgumentException(e);
128         }
129
130         if(rev != null) {
131             final Calendar cal = new GregorianCalendar();
132
133             cal.setTime(rev);
134
135             if(cal.get(Calendar.YEAR) < 1970) {
136                 rev = null;
137             }
138         }
139
140         final Module m = schemaContext.findModuleByName(module, rev);
141         Preconditions.checkArgument(m != null, "Could not find module by name,revision: " + module + "," + revision);
142
143         return getApiDeclaration(m, rev, uriInfo, context, schemaContext);
144     }
145
146     public ApiDeclaration getApiDeclaration(final Module module, final Date revision, final UriInfo uriInfo, final String context, final SchemaContext schemaContext) {
147         final String basePath = createBasePathFromUriInfo(uriInfo);
148
149         final ApiDeclaration doc = getSwaggerDocSpec(module, basePath, context, schemaContext);
150         if (doc != null) {
151             return doc;
152         }
153         return null;
154     }
155
156     protected String createBasePathFromUriInfo(final UriInfo uriInfo) {
157         String portPart = "";
158         final int port = uriInfo.getBaseUri().getPort();
159         if (port != -1) {
160             portPart = ":" + port;
161         }
162         final String basePath = new StringBuilder(uriInfo.getBaseUri().getScheme()).append("://")
163                 .append(uriInfo.getBaseUri().getHost()).append(portPart).append("/").append(RESTCONF_CONTEXT_ROOT)
164                 .toString();
165         return basePath;
166     }
167
168     public ApiDeclaration getSwaggerDocSpec(final Module m, final String basePath, final String context, final SchemaContext schemaContext) {
169         final ApiDeclaration doc = createApiDeclaration(basePath);
170
171         final List<Api> apis = new ArrayList<Api>();
172
173         final Collection<DataSchemaNode> dataSchemaNodes = m.getChildNodes();
174         LOG.debug("child nodes size [{}]", dataSchemaNodes.size());
175         for (final DataSchemaNode node : dataSchemaNodes) {
176             if ((node instanceof ListSchemaNode) || (node instanceof ContainerSchemaNode)) {
177
178                 LOG.debug("Is Configuration node [{}] [{}]", node.isConfiguration(), node.getQName().getLocalName());
179
180                 List<Parameter> pathParams = new ArrayList<Parameter>();
181                 String resourcePath = getDataStorePath("/config/", context);
182                 addRootPostLink(m, (DataNodeContainer) node, pathParams, resourcePath, apis);
183                 addApis(node, apis, resourcePath, pathParams, schemaContext, true);
184
185                 pathParams = new ArrayList<Parameter>();
186                 resourcePath = getDataStorePath("/operational/", context);
187                 addApis(node, apis, resourcePath, pathParams, schemaContext, false);
188             }
189         }
190
191         final Set<RpcDefinition> rpcs = m.getRpcs();
192         for (final RpcDefinition rpcDefinition : rpcs) {
193             final String resourcePath = getDataStorePath("/operations/", context);
194             addRpcs(rpcDefinition, apis, resourcePath, schemaContext);
195         }
196
197         LOG.debug("Number of APIs found [{}]", apis.size());
198
199         if (!apis.isEmpty()) {
200             doc.setApis(apis);
201             JSONObject models = null;
202
203             try {
204                 models = jsonConverter.convertToJsonSchema(m, schemaContext);
205                 doc.setModels(models);
206                 if (LOG.isDebugEnabled()) {
207                     LOG.debug(mapper.writeValueAsString(doc));
208                 }
209             } catch (IOException | JSONException e) {
210                 e.printStackTrace();
211             }
212
213             return doc;
214         }
215         return null;
216     }
217
218     private void addRootPostLink(final Module m, final DataNodeContainer node, final List<Parameter> pathParams,
219             final String resourcePath, final List<Api> apis) {
220         if (containsListOrContainer(m.getChildNodes())) {
221             final Api apiForRootPostUri = new Api();
222             apiForRootPostUri.setPath(resourcePath);
223             apiForRootPostUri.setOperations(operationPost(m.getName()+MODULE_NAME_SUFFIX, m.getDescription(), m, pathParams, true));
224             apis.add(apiForRootPostUri);
225         }
226     }
227
228     protected ApiDeclaration createApiDeclaration(final String basePath) {
229         final ApiDeclaration doc = new ApiDeclaration();
230         doc.setApiVersion(API_VERSION);
231         doc.setSwaggerVersion(SWAGGER_VERSION);
232         doc.setBasePath(basePath);
233         doc.setProduces(Arrays.asList("application/json", "application/xml"));
234         return doc;
235     }
236
237     protected String getDataStorePath(final String dataStore, final String context) {
238         return dataStore + context;
239     }
240
241     private String generateCacheKey(final Module m) {
242         return generateCacheKey(m.getName(), SimpleDateFormatUtil.getRevisionFormat().format(m.getRevision()));
243     }
244
245     private String generateCacheKey(final String module, final String revision) {
246         return module + "(" + revision + ")";
247     }
248
249     private void addApis(final DataSchemaNode node, final List<Api> apis, final String parentPath, final List<Parameter> parentPathParams, final SchemaContext schemaContext,
250             final boolean addConfigApi) {
251
252         final Api api = new Api();
253         final List<Parameter> pathParams = new ArrayList<Parameter>(parentPathParams);
254
255         final String resourcePath = parentPath + createPath(node, pathParams, schemaContext) + "/";
256         LOG.debug("Adding path: [{}]", resourcePath);
257         api.setPath(resourcePath);
258
259         Iterable<DataSchemaNode> childSchemaNodes = Collections.<DataSchemaNode> emptySet();
260         if ((node instanceof ListSchemaNode) || (node instanceof ContainerSchemaNode)) {
261             final DataNodeContainer dataNodeContainer = (DataNodeContainer) node;
262             childSchemaNodes = dataNodeContainer.getChildNodes();
263         }
264         api.setOperations(operation(node, pathParams, addConfigApi, childSchemaNodes));
265         apis.add(api);
266
267         for (final DataSchemaNode childNode : childSchemaNodes) {
268             if (childNode instanceof ListSchemaNode || childNode instanceof ContainerSchemaNode) {
269                 // keep config and operation attributes separate.
270                 if (childNode.isConfiguration() == addConfigApi) {
271                     addApis(childNode, apis, resourcePath, pathParams, schemaContext, addConfigApi);
272                 }
273             }
274         }
275
276     }
277
278     private boolean containsListOrContainer(final Iterable<DataSchemaNode> nodes) {
279         for (final DataSchemaNode child : nodes) {
280             if (child instanceof ListSchemaNode || child instanceof ContainerSchemaNode) {
281                 return true;
282             }
283         }
284         return false;
285     }
286
287     /**
288      * @param node
289      * @param pathParams
290      * @return
291      */
292     private List<Operation> operation(final DataSchemaNode node, final List<Parameter> pathParams, final boolean isConfig, final Iterable<DataSchemaNode> childSchemaNodes) {
293         final List<Operation> operations = new ArrayList<>();
294
295         final OperationBuilder.Get getBuilder = new OperationBuilder.Get(node, isConfig);
296         operations.add(getBuilder.pathParams(pathParams).build());
297
298         if (isConfig) {
299             final OperationBuilder.Put putBuilder = new OperationBuilder.Put(node.getQName().getLocalName(),
300                     node.getDescription());
301             operations.add(putBuilder.pathParams(pathParams).build());
302
303             final OperationBuilder.Delete deleteBuilder = new OperationBuilder.Delete(node);
304             operations.add(deleteBuilder.pathParams(pathParams).build());
305
306             if (containsListOrContainer(childSchemaNodes)) {
307                 operations.addAll(operationPost(node.getQName().getLocalName(), node.getDescription(), (DataNodeContainer) node,
308                         pathParams, isConfig));
309             }
310         }
311         return operations;
312     }
313
314     /**
315      * @param node
316      * @param pathParams
317      * @return
318      */
319     private List<Operation> operationPost(final String name, final String description, final DataNodeContainer dataNodeContainer, final List<Parameter> pathParams, final boolean isConfig) {
320         final List<Operation> operations = new ArrayList<>();
321         if (isConfig) {
322             final OperationBuilder.Post postBuilder = new OperationBuilder.Post(name, description, dataNodeContainer);
323             operations.add(postBuilder.pathParams(pathParams).build());
324         }
325         return operations;
326     }
327
328     private String createPath(final DataSchemaNode schemaNode, final List<Parameter> pathParams, final SchemaContext schemaContext) {
329         final ArrayList<LeafSchemaNode> pathListParams = new ArrayList<LeafSchemaNode>();
330         final StringBuilder path = new StringBuilder();
331         final String localName = resolvePathArgumentsName(schemaNode, schemaContext);
332         path.append(localName);
333
334         if ((schemaNode instanceof ListSchemaNode)) {
335             final List<QName> listKeys = ((ListSchemaNode) schemaNode).getKeyDefinition();
336             for (final QName listKey : listKeys) {
337                 final DataSchemaNode _dataChildByName = ((DataNodeContainer) schemaNode).getDataChildByName(listKey);
338                 pathListParams.add(((LeafSchemaNode) _dataChildByName));
339
340                 final String pathParamIdentifier = new StringBuilder("/{").append(listKey.getLocalName()).append("}")
341                         .toString();
342                 path.append(pathParamIdentifier);
343
344                 final Parameter pathParam = new Parameter();
345                 pathParam.setName(listKey.getLocalName());
346                 pathParam.setDescription(_dataChildByName.getDescription());
347                 pathParam.setType("string");
348                 pathParam.setParamType("path");
349
350                 pathParams.add(pathParam);
351             }
352         }
353         return path.toString();
354     }
355
356     protected void addRpcs(final RpcDefinition rpcDefn, final List<Api> apis, final String parentPath, final SchemaContext schemaContext) {
357         final Api rpc = new Api();
358         final String resourcePath = parentPath + resolvePathArgumentsName(rpcDefn, schemaContext);
359         rpc.setPath(resourcePath);
360
361         final Operation operationSpec = new Operation();
362         operationSpec.setMethod("POST");
363         operationSpec.setNotes(rpcDefn.getDescription());
364         operationSpec.setNickname(rpcDefn.getQName().getLocalName());
365         if (rpcDefn.getOutput() != null) {
366             operationSpec.setType("(" + rpcDefn.getQName().getLocalName() + ")output");
367         }
368         if (rpcDefn.getInput() != null) {
369             final Parameter payload = new Parameter();
370             payload.setParamType("body");
371             payload.setType("(" + rpcDefn.getQName().getLocalName() + ")input");
372             operationSpec.setParameters(Collections.singletonList(payload));
373         }
374
375         rpc.setOperations(Arrays.asList(operationSpec));
376
377         apis.add(rpc);
378     }
379
380     protected SortedSet<Module> getSortedModules(final SchemaContext schemaContext) {
381         if (schemaContext == null) {
382             return new TreeSet<>();
383         }
384
385         final Set<Module> modules = schemaContext.getModules();
386
387         final SortedSet<Module> sortedModules = new TreeSet<>(new Comparator<Module>() {
388             @Override
389             public int compare(final Module o1, final Module o2) {
390                 int result = o1.getName().compareTo(o2.getName());
391                 if (result == 0) {
392                     result = o1.getRevision().compareTo(o2.getRevision());
393                 }
394                 if (result == 0) {
395                     result = o1.getNamespace().compareTo(o2.getNamespace());
396                 }
397                 return result;
398             }
399         });
400         for (final Module m : modules) {
401             if (m != null) {
402                 sortedModules.add(m);
403             }
404         }
405         return sortedModules;
406     }
407
408 }