codex-team / codex-team/notes.api

Refactor tests for team rights

Open
#207 0 comments 0 reactions 1 assignee Claimed by @GoldenJaden View on GitHub
Tests
Dominant language
TypeScript
Stars
4
Forks
2
PR merge metrics
No merged PRs in 30d

Description

# Problem
With the come of **team rights policies**, there are a lot of almost indentical tests that should be run for some routes.

# Solution
Parametrize tests that test team rights - make use of the `test.each` method to stuff similar test to one pack.

You can peek into the `note.settings.test.ts` to understand how it should be done.

Also, it would be nice to save this `test.each` as separate util for better convenience:
something like
```
test.roles = test.each([{ role: MemberRole.Read,
isPublic: false,
isAuthorized: true,
statusCode: 200 },
{ ... },
{ ... },
{ ... }
]);
```
and use it as
```
test.roles('Returns note with access rights by public id ....', ({ role, isPublic, isAuthorized, statusCode }) => {

})
```

# Tasks

- [x] Refactor tests regarding team rights
- [ ] Make the method as a separate util
- [ ] Find out how to make the better
naming for tests in `test.each` (from `jest` tool). Right now we have same name for all tests in one scope, and it's not very convenient.
- [ ] Update test docs

Contributor guide

No contributing guide indexed for this repository

Assessment

This issue has not been assessed yet.

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.