如何对 Arduino 代码进行单元测试？

Question

我希望能够对我的 Arduino 代码进行单元测试。理想情况下，我能够运行任何测试，而无需将代码上传到 Arduino。有哪些工具或库可以帮助我解决这个问题？

有一个 Arduino 模拟器正在开发，它可能很有用，但似乎还没有即可使用。

Atmel 的 AVR Studio 包含一个可能有用的芯片模拟器，但我不知道如何将它与 Arduino IDE 结合使用。

Answer 1

simavr 是一个使用 avr-gcc 的 AVR 模拟器。

它已经支持一些 ATTiny 和 ATMega 微控制器，而且据作者称，添加更多微控制器很容易。

示例中包含 simduino，一个 Arduino 模拟器。它支持运行 Arduino 引导加载程序，并且可以通过 Socat （修改后的 < a href="https://en.wikipedia.org/wiki/Netcat" rel="nofollow noreferrer">Netcat）。

Answer 2

您可以使用我的项目 PySimAVR 在 Python 中进行单元测试。 Arscons 用于构建，simavr 用于模拟。

示例：

from pysimavr.sim import ArduinoSim    
def test_atmega88():
    mcu = 'atmega88'
    snippet = 'Serial.print("hello");'

    output = ArduinoSim(snippet=snippet, mcu=mcu, timespan=0.01).get_serial()
    assert output == 'hello'

开始测试：

$ nosetests pysimavr/examples/test_example.py
pysimavr.examples.test_example.test_atmega88 ... ok

Answer 3

为此，我构建了 arduino_ci 。尽管它仅限于测试 Arduino 库（而不是独立的草图），但它允许在本地或 CI 系统（如 Travis CI 或 Appveyor）上运行单元测试。

考虑 Arduino 库目录中的一个非常简单的库，名为 DoSomething，带有 do-something.cpp：

#include <Arduino.h>
#include "do-something.h"

int doSomething(void) {
  return 4;
};

您可以按如下方式对其进行单元测试（使用名为 < code>test/is_four.cpp 或类似的）：

#include <ArduinoUnitTests.h>
#include "../do-something.h"

unittest(library_does_something)
{
  assertEqual(4, doSomething());
}

unittest_main()  // this is a macro for main().  just go with it.

仅此而已。如果 assertEqual 语法和测试结构看起来很熟悉，那是因为我采用了一些 Matthew Murdoch 的 ArduinoUnit图书馆
他在他的回答中提到了这一点。

有关单元测试的更多信息，请参阅 Reference.md O 引脚、时钟、串行端口等。

这些单元测试使用 ruby​​ gem 中包含的脚本进行编译和运行。有关如何设置的示例，请参阅 README.md 或仅复制以下示例之一：

• 一个实际示例，测试队列实现
• 对另一个队列项目进行的另一组测试
• 一个复杂的示例，模拟一个通过 SoftwareSerial 连接控制交互式设备的库，作为 Adafruit FONA 库的一部分
• 上面显示的 DoSomething 示例库，使用测试 arduino_ci 本身

Answer 4

我不知道有什么平台可以测试 Arduino 代码。

但是，有 Fritzing 平台，您可以使用它对硬件进行建模，然后再进行建模导出PCB图之类的东西。

值得检查。

Answer 5

我们在大型科学实验中使用 Arduino 板进行数据采集。随后，我们必须支持多个具有不同实现的 Arduino 板。我编写了 Python 实用程序来在单元测试期间动态加载 Arduino 十六进制图像。下面链接中的代码通过配置文件支持 Windows 和 Mac OS X。要了解 Arduino IDE 放置十六进制图像的位置，请在按下构建（播放）按钮之前按下 Shift 键。按下 Shift 键并点击上传即可查明您的 avrdude（命令行上传实用程序）在您的系统/Arduino 版本上的位置。或者，您可以查看包含的配置文件并使用您的安装位置（当前在 Arduino 0020 上）。

http://github.com/toddstavish/Python-Arduino-Unit-Testing

Answer 6

该程序允许自动运行多个 Arduino 单元测试。测试过程在 PC 上启动，但测试在实际的 Arduino 硬件上运行。一组单元测试通常用于测试一个 Arduino 库。
（这个

