restconf/sal-rest-docgen/src/main/java/org/opendaylight/netconf/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.netconf.sal.rest.doc.impl;
   9
  10 import static org.opendaylight.netconf.sal.rest.doc.util.RestDocgenUtil.resolvePathArgumentsName;
  11
  12 import com.fasterxml.jackson.databind.ObjectMapper;
  13 import com.fasterxml.jackson.databind.SerializationFeature;
  14 import com.fasterxml.jackson.databind.node.ObjectNode;
  15 import com.google.common.base.Preconditions;
  16 import java.io.IOException;
  17 import java.net.URI;
  18 import java.text.ParseException;
  19 import java.util.ArrayList;
  20 import java.util.Arrays;
  21 import java.util.Calendar;
  22 import java.util.Collection;
  23 import java.util.Collections;
  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.opendaylight.netconf.sal.rest.doc.model.builder.OperationBuilder;
  32 import org.opendaylight.netconf.sal.rest.doc.model.builder.OperationBuilder.Delete;
  33 import org.opendaylight.netconf.sal.rest.doc.model.builder.OperationBuilder.Get;
  34 import org.opendaylight.netconf.sal.rest.doc.model.builder.OperationBuilder.Post;
  35 import org.opendaylight.netconf.sal.rest.doc.model.builder.OperationBuilder.Put;
  36 import org.opendaylight.netconf.sal.rest.doc.swagger.Api;
  37 import org.opendaylight.netconf.sal.rest.doc.swagger.ApiDeclaration;
  38 import org.opendaylight.netconf.sal.rest.doc.swagger.Operation;
  39 import org.opendaylight.netconf.sal.rest.doc.swagger.Parameter;
  40 import org.opendaylight.netconf.sal.rest.doc.swagger.Resource;
  41 import org.opendaylight.netconf.sal.rest.doc.swagger.ResourceList;
  42 import org.opendaylight.yangtools.yang.common.QName;
  43 import org.opendaylight.yangtools.yang.common.SimpleDateFormatUtil;
  44 import org.opendaylight.yangtools.yang.model.api.ContainerSchemaNode;
  45 import org.opendaylight.yangtools.yang.model.api.DataNodeContainer;
  46 import org.opendaylight.yangtools.yang.model.api.DataSchemaNode;
  47 import org.opendaylight.yangtools.yang.model.api.LeafSchemaNode;
  48 import org.opendaylight.yangtools.yang.model.api.ListSchemaNode;
  49 import org.opendaylight.yangtools.yang.model.api.Module;
  50 import org.opendaylight.yangtools.yang.model.api.RpcDefinition;
  51 import org.opendaylight.yangtools.yang.model.api.SchemaContext;
  52 import org.opendaylight.yangtools.yang.model.repo.api.SourceIdentifier;
  53 import org.slf4j.Logger;
  54 import org.slf4j.LoggerFactory;
  55
  56 public class BaseYangSwaggerGenerator {
  57
  58     private static final Logger LOG = LoggerFactory.getLogger(BaseYangSwaggerGenerator.class);
  59
  60     protected static final String API_VERSION = "1.0.0";
  61     protected static final String SWAGGER_VERSION = "1.2";
  62     protected static final String RESTCONF_CONTEXT_ROOT = "restconf";
  63     private static final String RESTCONF_DRAFT = "18";
  64
  65     static final String MODULE_NAME_SUFFIX = "_module";
  66     private final ModelGenerator jsonConverter = new ModelGenerator();
  67
  68     // private Map<String, ApiDeclaration> MODULE_DOC_CACHE = new HashMap<>()
  69     private final ObjectMapper mapper = new ObjectMapper();
  70     private static boolean newDraft;
  71
  72     protected BaseYangSwaggerGenerator() {
  73         this.mapper.configure(SerializationFeature.INDENT_OUTPUT, true);
  74     }
  75
  76     /**
  77      * Return list of modules converted to swagger compliant resource list.
  78      */
  79     public ResourceList getResourceListing(final UriInfo uriInfo, final SchemaContext schemaContext,
  80             final String context) {
  81
  82         final ResourceList resourceList = createResourceList();
  83
  84         final Set<Module> modules = getSortedModules(schemaContext);
  85
  86         final List<Resource> resources = new ArrayList<>(modules.size());
  87
  88         LOG.info("Modules found [{}]", modules.size());
  89
  90         for (final Module module : modules) {
  91             final String revisionString = module.getQNameModule().getFormattedRevision();
  92             final Resource resource = new Resource();
  93             LOG.debug("Working on [{},{}]...", module.getName(), revisionString);
  94             final ApiDeclaration doc =
  95                     getApiDeclaration(module.getName(), revisionString, uriInfo, schemaContext, context);
  96
  97             if (doc != null) {
  98                 resource.setPath(generatePath(uriInfo, module.getName(), revisionString));
  99                 resources.add(resource);
 100             } else {
 101                 LOG.warn("Could not generate doc for {},{}", module.getName(), revisionString);
 102             }
 103         }
 104
 105         resourceList.setApis(resources);
 106
 107         return resourceList;
 108     }
 109
 110     protected ResourceList createResourceList() {
 111         final ResourceList resourceList = new ResourceList();
 112         resourceList.setApiVersion(API_VERSION);
 113         resourceList.setSwaggerVersion(SWAGGER_VERSION);
 114         return resourceList;
 115     }
 116
 117     protected String generatePath(final UriInfo uriInfo, final String name, final String revision) {
 118         final URI uri = uriInfo.getRequestUriBuilder().path(generateCacheKey(name, revision)).build();
 119         return uri.toASCIIString();
 120     }
 121
 122     public ApiDeclaration getApiDeclaration(final String moduleName, final String revision, final UriInfo uriInfo,
 123             final SchemaContext schemaContext, final String context) {
 124         Date rev = null;
 125
 126         try {
 127             if (revision != null && !SourceIdentifier.NOT_PRESENT_FORMATTED_REVISION.equals(revision)) {
 128                 rev = SimpleDateFormatUtil.getRevisionFormat().parse(revision);
 129             }
 130         } catch (final ParseException e) {
 131             throw new IllegalArgumentException(e);
 132         }
 133
 134         if (rev != null) {
 135             final Calendar cal = new GregorianCalendar();
 136
 137             cal.setTime(rev);
 138
 139             if (cal.get(Calendar.YEAR) < 1970) {
 140                 rev = null;
 141             }
 142         }
 143
 144         final Module module = schemaContext.findModuleByName(moduleName, rev);
 145         Preconditions.checkArgument(module != null,
 146                 "Could not find module by name,revision: " + moduleName + "," + revision);
 147
 148         return getApiDeclaration(module, rev, uriInfo, context, schemaContext);
 149     }
 150
 151     public ApiDeclaration getApiDeclaration(final Module module, final Date revision, final UriInfo uriInfo,
 152             final String context, final SchemaContext schemaContext) {
 153         final String basePath = createBasePathFromUriInfo(uriInfo);
 154
 155         final ApiDeclaration doc = getSwaggerDocSpec(module, basePath, context, schemaContext);
 156         if (doc != null) {
 157             return doc;
 158         }
 159         return null;
 160     }
 161
 162     protected String createBasePathFromUriInfo(final UriInfo uriInfo) {
 163         String portPart = "";
 164         final int port = uriInfo.getBaseUri().getPort();
 165         if (port != -1) {
 166             portPart = ":" + port;
 167         }
 168         final String basePath =
 169                 new StringBuilder(uriInfo.getBaseUri().getScheme()).append("://").append(uriInfo.getBaseUri().getHost())
 170                         .append(portPart).append("/").append(RESTCONF_CONTEXT_ROOT).toString();
 171         return basePath;
 172     }
 173
 174     public ApiDeclaration getSwaggerDocSpec(final Module module, final String basePath, final String context,
 175                                             final SchemaContext schemaContext) {
 176         final ApiDeclaration doc = createApiDeclaration(basePath);
 177
 178         final List<Api> apis = new ArrayList<>();
 179         boolean hasAddRootPostLink = false;
 180
 181         final Collection<DataSchemaNode> dataSchemaNodes = module.getChildNodes();
 182         LOG.debug("child nodes size [{}]", dataSchemaNodes.size());
 183         for (final DataSchemaNode node : dataSchemaNodes) {
 184             if ((node instanceof ListSchemaNode) || (node instanceof ContainerSchemaNode)) {
 185                 LOG.debug("Is Configuration node [{}] [{}]", node.isConfiguration(), node.getQName().getLocalName());
 186
 187                 List<Parameter> pathParams = new ArrayList<>();
 188                 String resourcePath;
 189
 190                 /*
 191                  * Only when the node's config statement is true, such apis as
 192                  * GET/PUT/POST/DELETE config are added for this node.
 193                  */
 194                 if (node.isConfiguration()) { // This node's config statement is
 195                                               // true.
 196                     resourcePath = getDataStorePath("config", context);
 197
 198                     /*
 199                      * When there are two or more top container or list nodes
 200                      * whose config statement is true in module, make sure that
 201                      * only one root post link is added for this module.
 202                      */
 203                     if (!hasAddRootPostLink) {
 204                         LOG.debug("Has added root post link for module {}", module.getName());
 205                         addRootPostLink(module, (DataNodeContainer) node, pathParams, resourcePath, "config", apis);
 206
 207                         hasAddRootPostLink = true;
 208                     }
 209
 210                     addApis(node, apis, resourcePath, pathParams, schemaContext, true, module.getName(), "config");
 211                 }
 212                 pathParams = new ArrayList<>();
 213                 resourcePath = getDataStorePath("operational", context);
 214
 215                 addApis(node, apis, resourcePath, pathParams, schemaContext, false, module.getName(), "operational");
 216             }
 217         }
 218
 219         final Set<RpcDefinition> rpcs = module.getRpcs();
 220         for (final RpcDefinition rpcDefinition : rpcs) {
 221             final String resourcePath;
 222             resourcePath = getDataStorePath("operations", context);
 223
 224             addRpcs(rpcDefinition, apis, resourcePath, schemaContext);
 225         }
 226
 227         LOG.debug("Number of APIs found [{}]", apis.size());
 228
 229         if (!apis.isEmpty()) {
 230             doc.setApis(apis);
 231             ObjectNode models = null;
 232
 233             try {
 234                 models = this.jsonConverter.convertToJsonSchema(module, schemaContext);
 235                 doc.setModels(models);
 236                 if (LOG.isDebugEnabled()) {
 237                     LOG.debug(this.mapper.writeValueAsString(doc));
 238                 }
 239             } catch (IOException e) {
 240                 LOG.error("Exception occured in ModelGenerator", e);
 241             }
 242
 243             return doc;
 244         }
 245         return null;
 246     }
 247
 248     private static void addRootPostLink(final Module module, final DataNodeContainer node,
 249             final List<Parameter> pathParams, final String resourcePath, final String dataStore, final List<Api> apis) {
 250         if (containsListOrContainer(module.getChildNodes())) {
 251             final Api apiForRootPostUri = new Api();
 252             apiForRootPostUri.setPath(resourcePath.concat(getContent(dataStore)));
 253             apiForRootPostUri.setOperations(operationPost(module.getName() + MODULE_NAME_SUFFIX,
 254                     module.getDescription(), module, pathParams, true, ""));
 255             apis.add(apiForRootPostUri);
 256         }
 257     }
 258
 259     protected ApiDeclaration createApiDeclaration(final String basePath) {
 260         final ApiDeclaration doc = new ApiDeclaration();
 261         doc.setApiVersion(API_VERSION);
 262         doc.setSwaggerVersion(SWAGGER_VERSION);
 263         doc.setBasePath(basePath);
 264         doc.setProduces(Arrays.asList("application/json", "application/xml"));
 265         return doc;
 266     }
 267
 268     protected String getDataStorePath(final String dataStore, final String context) {
 269         if (newDraft) {
 270             if ("config".contains(dataStore) || "operational".contains(dataStore)) {
 271                 return "/" + RESTCONF_DRAFT + "/data" + context;
 272             }
 273             return "/" + RESTCONF_DRAFT + "/operations" + context;
 274         }
 275
 276         return "/" + dataStore + context;
 277     }
 278
 279     private static String generateCacheKey(final String module, final String revision) {
 280         return module + "(" + revision + ")";
 281     }
 282
 283     private void addApis(final DataSchemaNode node, final List<Api> apis, final String parentPath,
 284             final List<Parameter> parentPathParams, final SchemaContext schemaContext, final boolean addConfigApi,
 285             final String parentName, final String dataStore) {
 286         final Api api = new Api();
 287         final List<Parameter> pathParams = new ArrayList<>(parentPathParams);
 288
 289         final String resourcePath = parentPath + "/" + createPath(node, pathParams, schemaContext);
 290         LOG.debug("Adding path: [{}]", resourcePath);
 291         api.setPath(resourcePath.concat(getContent(dataStore)));
 292
 293         Iterable<DataSchemaNode> childSchemaNodes = Collections.<DataSchemaNode>emptySet();
 294         if ((node instanceof ListSchemaNode) || (node instanceof ContainerSchemaNode)) {
 295             final DataNodeContainer dataNodeContainer = (DataNodeContainer) node;
 296             childSchemaNodes = dataNodeContainer.getChildNodes();
 297         }
 298         api.setOperations(operation(node, pathParams, addConfigApi, childSchemaNodes, parentName));
 299         apis.add(api);
 300
 301         for (final DataSchemaNode childNode : childSchemaNodes) {
 302             if ((childNode instanceof ListSchemaNode) || (childNode instanceof ContainerSchemaNode)) {
 303                 // keep config and operation attributes separate.
 304                 if (childNode.isConfiguration() == addConfigApi) {
 305                     final String newParent = parentName + "/" + node.getQName().getLocalName();
 306                     addApis(childNode, apis, resourcePath, pathParams, schemaContext, addConfigApi, newParent,
 307                             dataStore);
 308                 }
 309             }
 310         }
 311     }
 312
 313     protected static String getContent(final String dataStore) {
 314         if (newDraft) {
 315             if ("operational".contains(dataStore)) {
 316                 return "?content=nonconfig";
 317             } else if ("config".contains(dataStore)) {
 318                 return "?content=config";
 319             } else {
 320                 return "";
 321             }
 322         } else {
 323             return "";
 324         }
 325     }
 326
 327     private static boolean containsListOrContainer(final Iterable<DataSchemaNode> nodes) {
 328         for (final DataSchemaNode child : nodes) {
 329             if (child instanceof ListSchemaNode || child instanceof ContainerSchemaNode) {
 330                 return true;
 331             }
 332         }
 333         return false;
 334     }
 335
 336     private static List<Operation> operation(final DataSchemaNode node, final List<Parameter> pathParams,
 337             final boolean isConfig, final Iterable<DataSchemaNode> childSchemaNodes, final String parentName) {
 338         final List<Operation> operations = new ArrayList<>();
 339
 340         final Get getBuilder = new Get(node, isConfig);
 341         operations.add(getBuilder.pathParams(pathParams).build());
 342
 343         if (isConfig) {
 344             final Put putBuilder = new Put(node.getQName().getLocalName(), node.getDescription(), parentName);
 345             operations.add(putBuilder.pathParams(pathParams).build());
 346
 347             final Delete deleteBuilder = new Delete(node);
 348             operations.add(deleteBuilder.pathParams(pathParams).build());
 349
 350             if (containsListOrContainer(childSchemaNodes)) {
 351                 operations.addAll(operationPost(node.getQName().getLocalName(), node.getDescription(),
 352                         (DataNodeContainer) node, pathParams, isConfig, parentName + "/"));
 353             }
 354         }
 355         return operations;
 356     }
 357
 358     private static List<Operation> operationPost(final String name, final String description,
 359             final DataNodeContainer dataNodeContainer, final List<Parameter> pathParams, final boolean isConfig,
 360             final String parentName) {
 361         final List<Operation> operations = new ArrayList<>();
 362         if (isConfig) {
 363             final Post postBuilder = new Post(name, parentName + name, description, dataNodeContainer);
 364             operations.add(postBuilder.pathParams(pathParams).build());
 365         }
 366         return operations;
 367     }
 368
 369     private static String createPath(final DataSchemaNode schemaNode, final List<Parameter> pathParams,
 370             final SchemaContext schemaContext) {
 371         final ArrayList<LeafSchemaNode> pathListParams = new ArrayList<>();
 372         final StringBuilder path = new StringBuilder();
 373         final String localName = resolvePathArgumentsName(schemaNode, schemaContext);
 374         path.append(localName);
 375
 376         if ((schemaNode instanceof ListSchemaNode)) {
 377             final List<QName> listKeys = ((ListSchemaNode) schemaNode).getKeyDefinition();
 378             StringBuilder keyBuilder = null;
 379             if (newDraft) {
 380                 keyBuilder = new StringBuilder("=");
 381             }
 382
 383             for (final QName listKey : listKeys) {
 384                 final DataSchemaNode dataChildByName = ((DataNodeContainer) schemaNode).getDataChildByName(listKey);
 385                 pathListParams.add(((LeafSchemaNode) dataChildByName));
 386                 final String pathParamIdentifier;
 387                 if (newDraft) {
 388                     pathParamIdentifier = keyBuilder.append("{").append(listKey.getLocalName()).append("}").toString();
 389                 } else {
 390                     pathParamIdentifier = "/{" + listKey.getLocalName() + "}";
 391                 }
 392                 path.append(pathParamIdentifier);
 393
 394                 final Parameter pathParam = new Parameter();
 395                 pathParam.setName(listKey.getLocalName());
 396                 pathParam.setDescription(dataChildByName.getDescription());
 397                 pathParam.setType("string");
 398                 pathParam.setParamType("path");
 399
 400                 pathParams.add(pathParam);
 401                 if (newDraft) {
 402                     keyBuilder = new StringBuilder(",");
 403                 }
 404             }
 405         }
 406         return path.toString();
 407     }
 408
 409     protected void addRpcs(final RpcDefinition rpcDefn, final List<Api> apis, final String parentPath,
 410             final SchemaContext schemaContext) {
 411         final Api rpc = new Api();
 412         final String resourcePath = parentPath + "/" + resolvePathArgumentsName(rpcDefn, schemaContext);
 413         rpc.setPath(resourcePath);
 414
 415         final Operation operationSpec = new Operation();
 416         operationSpec.setMethod("POST");
 417         operationSpec.setNotes(rpcDefn.getDescription());
 418         operationSpec.setNickname(rpcDefn.getQName().getLocalName());
 419         if (!rpcDefn.getOutput().getChildNodes().isEmpty()) {
 420             operationSpec.setType("(" + rpcDefn.getQName().getLocalName() + ")output" + OperationBuilder.TOP);
 421         }
 422         if (!rpcDefn.getInput().getChildNodes().isEmpty()) {
 423             final Parameter payload = new Parameter();
 424             payload.setParamType("body");
 425             payload.setType("(" + rpcDefn.getQName().getLocalName() + ")input" + OperationBuilder.TOP);
 426             operationSpec.setParameters(Collections.singletonList(payload));
 427             operationSpec.setConsumes(OperationBuilder.CONSUMES_PUT_POST);
 428         }
 429
 430         rpc.setOperations(Arrays.asList(operationSpec));
 431
 432         apis.add(rpc);
 433     }
 434
 435     protected SortedSet<Module> getSortedModules(final SchemaContext schemaContext) {
 436         if (schemaContext == null) {
 437             return new TreeSet<>();
 438         }
 439
 440         final Set<Module> modules = schemaContext.getModules();
 441
 442         final SortedSet<Module> sortedModules = new TreeSet<>((module1, module2) -> {
 443             int result = module1.getName().compareTo(module2.getName());
 444             if (result == 0) {
 445                 final Date module1Revision = module1.getRevision() != null ? module1.getRevision() : new Date(0);
 446                 final Date module2Revision = module2.getRevision() != null ? module2.getRevision() : new Date(0);
 447                 result = module1Revision.compareTo(module2Revision);
 448             }
 449             if (result == 0) {
 450                 result = module1.getNamespace().compareTo(module2.getNamespace());
 451             }
 452             return result;
 453         });
 454         for (final Module m : modules) {
 455             if (m != null) {
 456                 sortedModules.add(m);
 457             }
 458         }
 459         return sortedModules;
 460     }
 461
 462     public void setDraft(final boolean draft) {
 463         BaseYangSwaggerGenerator.newDraft = draft;
 464     }
 465 }