/**
    * 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.hadoop.hbase.regionserver;
  
  import static org.junit.Assert.assertEquals;
  import static org.junit.Assert.assertNotNull;
  
  import java.util.ArrayList;
  import java.util.List;
  
  import org.apache.hadoop.hbase.HBaseTestingUtility;
  import org.apache.hadoop.hbase.HColumnDescriptor;
  import org.apache.hadoop.hbase.HConstants;
  import org.apache.hadoop.hbase.HTableDescriptor;
  import org.apache.hadoop.hbase.TableName;
  import org.apache.hadoop.hbase.client.Admin;
  import org.apache.hadoop.hbase.client.Put;
  import org.apache.hadoop.hbase.client.Scan;
  import org.apache.hadoop.hbase.client.Table;
  import org.apache.hadoop.hbase.master.cleaner.TimeToLiveHFileCleaner;
  import org.apache.hadoop.hbase.regionserver.compactions.CompactionConfiguration;
  import org.apache.hadoop.hbase.regionserver.wal.FSHLog;
  import org.apache.hadoop.hbase.testclassification.LargeTests;
  import org.apache.hadoop.hbase.util.Bytes;
  import org.apache.hadoop.hbase.util.JVMClusterUtil;
  import org.junit.After;
  import org.junit.AfterClass;
  import org.junit.Before;
  import org.junit.BeforeClass;
  import org.junit.Test;
  import org.junit.experimental.categories.Category;
  import org.slf4j.Logger;
  import org.slf4j.LoggerFactory;
  
  @Category({LargeTests.class})
  public class TestCleanupCompactedFileAfterFailover {
  
    private static final Logger LOG =
        LoggerFactory.getLogger(TestCleanupCompactedFileAfterFailover.class);
  
    private static HBaseTestingUtility TEST_UTIL;
    private static Admin admin;
    private static Table table;
  
    private static TableName TABLE_NAME = TableName.valueOf("TestCleanupCompactedFileAfterFailover");
    private static byte[] ROW = Bytes.toBytes("row");
    private static byte[] FAMILY = Bytes.toBytes("cf");
    private static byte[] QUALIFIER = Bytes.toBytes("cq");
    private static byte[] VALUE = Bytes.toBytes("value");
    private static final int RS_NUMBER = 5;
  
    @BeforeClass
    public static void beforeClass() throws Exception {
      TEST_UTIL = new HBaseTestingUtility();
      // Set the scanner lease to 20min, so the scanner can't be closed by RegionServer
      TEST_UTIL.getConfiguration().setInt(HConstants.HBASE_CLIENT_SCANNER_TIMEOUT_PERIOD, 1200000);
      TEST_UTIL.getConfiguration()
          .setInt(CompactionConfiguration.HBASE_HSTORE_COMPACTION_MIN_KEY, 100);
      TEST_UTIL.getConfiguration().set("dfs.blocksize", "64000");
      TEST_UTIL.getConfiguration().set("dfs.namenode.fs-limits.min-block-size", "1024");
      TEST_UTIL.getConfiguration().set(TimeToLiveHFileCleaner.TTL_CONF_KEY, "0");
      TEST_UTIL.startMiniCluster(RS_NUMBER);
      admin = TEST_UTIL.getHBaseAdmin();
    }
  
    @AfterClass
    public static void afterClass() throws Exception {
      TEST_UTIL.shutdownMiniCluster();
    }
  
    @Before
    public void before() throws Exception {
      HTableDescriptor htd = new HTableDescriptor(TABLE_NAME);
      htd.addFamily(new HColumnDescriptor(FAMILY));
      admin.createTable(htd);
      TEST_UTIL.waitTableAvailable(TABLE_NAME, 30000);
      table = TEST_UTIL.getConnection().getTable(TABLE_NAME);
    }
  
    @After
    public void after() throws Exception {
      admin.disableTable(TABLE_NAME);
      admin.deleteTable(TABLE_NAME);
    }
 
   @Test
   public void testCleanupAfterFailoverWithCompactOnce() throws Exception {
     testCleanupAfterFailover(1);
   }
 
   @Test
   public void testCleanupAfterFailoverWithCompactTwice() throws Exception {
     testCleanupAfterFailover(2);
   }
 
   @Test
   public void testCleanupAfterFailoverWithCompactThreeTimes() throws Exception {
     testCleanupAfterFailover(3);
   }
 
   private void testCleanupAfterFailover(int compactNum) throws Exception {
     HRegionServer rsServedTable = null;
     List<Region> regions = new ArrayList<>();
     for (JVMClusterUtil.RegionServerThread rsThread : TEST_UTIL.getHBaseCluster()
         .getLiveRegionServerThreads()) {
       HRegionServer rs = rsThread.getRegionServer();
       if (rs.getOnlineTables().contains(TABLE_NAME)) {
         regions.addAll(rs.getOnlineRegions(TABLE_NAME));
         rsServedTable = rs;
       }
     }
     assertNotNull(rsServedTable);
     assertEquals("Table should only have one region", 1, regions.size());
     HRegion region = (HRegion)regions.get(0);
     HStore store = (HStore)region.getStore(FAMILY);
 
     writeDataAndFlush(3, region);
     assertEquals(3, store.getStorefilesCount());
 
     // Open a scanner and not close, then the storefile will be referenced
     store.getScanner(new Scan(), null, Long.MAX_VALUE);
 
     region.compact(true);
     assertEquals(1, store.getStorefilesCount());
     // The compacted file should not be archived as there are references by user scanner
     assertEquals(3, store.getStoreEngine().getStoreFileManager().getCompactedfiles().size());
 
     for (int i = 1; i < compactNum; i++) {
       // Compact again
       region.compact(true);
       assertEquals(1, store.getStorefilesCount());
       store.closeAndArchiveCompactedFiles();
       // Compacted storefiles still be 3 as the new compacted storefile was archived
       assertEquals(3, store.getStoreEngine().getStoreFileManager().getCompactedfiles().size());
     }
 
     int walNum = ((FSHLog)(rsServedTable.getWAL(null))).getNumLogFiles();
     // Roll WAL
     rsServedTable.walRoller.requestRollAll();
     // Flush again
     region.flush(true);
     // The WAL which contains compaction event marker should be archived
     assertEquals("The old WAL should be archived", walNum,
       ((FSHLog)(rsServedTable.getWAL(null))).getNumLogFiles());
 
     rsServedTable.kill();
     // Sleep to wait failover
     Thread.sleep(3000);
     TEST_UTIL.waitTableAvailable(TABLE_NAME, 30000);
 
     regions.clear();
     for (JVMClusterUtil.RegionServerThread rsThread : TEST_UTIL.getHBaseCluster()
         .getLiveRegionServerThreads()) {
       HRegionServer rs = rsThread.getRegionServer();
       if (rs != rsServedTable && rs.getOnlineTables().contains(TABLE_NAME)) {
         regions.addAll(rs.getOnlineRegions(TABLE_NAME));
       }
     }
     assertEquals("Table should only have one region", 1, regions.size());
     region = (HRegion)regions.get(0);
     store = (HStore)region.getStore(FAMILY);
     // The compacted storefile should be cleaned and only have 1 storefile
     assertEquals(1, store.getStorefilesCount());
   }
 
   private void writeDataAndFlush(int fileNum, HRegion region) throws Exception {
     for (int i = 0; i < fileNum; i++) {
       for (int j = 0; j < 100; j++) {
         table.put(new Put(concat(ROW, j)).addColumn(FAMILY, QUALIFIER, concat(VALUE, j)));
       }
       region.flush(true);
     }
   }
 
   private byte[] concat(byte[] base, int index) {
     return Bytes.toBytes(Bytes.toString(base) + "-" + index);
   }
 }