Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/ply-ct/ply-demo
Example project with Ply autotests
https://github.com/ply-ct/ply-demo
example-project graphql ply rest-api testing typescript workflow
Last synced: 29 days ago
JSON representation
Example project with Ply autotests
- Host: GitHub
- URL: https://github.com/ply-ct/ply-demo
- Owner: ply-ct
- License: mit
- Created: 2018-04-14T20:47:17.000Z (over 6 years ago)
- Default Branch: main
- Last Pushed: 2024-11-23T21:02:58.000Z (about 1 month ago)
- Last Synced: 2024-11-23T22:17:51.431Z (about 1 month ago)
- Topics: example-project, graphql, ply, rest-api, testing, typescript, workflow
- Language: TypeScript
- Homepage: https://ply-ct.github.io/ply/
- Size: 1.42 MB
- Stars: 10
- Watchers: 7
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# ply-demo
Illustrates how to use [Ply](https://ply-ct.github.io/ply/) for automated API testing.
Includes an example GitHub Actions workflow to demonstrate Ply continuous testing.
## Run a request suite
```
git clone https://github.com/ply-ct/ply-demo.git
cd ply-demo
npm install
npx ply test/requests/movie-queries.ply.yaml
```
The output indicates that all movie-queries requests have passed:
```
Ply version: "3.0.40"
Request 'moviesByYearAndRating' submitted at 4/11/2022, 14:01:18:716
Request 'moviesByYearAndRating' PASSED in 32 ms
Request 'movieById' submitted at 4/11/2022, 14:01:18:745
Request 'movieById' PASSED in 8 ms
Request 'greatFilmsOf1935' submitted at 4/11/2022, 14:01:18:754
Request 'greatFilmsOf1935' PASSED in 7 ms
Request 'bestMovieOf1935' submitted at 4/11/2022, 14:01:18:762
Request 'bestMovieOf1935' PASSED in 6 ms
Request 'stinkersOf1932' submitted at 4/11/2022, 14:01:18:769
Request 'stinkersOf1932' PASSED in 7 ms
Overall Results: {"Passed":5,"Failed":0,"Errored":0,"Pending":0,"Submitted":0}
Overall Time: 126 ms
```
## Run all tests
```
cd ply-demo
npm test
```
In package.json scripts, "pretest" starts [ply-movies](https://github.com/ply-ct/ply-movies#readme),
which serves up the REST API exercised by many of our Ply [requests](test/requests) and [cases](test/cases).
**Note**: Run [ply-movies locally](https://ply-ct.github.io/ply/topics/cases#ply-movies) in order for
destructive tests to succeed.
## Visual Studio Code
Install Ply's [VS Code extension](https://github.com/ply-ct/vscode-ply#vscode-ply) to run tests in
the Test Explorer sidebar.
## GitHub Workflow
This simple CI [workflow](https://github.com/ply-ct/ply-demo/blob/main/.github/workflows/build-test.yml)
shows how to use npm scripts to automatically execute all requests and cases whenever a commit is pushed
on the main branch.
## Ply GitHub Action
This readme file includes the [Ply Action](https://github.com/ply-ct/ply-action#readme) status badge.