sijie commented on a change in pull request #510: Issue-605 BP-15 New CreateLedger API URL: https://github.com/apache/bookkeeper/pull/510#discussion_r143036128
########## File path: bookkeeper-server/src/test/java/org/apache/bookkeeper/client/MockBookKeeperTestCase.java ########## @@ -0,0 +1,390 @@ +/** + * 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.bookkeeper.client; + +import static org.mockito.Mockito.mock; +import static org.mockito.Mockito.when; + +import com.google.common.base.Optional; +import io.netty.buffer.ByteBuf; +import io.netty.buffer.Unpooled; +import io.netty.util.internal.ConcurrentSet; +import java.util.ArrayList; +import java.util.Arrays; +import java.util.concurrent.ConcurrentHashMap; +import java.util.concurrent.ConcurrentMap; +import java.util.concurrent.ConcurrentSkipListSet; +import java.util.concurrent.Executors; +import java.util.concurrent.RejectedExecutionException; +import java.util.concurrent.ScheduledExecutorService; +import java.util.concurrent.ScheduledThreadPoolExecutor; +import java.util.concurrent.ThreadFactory; +import java.util.concurrent.ThreadPoolExecutor; +import java.util.concurrent.atomic.AtomicLong; +import java.util.concurrent.locks.ReentrantReadWriteLock; +import org.apache.bookkeeper.client.api.CreateBuilder; +import org.apache.bookkeeper.client.api.DeleteBuilder; +import org.apache.bookkeeper.client.api.OpenBuilder; +import org.apache.bookkeeper.conf.ClientConfiguration; +import org.apache.bookkeeper.meta.LedgerIdGenerator; +import org.apache.bookkeeper.meta.LedgerManager; +import org.apache.bookkeeper.net.BookieSocketAddress; +import org.apache.bookkeeper.proto.BookieClient; +import org.apache.bookkeeper.proto.BookkeeperInternalCallbacks; +import org.apache.bookkeeper.stats.NullStatsLogger; +import org.apache.bookkeeper.util.OrderedSafeExecutor; +import org.apache.commons.lang3.concurrent.BasicThreadFactory; +import org.junit.After; +import org.junit.Before; +import static org.mockito.ArgumentMatchers.any; +import static org.mockito.ArgumentMatchers.anyInt; +import static org.mockito.ArgumentMatchers.anyLong; +import static org.mockito.ArgumentMatchers.eq; +import org.mockito.Mockito; +import static org.mockito.Mockito.doAnswer; +import org.mockito.invocation.InvocationOnMock; +import org.mockito.stubbing.Answer; +import org.slf4j.Logger; +import org.slf4j.LoggerFactory; + +/** + * Base class for Mock-based Client testcases + */ +public abstract class MockBookKeeperTestCase { + + private final static Logger LOG = LoggerFactory.getLogger(MockBookKeeperTestCase.class); + + protected ScheduledExecutorService scheduler; + protected OrderedSafeExecutor executor; + protected BookKeeper bk; + protected BookieClient bookieClient; + protected LedgerManager ledgerManager; + protected LedgerIdGenerator ledgerIdGenerator; + + private BookieWatcher bookieWatcher; + + protected ConcurrentMap<Long, LedgerMetadata> mockLedgerMetadataRegistry = new ConcurrentHashMap<>(); + protected AtomicLong mockNextLedgerId = new AtomicLong(1); + protected ConcurrentSkipListSet<Long> fencedLedgers = new ConcurrentSkipListSet<>(); + + @Before + public void setup() throws Exception { + scheduler = new ScheduledThreadPoolExecutor(4); + executor = OrderedSafeExecutor.newBuilder().build(); + bookieWatcher = mock(BookieWatcher.class); + + bookieClient = mock(BookieClient.class); + ledgerManager = mock(LedgerManager.class); + ledgerIdGenerator = mock(LedgerIdGenerator.class); + + bk = mock(BookKeeper.class); + + NullStatsLogger nullStatsLogger = setupLoggers(); + + when(bk.getCloseLock()).thenReturn(new ReentrantReadWriteLock()); + when(bk.isClosed()).thenReturn(false); + when(bk.getBookieWatcher()).thenReturn(bookieWatcher); + when(bk.getExplicitLacInterval()).thenReturn(0); + when(bk.getMainWorkerPool()).thenReturn(executor); + when(bk.getBookieClient()).thenReturn(bookieClient); + when(bk.getScheduler()).thenReturn(scheduler); + when(bk.getReadSpeculativeRequestPolicy()).thenReturn(Optional.absent()); + when(bk.getConf()).thenReturn(new ClientConfiguration()); + when(bk.getStatsLogger()).thenReturn(nullStatsLogger); + when(bk.getLedgerManager()).thenReturn(ledgerManager); + when(bk.getLedgerIdGenerator()).thenReturn(ledgerIdGenerator); + + setupLedgerIdGenerator(); + + setupCreateLedgerMetadata(); + setupReadLedgerMetadata(); + setupWriteLedgerMetadata(); + setupRemoveLedgerMetadata(); + setupRegisterLedgerMetadataListener(); + setupBookieWatcherForNewEnsemble(); + setupBookieClientDefaultNoSuchEntryException(); + setupBookieClientAddEntry(); + } + + protected NullStatsLogger setupLoggers() { + NullStatsLogger nullStatsLogger = new NullStatsLogger(); + when(bk.getOpenOpLogger()).thenReturn(nullStatsLogger.getOpStatsLogger("mock")); + when(bk.getRecoverOpLogger()).thenReturn(nullStatsLogger.getOpStatsLogger("mock")); + when(bk.getAddOpLogger()).thenReturn(nullStatsLogger.getOpStatsLogger("mock")); + when(bk.getReadOpLogger()).thenReturn(nullStatsLogger.getOpStatsLogger("mock")); + when(bk.getDeleteOpLogger()).thenReturn(nullStatsLogger.getOpStatsLogger("mock")); + when(bk.getCreateOpLogger()).thenReturn(nullStatsLogger.getOpStatsLogger("mock")); + when(bk.getRecoverAddCountLogger()).thenReturn(nullStatsLogger.getOpStatsLogger("mock")); + when(bk.getRecoverReadCountLogger()).thenReturn(nullStatsLogger.getOpStatsLogger("mock")); + return nullStatsLogger; + } + + @After + public void tearDown() { + scheduler.shutdown(); + executor.shutdown(); + } + + protected void setBookkeeperConfig(ClientConfiguration config) { + when(bk.getConf()).thenReturn(config); + } + + protected CreateBuilder newCreateLedgerOp() { + return new LedgerCreateOp.CreateBuilderImpl(bk); + } + + protected OpenBuilder newOpenLedgerOp() { + return new LedgerOpenOp.OpenBuilderImpl(bk); + } + + protected DeleteBuilder newDeleteLedgerOp() { + return new LedgerDeleteOp.DeleteBuilderImpl(bk); + } + + protected void closeBookkeeper() { + when(bk.isClosed()).thenReturn(true); + } + + protected BookieSocketAddress generateBookieSocketAddress(int index) { + return new BookieSocketAddress("localhost", 1111 + index); + } + + protected ArrayList<BookieSocketAddress> generateNewEnsemble(int ensembleSize) { + ArrayList<BookieSocketAddress> ensemble = new ArrayList<>(ensembleSize); + for (int i = 0; i < ensembleSize; i++) { + ensemble.add(generateBookieSocketAddress(i)); + } + return ensemble; + } + + private void setupBookieWatcherForNewEnsemble() throws BKException.BKNotEnoughBookiesException { + when(bookieWatcher.newEnsemble(anyInt(), anyInt(), anyInt(), any())) + .thenAnswer((Answer<ArrayList<BookieSocketAddress>>) new Answer<ArrayList<BookieSocketAddress>>() { + @Override + @SuppressWarnings("unchecked") + public ArrayList<BookieSocketAddress> answer(InvocationOnMock invocation) throws Throwable { + Object[] args = invocation.getArguments(); + int ensembleSize = (Integer) args[0]; + return generateNewEnsemble(ensembleSize); + } + }); + } + + protected void setupBookieClientAddEntry() { + doAnswer((Answer) (InvocationOnMock invokation) -> { + Object[] args = invokation.getArguments(); + BookkeeperInternalCallbacks.WriteCallback callback = (BookkeeperInternalCallbacks.WriteCallback) args[5]; + BookieSocketAddress bookieSocketAddress = (BookieSocketAddress) args[0]; + long _ledgerId = (Long) args[1]; Review comment: I don't think we use "_xyz" for variables. I would stick to be just "ledgerId" to be consistent. I see this pattern has been used in multiple places in this class. ---------------------------------------------------------------- This is an automated message from the Apache Git Service. To respond to the message, please log on GitHub and use the URL above to go to the specific comment. For queries about this service, please contact Infrastructure at: [email protected] With regards, Apache Git Services
