/*
 * 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.sentry.tests.e2e.hive;

import static org.junit.Assert.assertFalse;
import static org.junit.Assert.assertTrue;

import java.sql.Connection;
import java.sql.SQLException;
import java.sql.Statement;
import java.util.Arrays;
import java.util.Collection;
import org.apache.sentry.core.model.db.DBModelAction;
import org.junit.AfterClass;
import org.junit.Before;
import org.junit.BeforeClass;
import org.junit.Test;
import org.junit.runner.RunWith;
import org.junit.runners.Parameterized;

@RunWith(Parameterized.class)
public class TestShowMetadataPrivileges extends AbstractTestWithStaticConfiguration {
  protected static final boolean ALLOWED = true;
  protected static final boolean NOT_ALLOWED = false;
  protected static final String SERVER1 = "server1";

  protected static Connection adminCon, user1Con;
  protected static Statement adminStmt, user1Stmt;

  protected DBModelAction action;
  protected boolean allowed;

  @Parameterized.Parameters
  public static Collection describePrivileges() {
    return Arrays.asList(new Object[][] {
      { null,                  NOT_ALLOWED }, // Means no privileges
      { DBModelAction.ALL,     ALLOWED },
      { DBModelAction.CREATE,  ALLOWED },
      { DBModelAction.SELECT,  ALLOWED },
      { DBModelAction.INSERT,  ALLOWED },
      { DBModelAction.ALTER,   ALLOWED },
      { DBModelAction.DROP,    ALLOWED },
      { DBModelAction.INDEX,   ALLOWED },
      { DBModelAction.LOCK,    ALLOWED },
    });
  }

  @BeforeClass
  public static void setupTestStaticConfiguration() throws Exception{
    useSentryService = true;
    restrictDefaultDatabase = true;
    AbstractTestWithStaticConfiguration.setupTestStaticConfiguration();
    setupAdmin();

    adminCon = context.createConnection(ADMIN1);
    adminStmt = context.createStatement(adminCon);
    user1Con = context.createConnection(USER1_1);
    user1Stmt = context.createStatement(user1Con);
  }

  @AfterClass
  public static void destroy() throws SQLException {
    adminStmt.close();
    adminCon.close();
    user1Stmt.close();
    user1Con.close();
  }

  public TestShowMetadataPrivileges(DBModelAction action, boolean allowed) {
    this.action = action;
    this.allowed = allowed;
  }

  @Before
  public void setup() throws Exception {
    adminStmt.execute("DROP DATABASE IF EXISTS " + DB1 + " CASCADE");
    adminStmt.execute("CREATE DATABASE " + DB1);
    adminStmt.execute("CREATE TABLE " + DB1 + "." + TBL1 + " (id int)");
    adminStmt.execute("CREATE ROLE role1");
    adminStmt.execute("GRANT ROLE role1 TO group " + USERGROUP1);
  }

  @Test
  public void testShowTablesWithGrantOnTable() throws Exception {
    if (action != null) {
      if (action == DBModelAction.CREATE) {
        // CREATE is not supported at the table level
        return;
      }

      adminStmt.execute("GRANT " + action + " ON TABLE " + DB1 + "." + TBL1 + " TO ROLE role1");
    }

    user1Stmt.execute("SHOW TABLES IN " + DB1);
    if (!allowed) {
      assertFalse(
        "SHOW TABLES should NOT display tables with " + action + " privileges on the table.",
        user1Stmt.getResultSet().next());
    } else {
      assertTrue(
        "SHOW TABLES should display tables with " + action + " privileges on the table.",
        user1Stmt.getResultSet().next());
    }
  }

  @Test
  public void testShowTablesWithGrantOnDatabase() throws Exception {
    if (action != null) {
      adminStmt.execute("GRANT " + action + " ON DATABASE " + DB1 + " TO ROLE role1");
    }

    user1Stmt.execute("SHOW TABLES IN " + DB1);
    if (!allowed) {
      assertFalse(
        "SHOW TABLES should NOT display tables with " + action + " privileges on the database.",
        user1Stmt.getResultSet().next());
    } else {
      assertTrue(
        "SHOW TABLES should display tables with " + action + " privileges on the database.",
        user1Stmt.getResultSet().next());
    }
  }

  @Test
  public void testShowTablesWithGrantOnServer() throws Exception {
    if (action != null) {
      adminStmt.execute("GRANT " + action + " ON SERVER " + SERVER1 + " TO ROLE role1");
    }

    user1Stmt.execute("SHOW TABLES IN " + DB1);
    if (!allowed) {
      assertFalse(
        "SHOW TABLES should NOT display tables with " + action + " privileges on the server.",
        user1Stmt.getResultSet().next());
    } else {
      assertTrue(
        "SHOW TABLES should display tables with " + action + " privileges on the server.",
        user1Stmt.getResultSet().next());
    }
  }

  @Test
  public void testShowDatabasesWithGrantOnDatabase() throws Exception {
    if (action != null) {
      adminStmt.execute("GRANT " + action + " ON DATABASE " + DB1 + " TO ROLE role1");
    }

    user1Stmt.execute("SHOW DATABASES");
    if (!allowed) {
      assertFalse(
          "SHOW DATABASES should NOT display databases with " + action + " privileges on the database.",
          user1Stmt.getResultSet().next());
    } else {
      assertTrue(
          "SHOW DATABASES should display databases with " + action + " privileges on the database.",
          user1Stmt.getResultSet().next());
    }
  }

  @Test
  public void testShowDatabasesWithGrantOnServer() throws Exception {
    if (action != null) {
      adminStmt.execute("GRANT " + action + " ON SERVER " + SERVER1 + " TO ROLE role1");
    }

    user1Stmt.execute("SHOW DATABASES");
    if (!allowed) {
      assertFalse(
          "SHOW DATABASES should NOT display databases with " + action + " privileges on the server.",
          user1Stmt.getResultSet().next());
    } else {
      assertTrue(
          "SHOW DATABASES should display databases with " + action + " privileges on the server.",
          user1Stmt.getResultSet().next());
    }
  }
}