Skip to content

Commit

Permalink
Reduce warnings in entitlement REST tests (elastic#123028)
Browse files Browse the repository at this point in the history
  • Loading branch information
prdoyle authored Feb 20, 2025
1 parent 41dae02 commit 3da1bb8
Show file tree
Hide file tree
Showing 13 changed files with 115 additions and 133 deletions.

Large diffs are not rendered by default.

Original file line number Diff line number Diff line change
Expand Up @@ -40,7 +40,7 @@
import static org.elasticsearch.entitlement.qa.test.EntitlementTest.ExpectedAccess.PLUGINS;

@SuppressForbidden(reason = "Explicitly checking APIs that are forbidden")
@SuppressWarnings("unused") // Called via reflection
@SuppressWarnings({ "unused" /* called via reflection */, "ResultOfMethodCallIgnored" })
class FileCheckActions {

static Path testRootDir = Paths.get(System.getProperty("es.entitlements.testdir"));
Expand All @@ -62,17 +62,17 @@ static Path readWriteFile() {
}

@EntitlementTest(expectedAccess = PLUGINS)
static void fileCanExecute() throws IOException {
static void fileCanExecute() {
readFile().toFile().canExecute();
}

@EntitlementTest(expectedAccess = PLUGINS)
static void fileCanRead() throws IOException {
static void fileCanRead() {
readFile().toFile().canRead();
}

@EntitlementTest(expectedAccess = PLUGINS)
static void fileCanWrite() throws IOException {
static void fileCanWrite() {
readFile().toFile().canWrite();
}

Expand Down Expand Up @@ -101,68 +101,68 @@ static void fileDeleteOnExit() throws IOException {
}

@EntitlementTest(expectedAccess = PLUGINS)
static void fileExists() throws IOException {
static void fileExists() {
readFile().toFile().exists();
}

@EntitlementTest(expectedAccess = PLUGINS)
static void fileIsDirectory() throws IOException {
static void fileIsDirectory() {
readFile().toFile().isDirectory();
}

@EntitlementTest(expectedAccess = PLUGINS)
static void fileIsFile() throws IOException {
static void fileIsFile() {
readFile().toFile().isFile();
}

@EntitlementTest(expectedAccess = PLUGINS)
static void fileIsHidden() throws IOException {
static void fileIsHidden() {
readFile().toFile().isHidden();
}

@EntitlementTest(expectedAccess = PLUGINS)
static void fileLastModified() throws IOException {
static void fileLastModified() {
readFile().toFile().lastModified();
}

@EntitlementTest(expectedAccess = PLUGINS)
static void fileLength() throws IOException {
static void fileLength() {
readFile().toFile().length();
}

@EntitlementTest(expectedAccess = PLUGINS)
static void fileList() throws IOException {
static void fileList() {
readDir().toFile().list();
}

@EntitlementTest(expectedAccess = PLUGINS)
static void fileListWithFilter() throws IOException {
static void fileListWithFilter() {
readDir().toFile().list((dir, name) -> true);
}

@EntitlementTest(expectedAccess = PLUGINS)
static void fileListFiles() throws IOException {
static void fileListFiles() {
readDir().toFile().listFiles();
}

@EntitlementTest(expectedAccess = PLUGINS)
static void fileListFilesWithFileFilter() throws IOException {
static void fileListFilesWithFileFilter() {
readDir().toFile().listFiles(pathname -> true);
}

@EntitlementTest(expectedAccess = PLUGINS)
static void fileListFilesWithFilenameFilter() throws IOException {
static void fileListFilesWithFilenameFilter() {
readDir().toFile().listFiles((dir, name) -> true);
}

@EntitlementTest(expectedAccess = PLUGINS)
static void fileMkdir() throws IOException {
static void fileMkdir() {
Path mkdir = readWriteDir().resolve("mkdir");
mkdir.toFile().mkdir();
}

@EntitlementTest(expectedAccess = PLUGINS)
static void fileMkdirs() throws IOException {
static void fileMkdirs() {
Path mkdir = readWriteDir().resolve("mkdirs");
mkdir.toFile().mkdirs();
}
Expand All @@ -175,27 +175,27 @@ static void fileRenameTo() throws IOException {
}

@EntitlementTest(expectedAccess = PLUGINS)
static void fileSetExecutable() throws IOException {
static void fileSetExecutable() {
readWriteFile().toFile().setExecutable(false);
}

@EntitlementTest(expectedAccess = PLUGINS)
static void fileSetExecutableOwner() throws IOException {
static void fileSetExecutableOwner() {
readWriteFile().toFile().setExecutable(false, false);
}

@EntitlementTest(expectedAccess = PLUGINS)
static void fileSetLastModified() throws IOException {
static void fileSetLastModified() {
readWriteFile().toFile().setLastModified(System.currentTimeMillis());
}

@EntitlementTest(expectedAccess = PLUGINS)
static void fileSetReadable() throws IOException {
static void fileSetReadable() {
readWriteFile().toFile().setReadable(true);
}

@EntitlementTest(expectedAccess = PLUGINS)
static void fileSetReadableOwner() throws IOException {
static void fileSetReadableOwner() {
readWriteFile().toFile().setReadable(true, false);
}

Expand All @@ -207,12 +207,12 @@ static void fileSetReadOnly() throws IOException {
}

@EntitlementTest(expectedAccess = PLUGINS)
static void fileSetWritable() throws IOException {
static void fileSetWritable() {
readWriteFile().toFile().setWritable(true);
}

@EntitlementTest(expectedAccess = PLUGINS)
static void fileSetWritableOwner() throws IOException {
static void fileSetWritableOwner() {
readWriteFile().toFile().setWritable(true, false);
}

Expand Down Expand Up @@ -363,6 +363,7 @@ static void keystoreGetInstance_FileLoadStoreParameter() throws IOException {
}

@EntitlementTest(expectedAccess = PLUGINS)
@SuppressWarnings("DataFlowIssue") // Passing null to a @NotNull parameter
static void keystoreBuilderNewInstance() {
try {
KeyStore.Builder.newInstance("", null, readFile().toFile(), null);
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -16,6 +16,7 @@
import static org.elasticsearch.entitlement.qa.test.EntitlementTest.ExpectedAccess.ALWAYS_DENIED;
import static org.elasticsearch.entitlement.qa.test.EntitlementTest.ExpectedAccess.SERVER_ONLY;

@SuppressWarnings({ "unused" /* called via reflection */ })
class FileStoreActions {

@EntitlementTest(expectedAccess = ALWAYS_DENIED)
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -18,7 +18,7 @@
import static org.elasticsearch.entitlement.qa.test.EntitlementTest.ExpectedAccess.PLUGINS;

@SuppressForbidden(reason = "testing entitlements")
@SuppressWarnings("unused") // used via reflection
@SuppressWarnings({ "unused" /* called via reflaction */, "removal" })
class ManageThreadsActions {
private ManageThreadsActions() {}

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -33,6 +33,7 @@
import static org.elasticsearch.entitlement.qa.test.EntitlementTest.ExpectedAccess.PLUGINS;
import static org.elasticsearch.entitlement.qa.test.EntitlementTest.ExpectedAccess.SERVER_ONLY;

@SuppressWarnings({ "unused" /* called via reflection */ })
class NativeActions {

@EntitlementTest(expectedAccess = SERVER_ONLY)
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -81,7 +81,7 @@ static void urlOpenConnectionWithProxy() throws URISyntaxException, IOException
assert urlConnection != null;
}

static void createLDAPCertStore() throws NoSuchAlgorithmException {
static void createLDAPCertStore() {
try {
// We pass down null params to provoke a InvalidAlgorithmParameterException
CertStore.getInstance("LDAP", null);
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -23,6 +23,7 @@
import static org.elasticsearch.entitlement.qa.test.EntitlementTest.ExpectedAccess.ALWAYS_DENIED;
import static org.elasticsearch.entitlement.qa.test.EntitlementTest.ExpectedAccess.PLUGINS;

@SuppressWarnings({ "unused" /* called via reflection */ })
class NioChannelsActions {

@EntitlementTest(expectedAccess = ALWAYS_DENIED)
Expand Down Expand Up @@ -51,7 +52,7 @@ static void fileChannelOpenForReadWithOptions() throws IOException {
}

@EntitlementTest(expectedAccess = ALWAYS_DENIED)
static void createAsynchronousFileChannel() throws IOException {
static void createAsynchronousFileChannel() {
new DummyImplementations.DummyAsynchronousFileChannel().close();
}

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -27,6 +27,7 @@
import static org.elasticsearch.entitlement.qa.test.EntitlementTest.ExpectedAccess.PLUGINS;
import static org.elasticsearch.entitlement.qa.test.EntitlementTest.ExpectedAccess.SERVER_ONLY;

@SuppressWarnings({ "unused" /* called via reflection */ })
class NioFileSystemActions {

@EntitlementTest(expectedAccess = SERVER_ONLY)
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -39,6 +39,7 @@
import static org.elasticsearch.entitlement.qa.test.FileCheckActions.readWriteDir;
import static org.elasticsearch.entitlement.qa.test.FileCheckActions.readWriteFile;

@SuppressWarnings({ "unused" /* called via reflection */ })
class NioFilesActions {

@EntitlementTest(expectedAccess = PLUGINS)
Expand Down Expand Up @@ -313,52 +314,36 @@ static void checkFilesIsExecutable() {

@EntitlementTest(expectedAccess = PLUGINS)
static void checkFilesWalkFileTree() throws IOException {
Files.walkFileTree(readDir(), new FileVisitor<>() {
@Override
public FileVisitResult preVisitDirectory(Path dir, BasicFileAttributes attrs) throws IOException {
return FileVisitResult.SKIP_SUBTREE;
}

@Override
public FileVisitResult visitFile(Path file, BasicFileAttributes attrs) throws IOException {
return FileVisitResult.SKIP_SUBTREE;
}

@Override
public FileVisitResult visitFileFailed(Path file, IOException exc) throws IOException {
return FileVisitResult.SKIP_SUBTREE;
}

@Override
public FileVisitResult postVisitDirectory(Path dir, IOException exc) throws IOException {
return FileVisitResult.SKIP_SUBTREE;
}
});
Files.walkFileTree(readDir(), dummyVisitor());
}

@EntitlementTest(expectedAccess = PLUGINS)
static void checkFilesWalkFileTreeWithOptions() throws IOException {
Files.walkFileTree(readDir(), Set.of(FileVisitOption.FOLLOW_LINKS), 2, new FileVisitor<>() {
Files.walkFileTree(readDir(), Set.of(FileVisitOption.FOLLOW_LINKS), 2, dummyVisitor());
}

private static FileVisitor<Path> dummyVisitor() {
return new FileVisitor<>() {
@Override
public FileVisitResult preVisitDirectory(Path dir, BasicFileAttributes attrs) throws IOException {
public FileVisitResult preVisitDirectory(Path dir, BasicFileAttributes attrs) {
return FileVisitResult.SKIP_SUBTREE;
}

@Override
public FileVisitResult visitFile(Path file, BasicFileAttributes attrs) throws IOException {
public FileVisitResult visitFile(Path file, BasicFileAttributes attrs) {
return FileVisitResult.SKIP_SUBTREE;
}

@Override
public FileVisitResult visitFileFailed(Path file, IOException exc) throws IOException {
public FileVisitResult visitFileFailed(Path file, IOException exc) {
return FileVisitResult.SKIP_SUBTREE;
}

@Override
public FileVisitResult postVisitDirectory(Path dir, IOException exc) throws IOException {
public FileVisitResult postVisitDirectory(Path dir, IOException exc) {
return FileVisitResult.SKIP_SUBTREE;
}
});
};
}

@EntitlementTest(expectedAccess = PLUGINS)
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -16,6 +16,7 @@

import static org.elasticsearch.entitlement.qa.test.EntitlementTest.ExpectedAccess.PLUGINS;

@SuppressWarnings({ "unused" /* called via reflection */, "rawtypes" })
class PathActions {

@EntitlementTest(expectedAccess = PLUGINS)
Expand All @@ -28,7 +29,6 @@ static void checkToRealPathNoFollow() throws IOException {
FileCheckActions.readFile().toRealPath(LinkOption.NOFOLLOW_LINKS);
}

@SuppressWarnings("rawtypes")
@EntitlementTest(expectedAccess = PLUGINS)
static void checkRegister() throws IOException {
try (var watchService = FileSystems.getDefault().newWatchService()) {
Expand All @@ -38,7 +38,6 @@ static void checkRegister() throws IOException {
}
}

@SuppressWarnings("rawtypes")
@EntitlementTest(expectedAccess = PLUGINS)
static void checkRegisterWithModifiers() throws IOException {
try (var watchService = FileSystems.getDefault().newWatchService()) {
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -15,6 +15,7 @@

import static org.elasticsearch.entitlement.qa.test.EntitlementTest.ExpectedAccess.ALWAYS_DENIED;

@SuppressWarnings({ "unused" /* called via reflection */ })
class SpiActions {
@EntitlementTest(expectedAccess = ALWAYS_DENIED)
static void createBreakIteratorProvider() {
Expand Down Expand Up @@ -78,14 +79,7 @@ static void createLocaleServiceProvider() {

@EntitlementTest(expectedAccess = ALWAYS_DENIED)
static void getInheritedChannel() throws IOException {
Channel channel = null;
try {
channel = SelectorProvider.provider().inheritedChannel();
} finally {
if (channel != null) {
channel.close();
}
}
try (Channel channel = SelectorProvider.provider().inheritedChannel()) {}
}

@EntitlementTest(expectedAccess = ALWAYS_DENIED)
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -14,6 +14,7 @@
import static org.elasticsearch.entitlement.qa.test.EntitlementTest.ExpectedAccess.ALWAYS_DENIED;
import static org.elasticsearch.entitlement.qa.test.EntitlementTest.ExpectedAccess.SERVER_ONLY;

@SuppressWarnings({ "unused" /* called via reflection */ })
class SystemActions {

@SuppressForbidden(reason = "Specifically testing Runtime.exit")
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -19,7 +19,7 @@

class VersionSpecificNetworkChecks {
static void createInetAddressResolverProvider() {
var x = new InetAddressResolverProvider() {
new InetAddressResolverProvider() {
@Override
public InetAddressResolver get(Configuration configuration) {
return null;
Expand Down

0 comments on commit 3da1bb8

Please sign in to comment.