/**
    * 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.mapreduce;
  
  import static org.junit.Assert.assertEquals;
  import static org.junit.Assert.assertTrue;
  
  import java.io.IOException;
  import java.security.PrivilegedExceptionAction;
  import java.util.ArrayList;
  import java.util.Arrays;
  import java.util.HashSet;
  import java.util.List;
  import java.util.Set;
  import java.util.UUID;
  
  import org.apache.commons.logging.Log;
  import org.apache.commons.logging.LogFactory;
  import org.apache.hadoop.conf.Configurable;
  import org.apache.hadoop.conf.Configuration;
  import org.apache.hadoop.fs.FSDataOutputStream;
  import org.apache.hadoop.fs.FileStatus;
  import org.apache.hadoop.fs.FileSystem;
  import org.apache.hadoop.fs.Path;
  import org.apache.hadoop.hbase.Cell;
  import org.apache.hadoop.hbase.CellUtil;
  import org.apache.hadoop.hbase.HBaseTestingUtility;
  import org.apache.hadoop.hbase.HConstants;
  import org.apache.hadoop.hbase.TableName;
  import org.apache.hadoop.hbase.client.Admin;
  import org.apache.hadoop.hbase.client.Connection;
  import org.apache.hadoop.hbase.client.ConnectionFactory;
  import org.apache.hadoop.hbase.client.Delete;
  import org.apache.hadoop.hbase.client.HBaseAdmin;
  import org.apache.hadoop.hbase.client.HTable;
  import org.apache.hadoop.hbase.client.Result;
  import org.apache.hadoop.hbase.client.ResultScanner;
  import org.apache.hadoop.hbase.client.Scan;
  import org.apache.hadoop.hbase.client.Table;
  import org.apache.hadoop.hbase.io.hfile.CacheConfig;
  import org.apache.hadoop.hbase.io.hfile.HFile;
  import org.apache.hadoop.hbase.io.hfile.HFileScanner;
  import org.apache.hadoop.hbase.protobuf.generated.VisibilityLabelsProtos.VisibilityLabelsResponse;
  import org.apache.hadoop.hbase.security.User;
  import org.apache.hadoop.hbase.security.visibility.Authorizations;
  import org.apache.hadoop.hbase.security.visibility.CellVisibility;
  import org.apache.hadoop.hbase.security.visibility.ScanLabelGenerator;
  import org.apache.hadoop.hbase.security.visibility.SimpleScanLabelGenerator;
  import org.apache.hadoop.hbase.security.visibility.VisibilityClient;
  import org.apache.hadoop.hbase.security.visibility.VisibilityConstants;
  import org.apache.hadoop.hbase.security.visibility.VisibilityController;
  import org.apache.hadoop.hbase.security.visibility.VisibilityTestUtil;
  import org.apache.hadoop.hbase.security.visibility.VisibilityUtils;
  import org.apache.hadoop.hbase.testclassification.LargeTests;
  import org.apache.hadoop.hbase.util.Bytes;
  import org.apache.hadoop.mapred.Utils.OutputFileUtils.OutputFilesFilter;
  import org.apache.hadoop.util.Tool;
  import org.apache.hadoop.util.ToolRunner;
  import org.junit.AfterClass;
  import org.junit.BeforeClass;
  import org.junit.Test;
  import org.junit.experimental.categories.Category;
  
  @Category(LargeTests.class)
  public class TestImportTSVWithVisibilityLabels implements Configurable {
  
    private static final Log LOG = LogFactory.getLog(TestImportTSVWithVisibilityLabels.class);
    protected static final String NAME = TestImportTsv.class.getSimpleName();
    protected static HBaseTestingUtility util = new HBaseTestingUtility();
  
    /**
     * Delete the tmp directory after running doMROnTableTest. Boolean. Default is
     * false.
     */
    protected static final String DELETE_AFTER_LOAD_CONF = NAME + ".deleteAfterLoad";
  
    /**
     * Force use of combiner in doMROnTableTest. Boolean. Default is true.
     */
    protected static final String FORCE_COMBINER_CONF = NAME + ".forceCombiner";
  
    private final String FAMILY = "FAM";
    private final static String TOPSECRET = "topsecret";
    private final static String PUBLIC = "public";
   private final static String PRIVATE = "private";
   private final static String CONFIDENTIAL = "confidential";
   private final static String SECRET = "secret";
   private static User SUPERUSER;
   private static Configuration conf;
 
   @Override
   public Configuration getConf() {
     return util.getConfiguration();
   }
 
   @Override
   public void setConf(Configuration conf) {
     throw new IllegalArgumentException("setConf not supported");
   }
 
   @BeforeClass
   public static void provisionCluster() throws Exception {
     conf = util.getConfiguration();
     SUPERUSER = User.createUserForTesting(conf, "admin", new String[] { "supergroup" });
     conf.set("hbase.superuser", "admin,"+User.getCurrent().getName());
     VisibilityTestUtil.enableVisiblityLabels(conf);
     conf.setClass(VisibilityUtils.VISIBILITY_LABEL_GENERATOR_CLASS, SimpleScanLabelGenerator.class,
         ScanLabelGenerator.class);
     util.setJobWithoutMRCluster();
     util.startMiniCluster();
     // Wait for the labels table to become available
     util.waitTableEnabled(VisibilityConstants.LABELS_TABLE_NAME.getName(), 50000);
     createLabels();
   }
 
   private static void createLabels() throws IOException, InterruptedException {
     PrivilegedExceptionAction<VisibilityLabelsResponse> action =
         new PrivilegedExceptionAction<VisibilityLabelsResponse>() {
       @Override
       public VisibilityLabelsResponse run() throws Exception {
         String[] labels = { SECRET, TOPSECRET, CONFIDENTIAL, PUBLIC, PRIVATE };
         try (Connection conn = ConnectionFactory.createConnection(conf)) {
           VisibilityClient.addLabels(conn, labels);
           LOG.info("Added labels ");
         } catch (Throwable t) {
           LOG.error("Error in adding labels" , t);
           throw new IOException(t);
         }
         return null;
       }
     };
     SUPERUSER.runAs(action);
   }
 
   @AfterClass
   public static void releaseCluster() throws Exception {
     util.shutdownMiniCluster();
   }
 
   @Test
   public void testMROnTable() throws Exception {
     String tableName = "test-" + UUID.randomUUID();
 
     // Prepare the arguments required for the test.
     String[] args = new String[] {
         "-D" + ImportTsv.MAPPER_CONF_KEY
             + "=org.apache.hadoop.hbase.mapreduce.TsvImporterMapper",
         "-D" + ImportTsv.COLUMNS_CONF_KEY + "=HBASE_ROW_KEY,FAM:A,FAM:B,HBASE_CELL_VISIBILITY",
         "-D" + ImportTsv.SEPARATOR_CONF_KEY + "=\u001b", tableName };
     String data = "KEY\u001bVALUE1\u001bVALUE2\u001bsecret&private\n";
     util.createTable(TableName.valueOf(tableName), FAMILY);
     doMROnTableTest(util, FAMILY, data, args, 1);
     util.deleteTable(tableName);
   }
 
   @Test
   public void testMROnTableWithDeletes() throws Exception {
     TableName tableName = TableName.valueOf("test-" + UUID.randomUUID());
 
     // Prepare the arguments required for the test.
     String[] args = new String[] {
         "-D" + ImportTsv.MAPPER_CONF_KEY + "=org.apache.hadoop.hbase.mapreduce.TsvImporterMapper",
         "-D" + ImportTsv.COLUMNS_CONF_KEY + "=HBASE_ROW_KEY,FAM:A,FAM:B,HBASE_CELL_VISIBILITY",
         "-D" + ImportTsv.SEPARATOR_CONF_KEY + "=\u001b", tableName.getNameAsString() };
     String data = "KEY\u001bVALUE1\u001bVALUE2\u001bsecret&private\n";
     util.createTable(tableName, FAMILY);
     doMROnTableTest(util, FAMILY, data, args, 1);
     issueDeleteAndVerifyData(tableName);
     util.deleteTable(tableName);
   }
 
   private void issueDeleteAndVerifyData(TableName tableName) throws IOException {
     LOG.debug("Validating table after delete.");
     Table table = new HTable(conf, tableName);
     boolean verified = false;
     long pause = conf.getLong("hbase.client.pause", 5 * 1000);
     int numRetries = conf.getInt(HConstants.HBASE_CLIENT_RETRIES_NUMBER, 5);
     for (int i = 0; i < numRetries; i++) {
       try {
         Delete d = new Delete(Bytes.toBytes("KEY"));
         d.deleteFamily(Bytes.toBytes(FAMILY));
         d.setCellVisibility(new CellVisibility("private&secret"));
         table.delete(d);
 
         Scan scan = new Scan();
         // Scan entire family.
         scan.addFamily(Bytes.toBytes(FAMILY));
         scan.setAuthorizations(new Authorizations("secret", "private"));
         ResultScanner resScanner = table.getScanner(scan);
         Result[] next = resScanner.next(5);
         assertEquals(0, next.length);
         verified = true;
         break;
       } catch (NullPointerException e) {
         // If here, a cell was empty. Presume its because updates came in
         // after the scanner had been opened. Wait a while and retry.
       }
       try {
         Thread.sleep(pause);
       } catch (InterruptedException e) {
         // continue
       }
     }
     table.close();
     assertTrue(verified);
   }
 
   @Test
   public void testMROnTableWithBulkload() throws Exception {
     String tableName = "test-" + UUID.randomUUID();
     Path hfiles = new Path(util.getDataTestDirOnTestFS(tableName), "hfiles");
     // Prepare the arguments required for the test.
     String[] args = new String[] {
         "-D" + ImportTsv.BULK_OUTPUT_CONF_KEY + "=" + hfiles.toString(),
         "-D" + ImportTsv.COLUMNS_CONF_KEY
             + "=HBASE_ROW_KEY,FAM:A,FAM:B,HBASE_CELL_VISIBILITY",
         "-D" + ImportTsv.SEPARATOR_CONF_KEY + "=\u001b", tableName };
     String data = "KEY\u001bVALUE1\u001bVALUE2\u001bsecret&private\n";
     util.createTable(TableName.valueOf(tableName), FAMILY);
     doMROnTableTest(util, FAMILY, data, args, 1);
     util.deleteTable(tableName);
   }
 
   @Test
   public void testBulkOutputWithTsvImporterTextMapper() throws Exception {
     String table = "test-" + UUID.randomUUID();
     String FAMILY = "FAM";
     Path bulkOutputPath = new Path(util.getDataTestDirOnTestFS(table),"hfiles");
     // Prepare the arguments required for the test.
     String[] args =
         new String[] {
             "-D" + ImportTsv.MAPPER_CONF_KEY
                 + "=org.apache.hadoop.hbase.mapreduce.TsvImporterTextMapper",
             "-D" + ImportTsv.COLUMNS_CONF_KEY
                 + "=HBASE_ROW_KEY,FAM:A,FAM:B,HBASE_CELL_VISIBILITY",
             "-D" + ImportTsv.SEPARATOR_CONF_KEY + "=\u001b",
             "-D" + ImportTsv.BULK_OUTPUT_CONF_KEY + "=" + bulkOutputPath.toString(), table
             };
     String data = "KEY\u001bVALUE4\u001bVALUE8\u001bsecret&private\n";
     doMROnTableTest(util, FAMILY, data, args, 4);
     util.deleteTable(table);
   }
 
   @Test
   public void testMRWithOutputFormat() throws Exception {
     String tableName = "test-" + UUID.randomUUID();
     Path hfiles = new Path(util.getDataTestDirOnTestFS(tableName), "hfiles");
     // Prepare the arguments required for the test.
     String[] args = new String[] {
         "-D" + ImportTsv.MAPPER_CONF_KEY
             + "=org.apache.hadoop.hbase.mapreduce.TsvImporterMapper",
         "-D" + ImportTsv.BULK_OUTPUT_CONF_KEY + "=" + hfiles.toString(),
         "-D" + ImportTsv.COLUMNS_CONF_KEY + "=HBASE_ROW_KEY,FAM:A,FAM:B,HBASE_CELL_VISIBILITY",
         "-D" + ImportTsv.SEPARATOR_CONF_KEY + "=\u001b", tableName };
     String data = "KEY\u001bVALUE4\u001bVALUE8\u001bsecret&private\n";
     util.createTable(TableName.valueOf(tableName), FAMILY);
     doMROnTableTest(util, FAMILY, data, args, 1);
     util.deleteTable(tableName);
   }
 
   @Test
   public void testBulkOutputWithInvalidLabels() throws Exception {
     TableName tableName = TableName.valueOf("test-" + UUID.randomUUID());
     Path hfiles = new Path(util.getDataTestDirOnTestFS(tableName.getNameAsString()), "hfiles");
     // Prepare the arguments required for the test.
     String[] args =
         new String[] { "-D" + ImportTsv.BULK_OUTPUT_CONF_KEY + "=" + hfiles.toString(),
             "-D" + ImportTsv.COLUMNS_CONF_KEY + "=HBASE_ROW_KEY,FAM:A,FAM:B,HBASE_CELL_VISIBILITY",
             "-D" + ImportTsv.SEPARATOR_CONF_KEY + "=\u001b", tableName.getNameAsString() };
 
     // 2 Data rows, one with valid label and one with invalid label
     String data =
         "KEY\u001bVALUE1\u001bVALUE2\u001bprivate\nKEY1\u001bVALUE1\u001bVALUE2\u001binvalid\n";
     util.createTable(tableName, FAMILY);
     doMROnTableTest(util, FAMILY, data, args, 1, 2);
     util.deleteTable(tableName);
   }
 
   @Test
   public void testBulkOutputWithTsvImporterTextMapperWithInvalidLabels() throws Exception {
     TableName tableName = TableName.valueOf("test-" + UUID.randomUUID());
     Path hfiles = new Path(util.getDataTestDirOnTestFS(tableName.getNameAsString()), "hfiles");
     // Prepare the arguments required for the test.
     String[] args =
         new String[] {
             "-D" + ImportTsv.MAPPER_CONF_KEY
                 + "=org.apache.hadoop.hbase.mapreduce.TsvImporterTextMapper",
             "-D" + ImportTsv.BULK_OUTPUT_CONF_KEY + "=" + hfiles.toString(),
             "-D" + ImportTsv.COLUMNS_CONF_KEY + "=HBASE_ROW_KEY,FAM:A,FAM:B,HBASE_CELL_VISIBILITY",
             "-D" + ImportTsv.SEPARATOR_CONF_KEY + "=\u001b", tableName.getNameAsString() };
 
     // 2 Data rows, one with valid label and one with invalid label
     String data =
         "KEY\u001bVALUE1\u001bVALUE2\u001bprivate\nKEY1\u001bVALUE1\u001bVALUE2\u001binvalid\n";
     util.createTable(tableName, FAMILY);
     doMROnTableTest(util, FAMILY, data, args, 1, 2);
     util.deleteTable(tableName);
   }
 
   protected static Tool doMROnTableTest(HBaseTestingUtility util, String family, String data,
       String[] args, int valueMultiplier) throws Exception {
     return doMROnTableTest(util, family, data, args, valueMultiplier, -1);
   }
 
 
   /**
    * Run an ImportTsv job and perform basic validation on the results. Returns
    * the ImportTsv <code>Tool</code> instance so that other tests can inspect it
    * for further validation as necessary. This method is static to insure
    * non-reliance on instance's util/conf facilities.
    *
    * @param args
    *          Any arguments to pass BEFORE inputFile path is appended.
    * @param expectedKVCount Expected KV count. pass -1 to skip the kvcount check
    *
    * @return The Tool instance used to run the test.
    */
   protected static Tool doMROnTableTest(HBaseTestingUtility util, String family, String data,
       String[] args, int valueMultiplier, int expectedKVCount) throws Exception {
     TableName table = TableName.valueOf(args[args.length - 1]);
     Configuration conf = new Configuration(util.getConfiguration());
 
     // populate input file
     FileSystem fs = FileSystem.get(conf);
     Path inputPath = fs.makeQualified(new Path(util
         .getDataTestDirOnTestFS(table.getNameAsString()), "input.dat"));
     FSDataOutputStream op = fs.create(inputPath, true);
     if (data == null) {
       data = "KEY\u001bVALUE1\u001bVALUE2\n";
     }
     op.write(Bytes.toBytes(data));
     op.close();
     LOG.debug(String.format("Wrote test data to file: %s", inputPath));
 
     if (conf.getBoolean(FORCE_COMBINER_CONF, true)) {
       LOG.debug("Forcing combiner.");
       conf.setInt("mapreduce.map.combine.minspills", 1);
     }
 
     // run the import
     List<String> argv = new ArrayList<String>(Arrays.asList(args));
     argv.add(inputPath.toString());
     Tool tool = new ImportTsv();
     LOG.debug("Running ImportTsv with arguments: " + argv);
     assertEquals(0, ToolRunner.run(conf, tool, argv.toArray(args)));
 
     // Perform basic validation. If the input args did not include
     // ImportTsv.BULK_OUTPUT_CONF_KEY then validate data in the table.
     // Otherwise, validate presence of hfiles.
     boolean createdHFiles = false;
     String outputPath = null;
     for (String arg : argv) {
       if (arg.contains(ImportTsv.BULK_OUTPUT_CONF_KEY)) {
         createdHFiles = true;
         // split '-Dfoo=bar' on '=' and keep 'bar'
         outputPath = arg.split("=")[1];
         break;
       }
     }
     LOG.debug("validating the table " + createdHFiles);
     if (createdHFiles)
       validateHFiles(fs, outputPath, family, expectedKVCount);
     else
       validateTable(conf, table, family, valueMultiplier);
 
     if (conf.getBoolean(DELETE_AFTER_LOAD_CONF, true)) {
       LOG.debug("Deleting test subdirectory");
       util.cleanupDataTestDirOnTestFS(table.getNameAsString());
     }
     return tool;
   }
 
   /**
    * Confirm ImportTsv via HFiles on fs.
    */
   private static void validateHFiles(FileSystem fs, String outputPath, String family,
       int expectedKVCount) throws IOException {
 
     // validate number and content of output columns
     LOG.debug("Validating HFiles.");
     Set<String> configFamilies = new HashSet<String>();
     configFamilies.add(family);
     Set<String> foundFamilies = new HashSet<String>();
     int actualKVCount = 0;
     for (FileStatus cfStatus : fs.listStatus(new Path(outputPath), new OutputFilesFilter())) {
       LOG.debug("The output path has files");
       String[] elements = cfStatus.getPath().toString().split(Path.SEPARATOR);
       String cf = elements[elements.length - 1];
       foundFamilies.add(cf);
       assertTrue(String.format(
           "HFile ouput contains a column family (%s) not present in input families (%s)", cf,
           configFamilies), configFamilies.contains(cf));
       for (FileStatus hfile : fs.listStatus(cfStatus.getPath())) {
         assertTrue(String.format("HFile %s appears to contain no data.", hfile.getPath()),
             hfile.getLen() > 0);
         if (expectedKVCount > -1) {
           actualKVCount += getKVCountFromHfile(fs, hfile.getPath());
         }
       }
     }
     if (expectedKVCount > -1) {
       assertTrue(String.format(
         "KV count in output hfile=<%d> doesn't match with expected KV count=<%d>", actualKVCount,
         expectedKVCount), actualKVCount == expectedKVCount);
     }
   }
 
   /**
    * Method returns the total KVs in given hfile
    * @param fs File System
    * @param p HFile path
    * @return KV count in the given hfile
    * @throws IOException
    */
   private static int getKVCountFromHfile(FileSystem fs, Path p) throws IOException {
     Configuration conf = util.getConfiguration();
     HFile.Reader reader = HFile.createReader(fs, p, new CacheConfig(conf), conf);
     reader.loadFileInfo();
     HFileScanner scanner = reader.getScanner(false, false);
     scanner.seekTo();
     int count = 0;
     do {
       count++;
     } while (scanner.next());
     reader.close();
     return count;
   }
 
   /**
    * Confirm ImportTsv via data in online table.
    */
   private static void validateTable(Configuration conf, TableName tableName, String family,
       int valueMultiplier) throws IOException {
 
     LOG.debug("Validating table.");
     Table table = new HTable(conf, tableName);
     boolean verified = false;
     long pause = conf.getLong("hbase.client.pause", 5 * 1000);
     int numRetries = conf.getInt(HConstants.HBASE_CLIENT_RETRIES_NUMBER, 5);
     for (int i = 0; i < numRetries; i++) {
       try {
         Scan scan = new Scan();
         // Scan entire family.
         scan.addFamily(Bytes.toBytes(family));
         scan.setAuthorizations(new Authorizations("secret","private"));
         ResultScanner resScanner = table.getScanner(scan);
         Result[] next = resScanner.next(5);
         assertEquals(1, next.length);
         for (Result res : resScanner) {
           LOG.debug("Getting results " + res.size());
           assertTrue(res.size() == 2);
           List<Cell> kvs = res.listCells();
           assertTrue(CellUtil.matchingRow(kvs.get(0), Bytes.toBytes("KEY")));
           assertTrue(CellUtil.matchingRow(kvs.get(1), Bytes.toBytes("KEY")));
           assertTrue(CellUtil.matchingValue(kvs.get(0), Bytes.toBytes("VALUE" + valueMultiplier)));
           assertTrue(CellUtil.matchingValue(kvs.get(1),
               Bytes.toBytes("VALUE" + 2 * valueMultiplier)));
           // Only one result set is expected, so let it loop.
         }
         verified = true;
         break;
       } catch (NullPointerException e) {
         // If here, a cell was empty. Presume its because updates came in
         // after the scanner had been opened. Wait a while and retry.
       }
       try {
         Thread.sleep(pause);
       } catch (InterruptedException e) {
         // continue
       }
     }
     table.close();
     assertTrue(verified);
   }
 
 }