| /* |
| * |
| * 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.qpid.server.virtualhost; |
| |
| import static org.mockito.Matchers.any; |
| import static org.mockito.Matchers.argThat; |
| import static org.mockito.Matchers.eq; |
| import static org.mockito.Matchers.isNull; |
| import static org.mockito.Mockito.mock; |
| import static org.mockito.Mockito.never; |
| import static org.mockito.Mockito.times; |
| import static org.mockito.Mockito.verify; |
| import static org.mockito.Mockito.when; |
| |
| import java.util.UUID; |
| |
| import org.mockito.ArgumentMatcher; |
| |
| import org.apache.qpid.server.logging.EventLogger; |
| import org.apache.qpid.server.message.BaseMessageInstance; |
| import org.apache.qpid.server.message.EnqueueableMessage; |
| import org.apache.qpid.server.message.ServerMessage; |
| import org.apache.qpid.server.model.Queue; |
| import org.apache.qpid.server.model.VirtualHost; |
| import org.apache.qpid.server.queue.QueueEntry; |
| import org.apache.qpid.server.store.MessageDurability; |
| import org.apache.qpid.server.store.MessageEnqueueRecord; |
| import org.apache.qpid.server.store.MessageStore; |
| import org.apache.qpid.server.store.NullMessageStore; |
| import org.apache.qpid.server.store.StorableMessageMetaData; |
| import org.apache.qpid.server.store.StoreException; |
| import org.apache.qpid.server.store.StoredMessage; |
| import org.apache.qpid.server.store.TestMessageMetaData; |
| import org.apache.qpid.server.store.Transaction; |
| import org.apache.qpid.server.store.Transaction.EnqueueRecord; |
| import org.apache.qpid.server.store.handler.DistributedTransactionHandler; |
| import org.apache.qpid.server.store.handler.MessageHandler; |
| import org.apache.qpid.server.store.handler.MessageInstanceHandler; |
| import org.apache.qpid.server.transfer.TransferQueue; |
| import org.apache.qpid.server.txn.DtxBranch; |
| import org.apache.qpid.server.txn.DtxRegistry; |
| import org.apache.qpid.server.util.Action; |
| import org.apache.qpid.test.utils.QpidTestCase; |
| import org.apache.qpid.transport.Xid; |
| |
| public class SynchronousMessageStoreRecovererTest extends QpidTestCase |
| { |
| private VirtualHost<?> _virtualHost; |
| |
| @Override |
| protected void setUp() throws Exception |
| { |
| super.setUp(); |
| |
| _virtualHost = mock(VirtualHost.class); |
| TransferQueue tq = mock(TransferQueue.class); |
| UUID tqId = UUID.randomUUID(); |
| when(tq.getId()).thenReturn(tqId); |
| when(_virtualHost.getEventLogger()).thenReturn(new EventLogger()); |
| when(_virtualHost.getTransferQueue()).thenReturn(tq); |
| |
| } |
| |
| @SuppressWarnings("unchecked") |
| public void testRecoveryOfSingleMessageOnSingleQueue() |
| { |
| final Queue<?> queue = createRegisteredMockQueue(); |
| |
| final long messageId = 1; |
| final StoredMessage<StorableMessageMetaData> storedMessage = createMockStoredMessage(messageId); |
| |
| MessageStore store = new NullMessageStore() |
| { |
| @Override |
| public void visitMessages(MessageHandler handler) throws StoreException |
| { |
| handler.handle(storedMessage); |
| } |
| |
| @Override |
| public void visitMessageInstances(MessageInstanceHandler handler) throws StoreException |
| { |
| handler.handle(new TestMessageEnqueueRecord(queue.getId(), messageId)); |
| } |
| }; |
| |
| when(_virtualHost.getMessageStore()).thenReturn(store); |
| |
| SynchronousMessageStoreRecoverer |
| recoverer = new SynchronousMessageStoreRecoverer(); |
| recoverer.recover(_virtualHost); |
| |
| ServerMessage<?> message = storedMessage.getMetaData().getType().createMessage(storedMessage); |
| verify(queue, times(1)).recover(eq(message), any(MessageEnqueueRecord.class)); |
| } |
| |
| @SuppressWarnings("unchecked") |
| public void testRecoveryOfMessageInstanceForNonExistingMessage() |
| { |
| final Queue<?> queue = createRegisteredMockQueue(); |
| |
| final long messageId = 1; |
| final Transaction transaction = mock(Transaction.class); |
| |
| MessageStore store = new NullMessageStore() |
| { |
| @Override |
| public void visitMessages(MessageHandler handler) throws StoreException |
| { |
| // no message to visit |
| } |
| |
| @Override |
| public void visitMessageInstances(MessageInstanceHandler handler) throws StoreException |
| { |
| handler.handle(new TestMessageEnqueueRecord(queue.getId(), messageId)); |
| } |
| |
| @Override |
| public Transaction newTransaction() |
| { |
| return transaction; |
| } |
| }; |
| |
| when(_virtualHost.getMessageStore()).thenReturn(store); |
| |
| SynchronousMessageStoreRecoverer |
| recoverer = new SynchronousMessageStoreRecoverer(); |
| recoverer.recover(_virtualHost); |
| |
| verify(queue, never()).enqueue(any(ServerMessage.class), any(Action.class), any(MessageEnqueueRecord.class)); |
| verify(transaction).dequeueMessage(argThat(new MessageEnqueueRecordMatcher(queue.getId(), messageId))); |
| verify(transaction, times(1)).commitTranAsync((Void) null); |
| } |
| |
| public void testRecoveryOfMessageInstanceForNonExistingQueue() |
| { |
| final UUID queueId = UUID.randomUUID(); |
| final Transaction transaction = mock(Transaction.class); |
| final long messageId = 1; |
| final StoredMessage<StorableMessageMetaData> storedMessage = createMockStoredMessage(messageId); |
| |
| MessageStore store = new NullMessageStore() |
| { |
| @Override |
| public void visitMessages(MessageHandler handler) throws StoreException |
| { |
| handler.handle(storedMessage); |
| } |
| |
| @Override |
| public void visitMessageInstances(MessageInstanceHandler handler) throws StoreException |
| { |
| handler.handle(new TestMessageEnqueueRecord(queueId, messageId)); |
| } |
| |
| @Override |
| public Transaction newTransaction() |
| { |
| return transaction; |
| } |
| }; |
| |
| when(_virtualHost.getMessageStore()).thenReturn(store); |
| |
| SynchronousMessageStoreRecoverer |
| recoverer = new SynchronousMessageStoreRecoverer(); |
| recoverer.recover(_virtualHost); |
| |
| verify(transaction).dequeueMessage(argThat(new MessageEnqueueRecordMatcher(queueId,messageId))); |
| verify(transaction, times(1)).commitTranAsync((Void) null); |
| } |
| |
| public void testRecoveryDeletesOrphanMessages() |
| { |
| |
| final long messageId = 1; |
| final StoredMessage<StorableMessageMetaData> storedMessage = createMockStoredMessage(messageId); |
| |
| MessageStore store = new NullMessageStore() |
| { |
| @Override |
| public void visitMessages(MessageHandler handler) throws StoreException |
| { |
| handler.handle(storedMessage); |
| } |
| |
| @Override |
| public void visitMessageInstances(MessageInstanceHandler handler) throws StoreException |
| { |
| // No messages instances |
| } |
| }; |
| |
| when(_virtualHost.getMessageStore()).thenReturn(store); |
| |
| SynchronousMessageStoreRecoverer |
| recoverer = new SynchronousMessageStoreRecoverer(); |
| recoverer.recover(_virtualHost); |
| |
| verify(storedMessage, times(1)).remove(); |
| } |
| |
| @SuppressWarnings("unchecked") |
| public void testRecoveryOfSingleEnqueueWithDistributedTransaction() |
| { |
| Queue<?> queue = createRegisteredMockQueue(); |
| |
| final Transaction transaction = mock(Transaction.class); |
| |
| final StoredMessage<StorableMessageMetaData> storedMessage = createMockStoredMessage(1); |
| long messageId = storedMessage.getMessageNumber(); |
| |
| EnqueueableMessage enqueueableMessage = createMockEnqueueableMessage(messageId, storedMessage); |
| EnqueueRecord enqueueRecord = createMockRecord(queue, enqueueableMessage); |
| |
| final long format = 1; |
| final byte[] globalId = new byte[] {0}; |
| final byte[] branchId = new byte[] {0}; |
| final EnqueueRecord[] enqueues = { enqueueRecord }; |
| final Transaction.DequeueRecord[] dequeues = {}; |
| |
| MessageStore store = new NullMessageStore() |
| { |
| @Override |
| public void visitMessages(MessageHandler handler) throws StoreException |
| { |
| handler.handle(storedMessage); |
| } |
| |
| @Override |
| public void visitMessageInstances(MessageInstanceHandler handler) throws StoreException |
| { |
| // No messages instances |
| } |
| |
| @Override |
| public void visitDistributedTransactions(DistributedTransactionHandler handler) throws StoreException |
| { |
| handler.handle(new Transaction.StoredXidRecord() |
| { |
| @Override |
| public long getFormat() |
| { |
| return format; |
| } |
| |
| @Override |
| public byte[] getGlobalId() |
| { |
| return globalId; |
| } |
| |
| @Override |
| public byte[] getBranchId() |
| { |
| return branchId; |
| } |
| }, enqueues, dequeues); |
| } |
| |
| @Override |
| public Transaction newTransaction() |
| { |
| return transaction; |
| } |
| }; |
| |
| DtxRegistry dtxRegistry = new DtxRegistry(_virtualHost); |
| |
| when(_virtualHost.getMessageStore()).thenReturn(store); |
| when(_virtualHost.getDtxRegistry()).thenReturn(dtxRegistry); |
| |
| SynchronousMessageStoreRecoverer |
| recoverer = new SynchronousMessageStoreRecoverer(); |
| recoverer.recover(_virtualHost); |
| |
| DtxBranch branch = dtxRegistry.getBranch(new Xid(format, globalId, branchId)); |
| assertNotNull("Expected dtx branch to be created", branch); |
| branch.commit(); |
| |
| ServerMessage<?> message = storedMessage.getMetaData().getType().createMessage(storedMessage); |
| verify(queue, times(1)).enqueue(eq(message), (Action<? super BaseMessageInstance>)isNull(), any(MessageEnqueueRecord.class)); |
| verify(transaction).commitTran(); |
| } |
| |
| public void testRecoveryOfSingleDequeueWithDistributedTransaction() |
| { |
| final UUID queueId = UUID.randomUUID(); |
| final Queue<?> queue = createRegisteredMockQueue(queueId); |
| |
| |
| final Transaction transaction = mock(Transaction.class); |
| final StoredMessage<StorableMessageMetaData> storedMessage = createMockStoredMessage(1); |
| final long messageId = storedMessage.getMessageNumber(); |
| |
| Transaction.DequeueRecord dequeueRecord = createMockDequeueRecord(queueId, messageId); |
| |
| QueueEntry queueEntry = mock(QueueEntry.class); |
| when(queueEntry.acquire()).thenReturn(true); |
| when(queue.getMessageOnTheQueue(messageId)).thenReturn(queueEntry); |
| |
| |
| final long format = 1; |
| final byte[] globalId = new byte[] {0}; |
| final byte[] branchId = new byte[] {0}; |
| final EnqueueRecord[] enqueues = {}; |
| final Transaction.DequeueRecord[] dequeues = { dequeueRecord }; |
| |
| MessageStore store = new NullMessageStore() |
| { |
| @Override |
| public void visitMessages(MessageHandler handler) throws StoreException |
| { |
| handler.handle(storedMessage); |
| } |
| |
| @Override |
| public void visitMessageInstances(MessageInstanceHandler handler) throws StoreException |
| { |
| // We need the message to be enqueued onto the queue so that later the distributed transaction |
| // can dequeue it. |
| handler.handle(new TestMessageEnqueueRecord(queue.getId(), messageId)); |
| } |
| |
| @Override |
| public void visitDistributedTransactions(DistributedTransactionHandler handler) throws StoreException |
| { |
| handler.handle(new Transaction.StoredXidRecord() |
| { |
| @Override |
| public long getFormat() |
| { |
| return format; |
| } |
| |
| @Override |
| public byte[] getGlobalId() |
| { |
| return globalId; |
| } |
| |
| @Override |
| public byte[] getBranchId() |
| { |
| return branchId; |
| } |
| }, enqueues, dequeues); |
| } |
| |
| @Override |
| public Transaction newTransaction() |
| { |
| return transaction; |
| } |
| }; |
| |
| DtxRegistry dtxRegistry = new DtxRegistry(_virtualHost); |
| |
| when(_virtualHost.getMessageStore()).thenReturn(store); |
| when(_virtualHost.getDtxRegistry()).thenReturn(dtxRegistry); |
| |
| SynchronousMessageStoreRecoverer |
| recoverer = new SynchronousMessageStoreRecoverer(); |
| recoverer.recover(_virtualHost); |
| |
| DtxBranch branch = dtxRegistry.getBranch(new Xid(format, globalId, branchId)); |
| assertNotNull("Expected dtx branch to be created", branch); |
| branch.commit(); |
| |
| verify(queueEntry, times(1)).delete(); |
| verify(transaction).commitTran(); |
| } |
| |
| |
| protected EnqueueRecord createMockRecord(Queue<?> queue, EnqueueableMessage enqueueableMessage) |
| { |
| EnqueueRecord enqueueRecord = mock(EnqueueRecord.class); |
| when(enqueueRecord.getMessage()).thenReturn(enqueueableMessage); |
| when(enqueueRecord.getResource()).thenReturn(queue); |
| return enqueueRecord; |
| } |
| |
| |
| protected Transaction.DequeueRecord createMockDequeueRecord(UUID queueId, long messageNumber) |
| { |
| Transaction.DequeueRecord dequeueRecord = mock(Transaction.DequeueRecord.class); |
| MessageEnqueueRecord enqueueRecord = mock(MessageEnqueueRecord.class); |
| when(enqueueRecord.getMessageNumber()).thenReturn(messageNumber); |
| when(enqueueRecord.getQueueId()).thenReturn(queueId); |
| when(dequeueRecord.getEnqueueRecord()).thenReturn(enqueueRecord); |
| return dequeueRecord; |
| } |
| |
| protected EnqueueableMessage createMockEnqueueableMessage(long messageId, |
| final StoredMessage<StorableMessageMetaData> storedMessage) |
| { |
| EnqueueableMessage enqueueableMessage = mock(EnqueueableMessage.class); |
| when(enqueueableMessage.getMessageNumber()).thenReturn(messageId); |
| when(enqueueableMessage.getStoredMessage()).thenReturn(storedMessage); |
| return enqueueableMessage; |
| } |
| |
| private StoredMessage<StorableMessageMetaData> createMockStoredMessage(final long messageId) |
| { |
| TestMessageMetaData metaData = new TestMessageMetaData(messageId, 0); |
| |
| @SuppressWarnings("unchecked") |
| final StoredMessage<StorableMessageMetaData> storedMessage = mock(StoredMessage.class); |
| when(storedMessage.getMessageNumber()).thenReturn(messageId); |
| when(storedMessage.getMetaData()).thenReturn(metaData); |
| return storedMessage; |
| } |
| |
| private Queue<?> createRegisteredMockQueue() |
| { |
| return createRegisteredMockQueue(UUID.randomUUID()); |
| } |
| |
| private Queue<?> createRegisteredMockQueue(UUID queueId) |
| { |
| Queue queue = mock(Queue.class); |
| when(queue.getMessageDurability()).thenReturn(MessageDurability.DEFAULT); |
| when(queue.getId()).thenReturn(queueId); |
| when(queue.getName()).thenReturn("test-queue"); |
| when(_virtualHost.getAttainedQueue(queueId)).thenReturn(queue); |
| when(_virtualHost.getAttainedChildFromAddress(Queue.class, "test-queue")).thenReturn(queue); |
| return queue; |
| } |
| |
| |
| private final class MessageEnqueueRecordMatcher extends ArgumentMatcher<MessageEnqueueRecord> |
| { |
| private final long _messageId; |
| private final UUID _queueId; |
| |
| private MessageEnqueueRecordMatcher(UUID queueId, long messageId) |
| { |
| _messageId = messageId; |
| _queueId = queueId; |
| } |
| |
| @Override |
| public boolean matches(Object argument) |
| { |
| return argument instanceof MessageEnqueueRecord |
| && ((MessageEnqueueRecord)argument).getMessageNumber() == _messageId |
| && ((MessageEnqueueRecord)argument).getQueueId().equals(_queueId); |
| } |
| } |
| |
| private class TestMessageEnqueueRecord implements MessageEnqueueRecord |
| { |
| private final UUID _queueId; |
| private final long _messageId; |
| |
| public TestMessageEnqueueRecord(final UUID queueId, final long messageId) |
| { |
| _queueId = queueId; |
| _messageId = messageId; |
| } |
| |
| @Override |
| public UUID getQueueId() |
| { |
| return _queueId; |
| } |
| |
| @Override |
| public long getMessageNumber() |
| { |
| return _messageId; |
| } |
| } |
| } |