README.md

kintuba

kintuba is stub for a unittest, it can use the kintone global object.

Description

kintuba はnode.js上で動作する kintone オブジェクトのスタブモジュールです。kintone カスタマイズの JavaScript をローカル開発環境でテストする際に使用できます。

---

通常 kintone カスタマイズの JavaScript をテストしようとすると、kintone オブジェクトにアクセスできない為以下のエラーが発生します。

ReferenceError: kintone is not defined

kintuba を使用すると、kintone オブジェクトのような振る舞いをしたり、予め用意したテストデータを kintone のデータのように扱ったりすることができます。

また、karma でブラウザを使用したテストをする場合は、karma プラグインを併せて利用して下さい。

https://github.com/t-kojima/karma-kintuba

Warning

kintuba はrequireされるとグローバルのkintoneオブジェクトを上書きします。（これは kintone にアップロードする JavaScript ファイルをそのままテストできるようにする為です。）

その為ローカルでのテストでのみの使用とし、本番環境では使用しないで下さい。

Installation

npm install --save-dev kintuba

or

yarn add --dev kintuba

Usage

テストコードでrequireして下さい。以後テストコード及びテスト対象コードでkintoneオブジェクトが利用できます。

require('kintuba');

イベントの実行

kintone では画面の移動等でイベントが実行されますが、ローカル環境ではそのような動作ができませんので kintuba ではイベントを実行する関数を用意しています。

kintone.events.onでイベントを登録するのに対し、kintone.events.doでイベントを実行します。

kintone.events.on('app.record.index.show', event => {
  console.log('event done');
});
kintone.events.do('app.record.index.show');

// => event done

また、レコード詳細画面を開いた場合など、特定の状況を表現する場合はoptionを指定します。

kintone.events.on('app.record.detail.show', event => {
  console.log(event.record.$id.value);
});
kintone.events.do('app.record.detail.show', { recordId: '2' });

// => 2

尚、kintone.events.doは非同期で動作する点に注意して下さい。

テストデータの利用

kintuba をrequireしただけではデータが存在しない為、event.records などにアクセスしても空配列が返ります。テストデータを返すようにするには、テストデータを用意し以下の手順で都度読み込んでください。また、テストデータの作成はここを参考に行ってください。

schema

schema.load() を実行すると、.kintuba/schema ディレクトリにある以下のファイルを読み込みます。

• app.json
• fields.json
• form.json
• views.json

使用例）

const schema = require('kintuba/schema');

describe('example', () => {
  before(() => schema.load());
});

既定のディレクトリ（.kintuba/schema）以外にあるファイルを読みたい場合は引数で指定することができます。

schema.load('other/dir');
// other/dir/app.json 等がロードされる

fixture

fixture.load()を実行すると、.kintuba/fixtureディレクトリにある以下のファイルを読み込みます。

• login.json
• records.json

使用例）

const fixture = require('kintuba/fixture');

describe('example', () => {
  before(() => fixture.load());
});

また、既定のディレクトリ以外を読む場合は引数で指定します。

fixture.load('other/dir');
// other/dir/login.json等がロードされる

Licence

MIT License.