From 2f832ea2eda1727308adf82051afdf30bfdb247f Mon Sep 17 00:00:00 2001 From: Marek Gradzki Date: Tue, 25 Jul 2017 15:44:21 +0200 Subject: Api docs: single row per VPP API message Lists all of supported CUD operations in single cell. Change-Id: I5f23200d869221f797ed8b4b5ca0512baa92486b Signed-off-by: Marek Gradzki --- .../io/fd/hc2vpp/docs/core/CoverageGenerator.java | 71 ++++++++++++---------- .../fd/hc2vpp/docs/core/PluginMethodReference.java | 5 ++ 2 files changed, 45 insertions(+), 31 deletions(-) (limited to 'vpp-integration/api-docs/core/src/main/java') diff --git a/vpp-integration/api-docs/core/src/main/java/io/fd/hc2vpp/docs/core/CoverageGenerator.java b/vpp-integration/api-docs/core/src/main/java/io/fd/hc2vpp/docs/core/CoverageGenerator.java index 4a8a77827..ff6c9b78b 100644 --- a/vpp-integration/api-docs/core/src/main/java/io/fd/hc2vpp/docs/core/CoverageGenerator.java +++ b/vpp-integration/api-docs/core/src/main/java/io/fd/hc2vpp/docs/core/CoverageGenerator.java @@ -34,7 +34,7 @@ import io.fd.hc2vpp.docs.api.PluginCoverage; import io.fd.hc2vpp.docs.api.YangType; import io.fd.honeycomb.translate.write.WriterFactory; import java.lang.reflect.Field; -import java.util.LinkedList; +import java.util.HashSet; import java.util.List; import java.util.Set; import java.util.stream.Collectors; @@ -63,53 +63,62 @@ public class CoverageGenerator implements VppApiUtils { final Set coverageUnits = writerBuilder.getWriteHandlers().stream() .flatMap(handler -> { + LOG.debug("Processing writer handling nodes: {}", handler.getHandledNodes()); // extracts customizer class from handler final Class customizerClass = getCustomizerClass(handler.getWriter()); // scans within write method final Set writeReferences = new CoverageScanner(customizerClass, WRITE, pluginClass).scan(); + LOG.debug("writeReferences: {}", writeReferences); // scans within update method final Set updateReferences = new CoverageScanner(customizerClass, UPDATE, pluginClass).scan(); + LOG.debug("updateReferences: {}", updateReferences); // scans within delete method final Set deleteReferences = new CoverageScanner(customizerClass, DELETE, pluginClass).scan(); + LOG.debug("deleteReferences: {}", deleteReferences); return Stream.of(writeReferences.stream(), updateReferences.stream(), deleteReferences.stream()) - .flatMap(pluginMethodReferenceStream -> pluginMethodReferenceStream) - .map(reference -> { - final CoverageUnit.CoverageUnitBuilder builder = new CoverageUnit.CoverageUnitBuilder(); - - // binds vpp api name and generateLink bind with version - builder.setVppApi(fromJvppApi(version, reference.getName())); - - //binds java api reference - builder.setJavaApi(new JavaApiMessage(reference.getName())); - - // binds Yang types with links from pre-build index - // TODO - use deserialized yii e.g. /module:parent-node/child-node - builder.setYangTypes(handler.getHandledNodes().stream() - .map(type -> new YangType(type, yangTypeIndex.getLinkForType(type))) - .collect(Collectors.toList())); - - final String callerClassLink = classPathIndex.linkForClass(reference.getCaller()); - final List supportedOperations = new LinkedList<>(); - if (writeReferences.contains(reference)) { - supportedOperations.add(new Operation(callerClassLink, WRITE)); + .flatMap(pluginMethodReferenceStream -> pluginMethodReferenceStream) + .collect(Collectors.groupingBy(PluginMethodReference::getName)).entrySet().stream() + .map(vppMessageReferenceByName -> { + final String jvppMethodName = vppMessageReferenceByName.getKey(); + final CoverageUnit.CoverageUnitBuilder builder = new CoverageUnit.CoverageUnitBuilder(); + + // binds vpp api name and generateLink bind with version + builder.setVppApi(fromJvppApi(version, jvppMethodName)); + + //binds java api reference + builder.setJavaApi(new JavaApiMessage(jvppMethodName)); + + // binds Yang types with links from pre-build index + // TODO - use deserialized yii e.g. /module:parent-node/child-node + builder.setYangTypes(handler.getHandledNodes().stream() + .map(type -> new YangType(type, yangTypeIndex.getLinkForType(type))) + .collect(Collectors.toList())); + + + final Set supportedOperations = new HashSet<>(); + vppMessageReferenceByName.getValue().stream().forEach( + reference -> { + final String callerClassLink = classPathIndex.linkForClass(reference.getCaller()); + if (writeReferences.contains(reference)) { + supportedOperations.add(new Operation(callerClassLink, WRITE)); + } + if (updateReferences.contains(reference)) { + supportedOperations.add(new Operation(callerClassLink, UPDATE)); + } + if (deleteReferences.contains(reference)) { + supportedOperations.add(new Operation(callerClassLink, DELETE)); + } } - - if (updateReferences.contains(reference)) { - supportedOperations.add(new Operation(callerClassLink, UPDATE)); - } - - if (deleteReferences.contains(reference)) { - supportedOperations.add(new Operation(callerClassLink, DELETE)); - } - return builder.setSupportedOperations(supportedOperations).build(); - }); + ); + return builder.setSupportedOperations(supportedOperations).build(); + }); }).collect(Collectors.toSet()); return new PluginCoverage(pluginClass.getSimpleName(), coverageUnits, true); diff --git a/vpp-integration/api-docs/core/src/main/java/io/fd/hc2vpp/docs/core/PluginMethodReference.java b/vpp-integration/api-docs/core/src/main/java/io/fd/hc2vpp/docs/core/PluginMethodReference.java index 5a98639ae..4e03b4a73 100644 --- a/vpp-integration/api-docs/core/src/main/java/io/fd/hc2vpp/docs/core/PluginMethodReference.java +++ b/vpp-integration/api-docs/core/src/main/java/io/fd/hc2vpp/docs/core/PluginMethodReference.java @@ -53,4 +53,9 @@ public class PluginMethodReference { public String getName() { return name; } + + @Override + public String toString() { + return "PluginMethodReference{name=" + this.name + ", caller=" + this.caller + ", owner=" + this.owner + ", " + "}"; + } } -- cgit 1.2.3-korg