Arduino论坛：http://arduino.cc/forum/index.php?topic= 140027.0

GitHub 项目页面：http://jeroendoggen.github.com/Arduino-TestSuite

Python 包索引中的页面： http://pypi.python.org/pypi/arduino_testsuite

单元测试是使用“Arduino 单元测试库”编写的：http://code.google.com/p /arduinounit

对每组单元测试执行以下步骤：

• 读取配置文件以找出要运行的测试
• 脚本编译并上传包含单元测试代码的 Arduino 草图
• 运行单元测试 脚本
• 。测试结果通过串行端口打印并由 Python 脚本进行分析。
• 开始下一个测试，对配置文件中请求的所有测试重复上述步骤。
• 该脚本打印一个摘要，显示完整测试套件中所有失败/通过的测试的概述。

Answer 7

将特定于硬件的代码与其余代码分开或抽象出来，以便您可以在拥有良好工具且最熟悉的任何平台上测试和调试更大的“其余代码”。

基本上，尝试从尽可能多的已知可用的构建块中构建尽可能多的最终代码。剩下的特定于硬件的工作将变得更加容易和更快。您可以自己使用现有的模拟器和/或模拟设备来完成它。然后，当然，您需要以某种方式测试真实的东西。根据具体情况，这可能会或可能不会很好地自动化（即谁或什么将按下按钮并提供其他输入？谁或什么将观察和解释各种指示器和输出？）。

Answer 8

James W. Grenning 写了很棒的书，这本书是关于嵌入式 C 代码的单元测试嵌入式 C 的测试驱动开发。

Answer 9

我在编写 Arduino 代码时使用 Searduino 。 Searduino 是一个 Arduino 模拟器和一个开发环境（Makefile、C 代码...），使您可以使用您最喜欢的编辑器轻松破解 C/C++。您可以导入 Arduino 草图并在模拟器中运行它们。

Searduino 0.8 的屏幕截图： http://searduino.files.wordpress .com/2014/01/jearduino-0-8.png

Searduino 0.9 将在最后的测试完成后发布，并录制视频......在一两天内。

在模拟器上进行的测试不应被视为真正的测试，但它确实帮助我发现了愚蠢/逻辑错误（忘记执行pinMode(xx, OUTPUT)等）。

顺便说一句：我是 Searduino 的开发者之一。

Answer 10

有一个名为 ncore 的项目，它为 Arduino 提供原生核心。并允许您为 Arduino 代码编写测试。

从项目描述来看

本机内核允许您在 Arduino 上编译和运行 Arduino 草图
PC，一般无需修改。它提供了本机版本
标准 Arduino 功能和命令行解释器
通常来自硬件的草图输入
本身。

另外在 “我需要什么来使用它”部分

如果你想构建测试，你需要 cxxtest
http://cxxtest.tigris.org。 NCORE 已使用 cxxtest 3.10.1 进行了测试。

Answer 11

如果您想在 MCU 之外（在桌面上）对代码进行单元测试，请查看 libcheck：
https://libcheck.github.io/check/

我用它来测试我自己的嵌入式代码几次。这是非常强大的框架。

Answer 12

您可以使用 emulare — 您可以将微控制器拖放到图表上并在 Eclipse 中运行代码。网站上的文档告诉您如何设置。

Answer 13

将 Proteus VSM 与 Arduino 库结合使用来调试或测试代码。

在将代码加载到板上之前，这是最佳实践，但请确保计时，因为仿真不会像在板上运行时那样实时运行。

Answer 14

尝试Autodesk 电路模拟器。它允许使用许多其他硬件组件测试 Arduino 代码和电路。

Answer 15

Arduino 基本是用 C 和 C++ 编写的，甚至 arduino 的库也是用 C 和 C++ 编写的。因此，简单来说，只需将代码处理为 C 和 C++ 并尝试进行单元测试。在这里，通过“句柄”这个词，我的意思是您将所有基本语法（例如serial.println更改为sysout，pinmode更改为variables，void循环更改为while（）循环）等基本语法，这些语法在keystock中或在某些迭代后会中断。

