Add cookie assertions framework - #868
Merged
Merged
Conversation
Collaborator
|
Can you fix the merge conflict? |
Add a convenient workflow for running assertions on cookie headers
returned by the server. This code is largely copied from Gregory
Langais' package `expect-cookie` (MIT License).
Example usage:
```js
const request = require('supertest');
const cookies = request.cookies;
request(app)
.get('/users')
.expect('Content-Type', /json/)
.expect('Content-Length', '15')
.expect(200)
// assert 'alpha' cookie is set with domain, path, and httpOnly options
.expect(cookies.set({ name: 'alpha', options: ['domain', 'path', 'httponly'] }))
// assert 'bravo' cookie is NOT set
.expect(cookies.not('set', { name: 'bravo' }))
.end(function(err, res) {
if (err) {
throw err;
}
});
```
Supports:
- `.set` - Assert that cookie and options are set.
- `.reset` - Assert that cookie is set and was already set (in request
headers).
- `.new` - Assert that cookie is set and was NOT
already set (NOT in request headers).
- `.renew` - Assert that cookie is set with a strictly greater `expires`
or `max-age` than the given value.
- `.contain` - Assert that cookie is set with value and contains
options.
- `.not` - Call any cookies assertion method with "assert true" modifier
set to `false`.
feat(cookies): add cookie assertions
Add a convenient workflow for running assertions on cookie headers
returned by the server. This code is largely copied from Gregory
Langais' package `expect-cookies` (MIT License).
Example usage:
```js
const request = require('supertest');
const cookies = request.cookies;
request(app)
.get('/users')
.expect('Content-Type', /json/)
.expect('Content-Length', '15')
.expect(200)
// assert 'alpha' cookie is set with domain, path, and httpOnly options
.expect(cookies.set({ name: 'alpha', options: ['domain', 'path', 'httponly'] }))
// assert 'bravo' cookie is NOT set
.expect(cookies.not('set', { name: 'bravo' }))
.end(function(err, res) {
if (err) {
throw err;
}
});
```
Supports:
- `.set` - Assert that cookie and options are set.
- `.reset` - Assert that cookie is set and was already set (in request
headers).
- `.new` - Assert that cookie is set and was NOT
already set (NOT in request headers).
- `.renew` - Assert that cookie is set with a strictly greater `expires`
or `max-age` than the given value.
- `.contain` - Assert that cookie is set with value and contains
options.
- `.not` - Call any cookies assertion method with "assert true" modifier
set to `false`.
dmurvihill
force-pushed
the
cookie-assertions
branch
from
August 26, 2025 04:09
366c7ef to
4f89680
Compare
|
Review the following changes in direct dependencies. Learn more about Socket for GitHub.
|
Contributor
Author
|
Fixed. Sorry, not sure how that happened. |
Contributor
Author
|
Everything look ok now? |
Contributor
Author
|
Cheers! |
Collaborator
|
v7.2.0 published to npm https://github.com/forwardemail/supertest/releases/tag/v7.2.0 please consider supporting our maintenance efforts by becoming a @forwardemail user! **sign up at https://forwardemail.net and use coupon code |
|
import request from 'supertest'; const cookies = request.cookies; looks like typing is missing here |
Contributor
Author
|
This package doesn't come with types. Try |
8 tasks
Contributor
Author
|
Types have been merged into DefinitelyTyped. |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
4 participants
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Add a convenient workflow for running assertions on cookie headers returned by the server. This code is largely copied from Gregory Langlais' package
expect-cookies(MIT License).Implements #855.
Example usage:
Supports:
.set- Assert that cookie and options are set..reset- Assert that cookie is set and was already set (in request headers)..new- Assert that cookie is set and was NOT already set (NOT in request headers)..renew- Assert that cookie is set with a strictly greaterexpiresormax-agethan the given value..contain- Assert that cookie is set with value and contains options..not- Call any cookies assertion method with "assert true" modifier set tofalse.Checklist