parser/yang-parser-impl/src/main/java/org/opendaylight/yangtools/yang/parser/repo/SemVerDependencyResolver.java

   1 /*
   2  * Copyright (c) 2016 Cisco Systems, Inc. and others.  All rights reserved.
   3  *
   4  * This program and the accompanying materials are made available under the
   5  * terms of the Eclipse Public License v1.0 which accompanies this distribution,
   6  * and is available at http://www.eclipse.org/legal/epl-v10.html
   7  */
   8 package org.opendaylight.yangtools.yang.parser.repo;
   9
  10 import java.util.Collection;
  11 import java.util.Map;
  12 import java.util.Optional;
  13 import org.opendaylight.yangtools.concepts.SemVer;
  14 import org.opendaylight.yangtools.yang.model.api.ModuleImport;
  15 import org.opendaylight.yangtools.yang.model.repo.api.SemVerSourceIdentifier;
  16 import org.opendaylight.yangtools.yang.model.repo.api.SourceIdentifier;
  17 import org.opendaylight.yangtools.yang.parser.api.ImportResolutionMode;
  18 import org.opendaylight.yangtools.yang.parser.api.YangParserConfiguration;
  19 import org.opendaylight.yangtools.yang.parser.rfc7950.repo.YangModelDependencyInfo;
  20
  21 final class SemVerDependencyResolver extends DependencyResolver {
  22     private static final YangParserConfiguration CONFIG = YangParserConfiguration.builder()
  23         .importResolutionMode(ImportResolutionMode.OPENCONFIG_SEMVER)
  24         .build();
  25
  26     SemVerDependencyResolver(final Map<SourceIdentifier, YangModelDependencyInfo> depInfo) {
  27         super(depInfo);
  28     }
  29
  30     protected static SourceIdentifier findCompatibleVersion(final Iterable<SourceIdentifier> haystack,
  31             final ModuleImport mi) {
  32         final String requestedModuleName = mi.getModuleName();
  33         for (SourceIdentifier r : haystack) {
  34             if (requestedModuleName.equals(r.getName())
  35                     && isCompatible(((SemVerSourceIdentifier) r).getSemanticVersion(), mi.getSemanticVersion())) {
  36                 return r;
  37             }
  38         }
  39
  40         return null;
  41     }
  42
  43     private static boolean isCompatible(final Optional<SemVer> moduleSemVer, final Optional<SemVer> importSemVer) {
  44         if (importSemVer.isEmpty()) {
  45             // Import does not care about the version
  46             return true;
  47         }
  48         if (moduleSemVer.isEmpty()) {
  49             // Modules which do not declare a semantic version are incompatible with imports which do
  50             return false;
  51         }
  52
  53         final SemVer modVer = moduleSemVer.get();
  54         final SemVer impVer = importSemVer.get();
  55         return modVer.getMajor() == impVer.getMajor() && modVer.compareTo(impVer) >= 0;
  56     }
  57
  58     @Override
  59     YangParserConfiguration parserConfig() {
  60         return CONFIG;
  61     }
  62
  63     @Override
  64     protected boolean isKnown(final Collection<SourceIdentifier> haystack, final ModuleImport mi) {
  65         final SemVerSourceIdentifier msi = SemVerSourceIdentifier.create(mi.getModuleName(), mi.getRevision(),
  66             mi.getSemanticVersion().orElse(null));
  67
  68         // Quick lookup
  69         if (haystack.contains(msi)) {
  70             return true;
  71         }
  72
  73         // Slow revision-less walk
  74         return findCompatibleVersion(haystack, mi) != null;
  75     }
  76
  77     public static SemVerDependencyResolver create(final Map<SourceIdentifier, YangModelDependencyInfo> depInfo) {
  78         return new SemVerDependencyResolver(depInfo);
  79     }
  80 }