我知道这是一个漫长的过程，而且不是那么简单。根据我个人的经验，一旦你开始使用它，这就会变得更可靠。

-Nandha_Frost

Answer 16

如果您有兴趣运行 INO 草图并检查串行输出，我在我的 Arduino NMEA 校验和 项目。

以下脚本获取该文件并使用 Arduino CLI 将其编译为 HEX 文件，然后将该文件加载到 SimAVR，SimAVR 对其进行评估并打印串行输出。由于所有 Arduino 程序都会永远运行，而没有真正选择杀死自己（exit(0) 不起作用），因此我让草图运行几秒钟，然后将捕获的输出与预期输出进行比较。

下载并解压 Arduino CLI（在本例中为版本 0.5.0 - 撰写本文时的最新版本）：

curl -L https://github.com/arduino/arduino-cli/releases/download/0.5.0/arduino-cli_0.5.0_Linux_64bit.tar.gz -o arduino-cli.tar.gz
tar -xvzf arduino-cli.tar.gz

现在您可以更新索引并安装适当的核心：

./arduino-cli core update-index
./arduino-cli core install arduino:avr

假设您的草图名为 nmea-checksum.ino，要获取 ELF 和 HEX，请运行：

./arduino-cli compile -b arduino:avr:uno nmea-checksum.ino

下一步，SimAVR 运行 HEX（或 ELF） - 我从源代码构建，因为最新版本不适合我：

sudo apt-get update
sudo apt-get install -y build-essential libelf-dev avr-libc gcc-avr freeglut3-dev libncurses5-dev pkg-config
git clone https://github.com/buserror/simavr.git
cd simavr
make

成功编译将为您提供 simavr/run_avr< /code> 您可以使用它来运行草图。就像我说的，超时否则它永远不会终止：

cd simavr
timeout 10 ./run_avr -m atmega168 -f 16000000 ../../nmea-checksum.ino.arduino.avr.uno.elf &> nmea-checksum.ino.clog || true

生成的文件将有 ANSI 颜色代码控制字符包装串行输出，以摆脱这些：

cat nmea-checksum.ino.clog | sed -r "s/\x1B\[([0-9]{1,2}(;[0-9]{1,2})?)?[mGK]//g" > nmea-checksum.ino.log
cat nmea-checksum.ino.log

现在您需要做的就是比较此文件到已知良好的文件：

diff nmea-checksum.ino.log ../../nmea-checksum.ino.test

如果没有差异，diff 将以代码 0 退出，否则脚本将失败。

Answer 17

很多有趣的答案。我发现 AUnit 似乎受到支持并允许通过 < a href="https://github.com/bxparks/EpoxyDuino" rel="nofollow noreferrer">EpoxyDuino。

我可以想象使用模拟器编写单元测试（由于缺乏仅在本机运行的选项）并在实际硬件上进行集成测试。

Answer 18

不要在 Arduino 设备或仿真器上运行单元测试

针对微控制器设备/仿真器/Sim 的测试的案例

关于单元测试的含义有很多讨论，但我不是
真的想在这里对此进行争论。这篇文章不是
告诉您避免对最终目标进行所有实际测试
硬件。我试图提出一个关于优化你的观点
通过消除您的目标硬件来开发反馈周期
您最平常和最频繁的测试。假设被测单位
比整个项目小得多。

单元测试的目的是测试自己代码的质量。单元测试通常不应该测试您无法控制的因素的功能。

这样想：即使您要测试 Arduino 库、微控制器硬件或仿真器的功能，此类测试结果绝对不可能告诉您有关您的产品质量的任何信息。自己的工作。因此，编写不在目标设备（或模拟器）上运行的单元测试更有价值、更高效。

对目标硬件进行频繁测试的周期极其缓慢：

1. 调整代码
2. 编译并上传到 Arduino 设备
3. 观察行为并猜测您的代码是否按照您的预期进行，
4. 如果您希望这样做，则重复

步骤 3 特别令人讨厌通过串行端口获取诊断消息，但您的项目本身需要使用 Arduino 唯一的硬件串行端口。如果您认为 SoftwareSerial 库可能有所帮助，您应该知道这样做可能会破坏任何需要精确定时的功能，例如同时生成其他信号。这个问题发生在我身上。

