# graphql-test-generator

> [![CircleCI](https://circleci.com/gh/socialtables/graphql-test-generator.svg?style=svg)](https://circleci.com/gh/socialtables/graphql-test-generator) Generates tests for graphql queries that compare the query against the schema. Exports one function for g

Latest version **1.0.0** (published 2017-09-21) · Apache-2.0 license · 0 weekly downloads

## Install

```sh
npm install graphql-test-generator
pnpm add graphql-test-generator
yarn add graphql-test-generator
bun add graphql-test-generator
```

Provides the commands `gqlTestExtraction`, `graphqlTestGenerator`, `gqlTestExtractionInteractive`, `graphqlTestGeneratorInteractive`.

## Health

**Score 15/100 (F)** — status: abandoned.

Positive: no vulnerabilities.

Warnings: low downloads; no types; no esm support.

Negative: abandoned; low maintenance score.

## Facts

| | |
|---|---|
| Version | 1.0.0 |
| Published | 2017-09-21 |
| First published | 2017-08-17 |
| Weekly downloads | 0 |
| License | Apache-2.0 |
| TypeScript types | none |
| Module format | CommonJS |
| Dependencies | 6 |
| Known vulnerabilities | 0 (+2 in 1 direct dependencies) |
| Install scripts | no |
| Maintainers | conorhastings |

## Links

- npm: https://www.npmjs.com/package/graphql-test-generator
- npm.io page: https://npm.io/package/graphql-test-generator

## Dependencies (6)

- [tmp](https://npm.io/package/tmp.md) 0.0.31
- [mkdirp](https://npm.io/package/mkdirp.md) 0.5.1
- [babylon](https://npm.io/package/babylon.md) ^6.18.0
- [inquirer](https://npm.io/package/inquirer.md) 3.2.1
- [commander](https://npm.io/package/commander.md) 2.11.0
- [gql-extract](https://npm.io/package/gql-extract.md) 0.0.5

## Recent versions

- 1.0.0 (latest) — 2017-09-21
- 0.1.0 — 2017-08-31
- 0.0.4 — 2017-08-18
- 0.0.3 — 2017-08-17
- 0.0.2 — 2017-08-17
- 0.0.1 — 2017-08-17

## README

##  GraphQL Test Generator
[![CircleCI](https://circleci.com/gh/socialtables/graphql-test-generator.svg?style=svg)](https://circleci.com/gh/socialtables/graphql-test-generator)
Generates tests for graphql queries that compare the query against the schema. Exports one function for generating tests and another function for extracting queries and generating tests. It can also be installed globally and used through the command line.

### Install

```bash
npm install graphql-test-generator --save-dev
```

### graphqlTestGenerator

#### Arguments
* entry - directory containing the graphql queries to be tested
* output - directory to write the files to
* schemaLocation - directory of the schemas to compare the queries to
* overwriteFiles - optional boolean indicating whether old test files should be overwritten (defaults to false)
* importLocation - optional directory for including other test functions (defaults to generating tape test)

#### Use

##### In JavaScript
```js
const { graphqlTestGenerator } = require('graphql-test-generator');

// This will find graphql queries in the entry directory, generate tests against the schema and write them to the test directory.

graphqlTestGenerator({ entry: './graphqlQueries', output: './tests', schemaLocation: './schemas', overwriteFiles: false, importLocation: './generateTestFunction' });
```

##### Command line usage
``` bash
graphqlTestGenerator -e ./src -o ./test -s ../server/schema
```

### gqlTestExtraction

#### Arguments
* entry - directory containing the application code with graphql queries in template strings
* output - directory to write the files to
* schemaLocation - directory of the schemas to compare the queries to
* overwriteFiles - optional boolean indicating whether old test files should be overwritten (defaults to false)
* importLocation - optional directory for including other test functions (defaults to generating tape test)

#### Use

##### In JavaScript
```js
const { gqlTestExtraction } = require('graphql-test-generator');

// This will find graphql queries in the source, extract queries that are in tagged template strings being called by the function exported from the graphql-tag library, generate tests against the schema and write them to the test directory.

gqlTestExtraction({ entry: './src', output: './tests', schemaLocation: './schemas', overwriteFiles: false, importLocation: './generateTestFunction' });
```
##### Command line usage
``` bash
gqlTestExtraction -e ./src -o ./test -s ../server/schema
```

- - -

Copyright (C) 2017 Social Tables, Inc. (https://www.socialtables.com) All rights reserved.

Licensed under the Apache License, Version 2.0 (the "License"); you may not use this file except in compliance with the License. You may obtain a copy of the License at

	http://www.apache.org/licenses/LICENSE-2.0

Unless required by applicable law or agreed to in writing, software distributed under the License is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the License for the specific language governing permissions and limitations under the License.

---
_Source: https://npm.io/package/graphql-test-generator · Machine-readable twin of the npm.io package page. Health data is recomputed on every publish._