tephra-core/src/test/java/org/apache/tephra/ThriftTransactionSystemTest.java

/*
 * 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.tephra;

import com.google.inject.AbstractModule;
import com.google.inject.Guice;
import com.google.inject.Inject;
import com.google.inject.Injector;
import com.google.inject.Provider;
import com.google.inject.Scopes;
import com.google.inject.util.Modules;
import org.apache.hadoop.conf.Configuration;
import org.apache.tephra.distributed.RetryNTimes;
import org.apache.tephra.distributed.RetryStrategy;
import org.apache.tephra.distributed.TransactionService;
import org.apache.tephra.persist.LocalFileTransactionStateStorage;
import org.apache.tephra.persist.TransactionStateStorage;
import org.apache.tephra.runtime.ConfigModule;
import org.apache.tephra.runtime.DiscoveryModules;
import org.apache.tephra.runtime.TransactionClientModule;
import org.apache.tephra.runtime.TransactionModules;
import org.apache.tephra.runtime.ZKModule;
import org.apache.tephra.txprune.TransactionPruningService;
import org.apache.tephra.util.Tests;
import org.apache.twill.discovery.DiscoveryService;
import org.apache.twill.internal.zookeeper.InMemoryZKServer;
import org.apache.twill.zookeeper.ZKClient;
import org.apache.twill.zookeeper.ZKClientService;
import org.junit.AfterClass;
import org.junit.Assert;
import org.junit.Before;
import org.junit.BeforeClass;
import org.junit.ClassRule;
import org.junit.Test;
import org.junit.rules.TemporaryFolder;
import org.slf4j.Logger;
import org.slf4j.LoggerFactory;

import java.util.concurrent.TimeUnit;
import java.util.concurrent.atomic.AtomicInteger;

public class ThriftTransactionSystemTest extends TransactionSystemTest {
  private static final Logger LOG = LoggerFactory.getLogger(ThriftTransactionSystemTest.class);
  
  private static InMemoryZKServer zkServer;
  private static ZKClientService zkClientService;
  private static TransactionService txService;
  private static TransactionStateStorage storage;
  private static TransactionSystemClient txClient;

  private static AtomicInteger pruneRuns = new AtomicInteger();

  @ClassRule
  public static TemporaryFolder tmpFolder = new TemporaryFolder();
  
  @BeforeClass
  public static void start() throws Exception {
    zkServer = InMemoryZKServer.builder().setDataDir(tmpFolder.newFolder()).build();
    zkServer.startAndWait();

    Configuration conf = getCommonConfiguration(null);
    conf.setBoolean(TxConstants.Manager.CFG_DO_PERSIST, false);
    conf.set(TxConstants.Service.CFG_DATA_TX_ZOOKEEPER_QUORUM, zkServer.getConnectionStr());
    // we want to use a retry strategy that lets us query the number of times it retried:
    conf.set(TxConstants.Service.CFG_DATA_TX_CLIENT_RETRY_STRATEGY, CountingRetryStrategyProvider.class.getName());
    conf.setInt(TxConstants.Service.CFG_DATA_TX_CLIENT_ATTEMPTS, 2);
    conf.setInt(TxConstants.Manager.CFG_TX_MAX_TIMEOUT, (int) TimeUnit.DAYS.toSeconds(5)); // very long limit
    conf.set(TxConstants.Manager.CFG_TX_SNAPSHOT_LOCAL_DIR, tmpFolder.newFolder().toString());

    Injector injector = Guice.createInjector(
      new ConfigModule(conf),
      new ZKModule(),
      new DiscoveryModules().getDistributedModules(),
      Modules.override(new TransactionModules().getDistributedModules())
        .with(new AbstractModule() {
          @Override
          protected void configure() {
            bind(TransactionStateStorage.class).to(LocalFileTransactionStateStorage.class).in(Scopes.SINGLETON);
            bind(TransactionService.class).to(TestTransactionService.class).in(Scopes.SINGLETON);
          }
        }),
      new TransactionClientModule()
    );

    zkClientService = injector.getInstance(ZKClientService.class);
    zkClientService.startAndWait();

    // start a tx server
    txService = injector.getInstance(TransactionService.class);
    storage = injector.getInstance(TransactionStateStorage.class);
    txClient = injector.getInstance(TransactionSystemClient.class);
    try {
      LOG.info("Starting transaction service");
      storage.startAndWait();
      txService.startAndWait();
    } catch (Exception e) {
      LOG.error("Failed to start service: ", e);
      throw e;
    }

    Tests.waitForTxReady(txClient);
  }
  
  @Before
  public void reset() throws Exception {
    getClient().resetState();
  }
  
  @AfterClass
  public static void stop() throws Exception {
    txService.stopAndWait();
    storage.stopAndWait();
    zkClientService.stopAndWait();
    zkServer.stopAndWait();
  }
  
  @Override
  protected TransactionSystemClient getClient() throws Exception {
    return txClient;
  }

  @Override
  protected TransactionStateStorage getStateStorage() throws Exception {
    return storage;
  }

  @Override
  public void testNegativeTimeout() throws Exception {
    // the super class tests that this throws IllegalArgumentException
    // here we want to test additionally that the thrift client does not retry the request. That makes sense for
    // other errors such as a lost connection, but not if the provided timeout argument was invalid.
    CountingRetryStrategyProvider.retries.set(0);
    super.testNegativeTimeout();
    Assert.assertEquals(0, CountingRetryStrategyProvider.retries.get());
  }

  @Override
  public void testExcessiveTimeout() throws Exception {
    // the super class tests that this throws IllegalArgumentException
    // here we want to test additionally that the thrift client does not retry the request. That makes sense for
    // other errors such as a lost connection, but not if the provided timeout argument was invalid.
    CountingRetryStrategyProvider.retries.set(0);
    super.testExcessiveTimeout();
    Assert.assertEquals(0, CountingRetryStrategyProvider.retries.get());
  }

  @Test
  public void testPruneNow() {
    int runs = pruneRuns.get();
    txClient.pruneNow();
    Assert.assertEquals(pruneRuns.get(), runs + 1);
  }

  // implements a retry strategy that lets us verify how many times it retried
  public static class CountingRetryStrategyProvider extends RetryNTimes.Provider {

    static AtomicInteger retries = new AtomicInteger();

    @Override
    public RetryStrategy newRetryStrategy() {
      final RetryStrategy delegate = super.newRetryStrategy();
      return new RetryStrategy() {
        @Override
        public boolean failOnce() {
          return delegate.failOnce();
        }
        @Override
        public void beforeRetry() {
          retries.incrementAndGet();
          delegate.beforeRetry();
        }
      };
    }
  }

  public static class TestTransactionService extends TransactionService {
    @Inject
    public TestTransactionService(Configuration conf, ZKClient zkClient,
                                  DiscoveryService discoveryService,
                                  Provider<TransactionManager> txManagerProvider) {
      super(conf, zkClient, discoveryService, txManagerProvider);
    }

    @Override
    protected TransactionPruningService createPruningService(Configuration conf, TransactionManager txManager) {
      return new TransactionPruningService(conf, txManager) {
        @Override
        public void pruneNow() {
          pruneRuns.incrementAndGet();
        }
      };
    }
  }
}