Ecosyste.ms: Awesome

An open API service indexing awesome lists of open source software.

Awesome Lists | Featured Topics | Projects

https://github.com/amazeelabs/graphql_snapshot_test

Last synced: 2 days ago
JSON representation

Host: GitHub
URL: https://github.com/amazeelabs/graphql_snapshot_test
Owner: AmazeeLabs
Created: 2023-01-18T14:45:52.000Z (about 2 years ago)
Default Branch: main
Last Pushed: 2023-03-23T19:59:40.000Z (almost 2 years ago)
Last Synced: 2024-11-22T23:32:41.123Z (2 months ago)
Language: PHP
Size: 187 KB
Stars: 0
Watchers: 2
Forks: 0
Open Issues: 1
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md

Awesome Lists containing this project

README

# ⚠️ DEPRECATED

We compared this module with
[@amazeelabs/graphql-schema-test](https://www.npmjs.com/package/@amazeelabs/graphql-schema-test)
and found no reason to use it:

- there was a lot of headache with the Domain module
- tests ran with `@amazeelabs/graphql-schema-test` take almost same time

# Drupal GraphQL Snapshot Testing

A Drush command that runs GraphQL queries against configured GraphQL servers and
stores the results in snapshots.

## Installation

```shell
composer require --dev amazeelabs/graphql_snapshot_test
```

## Usage

```shell
drush help graphql:snapshot:test
```

Results can be altered from custom modules. See
[graphql_snapshot_test.api.php](graphql_snapshot_test.api.php)

## Migration from `@amazeelabs/graphql-schema-test`

The package is designed to replace `@amazeelabs/graphql-schema-test` with
minimum effort. But you'll have to rewrite all your masking code to PHP 😬

New snapshots should look very close to the old ones. Example:

![Old/new snapshot comparison](docs/migration-example.png)

Tip: Use `--servers` option if the servers execution order does not match to the
old one.