test/unit/org/apache/cassandra/db/virtual/PermissionsCacheKeysTableTest.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.cassandra.db.virtual;

import java.util.Arrays;
import java.util.List;
import java.util.Set;

import com.google.common.collect.ImmutableList;
import org.junit.AfterClass;
import org.junit.Before;
import org.junit.BeforeClass;
import org.junit.Test;

import org.apache.cassandra.auth.AuthTestUtils;
import org.apache.cassandra.auth.AuthenticatedUser;
import org.apache.cassandra.auth.DataResource;
import org.apache.cassandra.auth.IAuthorizer;
import org.apache.cassandra.auth.IResource;
import org.apache.cassandra.auth.IRoleManager;
import org.apache.cassandra.auth.Permission;
import org.apache.cassandra.auth.RoleResource;
import org.apache.cassandra.config.DatabaseDescriptor;
import org.apache.cassandra.cql3.CQLTester;

import static org.apache.cassandra.auth.AuthTestUtils.ROLE_A;
import static org.apache.cassandra.auth.AuthTestUtils.ROLE_B;

public class PermissionsCacheKeysTableTest extends CQLTester
{
    private static final String KS_NAME = "vts";

    @SuppressWarnings("FieldCanBeLocal")
    private PermissionsCacheKeysTable table;

    @BeforeClass
    public static void setUpClass()
    {
        // high value is used for convenient debugging
        DatabaseDescriptor.setPermissionsValidity(20_000);

        CQLTester.setUpClass();
        CQLTester.requireAuthentication();

        IRoleManager roleManager = DatabaseDescriptor.getRoleManager();
        roleManager.createRole(AuthenticatedUser.SYSTEM_USER, ROLE_A, AuthTestUtils.getLoginRoleOptions());
        roleManager.createRole(AuthenticatedUser.SYSTEM_USER, ROLE_B, AuthTestUtils.getLoginRoleOptions());

        List<IResource> resources = Arrays.asList(
                DataResource.root(),
                DataResource.keyspace(KEYSPACE),
                DataResource.table(KEYSPACE, "t1"));

        IAuthorizer authorizer = DatabaseDescriptor.getAuthorizer();
        for (IResource resource : resources)
        {
            Set<Permission> permissions = resource.applicablePermissions();
            authorizer.grant(AuthenticatedUser.SYSTEM_USER, permissions, resource, ROLE_A);
            authorizer.grant(AuthenticatedUser.SYSTEM_USER, permissions, resource, ROLE_B);
        }
    }

    @Before
    public void config()
    {
        table = new PermissionsCacheKeysTable(KS_NAME);
        VirtualKeyspaceRegistry.instance.register(new VirtualKeyspace(KS_NAME, ImmutableList.of(table)));

        // ensure nothing keeps cached between tests
        AuthenticatedUser.permissionsCache.invalidate();
        disablePreparedReuseForTest();
    }

    @AfterClass
    public static void tearDownClass()
    {
        DatabaseDescriptor.setPermissionsValidity(DatabaseDescriptor.getRawConfig().permissions_validity.toMilliseconds());
    }

    @Test
    public void testSelectAllWhenPermissionsAreNotCached() throws Throwable
    {
        assertEmpty(execute("SELECT * FROM vts.permissions_cache_keys"));
    }

    @Test
    public void testSelectAllWhenPermissionsAreCached() throws Throwable
    {
        cachePermissionsForResource(ROLE_A, DataResource.root());
        cachePermissionsForResource(ROLE_A, DataResource.keyspace(KEYSPACE));
        cachePermissionsForResource(ROLE_B, DataResource.table(KEYSPACE, "t1"));

        assertRows(execute("SELECT * FROM vts.permissions_cache_keys"),
                row("role_a", "data"),
                row("role_a", "data/cql_test_keyspace"),
                row("role_b", "data/cql_test_keyspace/t1"));
    }

    @Test
    public void testSelectPartitionWhenPermissionsAreNotCached() throws Throwable
    {
        assertEmpty(execute("SELECT * FROM vts.permissions_cache_keys WHERE role='role_a' AND resource='data'"));
    }

    @Test
    public void testSelectPartitionWhenPermissionsAreCached() throws Throwable
    {
        cachePermissionsForResource(ROLE_A, DataResource.root());
        cachePermissionsForResource(ROLE_A, DataResource.keyspace(KEYSPACE));
        cachePermissionsForResource(ROLE_B, DataResource.table(KEYSPACE, "t1"));

        assertRows(execute("SELECT * FROM vts.permissions_cache_keys WHERE role='role_a' AND resource='data'"),
                row("role_a", "data"));
    }

    @Test
    public void testDeletePartition() throws Throwable
    {
        cachePermissionsForResource(ROLE_A, DataResource.root());
        cachePermissionsForResource(ROLE_A, DataResource.keyspace(KEYSPACE));

        execute("DELETE FROM vts.permissions_cache_keys WHERE role='role_a' AND resource='data'");

        assertRows(execute("SELECT * FROM vts.permissions_cache_keys"),
                row("role_a", "data/cql_test_keyspace"));
    }

    @Test
    public void testDeletePartitionWithInvalidValues() throws Throwable
    {
        cachePermissionsForResource(ROLE_A, DataResource.root());

        execute("DELETE FROM vts.permissions_cache_keys WHERE role='invalid_role' AND resource='data'");
        execute("DELETE FROM vts.permissions_cache_keys WHERE role='role_a' AND resource='invalid_resource'");

        assertRows(execute("SELECT * FROM vts.permissions_cache_keys WHERE role='role_a' AND resource='data'"),
                row("role_a", "data"));
    }

    @Test
    public void testTruncateTable() throws Throwable
    {
        cachePermissionsForResource(ROLE_A, DataResource.root());
        cachePermissionsForResource(ROLE_B, DataResource.table(KEYSPACE, "t1"));

        execute("TRUNCATE vts.permissions_cache_keys");

        assertEmpty(execute("SELECT * FROM vts.permissions_cache_keys"));
    }

    @Test
    public void testUnsupportedOperations() throws Throwable
    {
        // range tombstone is not supported, however, this table has no clustering columns, so it is not covered by tests

        // column deletion is not supported, however, this table has no regular columns, so it is not covered by tests

        // insert is not supported
        assertInvalidMessage("Column modification is not supported by table vts.permissions_cache_keys",
                "INSERT INTO vts.permissions_cache_keys (role, resource) VALUES ('role_e', 'data')");

        // update is not supported, however, this table has no regular columns, so it is not covered by tests
    }

    private void cachePermissionsForResource(RoleResource roleResource, IResource resource)
    {
        AuthenticatedUser role = new AuthenticatedUser(roleResource.getRoleName());
        role.getPermissions(resource);
    }
}