開発治具のススメ

こんにちは。宮下です。
せっかく、WordPressでホームページを作っているので、仕事の話や技術ネタなどの記事も投稿していこうと思います。

今回は、開発治具について少し書きたいと思います。

治具とは？

周囲の人で分かる人があまりいなかったのですが、治具って皆さんはわかりますか？
治具とは、英語の”jig”に由来する当て字で、工具の位置合わせなどで使う道具を指します。
要するに、作業をするための補助道具って感じです。
また、パソコンの組立や分解などでも作業者が使用する道具を指すこともありますよね？
で、その道具ってのは多くは自分用にチューンしたり、自作したりすることが多いです。

なので、私が今回使いたい治具の意味は後者の自分で自分の作業用に作るツールのことになります。

開発における治具とは？

例えばですが、ソフトウェア開発において単体テストは皆さん行っていますでしょうか？
モジュールテストやユニットテストとも言いますが、作った関数のテストのことです。

C#やPHPなどだと、Unitテストの自動実行ツールが用意されているため、テストコードを書いて、自動実行すればOK/NGがすぐに出てくるというものです。

このUnitテストツール群が作業道具だとすると、これをさらに楽にするための治具は何になるでしょうか？

今回の私の答えは、Unitテストのスケルトン自動生成になります。

Unitテストの自動実行ツールはあっても実際にはコードを書き起こさなければなりません。
そのためにはテスト仕様をまとめたテスト仕様書を書かなければなりません。

で、テスト仕様書からコードを書き起こすのって意外と大変なんですよね。
単体テストで網羅する場合ってかなり数を書くことになりますから。
逆に単体テストで全体をカバーできれば結合テストや総合テストでの項目を削減することができます。

そこで私は、

• スプレッドシートに決まったフォーマットでテスト仕様書を作成する
• GAS（Google API Script）を使用してテスト仕様書からコメントとテスト関数スケルトンを生成するScriptを用意する

で、Unitテストのスケルトンコード自動生成の治具を作ってみました。

前々から実現したかったんですが、VBAは慣れていなかったので、作るのを躊躇していたんですよね。
今回関わっているプロジェクトは、たまたまスプレッドシートを使ってテスト仕様書を管理していたため、慣れていたjavascriptで治具を作ることができました！

導入した結果

作るのに1時間ほどかかりましたが、今では全プロジェクトメンバーに使ってもらい、テスト関数のコメントと関数定義を書く手間を削減することができました。

これにより、毎作業で0.5〜1時間位はコストを削減できたんじゃないかなと思います。
使ってみた方々からはすごく便利と好評です！

プロジェクトの契約の関係で、作った治具のソースコードは公開できませんが、これを読んでいるSE/PGの皆さんも自分用の開発治具を作ってみてください。

興味のある方がいらっしゃれば、コメントをお願いします。
公開できる範囲で作り方をお教えします。

あと、こんな作業の開発治具作れない？ってネタも大募集です！