make test expectations easier to read

Author: StarpTech

src/core/graphql-utils.ts

@@ -1,5 +1,6 @@
 import { stripIgnoredCharacters } from 'graphql'
 
 export function normalizeSchema(typeDefs: string): string {
+  // TODO sort fields and types
   return stripIgnoredCharacters(typeDefs)
 }

src/core/test-util.ts

@@ -3,6 +3,7 @@ import execa from 'execa'
 import { join } from 'path'
 import { uid } from 'uid'
 import jwt from 'jsonwebtoken'
+import { stripIgnoredCharacters } from 'graphql/utilities'
 import { JwtPayload } from './jwt-auth'
 
 export interface TestContext {
@@ -13,6 +14,10 @@ export interface TestContext {
   connectionUrl: string
 }
 
+export function trimDoc(strings: ReadonlyArray<string>, ...values: ReadonlyArray<string>): string {
+  return stripIgnoredCharacters(strings.join(''))
+}
+
 export function getJwtHeader(payload: JwtPayload) {
   const jwtSecret = 'secret'
   const jwtToken = jwt.sign(payload, jwtSecret)

src/registry/federation/compose-schema-versions.test.ts

@@ -1,7 +1,13 @@
 import anyTest, { TestInterface } from 'ava'
 import build from '../../build-server'
 import { CURRENT_VERSION } from '../../core/constants'
-import { cleanTest, createTestContext, createTestPrefix, TestContext } from '../../core/test-util'
+import {
+  cleanTest,
+  createTestContext,
+  createTestPrefix,
+  TestContext,
+  trimDoc,
+} from '../../core/test-util'
 
 const test = anyTest as TestInterface<TestContext>
 test.before(createTestContext())
@@ -106,14 +112,22 @@ test('Should return schema of two services', async (t) => {
   t.truthy(response.data[0].lastUpdatedAt)
   t.like(response.data[0], {
     serviceName: `${t.context.testPrefix}_foo`,
-    typeDefs: 'type Query{hello:String}',
+    typeDefs: trimDoc/* GraphQL */ `
+      type Query {
+        hello: String
+      }
+    `,
     version: '2',
   })
 
   t.truthy(response.data[1].lastUpdatedAt)
   t.like(response.data[1], {
     serviceName: `${t.context.testPrefix}_bar`,
-    typeDefs: 'type Query{world:String}',
+    typeDefs: trimDoc/* GraphQL */ `
+      type Query {
+        world: String
+      }
+    `,
     version: '2',
   })
 })
@@ -363,7 +377,11 @@ test('Version "current" should always return the latest (not versioned) register
 
   t.like(response.data[0], {
     serviceName: `${t.context.testPrefix}_foo`,
-    typeDefs: `type Query{world:String}`,
+    typeDefs: trimDoc/* GraphQL */ `
+      type Query {
+        world: String
+      }
+    `,
     version: CURRENT_VERSION,
   })
 })
@@ -378,7 +396,11 @@ test('Should include "routingUrl" of the service', async (t) => {
     method: 'POST',
     url: '/schema/push',
     payload: {
-      typeDefs: `type Query { hello: String }`,
+      typeDefs: trimDoc/* GraphQL */ `
+        type Query {
+          hello: String
+        }
+      `,
       version: '1',
       serviceName: `${t.context.testPrefix}_foo`,
       routingUrl: 'http://localhost:3000/api/graphql',
@@ -410,7 +432,11 @@ test('Should include "routingUrl" of the service', async (t) => {
 
   t.like(response.data[0], {
     serviceName: `${t.context.testPrefix}_foo`,
-    typeDefs: 'type Query{hello:String}',
+    typeDefs: trimDoc/* GraphQL */ `
+      type Query {
+        hello: String
+      }
+    `,
     routingUrl: 'http://localhost:3000/api/graphql',
     version: '1',
   })

src/registry/federation/compose-schema.test.ts

@@ -1,7 +1,13 @@
 import anyTest, { TestInterface } from 'ava'
 import build from '../../build-server'
 import { CURRENT_VERSION } from '../../core/constants'
-import { cleanTest, createTestContext, createTestPrefix, TestContext } from '../../core/test-util'
+import {
+  cleanTest,
+  createTestContext,
+  createTestPrefix,
+  TestContext,
+  trimDoc,
+} from '../../core/test-util'
 
 const test = anyTest as TestInterface<TestContext>
 test.before(createTestContext())
@@ -63,14 +69,22 @@ test('Should return schema of two services', async (t) => {
   t.truthy(response.data[0].lastUpdatedAt)
   t.like(response.data[0], {
     serviceName: `${t.context.testPrefix}_bar`,
-    typeDefs: 'type Query{world:String}',
+    typeDefs: trimDoc/* GraphQL */ `
+      type Query {
+        world: String
+      }
+    `,
     version: '2',
   })
 
   t.truthy(response.data[1].lastUpdatedAt)
   t.like(response.data[1], {
     serviceName: `${t.context.testPrefix}_foo`,
-    typeDefs: `type Query{hello:String}`,
+    typeDefs: trimDoc/* GraphQL */ `
+      type Query {
+        hello: String
+      }
+    `,
     version: '1',
   })
 })
@@ -152,7 +166,11 @@ test('Version "current" has no precedence over the last updated', async (t) => {
 
   t.like(response.data[0], {
     serviceName: `${t.context.testPrefix}_foo`,
-    typeDefs: 'type Query{world:String}',
+    typeDefs: trimDoc/* GraphQL */ `
+      type Query {
+        world: String
+      }
+    `,
     version: '2',
   })
 })
@@ -197,7 +215,11 @@ test('Should include "routingUrl" of the service', async (t) => {
 
   t.like(response.data[0], {
     serviceName: `${t.context.testPrefix}_foo`,
-    typeDefs: 'type Query{hello:String}',
+    typeDefs: trimDoc/* GraphQL */ `
+      type Query {
+        hello: String
+      }
+    `,
     routingUrl: 'http://localhost:3000/api/graphql',
     version: '1',
   })