test: Migrate e2e tests to typescript (#973)

Author: mykola-mokhnach

package.json

@@ -39,7 +39,7 @@
     "e2e-test:commands:find": "mocha --exit --timeout 10m \"./test/functional/commands/find\"",
     "e2e-test:commands:general": "mocha --exit --timeout 10m \"./test/functional/commands/general\"",
     "e2e-test:commands:keyboard": "mocha --exit --timeout 10m \"./test/functional/commands/keyboard\"",
-    "e2e-test:driver": "mocha --exit --timeout 10m \"./test/functional/driver-e2e-specs.js\"",
+    "e2e-test:driver": "mocha --exit --timeout 10m \"./test/functional/driver-e2e-specs.ts\"",
     "lint": "eslint .",
     "lint:commit": "commitlint",
     "lint:fix": "npm run lint -- --fix",

scripts/run-functional-tests.sh

@@ -25,7 +25,7 @@ checkTestPrerequisites
 
 RESULTS_XML=test-results.xml
 echo "{\"reporterEnabled\": \"spec, xunit\", \"xunitReporterOptions\": {\"output\": \"$RESULTS_XML\"}}" > reporter_config.json
-ARGS=(./test/functional/driver-e2e-specs.js \
+ARGS=(./test/functional/driver-e2e-specs.ts \
 ./test/functional/commands \
 ./test/functional/commands/find \
 ./test/functional/commands/general \

…onal/commands/file-movement-e2e-specs.js …onal/commands/file-movement-e2e-specs.tstest/functional/commands/file-movement-e2e-specs.js renamed to test/functional/commands/file-movement-e2e-specs.ts test/functional/commands/file-movement-e2e-specs.js renamed to test/functional/commands/file-movement-e2e-specs.ts

@@ -1,63 +1,59 @@
-import _ from 'lodash';
+import type {Browser} from 'webdriverio';
 import B from 'bluebird';
-import stream from 'stream';
+import stream from 'node:stream';
 import unzipper from 'unzipper';
-import { APIDEMOS_CAPS } from '../desired';
-import { initSession, deleteSession } from '../helpers/session';
+import {APIDEMOS_CAPS} from '../desired';
+import {initSession, deleteSession} from '../helpers/session';
+import chai, {expect} from 'chai';
+import chaiAsPromised from 'chai-as-promised';
 
+chai.use(chaiAsPromised);
 
 describe('file movement', function () {
-  let driver;
-  let chai;
+  let driver: Browser;
 
   before(async function () {
-    chai = await import('chai');
-    const chaiAsPromised = await import('chai-as-promised');
-
-    chai.should();
-    chai.use(chaiAsPromised.default);
-
     driver = await initSession(APIDEMOS_CAPS);
   });
   after(async function () {
     await deleteSession();
   });
 
-  function getRandomDir () {
+  function getRandomDir(): string {
     return `/data/local/tmp/test${Math.random()}`;
   }
 
   it('should push and pull a file', async function () {
-    let stringData = `random string data ${Math.random()}`;
-    let base64Data = Buffer.from(stringData).toString('base64');
-    let remotePath = `${getRandomDir()}/remote.txt`;
+    const stringData = `random string data ${Math.random()}`;
+    const base64Data = Buffer.from(stringData).toString('base64');
+    const remotePath = `${getRandomDir()}/remote.txt`;
 
     await driver.pushFile(remotePath, base64Data);
 
     // get the file and its contents, to check
-    let remoteData64 = await driver.pullFile(remotePath);
-    let remoteData = Buffer.from(remoteData64, 'base64').toString();
-    remoteData.should.equal(stringData);
+    const remoteData64 = await driver.pullFile(remotePath);
+    const remoteData = Buffer.from(remoteData64, 'base64').toString();
+    expect(remoteData).to.equal(stringData);
   });
 
   it('should pull a folder', async function () {
-    let stringData = `random string data ${Math.random()}`;
-    let base64Data = Buffer.from(stringData).toString('base64');
+    const stringData = `random string data ${Math.random()}`;
+    const base64Data = Buffer.from(stringData).toString('base64');
 
     // send the files, then pull the whole folder
-    let remoteDir = getRandomDir();
+    const remoteDir = getRandomDir();
     await driver.pushFile(`${remoteDir}/remote0.txt`, base64Data);
     await driver.pushFile(`${remoteDir}/remote1.txt`, base64Data);
 
     // TODO: 'pullFolder' is returning 404 error
-    let data = await driver.pullFolder(remoteDir);
+    const data = await driver.pullFolder(remoteDir);
 
     // go through the folder we pulled and make sure the
     // two files we pushed are in it
-    let zipPromise = new B((resolve) => {
+    const zipPromise = new B<number>((resolve) => {
       let entryCount = 0;
-      let zipStream = new stream.Readable();
-      zipStream._read = _.noop;
+      const zipStream = new stream.Readable();
+      zipStream._read = () => {};
       zipStream
         .pipe(unzipper.Parse())
         .on('entry', function (entry) {
@@ -73,6 +69,7 @@ describe('file movement', function () {
       zipStream.push(null);
     });
 
-    (await zipPromise).should.equal(2);
+    expect(await zipPromise).to.equal(2);
   });
 });
+

test/functional/commands/find/by-accessibility-id-e2e-specs.js

@@ -0,0 +1,30 @@
+import type {Browser} from 'webdriverio';
+import {APIDEMOS_CAPS} from '../../desired';
+import {initSession, deleteSession} from '../../helpers/session';
+import chai, {expect} from 'chai';
+import chaiAsPromised from 'chai-as-promised';
+
+chai.use(chaiAsPromised);
+
+describe('Find - accessibility ID', function () {
+  let driver: Browser;
+
+  before(async function () {
+    driver = await initSession(APIDEMOS_CAPS);
+  });
+  after(async function () {
+    await deleteSession();
+  });
+  it('should find an element by name', async function () {
+    await expect(driver.$('~Animation').elementId).to.eventually.exist;
+  });
+  it('should return an array of one element with findElements', async function () {
+    const els = await driver.$$('~Animation');
+    expect(els).to.be.an.instanceof(Array);
+    expect(els).to.have.length(1);
+  });
+  it('should find an element with a content-desc property containing an apostrophe', async function () {
+    await expect(driver.$("~Access'ibility").elementId).to.eventually.exist;
+  });
+});
+

test/functional/commands/find/by-accessibility-id-e2e-specs.ts

@@ -1,74 +1,72 @@
-import { APIDEMOS_CAPS } from '../../desired';
-import { initSession, deleteSession } from '../../helpers/session';
+import type {Browser} from 'webdriverio';
+import {APIDEMOS_CAPS} from '../../desired';
+import {initSession, deleteSession} from '../../helpers/session';
+import chai, {expect} from 'chai';
+import chaiAsPromised from 'chai-as-promised';
 
+chai.use(chaiAsPromised);
 
 describe('Find - CSS', function () {
-  let driver;
-  let chai;
+  let driver: Browser;
   before(async function () {
-    chai = await import('chai');
-    const chaiAsPromised = await import('chai-as-promised');
-
-    chai.should();
-    chai.use(chaiAsPromised.default);
-
     driver = await initSession(APIDEMOS_CAPS);
   });
   after(async function () {
     await deleteSession();
   });
   it('should find an element by id (android resource-id)', async function () {
-    await driver.$('#android\\:id\\/text1').elementId.should.eventually.exist;
-    await driver.$('*[id="android:id/text1"]').elementId.should.eventually.exist;
-    await driver.$('*[resource-id="android:id/text1"]').elementId.should.eventually.exist;
+    await expect(driver.$('#android\\:id\\/text1').elementId).to.eventually.exist;
+    await expect(driver.$('*[id="android:id/text1"]').elementId).to.eventually.exist;
+    await expect(driver.$('*[resource-id="android:id/text1"]').elementId).to.eventually.exist;
   });
   it('should find an element by content description', async function () {
-    await driver.$('*[description="Animation"]').elementId.should.eventually.exist;
+    await expect(driver.$('*[description="Animation"]').elementId).to.eventually.exist;
   });
   it('should return an array with findElements', async function () {
-    let els = await driver.$$('*[content-desc="Animation"]');
-    els.should.be.an.instanceof(Array);
-    els.should.have.length(1);
+    const els = await driver.$$('*[content-desc="Animation"]');
+    expect(els).to.be.an.instanceof(Array);
+    expect(els).to.have.length(1);
   });
   it('should find an element with a content-desc property containing an apostrophe', async function () {
-    await driver.$('*[content-description="Access\'ibility"]').elementId.should.eventually.exist;
+    await expect(driver.$('*[content-description="Access\'ibility"]').elementId).to.eventually.exist;
   });
   it('should find an element by class name', async function () {
-    let el = await driver.$('android.widget.TextView');
+    const el = await driver.$('android.widget.TextView');
     const text = await el.getText();
-    text.toLowerCase().should.equal('api demos');
+    expect(text.toLowerCase()).to.equal('api demos');
   });
   it('should find an element with a chain of attributes and pseudo-classes', async function () {
     // TODO: webdriver selects 'class name' strategy.
     // ref. https://github.com/webdriverio/webdriverio/blob/eba541a77dbc42173717e1c106a7c4d3ccb198f5/packages/webdriverio/src/utils/findStrategy.ts#L91-L96
     this.skip();
-    let el = await driver.$('android.widget.TextView[clickable=true]:nth-child(1)');
-    await el.getText().should.eventually.equal('Accessibility');
+    const el = await driver.$('android.widget.TextView[clickable=true]:nth-child(1)');
+    await expect(el.getText()).to.eventually.equal('Accessibility');
   });
   it('should find an element with recursive UiSelectors', async function () {
     const els = await driver.$$('*[focused=true] *[clickable=true]');
-    els.should.have.length(1);
+    expect(els).to.have.length(1);
   });
   it('should find an element by a non-fully qualified class name using CSS tag name', async function () {
     const els = await driver.$$('android.widget.TextView');
-    els.length.should.be.above(0);
+    expect(els.length).to.be.above(0);
   });
   it('should find elements using starts with attribute', async function () {
-    await driver.$('*[description^="Animation"]').elementId.should.eventually.exist;
+    await expect(driver.$('*[description^="Animation"]').elementId).to.eventually.exist;
   });
   it('should find elements using ends with attribute', async function () {
-    await driver.$('*[description$="Animation"]').elementId.should.eventually.exist;
+    await expect(driver.$('*[description$="Animation"]').elementId).to.eventually.exist;
   });
   it('should find elements using word match attribute', async function () {
-    await driver.$('*[description~="Animation"]').elementId.should.eventually.exist;
+    await expect(driver.$('*[description~="Animation"]').elementId).to.eventually.exist;
   });
   it('should find elements using wildcard attribute', async function () {
-    await driver.$('*[description*="Animation"]').elementId.should.eventually.exist;
+    await expect(driver.$('*[description*="Animation"]').elementId).to.eventually.exist;
   });
   it('should allow UiScrollable with unicode string', async function () {
     await driver.startActivity('io.appium.android.apis', '.text.Unicode');
-    let selector = '*[text="عربي"]:instance(0)';
-    let el = await driver.$(selector);
-    await el.getText().should.eventually.equal('عربي');
+    const selector = '*[text="عربي"]:instance(0)';
+    const el = await driver.$(selector);
+    await expect(el.getText()).to.eventually.equal('عربي');
   });
 });
+

…tional/commands/find/by-css-e2e-specs.js …tional/commands/find/by-css-e2e-specs.tstest/functional/commands/find/by-css-e2e-specs.js renamed to test/functional/commands/find/by-css-e2e-specs.ts test/functional/commands/find/by-css-e2e-specs.js renamed to test/functional/commands/find/by-css-e2e-specs.ts

@@ -0,0 +1,27 @@
+import type {Browser} from 'webdriverio';
+import {APIDEMOS_CAPS} from '../../desired';
+import {initSession, deleteSession} from '../../helpers/session';
+import chai, {expect} from 'chai';
+import chaiAsPromised from 'chai-as-promised';
+
+chai.use(chaiAsPromised);
+
+describe('Find - ID', function () {
+  let driver: Browser;
+
+  before(async function () {
+    driver = await initSession(APIDEMOS_CAPS);
+  });
+  after(async function () {
+    await deleteSession();
+  });
+  it('should find an element by id', async function () {
+    await expect(driver.$('id=android:id/text1').elementId).to.eventually.exist;
+  });
+  it('should return an array of one element with findElements', async function () {
+    const els = await driver.$$('id=android:id/text1');
+    expect(els).to.be.an.instanceof(Array);
+    expect(els).to.have.length.above(1);
+  });
+});
+