Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Add basic test example to readme #53

Merged
merged 1 commit into from
Aug 19, 2023
Merged
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
21 changes: 21 additions & 0 deletions readme.md
Original file line number Diff line number Diff line change
Expand Up @@ -140,6 +140,27 @@ In order to avoid passing user/policy/resource props to every usage of the
</PunditProvider>
```

### Testing

Policies can be unit tested, for example with Jest/Vitest:

```javascript
describe('post policy, edit action', () => {
const user = { id: 1 }

it('grants access if post is authored by user', () => {
const post = { userId: user.id }
expect(new PostPolicy(user, post).can('edit')).toBe(true)
})

it('denies access if post is not authored by user', () => {
const differentUser = { id: 2 }
const post = { userId: differentUser.id }
expect(new PostPolicy(user, post).can('edit')).toBe(false)
})
})
```

## License

MIT
Expand Down