BUG-4688: Make SourceIdentifier use Revision
[yangtools.git] / yang / yang-parser-impl / src / main / java / org / opendaylight / yangtools / yang / parser / repo / YangTextSchemaContextResolver.java
index 32cf1529a0248997a14a1377476a11bf34c9b25b..5520c5e3e9dff9e78be5de9f36f516c44dead501 100644 (file)
@@ -8,31 +8,39 @@
 package org.opendaylight.yangtools.yang.parser.repo;
 
 import static com.google.common.base.Preconditions.checkArgument;
+
+import com.google.common.annotations.Beta;
 import com.google.common.base.MoreObjects.ToStringHelper;
-import com.google.common.base.Optional;
 import com.google.common.base.Preconditions;
+import com.google.common.base.Verify;
 import com.google.common.collect.ArrayListMultimap;
 import com.google.common.collect.ImmutableSet;
 import com.google.common.collect.Multimap;
-import com.google.common.util.concurrent.CheckedFuture;
 import com.google.common.util.concurrent.Futures;
+import com.google.common.util.concurrent.ListenableFuture;
 import java.io.IOException;
 import java.io.InputStream;
 import java.net.URL;
 import java.util.Collection;
+import java.util.Optional;
 import java.util.Set;
 import java.util.concurrent.ConcurrentLinkedDeque;
+import java.util.concurrent.ExecutionException;
+import java.util.concurrent.TimeUnit;
 import java.util.concurrent.atomic.AtomicReference;
 import javax.annotation.Nonnull;
+import org.opendaylight.yangtools.yang.common.Revision;
 import org.opendaylight.yangtools.yang.model.api.SchemaContext;
 import org.opendaylight.yangtools.yang.model.parser.api.YangSyntaxErrorException;
 import org.opendaylight.yangtools.yang.model.repo.api.MissingSchemaSourceException;
+import org.opendaylight.yangtools.yang.model.repo.api.RevisionSourceIdentifier;
 import org.opendaylight.yangtools.yang.model.repo.api.SchemaContextFactory;
 import org.opendaylight.yangtools.yang.model.repo.api.SchemaRepository;
 import org.opendaylight.yangtools.yang.model.repo.api.SchemaResolutionException;
 import org.opendaylight.yangtools.yang.model.repo.api.SchemaSourceException;
 import org.opendaylight.yangtools.yang.model.repo.api.SchemaSourceFilter;
 import org.opendaylight.yangtools.yang.model.repo.api.SourceIdentifier;
+import org.opendaylight.yangtools.yang.model.repo.api.StatementParserMode;
 import org.opendaylight.yangtools.yang.model.repo.api.YangTextSchemaSource;
 import org.opendaylight.yangtools.yang.model.repo.spi.PotentialSchemaSource;
 import org.opendaylight.yangtools.yang.model.repo.spi.PotentialSchemaSource.Costs;
