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
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
|
// Copyright Yahoo. Licensed under the terms of the Apache 2.0 license. See LICENSE in the project root.
package com.yahoo.container.plugin;
import com.yahoo.vespa.config.VespaVersion;
import org.junit.jupiter.api.BeforeEach;
import org.junit.jupiter.api.Test;
import java.io.File;
import java.io.IOException;
import java.nio.file.Files;
import java.nio.file.Path;
import java.nio.file.Paths;
import java.util.Arrays;
import java.util.Enumeration;
import java.util.List;
import java.util.jar.Attributes;
import java.util.jar.JarEntry;
import java.util.jar.JarFile;
import java.util.jar.Manifest;
import java.util.regex.Pattern;
import java.util.stream.Collectors;
import java.util.zip.ZipEntry;
import static org.junit.jupiter.api.Assertions.assertEquals;
import static org.junit.jupiter.api.Assertions.assertNotNull;
import static org.junit.jupiter.api.Assertions.assertTrue;
/**
* Verifies the bundle jar file built and its manifest.
*
* @author Tony Vaagenes
*/
public class BundleTest {
static final String TEST_BUNDLE_PATH = System.getProperty("test.bundle.path", ".") + "/";
// If bundle-plugin-test is compiled in a mvn command that also built dependencies, e.g. 'defaults',
// the artifact is defaults.jar, otherwise the installed and versioned artifact
// is used: defaults-7-SNAPSHOT.jar or e.g. defaults-7.123.45.jar.
private static final String snapshotOrVersionOrNone = "(-\\d+((-SNAPSHOT)|((\\.\\d+(\\.\\d+)?)?))?)?\\.jar";
private JarFile jarFile;
private Attributes mainAttributes;
@BeforeEach
public void setup() {
try {
File componentJar = findBundleJar("main");
jarFile = new JarFile(componentJar);
Manifest manifest = jarFile.getManifest();
mainAttributes = manifest.getMainAttributes();
} catch (IOException e) {
throw new RuntimeException(e);
}
}
static File findBundleJar(String bundleName) {
Path bundlePath = Paths.get(TEST_BUNDLE_PATH, bundleName + "-bundle.jar");
if (! Files.exists(bundlePath)) {
throw new RuntimeException("Failed finding component jar file: " + bundlePath);
}
return bundlePath.toFile();
}
@Test
void require_that_bundle_version_is_added_to_manifest() {
String bundleVersion = mainAttributes.getValue("Bundle-Version");
// Because of snapshot builds, we can only verify the major version.
int majorBundleVersion = Integer.valueOf(bundleVersion.substring(0, bundleVersion.indexOf('.')));
assertEquals(VespaVersion.major, majorBundleVersion);
}
@Test
void require_that_bundle_symbolic_name_matches_pom_artifactId() {
assertEquals("main", mainAttributes.getValue("Bundle-SymbolicName"));
}
@Test
void require_that_manifest_contains_inferred_imports() {
String importPackage = mainAttributes.getValue("Import-Package");
// From SimpleSearcher
assertTrue(importPackage.contains("com.yahoo.prelude.hitfield"));
// From SimpleSearcher2
assertTrue(importPackage.contains("com.yahoo.processing"));
assertTrue(importPackage.contains("com.yahoo.metrics.simple"));
assertTrue(importPackage.contains("com.google.inject"));
}
@Test
void require_that_manifest_contains_manual_imports() {
String importPackage = mainAttributes.getValue("Import-Package");
assertTrue(importPackage.contains("manualImport.withoutVersion"));
assertTrue(importPackage.contains("manualImport.withVersion;version=\"12.3.4\""));
for (int i = 1; i <= 2; ++i)
assertTrue(importPackage.contains("multiple.packages.with.the.same.version" + i + ";version=\"[1,2)\""));
}
@Test
void require_that_manifest_contains_exports() {
String exportPackage = mainAttributes.getValue("Export-Package");
assertTrue(exportPackage.contains("com.yahoo.test;version=1.2.3.RELEASE"));
}
@Test
void require_that_manifest_contains_public_api_for_this_bundle_and_embedded_bundles() {
var publicApiAttribute = mainAttributes.getValue("X-JDisc-PublicApi-Package");
assertNotNull(publicApiAttribute);
var publicApi = Arrays.stream(publicApiAttribute.split(",")).collect(Collectors.toSet());
var expected = List.of("ai.vespa.lib.public_api", "com.yahoo.lib.public_api", "com.yahoo.test");
assertEquals(expected.size(), publicApi.size());
expected.forEach(pkg -> assertTrue(publicApi.contains(pkg), "Public api did not contain %s".formatted(pkg)));
}
@Test
void require_that_manifest_contains_non_public_api_for_this_bundle_and_embedded_bundles() {
var nonPublicApiAttribute = mainAttributes.getValue("X-JDisc-Non-PublicApi-Export-Package");
assertNotNull(nonPublicApiAttribute);
var nonPublicApi = Arrays.stream(nonPublicApiAttribute.split(",")).collect(Collectors.toSet());
var expected = List.of("ai.vespa.internal", "ai.vespa.lib.non_public", "com.yahoo.lib.non_public", "com.yahoo.non_public");
assertEquals(expected.size(), nonPublicApi.size());
expected.forEach(pkg -> assertTrue(nonPublicApi.contains(pkg), "Non-public api did not contain %s".formatted(pkg)));
}
@Test
void require_that_manifest_contains_bundle_class_path() {
String bundleClassPath = mainAttributes.getValue("Bundle-ClassPath");
assertTrue(bundleClassPath.contains(".,"));
Pattern jrtPattern = Pattern.compile("dependencies/export-packages-lib" + snapshotOrVersionOrNone);
assertTrue(jrtPattern.matcher(bundleClassPath).find(), "Bundle class path did not contain 'export-packages-lib''.");
}
@Test
void require_that_component_jar_file_contains_compile_artifacts() {
String requiredDep = "dependencies/export-packages-lib";
Pattern depPattern = Pattern.compile(requiredDep + snapshotOrVersionOrNone);
ZipEntry depEntry = null;
Enumeration<JarEntry> entries = jarFile.entries();
while (entries.hasMoreElements()) {
var e = entries.nextElement();
if (e.getName().startsWith(requiredDep)) {
if (depPattern.matcher(e.getName()).matches()) {
depEntry = e;
break;
}
}
}
assertNotNull(depEntry, "Component jar file did not contain 'export-packages-lib' dependency.");
}
@Test
void require_that_web_inf_url_is_propagated_to_the_manifest() {
String webInfUrl = mainAttributes.getValue("WebInfUrl");
assertTrue(webInfUrl.contains("/WEB-INF/web.xml"));
}
}
|
