Add test for requestOptions and links

Signed-off-by: Alan Cha <[email protected]>

Author: Alan-Cha

packages/openapi-to-graphql/lib/oas_3_tools.js

@@ -1101,10 +1101,14 @@ export function storeSaneName(
  * sanitized
  */
 export function sanitizeObjectKeys(obj: object): object {
-  return Object.keys(obj).reduce((acc, key) => {
-    acc[sanitize(key, CaseStyle.camelCase)] = obj[key]
-    return acc
-  }, {})
+  if (typeof obj === 'object') {
+    return Object.keys(obj).reduce((acc, key) => {
+      acc[sanitize(key, CaseStyle.camelCase)] = obj[key]
+      return acc
+    }, {})
+  } else {
+    return undefined
+  }
 }
 
 /**

packages/openapi-to-graphql/lib/oas_3_tools.js.map

@@ -16,7 +16,7 @@ import { GraphQLOperationType } from '../lib/types/graphql'
 
 const oas = require('./fixtures/example_oas.json')
 const PORT = 3002
-// update PORT for this test case:
+// Update PORT for this test case:
 oas.servers[0].variables.port.default = String(PORT)
 
 let createdSchema

packages/openapi-to-graphql/lib/schema_builder.js

@@ -7,18 +7,26 @@
 
 /* globals beforeAll, test, expect */
 
-import { graphql, parse, validate } from 'graphql'
+import { graphql } from 'graphql'
 
 import * as openAPIToGraphQL from '../lib/index'
 import { startServer, stopServer } from './example_api2_server'
 
 const oas = require('./fixtures/example_oas2.json')
 const PORT = 3004
-// update PORT for this test case:
+// Update PORT for this test case:
 oas.servers[0].variables.port.default = String(PORT)
 
 let createdSchema
 
+/**
+ * This test suite is used to verify the behavior of the operationIdFieldNames
+ * option.
+ *
+ * It is necessary to make a separate OAS because we need all of operations to
+ * have operationIDs.
+ */
+
 /**
  * Set up the schema first and run example API server
  */
@@ -41,7 +49,8 @@ afterAll(() => {
 })
 
 /**
- * There should be two operations
+ * There should be two operations.
+ *
  * One will be given a field name from the operationId, i.e. user, and the other
  * one, because it does not have an operationId defined, will have an
  * autogenerated field name based on the path, i.e. getUser

packages/openapi-to-graphql/lib/schema_builder.js.map

@@ -18,10 +18,15 @@ const oas = require('./fixtures/example_oas.json')
 const oas3 = require('./fixtures/example_oas3.json')
 const PORT = 3005
 const PORT2 = 3006
-// update PORT for this test case:
+// Update PORT for this test case:
 oas.servers[0].variables.port.default = String(PORT)
 oas3.servers[0].variables.port.default = String(PORT2)
 
+/**
+ * This test suite is used to verify the behavior of interOAS links, i.e.
+ * links across different OASs
+ */
+
 let createdSchema
 
 /**
@@ -30,9 +35,7 @@ let createdSchema
 beforeAll(() => {
   return Promise.all([
     openAPIToGraphQL
-      .createGraphQLSchema([oas, oas3], {
-        fillEmptyResponses: true
-      })
+      .createGraphQLSchema([oas, oas3])
       .then(({ schema, report }) => {
         createdSchema = schema
       }),

packages/openapi-to-graphql/src/oas_3_tools.ts

@@ -8,39 +8,23 @@
 /* globals beforeAll, test, expect */
 
 import { graphql } from 'graphql'
-
 import * as openAPIToGraphQL from '../lib/index'
-import { Options } from '../lib/types/options'
-import { startServer, stopServer } from './example_api_server'
 
 const oas = require('./fixtures/example_oas4.json')
-const PORT = 3007
-// Update PORT for this test case:
-oas.servers[0].variables.port.default = String(PORT)
+
+// This test suite is used to verify the behavior of anyOf and oneOf handling
 
 let createdSchema
 
 /**
- * Set up the schema first and run example API server
+ * Set up the schema
  */
 beforeAll(() => {
-  return Promise.all([
-    openAPIToGraphQL
-      .createGraphQLSchema(oas, {
-        fillEmptyResponses: true
-      })
-      .then(({ schema, report }) => {
-        createdSchema = schema
-      }),
-    startServer(PORT)
-  ])
-})
-
-/**
- * Shut down API server
- */
-afterAll(() => {
-  return stopServer()
+  return openAPIToGraphQL
+    .createGraphQLSchema(oas)
+    .then(({ schema, report }) => {
+      createdSchema = schema
+    })
 })
 
 const anyOfQuery = `{

packages/openapi-to-graphql/test/example_api.test.ts

@@ -0,0 +1,105 @@
+// Copyright IBM Corp. 2017,2018. All Rights Reserved.
+// Node module: openapi-to-graphql
+// This file is licensed under the MIT License.
+// License text available at https://opensource.org/licenses/MIT
+
+'use strict'
+
+/* globals beforeAll, test, expect */
+
+import { graphql, parse, validate } from 'graphql'
+
+import * as openAPIToGraphQL from '../lib/index'
+import { Options } from '../lib/types/options'
+import { startServer, stopServer } from './example_api6_server'
+
+const oas = require('./fixtures/example_oas6.json')
+const PORT = 3009
+// Update PORT for this test case:
+oas.servers[0].variables.port.default = String(PORT)
+
+let createdSchema
+
+/**
+ * Set up the schema first and run example API server
+ */
+beforeAll(() => {
+  return Promise.all([
+    openAPIToGraphQL.createGraphQLSchema(oas).then(({ schema, report }) => {
+      createdSchema = schema
+    }),
+    startServer(PORT)
+  ])
+})
+
+/**
+ * Shut down API server
+ */
+afterAll(() => {
+  return stopServer()
+})
+
+test('Option requestOptions should work with links', () => {
+  // Verifying the behavior of the link by itself
+  const query = `{
+    object {
+      object2Link {
+        data
+      }
+      withParameter: object2Link (specialheader: "extra data"){
+        data
+      }
+    }
+  }`
+
+  const promise = graphql(createdSchema, query).then(result => {
+    expect(result.data).toEqual({
+      object: {
+        object2Link: {
+          data: 'object2'
+        },
+        withParameter: {
+          data: "object2 with special header: 'extra data'"
+        }
+      }
+    })
+  })
+
+  const options: Options = {
+    requestOptions: {
+      url: undefined,
+      headers: {
+        specialheader: 'requestOptions'
+      }
+    }
+  }
+
+  const query2 = `{
+    object {
+      object2Link {
+        data
+      }
+    }
+  }`
+
+  const promise2 = openAPIToGraphQL
+    .createGraphQLSchema(oas, options)
+    .then(({ schema }) => {
+      const ast = parse(query2)
+      const errors = validate(schema, ast)
+      expect(errors).toEqual([])
+      return graphql(schema, query2).then(result => {
+        expect(result).toEqual({
+          data: {
+            object: {
+              object2Link: {
+                data: "object2 with special header: 'requestOptions'" // Data from requestOptions in a link
+              }
+            }
+          }
+        })
+      })
+    })
+
+  return Promise.all([promise, promise2])
+})

packages/openapi-to-graphql/test/example_api2.test.ts

@@ -0,0 +1,68 @@
+// Copyright IBM Corp. 2017,2018. All Rights Reserved.
+// Node module: openapi-to-graphql
+// This file is licensed under the MIT License.
+// License text available at https://opensource.org/licenses/MIT
+
+'use strict'
+
+let server // holds server object for shutdown
+
+/**
+ * Starts the server at the given port
+ */
+function startServer(PORT) {
+  const express = require('express')
+  const app = express()
+
+  const bodyParser = require('body-parser')
+  app.use(bodyParser.json())
+
+  app.get('/api/object', (req, res) => {
+    console.log(req.method, req.path)
+    res.send({
+      data: 'object'
+    })
+  })
+
+  app.get('/api/object2', (req, res) => {
+    console.log(req.method, req.path)
+    if (typeof req.headers.specialheader === 'string') {
+      res.send({
+        data: `object2 with special header: '${req.headers.specialheader}'`
+      })
+    } else {
+      res.send({
+        data: 'object2'
+      })
+    }
+  })
+
+  return new Promise(resolve => {
+    server = app.listen(PORT, () => {
+      console.log(`Example API accessible on port ${PORT}`)
+      resolve()
+    })
+  })
+}
+
+/**
+ * Stops server.
+ */
+function stopServer() {
+  return new Promise(resolve => {
+    server.close(() => {
+      console.log(`Stopped API server`)
+      resolve()
+    })
+  })
+}
+
+// if run from command line, start server:
+if (require.main === module) {
+  startServer(3006)
+}
+
+module.exports = {
+  startServer,
+  stopServer
+}

packages/openapi-to-graphql/test/example_api3.test.ts

@@ -14,7 +14,8 @@ const openAPIToGraphQL = require('../lib/index')
 // const oas = require('./fixtures/example_oas.json')
 // const oas2 = require('./fixtures/example_oas2.json')
 // const oas3 = require('./fixtures/example_oas3.json')
-const oas4 = require('./fixtures/example_oas4.json')
+// const oas4 = require('./fixtures/example_oas4.json')
+const oas6 = require('./fixtures/example_oas6.json')
 
 // const oas = require('./fixtures/github.json')
 // const oas = require('./fixtures/instagram.json')
@@ -29,7 +30,14 @@ const oas4 = require('./fixtures/example_oas4.json')
 // const oas = yamljs.parse(fs.readFileSync('../tmp/APIs/box.com/content/2.0/swagger.yaml', 'utf8'))
 
 openAPIToGraphQL
-  .createGraphQLSchema(oas4)
+  .createGraphQLSchema(oas6, {
+    requestOptions: {
+      url: undefined,
+      headers: {
+        specialheader: 'requestOptions' // Option requestOptions
+      }
+    }
+  })
   .then(({ schema, report }) => {
     console.log(JSON.stringify(report, null, 2))