【GAS】Google Apps Scriptで作った自作関数に対してテストコードを書けるライブラリ「TestGAS」を作りました！

はじまり#

135ml

一旦、あのツールが完成したから、今回はその紹介記事にするぜ・・・

リサちゃん

お、とうとうあのツールが完成したか・・・

135ml

そうです。あの「TestGAS」を紹介させていただきまぁぁぁす！

そもそも、なぜ作ったか？#

テストコードを書いていれば、作った関数とかが何を返してくれる処理なのかが一発で分かって便利だし、関数の性能の担保にもなります。

しかし、Google Apps Scriptには、そのテストコードを走らせるようなテストツールがありません・・・。 Pythonで言うpytestとか、Node.jsで言うJestみたいなツールがないってことです。何か不便です。

PythonやNode.jsと同様に、Google Apps Scriptで書いたコードも何をしたらその関数が動くかをいちいち覚えてられないので、テストコードを記述したいのだが、それ用のツールが無くて書けないのが課題でした・・・。

そして、実際に作ったのが「TestGAS」#

そこで、Google Apps Scriptにテストコードを記述してその動作確認を行うためのツールを作りました。それが「TestGAS」というツールです。 このロゴが目印です。

例えば、こんなテストコードを打つとします。

1
// content of test_sample.gs
2
let tester = TestGAS.createExecutor();
3

4
function sample(x){
5
  return x + 1;
6
}
7

8
class Test_sample{
9
  test_sample_1(){
10
    tester.assertEquals(sample(2), 4);
11
  }
12
  test_sample_2(){
13
    tester.assertNotEquals(sample(2), 4);
14
  }
15
}
16

17
function execute_Test_sample(){
18
  let failureFuncs = tester.executeTestGas(Test_sample);
19
}

そして、execute_Test_sampleを実行すると、こんな結果が返ってきます。

1
[ 'test_sample_1', 'test_sample_2' ]
2
TestGAS starts: "Test_sample"
3
...... TestGAS terminated: "Test_sample".
4
====================================================== FAILURES ======================================================
5
______________________________________________ test_sample_1 ______________________________________________
6
AssertionError: Actual value is not equal to Expected value.
7
  actual : 3
8
  expected: 4
9
=================== 1 failed, 1 passed of all 2 tests in 0.01 seconds ===================

pytestライクに返ってきます。

Assertion以外で、普通にコードがミスってたら、Google Apps Script既存のエラーチェックに引っ掛かるので、そこのチェックも大丈夫です。

開発で苦労したこと#

初めてテストツールなるものを作ったから、色々と大変な部分があったが、その中でもかなり印象に残っているのは、thisのバインドとファクトリメソッドのところかな。 その2点は、それぞれ記事にしているので、みなさんもGASとかJavaScriptで何か作る時に参考にしてもらえればと思います。 ファクトリメソッドにしないと、外部のGASエディタから呼び出せないんですよね・・・。

thisのバインドに関する記事:

エンドルフィン風呂に浸かる。

【JavaScript】実行中の関数自身の関数名やクラス自身のメソッド名を取得する

実行している関数やメソッド自身の名前を取得する方法を紹介します。この方法は、その関数名を取得する関数を別の関数から呼び出してもらわなければなりません。thisに関数をバインドする必要があるためです。その呼び出し方の種類を掲載しています。

www.endorphinbath.com

ファクトリメソッドに関する記事:

エンドルフィン風呂に浸かる。

【GAS】クラスを作って外部ライブラリとして呼び出したい場合は、ファクトリメソッドを作ろう

Google Apps Scriptで、ライブラリ化したクラスメソッドを外部のライブラリから呼べなくなってしまっている場合に、「ファクトリメソッド」を使って解決するかもしれません。本記事の方法をお試し下さい。

www.endorphinbath.com

その他の作成物#

今回、ライブラリのリファレンスとか初めて書きました・・・。 そのために使ったのがGitHub Pagesで、Public Repositoryにすれば無料で利用できて、テーマとかもいじれるから、とても便利。 実際に作ったリファレンスのページがこちらになります。

TestGAS Reference

Reference

Top page of reference about TestGAS

landmaster135.github.io

リポジトリはここです。

クラスとか関数の設計図はこんな感じになってます。

課題#

今回、最低限の機能は実装できたと思いますが、実はもう少し欲しい機能があります・・・。どうすればいいのか・・・。

• 関数をモックする機能
• 網羅率（カバレッジ）を表示する機能

おしまい#

135ml

なんとか、公開できるレベルまで持ってこれて何よりです！ 個人的には、とりあえずこれで自作した関数の仕様がテストコードとして書けるようになったから、かなり満足。

リサちゃん

コードの動きをいちいち確認する作業が省けるねえ！

135ml

みなさんも使ってみたい場合は、このスクリプトIDを使って利用できると思うので、使ってみて下さい。

1
1CRjWWWYfjD7WzPl43RB1BiD7XDLJmR03eEpXr2LMh75yAq5qMlczOIfm

以上になります！