-
Notifications
You must be signed in to change notification settings - Fork 340
/
JarFileScannerTest.java
152 lines (130 loc) · 6.52 KB
/
JarFileScannerTest.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
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
/*
* Copyright (c) 2012, 2022 Oracle and/or its affiliates. All rights reserved.
*
* This program and the accompanying materials are made available under the
* terms of the Eclipse Public License v. 2.0, which is available at
* http://www.eclipse.org/legal/epl-2.0.
*
* This Source Code may also be made available under the following Secondary
* Licenses when the conditions for such availability set forth in the
* Eclipse Public License v. 2.0 are satisfied: GNU General Public License,
* version 2 with the GNU Classpath Exception, which is available at
* https://www.gnu.org/software/classpath/license.html.
*
* SPDX-License-Identifier: EPL-2.0 OR GPL-2.0 WITH Classpath-exception-2.0
*/
package org.glassfish.jersey.server.internal.scanning;
import java.io.FileInputStream;
import java.io.IOException;
import java.io.InputStream;
import java.util.Enumeration;
import java.util.jar.JarEntry;
import java.util.jar.JarFile;
import java.util.regex.Pattern;
import org.junit.jupiter.api.BeforeEach;
import org.junit.jupiter.api.Test;
import org.junit.jupiter.params.ParameterizedTest;
import org.junit.jupiter.params.provider.ValueSource;
import static org.hamcrest.CoreMatchers.equalTo;
import static org.hamcrest.MatcherAssert.assertThat;
import static org.junit.jupiter.api.Assertions.assertFalse;
import static org.junit.jupiter.api.Assertions.fail;
/**
* @author Martin Snyder
*/
public class JarFileScannerTest {
private String jaxRsApiPath;
@BeforeEach
public void setUp() throws Exception {
final String classPath = System.getProperty("java.class.path");
final String[] entries = classPath.split(System.getProperty("path.separator"));
for (final String entry : entries) {
if (entry.contains("jakarta.ws.rs-api")) {
jaxRsApiPath = entry;
break;
}
}
if (jaxRsApiPath == null) {
fail("Could not find jakarta.ws.rs-api.");
}
}
@Test
public void testRecursiveResourceEnumerationOfAllPackages() throws IOException {
final int actualEntries = countJarEntriesByPattern(Pattern.compile(".*\\.(class|properties|xml|md)"));
final int scannedEntries = countJarEntriesUsingScanner("", true);
assertThat("Failed to enumerate all contents of javax.ws.rs-api", scannedEntries, equalTo(actualEntries));
}
@Test
public void testRecursiveClassEnumerationWithExistantPackage() throws IOException {
final int actualEntries = countJarEntriesByPattern(Pattern.compile("javax/ws/rs/.*\\.class"));
final int scannedEntries = countJarEntriesUsingScanner("javax/ws/rs", true);
assertThat("Failed to enumerate all contents of javax.ws.rs-api", scannedEntries, equalTo(actualEntries));
}
@Test
public void testNonRecursiveClassEnumerationWithExistantPackage() throws IOException {
final int actualEntries = countJarEntriesByPattern(Pattern.compile("javax/ws/rs/[^/]*\\.class"));
final int scannedEntries = countJarEntriesUsingScanner("javax/ws/rs", false);
assertThat("Failed to enumerate package 'javax.ws.rs' of javax.ws.rs-api", scannedEntries, equalTo(actualEntries));
}
@Test
public void testRecursiveClassEnumerationWithOptionalTrailingSlash() throws IOException {
final int scannedEntriesWithoutSlash = countJarEntriesUsingScanner("javax/ws/rs", true);
final int scannedEntriesWithSlash = countJarEntriesUsingScanner("javax/ws/rs/", true);
assertThat("Adding a trailing slash incorrectly affects recursive scanning", scannedEntriesWithSlash,
equalTo(scannedEntriesWithoutSlash));
}
@Test
public void testNonRecursiveClassEnumerationWithOptionalTrailingSlash() throws IOException {
final int scannedEntriesWithoutSlash = countJarEntriesUsingScanner("javax/ws/rs", false);
final int scannedEntriesWithSlash = countJarEntriesUsingScanner("javax/ws/rs/", false);
assertThat("Adding a trailing slash incorrectly affects recursive scanning", scannedEntriesWithSlash,
equalTo(scannedEntriesWithoutSlash));
}
private int countJarEntriesByPattern(final Pattern pattern) throws IOException {
int matchingEntries = 0;
try (final JarFile jarFile = new JarFile(this.jaxRsApiPath)) {
final Enumeration<JarEntry> entries = jarFile.entries();
while (entries.hasMoreElements()) {
final JarEntry entry = entries.nextElement();
if (pattern.matcher(entry.getName()).matches()) {
matchingEntries++;
}
}
}
return matchingEntries;
}
private int countJarEntriesUsingScanner(final String parent, final boolean recursive) throws IOException {
int scannedEntryCount = 0;
try (final InputStream jaxRsApi = new FileInputStream(this.jaxRsApiPath)) {
final JarFileScanner jarFileScanner = new JarFileScanner(jaxRsApi, parent, recursive);
while (jarFileScanner.hasNext()) {
// Fetch next entry.
jarFileScanner.next();
// JERSEY-2175 and JERSEY-2197:
// This test doesn't actually do anything with the input stream, but it is important that it
// open/close the stream to simulate actual usage. The reported defect is only exposed if you
// call open/close in some fashion.
try (final InputStream classStream = jarFileScanner.open()) {
scannedEntryCount++;
}
}
}
return scannedEntryCount;
}
@ParameterizedTest
@ValueSource(booleans = {true, false})
public void testClassEnumerationWithNonexistentPackage(final boolean recursive) throws IOException {
try (final InputStream jaxRsApi = new FileInputStream(this.jaxRsApiPath)) {
final JarFileScanner jarFileScanner = new JarFileScanner(jaxRsApi, "javax/ws/r", recursive);
assertFalse(jarFileScanner.hasNext(), "Unexpectedly found package 'javax.ws.r' in javax.ws.rs-api");
}
}
@ParameterizedTest
@ValueSource(booleans = {true, false})
public void testClassEnumerationWithClassPrefix(final boolean recursive) throws IOException {
try (final InputStream jaxRsApi = new FileInputStream(this.jaxRsApiPath)) {
final JarFileScanner jarFileScanner = new JarFileScanner(jaxRsApi, "javax/ws/rs/GE", recursive);
assertFalse(jarFileScanner.hasNext(), "Unexpectedly found package 'javax.ws.rs.GE' in javax.ws.rs-api");
}
}
}