*/
package org.opendaylight.yangtools.yang.parser.util;
+import com.google.common.annotations.VisibleForTesting;
+import com.google.common.collect.Lists;
import java.net.URI;
-import java.util.ArrayList;
import java.util.Arrays;
-import java.util.Collection;
-import java.util.Collections;
import java.util.Date;
import java.util.HashMap;
+import java.util.HashSet;
import java.util.List;
import java.util.Map;
+import java.util.Objects;
import java.util.Set;
-
import org.opendaylight.yangtools.yang.common.SimpleDateFormatUtil;
+import org.opendaylight.yangtools.yang.common.YangVersion;
import org.opendaylight.yangtools.yang.model.api.Module;
import org.opendaylight.yangtools.yang.model.api.ModuleImport;
-import org.opendaylight.yangtools.yang.model.api.SchemaContext;
-import org.opendaylight.yangtools.yang.parser.builder.impl.ModuleBuilder;
-import org.opendaylight.yangtools.yang.parser.util.TopologicalSort.Node;
import org.opendaylight.yangtools.yang.parser.util.TopologicalSort.NodeImpl;
import org.slf4j.Logger;
import org.slf4j.LoggerFactory;
-import com.google.common.annotations.VisibleForTesting;
-import com.google.common.base.Function;
-import com.google.common.collect.Lists;
-import com.google.common.collect.Maps;
-import com.google.common.collect.Sets;
-
/**
- * Creates a module dependency graph from provided {@link ModuleBuilder}s and
- * provides a {@link #sort(ModuleBuilder...)} method. It is topological sort and
+ * Creates a module dependency graph from provided {@link Module}s and
+ * provides a {@link #sort(Module...)} method. It is topological sort and
* returns modules in order in which they should be processed (e.g. if A imports
* B, sort returns {B, A}).
*/
public final class ModuleDependencySort {
- private static final Date DEFAULT_REVISION = new Date(0);
- private static final Logger LOGGER = LoggerFactory.getLogger(ModuleDependencySort.class);
+ private static final Date DEFAULT_REVISION = SimpleDateFormatUtil.DEFAULT_DATE_REV;
+ private static final Logger LOG = LoggerFactory.getLogger(ModuleDependencySort.class);
/**
* It is not desirable to instance this class
}
/**
- * Extracts {@link ModuleBuilder} from a {@link ModuleNodeImpl}.
- */
- private static final Function<Node, ModuleBuilder> NODE_TO_MODULEBUILDER = new Function<Node, ModuleBuilder>() {
- @Override
- public ModuleBuilder apply(final Node input) {
- // Cast to ModuleBuilder from Node and return
- return (ModuleBuilder) ((ModuleNodeImpl) input).getReference();
- }
- };
-
- /**
- * Topological sort of module builder dependency graph.
+ * Topological sort of module dependency graph.
*
- * @return Sorted list of Module builders. Modules can be further processed
- * in returned order.
+ * @param modules YANG modules
+ * @return Sorted list of Modules. Modules can be further processed in
+ * returned order.
*/
- public static List<ModuleBuilder> sort(final ModuleBuilder... builders) {
- List<Node> sorted = sortInternal(Arrays.asList(builders));
- return Lists.transform(sorted, NODE_TO_MODULEBUILDER);
- }
-
- public static List<ModuleBuilder> sort(final Collection<ModuleBuilder> builders) {
- ModuleBuilder[] array = new ModuleBuilder[builders.size()];
- builders.toArray(array);
- return sort(array);
- }
-
- public static List<ModuleBuilder> sortWithContext(final SchemaContext context, final ModuleBuilder... builders) {
- List<Object> modules = new ArrayList<Object>();
- Collections.addAll(modules, builders);
- modules.addAll(context.getModules());
-
- List<Node> sorted = sortInternal(modules);
- // Cast to ModuleBuilder from Node if possible and return
- return Lists.transform(sorted, new Function<Node, ModuleBuilder>() {
-
- @Override
- public ModuleBuilder apply(final Node input) {
- if (((ModuleNodeImpl) input).getReference() instanceof ModuleBuilder) {
- return (ModuleBuilder) ((ModuleNodeImpl) input).getReference();
- } else {
- return null;
- }
- }
- });
+ public static List<Module> sort(final Module... modules) {
+ return sort(Arrays.asList(modules));
}
/**
* Topological sort of module dependency graph.
*
+ * @param modules YANG modules
* @return Sorted list of Modules. Modules can be further processed in
* returned order.
*/
- public static List<Module> sort(final Module... modules) {
- List<Node> sorted = sortInternal(Arrays.asList(modules));
+ public static List<Module> sort(final Iterable<Module> modules) {
+ final List<TopologicalSort.Node> sorted = sortInternal(modules);
// Cast to Module from Node and return
- return Lists.transform(sorted, new Function<Node, Module>() {
-
- @Override
- public Module apply(final Node input) {
- return (Module) ((ModuleNodeImpl) input).getReference();
- }
- });
+ return Lists.transform(sorted, input -> input == null ? null : ((ModuleNodeImpl) input).getReference());
}
- private static List<Node> sortInternal(final List<?> modules) {
- Map<String, Map<Date, ModuleNodeImpl>> moduleGraph = createModuleGraph(modules);
+ private static List<TopologicalSort.Node> sortInternal(final Iterable<Module> modules) {
+ final Map<String, Map<Date, ModuleNodeImpl>> moduleGraph = createModuleGraph(modules);
- Set<Node> nodes = Sets.newHashSet();
- for (Map<Date, ModuleNodeImpl> map : moduleGraph.values()) {
- for (ModuleNodeImpl node : map.values()) {
- nodes.add(node);
- }
+ final Set<TopologicalSort.Node> nodes = new HashSet<>();
+ for (final Map<Date, ModuleNodeImpl> map : moduleGraph.values()) {
+ nodes.addAll(map.values());
}
return TopologicalSort.sort(nodes);
}
@VisibleForTesting
- static Map<String, Map<Date, ModuleNodeImpl>> createModuleGraph(final List<?> builders) {
- Map<String, Map<Date, ModuleNodeImpl>> moduleGraph = Maps.newHashMap();
+ static Map<String, Map<Date, ModuleNodeImpl>> createModuleGraph(final Iterable<Module> builders) {
+ final Map<String, Map<Date, ModuleNodeImpl>> moduleGraph = new HashMap<>();
processModules(moduleGraph, builders);
processDependencies(moduleGraph, builders);
/**
* Extract module:revision from module builders
*/
- private static void processDependencies(final Map<String, Map<Date, ModuleNodeImpl>> moduleGraph, final List<?> builders) {
- Map<URI, Object> allNS = new HashMap<>();
+ private static void processDependencies(final Map<String, Map<Date, ModuleNodeImpl>> moduleGraph,
+ final Iterable<Module> mmbs) {
+ final Map<URI, Module> allNS = new HashMap<>();
// Create edges in graph
- for (Object mb : builders) {
- Map<String, Date> imported = Maps.newHashMap();
-
- String fromName = null;
- Date fromRevision = null;
- Set<ModuleImport> imports = null;
- URI ns = null;
-
- if (mb instanceof Module) {
- fromName = ((Module) mb).getName();
- fromRevision = ((Module) mb).getRevision();
- imports = ((Module) mb).getImports();
- ns = ((Module)mb).getNamespace();
- } else if (mb instanceof ModuleBuilder) {
- fromName = ((ModuleBuilder) mb).getName();
- fromRevision = ((ModuleBuilder) mb).getRevision();
- imports = ((ModuleBuilder) mb).getModuleImports();
- ns = ((ModuleBuilder)mb).getNamespace();
- }
+ for (final Module module : mmbs) {
+ final Map<String, Date> imported = new HashMap<>();
+ final String fromName = module.getName();
+ final URI ns = module.getNamespace();
+ Date fromRevision = module.getRevision();
// check for existence of module with same namespace
- if (allNS.containsKey(ns)) {
- Object mod = allNS.get(ns);
- String name = null;
- Date revision = null;
- if (mod instanceof Module) {
- name = ((Module) mod).getName();
- revision = ((Module) mod).getRevision();
- } else if (mod instanceof ModuleBuilder) {
- name = ((ModuleBuilder) mod).getName();
- revision = ((ModuleBuilder) mod).getRevision();
- }
- if (!(fromName.equals(name))) {
- LOGGER.warn(
- "Error while sorting module [{}, {}]: module with same namespace ({}) already loaded: [{}, {}]",
- fromName, fromRevision, ns, name, revision);
+ final Module prev = allNS.putIfAbsent(ns, module);
+ if (prev != null) {
+ final String name = prev.getName();
+ if (!fromName.equals(name)) {
+ LOG.warn("Error while sorting module [{}, {}]: module with same namespace ({}) already loaded:"
+ + " [{}, {}]", fromName, fromRevision, ns, name, prev.getRevision());
}
- } else {
- allNS.put(ns, mb);
}
// no need to check if other Type of object, check is performed in
fromRevision = DEFAULT_REVISION;
}
- for (ModuleImport imprt : imports) {
- String toName = imprt.getModuleName();
- Date toRevision = imprt.getRevision() == null ? DEFAULT_REVISION : imprt.getRevision();
+ for (final ModuleImport imprt : module.getImports()) {
+ final String toName = imprt.getModuleName();
+ final Date toRevision = imprt.getRevision() == null ? DEFAULT_REVISION : imprt.getRevision();
- ModuleNodeImpl from = moduleGraph.get(fromName).get(fromRevision);
+ final ModuleNodeImpl from = moduleGraph.get(fromName).get(fromRevision);
- ModuleNodeImpl to = getModuleByNameAndRevision(moduleGraph, fromName, fromRevision, toName, toRevision);
+ final ModuleNodeImpl to = getModuleByNameAndRevision(moduleGraph, fromName, fromRevision, toName, toRevision);
/*
- * Check imports: If module is imported twice with different
+ * If it is an yang 1 module, check imports: If module is imported twice with different
* revisions then throw exception
*/
- if (imported.get(toName) != null && !imported.get(toName).equals(toRevision)
- && !imported.get(toName).equals(DEFAULT_REVISION) && !toRevision.equals(DEFAULT_REVISION)) {
- ex(String.format("Module:%s imported twice with different revisions:%s, %s", toName,
- formatRevDate(imported.get(toName)), formatRevDate(toRevision)));
+ if (YangVersion.VERSION_1.toString().equals(module.getYangVersion())) {
+ final Date impRevision = imported.get(toName);
+ if (impRevision != null && !impRevision.equals(toRevision)
+ && !DEFAULT_REVISION.equals(impRevision) && !DEFAULT_REVISION.equals(toRevision)) {
+ throw new YangValidationException(String.format(
+ "Module:%s imported twice with different revisions:%s, %s", toName,
+ formatRevDate(impRevision), formatRevDate(toRevision)));
+ }
}
imported.put(toName, toRevision);
*/
private static ModuleNodeImpl getModuleByNameAndRevision(final Map<String, Map<Date, ModuleNodeImpl>> moduleGraph,
final String fromName, final Date fromRevision, final String toName, final Date toRevision) {
- ModuleNodeImpl to = null;
-
- if (moduleGraph.get(toName) == null || !moduleGraph.get(toName).containsKey(toRevision)) {
- // If revision is not specified in import, but module exists
- // with different revisions, take first
- if (moduleGraph.get(toName) != null && !moduleGraph.get(toName).isEmpty()
- && toRevision.equals(DEFAULT_REVISION)) {
- to = moduleGraph.get(toName).values().iterator().next();
- LOGGER.debug(String
- .format("Import:%s:%s by module:%s:%s does not specify revision, using:%s:%s for module dependency sort",
- toName, formatRevDate(toRevision), fromName, formatRevDate(fromRevision), to.getName(),
- formatRevDate(to.getRevision())));
- } else {
- LOGGER.warn(String.format("Not existing module imported:%s:%s by:%s:%s", toName,
- formatRevDate(toRevision), fromName, formatRevDate(fromRevision)));
- LOGGER.warn("Available models: {}", moduleGraph);
- ex(String.format("Not existing module imported:%s:%s by:%s:%s", toName, formatRevDate(toRevision),
- fromName, formatRevDate(fromRevision)));
+
+ final Map<Date, ModuleNodeImpl> modulerevs = moduleGraph.get(toName);
+ if (modulerevs != null) {
+ final ModuleNodeImpl exact = modulerevs.get(toRevision);
+ if (exact != null) {
+ return exact;
+ }
+
+ // If revision is not specified in import, but module exists with different revisions, take first one
+ if (DEFAULT_REVISION.equals(toRevision) && !modulerevs.isEmpty()) {
+ final ModuleNodeImpl first = modulerevs.values().iterator().next();
+ if (LOG.isTraceEnabled()) {
+ LOG.trace("Import:{}:{} by module:{}:{} does not specify revision, using:{}:{}"
+ + " for module dependency sort", toName, formatRevDate(toRevision), fromName,
+ formatRevDate(fromRevision), first.getName(), formatRevDate(first.getRevision()));
+ }
+ return first;
}
- } else {
- to = moduleGraph.get(toName).get(toRevision);
}
- return to;
- }
- private static void ex(final String message) {
- throw new YangValidationException(message);
+ LOG.warn("Not existing module imported:{}:{} by:{}:{}", toName, formatRevDate(toRevision), fromName,
+ formatRevDate(fromRevision));
+ LOG.warn("Available models: {}", moduleGraph);
+ throw new YangValidationException(String.format("Not existing module imported:%s:%s by:%s:%s", toName,
+ formatRevDate(toRevision), fromName, formatRevDate(fromRevision)));
}
/**
* Extract dependencies from module builders or modules to fill dependency
* graph
*/
- private static void processModules(final Map<String, Map<Date, ModuleNodeImpl>> moduleGraph, final List<?> builders) {
+ private static void processModules(final Map<String, Map<Date, ModuleNodeImpl>> moduleGraph,
+ final Iterable<Module> modules) {
// Process nodes
- for (Object mb : builders) {
-
- String name = null;
- Date rev = null;
-
- if (mb instanceof Module) {
- name = ((Module) mb).getName();
- rev = ((Module) mb).getRevision();
- } else if (mb instanceof ModuleBuilder) {
- name = ((ModuleBuilder) mb).getName();
- rev = ((ModuleBuilder) mb).getRevision();
- } else {
- throw new IllegalStateException(String.format(
- "Unexpected type of node for sort, expected only:%s, %s, got:%s", Module.class,
- ModuleBuilder.class, mb.getClass()));
- }
+ for (final Module momb : modules) {
+ final String name = momb.getName();
+ Date rev = momb.getRevision();
if (rev == null) {
rev = DEFAULT_REVISION;
}
- if (moduleGraph.get(name) == null) {
- moduleGraph.put(name, Maps.<Date, ModuleNodeImpl> newHashMap());
- }
-
- if (moduleGraph.get(name).get(rev) != null) {
- ex(String.format("Module:%s with revision:%s declared twice", name, formatRevDate(rev)));
+ final Map<Date, ModuleNodeImpl> revs = moduleGraph.computeIfAbsent(name, key -> new HashMap<>(2));
+ if (revs.containsKey(rev)) {
+ throw new YangValidationException(String.format("Module:%s with revision:%s declared twice", name,
+ formatRevDate(rev)));
}
- moduleGraph.get(name).put(rev, new ModuleNodeImpl(name, rev, mb));
+ revs.put(rev, new ModuleNodeImpl(name, rev, momb));
}
}
static class ModuleNodeImpl extends NodeImpl {
private final String name;
private final Date revision;
- private final Object originalObject;
+ private final Module originalObject;
- public ModuleNodeImpl(final String name, final Date revision, final Object builder) {
+ public ModuleNodeImpl(final String name, final Date revision, final Module module) {
this.name = name;
this.revision = revision;
- this.originalObject = builder;
+ this.originalObject = module;
}
public String getName() {
public int hashCode() {
final int prime = 31;
int result = 1;
- result = prime * result + ((name == null) ? 0 : name.hashCode());
- result = prime * result + ((revision == null) ? 0 : revision.hashCode());
+ result = prime * result + Objects.hashCode(name);
+ result = prime * result + Objects.hashCode(revision);
return result;
}
if (getClass() != obj.getClass()) {
return false;
}
- ModuleNodeImpl other = (ModuleNodeImpl) obj;
+ final ModuleNodeImpl other = (ModuleNodeImpl) obj;
if (name == null) {
if (other.name != null) {
return false;
return "Module [name=" + name + ", revision=" + formatRevDate(revision) + "]";
}
- public Object getReference() {
+ public Module getReference() {
return originalObject;
}
Code Review / yangtools.git / blobdiff