View Code? Open in Web Editor NEW

This project forked from oslabs-beta/eeql

EEQL is a standalone test creation suite that constructs reliable endpoint tests for both GraphQL and RESTful API's.

License: MIT License

SCSS 25.94% JavaScript 19.40% TypeScript 54.04% HTML 0.62%

eeql's Introduction

eeQL

"EEQL is a standalone test creation suite that constructs reliable endpoint tests for both GraphQL and RESTful API's.".

Installation

Please dive into eeQL.io to install this application.

Refer to our Builds/Resources for more information on compatability and previous releases.

Usage

GETTING STARTED

Input desired port for proper integration into your project
Upload a project directory (note: a testing folder will be created if none exists).
eeQL will automatically create, display and locate testing files within your uploaded project to facilitate reliable test creation.

TEST CREATION

REST

Select the REST button
Select the request method that you plan on testing
Upload the server file of your project
Fill out the requested fields within the Test Builder Module
Press the save button to automatically create a Jest-and-Supertest-based REST test !

GRAPHQL

Select the GraphQL button
Upload the schema file of your project
Upload the resolvers file of your project
Provide a description of the test
Determine if the operation is a valid or invalid one
Provide the operation (query/mutation) text
Determine if the operation is a query or a mutation
Optionally, provide a mutation object if the operation is a mutation instead of a query
Press the save button to generate an easyGraphQL-based operation test!

Contributing

Pull requests are welcome. For major changes, please open an issue first to discuss what you would like to change. Please make sure to update tests as appropriate.