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
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
|
// Copyright Vespa.ai. Licensed under the terms of the Apache 2.0 license. See LICENSE in the project root.
package com.yahoo.vespa.model.application.validation;
import com.yahoo.config.model.deploy.DeployState;
import org.w3c.dom.Document;
import java.util.ArrayList;
import java.util.Arrays;
import java.util.Collection;
import java.util.HashMap;
import java.util.HashSet;
import java.util.List;
import java.util.Map;
import java.util.Set;
import java.util.function.Predicate;
import java.util.jar.Attributes;
import java.util.jar.JarFile;
import java.util.jar.Manifest;
import java.util.logging.Level;
import java.util.regex.Pattern;
/**
* A validator for bundles.
*
* @author hmusum
* @author bjorncs
*/
public class BundleValidator extends AbstractBundleValidator {
public BundleValidator() {}
@Override
protected void validateManifest(DeployState state, JarFile jar, Manifest mf) {
// Check for required OSGI headers
Attributes attributes = mf.getMainAttributes();
HashSet<String> mfAttributes = new HashSet<>();
for (Map.Entry<Object,Object> entry : attributes.entrySet()) {
mfAttributes.add(entry.getKey().toString());
}
List<String> requiredOSGIHeaders = Arrays.asList(
"Bundle-ManifestVersion", "Bundle-Name", "Bundle-SymbolicName", "Bundle-Version");
for (String header : requiredOSGIHeaders) {
if (!mfAttributes.contains(header)) {
throw new IllegalArgumentException("Required OSGI header '" + header +
"' was not found in manifest in '" + filename(jar) + "'");
}
}
if (attributes.getValue("Bundle-Version").endsWith(".SNAPSHOT")) {
log(state, Level.WARNING,
"Deploying snapshot bundle " + filename(jar) + ".\nTo use this bundle, you must include the " +
"qualifier 'SNAPSHOT' in the version specification in services.xml.");
}
if (attributes.getValue("Import-Package") != null) {
validateImportedPackages(state, jar, mf);
}
}
@Override protected void validatePomXml(DeployState state, JarFile jar, Document pom) {}
private void validateImportedPackages(DeployState state, JarFile jar, Manifest manifest) {
Map<DeprecatedProvidedBundle, List<String>> deprecatedPackagesInUse = new HashMap<>();
forEachImportPackage(manifest, (packageName) -> {
for (DeprecatedProvidedBundle deprecatedBundle : DeprecatedProvidedBundle.values()) {
for (Predicate<String> matcher : deprecatedBundle.javaPackageMatchers) {
if (matcher.test(packageName)) {
deprecatedPackagesInUse.computeIfAbsent(deprecatedBundle, __ -> new ArrayList<>())
.add(packageName);
}
}
}
});
deprecatedPackagesInUse.forEach((artifact, packagesInUse) -> {
log(state, Level.WARNING, "JAR file '%s' imports the packages %s from '%s'. \n%s",
filename(jar), packagesInUse, artifact.name, artifact.description);
});
}
private enum DeprecatedProvidedBundle {
ORG_JSON("org.json:json",
"This bundle is no longer provided on Vespa 8 - " +
"see https://docs.vespa.ai/en/vespa8-release-notes.html#container-runtime.",
Set.of("org\\.json")),
JETTY("jetty", "The Jetty bundles are no longer provided on Vespa 8 - " +
"see https://docs.vespa.ai/en/vespa8-release-notes.html#container-runtime.",
Set.of("org\\.eclipse\\.jetty.*"));
final String name;
final Collection<Predicate<String>> javaPackageMatchers;
final String description;
DeprecatedProvidedBundle(String name,
String description,
Collection<String> javaPackagePatterns) {
this.name = name;
this.javaPackageMatchers = javaPackagePatterns.stream()
.map(s -> Pattern.compile(s).asMatchPredicate())
.toList();
this.description = description;
}
}
}
|
