E2e tests (#233)

* add e2e tests * update readme * change query name; change tests to e2e * use exact versions * remove unused param * use isomorphic fetch * rename E2E_TEST_URI * add e2e tests to tsconfig.json * refactor export statement * update yarn.lock * move e2e test variables to a separate file * Update README.md

Author: jelisejev

README.md

@@ -83,6 +83,12 @@ Attention Windows users: when `Docker for Windows` is not an option, install `ya
 - npm: `$ npm test`
 - yarn: `$ yarn test`
 
+### Run e2e tests
+
+Run the app or point E2E_TEST_URL to a remote instance you want to test against.
+- npm: `$ npm run test:e2e`
+- yarn: `$ yarn test:e2e`
+
 ### Generate coverage reports
 
 Set environment variable `CI` to true to generate coverage reports.

docker-compose.yml

@@ -12,4 +12,3 @@ services:
  - 3001:3001
  environment:
  - SHELL=/bin/sh
- 

e2e/client.ts

@@ -0,0 +1,17 @@
+import { ApolloClient } from 'apollo-client';
+import { HttpLink } from 'apollo-link-http';
+import { InMemoryCache } from 'apollo-cache-inmemory';
+export { default as gql } from 'graphql-tag';
+
+import 'isomorphic-fetch';
+
+const httpLink = new HttpLink({
+ uri: `${process.env.E2E_TEST_URL}/${process.env.GRAPHQL_PATH}`,
+});
+
+const client = () => new ApolloClient({
+ link: httpLink,
+ cache: new InMemoryCache(),
+});
+
+export default client;

e2e/joke.e2e.ts

@@ -0,0 +1,24 @@
+import client, { gql } from './client';
+
+test('jokes.byCategory should return a random joke', async () => {
+ const response = await client().query({
+ query: gql`
+ query RandomJokeByCategory {
+ jokes {
+ byCategory {
+ id
+ text
+ categories
+ }
+ }
+ }
+ `,
+ });
+
+ const byCategory = (response.data as any).jokes.byCategory;
+ expect(byCategory).toMatchObject({
+ id: expect.any(String),
+ text: expect.any(String),
+ categories: expect.any(Array),
+ });
+});

jest/__setup__/e2e-env-test.ts

@@ -0,0 +1,10 @@
+import envalid from 'envalid';
+
+const { str } = envalid;
+
+const env = envalid.cleanEnv(process.env, {
+ GRAPHQL_PATH: str({ default: 'graphql' }),
+ E2E_TEST_URL: str({ default: 'http://localhost:3001' }),
+});
+
+export default env;

jest/__setup__/e2e-setup.ts

@@ -0,0 +1,2 @@
+import env from './e2e-env-test';
+process.env = env;

jest/e2e.config.js

@@ -0,0 +1,15 @@
+const path = require('path');
+
+module.exports = Object.assign(
+ {},
+ require('./default.config.js'),
+ {
+ "testRegex": ".*\\.e2e\\.(ts)$",
+ "roots": [
+ "e2e"
+ ],
+ "setupFiles": [
+ path.join(__dirname, "./__setup__/e2e-setup.ts")
+ ],
+ }
+);

package.json

@@ -10,9 +10,11 @@
  "test:integration": "npm run validate:env && jest --config jest/integration.config.js",
  "test:unit": "npm run validate:env && jest --config jest/unit.config.js",
  "test:all": "npm run validate:env && jest",
+ "test:e2e": "npm run validate:env-e2e && jest --config jest/e2e.config.js",
  "lint": "tslint -t stylish 'src/**/*.ts'",
  "lint:watch": "chokidar \"src/**/*.ts\" -c \"tslint -t stylish --force '{path}'\"",
  "validate:env": "tsc src/env.ts --lib esnext --esModuleInterop --outDir ./build/ && node ./build/env.js",
+ "validate:env-e2e": "tsc jest/__setup__/e2e-env-test.ts --lib esnext --esModuleInterop --outDir ./build/e2e && node ./build/e2e/e2e-env-test.js",
  "clean": "rimraf build",
  "clean:graphql": "rimraf build/**/*.{gql,graphql,graphqls}",
  "copy:graphql": "cpx \"src/**/*.{gql,graphql,graphqls}\" build",
@@ -51,11 +53,16 @@
  "@types/koa": "2.0.45",
  "@types/koa-router": "7.0.28",
  "@types/nock": "9.1.3",
+ "apollo-cache-inmemory": "1.1.12",
+ "apollo-client": "2.2.8",
+ "apollo-link-http": "1.5.4",
  "cash-touch": "0.2.0",
  "chokidar-cli": "1.2.0",
  "cpx": "1.5.0",
  "docker-share": "0.0.4",
+ "graphql-tag": "2.8.0",
  "graphql-to-typescript": "0.1.2",
+ "isomorphic-fetch": "2.2.1",
  "jest": "22.4.3",
  "jest-junit": "3.7.0",
  "nock": "9.2.5",

yarn.lock

@@ -54,6 +54,10 @@
  dependencies:
  "@types/node" "*"
 
+"@types/async@2.0.47":
+ version "2.0.47"
+ resolved "https://registry.yarnpkg.com/@types/async/-/async-2.0.47.tgz#f49ba1dd1f189486beb6e1d070a850f6ab4bd521"
+
 "@types/bluebird@3.5.20":
  version "3.5.20"
  resolved "https://registry.yarnpkg.com/@types/bluebird/-/bluebird-3.5.20.tgz#f6363172add6f4eabb8cada53ca9af2781e8d6a1"
@@ -178,6 +182,10 @@
  "@types/express-serve-static-core" "*"
  "@types/mime" "*"
 
+"@types/zen-observable@^0.5.3":
+ version "0.5.3"
+ resolved "https://registry.yarnpkg.com/@types/zen-observable/-/zen-observable-0.5.3.tgz#91b728599544efbb7386d8b6633693a3c2e7ade5"
+
 abab@^1.0.4:
  version "1.0.4"
  resolved "https://registry.yarnpkg.com/abab/-/abab-1.0.4.tgz#5faad9c2c07f60dd76770f71cf025b62a63cfd4e"
@@ -280,7 +288,54 @@ apollo-cache-control@^0.1.0:
  dependencies:
  graphql-extensions "^0.0.x"
 
-apollo-link@^1.2.1:
+apollo-cache-inmemory@1.1.12:
+ version "1.1.12"
+ resolved "https://registry.yarnpkg.com/apollo-cache-inmemory/-/apollo-cache-inmemory-1.1.12.tgz#ab489bf046b3e026556ab28bdebb6e010cac9531"
+ dependencies:
+ apollo-cache "^1.1.7"
+ apollo-utilities "^1.0.11"
+ graphql-anywhere "^4.1.8"
+
+apollo-cache@^1.1.7:
+ version "1.1.7"
+ resolved "https://registry.yarnpkg.com/apollo-cache/-/apollo-cache-1.1.7.tgz#5817018a2fbfc05a21ba319bd17a3e7538110cc5"
+ dependencies:
+ apollo-utilities "^1.0.11"
+
+apollo-client@2.2.8:
+ version "2.2.8"
+ resolved "https://registry.yarnpkg.com/apollo-client/-/apollo-client-2.2.8.tgz#b604d31ab2d2dd00db3105d8793b93ee02ce567e"
+ dependencies:
+ "@types/zen-observable" "^0.5.3"
+ apollo-cache "^1.1.7"
+ apollo-link "^1.0.0"
+ apollo-link-dedup "^1.0.0"
+ apollo-utilities "^1.0.11"
+ symbol-observable "^1.0.2"
+ zen-observable "^0.7.0"
+ optionalDependencies:
+ "@types/async" "2.0.47"
+
+apollo-link-dedup@^1.0.0:
+ version "1.0.9"
+ resolved "https://registry.yarnpkg.com/apollo-link-dedup/-/apollo-link-dedup-1.0.9.tgz#3c4e4af88ef027cbddfdb857c043fd0574051dad"
+ dependencies:
+ apollo-link "^1.2.2"
+
+apollo-link-http-common@^0.2.4:
+ version "0.2.4"
+ resolved "https://registry.yarnpkg.com/apollo-link-http-common/-/apollo-link-http-common-0.2.4.tgz#877603f7904dc8f70242cac61808b1f8d034b2c3"
+ dependencies:
+ apollo-link "^1.2.2"
+
+apollo-link-http@1.5.4:
+ version "1.5.4"
+ resolved "https://registry.yarnpkg.com/apollo-link-http/-/apollo-link-http-1.5.4.tgz#b80b7b4b342c655b6a5614624b076a36be368f43"
+ dependencies:
+ apollo-link "^1.2.2"
+ apollo-link-http-common "^0.2.4"
+
+apollo-link@^1.0.0, apollo-link@^1.2.1, apollo-link@^1.2.2:
  version "1.2.2"
  resolved "https://registry.yarnpkg.com/apollo-link/-/apollo-link-1.2.2.tgz#54c84199b18ac1af8d63553a68ca389c05217a03"
  dependencies:
@@ -317,6 +372,10 @@ apollo-utilities@^1.0.0, apollo-utilities@^1.0.1:
  version "1.0.8"
  resolved "https://registry.yarnpkg.com/apollo-utilities/-/apollo-utilities-1.0.8.tgz#74d797d38953d2ba35e16f880326e2abcbc8b016"
 
+apollo-utilities@^1.0.11:
+ version "1.0.11"
+ resolved "https://registry.yarnpkg.com/apollo-utilities/-/apollo-utilities-1.0.11.tgz#cd36bfa6e5c04eea2caf0c204a0f38a0ad550802"
+
 append-transform@^0.4.0:
  version "0.4.0"
  resolved "https://registry.yarnpkg.com/append-transform/-/append-transform-0.4.0.tgz#d76ebf8ca94d276e247a36bad44a4b74ab611991"
@@ -1840,6 +1899,12 @@ graceful-fs@^4.1.11, graceful-fs@^4.1.2, graceful-fs@^4.1.6:
  version "4.1.11"
  resolved "https://registry.yarnpkg.com/graceful-fs/-/graceful-fs-4.1.11.tgz#0e8bdfe4d1ddb8854d64e04ea7c00e2a026e5658"
 
+graphql-anywhere@^4.1.8:
+ version "4.1.8"
+ resolved "https://registry.yarnpkg.com/graphql-anywhere/-/graphql-anywhere-4.1.8.tgz#23882e6a16ec824febbe5bca40937cdd76c5acdc"
+ dependencies:
+ apollo-utilities "^1.0.11"
+
 graphql-code-generator@^0.5.1:
  version "0.5.5"
  resolved "https://registry.yarnpkg.com/graphql-code-generator/-/graphql-code-generator-0.5.5.tgz#ad2a3ab2ffae56faf0290f0317dd515213f598e5"
@@ -1902,6 +1967,10 @@ graphql-subscriptions@^0.3.1:
  dependencies:
  es6-promise "^3.2.1"
 
+graphql-tag@2.8.0:
+ version "2.8.0"
+ resolved "https://registry.yarnpkg.com/graphql-tag/-/graphql-tag-2.8.0.tgz#52cdea07a842154ec11a2e840c11b977f9b835ce"
+
 graphql-to-typescript@0.1.2:
  version "0.1.2"
  resolved "https://registry.yarnpkg.com/graphql-to-typescript/-/graphql-to-typescript-0.1.2.tgz#a5a3ba625216c7408f13e5c62724f9973f42909b"
@@ -2454,7 +2523,7 @@ isobject@^3.0.0, isobject@^3.0.1:
  version "3.0.1"
  resolved "https://registry.yarnpkg.com/isobject/-/isobject-3.0.1.tgz#4e431e92b11a9731636aa1f9c8d1ccbcfdab78df"
 
-isomorphic-fetch@^2.1.1:
+isomorphic-fetch@2.1.1:
  version "2.2.1"
  resolved "https://registry.yarnpkg.com/isomorphic-fetch/-/isomorphic-fetch-2.2.1.tgz#611ae1acf14f5e81f729507472819fe9733558a9"
  dependencies:
@@ -4576,7 +4645,7 @@ svg-pan-zoom@^3.5.2:
  version "3.5.3"
  resolved "https://registry.yarnpkg.com/svg-pan-zoom/-/svg-pan-zoom-3.5.3.tgz#e6b52a1b349716c78e7b5f92d0ed1cc1b860f5d8"
 
-symbol-observable@^1.0.3:
+symbol-observable@^1.0.2, symbol-observable@^1.0.3:
  version "1.2.0"
  resolved "https://registry.yarnpkg.com/symbol-observable/-/symbol-observable-1.2.0.tgz#c22688aed4eab3cdc2dfeacbb561660560a00804"
 
@@ -5200,6 +5269,10 @@ zen-observable-ts@^0.8.9:
  dependencies:
  zen-observable "^0.8.0"
 
+zen-observable@^0.7.0:
+ version "0.7.1"
+ resolved "https://registry.yarnpkg.com/zen-observable/-/zen-observable-0.7.1.tgz#f84075c0ee085594d3566e1d6454207f126411b3"
+
 zen-observable@^0.8.0:
  version "0.8.8"
  resolved "https://registry.yarnpkg.com/zen-observable/-/zen-observable-0.8.8.tgz#1ea93995bf098754a58215a1e0a7309e5749ec42"