org.opendaylight.yangtools.yang2sources.plugin.ScannedDependency Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of yang-maven-plugin Show documentation
This plugin is a wrapper for "yang to source code" generation. It can be configured by a set of third-party code generators and resource providers. For further info see available goals. Sample usage: TODO: add sample usage when finished
There is a newer version: 14.0.5
Show newest version
/*
 * Copyright (c) 2018 Pantheon Technologies, s.r.o. and others.  All rights reserved.
 *
 * This program and the accompanying materials are made available under the
 * terms of the Eclipse Public License v1.0 which accompanies this distribution,
 * and is available at http://www.eclipse.org/legal/epl-v10.html
 */
package org.opendaylight.yangtools.yang2sources.plugin;

import static java.util.Objects.requireNonNull;
import static org.opendaylight.yangtools.yang.common.YangConstants.RFC6020_YANG_FILE_EXTENSION;
import static org.opendaylight.yangtools.yang2sources.plugin.YangToSourcesProcessor.META_INF_YANG_STRING;
import static org.opendaylight.yangtools.yang2sources.plugin.YangToSourcesProcessor.META_INF_YANG_STRING_JAR;

import com.google.common.annotations.VisibleForTesting;
import com.google.common.collect.ImmutableList;
import com.google.common.collect.ImmutableSet;
import com.google.common.io.ByteSource;
import java.io.File;
import java.io.IOException;
import java.nio.charset.StandardCharsets;
import java.util.ArrayList;
import java.util.Arrays;
import java.util.List;
import java.util.zip.ZipEntry;
import java.util.zip.ZipFile;
import org.apache.maven.artifact.Artifact;
import org.apache.maven.project.MavenProject;
import org.eclipse.jdt.annotation.NonNullByDefault;
import org.opendaylight.yangtools.yang.model.api.source.SourceIdentifier;
import org.opendaylight.yangtools.yang.model.api.source.YangTextSource;
import org.opendaylight.yangtools.yang.model.spi.source.DelegatedYangTextSource;
import org.opendaylight.yangtools.yang.model.spi.source.FileYangTextSource;
import org.slf4j.Logger;
import org.slf4j.LoggerFactory;

@NonNullByDefault
abstract class ScannedDependency {
    private static final class Single extends ScannedDependency {
        Single(final File file) {
            super(file);
        }

        @Override
        ImmutableList sources() {
            return ImmutableList.of(new FileYangTextSource(file().toPath()));
        }
    }

    private static final class Zip extends ScannedDependency {
        private final ImmutableSet entryNames;

        Zip(final File file, final ImmutableSet entryNames) {
            super(file);
            this.entryNames = requireNonNull(entryNames);
        }

        @Override
        ImmutableList sources() throws IOException {
            final var builder = ImmutableList.builderWithExpectedSize(entryNames.size());

            try (var zip = new ZipFile(file())) {
                for (var entryName : entryNames) {
                    final var entry = requireNonNull(zip.getEntry(entryName));

                    builder.add(new DelegatedYangTextSource(
                        SourceIdentifier.ofYangFileName(entryName.substring(entryName.lastIndexOf('/') + 1)),
                        ByteSource.wrap(zip.getInputStream(entry).readAllBytes())
                            .asCharSource(StandardCharsets.UTF_8)));
                }
            }

            return builder.build();
        }
    }

    private static final Logger LOG = LoggerFactory.getLogger(ScannedDependency.class);

    private final File file;

    ScannedDependency(final File file) {
        this.file = requireNonNull(file);
    }

    static List scanDependencies(final MavenProject project) throws IOException {
        final List filesOnCp = getClassPath(project);
        LOG.debug("{} Searching for YANG files in dependencies: {}", YangToSourcesProcessor.LOG_PREFIX, filesOnCp);
        LOG.debug("{} Searching for YANG files in {} dependencies", YangToSourcesProcessor.LOG_PREFIX,
            filesOnCp.size());

        final var result = new ArrayList();
        for (File file : filesOnCp) {
            // is it jar file or directory?
            if (file.isDirectory()) {
                final File yangDir = new File(file, META_INF_YANG_STRING);
                if (yangDir.exists() && yangDir.isDirectory()) {
                    result.addAll(scanDirectory(yangDir));
                }
            } else {
                result.addAll(scanZipFile(file));
            }
        }
        return result;
    }

    private static ImmutableList scanDirectory(final File yangDir) {
        return Arrays.stream(yangDir.listFiles(
            (dir, name) -> name.endsWith(RFC6020_YANG_FILE_EXTENSION) && new File(dir, name).isFile()))
                .map(Single::new)
                .collect(ImmutableList.toImmutableList());
    }

    private static ImmutableList scanZipFile(final File zipFile) throws IOException {
        final ImmutableSet entryNames;
        try (ZipFile zip = new ZipFile(zipFile)) {
            entryNames = zip.stream()
                .filter(entry -> {
                    final String entryName = entry.getName();
                    return entryName.startsWith(META_INF_YANG_STRING_JAR) && !entry.isDirectory()
                        && entryName.endsWith(RFC6020_YANG_FILE_EXTENSION);
                })
                .map(ZipEntry::getName)
                .collect(ImmutableSet.toImmutableSet());
        }

        return entryNames.isEmpty() ? ImmutableList.of() : ImmutableList.of(new Zip(zipFile, entryNames));
    }

    // FIXME: java.nio.file.Path
    final File file() {
        return file;
    }

    abstract ImmutableList sources() throws IOException;

    @VisibleForTesting
    static List getClassPath(final MavenProject project) {
        return project.getArtifacts().stream()
            .map(Artifact::getFile)
            .filter(file -> file.isFile() && file.getName().endsWith(".jar") || file.isDirectory())
            .toList();
    }
}