SpectronからElectronアプリケーションのMenuを操作する

この記事は Electron Advent Calendar 2016 の12日目の記事です。

SpectronはElectronアプリケーションのためのE2Eテストツールです。

electron.atom.io

SpectronはElectronのChrome Driverを通じてアプリケーションの操作を実行できるのですが、メニューの操作には現状対応していません。(詳しくは後述します。)

そこでspectron-fake-menuというSpectronからメニューの操作ができるnpmを作成しました。

github.com

使い方

https://github.com/joe-re/spectron-fake-menu/tree/master/example にサンプルアプリケーションがあります。

ちょっと変なアプリですが、メニューからカウントのインクリメント、デクリメントをするカウンターです。

f:id:joe-re:20161212070307p:plain

テストコードでは、インクリメントとデクリメントをspectron-fake-menuを使って操作し、成功していることを検証しています。

以下のように、SpectronのApplicationクラスのインスタンスをapplyメソッドに渡すことで、spectron-fake-menuのセットアップは完了します。

const Application = require('spectron').Application;
const fakeMenu = require('spectron-fake-menu');
const app = new Application({ path: electron, args: [ path.join(__dirname, '.') ] });

fakeMenu.apply(app); // apply fake menu

その後は、fakeMenu.clickMenuメソッドでMenuのクリックイベントを発火させることができます。clickMenuメソッドの引数にはラベルの文字列を渡します。

const fakeMenu = require('spectron-fake-menu');
fakeMenu.clickMenu('Count', 'Increment'); // trigger 'Count -> Increment'
fakeMenu.clickMenu('Count', 'Decrement'); // trigger 'Count -> Decrement'

そもそもなぜSpectronからMenuの操作ができないのか

以下のIssueがあります。

Testing menu interaction · Issue #21 · electron/spectron · GitHub

require('electron').remote.Menu.getApplicationMenu() API does not serialize to JSON so it can't currently be fetched via Spectron.

MenuのAPIがJSONにserializeされていないので、process間通信が必要なSpectronでは操作が難しいというのがその理由のようです。同じ様に、dialogモジュールの操作も出来ません。

Can't interact with dialog · Issue #23 · electron/spectron · GitHub

アプリケーションの操作をChrome Driverを通じて行うのが基本理念のSpectronでは、これらのnativeなAPIを必要とする操作に対するサポートはまだ不十分、というのが実情です。

spectron-fake-menuではどうしているのか

Mocking electron modules · Issue #94 · electron/spectron · GitHub

のIssueで紹介されている方法なのですが、Electronは--requireオプションで、Electronの起動直前にスクリプトを差し込むことができます。

これを利用して、Mainプロセスにspectron-fake-menu用のイベントを受け取る口を仕込んでいます。

require('electron').ipcMain.on('SPECTRON_FAKE_MENU/SEND', (_e, labels) => {
  const item = findItem(require('electron').Menu.getApplicationMenu().items, labels);
  item.click();
});

あとは簡単で、clickMenuメソッドでそのイベントを中継してMainプロセスに通知すれば良いだけです。

function clickMenu(...labels) {
  _app.electron.ipcRenderer.send('SPECTRON_FAKE_MENU/SEND', labels);
}

実際、この一連の処理のコードは30行程度しかありません。

つらいところ: メニューの操作は非同期処理になる

Exampleのテストコードは以下のようになっています。

function waitForChangeCount(app, count) {
  return new Promise((resolve, _reject) => {
    // Since the click event is asynchronous processing in the native layer, wait for the count chang on DOM.
    // If the expected change does not occur, the test will fail with a timeout.
    const timer = setInterval(() => {
      app.client.getText('#count').then((text) => {
        if (text === count) {
          clearInterval(timer);
          resolve();
        }
      });
    }, 1000);
  });
}

desctibe('decrement', function() {
  // ...省略
  it('decrement count', () => {
    return app.client.waitForExist('#count')
      .then(() => {
        fakeMenu.clickMenu('Count', 'Decrement');
        return waitForChangeCount(app, '-1');
      })
      .then(() => assert.ok(true));
  });

waitForChangeCountメソッドの処理にとてもつらい感が現れています。 clickMenuメソッドでメニューのクリックを発火してから画面上にその変化が現れるまでが非同期なので、タイマーをセットしてDOMの変化を監視しています。

nativeなレイヤーでのclickイベントのやり取りがそもそも非同期なので、外部から処理を差し挟んで同期APIにするのが非常に難しいです。(どなたかアイディアあれば教えてください。)

dialogモジュールのテスト時のモックも同じ理屈でできる

File -> Saveをクリックしたらdialogを表示する、みたいな操作は結構あると思います。用意されているAPIのみでテストを書くとすると、現状ではSpectronでこのケースのE2Eテストを書くのは難しいです。

しかし同じ理屈で、preloadスクリプト内でモックオブジェクトをセットしてしまえば、dialogモジュールの処理のモックも可能です。

例えば、以下の処理はdialogモジュールのshowSaveDialogメソッドを置き換えています。

const nativeRequire = require;
require = function(moduleName) {
  if (moduleName === 'electron') {
    const electron = nativeRequire('electron');
    electron.dialog.showSaveDialog = mockShowSaveDialog;
    return electron;
  }
  return nativeRequire(moduleName);
};

当然ですが、やればやるだけE2Eとは何だったのか...みたいなことになってどんどん信頼性が落ちていくので、用法用量は守りましょう。

まとめると

Rendererプロセスからの操作の方がテストは格段に楽です。

でもどうしてもMenuからの操作をテストしたい...という方は是非使ってみてください。