testing

Classes

TestRbacModule

Defined in: src/testing/test-rbac.module.ts:14

Constructors

Constructor

new TestRbacModule(): TestRbacModule;

Returns

TestRbacModule

Methods

forRoot()

static forRoot(options?): DynamicModule;

Defined in: src/testing/test-rbac.module.ts:15

Parameters

Parameter	Type
options	TestRbacModuleOptions

Returns

DynamicModule

Interfaces

RbacScenario

Defined in: src/testing/rbac-scenario.ts:18

Properties

rbac

rbac: RbacService;

Defined in: src/testing/rbac-scenario.ts:20

storage

storage: InMemoryRbacStorage;

Defined in: src/testing/rbac-scenario.ts:19

---

RbacScenarioInput

Defined in: src/testing/rbac-scenario.ts:12

Properties

bindings?

optional bindings?: AssignRoleInput[];

Defined in: src/testing/rbac-scenario.ts:14

options?

optional options?: Omit<RbacModuleOptions, "storage">;

Defined in: src/testing/rbac-scenario.ts:15

roles?

optional roles?: CreateRoleInput[];

Defined in: src/testing/rbac-scenario.ts:13

---

TestRbacModuleOptions

Defined in: src/testing/test-rbac.module.ts:6

Extends

• Omit<RbacModuleOptions, "storage" | "subjectResolver">

Properties

auditLogger?

optional auditLogger?: RbacAuditLogger;

Defined in: src/interfaces/module-options.ts:44

Inherited from

RbacModuleOptions.auditLogger

changePublisher?

optional changePublisher?: RbacPolicyChangePublisher;

Defined in: src/interfaces/module-options.ts:55

Inherited from

RbacModuleOptions.changePublisher

logAllowedDecisions?

optional logAllowedDecisions?: boolean;

Defined in: src/interfaces/module-options.ts:53

Inherited from

RbacModuleOptions.logAllowedDecisions

now?

optional now?: () => Date;

Defined in: src/interfaces/module-options.ts:56

Returns

Date

Inherited from

RbacModuleOptions.now

requireMetadata?

optional requireMetadata?: boolean;

Defined in: src/interfaces/module-options.ts:45

Inherited from

RbacModuleOptions.requireMetadata

storage?

optional storage?: RbacStorage;

Defined in: src/testing/test-rbac.module.ts:8

storageErrors?

optional storageErrors?: "deny" | "throw";

Defined in: src/interfaces/module-options.ts:52

Inherited from

RbacModuleOptions.storageErrors

subject?

optional subject?: RbacSubject;

Defined in: src/testing/test-rbac.module.ts:9

subjectResolver?

optional subjectResolver?: RbacSubjectResolver;

Defined in: src/testing/test-rbac.module.ts:10

tenant?

optional tenant?: {
  allowGlobalRolesInTenant?: boolean;
  requiredByDefault?: boolean;
};

Defined in: src/interfaces/module-options.ts:46

allowGlobalRolesInTenant?

optional allowGlobalRolesInTenant?: boolean;

requiredByDefault?

optional requiredByDefault?: boolean;

Inherited from

RbacModuleOptions.tenant

tenantResolver?

optional tenantResolver?: RbacTenantResolver;

Defined in: src/interfaces/module-options.ts:43

Inherited from

RbacModuleOptions.tenantResolver

writeValidation?

optional writeValidation?: RbacWriteValidationOptions;

Defined in: src/interfaces/module-options.ts:54

Inherited from

RbacModuleOptions.writeValidation

Type Aliases

RbacMatrixCase

type RbacMatrixCase = RbacCanInput & {
  allowed: boolean;
  label?: string;
  reason?: RbacDecisionReason;
};

Defined in: src/testing/rbac-scenario.ts:23

Type Declaration

Name	Type	Defined in
allowed	boolean	src/testing/rbac-scenario.ts:24
label?	string	src/testing/rbac-scenario.ts:26
reason?	RbacDecisionReason	src/testing/rbac-scenario.ts:25

Variables

apiKey

const apiKey: (id, tenantId?) => RbacSubject = rbacApiKey;

Defined in: src/testing/subjects.ts:22

Parameters

Parameter	Type
id	string
tenantId?	string | null

Returns

RbacSubject

---

serviceAccount

const serviceAccount: (id, tenantId?) => RbacSubject = rbacServiceAccount;

Defined in: src/testing/subjects.ts:23

Parameters

Parameter	Type
id	string
tenantId?	string | null

Returns

RbacSubject

---

user

const user: (id, tenantId?) => RbacSubject = rbacUser;

Defined in: src/testing/subjects.ts:21

Parameters

Parameter	Type
id	string
tenantId?	string | null

Returns

RbacSubject

Functions

createRbacScenario()

function createRbacScenario(input?): Promise<RbacScenario>;

Defined in: src/testing/rbac-scenario.ts:50

Parameters

Parameter	Type
input	RbacScenarioInput

Returns

Promise<RbacScenario>

---

expectAllowed()

function expectAllowed(rbac, input): Promise<RbacDecision>;

Defined in: src/testing/expect-rbac-decision.ts:4

Parameters

Parameter	Type
rbac	RbacService
input	RbacCanInput

Returns

Promise<RbacDecision>

---

expectDenied()

function expectDenied(
   rbac,
   input,
reason?): Promise<RbacDecision>;

Defined in: src/testing/expect-rbac-decision.ts:16

Parameters

Parameter	Type
rbac	RbacService
input	RbacCanInput
reason?	RbacDecisionReason

Returns

Promise<RbacDecision>

---

expectDeniedReason()

function expectDeniedReason(
   rbac,
   input,
reason): Promise<RbacDecision>;

Defined in: src/testing/expect-rbac-decision.ts:32

Parameters

Parameter	Type
rbac	RbacService
input	RbacCanInput
reason	RbacDecisionReason

Returns

Promise<RbacDecision>

---

expectRbacMatrix()

function expectRbacMatrix(rbac, cases): Promise<RbacDecision[]>;

Defined in: src/testing/rbac-scenario.ts:64

Parameters

Parameter	Type
rbac	RbacService
cases	RbacMatrixCase[]

Returns

Promise<RbacDecision[]>

---

rbacApiKey()

function rbacApiKey(id, tenantId?): RbacSubject;

Defined in: src/testing/subjects.ts:9

Parameters

Parameter	Type
id	string
tenantId?	string | null

Returns

RbacSubject

---

rbacServiceAccount()

function rbacServiceAccount(id, tenantId?): RbacSubject;

Defined in: src/testing/subjects.ts:15

Parameters

Parameter	Type
id	string
tenantId?	string | null

Returns

RbacSubject

---

rbacUser()

function rbacUser(id, tenantId?): RbacSubject;

Defined in: src/testing/subjects.ts:3

Parameters

Parameter	Type
id	string
tenantId?	string | null

Returns

RbacSubject