forked from apache/pulsar
-
Notifications
You must be signed in to change notification settings - Fork 0
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
[fix][broker] Key_Shared subscription: Reject consumers with incompat…
…ible policy (apache#23449)
- Loading branch information
Showing
5 changed files
with
229 additions
and
15 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
175 changes: 175 additions & 0 deletions
175
...src/test/java/org/apache/pulsar/broker/service/SubscriptionConsumerCompatibilityTest.java
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,175 @@ | ||
| /* | ||
| * 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.service; | ||
|
|
||
| import static org.mockito.Mockito.doReturn; | ||
| import static org.mockito.Mockito.mock; | ||
| import static org.testng.Assert.assertEquals; | ||
| import static org.testng.Assert.assertTrue; | ||
| import static org.testng.Assert.fail; | ||
| import java.util.Map; | ||
| import java.util.concurrent.TimeUnit; | ||
| import org.apache.bookkeeper.mledger.ManagedLedger; | ||
| import org.apache.bookkeeper.mledger.ManagedLedgerConfig; | ||
| import org.apache.bookkeeper.mledger.impl.ManagedCursorImpl; | ||
| import org.apache.bookkeeper.mledger.impl.ManagedLedgerImpl; | ||
| import org.apache.pulsar.broker.BrokerTestUtil; | ||
| import org.apache.pulsar.broker.service.nonpersistent.NonPersistentSubscription; | ||
| import org.apache.pulsar.broker.service.nonpersistent.NonPersistentTopic; | ||
| import org.apache.pulsar.broker.service.persistent.PersistentSubscription; | ||
| import org.apache.pulsar.broker.service.persistent.PersistentTopic; | ||
| import org.apache.pulsar.broker.testcontext.PulsarTestContext; | ||
| import org.apache.pulsar.common.api.proto.CommandSubscribe; | ||
| import org.apache.pulsar.common.api.proto.KeySharedMeta; | ||
| import org.apache.pulsar.common.api.proto.KeySharedMode; | ||
| import org.testng.annotations.AfterMethod; | ||
| import org.testng.annotations.BeforeMethod; | ||
| import org.testng.annotations.DataProvider; | ||
| import org.testng.annotations.Test; | ||
|
|
||
| @Test(groups = "broker") | ||
| public class SubscriptionConsumerCompatibilityTest { | ||
|
|
||
| private PulsarTestContext pulsarTestContext; | ||
| private ManagedLedger ledgerMock; | ||
| private ManagedCursorImpl cursorMock; | ||
| private final String successTopicName = "persistent://prop/use/ns-abc/successTopic"; | ||
| private final String subName = "subscriptionName"; | ||
|
|
||
| @BeforeMethod | ||
| public void setup() throws Exception { | ||
| pulsarTestContext = PulsarTestContext.builderForNonStartableContext().build(); | ||
|
|
||
| ledgerMock = mock(ManagedLedgerImpl.class); | ||
| ManagedLedgerConfig managedLedgerConfigMock = mock(ManagedLedgerConfig.class); | ||
| doReturn(managedLedgerConfigMock).when(ledgerMock).getConfig(); | ||
|
|
||
| cursorMock = mock(ManagedCursorImpl.class); | ||
| doReturn("mockCursor").when(cursorMock).getName(); | ||
| } | ||
|
|
||
| @AfterMethod(alwaysRun = true) | ||
| public void teardown() throws Exception { | ||
| if (pulsarTestContext != null) { | ||
| pulsarTestContext.close(); | ||
| pulsarTestContext = null; | ||
| } | ||
| } | ||
|
|
||
| @DataProvider(name = "incompatibleKeySharedPolicies") | ||
| public Object[][] incompatibleKeySharedPolicies() { | ||
| KeySharedMeta ksmSticky = new KeySharedMeta().setKeySharedMode(KeySharedMode.STICKY); | ||
| ksmSticky.addHashRange().setStart(0).setEnd(2); | ||
|
|
||
| KeySharedMeta ksmStickyAllowOutOfOrder = new KeySharedMeta().setKeySharedMode(KeySharedMode.STICKY) | ||
| .setAllowOutOfOrderDelivery(true); | ||
| ksmStickyAllowOutOfOrder.addHashRange().setStart(3).setEnd(5); | ||
|
|
||
| KeySharedMeta ksmAutoSplit = new KeySharedMeta().setKeySharedMode(KeySharedMode.AUTO_SPLIT); | ||
| KeySharedMeta ksmAutoSplitAllowOutOfOrder = new KeySharedMeta().setKeySharedMode(KeySharedMode.AUTO_SPLIT) | ||
| .setAllowOutOfOrderDelivery(true); | ||
|
|
||
| String errorMessagePrefix = "Subscription is of different type. "; | ||
| String errorMessageSubscriptionModeSticky = errorMessagePrefix + "Active subscription key_shared mode of " | ||
| + "'STICKY' is different than the connecting consumer's key_shared mode 'AUTO_SPLIT'."; | ||
| String errorMessageSubscriptionModeAutoSplit = errorMessagePrefix + "Active subscription key_shared mode of " | ||
| + "'AUTO_SPLIT' is different than the connecting consumer's key_shared mode 'STICKY'."; | ||
| String errorMessageOutOfOrderNotAllowed = errorMessagePrefix + "Active subscription does not allow out of " | ||
| + "order delivery while the connecting consumer allows it."; | ||
| String errorMessageOutOfOrderAllowed = errorMessagePrefix + "Active subscription allows out of order delivery " | ||
| + "while the connecting consumer does not allow it."; | ||
|
|
||
| return new Object[][] { | ||
| { ksmAutoSplit, ksmSticky, errorMessageSubscriptionModeAutoSplit }, | ||
| { ksmAutoSplit, ksmStickyAllowOutOfOrder, errorMessageSubscriptionModeAutoSplit }, | ||
| { ksmAutoSplit, ksmAutoSplitAllowOutOfOrder, errorMessageOutOfOrderNotAllowed }, | ||
|
|
||
| { ksmAutoSplitAllowOutOfOrder, ksmSticky, errorMessageSubscriptionModeAutoSplit }, | ||
| { ksmAutoSplitAllowOutOfOrder, ksmStickyAllowOutOfOrder, errorMessageSubscriptionModeAutoSplit }, | ||
| { ksmAutoSplitAllowOutOfOrder, ksmAutoSplit, errorMessageOutOfOrderAllowed }, | ||
|
|
||
| { ksmSticky, ksmStickyAllowOutOfOrder, errorMessageOutOfOrderNotAllowed }, | ||
| { ksmSticky, ksmAutoSplit, errorMessageSubscriptionModeSticky }, | ||
| { ksmSticky, ksmAutoSplitAllowOutOfOrder, errorMessageSubscriptionModeSticky }, | ||
|
|
||
| { ksmStickyAllowOutOfOrder, ksmSticky, errorMessageOutOfOrderAllowed }, | ||
| { ksmStickyAllowOutOfOrder, ksmAutoSplit, errorMessageSubscriptionModeSticky }, | ||
| { ksmStickyAllowOutOfOrder, ksmAutoSplitAllowOutOfOrder, errorMessageSubscriptionModeSticky } | ||
| }; | ||
| } | ||
|
|
||
| @Test(dataProvider = "incompatibleKeySharedPolicies") | ||
| public void testIncompatibleKeySharedPoliciesNotAllowedInNonPersistentSub(KeySharedMeta consumer1Ksm, KeySharedMeta consumer2Ksm, | ||
| String expectedErrorMessage) throws Exception { | ||
| NonPersistentTopic topic = new NonPersistentTopic(successTopicName, pulsarTestContext.getBrokerService()); | ||
| NonPersistentSubscription sub = new NonPersistentSubscription(topic, subName, Map.of()); | ||
|
|
||
| // two consumers with incompatible key_shared policies | ||
| Consumer keySharedConsumerMock1 = createKeySharedMockConsumer("consumer-1", consumer1Ksm); | ||
| Consumer keySharedConsumerMock2 = createKeySharedMockConsumer("consumer-2", consumer2Ksm); | ||
|
|
||
| // first consumer defines key_shared mode of subscription and whether out of order delivery is allowed | ||
| sub.addConsumer(keySharedConsumerMock1).get(5, TimeUnit.SECONDS); | ||
|
|
||
| try { | ||
| // add second consumer with incompatible key_shared policy | ||
| sub.addConsumer(keySharedConsumerMock2).get(5, TimeUnit.SECONDS); | ||
| fail(BrokerServiceException.SubscriptionBusyException.class.getSimpleName() + " not thrown"); | ||
| } catch (Exception e) { | ||
| // subscription throws exception when consumer with incompatible key_shared policy is added | ||
| Throwable cause = e.getCause(); | ||
| assertTrue(cause instanceof BrokerServiceException.SubscriptionBusyException); | ||
| assertEquals(cause.getMessage(), expectedErrorMessage); | ||
| } | ||
| } | ||
|
|
||
| @Test(dataProvider = "incompatibleKeySharedPolicies") | ||
| public void testIncompatibleKeySharedPoliciesNotAllowedInPersistentSub(KeySharedMeta consumer1Ksm, KeySharedMeta consumer2Ksm, | ||
| String expectedErrorMessage) throws Exception { | ||
| PersistentTopic topic = new PersistentTopic(successTopicName, ledgerMock, pulsarTestContext.getBrokerService()); | ||
| PersistentSubscription sub = new PersistentSubscription(topic, subName, cursorMock, false); | ||
|
|
||
| // two consumers with incompatible key_shared policies | ||
| Consumer keySharedConsumerMock1 = createKeySharedMockConsumer("consumer-1", consumer1Ksm); | ||
| Consumer keySharedConsumerMock2 = createKeySharedMockConsumer("consumer-2", consumer2Ksm); | ||
|
|
||
| // first consumer defines key_shared mode of subscription and whether out of order delivery is allowed | ||
| sub.addConsumer(keySharedConsumerMock1).get(5, TimeUnit.SECONDS); | ||
|
|
||
| try { | ||
| // add second consumer with incompatible key_shared policy | ||
| sub.addConsumer(keySharedConsumerMock2).get(5, TimeUnit.SECONDS); | ||
| fail(BrokerServiceException.SubscriptionBusyException.class.getSimpleName() + " not thrown"); | ||
| } catch (Exception e) { | ||
| // subscription throws exception when consumer with incompatible key_shared policy is added | ||
| Throwable cause = e.getCause(); | ||
| assertTrue(cause instanceof BrokerServiceException.SubscriptionBusyException); | ||
| assertEquals(cause.getMessage(), expectedErrorMessage); | ||
| } | ||
| } | ||
|
|
||
| protected Consumer createKeySharedMockConsumer(String name, KeySharedMeta ksm) { | ||
| Consumer consumer = BrokerTestUtil.createMockConsumer(name); | ||
| doReturn(CommandSubscribe.SubType.Key_Shared).when(consumer).subType(); | ||
| doReturn(ksm).when(consumer).getKeySharedMeta(); | ||
| doReturn(mock(PendingAcksMap.class)).when(consumer).getPendingAcks(); | ||
| return consumer; | ||
| } | ||
|
|
||
| } |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters