feat: client test

myan9 · starpit · commit 4c16985d4497 · 2019-10-30T17:17:28.000-04:00
Fixes #3130
diff --git a/.travis.yml b/.travis.yml
@@ -18,6 +18,10 @@ env:
       KUI_USE_PROXY=true
       NEEDS_IBMCLOUD_CLI=true # see plugins/plugin-bash-like/src/test/bash-like/bash-like.ts
 
+    - LAYERS="response"
+      MOCHA_TARGETS="electron"
+      KUI_USE_CLIENT=test
+
     - LAYERS="core"
       MOCHA_TARGETS="electron"
       KUI_USE_CLIENT=base
@@ -89,6 +93,8 @@ matrix:
       env: LAYERS="core" MOCHA_TARGETS="electron" KUI_USE_CLIENT=base LINUX_BASE_BUILD="${TRAVIS_BUILD_DIR}/clients/electron/dist/electron/Kui-base-linux-x64/Kui" OSX_BASE_BUILD="${TRAVIS_BUILD_DIR}/clients/electron/dist/electron/Kui-base-darwin-x64/Kui.app/Contents/MacOS/Kui" TEST_FROM_BUILD=`[ "$TRAVIS_OS_NAME" == linux ] && echo "$LINUX_BASE_BUILD" || echo "$OSX_BASE_BUILD"`
     - os: osx
       env: SCRIPTS="build-webpack-client.sh lint.sh typecov.sh" WAIT_LAYERS="manager" LAYERS="openwhisk1 openwhisk3 openwhisk-editor grid" MOCHA_TARGETS="webpack electron" KUI_USE_PROXY=false NEEDS_OPENWHISK=true
+    - os: osx
+      env: LAYERS="response" MOCHA_TARGETS="electron" KUI_USE_CLIENT=test
     - os: osx
       env: LAYERS="openwhisk2 openwhisk4 composer1 composer2" MOCHA_TARGETS="electron" NEEDS_OPENWHISK=true NEEDS_OPENWHISK_API_GATEWAY=true NEEDS_OPENWHISK_NODEJS8=true NEEDS_OPENWHISK_JAVA8=true NEEDS_SECOND_OPENWHISK_AUTH=true
     - os: osx
diff --git a/clients/test/.gitignore b/clients/test/.gitignore
@@ -0,0 +1,3 @@
+.npmrc
+dist
+package-lock.json
diff --git a/clients/test/package.json b/clients/test/package.json
@@ -0,0 +1,41 @@
+{
+  "name": "client-test",
+  "version": "1.0.0",
+  "description": "A test client for the Kui",
+  "main": "node_modules/@kui-shell/core/main/main.js",
+  "scripts": {
+    "preinstall": "rm -rf node_modules package-lock.json; (cd ../../ && npm ci && npm run pack)",
+    "build:electron": "build() { npx --no-install kui-build-electron /tmp $1; }; build",
+    "compile": "kui-compile",
+    "postinstall": "kui-compile",
+    "test": "kui-test",
+    "watch": "tsc --build . --watch",
+    "pty:rebuild": "if [ -d node_modules/node-pty-prebuilt-multiarch ]; then cd node_modules/node-pty-prebuilt-multiarch && npm run install; fi",
+    "pty:electron": "if [ -d node_modules/node-pty-prebuilt-multiarch ]; then if [ ! -e node_modules/node-pty-prebuilt-multiarch/.npmrc ]; then cp node_modules/@kui-shell/builder/npmrc node_modules/node-pty-prebuilt-multiarch/.npmrc && npm run pty:rebuild; fi; fi",
+    "pty:nodejs": "if [ -e node_modules/node-pty-prebuilt-multiarch/.npmrc ]; then rm -f node_modules/node-pty-prebuilt-multiarch/.npmrc; npm run pty:rebuild; fi",
+    "start": "npm run -s compile && npm run -s pty:electron && electron . shell"
+  },
+  "repository": {
+    "type": "git",
+    "url": "git@github.com:kui-shell/plugin-sample.git"
+  },
+  "keywords": [],
+  "author": "Mengting Yan",
+  "license": "Apache-2.0",
+  "devDependencies": {
+    "@kui-shell/builder": "file:/tmp/kui-packs/kui-shell-builder.tgz",
+    "@kui-shell/core": "file:/tmp/kui-packs/kui-shell-core.tgz",
+    "@kui-shell/test": "file:/tmp/kui-packs/kui-shell-test.tgz",
+    "@types/mocha": "5.2.7",
+    "@types/node": "12.7.12",
+    "@types/uuid": "^3.4.5",
+    "@types/webdriverio": "^4.13.3",
+    "electron": "6.0.12",
+    "mocha": "6.2.1",
+    "spectron": "8.0.0",
+    "typescript": "3.6.4"
+  },
+  "dependencies": {
+    "@kui-shell/plugin-test": "file:plugins/plugin-test"
+  }
+}
diff --git a/clients/test/plugins/plugin-test/.gitignore b/clients/test/plugins/plugin-test/.gitignore
@@ -0,0 +1,2 @@
+dist
+tsconfig.tsbuildinfo
diff --git a/clients/test/plugins/plugin-test/package.json b/clients/test/plugins/plugin-test/package.json
@@ -0,0 +1,20 @@
+{
+  "name": "@kui-shell/plugin-test",
+  "version": "0.0.1",
+  "description": "A test plugin for the Kui",
+  "author": "Mengting Yan",
+  "license": "Apache-2.0",
+  "keywords": [
+    "kui",
+    "plugin",
+    "sample",
+    "example"
+  ],
+  "main": "dist/plugin.js",
+  "dependencies": {
+    "@kui-shell/core": "file:/tmp/kui-packs/kui-shell-core.tgz"
+  },
+  "publishConfig": {
+    "access": "public"
+  }
+}
diff --git a/clients/test/plugins/plugin-test/src/plugin.ts b/clients/test/plugins/plugin-test/src/plugin.ts
@@ -0,0 +1,32 @@
+/*
+ * Copyright 2019 IBM Corporation
+ *
+ * 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
+ *
+ * http://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.
+ */
+
+import { CommandRegistrar } from '@kui-shell/core/models/command'
+
+const usage = (command: string) => ({
+  command,
+  docs: 'Say hello!'
+})
+
+const options = (cmd: string) => ({ usage: usage(cmd), noAuthOk: true })
+
+const stringResponse = () => {
+  return 'hello world'
+}
+
+export default async (commandTree: CommandRegistrar) => {
+  commandTree.listen('/test/string', stringResponse, options('test string'))
+}
diff --git a/clients/test/plugins/plugin-test/src/test/response/stringResponse.ts b/clients/test/plugins/plugin-test/src/test/response/stringResponse.ts
@@ -0,0 +1,23 @@
+/*
+ * Copyright 2019 IBM Corporation
+ *
+ * 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
+ *
+ * http://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.
+ */
+import { TestStringResponse } from '@kui-shell/test'
+
+/* eslint-disable no-new */
+new TestStringResponse({
+  command: 'test string',
+  expect: 'hello world',
+  exact: true
+})
diff --git a/clients/test/plugins/plugin-test/tsconfig.json b/clients/test/plugins/plugin-test/tsconfig.json
@@ -0,0 +1,10 @@
+{
+  "extends": "../../node_modules/@kui-shell/builder/tsconfig-base.json",
+  "include": ["src/**/*"],
+  "compilerOptions": {
+    "composite": true,
+    "noImplicitAny": true,
+    "outDir": "dist",
+    "rootDir": "src"
+  }
+}
diff --git a/clients/test/theme b/clients/test/theme
@@ -0,0 +1 @@
+../default/theme
diff --git a/clients/test/tsconfig.json b/clients/test/tsconfig.json
@@ -0,0 +1,4 @@
+{
+  "extends": "./node_modules/@kui-shell/builder/tsconfig-base.json",
+  "references": [{ "path": "./plugins/plugin-test" }]
+}
diff --git a/packages/test/src/api/string-response.ts b/packages/test/src/api/string-response.ts
@@ -0,0 +1,38 @@
+/*
+ * Copyright 2019 IBM Corporation
+ *
+ * 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
+ *
+ * http://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.
+ */
+import * as Common from './common'
+import * as CLI from './cli'
+import * as ReplExpect from './repl-expect'
+
+interface TestParam {
+  command: string
+  expect: string
+  exact: boolean
+}
+
+export class TestStringResponse {
+  public constructor(test: TestParam) {
+    describe(`string response ${process.env.MOCHA_RUN_TARGET || ''}`, function(this: Common.ISuite) {
+      before(Common.before(this))
+      after(Common.after(this))
+
+      it('should return a string', () =>
+        CLI.command(test.command, this.app)
+          .then(ReplExpect.okWithString(test.expect, test.exact))
+          .catch(Common.oops(this, true)))
+    })
+  }
+}
diff --git a/packages/test/src/index.ts b/packages/test/src/index.ts
@@ -29,3 +29,5 @@ export { ReplExpect }
 export { Selectors }
 export { SidecarExpect }
 export { Util }
+
+export { TestStringResponse } from './api/string-response'
diff --git a/tools/travis/test/script.sh b/tools/travis/test/script.sh
@@ -159,7 +159,13 @@ if [ -n "$LAYERS" ]; then
             export PORT_OFFSET_BASE
 
             echo "running these non-headless layers with $MOCHA_RUN_TARGET: $NON_HEADLESS_LAYERS"
-            (MONOREPO_MODE=true npm run test $NON_HEADLESS_LAYERS) &
+
+            if [ "$KUI_USE_CLIENT" == test ]; then
+              (cd clients/"$MOCHA_RUN_TARGET"; npm run test $NON_HEADLESS_LAYERS) &
+            else
+              (MONOREPO_MODE=true npm run test $NON_HEADLESS_LAYERS) &
+            fi
+
             children+=("$!")
             childrenNames+=("mocha layers")
             childrenStartTimes+=("$(date +%s)")
diff --git a/tools/travis/test/target.d/electron.sh b/tools/travis/test/target.d/electron.sh
@@ -30,8 +30,8 @@ PLATFORM=`uname | tr '[:upper:]' '[:lower:]'`
 
 cd clients/electron
 
-# pick up the dependencies of kui-base
-[[ "$KUI_USE_CLIENT" == base ]] && npm install
+# pick up the dependencies of the client
+[[ -n "$KUI_USE_CLIENT" ]] && npm install
 
 NO_INSTALLER=`[[ "$TRAVIS_OS_NAME" == linux ]] && echo true` npm run build:electron -- ${PLATFORM} # we want to test Mac DMG Build
 

Original file line number	Diff line number	Diff line change
`@@ -0,0 +1,3 @@`
	`1`	`+.npmrc`
	`2`	`+dist`
	`3`	`+package-lock.json`
-Original file line number
+Diff line change
@@ @@ -0,0 +1,4 @@ @@
 +{
 +  "extends": "./node_modules/@kui-shell/builder/tsconfig-base.json",
 +  "references": [{ "path": "./plugins/plugin-test" }]
 +}