Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/bustle/chai-graphql
GraphQL response matcher for Chai assertion library
https://github.com/bustle/chai-graphql
Last synced: 3 days ago
JSON representation
GraphQL response matcher for Chai assertion library
- Host: GitHub
- URL: https://github.com/bustle/chai-graphql
- Owner: bustle
- License: mit
- Created: 2017-02-28T04:27:44.000Z (over 7 years ago)
- Default Branch: master
- Last Pushed: 2022-02-10T17:15:24.000Z (almost 3 years ago)
- Last Synced: 2024-09-17T15:18:05.434Z (about 2 months ago)
- Language: JavaScript
- Homepage:
- Size: 69.3 KB
- Stars: 6
- Watchers: 8
- Forks: 1
- Open Issues: 1
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
chai-graphql [](https://badge.fury.io/js/chai-graphql) [](https://travis-ci.org/bustle/chai-graphql) [](https://david-dm.org/bustle/chai-graphql#info=devDependencies)
===========
GraphQL response matcher for [Chai](http://chaijs.com/) assertion library
Works with both parsed JSON responses and local object responses.
## Installation
```
npm install --save-dev chai-graphql
```
## API
Methods will "unwrap" the data and/or payload from a response to make testing less repetitive.
- `assert.graphQl(response, [expectedData])` performs a deep equals on the `response.data` or `response.data.payload` and `expectedData` if present. Throws if there are any errors in `response.errors`. Returns `response.data`
- `assert.graphQLSubset(response, [subsetOfExpectedData])` performs a subset match of `response.data` or `response.data.payload` and expectedData if present. Throws if there are any errors in `response.errors`. Returns `response.data`
- `assert.graphQLError(response, [errorMatcher])` throws if there are not any `response.errors`, returns the `response.errors`. `errorMatcher` can be a string, regex or an array of strings or regexes. In the string or regex form the error's message property will be [`match()`](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/String/match) by the `errorMatcher`. In the array form, each `errorMatcher` is tested against each error in order. If there a greater or fewer number of matchers than errors an it will throw.
## Usage
In your setup
```js
import chai from 'chai'
import chaiGraphQL from 'chai-graphql'
chai.use(chaiGraphQL)
```
in your spec.js
```js
var goodResponse = {
data: {
foo: 'bar'
}
}
// Passes
assert.graphQL(goodResponse, { foo: 'bar' })
assert.graphQLSubset(goodResponse, { foo: 'bar' })
assert.graphQL(goodResponse)
assert.graphQLSubset(goodResponse)
assert.graphQLSubset(goodResponse, { })
assert.notGraphQLError(goodResponse)
expect(goodResponse).to.be.graphQl({ foo: 'bar' })
// Fails
assert.graphQL(goodResponse, { foo: 'FAIL' })
assert.graphQL(goodResponse, { })
assert.graphQLError(goodResponse)
expect(goodResponse).to.be.graphQLError()
const badResponse = {
errors: [
{
message: 'Error message',
stack: 'Prints if present'
},
new GraphQLError('GraphQL Error Object'),
new Error('Regular Error')
]
}
// Passes
assert.graphQLError(badResponse)
expect(badResponse).to.be.graphQLError()
assert.graphQLError(badResponse, 'Error message')
assert.graphQLError(badResponse, /GraphQL Error Object/)
assert.graphQLError(badResponse, [
'Error message',
/GraphQL Error Object/
])
// fails
assert.graphQL(badResponse, { foo: 'bar' })
assert.graphQL(badResponse)
assert.notGraphQLError(badResponse)
expect(badResponse).to.be.graphQl({ foo: 'bar' })
assert.graphQLError(badResponse, 'Rando Error')
assert.graphQLError(badResponse, [ 'Error message' ])
```