first commit

zcfan · zcfan · commit 94e0477409d2 · 2020-06-11T10:15:29.000+08:00
diff --git a/.eslintrc b/.eslintrc
@@ -0,0 +1,3 @@
+{
+  "extends": "appium"
+}
diff --git a/.gitignore b/.gitignore
@@ -0,0 +1,47 @@
+.DS_Store
+.vscode
+
+# Logs
+logs
+*.log
+npm-debug.log*
+package-lock.json*
+
+# Runtime data
+pids
+*.pid
+*.seed
+
+# Directory for instrumented libs generated by jscoverage/JSCover
+lib-cov
+
+# Coverage directory used by tools like istanbul
+coverage
+
+# nyc test coverage
+.nyc_output
+
+# Grunt intermediate storage (http://gruntjs.com/creating-plugins#storing-task-files)
+.grunt
+
+# node-waf configuration
+.lock-wscript
+
+# Compiled binary addons (http://nodejs.org/api/addons.html)
+build/Release
+
+# Dependency directories
+node_modules
+jspm_packages
+
+# Optional npm cache directory
+.npm
+
+# Optional REPL history
+.node_repl_history
+
+# Ignore gulped JS
+build
+
+# Pack output
+*.tgz
diff --git a/README.md b/README.md
@@ -0,0 +1,45 @@
+Appium MiniProgram Driver
+----
+
+Appium MiniProgram Driver is a test automation tool for WeiXin(a.k.a. WeChat) MiniProgram. 
+
+Appium MiniProgram Driver 是针对微信小程序的测试自动化工具。将微信官方自动化接口封装为 Appium Driver，借助 Appium 框架与 WebDriver API，我们可以使用多种编程语言编写小程序自动化脚本。
+
+## 现状
+
+试验性完成了：
+
+- 截图
+- css selector 获取单个、多个 element
+- tap 指定 element
+- longPress 指定 element
+- pageScrollTo
+- scroll-view 的 scrollTo
+- swiper 的 swipeTo
+
+## 障碍
+
+#### 手势 API 不标准
+
+只是简单尝试一下就遇到了 scroll-view 和 swiper 两个标签有自己的特殊 API。不过解决起来也还好，暂时不算坑。
+
+#### 截图 API 有问题
+
+miniprogram-automator 的 screenshot 本身就有问题，一开始好好的突然开始截图失败。
+
+```
+> mpProgram.screenshot()
+Promise { <pending> }
+> (node:50420) UnhandledPromiseRejectionWarning: Error: fail to capture screenshot
+    at Transport.Connection.onMessage (/PATH_TO_PROJECT/appium-mp-driver/node_modules/miniprogram-automator/out/Connection.js:1:986)
+    at Transport.emit (events.js:315:20)
+    at Transport.EventEmitter.emit (domain.js:505:15)
+    at WebSocket.<anonymous> (/PATH_TO_PROJECT/appium-mp-driver/node_modules/miniprogram-automator/out/Transport.js:1:219)
+    at WebSocket.onMessage (/PATH_TO_PROJECT/appium-mp-driver/node_modules/miniprogram-automator/node_modules/ws/lib/event-target.js:120:16)
+    at WebSocket.emit (events.js:315:20)
+    at WebSocket.EventEmitter.emit (domain.js:505:15)
+    at Receiver.receiverOnMessage (/PATH_TO_PROJECT/appium-mp-driver/node_modules/miniprogram-automator/node_modules/ws/lib/websocket.js:789:20)
+    at Receiver.emit (events.js:315:20)
+    at Receiver.EventEmitter.emit (domain.js:505:15)
+(node:50420) UnhandledPromiseRejectionWarning: Unhandled promise rejection. This error originated either by throwing inside of an async function without a catch block, or by rejecting a promise which was not handled with .catch(). To terminate the node process on unhandled promise rejection, use the CLI flag `--unhandled-rejections=strict` (see https://nodejs.org/api/cli.html#cli_unhandled_rejections_mode). (rejection id: 14)
+```
diff --git a/gulpfile.js b/gulpfile.js
@@ -0,0 +1,10 @@
+'use strict';
+
+const gulp = require('gulp');
+const boilerplate = require('appium-gulp-plugins').boilerplate.use(gulp);
+
+
+boilerplate({
+  build: 'appium-mp-driver',
+  watchE2E: true,
+});
diff --git a/index.js b/index.js
@@ -0,0 +1,26 @@
+// transpile:main
+
+import yargs from 'yargs';
+import { asyncify } from 'asyncbox';
+import * as server from './lib/server';
+import * as driver from './lib/driver';
+
+const { startServer } = server;
+
+const DEFAULT_HOST = 'localhost';
+const DEFAULT_PORT = 4723;
+
+async function main () {
+  let port = yargs.argv.port || DEFAULT_PORT;
+  let host = yargs.argv.host || DEFAULT_HOST;
+  return await startServer(port, host);
+}
+
+if (require.main === module) {
+  asyncify(main);
+}
+
+const { MpDriver } = driver;
+
+export default MpDriver;
+export { MpDriver };
diff --git a/lib/commands/find.js b/lib/commands/find.js
@@ -0,0 +1,63 @@
+/* eslint-disable */
+import { errors } from 'appium-base-driver';
+
+let commands = {};
+
+commands.findElOrEls = async function (strategy, selector, mult, context) {
+  this.findedElements = this.findedElements || {};
+
+  let result;
+  const doFind = async () => {
+    if(strategy !== 'css selector') {
+      throw new Error('Unsupported strategy for findElOrEls: ' + strategy);
+    }
+    
+    // 默认在当前页面上查找元素
+    let context;
+    if (typeof context === 'undefined' || !context) {
+      context = await this.mpProgram.currentPage();
+    } else {
+      context = this.findedElements[context];
+    }
+  
+    if (mult) {
+      result = await context.$$(selector);
+      if (result) {
+        result = result.map(el => {
+          this.findedElements[el.id] = el;
+          return {
+            elementId: el.id
+          };
+        })
+        return true;
+      } else {
+        return false;
+      }
+    } else {
+      result = await context.$(selector);
+      if (result) {
+        this.findedElements[result.id] = result;
+        result = {
+          elementId: result.id
+        };
+        return true;
+      } else {
+        return false;
+      }
+    }
+  }
+
+  try {
+    await this.implicitWaitForCondition(doFind);
+  } catch (err) {
+    if (err.message && err.message.match(/Condition unmet/)) {
+      // 没有找到元素
+      throw new errors.NoSuchElementError(result);
+    } else {
+      throw err;
+    }
+  }
+  return result;
+};
+
+export default commands;
diff --git a/lib/commands/gesture.js b/lib/commands/gesture.js
@@ -0,0 +1,91 @@
+/* eslint-disable */
+import { errors } from 'appium-base-driver';
+
+let commands = {};
+
+commands.click = async function (elementId = null) {
+  await this.tapEl(elementId);
+};
+
+commands.tapEl = async function (elementId, longPress) {
+  const page = await this.mpProgram.currentPage();
+  const el = await page.$(elementId);
+  if (el) {
+    if (longPress) {
+      await el.longPress();
+    } else {
+      await el.tap();
+    }
+  } else {
+    throw new Error(`click failed, element ${elementId} not found`);
+  }
+};
+
+commands.tap = async function (gestures, longPress) {
+  let elementId = gestures[0].options.element;
+  await this.tapEl(elementId, longPress);
+};
+
+commands.performTouch = async function (gestures) {
+  if (gestures.length === 3) {
+    
+    if (gestures[0].action === 'press' && gestures[1].action === 'moveTo' && gestures[2].action === 'release') {
+      return await this.doSwipe(gestures);
+    }
+
+  } else if (gestures.length === 2) {
+    
+    if (gestures[0].action === 'press' && gestures[1].action === 'release') {
+      return await this.tap(gestures, false);
+    } else if (gestures[0].action === 'longPress' && gestures[1].action === 'release') {
+      return await this.tap(gestures, true);
+    }
+
+  } else if (gestures.length === 1) {
+    if (gestures[0].action === 'tap') {
+
+      return await this.tap(gestures, false);
+    
+    } else if (gestures[0].action === 'pageScrollTo') {
+
+      // 小程序 page 特有的 API
+      await this.mpProgram.pageScrollTo(gestures[0].options.scrollTop)
+      return true
+    
+    } else if (gestures[0].action === 'scrollTo') {
+
+      // 小程序 scroll-view 特有的 API
+      const opts = gestures[0].options;
+      const page = await this.mpProgram.currentPage();
+      const scrollView = await page.$(opts.element);
+      if (!scrollView) {
+        throw new errors.NoSuchElementError(scrollView);
+      }
+      if (scrollView.tagName !== 'scrollView') {
+        throw new Error(`element ${opts.element} is not a scrollView`)
+      }
+      await scrollView.scrollTo(opts.x, opts.y);
+      return true;
+    
+    } else if (gestures[0].action === 'swipeTo') {
+
+      // 小程序 swiper 组件特有的 API，微信能搞点阳间的玩意不
+      const opts = gestures[0].options;
+      const page = await this.mpProgram.currentPage();
+      const swiper = await page.$(opts.element);
+      if (!swiper) {
+        throw new errors.NoSuchElementError(swiper);
+      }
+      if (swiper.tagName !== 'swiper') {
+        throw new Error(`element ${opts.element} is not a swiper`)
+      }
+      await swiper.swipeTo(opts.index);
+      return true;
+
+    }
+  }
+};
+
+
+export default commands;
+ 
diff --git a/lib/commands/index.js b/lib/commands/index.js
@@ -0,0 +1,22 @@
+import screenShotCmds from './screenshot';
+import findCmds from './find';
+import gestureCmds from './gesture';
+
+let commands = {};
+Object.assign(
+  commands,
+  // contextCommands,
+  // settingsCmds,
+  // timeoutCmds,
+  findCmds,
+  // generalCmds,
+  screenShotCmds,
+  // elementCmds,
+  gestureCmds,
+  // navigationCmds,
+  // executeCmds,
+  // mobileCmds,
+  // add other command types here
+);
+
+export default commands;
diff --git a/lib/commands/screenshot.js b/lib/commands/screenshot.js
@@ -0,0 +1,7 @@
+let commands = {};
+
+commands.getScreenshot = async function () {
+  return await this.mpProgram.screenshot();
+};
+
+export default commands;
diff --git a/lib/desired-caps.js b/lib/desired-caps.js
@@ -0,0 +1,32 @@
+const desiredCapConstraints = {
+  platformName: {
+    presence: true,
+    isString: true,
+    inclusionCaseInsensitive: [
+      'iOS',
+      'Android',
+      'Simulator'
+    ]
+  },
+  automationName: {
+    presence: true,
+    isString: true,
+    inclusionCaseInsensitive: [
+      'MP',
+    ]
+  },
+  app: {
+    isString: true
+  },
+  MpAppAddress: {
+    isString: true
+  },
+  avd: {
+    isString: true
+  },
+  udid: {
+    isString: true
+  }
+};
+
+export default desiredCapConstraints;
diff --git a/lib/driver.js b/lib/driver.js
diff --git a/lib/server.js b/lib/server.js
diff --git a/package.json b/package.json
diff --git a/test/unit/driver-specs.js b/test/unit/driver-specs.js
