test/runner.ts

// Copyright 2020 The Casbin Authors. All Rights Reserved.
//
// Licensed 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.

import type { Instance } from '../src/adapter';

import { newEnforcer, Enforcer, Util } from 'casbin';
import { BasicAdapter } from '../src/adapter';

function array2DEqualsIgnoreOrder(a: string[][], b: string[][]): boolean {
  return Util.array2DEquals(a.sort(), b.sort());
}

async function testGetPolicy(e: Enforcer, res: string[][]): Promise<void> {
  const myRes = await e.getPolicy();
  expect(array2DEqualsIgnoreOrder(res, myRes)).toBe(true);
}

async function testGetGroupingPolicy(
  e: Enforcer,
  res: string[][],
): Promise<void> {
  const myRes = await e.getGroupingPolicy();
  expect(array2DEqualsIgnoreOrder(res, myRes)).toBe(true);
}

export default function <T extends keyof Instance>(
  drive: T,
  client: Instance[T],
) {
  return async function (): Promise<void> {
    const a = await BasicAdapter.newAdapter(drive, client);

    try {
      // Because the DB is empty at first,
      // so we need to load the policy from the file adapter (.CSV) first.
      let e = await newEnforcer(
        'examples/rbac_model.conf',
        'examples/rbac_policy.csv',
      );

      // This is a trick to save the current policy to the DB.
      // We can't call e.savePolicy() because the adapter in the enforcer is still the file adapter.
      // The current policy means the policy in the Node-Casbin enforcer (aka in memory).
      await a.savePolicy(e.getModel());

      // Clear the current policy.
      e.clearPolicy();
      testGetPolicy(e, []);

      // Load the policy from DB.
      await a.loadPolicy(e.getModel());
      testGetPolicy(e, [
        ['alice', 'data1', 'read'],
        ['bob', 'data2', 'write'],
        ['data2_admin', 'data2', 'read'],
        ['data2_admin', 'data2', 'write'],
      ]);

      // Note: you don't need to look at the above code
      // if you already have a working DB with policy inside.

      // Now the DB has policy, so we can provide a normal use case.
      // Create an adapter and an enforcer.
      // newEnforcer() will load the policy automatically.
      e = await newEnforcer('examples/rbac_model.conf', a);
      testGetPolicy(e, [
        ['alice', 'data1', 'read'],
        ['bob', 'data2', 'write'],
        ['data2_admin', 'data2', 'read'],
        ['data2_admin', 'data2', 'write'],
      ]);

      // Add policy to DB
      await a.addPolicy('', 'p', ['role', 'res', 'action']);
      e = await newEnforcer('examples/rbac_model.conf', a);
      testGetPolicy(e, [
        ['alice', 'data1', 'read'],
        ['bob', 'data2', 'write'],
        ['data2_admin', 'data2', 'read'],
        ['data2_admin', 'data2', 'write'],
        ['role', 'res', 'action'],
      ]);

      // Add policyList to DB
      await a.addPolicies('', 'p', [
        ['role', 'res', 'GET'],
        ['role', 'res', 'POST'],
      ]);
      e = await newEnforcer('examples/rbac_model.conf', a);
      testGetPolicy(e, [
        ['alice', 'data1', 'read'],
        ['bob', 'data2', 'write'],
        ['data2_admin', 'data2', 'read'],
        ['data2_admin', 'data2', 'write'],
        ['role', 'res', 'action'],
        ['role', 'res', 'GET'],
        ['role', 'res', 'POST'],
      ]);

      // Remove policy from DB
      await a.removePolicy('', 'p', ['role', 'res', 'action']);
      e = await newEnforcer('examples/rbac_model.conf', a);
      testGetPolicy(e, [
        ['alice', 'data1', 'read'],
        ['bob', 'data2', 'write'],
        ['data2_admin', 'data2', 'read'],
        ['data2_admin', 'data2', 'write'],
        ['role', 'res', 'GET'],
        ['role', 'res', 'POST'],
      ]);

      // Remove policyList from DB
      await a.removePolicies('', 'p', [
        ['role', 'res', 'GET'],
        ['role', 'res', 'POST'],
      ]);
      e = await newEnforcer('examples/rbac_model.conf', a);
      testGetPolicy(e, [
        ['alice', 'data1', 'read'],
        ['bob', 'data2', 'write'],
        ['data2_admin', 'data2', 'read'],
        ['data2_admin', 'data2', 'write'],
      ]);

      testGetGroupingPolicy(e, [['alice', 'data2_admin']]);

      // Remove groupingPolicy from DB
      await e.deleteUser('alice');
      testGetGroupingPolicy(e, []);
    } finally {
      await a.close();
    }
  };
}