gerrit.opnfv Code Review - onosfw.git/blob

   1 /*
   2  * Copyright 2015 Open Networking Laboratory
   3  *
   4  * Licensed under the Apache License, Version 2.0 (the "License");
   5  * you may not use this file except in compliance with the License.
   6  * You may obtain a copy of the License at
   7  *
   8  *     http://www.apache.org/licenses/LICENSE-2.0
   9  *
  10  * Unless required by applicable law or agreed to in writing, software
  11  * distributed under the License is distributed on an "AS IS" BASIS,
  12  * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
  13  * See the License for the specific language governing permissions and
  14  * limitations under the License.
  15  */
  16 package org.onosproject.maven;
  17
  18 import com.fasterxml.jackson.databind.ObjectMapper;
  19 import com.fasterxml.jackson.databind.node.ArrayNode;
  20 import com.fasterxml.jackson.databind.node.ObjectNode;
  21 import com.google.common.base.Charsets;
  22 import com.google.common.io.ByteStreams;
  23 import com.google.common.io.Files;
  24 import com.thoughtworks.qdox.JavaProjectBuilder;
  25 import com.thoughtworks.qdox.model.DocletTag;
  26 import com.thoughtworks.qdox.model.JavaAnnotation;
  27 import com.thoughtworks.qdox.model.JavaClass;
  28 import com.thoughtworks.qdox.model.JavaMethod;
  29 import com.thoughtworks.qdox.model.JavaParameter;
  30 import com.thoughtworks.qdox.model.JavaType;
  31 import org.apache.maven.plugin.AbstractMojo;
  32 import org.apache.maven.plugin.MojoExecutionException;
  33 import org.apache.maven.plugins.annotations.LifecyclePhase;
  34 import org.apache.maven.plugins.annotations.Mojo;
  35 import org.apache.maven.plugins.annotations.Parameter;
  36 import org.apache.maven.project.MavenProject;
  37
  38 import java.io.File;
  39 import java.io.FileWriter;
  40 import java.io.IOException;
  41 import java.io.PrintWriter;
  42 import java.util.HashMap;
  43 import java.util.Map;
  44 import java.util.Optional;
  45
  46 import static com.google.common.base.Strings.isNullOrEmpty;
  47
  48 /**
  49  * Produces ONOS Swagger api-doc.
  50  */
  51 @Mojo(name = "swagger", defaultPhase = LifecyclePhase.GENERATE_SOURCES)
  52 public class OnosSwaggerMojo extends AbstractMojo {
  53     private final ObjectMapper mapper = new ObjectMapper();
  54
  55     private static final String JSON_FILE = "swagger.json";
  56     private static final String GEN_SRC = "generated-sources";
  57     private static final String REG_SRC = "registrator.javat";
  58
  59     private static final String PATH = "javax.ws.rs.Path";
  60     private static final String PATH_PARAM = "javax.ws.rs.PathParam";
  61     private static final String QUERY_PARAM = "javax.ws.rs.QueryParam";
  62     private static final String POST = "javax.ws.rs.POST";
  63     private static final String GET = "javax.ws.rs.GET";
  64     private static final String PUT = "javax.ws.rs.PUT";
  65     private static final String DELETE = "javax.ws.rs.DELETE";
  66     private static final String PRODUCES = "javax.ws.rs.Produces";
  67     private static final String CONSUMES = "javax.ws.rs.Consumes";
  68     private static final String JSON = "MediaType.APPLICATION_JSON";
  69
  70     /**
  71      * The directory where the generated catalogue file will be put.
  72      */
  73     @Parameter(defaultValue = "${basedir}")
  74     protected File srcDirectory;
  75
  76     /**
  77      * The directory where the generated catalogue file will be put.
  78      */
  79     @Parameter(defaultValue = "${project.build.directory}")
  80     protected File dstDirectory;
  81
  82     /**
  83      * REST API web-context
  84      */
  85     @Parameter(defaultValue = "${web.context}")
  86     protected String webContext;
  87
  88     /**
  89      * REST API version
  90      */
  91     @Parameter(defaultValue = "${api.version}")
  92     protected String apiVersion;
  93
  94     /**
  95      * REST API description
  96      */
  97     @Parameter(defaultValue = "${api.description}")
  98     protected String apiDescription;
  99
 100     /**
 101      * REST API title
 102      */
 103     @Parameter(defaultValue = "${api.title}")
 104     protected String apiTitle;
 105
 106     /**
 107      * REST API title
 108      */
 109     @Parameter(defaultValue = "${api.package}")
 110     protected String apiPackage;
 111
 112     /**
 113      * Maven project
 114      */
 115     @Parameter(defaultValue = "${project}")
 116     protected MavenProject project;
 117
 118
 119     @Override
 120     public void execute() throws MojoExecutionException {
 121         try {
 122             JavaProjectBuilder builder = new JavaProjectBuilder();
 123             builder.addSourceTree(new File(srcDirectory, "src/main/java"));
 124
 125             ObjectNode root = initializeRoot();
 126             ArrayNode tags = mapper.createArrayNode();
 127             ObjectNode paths = mapper.createObjectNode();
 128             ObjectNode definitions = mapper.createObjectNode();
 129
 130             root.set("tags", tags);
 131             root.set("paths", paths);
 132             root.set("definitions", definitions);
 133
 134             builder.getClasses().forEach(jc -> processClass(jc, paths, tags, definitions));
 135
 136             if (paths.size() > 0) {
 137                 getLog().info("Generating ONOS REST API documentation...");
 138                 genCatalog(root);
 139
 140                 if (!isNullOrEmpty(apiPackage)) {
 141                     genRegistrator();
 142                 }
 143             }
 144
 145             project.addCompileSourceRoot(new File(dstDirectory, GEN_SRC).getPath());
 146
 147         } catch (Exception e) {
 148             getLog().warn("Unable to generate ONOS REST API documentation", e);
 149             throw e;
 150         }
 151     }
 152
 153     // initializes top level root with Swagger required specifications
 154     private ObjectNode initializeRoot() {
 155         ObjectNode root = mapper.createObjectNode();
 156         root.put("swagger", "2.0");
 157         ObjectNode info = mapper.createObjectNode();
 158         root.set("info", info);
 159
 160         root.put("basePath", webContext);
 161         info.put("version", apiVersion);
 162         info.put("title", apiTitle);
 163         info.put("description", apiDescription);
 164
 165         ArrayNode produces = mapper.createArrayNode();
 166         produces.add("application/json");
 167         root.set("produces", produces);
 168
 169         ArrayNode consumes = mapper.createArrayNode();
 170         consumes.add("application/json");
 171         root.set("consumes", consumes);
 172
 173         return root;
 174     }
 175
 176     // Checks whether javaClass has a path tag associated with it and if it does
 177     // processes its methods and creates a tag for the class on the root
 178     void processClass(JavaClass javaClass, ObjectNode paths, ArrayNode tags, ObjectNode definitions) {
 179         // If the class does not have a Path tag then ignore it
 180         JavaAnnotation annotation = getPathAnnotation(javaClass);
 181         if (annotation == null) {
 182             return;
 183         }
 184
 185         String path = getPath(annotation);
 186         if (path == null) {
 187             return;
 188         }
 189
 190         String resourcePath = "/" + path;
 191         String tagPath = path.isEmpty() ? "/" : path;
 192
 193         // Create tag node for this class.
 194         ObjectNode tagObject = mapper.createObjectNode();
 195         tagObject.put("name", tagPath);
 196         if (javaClass.getComment() != null) {
 197             tagObject.put("description", shortText(javaClass.getComment()));
 198         }
 199         tags.add(tagObject);
 200
 201         // Create an array node add to all methods from this class.
 202         ArrayNode tagArray = mapper.createArrayNode();
 203         tagArray.add(tagPath);
 204
 205         processAllMethods(javaClass, resourcePath, paths, tagArray, definitions);
 206     }
 207
 208     private JavaAnnotation getPathAnnotation(JavaClass javaClass) {
 209         Optional<JavaAnnotation> optional = javaClass.getAnnotations()
 210                 .stream().filter(a -> a.getType().getName().equals(PATH)).findAny();
 211         return optional.isPresent() ? optional.get() : null;
 212     }
 213
 214     // Checks whether a class's methods are REST methods and then places all the
 215     // methods under a specific path into the paths node
 216     private void processAllMethods(JavaClass javaClass, String resourcePath,
 217                                    ObjectNode paths, ArrayNode tagArray, ObjectNode definitions) {
 218         // map of the path to its methods represented by an ObjectNode
 219         Map<String, ObjectNode> pathMap = new HashMap<>();
 220
 221         javaClass.getMethods().forEach(javaMethod -> {
 222             javaMethod.getAnnotations().forEach(annotation -> {
 223                 String name = annotation.getType().getName();
 224                 if (name.equals(POST) || name.equals(GET) || name.equals(DELETE) || name.equals(PUT)) {
 225                     // substring(12) removes "javax.ws.rs."
 226                     String method = annotation.getType().toString().substring(12).toLowerCase();
 227                     processRestMethod(javaMethod, method, pathMap, resourcePath, tagArray, definitions);
 228                 }
 229             });
 230         });
 231
 232         // for each path add its methods to the path node
 233         for (Map.Entry<String, ObjectNode> entry : pathMap.entrySet()) {
 234             paths.set(entry.getKey(), entry.getValue());
 235         }
 236
 237
 238     }
 239
 240     private void processRestMethod(JavaMethod javaMethod, String method,
 241                                    Map<String, ObjectNode> pathMap,
 242                                    String resourcePath, ArrayNode tagArray, ObjectNode definitions) {
 243         String fullPath = resourcePath, consumes = "", produces = "",
 244                 comment = javaMethod.getComment();
 245         DocletTag tag = javaMethod.getTagByName("rsModel");
 246         for (JavaAnnotation annotation : javaMethod.getAnnotations()) {
 247             String name = annotation.getType().getName();
 248             if (name.equals(PATH)) {
 249                 fullPath = resourcePath + "/" + getPath(annotation);
 250                 fullPath = fullPath.replaceFirst("^//", "/");
 251             }
 252             if (name.equals(CONSUMES)) {
 253                 consumes = getIOType(annotation);
 254             }
 255             if (name.equals(PRODUCES)) {
 256                 produces = getIOType(annotation);
 257             }
 258         }
 259         ObjectNode methodNode = mapper.createObjectNode();
 260         methodNode.set("tags", tagArray);
 261
 262         addSummaryDescriptions(methodNode, comment);
 263         addJsonSchemaDefinition(definitions, tag);
 264         addJsonSchemaDefinition(definitions, tag);
 265
 266         processParameters(javaMethod, methodNode, method, tag);
 267
 268         processConsumesProduces(methodNode, "consumes", consumes);
 269         processConsumesProduces(methodNode, "produces", produces);
 270         if (tag == null || ((method.toLowerCase().equals("post") || method.toLowerCase().equals("put"))
 271                 && !(tag.getParameters().size() > 1))) {
 272             addResponses(methodNode, tag, false);
 273         } else {
 274             addResponses(methodNode, tag, true);
 275         }
 276
 277         ObjectNode operations = pathMap.get(fullPath);
 278         if (operations == null) {
 279             operations = mapper.createObjectNode();
 280             operations.set(method, methodNode);
 281             pathMap.put(fullPath, operations);
 282         } else {
 283             operations.set(method, methodNode);
 284         }
 285     }
 286
 287     private void addJsonSchemaDefinition(ObjectNode definitions, DocletTag tag) {
 288         File definitionsDirectory = new File(srcDirectory + "/src/main/resources/definitions");
 289         if (tag != null) {
 290             tag.getParameters().stream().forEach(param -> {
 291                 try {
 292                     File config = new File(definitionsDirectory.getAbsolutePath() + "/"
 293                                                    + param + ".json");
 294                     String lines = Files.readLines(config, Charsets.UTF_8).stream().reduce((t, u) -> t + u).
 295                             get();
 296                     definitions.putPOJO(param, lines);
 297                 } catch (IOException e) {
 298                     e.printStackTrace();
 299                 }
 300             });
 301
 302         }
 303     }
 304
 305     private void processConsumesProduces(ObjectNode methodNode, String type, String io) {
 306         if (!io.equals("")) {
 307             ArrayNode array = mapper.createArrayNode();
 308             methodNode.set(type, array);
 309             array.add(io);
 310         }
 311     }
 312
 313     private void addSummaryDescriptions(ObjectNode methodNode, String comment) {
 314         String summary = "", description;
 315         if (comment != null) {
 316             if (comment.contains(".")) {
 317                 int periodIndex = comment.indexOf(".");
 318                 summary = comment.substring(0, periodIndex);
 319                 description = comment.length() > periodIndex + 1 ?
 320                         comment.substring(periodIndex + 1).trim() : "";
 321             } else {
 322                 description = comment;
 323             }
 324             methodNode.put("summary", summary);
 325             methodNode.put("description", description);
 326         }
 327     }
 328
 329     // Temporary solution to add responses to a method
 330     // TODO Provide annotations in the web resources for responses and parse them
 331     private void addResponses(ObjectNode methodNode, DocletTag tag, boolean responseJson) {
 332         ObjectNode responses = mapper.createObjectNode();
 333         methodNode.set("responses", responses);
 334
 335         ObjectNode success = mapper.createObjectNode();
 336         success.put("description", "successful operation");
 337         responses.set("200", success);
 338         if (tag != null && responseJson) {
 339             ObjectNode schema = mapper.createObjectNode();
 340             tag.getParameters().stream().forEach(
 341                     param -> schema.put("$ref", "#/definitions/" + param));
 342             success.set("schema", schema);
 343         }
 344
 345         ObjectNode defaultObj = mapper.createObjectNode();
 346         defaultObj.put("description", "Unexpected error");
 347         responses.set("default", defaultObj);
 348     }
 349
 350     // Checks if the annotations has a value of JSON and returns the string
 351     // that Swagger requires
 352     private String getIOType(JavaAnnotation annotation) {
 353         if (annotation.getNamedParameter("value").toString().equals(JSON)) {
 354             return "application/json";
 355         }
 356         return "";
 357     }
 358
 359     // If the annotation has a Path tag, returns the value with leading and
 360     // trailing double quotes and slash removed.
 361     private String getPath(JavaAnnotation annotation) {
 362         String path = annotation.getNamedParameter("value").toString();
 363         return path == null ? null : path.replaceAll("(^[\\\"/]*|[/\\\"]*$)", "");
 364     }
 365
 366     // Processes parameters of javaMethod and enters the proper key-values into the methodNode
 367     private void processParameters(JavaMethod javaMethod, ObjectNode methodNode, String method, DocletTag tag) {
 368         ArrayNode parameters = mapper.createArrayNode();
 369         methodNode.set("parameters", parameters);
 370         boolean required = true;
 371
 372         for (JavaParameter javaParameter : javaMethod.getParameters()) {
 373             ObjectNode individualParameterNode = mapper.createObjectNode();
 374             Optional<JavaAnnotation> optional = javaParameter.getAnnotations().stream().filter(
 375                     annotation -> annotation.getType().getName().equals(PATH_PARAM) ||
 376                             annotation.getType().getName().equals(QUERY_PARAM)).findAny();
 377             JavaAnnotation pathType = optional.isPresent() ? optional.get() : null;
 378
 379             String annotationName = javaParameter.getName();
 380
 381
 382             if (pathType != null) { //the parameter is a path or query parameter
 383                 individualParameterNode.put("name",
 384                                             pathType.getNamedParameter("value")
 385                                                     .toString().replace("\"", ""));
 386                 if (pathType.getType().getName().equals(PATH_PARAM)) {
 387                     individualParameterNode.put("in", "path");
 388                 } else if (pathType.getType().getName().equals(QUERY_PARAM)) {
 389                     individualParameterNode.put("in", "query");
 390                 }
 391                 individualParameterNode.put("type", getType(javaParameter.getType()));
 392             } else { // the parameter is a body parameter
 393                 individualParameterNode.put("name", annotationName);
 394                 individualParameterNode.put("in", "body");
 395
 396                 // Adds the reference to the Json model for the input
 397                 // that goes in the post or put operation
 398                 if (tag != null && (method.toLowerCase().equals("post") ||
 399                         method.toLowerCase().equals("put"))) {
 400                     ObjectNode schema = mapper.createObjectNode();
 401                     tag.getParameters().stream().forEach(param -> {
 402                         schema.put("$ref", "#/definitions/" + param);
 403                     });
 404                     individualParameterNode.set("schema", schema);
 405                 }
 406             }
 407             for (DocletTag p : javaMethod.getTagsByName("param")) {
 408                 if (p.getValue().contains(annotationName)) {
 409                     try {
 410                         String description = p.getValue().split(" ", 2)[1].trim();
 411                         if (description.contains("optional")) {
 412                             required = false;
 413                         }
 414                         individualParameterNode.put("description", description);
 415                     } catch (Exception e) {
 416                         e.printStackTrace();
 417                     }
 418                 }
 419             }
 420             individualParameterNode.put("required", required);
 421             parameters.add(individualParameterNode);
 422         }
 423     }
 424
 425     // Returns the Swagger specified strings for the type of a parameter
 426     private String getType(JavaType javaType) {
 427         String type = javaType.getFullyQualifiedName();
 428         String value;
 429         if (type.equals(String.class.getName())) {
 430             value = "string";
 431         } else if (type.equals("int")) {
 432             value = "integer";
 433         } else if (type.equals(boolean.class.getName())) {
 434             value = "boolean";
 435         } else if (type.equals(long.class.getName())) {
 436             value = "number";
 437         } else {
 438             value = "";
 439         }
 440         return value;
 441     }
 442
 443     // Writes the swagger.json file using the supplied JSON root.
 444     private void genCatalog(ObjectNode root) {
 445         File swaggerCfg = new File(dstDirectory, JSON_FILE);
 446         if (dstDirectory.exists() || dstDirectory.mkdirs()) {
 447             try (FileWriter fw = new FileWriter(swaggerCfg);
 448                  PrintWriter pw = new PrintWriter(fw)) {
 449                 pw.println(root.toString());
 450             } catch (IOException e) {
 451                 getLog().warn("Unable to write " + JSON_FILE);
 452             }
 453         } else {
 454             getLog().warn("Unable to create " + dstDirectory);
 455         }
 456     }
 457
 458     // Generates the registrator Java component.
 459     private void genRegistrator() {
 460         File dir = new File(dstDirectory, GEN_SRC);
 461         File reg = new File(dir, apiPackage.replaceAll("\\.", "/") + "/ApiDocRegistrator.java");
 462         File pkg = reg.getParentFile();
 463         if (pkg.exists() || pkg.mkdirs()) {
 464             try {
 465                 String src = new String(ByteStreams.toByteArray(getClass().getResourceAsStream(REG_SRC)));
 466                 src = src.replace("${api.package}", apiPackage)
 467                         .replace("${web.context}", webContext)
 468                         .replace("${api.title}", apiTitle)
 469                         .replace("${api.description}", apiTitle);
 470                 Files.write(src.getBytes(), reg);
 471             } catch (IOException e) {
 472                 getLog().warn("Unable to write " + reg);
 473             }
 474         } else {
 475             getLog().warn("Unable to create " + reg);
 476         }
 477     }
 478
 479     // Returns "nickname" based on method and path for a REST method
 480     private String setNickname(String method, String path) {
 481         if (!path.equals("")) {
 482             return (method + path.replace('/', '_').replace("{", "").replace("}", "")).toLowerCase();
 483         } else {
 484             return method.toLowerCase();
 485         }
 486     }
 487
 488     private String shortText(String comment) {
 489         int i = comment.indexOf('.');
 490         return i > 0 ? comment.substring(0, i) : comment;
 491     }
 492
 493 }