@@ -48,11 +56,12 @@ import org.slf4j.LoggerFactory;
 
 public final class YangTextSchemaContextResolver implements AutoCloseable, SchemaSourceProvider<YangTextSchemaSource> {
     private static final Logger LOG = LoggerFactory.getLogger(YangTextSchemaContextResolver.class);
+    private static final long SOURCE_LIFETIME_SECONDS = 60;
 
     private final Collection<SourceIdentifier> requiredSources = new ConcurrentLinkedDeque<>();
     private final Multimap<SourceIdentifier, YangTextSchemaSource> texts = ArrayListMultimap.create();
     private final AtomicReference<Optional<SchemaContext>> currentSchemaContext =
-            new AtomicReference<>(Optional.<SchemaContext>absent());
+            new AtomicReference<>(Optional.empty());
     private final InMemorySchemaSourceCache<ASTSchemaSource> cache;
     private final SchemaListenerRegistration transReg;
     private final SchemaSourceRegistry registry;
@@ -67,7 +76,8 @@ public final class YangTextSchemaContextResolver implements AutoCloseable, Schem
         final TextToASTTransformer t = TextToASTTransformer.create(repository, registry);
         transReg = registry.registerSchemaSourceListener(t);
 
-        cache = InMemorySchemaSourceCache.createSoftCache(registry, ASTSchemaSource.class);
+        cache = InMemorySchemaSourceCache.createSoftCache(registry, ASTSchemaSource.class, SOURCE_LIFETIME_SECONDS,
+            TimeUnit.SECONDS);
     }
 
     public static YangTextSchemaContextResolver create(final String name) {
@@ -79,16 +89,16 @@ public final class YangTextSchemaContextResolver implements AutoCloseable, Schem
      * Register a {@link YangTextSchemaSource}.
      *
      * @param source YANG text source
+     * @return a YangTextSchemaSourceRegistration
      * @throws YangSyntaxErrorException When the YANG file is syntactically invalid
      * @throws IOException when the URL is not readable
      * @throws SchemaSourceException When parsing encounters general error
-     * @return a YangTextSchemaSourceRegistration
      */
     public YangTextSchemaSourceRegistration registerSource(@Nonnull final YangTextSchemaSource source)
             throws SchemaSourceException, IOException, YangSyntaxErrorException {
         checkArgument(source != null);
 
-        final ASTSchemaSource ast = TextToASTTransformer.TRANSFORMATION.apply(source).checkedGet();
+        final ASTSchemaSource ast = TextToASTTransformer.transformText(source);
         LOG.trace("Resolved source {} to source {}", source, ast);
 
         // AST carries an accurate identifier, check if it matches the one supplied by the source. If it
@@ -98,12 +108,12 @@ public final class YangTextSchemaContextResolver implements AutoCloseable, Schem
         final YangTextSchemaSource text;
         if (!parsedId.equals(providedId)) {
             if (!parsedId.getName().equals(providedId.getName())) {
-                LOG.info("Provided module name {} does not match actual text {}, corrected", providedId.toYangFilename(),
-                    parsedId.toYangFilename());
+                LOG.info("Provided module name {} does not match actual text {}, corrected",
+                    providedId.toYangFilename(), parsedId.toYangFilename());
             } else {
-                final String sourceRev = providedId.getRevision();
-                final String astRev = parsedId.getRevision();
-                if (sourceRev != null) {
+                final Optional<Revision> sourceRev = providedId.getRevision();
+                final Optional<Revision> astRev = parsedId.getRevision();
+                if (sourceRev.isPresent()) {
                     if (!sourceRev.equals(astRev)) {
                         LOG.info("Provided module revision {} does not match actual text {}, corrected",
                             providedId.toYangFilename(), parsedId.toYangFilename());
@@ -148,15 +158,18 @@ public final class YangTextSchemaContextResolver implements AutoCloseable, Schem
      * Register a URL containing a YANG text.
      *
      * @param url YANG text source URL
+     * @return a YangTextSchemaSourceRegistration for this URL
      * @throws YangSyntaxErrorException When the YANG file is syntactically invalid
      * @throws IOException when the URL is not readable
      * @throws SchemaSourceException When parsing encounters general error
-     * @return a YangTextSchemaSourceRegistration for this URL
      */
-    public YangTextSchemaSourceRegistration registerSource(@Nonnull final URL url) throws SchemaSourceException, IOException, YangSyntaxErrorException {
+    public YangTextSchemaSourceRegistration registerSource(@Nonnull final URL url) throws SchemaSourceException,
+            IOException, YangSyntaxErrorException {
         checkArgument(url != null, "Supplied URL must not be null");
 
-        final SourceIdentifier guessedId = new SourceIdentifier(url.getFile(), Optional.<String>absent());
+        final String path = url.getPath();
+        final String fileName = path.substring(path.lastIndexOf('/') + 1);
+        final SourceIdentifier guessedId = guessSourceIdentifier(fileName);
         return registerSource(new YangTextSchemaSource(guessedId) {
             @Override
             public InputStream openStream() throws IOException {
@@ -170,15 +183,36 @@ public final class YangTextSchemaContextResolver implements AutoCloseable, Schem
         });
     }
 
+    private static SourceIdentifier guessSourceIdentifier(final String fileName) {
+        try {
+            return YangTextSchemaSource.identifierFromFilename(fileName);
+        } catch (IllegalArgumentException e) {
+            LOG.warn("Invalid file name format in '{}'", fileName, e);
+            return RevisionSourceIdentifier.create(fileName);
+        }
+    }
+
     /**
      * Try to parse all currently available yang files and build new schema context.
+     *
      * @return new schema context iif there is at least 1 yang file registered and
      *         new schema context was successfully built.
      */
     public Optional<SchemaContext> getSchemaContext() {
+        return getSchemaContext(StatementParserMode.DEFAULT_MODE);
+    }
+
+    /**
+     * Try to parse all currently available yang files and build new schema context depending on specified parsing mode.
+     *
+     * @param statementParserMode mode of statement parser
+     * @return new schema context iif there is at least 1 yang file registered and
+     *         new schema context was successfully built.
+     */
+    public Optional<SchemaContext> getSchemaContext(final StatementParserMode statementParserMode) {
         final SchemaContextFactory factory = repository.createSchemaContextFactory(SchemaSourceFilter.ALWAYS_ACCEPT);
         Optional<SchemaContext> sc;
-        Object v;
+        Object ver;
         do {
             // Spin get stable context version
             Object cv;
@@ -193,18 +227,22 @@ public final class YangTextSchemaContextResolver implements AutoCloseable, Schem
             // Version has been updated
             Collection<SourceIdentifier> sources;
             do {
-                v = version;
+                ver = version;
                 sources = ImmutableSet.copyOf(requiredSources);
-            } while (v != version);
+            } while (ver != version);
 
             while (true) {
-                final CheckedFuture<SchemaContext, SchemaResolutionException> f = factory.createSchemaContext(sources);
+                final ListenableFuture<SchemaContext> f = factory.createSchemaContext(sources, statementParserMode);
                 try {
-                    sc = Optional.of(f.checkedGet());
+                    sc = Optional.of(f.get());
                     break;
-                } catch (SchemaResolutionException e) {
-                    LOG.debug("Failed to fully assemble schema context for {}", sources, e);
-                    sources = e.getResolvedSources();
+                } catch (InterruptedException e) {
+                    throw new RuntimeException("Interrupted while assembling schema context", e);
+                } catch (ExecutionException e) {
+                    LOG.info("Failed to fully assemble schema context for {}", sources, e);
+                    final Throwable cause = e.getCause();
+                    Verify.verify(cause instanceof SchemaResolutionException);
+                    sources = ((SchemaResolutionException) cause).getResolvedSources();
                 }
             }
 
@@ -213,25 +251,26 @@ public final class YangTextSchemaContextResolver implements AutoCloseable, Schem
             synchronized (this) {
                 if (contextVersion == cv) {
                     currentSchemaContext.set(sc);
-                    contextVersion = v;
+                    contextVersion = ver;
                 }
             }
-        } while (version == v);
+        } while (version == ver);
 
         return sc;
     }
 
     @Override
-    public synchronized CheckedFuture<YangTextSchemaSource, SchemaSourceException> getSource(final SourceIdentifier sourceIdentifier) {
+    public synchronized ListenableFuture<YangTextSchemaSource> getSource(
+            final SourceIdentifier sourceIdentifier) {
         final Collection<YangTextSchemaSource> ret = texts.get(sourceIdentifier);
 
         LOG.debug("Lookup {} result {}", sourceIdentifier, ret);
         if (ret.isEmpty()) {
-            return Futures.<YangTextSchemaSource, SchemaSourceException>immediateFailedCheckedFuture(
-                    new MissingSchemaSourceException("URL for " + sourceIdentifier + " not registered", sourceIdentifier));
+            return Futures.immediateFailedFuture(new MissingSchemaSourceException(
+                "URL for " + sourceIdentifier + " not registered", sourceIdentifier));
         }
 
-        return Futures.immediateCheckedFuture(ret.iterator().next());
+        return Futures.immediateFuture(ret.iterator().next());
     }
 
     /**
@@ -243,6 +282,37 @@ public final class YangTextSchemaContextResolver implements AutoCloseable, Schem
         return ImmutableSet.copyOf(texts.keySet());
     }
 
+    @Beta
+    public synchronized Collection<YangTextSchemaSource> getSourceTexts(final SourceIdentifier sourceIdentifier) {
+        return ImmutableSet.copyOf(texts.get(sourceIdentifier));
+    }
+
+    @Beta
+    public SchemaContext trySchemaContext() throws SchemaResolutionException {
+        return trySchemaContext(StatementParserMode.DEFAULT_MODE);
+    }
+
+    @Beta
+    public SchemaContext trySchemaContext(final StatementParserMode statementParserMode)
+            throws SchemaResolutionException {
+        final ListenableFuture<SchemaContext> future = repository
+                .createSchemaContextFactory(SchemaSourceFilter.ALWAYS_ACCEPT)
+                .createSchemaContext(ImmutableSet.copyOf(requiredSources), statementParserMode);
+
+        try {
+            return future.get();
+        } catch (InterruptedException e) {
+            throw new RuntimeException("Interrupted while waiting for SchemaContext assembly", e);
+        } catch (ExecutionException e) {
+            final Throwable cause = e.getCause();
+            if (cause instanceof SchemaResolutionException) {
+                throw (SchemaResolutionException) cause;
+            }
+
+            throw new SchemaResolutionException("Failed to assemble SchemaContext", e);
+        }
+    }
+
     @Override
     public void close() {
         transReg.close();