bundle-plugin/src/main/java/com/yahoo/container/plugin/classanalysis/Packages.java


1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64

// Copyright Vespa.ai. Licensed under the terms of the Apache 2.0 license. See LICENSE in the project root.
package com.yahoo.container.plugin.classanalysis;

import com.yahoo.container.plugin.osgi.ImportPackages;

import java.util.HashSet;
import java.util.List;
import java.util.Map;
import java.util.Set;

/**
 * Utility methods related to packages.
 *
 * @author Tony Vaagenes
 * @author ollivir
 */
public class Packages {

    public static class PackageMetaData {
        public final Set<String> definedPackages;
        public final Set<String> referencedExternalPackages;

        public PackageMetaData(Set<String> definedPackages, Set<String> referencedExternalPackages) {
            this.definedPackages = definedPackages;
            this.referencedExternalPackages = referencedExternalPackages;
        }
    }

    public static String packageName(String fullClassName) {
        int index = fullClassName.lastIndexOf('.');
        if (index == -1) {
            return "";
        } else {
            return fullClassName.substring(0, index);
        }
    }

    /**
     * Returns a sorted list of the imported packages that exist in the given set of disallowed packages.
     */
    public static List<String> disallowedImports(Map<String, ImportPackages.Import> imports, List<String> disallowed) {
        if (imports == null || imports.isEmpty()) return List.of();

        var importedSet = new HashSet<>(imports.keySet());
        var disallowedSet = disallowed == null ? Set.of() : new HashSet<>(disallowed);

        return importedSet.stream()
                .filter(disallowedSet::contains)
                .sorted()
                .toList();
    }

    public static PackageMetaData analyzePackages(Set<ClassFileMetaData> allClasses) {
        Set<String> definedPackages = new HashSet<>();
        Set<String> referencedPackages = new HashSet<>();
        for (ClassFileMetaData metaData : allClasses) {
            definedPackages.add(packageName(metaData.getName()));
            metaData.getReferencedClasses().forEach(className -> referencedPackages.add(packageName(className)));
        }
        referencedPackages.removeAll(definedPackages);
        return new PackageMetaData(definedPackages, referencedPackages);
    }

}