summaryrefslogtreecommitdiffstats
path: root/vpp-integration/api-docs/core
diff options
context:
space:
mode:
authorMarek Gradzki <mgradzki@cisco.com>2017-07-25 15:44:21 +0200
committerMarek Gradzki <mgradzki@cisco.com>2017-07-25 20:27:45 +0200
commit403a2684f3b316812fb5f81a3ec03abd0bfd886f (patch)
treedac7f20cb846a1aebd20e93038f3f933ad56a151 /vpp-integration/api-docs/core
parent4e65014a55c21582e884abd3957b7bdee7d5b86e (diff)
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 <mgradzki@cisco.com>
Diffstat (limited to 'vpp-integration/api-docs/core')
-rw-r--r--vpp-integration/api-docs/core/src/main/java/io/fd/hc2vpp/docs/core/CoverageGenerator.java71
-rw-r--r--vpp-integration/api-docs/core/src/main/java/io/fd/hc2vpp/docs/core/PluginMethodReference.java5
2 files changed, 45 insertions, 31 deletions
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<CoverageUnit> 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<PluginMethodReference> writeReferences =
new CoverageScanner(customizerClass, WRITE, pluginClass).scan();
+ LOG.debug("writeReferences: {}", writeReferences);
// scans within update method
final Set<PluginMethodReference> updateReferences =
new CoverageScanner(customizerClass, UPDATE, pluginClass).scan();
+ LOG.debug("updateReferences: {}", updateReferences);
// scans within delete method
final Set<PluginMethodReference> 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<Operation> 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<Operation> 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 + ", " + "}";
+ }
}