feat: pactum sample with graphql

Author: jmcdo29

apps/graphql-sample/test/app.e2e-spec.ts

@@ -27,7 +27,7 @@ const cats: Cat[] = [
 
 const gql = '/graphql';
 
-describe('AppController (e2e)', () => {
+describe('GraphQL AppResolver (e2e) {Supertest}', () => {
   let app: INestApplication;
 
   beforeAll(async () => {

apps/graphql-sample/test/app.pactum.e2e-spec.ts

@@ -0,0 +1,187 @@
+import { INestApplication } from '@nestjs/common';
+import { Test, TestingModule } from '@nestjs/testing';
+import * as pactum from 'pactum';
+import { AppModule } from '../src/app.module';
+import { Cat } from '../src/cat/models/cat-query.dto';
+
+const cats: Cat[] = [
+  {
+    name: 'Ventus',
+    age: 4,
+    breed: 'Russian Blue',
+    id: '1',
+  },
+  {
+    name: 'Terra',
+    age: 5,
+    breed: 'Siberian',
+    id: '2',
+  },
+  {
+    name: 'Aqua',
+    age: 3,
+    breed: 'Maine Coon',
+    id: '3',
+  },
+];
+
+describe('GraphQL ApPResolver (e2e) {Pactum}', () => {
+  let app: INestApplication;
+  let url: string;
+
+  beforeAll(async () => {
+    const moduleFixture: TestingModule = await Test.createTestingModule({
+      imports: [AppModule],
+    }).compile();
+
+    app = moduleFixture.createNestApplication();
+    await app.listen(0);
+    url = await app.getUrl();
+    pactum.request.setBaseUrl(url.replace('[::1]', 'localhost'));
+  });
+
+  afterAll(async () => {
+    await app.close();
+  });
+
+  describe('/graphql', () => {
+    describe('cats', () => {
+      it('should get the cats array', () => {
+        return pactum
+          .spec()
+          .post('/graphql')
+          .withGraphQLQuery(
+            `query cats {
+              getCats {
+                id
+                name
+                age
+                breed
+              }
+            }`,
+          )
+          .expectStatus(200)
+          .expectBody({
+            data: {
+              getCats: cats,
+            },
+          });
+      });
+    });
+    describe('one cat', () => {
+      it('should get a single cat', () => {
+        return pactum
+          .spec()
+          .post('/graphql')
+          .withGraphQLQuery(
+            `query cat($cat: CatInput!){
+              getCat(catId:$cat) {
+                id
+                name
+                age
+                breed
+              }
+            }`,
+          )
+          .withGraphQLVariables({
+            cat: {
+              id: '2',
+            },
+          })
+          .expectStatus(200)
+          .expectBody({
+            data: {
+              getCat: {
+                name: 'Terra',
+                age: 5,
+                breed: 'Siberian',
+                id: '2',
+              },
+            },
+          });
+      });
+      it('should get an error for a bad id', () => {
+        return (
+          pactum
+            .spec()
+            .post('/graphql')
+            .withGraphQLQuery(
+              `query cast($cat: CatInput!){
+                getCat(catId:$cat){
+                  id
+                  name
+                  age
+                  breed
+                }
+              }`,
+            )
+            .withGraphQLVariables({
+              cat: {
+                id: '500',
+              },
+            })
+            .expectStatus(200)
+            // verify that the response has an error array with at least one object that has the following message
+            .expectJsonLike({
+              errors: [
+                {
+                  message: 'No cat with id 500 found',
+                },
+              ],
+            })
+        );
+      });
+    });
+    it('should create a cat then retrieve all cats', async () => {
+      const newCat = {
+        name: 'Vanitas',
+        breed: 'Calico',
+        age: 100,
+      };
+      await pactum
+        .spec()
+        .post('/graphql')
+        .withGraphQLQuery(
+          `mutation makeACat($newCat:CatInsert!) {
+            insertCat(newCat:$newCat){
+              breed
+              age
+              id
+              name
+            }
+          }`,
+        )
+        .withGraphQLVariables({
+          newCat,
+        })
+        .expectStatus(200)
+        .expectJson({
+          data: {
+            insertCat: {
+              ...newCat,
+              id: '4',
+            },
+          },
+        });
+      await pactum
+        .spec()
+        .post('/graphql')
+        .withGraphQLQuery(
+          `query getAll {
+            getCats {
+              name
+              age
+              breed
+              id
+            }
+          }`,
+        )
+        .expectStatus(200)
+        .expectJson({
+          data: {
+            getCats: cats.concat([{ ...newCat, id: '4' }]),
+          },
+        });
+    });
+  });
+});