再说一次，如果您要使用模拟器测试您的草图，并且您的时间关键型例程在上传到实际的 Arduino 之前都运行完美，那么您将学到的唯一教训是模拟器有缺陷 - 并且仍然知道这一点没有透露任何关于您自己的工作质量的信息。

如果在设备或模拟器上进行测试很愚蠢，我应该做什么？

您可能正在使用计算机来处理 Arduino 项目。该计算机比微控制器快几个数量级。编写测试以在您的计算机上构建和运行。

请记住，Arduino 库和微控制器的行为应该假设是正确的，或者至少始终不正确。

当您的测试产生的输出与您的预期相反时，那么您所测试的代码中可能存在缺陷。如果您的测试输出符合您的预期，但当您将其上传到 Arduino 时程序无法正常运行，那么您就知道您的测试是基于不正确的假设，并且您的测试可能存在缺陷。无论哪种情况，您都将获得关于下一个代码更改应该是什么的真正见解。您的反馈质量从“某些内容损坏”改进为“此特定代码损坏”。

如何在您的 PC 上构建和运行测试

您需要做的第一件事是确定您的测试目标。考虑一下您想要测试您自己的代码的哪些部分，然后确保以可以隔离离散部分的方式构建您的程序以进行测试。

如果您想要测试的部件调用任何 Arduino 函数，您将需要在测试程序中提供模型替换。这比看起来要少得多。您的模型实际上不需要做任何事情，只需为您的测试提供可预测的输入和输出。

您想要测试的任何您自己的代码都需要存在于 .pde 草图之外的源文件中。不用担心，即使在草图之外有一些源代码，您的草图仍然可以编译。当您真正认真对待它时，只需在草图文件中定义程序的正常入口点即可。

剩下的就是编写实际的测试，然后使用您最喜欢的 C++ 编译器进行编译！现实世界的例子可能最好地说明这一点。

实际工作示例

此处发现我的一个宠物项目有一些在 PC 上运行的简单测试。对于这个答案提交，我将回顾一下我如何模拟一些 Arduino 库函数以及我为测试这些模型而编写的测试。这与我之前所说的不测试其他人的代码并不矛盾，因为我是编写模型的人。我想非常确定我的模型是正确的。

mock_arduino.cpp 的源代码，其中包含复制 Arduino 库提供的一些支持功能的代码：

#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。

Answer 19

由于 Arduino 没有任何预先存在的单元测试框架，我创建了 ArduinoUnit。这是一个简单的 Arduino 草图，展示了其用途：

#include <ArduinoUnit.h>

// Create test suite
TestSuite suite;

void setup() {
    Serial.begin(9600);    
}

// Create a test called 'addition' in the test suite
test(addition) {
    assertEquals(3, 1 + 2);
}

void loop() {
    // Run test suite, printing results to the serial port
    suite.run();
}

Answer 20

通过抽象出硬件访问并在测试中模拟它，我在单元测试我的 PIC 代码方面取得了相当大的成功。

例如，我使用抽象 PORTA

#define SetPortA(v) {PORTA = v;}

那么 SetPortA 可以很容易地被模拟，而无需在 PIC 版本中添加开销代码。

一旦硬件抽象经过一段时间的测试，我很快就会发现，通常代码从测试设备转移到 PIC 并且第一次就能工作。

更新：

我使用#include接缝作为单元代码，#include C++文件中的单元代码作为测试设备，并使用C文件作为目标代码。

作为一个例子，我想多路复用四个 7 段显示器，一个端口驱动段，第二个端口选择显示器。显示代码通过 SetSegmentData(char) 和 SetDisplay(char) 与显示器交互。我可以在我的 C++ 测试装置中模拟这些并检查是否获得了我期望的数据。对于目标，我使用#define，这样我就可以直接赋值，而无需函数调用的开销

#define SetSegmentData(x) {PORTA = x;}

Answer 21

看来 emulino 可以完美地完成这项工作。

Emulino 是 Greg Hewgill 开发的 Arduino 平台模拟器。 （来源）

GitHub 存储库