Arduinoデバイスまたはエミュレーターでユニットテストを実行しない
マイクロコントローラーのデバイス/エミュレーター/ Simベースのテストに対する訴訟
単体テストが何を意味するかについては多くの議論があり、私は実際にそれについてここで議論するつもりはありません。この投稿は、最終的なターゲットハードウェアでの実際的なテストをすべて
回避するように指示するものではありません。最も平凡で頻繁なテストからターゲットハードウェアを排除することにより、開発フィードバックサイクルの最適化について説明します。テスト対象のユニットは、プロジェクト全体よりもはるかに小さいと想定されています。
単体テストの目的は、独自のコードの品質をテストすることです。単体テストでは、通常、制御できない要因の機能をテストするべきではありません。
このように考えてください。たとえArduinoライブラリ、マイクロコントローラーハードウェア、またはエミュレーターの機能をテストしたとしても、そのようなテスト結果から自分の作業の品質について何かを伝えることは絶対に不可能です。したがって、ターゲットデバイス（またはエミュレータ）で実行されない単体テストを記述する方がはるかに価値が高く効率的です。
ターゲットハードウェアで頻繁にテストを行うと、サイクルが非常に遅くなります。
- コードを微調整する
- コンパイルしてArduinoデバイスにアップロード
- 動作を観察し、コードが期待どおりに動作しているかどうかを推測します
- 繰り返す
ステップ3は、シリアルポートを介して診断メッセージを取得することを期待しているが、プロジェクト自体がArduinoの唯一のハードウェアシリアルポートを使用する必要がある場合に特に厄介です。SoftwareSerialライブラリが役立つと考えている場合は、そうすることで、同時に他の信号を生成するなど、正確なタイミングを必要とする機能が混乱する可能性があることを知っておく必要があります。この問題は私に起こりました。
繰り返しになりますが、エミュレータを使用してスケッチをテストし、実際のArduinoにアップロードするまでタイムクリティカルなルーチンが完全に実行された場合、学ぶべき唯一の教訓は、エミュレータに欠陥があることです。あなた自身の仕事の質について何も明らかにしません。
デバイスまたはエミュレータでテストするのが愚かな場合、どうすればよいですか？
コンピューターを使用してArduinoプロジェクトで作業している可能性があります。そのコンピューターはマイクロコントローラーよりも桁違いに速い。コンピュータでビルドして実行するテストを記述します。
Arduinoライブラリとマイクロコントローラーの動作は正しいか、少なくとも一貫して正しくないと想定されていることを忘れないでください。
テストが期待に反する出力を生成する場合、テストされたコードに欠陥がある可能性があります。テスト出力が期待どおりであるが、Arduinoにアップロードしたときにプログラムが正しく動作しない場合、テストが誤った仮定に基づいており、テストに欠陥がある可能性があることがわかります。どちらの場合も、次のコード変更がどうあるべきかについての真の洞察が与えられます。フィードバックの質が「何かが壊れている」から「この特定のコードが壊れている」に改善されます。
PCでテストをビルドして実行する方法
最初に行う必要があるのは、テストの目標を特定することです。独自のコードのどの部分をテストしたいかを考え、テストのために個別の部分を分離できるような方法でプログラムを構築してください。
テストするパーツがArduino関数を呼び出す場合は、テストプログラムでモックアップの代替品を提供する必要があります。これは見かけよりはるかに少ない作業です。モックアップは実際に何もする必要はありませんが、予測可能な入力と出力をテストに提供します。
テストする独自のコードは、.pdeスケッチ以外のソースファイルに存在する必要があります。心配する必要はありません。スケッチの外部にあるソースコードを使用しても、スケッチはコンパイルされます。あなたが本当にそれに取り掛かったとき、あなたのプログラムの通常のエントリーポイントより少しだけがスケッチファイルで定義されるべきです。
あとは、実際のテストを記述し、お気に入りのC ++コンパイラを使用してコンパイルするだけです。これはおそらく実際の例で最もよく説明されています。
実際の作業例
ここで見つかった私のペットプロジェクトの1つには、PCで実行する簡単なテストがいくつかあります。この回答の提出では、Arduinoライブラリ関数のいくつかをモックアップする方法と、それらのモックアップをテストするために書いたテストについて簡単に説明します。これは、モックアップを作成したのは私だったので、他の人のコードをテストしないことについて前に言ったことに反しません。私のモックアップが正しいことを非常に確実にしたかったのです。
Arduinoライブラリによって提供されるいくつかのサポート機能を複製するコードを含むmock_arduino.cppのソース：
#include <sys/timeb.h>
#include "mock_arduino.h"
timeb t_start;
unsigned long millis() {
timeb t_now;
ftime(&t_now);
return (t_now.time - t_start.time) * 1000 + (t_now.millitm - t_start.millitm);
}
void delay( unsigned long ms ) {
unsigned long start = millis();
while(millis() - start < ms){}
}
void initialize_mock_arduino() {
ftime(&t_start);
}
次のモックアップを使用して、コードがバイナリデータをハードウェアシリアルデバイスに書き込むときに、読み取り可能な出力を生成します。
fake_serial.h
#include <iostream>
class FakeSerial {
public:
void begin(unsigned long);
void end();
size_t write(const unsigned char*, size_t);
};
extern FakeSerial Serial;
fake_serial.cpp
#include <cstring>
#include <iostream>
#include <iomanip>
#include "fake_serial.h"
void FakeSerial::begin(unsigned long speed) {
return;
}
void FakeSerial::end() {
return;
}
size_t FakeSerial::write( const unsigned char buf[], size_t size ) {
using namespace std;
ios_base::fmtflags oldFlags = cout.flags();
streamsize oldPrec = cout.precision();
char oldFill = cout.fill();
cout << "Serial::write: ";
cout << internal << setfill('0');
for( unsigned int i = 0; i < size; i++ ){
cout << setw(2) << hex << (unsigned int)buf[i] << " ";
}
cout << endl;
cout.flags(oldFlags);
cout.precision(oldPrec);
cout.fill(oldFill);
return size;
}
FakeSerial Serial;
そして最後に、実際のテストプログラム：
#include "mock_arduino.h"
using namespace std;
void millis_test() {
unsigned long start = millis();
cout << "millis() test start: " << start << endl;
while( millis() - start < 10000 ) {
cout << millis() << endl;
sleep(1);
}
unsigned long end = millis();
cout << "End of test - duration: " << end - start << "ms" << endl;
}
void delay_test() {
unsigned long start = millis();
cout << "delay() test start: " << start << endl;
while( millis() - start < 10000 ) {
cout << millis() << endl;
delay(250);
}
unsigned long end = millis();
cout << "End of test - duration: " << end - start << "ms" << endl;
}
void run_tests() {
millis_test();
delay_test();
}
int main(int argc, char **argv){
initialize_mock_arduino();
run_tests();
}
この投稿は十分に長いので、GitHubにある私のプロジェクトを参照して、実際のテストケースをいくつか確認してください。進行中の作業をmaster以外のブランチに置いているので、それらのブランチで追加のテストを確認します。
独自の軽量テストルーチンを作成することを選択しましたが、CppUnitなどのより堅牢な単体テストフレームワークも使用できます。