これは何
Modbus TCP/RTU機器のレジスタマップ(CSV)から、QAで手作業で洗い出している「正常系・境界値・異常系」のテストケースを自動生成する、個人開発のCLIツールです。実施結果を記入するExcelテンプレートの出力や、結果集計レポート(テキスト/HTML)の生成まで一気通貫でやります。
まだベータ版です。実機での動作検証は行っていません。 「こういうツールないと思って作ってみた」というレベルのものなので、動作の正しさを保証するものではない前提で見ていただけると助かります。不具合報告や「こここうした方がいいのでは」というコメントは大歓迎です。
作った理由
Modbus機器のQAをやったことがある人ならわかると思うのですが、レジスタマップ(アドレス・型・アクセス権・有効範囲の一覧)から、
- 正常に読み書きできるか
- 境界値(上限・下限ちょうど、その外側)を弾けるか
- 読み取り専用レジスタへの書き込みを拒否できるか
- 存在しないアドレス/ファンクションコードへのアクセスを拒否できるか
といったテストケースを手作業で洗い出すのは地味に時間がかかります。レジスタが数十〜数百あると尚更です。ここを自動化できないかと思って作りました。
特徴: ネットワーク通信を一切しない
このツールの一番のこだわりはここです。完全にローカルで完結し、外部と一切通信しません。
FA(工場自動化)業界はOT/ITネットワークが分離されている現場が多く、レジスタマップという機器仕様情報を社外(クラウド)に送れないケースがあります。なのでWeb版やSaaS版ではなく、あえてローカルで動くCLIツールにしています。
使い方
Python版とWindows向けexe版があります。
exe版(Windows・Python不要)
Releases から modbus_qa.exe をダウンロードするだけで使えます。
Python版
git clone https://github.com/miya-taro/mdbs-tester.git
cd mdbs-tester
pip install -r requirements.txt
レジスタマップCSVを用意します。
register_name,register_type,address,data_type,access,min_value,max_value
運転指令,Coil,0,bool,,,,
目標回転数,HoldingRegister,0,uint16,RW,0,3000
テストケースを生成します。
python3 modbus_qa.py generate register_map.csv -o out
test_cases.xlsx が生成されるので、これを開いて実機でのテスト結果(実施日・実施者・実測値・OK/NG)を記入します。記入が終わったらレポートを生成します。
python3 modbus_qa.py report out/test_cases.xlsx -o out
OK/NG/未実施の集計と、NG一覧・未実施一覧をまとめたテキストレポートとHTMLレポートが出力されます。
生成されるテストケースの例
1レジスタあたり、だいたい以下のようなカテゴリでテストケースを作ります。
- 正常系(読み取り)
- 正常系(書き込み・書き込み可能な場合)
- 境界値(下限/上限ちょうど、下限-1/上限+1)
- 異常系(読み取り専用レジスタへの書き込み)
- 異常系(未定義アドレスへのアクセス)
- 異常系(未対応ファンクションコードへのアクセス)
詳しいルールは仕様書にまとめています。
今後やりたいこと・現状の制約
- 実機での動作検証(まだやれていません)
- 型不一致・スケール異常系のテストケース追加
- 複数レジスタの一括アクセステスト
このあたりは実際に使ってもらったフィードバック次第で優先度を決めたいと思っています。
おわりに
ニッチな領域のツールなので需要があるかは正直わかりませんが、同じような手作業に困っている人がいたら使ってみてもらえると嬉しいです。感想・要望・不具合報告、なんでもコメントいただけると助かります。