This is an automated email from the ASF dual-hosted git repository. bogong pushed a commit to branch branch-2.9 in repository https://gitbox.apache.org/repos/asf/pulsar.git
commit 2ec6471ac428720990da560f2f59fc5977bef0ef Author: Andras Beni <[email protected]> AuthorDate: Thu Sep 22 13:27:09 2022 +0200 [fix][broker] Extract additional servlets to the default directory by… (#17477) (cherry picked from commit 3d47ee8ab6a2d39017413b21160a21067cf7439b) --- .../web/plugin/servlet/AdditionalServlets.java | 4 +- .../web/plugin/servlet/AdditionalServletsTest.java | 92 ++++++++++++++++++++++ 2 files changed, 95 insertions(+), 1 deletion(-) diff --git a/pulsar-broker-common/src/main/java/org/apache/pulsar/broker/web/plugin/servlet/AdditionalServlets.java b/pulsar-broker-common/src/main/java/org/apache/pulsar/broker/web/plugin/servlet/AdditionalServlets.java index 080e1c75096..a0c0bf98f0a 100644 --- a/pulsar-broker-common/src/main/java/org/apache/pulsar/broker/web/plugin/servlet/AdditionalServlets.java +++ b/pulsar-broker-common/src/main/java/org/apache/pulsar/broker/web/plugin/servlet/AdditionalServlets.java @@ -25,6 +25,7 @@ import java.util.Map; import lombok.Getter; import lombok.extern.slf4j.Slf4j; +import org.apache.commons.lang3.StringUtils; import org.apache.pulsar.common.configuration.PulsarConfiguration; import org.apache.pulsar.common.nar.NarClassLoader; @@ -72,7 +73,8 @@ public class AdditionalServlets implements AutoCloseable { } String narExtractionDirectory = conf.getProperties().getProperty(NAR_EXTRACTION_DIRECTORY); - if(narExtractionDirectory == null) { + + if (StringUtils.isBlank(narExtractionDirectory)) { narExtractionDirectory = NarClassLoader.DEFAULT_NAR_EXTRACTION_DIR; } diff --git a/pulsar-broker-common/src/test/java/org/apache/pulsar/broker/web/plugin/servlet/AdditionalServletsTest.java b/pulsar-broker-common/src/test/java/org/apache/pulsar/broker/web/plugin/servlet/AdditionalServletsTest.java new file mode 100644 index 00000000000..d8cd8798fb3 --- /dev/null +++ b/pulsar-broker-common/src/test/java/org/apache/pulsar/broker/web/plugin/servlet/AdditionalServletsTest.java @@ -0,0 +1,92 @@ +/** + * Licensed to the Apache Software Foundation (ASF) under one + * or more contributor license agreements. See the NOTICE file + * distributed with this work for additional information + * regarding copyright ownership. The ASF licenses this file + * to you under the Apache License, Version 2.0 (the + * "License"); you may not use this file except in compliance + * with the License. You may obtain a copy of the License at + * + * http://www.apache.org/licenses/LICENSE-2.0 + * + * Unless required by applicable law or agreed to in writing, + * software distributed under the License is distributed on an + * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY + * KIND, either express or implied. See the License for the + * specific language governing permissions and limitations + * under the License. + */ +package org.apache.pulsar.broker.web.plugin.servlet; + +import static org.mockito.Mockito.mock; +import static org.powermock.api.mockito.PowerMockito.when; + +import org.apache.pulsar.common.configuration.PulsarConfiguration; +import org.mockito.Mockito; +import org.powermock.api.mockito.PowerMockito; +import org.powermock.core.classloader.annotations.PowerMockIgnore; +import org.powermock.core.classloader.annotations.PrepareForTest; +import org.powermock.modules.testng.PowerMockTestCase; +import org.testng.Assert; +import org.testng.annotations.Test; +import java.io.IOException; +import java.nio.file.Paths; +import java.util.Properties; + +@PrepareForTest({ + AdditionalServletUtils.class +}) +@PowerMockIgnore({"org.apache.logging.log4j.*", "javax.xml.*", "com.sun.org.apache.xerces.*"}) +public class AdditionalServletsTest extends PowerMockTestCase { + + + @Test + public void testEmptyStringAsExtractionDirectory() throws IOException { + Properties p = new Properties(); + p.put("narExtractionDirectory", ""); + p.put("additionalServlets", "AS1,AS2"); + p.put("additionalServletDirectory", "/additionalServletDirectory"); + + PulsarConfiguration config = mock(PulsarConfiguration.class); + Mockito.when(config.getProperties()).thenReturn(p); + + AdditionalServletMetadata asm1 = additionalServletMetadata(1); + AdditionalServletMetadata asm2 = additionalServletMetadata(2); + + AdditionalServletDefinitions definitions = new AdditionalServletDefinitions(); + definitions.servlets().put("AS1", asm1); + definitions.servlets().put("AS2", asm2); + + AdditionalServletWithClassLoader as1 = mock(AdditionalServletWithClassLoader.class); + AdditionalServletWithClassLoader as2 = mock(AdditionalServletWithClassLoader.class); + + String originalTmpDirectory = System.getProperty("java.io.tmpdir"); + + try { + PowerMockito.mockStatic(AdditionalServletUtils.class); + String tmpDirectory = "/my/tmp/directory"; + System.setProperty("java.io.tmpdir", tmpDirectory); + when(AdditionalServletUtils.searchForServlets( + "/additionalServletDirectory", tmpDirectory)).thenReturn(definitions); + when(AdditionalServletUtils.load(asm1, tmpDirectory)).thenReturn(as1); + when(AdditionalServletUtils.load(asm2, tmpDirectory)).thenReturn(as2); + + AdditionalServlets servlets = AdditionalServlets.load(config); + + Assert.assertEquals(servlets.getServlets().get("AS1"), as1); + Assert.assertEquals(servlets.getServlets().get("AS2"), as2); + } finally { + System.setProperty("java.io.tmpdir", originalTmpDirectory); + } + } + + private AdditionalServletMetadata additionalServletMetadata(int index) { + AdditionalServletMetadata as = new AdditionalServletMetadata(); + as.setArchivePath(Paths.get("/additionalServletDirectory/" + index)); + as.setDefinition(new AdditionalServletDefinition()); + as.getDefinition().setName("as" + index); + as.getDefinition().setAdditionalServletClass("com.example.AS" + index); + as.getDefinition().setDescription("Additional Servlet " +index); + return as; + } +}
