feat(rbac): role-based access control module (#14310)

This commit is contained in:
Carlos R. L. Rodrigues
2026-01-07 05:36:39 -03:00
committed by GitHub
parent d6d7d14a6a
commit 1bfde8dc57
74 changed files with 4186 additions and 3 deletions
@@ -0,0 +1,285 @@
import { medusaIntegrationTestRunner } from "@medusajs/test-utils"
import {
adminHeaders,
createAdminUser,
} from "../../../../helpers/create-admin-user"
jest.setTimeout(60000)
medusaIntegrationTestRunner({
testSuite: ({ dbConnection, api, getContainer }) => {
let container
beforeEach(async () => {
container = getContainer()
await createAdminUser(dbConnection, adminHeaders, container)
})
describe("RBAC Policies - Admin API", () => {
describe("POST /admin/rbac/policies", () => {
it("should create a policy", async () => {
const response = await api.post(
"/admin/rbac/policies",
{
key: "read:products",
resource: "product",
operation: "read",
name: "Read Products",
description: "Permission to read products",
},
adminHeaders
)
expect(response.status).toEqual(200)
expect(response.data.policy).toEqual(
expect.objectContaining({
id: expect.any(String),
key: "read:products",
resource: "product",
operation: "read",
name: "Read Products",
description: "Permission to read products",
})
)
})
it("should create a policy with metadata", async () => {
const response = await api.post(
"/admin/rbac/policies",
{
key: "write:orders",
resource: "order",
operation: "write",
name: "Write Orders",
metadata: { category: "order_management" },
},
adminHeaders
)
expect(response.status).toEqual(200)
expect(response.data.policy).toEqual(
expect.objectContaining({
key: "write:orders",
resource: "order",
operation: "write",
metadata: { category: "order_management" },
})
)
})
})
describe("GET /admin/rbac/policies", () => {
beforeEach(async () => {
await api.post(
"/admin/rbac/policies",
{
key: "read:products",
resource: "product",
operation: "read",
name: "Read Products",
},
adminHeaders
)
await api.post(
"/admin/rbac/policies",
{
key: "write:products",
resource: "product",
operation: "write",
name: "Write Products",
},
adminHeaders
)
await api.post(
"/admin/rbac/policies",
{
key: "read:orders",
resource: "order",
operation: "read",
name: "Read Orders",
},
adminHeaders
)
})
it("should list all policies", async () => {
const response = await api.get("/admin/rbac/policies", adminHeaders)
expect(response.status).toEqual(200)
expect(response.data.count).toEqual(3)
expect(response.data.policies).toEqual(
expect.arrayContaining([
expect.objectContaining({
key: "read:products",
resource: "product",
operation: "read",
}),
expect.objectContaining({
key: "write:products",
resource: "product",
operation: "write",
}),
expect.objectContaining({
key: "read:orders",
resource: "order",
operation: "read",
}),
])
)
})
it("should filter policies by resource", async () => {
const response = await api.get(
"/admin/rbac/policies?resource=product",
adminHeaders
)
expect(response.status).toEqual(200)
expect(response.data.count).toEqual(2)
expect(response.data.policies).toEqual(
expect.arrayContaining([
expect.objectContaining({
key: "read:products",
resource: "product",
}),
expect.objectContaining({
key: "write:products",
resource: "product",
}),
])
)
})
it("should filter policies by operation", async () => {
const response = await api.get(
"/admin/rbac/policies?operation=read",
adminHeaders
)
expect(response.status).toEqual(200)
expect(response.data.count).toEqual(2)
expect(response.data.policies).toEqual(
expect.arrayContaining([
expect.objectContaining({
key: "read:products",
operation: "read",
}),
expect.objectContaining({
key: "read:orders",
operation: "read",
}),
])
)
})
})
describe("GET /admin/rbac/policies/:id", () => {
it("should retrieve a policy by id", async () => {
const createResponse = await api.post(
"/admin/rbac/policies",
{
key: "delete:users",
resource: "user",
operation: "delete",
name: "Delete Users",
},
adminHeaders
)
const policyId = createResponse.data.policy.id
const response = await api.get(
`/admin/rbac/policies/${policyId}`,
adminHeaders
)
expect(response.status).toEqual(200)
expect(response.data.policy).toEqual(
expect.objectContaining({
id: policyId,
key: "delete:users",
resource: "user",
operation: "delete",
name: "Delete Users",
})
)
})
})
describe("POST /admin/rbac/policies/:id", () => {
it("should update a policy", async () => {
const createResponse = await api.post(
"/admin/rbac/policies",
{
key: "admin:system",
resource: "system",
operation: "admin",
name: "System Admin",
},
adminHeaders
)
const policyId = createResponse.data.policy.id
const response = await api.post(
`/admin/rbac/policies/${policyId}`,
{
name: "System Administrator",
description: "Full system access",
},
adminHeaders
)
expect(response.status).toEqual(200)
expect(response.data.policy).toEqual(
expect.objectContaining({
id: policyId,
key: "admin:system",
name: "System Administrator",
description: "Full system access",
})
)
})
})
describe("DELETE /admin/rbac/policies/:id", () => {
it("should delete a policy", async () => {
const createResponse = await api.post(
"/admin/rbac/policies",
{
key: "test:delete",
resource: "test",
operation: "delete",
name: "Test Delete",
},
adminHeaders
)
const policyId = createResponse.data.policy.id
const deleteResponse = await api.delete(
`/admin/rbac/policies/${policyId}`,
adminHeaders
)
expect(deleteResponse.status).toEqual(200)
expect(deleteResponse.data).toEqual({
id: policyId,
object: "rbac_policy",
deleted: true,
})
const listResponse = await api.get(
"/admin/rbac/policies",
adminHeaders
)
expect(
listResponse.data.policies.find((p) => p.id === policyId)
).toBeUndefined()
})
})
})
},
})
@@ -0,0 +1,384 @@
import { medusaIntegrationTestRunner } from "@medusajs/test-utils"
import {
adminHeaders,
createAdminUser,
} from "../../../../helpers/create-admin-user"
jest.setTimeout(60000)
medusaIntegrationTestRunner({
testSuite: ({ dbConnection, api, getContainer }) => {
let container
beforeEach(async () => {
container = getContainer()
await createAdminUser(dbConnection, adminHeaders, container)
})
describe("RBAC Roles - Admin API", () => {
describe("POST /admin/rbac/roles", () => {
it("should create a role", async () => {
const response = await api.post(
"/admin/rbac/roles",
{
name: "Viewer",
description: "Can view resources",
},
adminHeaders
)
expect(response.status).toEqual(200)
expect(response.data.role).toEqual(
expect.objectContaining({
id: expect.any(String),
name: "Viewer",
description: "Can view resources",
})
)
})
it("should create a role with metadata", async () => {
const response = await api.post(
"/admin/rbac/roles",
{
name: "Editor",
description: "Can edit resources",
metadata: { department: "sales" },
},
adminHeaders
)
expect(response.status).toEqual(200)
expect(response.data.role).toEqual(
expect.objectContaining({
name: "Editor",
metadata: { department: "sales" },
})
)
})
})
describe("GET /admin/rbac/roles", () => {
beforeEach(async () => {
await api.post(
"/admin/rbac/roles",
{
name: "Viewer",
description: "Can view resources",
},
adminHeaders
)
await api.post(
"/admin/rbac/roles",
{
name: "Editor",
description: "Can edit resources",
},
adminHeaders
)
await api.post(
"/admin/rbac/roles",
{
name: "Admin",
description: "Full access",
},
adminHeaders
)
})
it("should list all roles", async () => {
const response = await api.get("/admin/rbac/roles", adminHeaders)
expect(response.status).toEqual(200)
expect(response.data.count).toEqual(3)
expect(response.data.roles).toEqual(
expect.arrayContaining([
expect.objectContaining({
name: "Viewer",
description: "Can view resources",
}),
expect.objectContaining({
name: "Editor",
description: "Can edit resources",
}),
expect.objectContaining({
name: "Admin",
description: "Full access",
}),
])
)
})
it("should filter roles by name", async () => {
const response = await api.get(
"/admin/rbac/roles?name=Viewer",
adminHeaders
)
expect(response.status).toEqual(200)
expect(response.data.count).toEqual(1)
expect(response.data.roles[0]).toEqual(
expect.objectContaining({
name: "Viewer",
})
)
})
})
describe("GET /admin/rbac/roles/:id", () => {
it("should retrieve a role by id", async () => {
const createResponse = await api.post(
"/admin/rbac/roles",
{
name: "Manager",
description: "Can manage resources",
},
adminHeaders
)
const roleId = createResponse.data.role.id
const response = await api.get(
`/admin/rbac/roles/${roleId}`,
adminHeaders
)
expect(response.status).toEqual(200)
expect(response.data.role).toEqual(
expect.objectContaining({
id: roleId,
name: "Manager",
description: "Can manage resources",
})
)
})
})
describe("POST /admin/rbac/roles/:id", () => {
it("should update a role", async () => {
const createResponse = await api.post(
"/admin/rbac/roles",
{
name: "Support",
description: "Support team",
},
adminHeaders
)
const roleId = createResponse.data.role.id
const response = await api.post(
`/admin/rbac/roles/${roleId}`,
{
name: "Customer Support",
description: "Customer support team with limited access",
},
adminHeaders
)
expect(response.status).toEqual(200)
expect(response.data.role).toEqual(
expect.objectContaining({
id: roleId,
name: "Customer Support",
description: "Customer support team with limited access",
})
)
})
})
describe("DELETE /admin/rbac/roles/:id", () => {
it("should delete a role", async () => {
const createResponse = await api.post(
"/admin/rbac/roles",
{
name: "Temporary",
description: "Temporary role",
},
adminHeaders
)
const roleId = createResponse.data.role.id
const deleteResponse = await api.delete(
`/admin/rbac/roles/${roleId}`,
adminHeaders
)
expect(deleteResponse.status).toEqual(200)
expect(deleteResponse.data).toEqual({
id: roleId,
object: "rbac_role",
deleted: true,
})
const listResponse = await api.get("/admin/rbac/roles", adminHeaders)
expect(
listResponse.data.roles.find((r) => r.id === roleId)
).toBeUndefined()
})
})
describe("Role Policies", () => {
let policies
let viewerRole
let editorRole
beforeEach(async () => {
const policy1 = await api.post(
"/admin/rbac/policies",
{
key: "read:products",
resource: "product",
operation: "read",
name: "Read Products",
},
adminHeaders
)
const policy2 = await api.post(
"/admin/rbac/policies",
{
key: "write:products",
resource: "product",
operation: "write",
name: "Write Products",
},
adminHeaders
)
const policy3 = await api.post(
"/admin/rbac/policies",
{
key: "delete:products",
resource: "product",
operation: "delete",
name: "Delete Products",
},
adminHeaders
)
policies = [
policy1.data.policy,
policy2.data.policy,
policy3.data.policy,
]
const viewer = await api.post(
"/admin/rbac/roles",
{
name: "Product Viewer",
description: "Can view products",
},
adminHeaders
)
viewerRole = viewer.data.role
const editor = await api.post(
"/admin/rbac/roles",
{
name: "Product Editor",
description: "Can edit products",
},
adminHeaders
)
editorRole = editor.data.role
})
it("should create role-policy associations", async () => {
const response = await api.post(
"/admin/rbac/role-policies",
{
role_id: viewerRole.id,
scope_id: policies[0].id,
},
adminHeaders
)
expect(response.status).toEqual(200)
expect(response.data.role_policy).toEqual(
expect.objectContaining({
role_id: viewerRole.id,
scope_id: policies[0].id,
})
)
})
it("should list role-policies for a specific role", async () => {
await api.post(
"/admin/rbac/role-policies",
{
role_id: viewerRole.id,
scope_id: policies[0].id,
},
adminHeaders
)
await api.post(
"/admin/rbac/role-policies",
{
role_id: viewerRole.id,
scope_id: policies[1].id,
},
adminHeaders
)
const response = await api.get(
`/admin/rbac/role-policies?role_id=${viewerRole.id}`,
adminHeaders
)
expect(response.status).toEqual(200)
expect(response.data.count).toEqual(2)
expect(response.data.role_policies).toEqual(
expect.arrayContaining([
expect.objectContaining({
role_id: viewerRole.id,
scope_id: policies[0].id,
}),
expect.objectContaining({
role_id: viewerRole.id,
scope_id: policies[1].id,
}),
])
)
})
it("should delete a role-policy association", async () => {
const createResponse = await api.post(
"/admin/rbac/role-policies",
{
role_id: editorRole.id,
scope_id: policies[2].id,
},
adminHeaders
)
const rolePolicyId = createResponse.data.role_policy.id
const deleteResponse = await api.delete(
`/admin/rbac/role-policies/${rolePolicyId}`,
adminHeaders
)
expect(deleteResponse.status).toEqual(200)
expect(deleteResponse.data).toEqual({
id: rolePolicyId,
object: "rbac_role_policy",
deleted: true,
})
const listResponse = await api.get(
`/admin/rbac/role-policies?role_id=${editorRole.id}`,
adminHeaders
)
expect(
listResponse.data.role_policies.find((rp) => rp.id === rolePolicyId)
).toBeUndefined()
})
})
})
},
})