@appium/test-support 3.0.52 → 3.1.0

package/README.md

@@ -13,50 +13,6 @@ npm install @appium/test-support --save-dev
 
 ## Usage
 
-### stubEnv
-
-```js
-import { stubEnv } from '@appium/test-support';
-
-describe('myTest', () => {
-  stubEnv();
-  it('setting env variable', () => {
-    // Changes to process.env will stay local
-    process.env.ABC = 'abc';
-  });
-});
-```
-
-### stubLog
-
-```js
-import { stubLog } from '@appium/test-support';
-
-describe('myTest', () => {
-  let sandbox;
-  // configure sandbox here...
-
-  it('stubbing log', () => {
-    let logStub = stubLog(sandbox, log);
-    log.info('Hello World!');
-    log.warn(`The ${'sun'.yellow} is shining!`);
-    logStub.output.should.equals([
-      'info: Hello World!',
-      `warn: The ${'sun'.yellow} is shining!`
-    ].join('\n'));
-  });
-  it('stubbing log stripping colors', () => {
-    let logStub = stubLog(sandbox, log, {stripColors: true});
-    log.info('Hello World!');
-    log.warn(`The ${'sun'.yellow} is shining!`);
-    logStub.output.should.equals([
-      'info: Hello World!',
-      'warn: The sun is shining!'
-    ].join('\n'));
-  });
-});
-```
-
 ### withSandbox
 
 Use when mixing up `sinon` APIs (mocks, spies, stubs).
