Merge pull request #216 from proto-graphql/izumin5210/e2e

New e2e testing

Author: izumin5210

.changeset/wild-toes-pull.md

@@ -0,0 +1,8 @@
+---
+"@proto-graphql/e2e": patch
+"@testapis/proto": patch
+"protoc-gen-nexus": patch
+"protoc-gen-pothos": patch
+---
+
+new E2E testing

.github/workflows/ci.yml

@@ -28,7 +28,7 @@ jobs:
         base-path: packages/protoc-gen-nexus
 
 
-  test-integration:
+  test-e2e:
 
     runs-on: ubuntu-latest
 
@@ -40,5 +40,6 @@ jobs:
       uses: actions/setup-node@v1
       with:
         node-version: 14.x
+    - uses: bufbuild/buf-setup-action@v1
     - run: yarn --frozen-lockfile
-    - run: yarn test:integration
+    - run: yarn test:e2e

buf.work.yaml

@@ -0,0 +1,3 @@
+version: v1
+directories:
+  - packages/@testapis/proto/src

e2e/.gitignore

@@ -0,0 +1,3 @@
+/tests/__generated__/*
+/tests/*/__generated__/*
+!/tests/*/__generated__/schema.graphql

e2e/buf.gen.yaml

@@ -0,0 +1,26 @@
+version: v1
+plugins:
+  - name: nexus
+    path: ../packages/protoc-gen-nexus/bin/protoc-gen-nexus
+    out: tests/__generated__/nexus/protobufjs
+    opt:
+      - use_protobufjs
+      - import_prefix=@testapis/node/lib/
+  - name: nexus
+    path: ../packages/protoc-gen-nexus/bin/protoc-gen-nexus
+    out: tests/__generated__/nexus/google-protobuf
+    opt:
+      - import_prefix=@testapis/node-native/lib/
+  - name: pothos
+    path: ../packages/protoc-gen-pothos/bin/protoc-gen-pothos
+    out: tests/__generated__/pothos/ts-proto
+    opt:
+      - import_prefix=@testapis/ts-proto/lib/
+      - pothos_builder_path=@/builder
+  - name: pothos
+    path: ../packages/protoc-gen-pothos/bin/protoc-gen-pothos
+    out: tests/__generated__/pothos/ts-proto-with-forcelong-number
+    opt:
+      - import_prefix=@testapis/ts-proto-with-forcelong-number/lib/
+      - pothos_builder_path=@/builder
+      - long_number=Int

e2e/jest.config.js

@@ -0,0 +1,24 @@
+// eslint-disable-next-line @typescript-eslint/no-var-requires
+const path = require("path");
+
+module.exports = {
+  // eslint-disable-next-line @typescript-eslint/no-var-requires
+  projects: require("glob")
+    .sync("./tests/*/tsconfig.json")
+    .map((tsconfigPath) => {
+      return {
+        preset: "ts-jest",
+        testEnvironment: "node",
+        rootDir: path.dirname(tsconfigPath),
+        moduleNameMapper: {
+          "^@/(.*)$": "<rootDir>/$1",
+        },
+      };
+    }),
+  globals: {
+    "ts-jest": {
+      // typecheck on other process
+      diagnostics: false,
+    },
+  },
+};

e2e/package.json

@@ -0,0 +1,22 @@
+{
+  "name": "@proto-graphql/e2e",
+  "version": "0.0.1",
+  "description": "E2E tests",
+  "private": true,
+  "devDependencies": {
+    "@testapis/node": "^0.5.0",
+    "@testapis/node-native": "^0.5.1",
+    "@testapis/ts-proto": "^0.5.1",
+    "@testapis/ts-proto-with-forcelong-number": "^0.6.0",
+    "protoc-gen-nexus": "^0.5.1",
+    "protoc-gen-pothos": "^0.2.0",
+    "tsconfig-paths": "^4.1.0"
+  },
+  "scripts": {
+    "test:setup": "./setupTests.mjs",
+    "test:typecheck": "tsc -b tsconfig.json",
+    "test:jest": "jest",
+    "test:schema": "git diff --exit-code tests/**/schema.graphql",
+    "test:e2e": "yarn test:setup && yarn test:typecheck && yarn test:jest && yarn test:schema"
+  }
+}

