feat: replace system test with pack-n-play (#132)

* pack-n-play setup

* feedback

* system-test for js users

* js test application

templates/typescript_gapic/package.json.njk

@@ -57,6 +57,7 @@ limitations under the License.
     "mocha": "^6.0.0",
     "mv": "^2.1.1",
     "ncp": "^2.0.0",
+    "pack-n-play": "^1.0.0-2",
     "null-loader": "^3.0.0",
     "tmp": "^0.1.0",
     "ts-loader": "^6.2.1",

templates/typescript_gapic/system-test/fixtures/sample/tsconfig.json.njk → templates/typescript_gapic/system-test/fixtures/sample/src/index.js.njk

@@ -15,15 +15,17 @@ See the License for the specific language governing permissions and
 limitations under the License.
 
 -#}
-{
-  "extends": "./node_modules/gts/tsconfig-google.json",
-  "compilerOptions": {
-    "rootDir": ".",
-    "outDir": "build",
-    "types": ["node"],
-    "skipLibCheck": false
-  },
-  "include": [
-    "src/*.ts"
-  ]
+{% import "../../../../_license.njk" as license -%}
+{{license.license()}}
+{%- for service in api.services %}
+const {{ api.naming.productName.toKebabCase()}} = require('{{ api.naming.productName.toKebabCase() }}');
+{%- endfor %}
+
+function main() {
+{%- for service in api.services %}
+  const {{ service.name.toCamelCase() -}}Client = new {{ api.naming.productName.toKebabCase() }}.{{ service.name.toPascalCase() + 'Client' }}();
+  console.log("{{- service.name.toCamelCase() -}}Client was created!");
+{%- endfor %}
 }
+
+main();

templates/typescript_gapic/system-test/install.ts.njk

@@ -17,40 +17,33 @@ limitations under the License.
 -#}
 {% import "../_license.njk" as license -%}
 {{license.license()}}
-import * as execa from 'execa';
-import * as mv from 'mv';
-import {ncp} from 'ncp';
-import * as tmp from 'tmp';
-import {promisify} from 'util';
-
-const keep = false;
-const mvp = promisify(mv);
-const ncpp = promisify(ncp);
-const stagingDir = tmp.dirSync({keep, unsafeCleanup: true});
-const stagingPath = stagingDir.name;
-const pkg = require('../../package.json');
-
-describe('📦 pack and install', () => {
-  it('should be able use the library from a TypeScript application', async function() {
+import {packNTest} from 'pack-n-play';
+import { readFileSync } from 'fs';
+
+describe('typescript consumer tests', () => {
+
+  it('should have correct type signature for typescript users', async function() {
     this.timeout(300000);
-    await execa('npm', ['pack', '--unsafe-perm']);
-    const packageName = pkg.name.replace('@', '').replace('/', '-');
-    const tarball = `${packageName}-${pkg.version}.tgz`;
-    await mvp(tarball, `${stagingPath}/{{ api.naming.productName.toKebabCase() }}.tgz`);
-    await ncpp('system-test/fixtures/sample', `${stagingPath}/`);
-    await execa('npm', ['install', '--unsafe-perm'], {
-      cwd: `${stagingPath}/`,
-      stdio: 'inherit',
-    });
-    await execa('node', ['--throw-deprecation', 'build/src/index.js'], {
-      cwd: `${stagingPath}/`,
-      stdio: 'inherit',
-    });
+    const options = {
+      packageDir: process.cwd(),  // path to your module.
+      sample: {
+        description: 'typescript based user can use the type definitions',
+        ts: readFileSync('./system-test/fixtures/sample/src/index.ts').toString()
+      }
+    };
+    await packNTest(options);  // will throw upon error.
   });
 
-  after('cleanup staging', () => {
-    if (!keep) {
-      stagingDir.removeCallback();
-    }
+  it('should have correct type signature for javascript users', async function() {
+    this.timeout(300000);
+    const options = {
+      packageDir: process.cwd(),  // path to your module.
+      sample: {
+        description: 'typescript based user can use the type definitions',
+        ts: readFileSync('./system-test/fixtures/sample/src/index.js').toString()
+      }
+    };
+    await packNTest(options);  // will throw upon error.
   });
+
 });

typescript/test/testdata/keymanager/package.json.baseline

@@ -40,6 +40,7 @@
     "mocha": "^6.0.0",
     "mv": "^2.1.1",
     "ncp": "^2.0.0",
+    "pack-n-play": "^1.0.0-2",
     "null-loader": "^3.0.0",
     "tmp": "^0.1.0",
     "ts-loader": "^6.2.1",

typescript/test/testdata/keymanager/system-test/fixtures/sample/src/index.js.baseline

@@ -0,0 +1,26 @@
+// Copyright 2019 Google LLC
+//
+// Licensed under the Apache License, Version 2.0 (the "License");
+// you may not use this file except in compliance with the License.
+// You may obtain a copy of the License at
+//
+//     https://www.apache.org/licenses/LICENSE-2.0
+//
+// Unless required by applicable law or agreed to in writing, software
+// distributed under the License is distributed on an "AS IS" BASIS,
+// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+// See the License for the specific language governing permissions and
+// limitations under the License.
+//
+// ** This file is automatically generated by gapic-generator-typescript. **
+// ** https://github.com/googleapis/gapic-generator-typescript **
+// ** All changes to this file may be overwritten. **
+
+const kms = require('kms');
+
+function main() {
+  const keyManagementServiceClient = new kms.KeyManagementServiceClient();
+  console.log("keyManagementServiceClient was created!");
+}
+
+main();

typescript/test/testdata/keymanager/system-test/install.ts.baseline

@@ -16,40 +16,33 @@
 // ** https://github.com/googleapis/gapic-generator-typescript **
 // ** All changes to this file may be overwritten. **
 
-import * as execa from 'execa';
-import * as mv from 'mv';
-import {ncp} from 'ncp';
-import * as tmp from 'tmp';
-import {promisify} from 'util';
+import {packNTest} from 'pack-n-play';
+import { readFileSync } from 'fs';
 
-const keep = false;
-const mvp = promisify(mv);
-const ncpp = promisify(ncp);
-const stagingDir = tmp.dirSync({keep, unsafeCleanup: true});
-const stagingPath = stagingDir.name;
-const pkg = require('../../package.json');
+describe('typescript consumer tests', () => {
 
-describe('📦 pack and install', () => {
-  it('should be able use the library from a TypeScript application', async function() {
+  it('should have correct type signature for typescript users', async function() {
     this.timeout(300000);
-    await execa('npm', ['pack', '--unsafe-perm']);
-    const packageName = pkg.name.replace('@', '').replace('/', '-');
-    const tarball = `${packageName}-${pkg.version}.tgz`;
-    await mvp(tarball, `${stagingPath}/kms.tgz`);
-    await ncpp('system-test/fixtures/sample', `${stagingPath}/`);
-    await execa('npm', ['install', '--unsafe-perm'], {
-      cwd: `${stagingPath}/`,
-      stdio: 'inherit',
-    });
-    await execa('node', ['--throw-deprecation', 'build/src/index.js'], {
-      cwd: `${stagingPath}/`,
-      stdio: 'inherit',
-    });
+    const options = {
+      packageDir: process.cwd(),  // path to your module.
+      sample: {
+        description: 'typescript based user can use the type definitions',
+        ts: readFileSync('./system-test/fixtures/sample/src/index.ts').toString()
+      }
+    };
+    await packNTest(options);  // will throw upon error.
   });
 
-  after('cleanup staging', () => {
-    if (!keep) {
-      stagingDir.removeCallback();
-    }
+  it('should have correct type signature for javascript users', async function() {
+    this.timeout(300000);
+    const options = {
+      packageDir: process.cwd(),  // path to your module.
+      sample: {
+        description: 'typescript based user can use the type definitions',
+        ts: readFileSync('./system-test/fixtures/sample/src/index.js').toString()
+      }
+    };
+    await packNTest(options);  // will throw upon error.
   });
+
 });

typescript/test/testdata/showcase/package.json.baseline

@@ -40,6 +40,7 @@
     "mocha": "^6.0.0",
     "mv": "^2.1.1",
     "ncp": "^2.0.0",
+    "pack-n-play": "^1.0.0-2",
     "null-loader": "^3.0.0",
     "tmp": "^0.1.0",
     "ts-loader": "^6.2.1",

typescript/test/testdata/showcase/system-test/fixtures/sample/src/index.js.baseline

@@ -0,0 +1,26 @@
+// Copyright 2019 Google LLC
+//
+// Licensed under the Apache License, Version 2.0 (the "License");
+// you may not use this file except in compliance with the License.
+// You may obtain a copy of the License at
+//
+//     https://www.apache.org/licenses/LICENSE-2.0
+//
+// Unless required by applicable law or agreed to in writing, software
+// distributed under the License is distributed on an "AS IS" BASIS,
+// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+// See the License for the specific language governing permissions and
+// limitations under the License.
+//
+// ** This file is automatically generated by gapic-generator-typescript. **
+// ** https://github.com/googleapis/gapic-generator-typescript **
+// ** All changes to this file may be overwritten. **
+
+const showcase = require('showcase');
+
+function main() {
+  const echoClient = new showcase.EchoClient();
+  console.log("echoClient was created!");
+}
+
+main();