@@ -100,51 +56,6 @@ describe('withMocks', withMocks({api}, (mocks) => {
 }));
 ```
 
-### fakeTime
-
-```js
-import { fakeTime } from '@appium/test-support';
-
-function doSomething() {
-  return new B.Promise((resolve) => {
-    let ret = '';
-    function appendOneByOne () {
-      if(ret.length >= 10) {
-        return resolve(ret);
-      }
-      setTimeout(() => {
-        ret = ret + ret.length;
-        appendOneByOne();
-      }, 1000);
-    }
-    appendOneByOne();
-  });
-}
-
-describe('fakeTime', () => {
-  let sandbox;
-  // create sandbox ...
-
-  it('should fake time', async () => {
-    let timeLord = fakeTime(sandbox);
-    let p = doSomething();
-    timeLord.speedup(200, 60); // interval=200, times=60
-    (await p).should.equals('0123456789');
-  });
-});
-```
-
-## Travis Android Emu Setup
-
-On [Travis](https://travis-ci.org/), setting up an emulator takes a lot of boilerplate.
-While the configuration needs to be done on a case-by-case basis, the actual startup
-can be scripted. Toward that, there are two scripts:
-* `android-emu-travis-pre` - creates a device (configured with the environment variables
-  `ANDROID_EMU_NAME`, `ANDROID_EMU_TARGET`, and `ANDROID_EMU_ABI`) and starts it
-  in the background
-* `android-emu-travis-post` - waits for the device to be booted, and then goes
-  to its home screen
-
 ## License
 
 Apache-2.0

package/build/lib/index.d.ts

@@ -1,5 +1,3 @@
-export { stubEnv } from "./env-utils";
-export { stubLog } from "./log-utils";
 export { withMocks, verifyMocks } from "./mock-utils";
 export { withSandbox, verifySandbox } from "./sandbox-utils";
 //# sourceMappingURL=index.d.ts.map

package/build/lib/index.js

@@ -1,12 +1,8 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.verifySandbox = exports.withSandbox = exports.verifyMocks = exports.withMocks = exports.stubLog = exports.stubEnv = void 0;
+exports.verifySandbox = exports.withSandbox = exports.verifyMocks = exports.withMocks = void 0;
 // this just needs to be imported, for the functionality to be injected
 require("./unhandled-rejection");
-var env_utils_1 = require("./env-utils");
-Object.defineProperty(exports, "stubEnv", { enumerable: true, get: function () { return env_utils_1.stubEnv; } });
-var log_utils_1 = require("./log-utils");
-Object.defineProperty(exports, "stubLog", { enumerable: true, get: function () { return log_utils_1.stubLog; } });
 var mock_utils_1 = require("./mock-utils");
 Object.defineProperty(exports, "withMocks", { enumerable: true, get: function () { return mock_utils_1.withMocks; } });
 Object.defineProperty(exports, "verifyMocks", { enumerable: true, get: function () { return mock_utils_1.verifyMocks; } });

package/build/lib/index.js.map

@@ -1 +1 @@
-{"version":3,"file":"index.js","sourceRoot":"","sources":["../../lib/index.js"],"names":[],"mappings":";;;AAAA,uEAAuE;AACvE,iCAA+B;AAE/B,yCAAoC;AAA5B,oGAAA,OAAO,OAAA;AACf,yCAAoC;AAA5B,oGAAA,OAAO,OAAA;AACf,2CAAoD;AAA5C,uGAAA,SAAS,OAAA;AAAE,yGAAA,WAAW,OAAA;AAC9B,iDAA2D;AAAnD,4GAAA,WAAW,OAAA;AAAE,8GAAA,aAAa,OAAA"}
+{"version":3,"file":"index.js","sourceRoot":"","sources":["../../lib/index.js"],"names":[],"mappings":";;;AAAA,uEAAuE;AACvE,iCAA+B;AAE/B,2CAAoD;AAA5C,uGAAA,SAAS,OAAA;AAAE,yGAAA,WAAW,OAAA;AAC9B,iDAA2D;AAAnD,4GAAA,WAAW,OAAA;AAAE,8GAAA,aAAa,OAAA"}

package/lib/index.js

@@ -1,7 +1,5 @@
 // this just needs to be imported, for the functionality to be injected
 import './unhandled-rejection';
 
-export {stubEnv} from './env-utils';
-export {stubLog} from './log-utils';
 export {withMocks, verifyMocks} from './mock-utils';
 export {withSandbox, verifySandbox} from './sandbox-utils';

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@appium/test-support",
-  "version": "3.0.52",
+  "version": "3.1.0",
   "description": "A collection of test utilities used across Appium packages",
   "keywords": [
     "automation",
@@ -45,7 +45,7 @@
     "test:unit": "mocha \"./test/unit/**/*.spec.js\""
   },
   "dependencies": {
-    "@appium/support": "^5.1.7",
+    "@appium/support": "^6.0.0",
     "@colors/colors": "1.6.0",
     "bluebird": "3.7.2",
     "lodash": "4.17.21",
@@ -60,5 +60,5 @@
   "publishConfig": {
     "access": "public"
   },
-  "gitHead": "abc9ebb9e8011cc606a63f1caa126bc8c61fe2a5"
+  "gitHead": "1d16ac6b4521b1ac06b8650c6bb5c311d8d49ae3"
 }

package/build/lib/env-utils.d.ts

@@ -1,5 +0,0 @@
-/**
- * Creates Mocha "before each" and "after each" hooks to restore `process.env` after every test.
- */
-export function stubEnv(): void;
-//# sourceMappingURL=env-utils.d.ts.map

package/build/lib/env-utils.d.ts.map

@@ -1 +0,0 @@
-{"version":3,"file":"env-utils.d.ts","sourceRoot":"","sources":["../../lib/env-utils.js"],"names":[],"mappings":"AAAA;;GAEG;AACH,gCAUC"}

package/build/lib/env-utils.js

@@ -1,18 +0,0 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.stubEnv = stubEnv;
-/**
- * Creates Mocha "before each" and "after each" hooks to restore `process.env` after every test.
- */
-function stubEnv() {
-    /** @type {NodeJS.ProcessEnv} */
-    let envBackup;
-    beforeEach(function beforeEach() {
-        envBackup = process.env;
-        process.env = { ...process.env };
-    });
-    afterEach(function afterEach() {
-        process.env = envBackup;
-    });
-}
-//# sourceMappingURL=env-utils.js.map

package/build/lib/env-utils.js.map

@@ -1 +0,0 @@
-{"version":3,"file":"env-utils.js","sourceRoot":"","sources":["../../lib/env-utils.js"],"names":[],"mappings":";;AAeQ,0BAAO;AAff;;GAEG;AACH,SAAS,OAAO;IACd,gCAAgC;IAChC,IAAI,SAAS,CAAC;IACd,UAAU,CAAC,SAAS,UAAU;QAC5B,SAAS,GAAG,OAAO,CAAC,GAAG,CAAC;QACxB,OAAO,CAAC,GAAG,GAAG,EAAC,GAAG,OAAO,CAAC,GAAG,EAAC,CAAC;IACjC,CAAC,CAAC,CAAC;IACH,SAAS,CAAC,SAAS,SAAS;QAC1B,OAAO,CAAC,GAAG,GAAG,SAAS,CAAC;IAC1B,CAAC,CAAC,CAAC;AACL,CAAC"}

package/build/lib/log-utils.d.ts

@@ -1,34 +0,0 @@
-/**
- * Options for {@linkcode LogStub} constructor
- */
-export type LogStubOptions = {
-    /**
-     * - If `true`, strip ANSI colors from output
-     */
-    stripColors?: boolean | undefined;
-};
-/**
- * Instantiates a {@linkcode LogStub} object
- * @param {import('sinon').SinonSandbox} sandbox
- * @param {import('@appium/types').AppiumLogger} log
- * @param {LogStubOptions} [opts]
- * @returns {LogStub}
- */
-export function stubLog(sandbox: import("sinon").SinonSandbox, log: import("@appium/types").AppiumLogger, opts?: LogStubOptions): LogStub;
-declare class LogStub {
-    /**
-     *
-     * @param {LogStubOptions} [opts]
-     */
-    constructor(opts?: LogStubOptions);
-    output: string;
-    stripColors: boolean;
-    /**
-     *
-     * @param {string} level
-     * @param {any} message
-     */
-    log(level: string, message: any): void;
-}
-export {};
-//# sourceMappingURL=log-utils.d.ts.map

package/build/lib/log-utils.d.ts.map

@@ -1 +0,0 @@
-{"version":3,"file":"log-utils.d.ts","sourceRoot":"","sources":["../../lib/log-utils.js"],"names":[],"mappings":";;;;;;;;;AA2BA;;;;;;GAMG;AACH,iCALW,OAAO,OAAO,EAAE,YAAY,OAC5B,OAAO,eAAe,EAAE,YAAY,SACpC,cAAc,GACZ,OAAO,CAUnB;AAxCD;IACE;;;OAGG;IACH,mBAFW,cAAc,EAKxB;IAFC,eAAgB;IAChB,qBAA4C;IAE9C;;;;OAIG;IACH,WAHW,MAAM,WACN,GAAG,QAUb;CACF"}

package/build/lib/log-utils.js

@@ -1,50 +0,0 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.stubLog = stubLog;
-require("@colors/colors");
-class LogStub {
-    /**
-     *
-     * @param {LogStubOptions} [opts]
-     */
-    constructor(opts = {}) {
-        this.output = '';
-        this.stripColors = Boolean(opts.stripColors);
-    }
-    /**
-     *
-     * @param {string} level
-     * @param {any} message
-     */
-    log(level, message) {
-        if (this.stripColors) {
-            message = message.stripColors;
-        }
-        if (this.output.length > 0) {
-            this.output += '\n';
-        }
-        this.output = `${this.output}${level}: ${message}`;
-    }
-}
-/**
- * Instantiates a {@linkcode LogStub} object
- * @param {import('sinon').SinonSandbox} sandbox
- * @param {import('@appium/types').AppiumLogger} log
- * @param {LogStubOptions} [opts]
- * @returns {LogStub}
- */
-function stubLog(sandbox, log, opts = {}) {
-    let logStub = new LogStub(opts);
-    for (let l of log.levels) {
-        sandbox.stub(log, l).callsFake(function doLogging(mess) {
-            logStub.log(l, mess);
-        });
-    }
-    return logStub;
-}
-/**
- * Options for {@linkcode LogStub} constructor
- * @typedef LogStubOptions
- * @property {boolean} [stripColors] - If `true`, strip ANSI colors from output
- */
-//# sourceMappingURL=log-utils.js.map

package/build/lib/log-utils.js.map

@@ -1 +0,0 @@
-{"version":3,"file":"log-utils.js","sourceRoot":"","sources":["../../lib/log-utils.js"],"names":[],"mappings":";;AA4CQ,0BAAO;AA5Cf,0BAAwB;AAExB,MAAM,OAAO;IACX;;;OAGG;IACH,YAAY,IAAI,GAAG,EAAE;QACnB,IAAI,CAAC,MAAM,GAAG,EAAE,CAAC;QACjB,IAAI,CAAC,WAAW,GAAG,OAAO,CAAC,IAAI,CAAC,WAAW,CAAC,CAAC;IAC/C,CAAC;IACD;;;;OAIG;IACH,GAAG,CAAC,KAAK,EAAE,OAAO;QAChB,IAAI,IAAI,CAAC,WAAW,EAAE,CAAC;YACrB,OAAO,GAAG,OAAO,CAAC,WAAW,CAAC;QAChC,CAAC;QACD,IAAI,IAAI,CAAC,MAAM,CAAC,MAAM,GAAG,CAAC,EAAE,CAAC;YAC3B,IAAI,CAAC,MAAM,IAAI,IAAI,CAAC;QACtB,CAAC;QACD,IAAI,CAAC,MAAM,GAAG,GAAG,IAAI,CAAC,MAAM,GAAG,KAAK,KAAK,OAAO,EAAE,CAAC;IACrD,CAAC;CACF;AAED;;;;;;GAMG;AACH,SAAS,OAAO,CAAC,OAAO,EAAE,GAAG,EAAE,IAAI,GAAG,EAAE;IACtC,IAAI,OAAO,GAAG,IAAI,OAAO,CAAC,IAAI,CAAC,CAAC;IAChC,KAAK,IAAI,CAAC,IAAI,GAAG,CAAC,MAAM,EAAE,CAAC;QACzB,OAAO,CAAC,IAAI,CAAC,GAAG,EAAE,CAAC,CAAC,CAAC,SAAS,CAAC,SAAS,SAAS,CAAC,IAAI;YACpD,OAAO,CAAC,GAAG,CAAC,CAAC,EAAE,IAAI,CAAC,CAAC;QACvB,CAAC,CAAC,CAAC;IACL,CAAC;IACD,OAAO,OAAO,CAAC;AACjB,CAAC;AAID;;;;GAIG"}

package/lib/env-utils.js

@@ -1,16 +0,0 @@
-/**
- * Creates Mocha "before each" and "after each" hooks to restore `process.env` after every test.
- */
-function stubEnv() {
-  /** @type {NodeJS.ProcessEnv} */
-  let envBackup;
-  beforeEach(function beforeEach() {
-    envBackup = process.env;
-    process.env = {...process.env};
-  });
-  afterEach(function afterEach() {
-    process.env = envBackup;
-  });
-}
-
-export {stubEnv};

package/lib/log-utils.js

@@ -1,51 +0,0 @@
-import '@colors/colors';
-
-class LogStub {
-  /**
-   *
-   * @param {LogStubOptions} [opts]
-   */
-  constructor(opts = {}) {
-    this.output = '';
-    this.stripColors = Boolean(opts.stripColors);
-  }
-  /**
-   *
-   * @param {string} level
-   * @param {any} message
-   */
-  log(level, message) {
-    if (this.stripColors) {
-      message = message.stripColors;
-    }
-    if (this.output.length > 0) {
-      this.output += '\n';
-    }
-    this.output = `${this.output}${level}: ${message}`;
-  }
-}
-
-/**
- * Instantiates a {@linkcode LogStub} object
- * @param {import('sinon').SinonSandbox} sandbox
- * @param {import('@appium/types').AppiumLogger} log
- * @param {LogStubOptions} [opts]
- * @returns {LogStub}
- */
-function stubLog(sandbox, log, opts = {}) {
-  let logStub = new LogStub(opts);
-  for (let l of log.levels) {
-    sandbox.stub(log, l).callsFake(function doLogging(mess) {
-      logStub.log(l, mess);
-    });
-  }
-  return logStub;
-}
-
-export {stubLog};
-
-/**
- * Options for {@linkcode LogStub} constructor
- * @typedef LogStubOptions
- * @property {boolean} [stripColors] - If `true`, strip ANSI colors from output
- */