restconf/sal-rest-docgen/src/main/java/org/opendaylight/netconf/sal/rest/doc/impl/ModelGenerator.java

   1 /*
   2  * Copyright (c) 2014 Cisco 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.resolveNodesName;
  11
  12 import com.fasterxml.jackson.databind.JsonNode;
  13 import com.fasterxml.jackson.databind.node.ArrayNode;
  14 import com.fasterxml.jackson.databind.node.JsonNodeFactory;
  15 import com.fasterxml.jackson.databind.node.ObjectNode;
  16 import com.fasterxml.jackson.databind.node.TextNode;
  17 import com.google.common.collect.Range;
  18 import com.google.common.collect.RangeSet;
  19 import com.mifmif.common.regex.Generex;
  20 import java.io.IOException;
  21 import java.util.List;
  22 import java.util.Optional;
  23 import java.util.Set;
  24 import java.util.regex.Pattern;
  25 import org.opendaylight.netconf.sal.rest.doc.model.builder.OperationBuilder;
  26 import org.opendaylight.netconf.sal.rest.doc.model.builder.OperationBuilder.Post;
  27 import org.opendaylight.yangtools.yang.common.QName;
  28 import org.opendaylight.yangtools.yang.model.api.AnyXmlSchemaNode;
  29 import org.opendaylight.yangtools.yang.model.api.ChoiceSchemaNode;
  30 import org.opendaylight.yangtools.yang.model.api.ContainerSchemaNode;
  31 import org.opendaylight.yangtools.yang.model.api.DataNodeContainer;
  32 import org.opendaylight.yangtools.yang.model.api.DataSchemaNode;
  33 import org.opendaylight.yangtools.yang.model.api.ElementCountConstraint;
  34 import org.opendaylight.yangtools.yang.model.api.IdentitySchemaNode;
  35 import org.opendaylight.yangtools.yang.model.api.LeafListSchemaNode;
  36 import org.opendaylight.yangtools.yang.model.api.LeafSchemaNode;
  37 import org.opendaylight.yangtools.yang.model.api.ListSchemaNode;
  38 import org.opendaylight.yangtools.yang.model.api.MandatoryAware;
  39 import org.opendaylight.yangtools.yang.model.api.Module;
  40 import org.opendaylight.yangtools.yang.model.api.RevisionAwareXPath;
  41 import org.opendaylight.yangtools.yang.model.api.RpcDefinition;
  42 import org.opendaylight.yangtools.yang.model.api.SchemaContext;
  43 import org.opendaylight.yangtools.yang.model.api.SchemaNode;
  44 import org.opendaylight.yangtools.yang.model.api.TypeDefinition;
  45 import org.opendaylight.yangtools.yang.model.api.TypedDataSchemaNode;
  46 import org.opendaylight.yangtools.yang.model.api.type.BinaryTypeDefinition;
  47 import org.opendaylight.yangtools.yang.model.api.type.BitsTypeDefinition;
  48 import org.opendaylight.yangtools.yang.model.api.type.BitsTypeDefinition.Bit;
  49 import org.opendaylight.yangtools.yang.model.api.type.BooleanTypeDefinition;
  50 import org.opendaylight.yangtools.yang.model.api.type.EmptyTypeDefinition;
  51 import org.opendaylight.yangtools.yang.model.api.type.EnumTypeDefinition;
  52 import org.opendaylight.yangtools.yang.model.api.type.EnumTypeDefinition.EnumPair;
  53 import org.opendaylight.yangtools.yang.model.api.type.IdentityrefTypeDefinition;
  54 import org.opendaylight.yangtools.yang.model.api.type.LeafrefTypeDefinition;
  55 import org.opendaylight.yangtools.yang.model.api.type.LengthConstraint;
  56 import org.opendaylight.yangtools.yang.model.api.type.PatternConstraint;
  57 import org.opendaylight.yangtools.yang.model.api.type.RangeConstraint;
  58 import org.opendaylight.yangtools.yang.model.api.type.RangeRestrictedTypeDefinition;
  59 import org.opendaylight.yangtools.yang.model.api.type.StringTypeDefinition;
  60 import org.opendaylight.yangtools.yang.model.api.type.UnionTypeDefinition;
  61 import org.opendaylight.yangtools.yang.model.util.RevisionAwareXPathImpl;
  62 import org.opendaylight.yangtools.yang.model.util.SchemaContextUtil;
  63 import org.slf4j.Logger;
  64 import org.slf4j.LoggerFactory;
  65
  66 /**
  67  * Generates JSON Schema for data defined in YANG. This class is not thread-safe.
  68  */
  69 public class ModelGenerator {
  70
  71     private static final Logger LOG = LoggerFactory.getLogger(ModelGenerator.class);
  72
  73     private static final Pattern STRIP_PATTERN = Pattern.compile("\\[[^\\[\\]]*\\]");
  74     private static final String BASE_64 = "base64";
  75     private static final String BINARY_ENCODING_KEY = "binaryEncoding";
  76     private static final String MEDIA_KEY = "media";
  77     private static final String UNIQUE_ITEMS_KEY = "uniqueItems";
  78     private static final String MAX_ITEMS = "maxItems";
  79     private static final String MIN_ITEMS = "minItems";
  80     private static final String SCHEMA_URL = "http://json-schema.org/draft-04/schema";
  81     private static final String SCHEMA_KEY = "$schema";
  82     private static final String MAX_LENGTH_KEY = "maxLength";
  83     private static final String MIN_LENGTH_KEY = "minLength";
  84     private static final String REQUIRED_KEY = "required";
  85     private static final String REF_KEY = "$ref";
  86     private static final String ITEMS_KEY = "items";
  87     private static final String TYPE_KEY = "type";
  88     private static final String PROPERTIES_KEY = "properties";
  89     private static final String DESCRIPTION_KEY = "description";
  90     private static final String OBJECT_TYPE = "object";
  91     private static final String ARRAY_TYPE = "array";
  92     private static final String ENUM = "enum";
  93     private static final String ID_KEY = "id";
  94     private static final String SUB_TYPES_KEY = "subTypes";
  95     private static final String UNIQUE_EMPTY_IDENTIFIER = "unique_empty_identifier";
  96
  97     private Module topLevelModule;
  98
  99     public ModelGenerator() {
 100     }
 101
 102     /**
 103      * Creates Json models from provided module according to swagger spec.
 104      *
 105      * @param module        - Yang module to be converted
 106      * @param schemaContext - SchemaContext of all Yang files used by Api Doc
 107      * @return ObjectNode containing data used for creating examples and models in Api Doc
 108      * @throws IOException if I/O operation fails
 109      */
 110     public ObjectNode convertToJsonSchema(final Module module,
 111                                           final SchemaContext schemaContext) throws IOException {
 112         final ObjectNode models = JsonNodeFactory.instance.objectNode();
 113         final ObjectNode emptyIdentifier = JsonNodeFactory.instance.objectNode();
 114         models.set(UNIQUE_EMPTY_IDENTIFIER, emptyIdentifier);
 115         topLevelModule = module;
 116         processModules(module, models, schemaContext);
 117         processContainersAndLists(module, models, schemaContext);
 118         processRPCs(module, models, schemaContext);
 119         processIdentities(module, models);
 120         return models;
 121     }
 122
 123     private void processModules(final Module module, final ObjectNode models,
 124                                 final SchemaContext schemaContext) {
 125         createConcreteModelForPost(models, module.getName() + BaseYangSwaggerGenerator.MODULE_NAME_SUFFIX,
 126                 createPropertiesForPost(module, schemaContext, module.getName()));
 127     }
 128
 129     private void processContainersAndLists(final Module module, final ObjectNode models,
 130                                            final SchemaContext schemaContext) throws IOException {
 131         final String moduleName = module.getName();
 132
 133         for (final DataSchemaNode childNode : module.getChildNodes()) {
 134             // For every container and list in the module
 135             if (childNode instanceof ContainerSchemaNode || childNode instanceof ListSchemaNode) {
 136                 processDataNodeContainer((DataNodeContainer) childNode, moduleName, models, true, schemaContext);
 137                 processDataNodeContainer((DataNodeContainer) childNode, moduleName, models, false, schemaContext);
 138             }
 139         }
 140     }
 141
 142     /**
 143      * Process the RPCs for a Module Spits out a file each of the name
 144      * {@code <rpcName>-input.json and <rpcName>-output.json}
 145      * for each RPC that contains input & output elements.
 146      *
 147      * @param module module
 148      * @throws IOException if I/O operation fails
 149      */
 150     private void processRPCs(final Module module, final ObjectNode models,
 151                              final SchemaContext schemaContext) throws IOException {
 152         final Set<RpcDefinition> rpcs = module.getRpcs();
 153         final String moduleName = module.getName();
 154         for (final RpcDefinition rpc : rpcs) {
 155             final ContainerSchemaNode input = rpc.getInput();
 156             if (!input.getChildNodes().isEmpty()) {
 157                 final ObjectNode properties =
 158                         processChildren(input.getChildNodes(), moduleName, models, true, schemaContext);
 159
 160                 final String filename = "(" + rpc.getQName().getLocalName() + ")input";
 161                 final ObjectNode childSchema = getSchemaTemplate();
 162                 childSchema.put(TYPE_KEY, OBJECT_TYPE);
 163                 childSchema.set(PROPERTIES_KEY, properties);
 164                 childSchema.put(ID_KEY, filename);
 165                 models.set(filename, childSchema);
 166
 167                 processTopData(filename, models, input);
 168             }
 169
 170             final ContainerSchemaNode output = rpc.getOutput();
 171             if (!output.getChildNodes().isEmpty()) {
 172                 final ObjectNode properties =
 173                         processChildren(output.getChildNodes(), moduleName, models, true, schemaContext);
 174                 final String filename = "(" + rpc.getQName().getLocalName() + ")output";
 175                 final ObjectNode childSchema = getSchemaTemplate();
 176                 childSchema.put(TYPE_KEY, OBJECT_TYPE);
 177                 childSchema.set(PROPERTIES_KEY, properties);
 178                 childSchema.put(ID_KEY, filename);
 179                 models.set(filename, childSchema);
 180
 181                 processTopData(filename, models, output);
 182             }
 183         }
 184     }
 185
 186     private ObjectNode processTopData(final String filename, final ObjectNode models, final SchemaNode schemaNode) {
 187         final ObjectNode items = JsonNodeFactory.instance.objectNode();
 188
 189         items.put(REF_KEY, filename);
 190         final ObjectNode dataNodeProperties = JsonNodeFactory.instance.objectNode();
 191         dataNodeProperties.put(TYPE_KEY, schemaNode instanceof ListSchemaNode ? ARRAY_TYPE : OBJECT_TYPE);
 192         dataNodeProperties.set(ITEMS_KEY, items);
 193
 194         putIfNonNull(dataNodeProperties, DESCRIPTION_KEY, schemaNode.getDescription().orElse(null));
 195         final ObjectNode properties = JsonNodeFactory.instance.objectNode();
 196         properties.set(topLevelModule.getName() + ":" + schemaNode.getQName().getLocalName(), dataNodeProperties);
 197         final ObjectNode finalChildSchema = getSchemaTemplate();
 198         finalChildSchema.put(TYPE_KEY, OBJECT_TYPE);
 199         finalChildSchema.set(PROPERTIES_KEY, properties);
 200         finalChildSchema.put(ID_KEY, filename + OperationBuilder.TOP);
 201         models.set(filename + OperationBuilder.TOP, finalChildSchema);
 202
 203         return dataNodeProperties;
 204     }
 205
 206     /**
 207      * Processes the 'identity' statement in a yang model and maps it to a 'model' in the Swagger JSON spec.
 208      *
 209      * @param module The module from which the identity stmt will be processed
 210      * @param models The ObjectNode in which the parsed identity will be put as a 'model' obj
 211      */
 212     private static void processIdentities(final Module module, final ObjectNode models) {
 213
 214         final String moduleName = module.getName();
 215         final Set<IdentitySchemaNode> idNodes = module.getIdentities();
 216         LOG.debug("Processing Identities for module {} . Found {} identity statements", moduleName, idNodes.size());
 217
 218         for (final IdentitySchemaNode idNode : idNodes) {
 219             final ObjectNode identityObj = JsonNodeFactory.instance.objectNode();
 220             final String identityName = idNode.getQName().getLocalName();
 221             LOG.debug("Processing Identity: {}", identityName);
 222
 223             identityObj.put(ID_KEY, identityName);
 224             putIfNonNull(identityObj, DESCRIPTION_KEY, idNode.getDescription().orElse(null));
 225
 226             final ObjectNode props = JsonNodeFactory.instance.objectNode();
 227
 228             if (idNode.getBaseIdentities().isEmpty()) {
 229                 /*
 230                  * This is a base identity. So lets see if it has sub types. If it does, then add them to the model
 231                  * definition.
 232                  */
 233                 final Set<IdentitySchemaNode> derivedIds = idNode.getDerivedIdentities();
 234
 235                 if (derivedIds != null) {
 236                     final ArrayNode subTypes = new ArrayNode(JsonNodeFactory.instance);
 237                     for (final IdentitySchemaNode derivedId : derivedIds) {
 238                         subTypes.add(derivedId.getQName().getLocalName());
 239                     }
 240                     identityObj.set(SUB_TYPES_KEY, subTypes);
 241
 242                 }
 243             } else {
 244                 /*
 245                  * This is a derived entity. Add it's base type & move on.
 246                  */
 247                 props.put(TYPE_KEY, idNode.getBaseIdentities().iterator().next().getQName().getLocalName());
 248             }
 249
 250             // Add the properties. For a base type, this will be an empty object as required by the Swagger spec.
 251             identityObj.set(PROPERTIES_KEY, props);
 252             models.set(identityName, identityObj);
 253         }
 254     }
 255
 256     private ObjectNode processDataNodeContainer(
 257             final DataNodeContainer dataNode, final String parentName, final ObjectNode models, final boolean isConfig,
 258             final SchemaContext schemaContext) throws IOException {
 259         if (dataNode instanceof ListSchemaNode || dataNode instanceof ContainerSchemaNode) {
 260             final Iterable<DataSchemaNode> containerChildren = dataNode.getChildNodes();
 261             final String localName = ((SchemaNode) dataNode).getQName().getLocalName();
 262             final ObjectNode properties =
 263                     processChildren(containerChildren, parentName + "/" + localName, models, isConfig, schemaContext);
 264             final String nodeName = parentName + (isConfig ? OperationBuilder.CONFIG : OperationBuilder.OPERATIONAL)
 265                     + localName;
 266
 267             final ObjectNode childSchema = getSchemaTemplate();
 268             childSchema.put(TYPE_KEY, OBJECT_TYPE);
 269             childSchema.set(PROPERTIES_KEY, properties);
 270
 271             childSchema.put(ID_KEY, nodeName);
 272             models.set(nodeName, childSchema);
 273
 274             if (isConfig) {
 275                 createConcreteModelForPost(models, localName,
 276                         createPropertiesForPost(dataNode, schemaContext, parentName + "/" + localName));
 277             }
 278
 279             return processTopData(nodeName, models, (SchemaNode) dataNode);
 280         }
 281         return null;
 282     }
 283
 284     private static void createConcreteModelForPost(final ObjectNode models, final String localName,
 285                                                    final JsonNode properties) {
 286         final String nodePostName = OperationBuilder.CONFIG + localName + Post.METHOD_NAME;
 287         final ObjectNode postSchema = getSchemaTemplate();
 288         postSchema.put(TYPE_KEY, OBJECT_TYPE);
 289         postSchema.put(ID_KEY, nodePostName);
 290         postSchema.set(PROPERTIES_KEY, properties);
 291         models.set(nodePostName, postSchema);
 292     }
 293
 294     private JsonNode createPropertiesForPost(final DataNodeContainer dataNodeContainer,
 295                                                final SchemaContext schemaContext, final String parentName) {
 296         final ObjectNode properties = JsonNodeFactory.instance.objectNode();
 297         for (final DataSchemaNode childNode : dataNodeContainer.getChildNodes()) {
 298             if (childNode instanceof ListSchemaNode || childNode instanceof ContainerSchemaNode) {
 299                 final ObjectNode items = JsonNodeFactory.instance.objectNode();
 300                 items.put(REF_KEY, parentName + "(config)" + childNode.getQName().getLocalName());
 301                 final ObjectNode property = JsonNodeFactory.instance.objectNode();
 302                 property.put(TYPE_KEY, childNode instanceof ListSchemaNode ? ARRAY_TYPE : OBJECT_TYPE);
 303                 property.set(ITEMS_KEY, items);
 304                 properties.set(childNode.getQName().getLocalName(), property);
 305             } else if (childNode instanceof LeafSchemaNode) {
 306                 final ObjectNode property = processLeafNode((LeafSchemaNode) childNode, schemaContext);
 307                 properties.set(childNode.getQName().getLocalName(), property);
 308             }
 309         }
 310         return properties;
 311     }
 312
 313     /**
 314      * Processes the nodes.
 315      */
 316     private ObjectNode processChildren(
 317             final Iterable<DataSchemaNode> nodes, final String parentName, final ObjectNode models,
 318             final boolean isConfig, final SchemaContext schemaContext) throws IOException {
 319         final ObjectNode properties = JsonNodeFactory.instance.objectNode();
 320         for (final DataSchemaNode node : nodes) {
 321             if (node.isConfiguration() == isConfig) {
 322                 final String name = resolveNodesName(node, topLevelModule, schemaContext);
 323                 final ObjectNode property;
 324                 if (node instanceof LeafSchemaNode) {
 325                     property = processLeafNode((LeafSchemaNode) node, schemaContext);
 326
 327                 } else if (node instanceof ListSchemaNode) {
 328                     property = processDataNodeContainer((ListSchemaNode) node, parentName, models, isConfig,
 329                             schemaContext);
 330
 331                 } else if (node instanceof LeafListSchemaNode) {
 332                     property = processLeafListNode((LeafListSchemaNode) node, schemaContext);
 333
 334                 } else if (node instanceof ChoiceSchemaNode) {
 335                     if (((ChoiceSchemaNode) node).getCases().values().iterator().hasNext()) {
 336                         processChoiceNode(((ChoiceSchemaNode) node).getCases().values().iterator().next()
 337                             .getChildNodes(), parentName, models, schemaContext, isConfig, properties);
 338                     }
 339                     continue;
 340
 341                 } else if (node instanceof AnyXmlSchemaNode) {
 342                     property = processAnyXMLNode((AnyXmlSchemaNode) node);
 343
 344                 } else if (node instanceof ContainerSchemaNode) {
 345                     property = processDataNodeContainer((ContainerSchemaNode) node, parentName, models, isConfig,
 346                             schemaContext);
 347
 348                 } else {
 349                     throw new IllegalArgumentException("Unknown DataSchemaNode type: " + node.getClass());
 350                 }
 351                 putIfNonNull(property, DESCRIPTION_KEY, node.getDescription().orElse(null));
 352                 properties.set(topLevelModule.getName() + ":" + name, property);
 353             }
 354         }
 355         return properties;
 356     }
 357
 358     private ObjectNode processLeafListNode(final LeafListSchemaNode listNode,
 359                                            final SchemaContext schemaContext) {
 360         final ObjectNode props = JsonNodeFactory.instance.objectNode();
 361         props.put(TYPE_KEY, ARRAY_TYPE);
 362
 363         final ObjectNode itemsVal = JsonNodeFactory.instance.objectNode();
 364         final Optional<ElementCountConstraint> optConstraint = listNode.getElementCountConstraint();
 365         final int max;
 366         if (optConstraint.isPresent()) {
 367             final Integer constraintMax = optConstraint.get().getMaxElements();
 368             max = constraintMax == null ? 2 : constraintMax;
 369             processElementCount(optConstraint.get(), props);
 370         } else {
 371             max = 2;
 372         }
 373
 374         if (max >= 2) {
 375             processTypeDef(listNode.getType(), listNode, itemsVal, schemaContext);
 376             processTypeDef(listNode.getType(), listNode, itemsVal, schemaContext);
 377         } else {
 378             processTypeDef(listNode.getType(), listNode, itemsVal, schemaContext);
 379         }
 380         props.set(ITEMS_KEY, itemsVal);
 381
 382         return props;
 383     }
 384
 385     private void processChoiceNode(
 386             final Iterable<DataSchemaNode> nodes, final String moduleName, final ObjectNode models,
 387             final SchemaContext schemaContext, final boolean isConfig, final ObjectNode properties)
 388            throws IOException {
 389         for (final DataSchemaNode node : nodes) {
 390             final String name = resolveNodesName(node, topLevelModule, schemaContext);
 391             final ObjectNode property;
 392
 393             if (node instanceof LeafSchemaNode) {
 394                 property = processLeafNode((LeafSchemaNode) node, schemaContext);
 395
 396             } else if (node instanceof ListSchemaNode) {
 397                 property = processDataNodeContainer((ListSchemaNode) node, moduleName, models, isConfig,
 398                         schemaContext);
 399
 400             } else if (node instanceof LeafListSchemaNode) {
 401                 property = processLeafListNode((LeafListSchemaNode) node, schemaContext);
 402
 403             } else if (node instanceof ChoiceSchemaNode) {
 404                 if (((ChoiceSchemaNode) node).getCases().values().iterator().hasNext()) {
 405                     processChoiceNode(((ChoiceSchemaNode) node).getCases().values().iterator().next().getChildNodes(),
 406                             moduleName, models, schemaContext, isConfig, properties);
 407                 }
 408                 continue;
 409
 410             } else if (node instanceof AnyXmlSchemaNode) {
 411                 property = processAnyXMLNode((AnyXmlSchemaNode) node);
 412
 413             } else if (node instanceof ContainerSchemaNode) {
 414                 property = processDataNodeContainer((ContainerSchemaNode) node, moduleName, models, isConfig,
 415                         schemaContext);
 416
 417             } else {
 418                 throw new IllegalArgumentException("Unknown DataSchemaNode type: " + node.getClass());
 419             }
 420
 421             putIfNonNull(property, DESCRIPTION_KEY, node.getDescription().orElse(null));
 422             properties.set(name, property);
 423         }
 424     }
 425
 426     private static void processElementCount(final ElementCountConstraint constraint, final ObjectNode props) {
 427         final Integer minElements = constraint.getMinElements();
 428         if (minElements != null) {
 429             props.put(MIN_ITEMS, minElements);
 430         }
 431         final Integer maxElements = constraint.getMaxElements();
 432         if (maxElements != null) {
 433             props.put(MAX_ITEMS, maxElements);
 434         }
 435     }
 436
 437     private static void processMandatory(final MandatoryAware node, final ObjectNode props) {
 438         props.put(REQUIRED_KEY, node.isMandatory());
 439     }
 440
 441     private ObjectNode processLeafNode(final LeafSchemaNode leafNode,
 442                                        final SchemaContext schemaContext) {
 443         final ObjectNode property = JsonNodeFactory.instance.objectNode();
 444
 445         final String leafDescription = leafNode.getDescription().orElse(null);
 446         putIfNonNull(property, DESCRIPTION_KEY, leafDescription);
 447         processMandatory(leafNode, property);
 448         processTypeDef(leafNode.getType(), leafNode, property, schemaContext);
 449
 450         return property;
 451     }
 452
 453     private static ObjectNode processAnyXMLNode(final AnyXmlSchemaNode leafNode) {
 454         final ObjectNode property = JsonNodeFactory.instance.objectNode();
 455
 456         final String leafDescription = leafNode.getDescription().orElse(null);
 457         putIfNonNull(property, DESCRIPTION_KEY, leafDescription);
 458
 459         processMandatory(leafNode, property);
 460         final String localName = leafNode.getQName().getLocalName();
 461         property.put(TYPE_KEY, "example of anyxml " + localName);
 462
 463         return property;
 464     }
 465
 466     private String processTypeDef(final TypeDefinition<?> leafTypeDef, final DataSchemaNode node,
 467                                   final ObjectNode property, final SchemaContext schemaContext) {
 468         final String jsonType;
 469         if (leafTypeDef.getDefaultValue() == null) {
 470             if (leafTypeDef instanceof BinaryTypeDefinition) {
 471                 jsonType = processBinaryType(property);
 472
 473             } else if (leafTypeDef instanceof BitsTypeDefinition) {
 474                 jsonType = processBitsType((BitsTypeDefinition) leafTypeDef, property);
 475
 476             } else if (leafTypeDef instanceof EnumTypeDefinition) {
 477                 jsonType = processEnumType((EnumTypeDefinition) leafTypeDef, property);
 478
 479             } else if (leafTypeDef instanceof IdentityrefTypeDefinition) {
 480                 final String name = topLevelModule.getName();
 481                 jsonType = name + ":" + ((IdentityrefTypeDefinition) leafTypeDef).getIdentities().iterator().next()
 482                         .getQName().getLocalName();
 483
 484             } else if (leafTypeDef instanceof StringTypeDefinition) {
 485                 jsonType = processStringType(leafTypeDef, property, node.getQName().getLocalName());
 486
 487             } else if (leafTypeDef instanceof UnionTypeDefinition) {
 488                 jsonType = processUnionType((UnionTypeDefinition) leafTypeDef, property, schemaContext, node);
 489
 490             } else if (leafTypeDef instanceof EmptyTypeDefinition) {
 491                 jsonType = UNIQUE_EMPTY_IDENTIFIER;
 492
 493             } else if (leafTypeDef instanceof LeafrefTypeDefinition) {
 494                 return processLeafRef(node, property, schemaContext, leafTypeDef);
 495
 496             } else if (leafTypeDef instanceof BooleanTypeDefinition) {
 497                 jsonType = "true";
 498
 499             } else if (leafTypeDef instanceof RangeRestrictedTypeDefinition) {
 500                 final Number maybeLower = ((RangeRestrictedTypeDefinition<?, ?>) leafTypeDef).getRangeConstraint()
 501                         .map(RangeConstraint::getAllowedRanges).map(RangeSet::span).map(Range::lowerEndpoint)
 502                         .orElse(null);
 503                 jsonType = String.valueOf(maybeLower);
 504
 505             } else {
 506                 jsonType = OBJECT_TYPE;
 507
 508             }
 509         } else {
 510             jsonType = String.valueOf(leafTypeDef.getDefaultValue());
 511         }
 512         putIfNonNull(property, TYPE_KEY, jsonType);
 513         return jsonType;
 514     }
 515
 516     private String processLeafRef(final DataSchemaNode node, final ObjectNode property,
 517                                   final SchemaContext schemaContext, final TypeDefinition<?> leafTypeDef) {
 518         RevisionAwareXPath xpath = ((LeafrefTypeDefinition) leafTypeDef).getPathStatement();
 519         final SchemaNode schemaNode;
 520
 521         final String xPathString = STRIP_PATTERN.matcher(xpath.toString()).replaceAll("");
 522         xpath = new RevisionAwareXPathImpl(xPathString, xpath.isAbsolute());
 523
 524         final Module module;
 525         if (xpath.isAbsolute()) {
 526             module = findModule(schemaContext, leafTypeDef.getQName());
 527             schemaNode = SchemaContextUtil.findDataSchemaNode(schemaContext, module, xpath);
 528         } else {
 529             module = findModule(schemaContext, node.getQName());
 530             schemaNode = SchemaContextUtil.findDataSchemaNodeForRelativeXPath(schemaContext, module, node, xpath);
 531         }
 532
 533         return processTypeDef(((TypedDataSchemaNode) schemaNode).getType(), (DataSchemaNode) schemaNode,
 534                 property, schemaContext);
 535     }
 536
 537     private static Module findModule(final SchemaContext schemaContext, final QName qualifiedName) {
 538         return schemaContext.findModule(qualifiedName.getNamespace(), qualifiedName.getRevision()).orElse(null);
 539     }
 540
 541     private static String processBinaryType(final ObjectNode property) {
 542         final ObjectNode media = JsonNodeFactory.instance.objectNode();
 543         media.put(BINARY_ENCODING_KEY, BASE_64);
 544         property.set(MEDIA_KEY, media);
 545         return "bin1 bin2";
 546     }
 547
 548     private static String processEnumType(final EnumTypeDefinition enumLeafType,
 549                                           final ObjectNode property) {
 550         final List<EnumPair> enumPairs = enumLeafType.getValues();
 551         ArrayNode enumNames = new ArrayNode(JsonNodeFactory.instance);
 552         for (final EnumPair enumPair : enumPairs) {
 553             enumNames.add(new TextNode(enumPair.getName()));
 554         }
 555
 556         property.set(ENUM, enumNames);
 557         return enumLeafType.getValues().iterator().next().getName();
 558     }
 559
 560     private static String processBitsType(final BitsTypeDefinition bitsType,
 561                                           final ObjectNode property) {
 562         property.put(MIN_ITEMS, 0);
 563         property.put(UNIQUE_ITEMS_KEY, true);
 564         ArrayNode enumNames = new ArrayNode(JsonNodeFactory.instance);
 565         final List<Bit> bits = bitsType.getBits();
 566         for (final Bit bit : bits) {
 567             enumNames.add(new TextNode(bit.getName()));
 568         }
 569         property.set(ENUM, enumNames);
 570
 571         return enumNames.iterator().next() + " " + enumNames.get(enumNames.size() - 1);
 572     }
 573
 574     private static String processStringType(final TypeDefinition<?> stringType,
 575                                             final ObjectNode property, final String nodeName) {
 576         StringTypeDefinition type = (StringTypeDefinition) stringType;
 577         Optional<LengthConstraint> lengthConstraints = ((StringTypeDefinition) stringType).getLengthConstraint();
 578         while (!lengthConstraints.isPresent() && type.getBaseType() != null) {
 579             type = type.getBaseType();
 580             lengthConstraints = type.getLengthConstraint();
 581         }
 582
 583         if (lengthConstraints.isPresent()) {
 584             final Range<Integer> range = lengthConstraints.get().getAllowedRanges().span();
 585             putIfNonNull(property, MIN_LENGTH_KEY, range.lowerEndpoint());
 586             putIfNonNull(property, MAX_LENGTH_KEY, range.upperEndpoint());
 587         }
 588
 589         if (type.getPatternConstraints().iterator().hasNext()) {
 590             final PatternConstraint pattern = type.getPatternConstraints().iterator().next();
 591             String regex = pattern.getJavaPatternString();
 592             regex = regex.substring(1, regex.length() - 1);
 593             final Generex generex = new Generex(regex);
 594             return generex.random();
 595         } else {
 596             return "Some " + nodeName;
 597         }
 598     }
 599
 600     private String processUnionType(final UnionTypeDefinition unionType, final ObjectNode property,
 601                                     final SchemaContext schemaContext, final DataSchemaNode node) {
 602         final ArrayNode unionNames = new ArrayNode(JsonNodeFactory.instance);
 603         for (final TypeDefinition<?> typeDef : unionType.getTypes()) {
 604             unionNames.add(processTypeDef(typeDef, node, property, schemaContext));
 605         }
 606         property.set(ENUM, unionNames);
 607         return unionNames.iterator().next().asText();
 608     }
 609
 610     /**
 611      * Helper method to generate a pre-filled JSON schema object.
 612      */
 613     private static ObjectNode getSchemaTemplate() {
 614         final ObjectNode schemaJSON = JsonNodeFactory.instance.objectNode();
 615         schemaJSON.put(SCHEMA_KEY, SCHEMA_URL);
 616
 617         return schemaJSON;
 618     }
 619
 620     private static void putIfNonNull(final ObjectNode property, final String key, final Number number) {
 621         if (key != null && number != null) {
 622             if (number instanceof Double) {
 623                 property.put(key, (Double) number);
 624             } else if (number instanceof Float) {
 625                 property.put(key, (Float) number);
 626             } else if (number instanceof Integer) {
 627                 property.put(key, (Integer) number);
 628             } else if (number instanceof Short) {
 629                 property.put(key, (Short) number);
 630             } else if (number instanceof Long) {
 631                 property.put(key, (Long) number);
 632             }
 633         }
 634     }
 635
 636     private static void putIfNonNull(final ObjectNode property, final String key, final String value) {
 637         if (key != null && value != null) {
 638             property.put(key, value);
 639         }
 640     }
 641
 642 }