From f66e7b80615a9116cacd15b4e2c90fa8be8dd4bd Mon Sep 17 00:00:00 2001 From: Patrick Doyle <810052+prdoyle@users.noreply.github.com> Date: Thu, 22 May 2025 10:16:16 -0400 Subject: [PATCH] Use package to suppress warning for entitlement self-test (#128223) (#128304) * Use package to suppress warning for entitlement self-test * [CI] Auto commit changes from spotless --------- Co-authored-by: elasticsearchmachine --- .../entitlement/bootstrap/EntitlementBootstrap.java | 10 +++++----- .../initialization/EntitlementInitialization.java | 2 +- .../entitlement/runtime/policy/PolicyManager.java | 10 +++++----- .../org/elasticsearch/bootstrap/Elasticsearch.java | 2 +- 4 files changed, 12 insertions(+), 12 deletions(-) diff --git a/libs/entitlement/src/main/java/org/elasticsearch/entitlement/bootstrap/EntitlementBootstrap.java b/libs/entitlement/src/main/java/org/elasticsearch/entitlement/bootstrap/EntitlementBootstrap.java index b3200c756890b..c7460d4a611fb 100644 --- a/libs/entitlement/src/main/java/org/elasticsearch/entitlement/bootstrap/EntitlementBootstrap.java +++ b/libs/entitlement/src/main/java/org/elasticsearch/entitlement/bootstrap/EntitlementBootstrap.java @@ -43,14 +43,14 @@ public record BootstrapArgs( Function, PolicyManager.PolicyScope> scopeResolver, PathLookup pathLookup, Map sourcePaths, - Set> suppressFailureLogClasses + Set suppressFailureLogPackages ) { public BootstrapArgs { requireNonNull(pluginPolicies); requireNonNull(scopeResolver); requireNonNull(pathLookup); requireNonNull(sourcePaths); - requireNonNull(suppressFailureLogClasses); + requireNonNull(suppressFailureLogPackages); } } @@ -78,7 +78,7 @@ public static BootstrapArgs bootstrapArgs() { * @param tempDir the temp directory for Elasticsearch * @param logsDir the log directory for Elasticsearch * @param pidFile path to a pid file for Elasticsearch, or {@code null} if one was not specified - * @param suppressFailureLogClasses classes for which we do not need or want to log Entitlements failures + * @param suppressFailureLogPackages packages for which we do not need or want to log Entitlements failures */ public static void bootstrap( Policy serverPolicyPatch, @@ -95,7 +95,7 @@ public static void bootstrap( Path logsDir, Path tempDir, Path pidFile, - Set> suppressFailureLogClasses + Set suppressFailureLogPackages ) { logger.debug("Loading entitlement agent"); if (EntitlementBootstrap.bootstrapArgs != null) { @@ -119,7 +119,7 @@ public static void bootstrap( settingResolver ), sourcePaths, - suppressFailureLogClasses + suppressFailureLogPackages ); exportInitializationToAgent(); loadAgent(findAgentJar()); diff --git a/libs/entitlement/src/main/java/org/elasticsearch/entitlement/initialization/EntitlementInitialization.java b/libs/entitlement/src/main/java/org/elasticsearch/entitlement/initialization/EntitlementInitialization.java index 5d66651c22949..3c03efcd9b24e 100644 --- a/libs/entitlement/src/main/java/org/elasticsearch/entitlement/initialization/EntitlementInitialization.java +++ b/libs/entitlement/src/main/java/org/elasticsearch/entitlement/initialization/EntitlementInitialization.java @@ -90,7 +90,7 @@ private static PolicyManager createPolicyManager() { EntitlementBootstrap.bootstrapArgs().sourcePaths(), ENTITLEMENTS_MODULE, pathLookup, - bootstrapArgs.suppressFailureLogClasses() + bootstrapArgs.suppressFailureLogPackages() ); } diff --git a/libs/entitlement/src/main/java/org/elasticsearch/entitlement/runtime/policy/PolicyManager.java b/libs/entitlement/src/main/java/org/elasticsearch/entitlement/runtime/policy/PolicyManager.java index aa901e9900d17..053d257d814d8 100644 --- a/libs/entitlement/src/main/java/org/elasticsearch/entitlement/runtime/policy/PolicyManager.java +++ b/libs/entitlement/src/main/java/org/elasticsearch/entitlement/runtime/policy/PolicyManager.java @@ -256,7 +256,7 @@ ModuleEntitlements policyEntitlements(String componentName, Path componentPath, private final Map>> pluginsEntitlements; private final Function, PolicyScope> scopeResolver; private final PathLookup pathLookup; - private final Set> mutedClasses; + private final Set suppressFailureLogPackages; public static final String ALL_UNNAMED = "ALL-UNNAMED"; @@ -311,7 +311,7 @@ public PolicyManager( Map sourcePaths, Module entitlementsModule, PathLookup pathLookup, - Set> suppressFailureLogClasses + Set suppressFailureLogPackages ) { this.serverEntitlements = buildScopeEntitlementsMap(requireNonNull(serverPolicy)); this.apmAgentEntitlements = apmAgentEntitlements; @@ -322,7 +322,7 @@ public PolicyManager( this.sourcePaths = sourcePaths; this.entitlementsModule = entitlementsModule; this.pathLookup = requireNonNull(pathLookup); - this.mutedClasses = suppressFailureLogClasses; + this.suppressFailureLogPackages = suppressFailureLogPackages; List exclusiveFileEntitlements = new ArrayList<>(); for (var e : serverEntitlements.entrySet()) { @@ -688,8 +688,8 @@ public void checkWriteProperty(Class callerClass, String property) { private void notEntitled(String message, Class callerClass, ModuleEntitlements entitlements) { var exception = new NotEntitledException(message); - // Don't emit a log for muted classes, e.g. classes containing self tests - if (mutedClasses.contains(callerClass) == false) { + // Don't emit a log for suppressed packages, e.g. packages containing self tests + if (suppressFailureLogPackages.contains(callerClass.getPackage()) == false) { entitlements.logger().warn("Not entitled: {}", message, exception); } throw exception; diff --git a/server/src/main/java/org/elasticsearch/bootstrap/Elasticsearch.java b/server/src/main/java/org/elasticsearch/bootstrap/Elasticsearch.java index 028dbb20aec76..d60c5b7e57deb 100644 --- a/server/src/main/java/org/elasticsearch/bootstrap/Elasticsearch.java +++ b/server/src/main/java/org/elasticsearch/bootstrap/Elasticsearch.java @@ -270,7 +270,7 @@ private static void initPhase2(Bootstrap bootstrap) throws IOException { nodeEnv.logsDir(), nodeEnv.tmpDir(), args.pidFile(), - Set.of(EntitlementSelfTester.class) + Set.of(EntitlementSelfTester.class.getPackage()) ); EntitlementSelfTester.entitlementSelfTest(); } else {