Added test to doc generation
This commit is contained in:
parent
9e73e053ea
commit
a46b1d9ac3
|
@ -33,6 +33,10 @@ public class Generator {
|
||||||
this.modelKnowledge = new ModelKnowledge();
|
this.modelKnowledge = new ModelKnowledge();
|
||||||
}
|
}
|
||||||
|
|
||||||
|
public ModelKnowledge getModelKnowledge() {
|
||||||
|
return modelKnowledge;
|
||||||
|
}
|
||||||
|
|
||||||
public Class<? extends DocumentationGenerator> getDocumentationGeneratorClass(AccessType accessType)
|
public Class<? extends DocumentationGenerator> getDocumentationGeneratorClass(AccessType accessType)
|
||||||
throws Exception {
|
throws Exception {
|
||||||
Class<? extends DocumentationGenerator> clz;
|
Class<? extends DocumentationGenerator> clz;
|
||||||
|
|
|
@ -2,16 +2,24 @@ package org.gcube.informationsystem.utils.documentation;
|
||||||
|
|
||||||
import java.util.ServiceLoader;
|
import java.util.ServiceLoader;
|
||||||
|
|
||||||
|
import org.gcube.informationsystem.base.reference.AccessType;
|
||||||
|
import org.gcube.informationsystem.base.reference.Element;
|
||||||
import org.gcube.informationsystem.discovery.ISModelRegistrationProvider;
|
import org.gcube.informationsystem.discovery.ISModelRegistrationProvider;
|
||||||
import org.gcube.informationsystem.discovery.RegistrationProvider;
|
import org.gcube.informationsystem.discovery.RegistrationProvider;
|
||||||
|
import org.gcube.informationsystem.discovery.knowledge.ModelKnowledge;
|
||||||
|
import org.gcube.informationsystem.tree.Tree;
|
||||||
import org.gcube.informationsystem.utils.documentation.generator.TreeGenerator;
|
import org.gcube.informationsystem.utils.documentation.generator.TreeGenerator;
|
||||||
import org.gcube.informationsystem.utils.documentation.model.DocumentationGenerator;
|
import org.gcube.informationsystem.utils.documentation.model.DocumentationGenerator;
|
||||||
import org.junit.Test;
|
import org.junit.Test;
|
||||||
|
import org.slf4j.Logger;
|
||||||
|
import org.slf4j.LoggerFactory;
|
||||||
|
|
||||||
/**
|
/**
|
||||||
* @author Luca Frosini (ISTI - CNR)
|
* @author Luca Frosini (ISTI - CNR)
|
||||||
*/
|
*/
|
||||||
public class GenerateTest {
|
public class GenerateTest {
|
||||||
|
|
||||||
|
public static Logger logger = LoggerFactory.getLogger(GenerateTest.class);
|
||||||
|
|
||||||
@Test
|
@Test
|
||||||
public void testDocGeneration() throws Exception {
|
public void testDocGeneration() throws Exception {
|
||||||
|
@ -28,6 +36,23 @@ public class GenerateTest {
|
||||||
treeGenerator.setSplittedFiles(true);
|
treeGenerator.setSplittedFiles(true);
|
||||||
}
|
}
|
||||||
treeGenerator.generate();
|
treeGenerator.generate();
|
||||||
|
|
||||||
|
logger.info("-------- Analising Discovery for model '{}'", rp.getModelName());
|
||||||
|
|
||||||
|
ModelKnowledge modelKnowledge = treeGenerator.getModelKnowledge();
|
||||||
|
ResultAnaliser ra = new ResultAnaliser(rp);
|
||||||
|
modelKnowledge.addDiscoveredElementActions(ra);
|
||||||
|
|
||||||
|
logger.info("-------- Analising Trees for model '{}'", rp.getModelName());
|
||||||
|
|
||||||
|
AccessType[] accessTypes = AccessType.getModelTypes();
|
||||||
|
for(AccessType accessType : accessTypes) {
|
||||||
|
logger.info(" ------------- Analising Tree of '{}' for model '{}'", accessType.getName() ,rp.getModelName());
|
||||||
|
|
||||||
|
Tree<Class<Element>> tree = modelKnowledge.getClassesTree(accessType);
|
||||||
|
tree.elaborate(ra);
|
||||||
|
}
|
||||||
|
|
||||||
}
|
}
|
||||||
}
|
}
|
||||||
|
|
||||||
|
|
|
@ -0,0 +1,80 @@
|
||||||
|
/**
|
||||||
|
*
|
||||||
|
*/
|
||||||
|
package org.gcube.informationsystem.utils.documentation;
|
||||||
|
|
||||||
|
import java.util.ArrayList;
|
||||||
|
import java.util.Collection;
|
||||||
|
import java.util.List;
|
||||||
|
|
||||||
|
import org.gcube.informationsystem.base.reference.AccessType;
|
||||||
|
import org.gcube.informationsystem.base.reference.Element;
|
||||||
|
import org.gcube.informationsystem.discovery.DiscoveredElementAction;
|
||||||
|
import org.gcube.informationsystem.discovery.RegistrationProvider;
|
||||||
|
import org.gcube.informationsystem.tree.Node;
|
||||||
|
import org.gcube.informationsystem.tree.NodeElaborator;
|
||||||
|
import org.gcube.informationsystem.types.TypeMapper;
|
||||||
|
import org.slf4j.Logger;
|
||||||
|
import org.slf4j.LoggerFactory;
|
||||||
|
|
||||||
|
/**
|
||||||
|
* @author Luca Frosini (ISTI - CNR)
|
||||||
|
*/
|
||||||
|
public class ResultAnaliser implements DiscoveredElementAction<Element>, NodeElaborator<Class<Element>> {
|
||||||
|
|
||||||
|
public static Logger logger = LoggerFactory.getLogger(ResultAnaliser.class);
|
||||||
|
|
||||||
|
protected RegistrationProvider rp;
|
||||||
|
protected Collection<Package> packages;
|
||||||
|
protected List<Class<Element>> baseTypes;
|
||||||
|
|
||||||
|
public ResultAnaliser(RegistrationProvider rp) {
|
||||||
|
this.rp = rp;
|
||||||
|
this.packages = rp.getPackagesToRegister();
|
||||||
|
this.baseTypes = new ArrayList<>();
|
||||||
|
AccessType[] accessTypes = AccessType.getModelTypes();
|
||||||
|
for(AccessType accessType : accessTypes) {
|
||||||
|
this.baseTypes.add(accessType.getTypeClass());
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
@Override
|
||||||
|
public void analizeElement(Class<Element> e) throws Exception {
|
||||||
|
String typeName = TypeMapper.getType(e);
|
||||||
|
if(baseTypes.contains(e)) {
|
||||||
|
logger.info("- Type {} is the root type", typeName);
|
||||||
|
return;
|
||||||
|
}
|
||||||
|
|
||||||
|
if(packages.contains(e.getPackage())) {
|
||||||
|
logger.info(" - Type {} belongs to {} as expected", typeName, rp.getModelName());
|
||||||
|
}else {
|
||||||
|
logger.error(" - Type {} DOES NOT belong to {} as expected. This is very strange and should not occurr.", typeName, rp.getModelName());
|
||||||
|
throw new Exception("Type " + typeName + " DOES NOT belong to " + rp.getModelName() +" as expected. This is very strange and should not occurr.");
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
@Override
|
||||||
|
public void elaborate(Node<Class<Element>> node, int level) throws Exception {
|
||||||
|
Class<Element> e = node.getNodeElement();
|
||||||
|
|
||||||
|
StringBuffer stringBuffer = new StringBuffer();
|
||||||
|
for (int i = 0; i < level; ++i) {
|
||||||
|
stringBuffer.append(Node.INDENTATION);
|
||||||
|
}
|
||||||
|
|
||||||
|
String typeName = TypeMapper.getType(e);
|
||||||
|
if(node.getTree().getRoot().getNodeElement() == e) {
|
||||||
|
logger.info("{}- Type {} is the root type", stringBuffer.toString(), typeName);
|
||||||
|
return;
|
||||||
|
}
|
||||||
|
|
||||||
|
if(packages.contains(e.getPackage())) {
|
||||||
|
logger.info("{}- Type {} belongs to {} as expected", stringBuffer.toString(), typeName, rp.getModelName());
|
||||||
|
}else {
|
||||||
|
logger.error("{}- Type {} DOES NOT belong to {} as expected. This is very strange and should not occurr.", stringBuffer.toString(), typeName, rp.getModelName());
|
||||||
|
throw new Exception("Type " + typeName + " DOES NOT belong to " + rp.getModelName() +" as expected. This is very strange and should not occurr.");
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
}
|
Loading…
Reference in New Issue