e2e/setupTests.mjs

@@ -0,0 +1,84 @@
+#!/usr/bin/env node
+/* eslint-disable @typescript-eslint/no-var-requires */
+
+import { exec as _exec } from "child_process";
+import { mkdir, readFile, rm, writeFile } from "fs/promises";
+import { basename, join, relative } from "path";
+import { promisify } from "util";
+
+const exec = promisify(_exec);
+const header = `// Code generated by ${basename(import.meta.url)}. DO NOT EDIT.`;
+const testsDir = "tests";
+
+/**
+ * @param {{ target: "nexus" | "pothos", proto: { package: String, lib: String } } opts
+ */
+function getTestPath(opts) {
+  return `${testsDir}/${[opts.target, opts.proto.package.replace("/", "-"), opts.proto.lib].join("--")}`;
+}
+
+/**
+ * @param {{ target: "nexus" | "pothos", proto: { package: String, lib: String } } opts
+ */
+async function setupTest(opts) {
+  const path = getTestPath(opts);
+  const genDir = join(path, "__generated__");
+  const tsconfigPath = join(path, "tsconfig.json");
+  const schemaPath = join(path, "schema.ts");
+
+  await rm(genDir, { recursive: true, force: true });
+  await mkdir(genDir, { recursive: true });
+
+  const tsconfig = {
+    extends: "../../tsconfig.base.json",
+    compilerOptions: {
+      baseUrl: ".",
+      paths: {
+        "@/*": ["./*"],
+      },
+    },
+    include: [
+      ".",
+      relative(path, "./src"),
+      relative(
+        path,
+        [testsDir, "__generated__", opts.target, opts.proto.lib, "testapis", ...opts.proto.package.split("/")].join("/")
+      ),
+    ].map((p) => `${p}/**/*`),
+  };
+
+  await writeFile(tsconfigPath, `${header}\n${JSON.stringify(tsconfig, undefined, 2)}`, "utf-8");
+
+  await exec(`yarn ts-node --transpile-only --require tsconfig-paths/register --project ${tsconfigPath} ${schemaPath}`);
+}
+
+async function setupTests() {
+  /** @type {{ tests: { target: "nexus" | "pothos", proto: { package: String, lib: String} }[] } */
+  const config = JSON.parse(await readFile("tests.json", "utf-8"));
+
+  await Promise.all(config.tests.map(setupTest));
+  await writeFile(
+    "tsconfig.json",
+    `${header}\n${JSON.stringify(
+      {
+        files: [],
+        references: config.tests.map((tt) => ({ path: getTestPath(tt) })),
+      },
+      undefined,
+      2
+    )}`,
+    "utf-8"
+  );
+}
+
+async function setupProtoNexus() {
+  await rm(join(testsDir, "__generated__"), { recursive: true, force: true });
+  await exec(`buf generate ${join("..", "packages", "@testapis", "proto", "src")}`);
+}
+
+async function main() {
+  await setupProtoNexus();
+  await setupTests();
+}
+
+await main();

e2e/src/makeTestSchema.ts

@@ -0,0 +1,20 @@
+import { makeSchema } from "nexus";
+import * as path from "path";
+
+export function makeTestSchema({ rootDir, types }: { rootDir: string; types: any }) {
+  const schema = makeSchema({
+    types,
+    outputs: {
+      schema: path.join(rootDir, "__generated__", "schema.graphql"),
+      typegen: path.join(rootDir, "__generated__", "typings.ts"),
+    },
+    shouldGenerateArtifacts: true,
+    features: {
+      abstractTypeStrategies: {
+        isTypeOf: true,
+      },
+    },
+  });
+
+  return schema;
+}

e2e/src/printGraphqlSchema.ts

@@ -0,0 +1,8 @@
+import { mkdirSync, writeFileSync } from "fs";
+import { GraphQLSchema, printSchema } from "graphql";
+import { join } from "path";
+
+export function printGraphqlSchema({ rootDir, schema }: { rootDir: string; schema: GraphQLSchema }) {
+  mkdirSync(join(rootDir, "__generated__"), { recursive: true });
+  writeFileSync(join(rootDir, "__generated__", "schema.graphql"), printSchema(schema), "utf-8");
+}