feat: export the adb utilities to be used in third party nodejs scripts

src/main.js

@@ -3,8 +3,14 @@ import {main} from './program';
 import cmd from './cmd';
 import * as logger from './util/logger';
 
-// This only exposes util/logger so far.
+// This only exposes util/logger and a couple of functions from util/adb so far.
 // Do we need anything else?
-const util = {logger};
+const util = {
+  logger,
+  get adb(): Object {
+    const {listADBDevices, listADBFirefoxAPKs} = require('./util/adb.js');
+    return {listADBDevices, listADBFirefoxAPKs};
+  },
+};
 
 export default {main, cmd, util};

src/util/adb.js

@@ -418,3 +418,16 @@ export default class ADBUtils {
     });
   }
 }
+
+export async function listADBDevices(adbBin?: string): Promise<Array<string>> {
+  const adbClient = new ADBUtils({adbBin});
+  return adbClient.discoverDevices();
+}
+
+export async function listADBFirefoxAPKs(
+  deviceId: string,
+  adbBin?: string
+): Promise<Array<string>> {
+  const adbClient = new ADBUtils({adbBin});
+  return adbClient.discoverInstalledFirefoxAPKs(deviceId);
+}

tests/fixtures/webext-as-library/helpers.js

@@ -0,0 +1,15 @@
+const assert = require('assert');
+
+function testWebExtModuleImports(webExt) {
+  assert.deepEqual(Object.keys(webExt).sort(), ['cmd', 'main', 'util'].sort());
+  assert.deepEqual(Object.keys(webExt.util).sort(), ['logger', 'adb'].sort());
+  assert.deepEqual(
+    Object.keys(webExt.util.adb).sort(),
+    ['listADBDevices', 'listADBFirefoxAPKs'].sort(),
+  );
+  assert.equal(typeof webExt.cmd.run, 'function');
+}
+
+module.exports = {
+  testWebExtModuleImports,
+};

tests/fixtures/webext-as-library/test-import.mjs

@@ -0,0 +1,7 @@
+// eslint-disable-next-line import/no-unresolved
+import webExt from 'web-ext';
+
+// eslint-disable-next-line import/extensions
+import _ from './helpers.js';
+
+_.testWebExtModuleImports(webExt);

tests/fixtures/webext-as-library/test-require.js

@@ -0,0 +1,5 @@
+const webExt = require('web-ext');
+
+const _ = require('./helpers.js');
+
+_.testWebExtModuleImports(webExt);

tests/functional/common.js

@@ -21,9 +21,9 @@ export const fixturesDir: string =
 export const minimalAddonPath: string =
   path.join(fixturesDir, 'minimal-web-ext');
 export const fixtureEsmImport: string =
-  path.join(fixturesDir, 'import-as-esm');
+  path.join(fixturesDir, 'webext-as-library');
 export const fixtureCjsRequire: string =
-  path.join(fixturesDir, 'require-as-cjs');
+  path.join(fixturesDir, 'webext-as-library');
 export const fakeFirefoxPath: string = path.join(
   functionalTestsDir,
   process.platform === 'win32' ?

tests/unit/test.web-ext.js

@@ -6,6 +6,7 @@ import sinon from 'sinon';
 import webExt from '../../src/main';
 import {main} from '../../src/program';
 import {consoleStream} from '../../src/util/logger';
+import {listADBDevices, listADBFirefoxAPKs} from '../../src/util/adb';
 
 
 describe('webExt', () => {
@@ -17,6 +18,14 @@ describe('webExt', () => {
     assert.equal(webExt.util.logger.consoleStream, consoleStream);
   });
 
+  it('gives access to listADBDevices', () => {
+    assert.equal(webExt.util.adb.listADBDevices, listADBDevices);
+  });
+
+  it('gives access to listADBFirefoxAPKs', () => {
+    assert.equal(webExt.util.adb.listADBFirefoxAPKs, listADBFirefoxAPKs);
+  });
+
   describe('exposes commands', () => {
     let stub: any;
     afterEach(() => {