CppUTest’in STM32CubeIDE ile Kullanımı

    Uzun bir aradan sonra tekrardan merhaba. Bazı sebeplerden dolayı bir yıldır bir şeyler yazamamışım. Bu açığı şöyle birkaç güzel yazı ile kapatmak istiyorum. Bu aralar Test Güdümlü Geliştirme( Test Driven Development) konusuna çalışıyorum ve TDD‘ye bir alışkanlık kazanmak istiyorum. Hazır bu konuya çalışırken yaptığım örnekleri burada paylaşmak istiyorum. Merak etmeyin paylaşacağım örnekler bir led yakıp söndürme testi falan olmayacak :). Elimin altında şuan çok fazla elektronik bir ekipman, modül vb. yok idare edin. O yüzden elimde olan Nucleo kart ve ESP8266 ile TDD üzerine elimden geldiğince güzel örnekler paylaşmaya çalışacağım. Bu ilk yazıda TDD için kullanacağım Unit Test Framework’lerinden biri olan CppUTest’in STM32CubeIDE ile nasıl derlenip, kullanılacağından bahsetmek istiyorum çünkü bu aşama bile bir yazı için oldukça uzun bir hal aldı.

    İkinci yazıda ESP8266 ile TCP/IP üzerinden bilgisayar ile haberleşecek bir kütüphaneyi tamamen TDD prensibini uygulayarak geliştirmeye çalışacağım. Bu kütüphanede işin içine Ring Buffer konseptini de katacağım.

    Üçüncü yazıyı daha da ileriye taşıyarak ikincide geliştirdiğim ESP8266 kütüphanesini kullanan bir haberleşme protokolü kütüphanesi geliştireceğim( daha karar vermedim ama yüksek ihtimalle MQTT olacak). Ayrıca üçüncü yazıda kriptografinin gömülü yazılım tarafında kullanımını görmek için basit bir şifreleme algoritması kullanıp MQTT ile şifreli haberleşme uygulaması yapmayı planlıyorum. Daha önceki yazılarda yerelde bir MQTT broker kullanan örneği paylaşmıştım, burada bir cloud servis üzerinden gitmeyi planlıyorum ( HiveMQ,CloudMQTT vb.). Üçüncü yazıyı da TDD prensiplerine uyarak geliştireceğim ama yazıda daha çok MQTT ve kriptografi üzerinde duracağım. TDD tarafını incelemek için github tarafında zaten kodlara erişebileceksiniz.

    TDD tarafında kaynağım  James Grenning‘in yazdığı “Test-Driven Development for Embedded C” kitabı olacak. Framework olarak CppUTest seçmemin sebebi de budur. STM32CubeIDE Eclipse tabanlı bir IDE olduğu için bir çok Unit Test framework’ünü desteklemektedir. Hangisini kullanacağınız size kalmış.

    Lafı daha da uzatmadan bu yazının asıl konusuna gelelim. Aşağıda CppUTest’in STM32CubeIDE ile nasıl kullanılacağına ve benim nasıl bir dosya yapısı halinde kullandığımı adım adım açıkladım. Takıldığınız yerler olursa yorumlarda sorabilirsiniz.

File->New->STM32 project  ile yeni bir proje oluşturulur. Açılan pencereden kullanacak olduğunuz MCU veya Board seçilir. Burada benim kullandığım kart Nucleo-G474RE’dir (Aslında statik derleme aşamasında mcu seçiminin bir önemi yoktur. İstediğiniz mcu’yu seçebilirsiniz.). Kullanmak istediğiniz mcu’yu seçtikten sonra aşağıdaki pencereden;

seçilerek devam edilir. Burada proje ismini belirlemek size kalmış.

Project->Properties->C/C++ Build-> Settings->Tool Settings ->MCU G++ Compiler -> Preprocessor  penceresinde  “Define symbols” kısmında add simgesine tıklayıp CPPUTEST_STD_CPP_LIB_DISABLED ön işlemci komutunu ekleyin.

Project->Properties->C/C++ Build-> Settings-> Tool Settings ->MCU G++ Compiler -> Optimization penceresinde;

kutucuklarının işaretli olduğundan emin olun.

Projenizin bulunduğu klasör içinde src/ IEEE754ExceptionsPlugin.cpp dosyasının içindeki  #ifdef CPPUTEST_HAVE_FENV satırını değiştirin. (CPPUTEST_HAVE_FENV den bir harf silip veya alakasız bir harf ekleyebilirsiniz. Buradaki amaç #else kısmındaki kodun derlenmesini sağlamaktır.)

Build simgesine tıklayarak projeyi derleyin. Projenin Debug dosyası altındaki dosyalar cpputest in derlenmiş halidir. Asıl kodlarımızı yazıp testlerini yapacağımız projede debug dosyasını referans göstereceğiz. Bu aşamadan sonra bu projeyi kapatıp asıl proje kodlarımızı yazacağımız yeni stm32 projesi oluşturabiliriz.

Bu oluşturacağımız proje asıl kodlarımızı yazacağımız proje olacak. Burada kullanacak olduğunuz mikrodenetleyiciyi seçtikten sonra açılan pencerede aşağıdaki ayarları yapabilirsiniz. Burada “Targeted Language” kısmını C++ olarak seçeceğiz.

Bu aşamada şöyle bir yol izliyorum. İki farklı build ve debug konfigürasyonu oluşturuyorum. Test kodları için ayrı bir dosya oluşturup bu dosya içerisindeki kodları yeni oluşturduğum build konfigürayonunda derlenmesi için ayarlıyorum. Böylece main.cpp üzerinde testini yaptığım kodları derleyerek mikrodenetleyiciye yüklüyorum. Ayrıca test kodları ROM’da yer tutmamış oluyor(asıl projede). Yani projenin dosya yapısını aşağıdaki gibi ayarlıyorum. Aşağıda görüldüğü gibi Tests dosyasının altında bir main.cpp ve Core klasörünün altında main.c bulunuyor. CppUTest isminden de anlaşılacağı gibi C++ üzerine kurulmuş bir framework ve testlerin koşturulması için .cpp uzantılı ve main fonksiyonu olan bir dosyadan çağrılması gerekmekte.  Gömülü tarafta ise çoğunlukla C dili ile çalıştığımız için böyle bir yol izleyebiliriz. Hem C de geliştirme yapmış oluruz hem de C de yazdığımız kütüphanelerin veya fonksiyonların testini yapmış oluruz.

Şimdi gelin yeni bir derleme konfigürasyonunun nasıl oluşturulduğuna bakalım. Bunun için proje üzerine sağ tıklayıp; Build Configurations -> Manage’e  ve açılan pencereden “New”butonuna tıklıyoruz.

Burada “Name” kısmına istediğiniz ismi verebilirsiniz. Burada önemli olan “Copy settings from” kısmından “Existing configuration” “Debug” olarak seçilmelidir. Bu aşamadan sonra “Ok” butonuna tıklayıp kapatabiliriz. Daha sonra bir önceki pencereden yeni oluşturduğumuz build konfigürasyonunu aktif etmemiz gerekiyor. Bunu “set active” butonuna tıklayarak yapıyoruz.

Şimdi testler için ayrı bir dosya oluşturalım. Bunun için proje üzerine sağ tıklayıp; New->Source Folder’a tıklayalım.

Burada istediğiniz dosya ismini girip finish’e tıklayabilirsiniz. Daha sonra bu oluşturduğumuz Tests isimli dosyanın üzerine sağ tıklayıp; New->Source File a tıklayın.

Testlerimizin koşabilmesi için bir main içinden çağrılması lazım. Bu yüzden burada main.cpp isimli bir dosya oluşturuyorum. Daha sonra /Core/Src altındaki main.c nin içeriğinin hepsini kopyalayıp main.cpp içerisine yapıştırıyorum. Buradaki amaç debug yaparken test sonuçlarının UART üzerinden basılacak olmasıdır. main.c nin içerisinde UART ayarlı olduğu için burada tekrar oluşturmak yerine kopyalıyorum. Ardından main.cpp nin içine CppUtest için gerekli kütüphane dosyasını dahil ediyorum.

...
/* Includes ------------------------------------------------------------------*/
#include "main.h"
#include "CppUTest/CommandLineTestRunner.h"
/* Private includes ----------------------------------------------------------*/
/* USER CODE BEGIN Includes */
...

Ardından Testlerin koşabilmesi için aşağıdaki iki satırlık bloğu main fonksiyonun içine ekliyorum.

...
/* USER CODE BEGIN WHILE */
 const char * av_override[] = { };
 CommandLineTestRunner::RunAllTests(0, av_override);
 while (1)
 {
 /* USER CODE END WHILE */
...

Daha sonra yine aynı şekilde Tests klasörünün içine “tests.cpp” isimli bir dosya daha ekliyorum. Bu dosya içerisinde test fonksiyonlarımızı yazacağız.

Daha sonra bu Tests isimli klasörün içine githubtan indirdiğimiz CppUTest projesinin  /cpputest/Include içindeki dosyaları kopyalıyoruz.

Şimdi kendi yazacağımız ve testini yapacağımız kütüphaneler için bir dosya oluşturalım. Bunun için projeye sağ tıklayıp;

New->Source Folder’a tıklayıp açılan pencereden dosya ismini giriyoruz.

Daha sonra bu yeni oluşturduğumuz dosyaya  sağ tıklayıp; New->Source file’a tıklayıp açılan pencereden kütüphanemizin kaynak dosyasını oluşturuyoruz. Yine aynı şekilde New->header file diyerek .h uzantılı header dosyasını oluşturuyoruz.

Burada kütüphanemi C dosyası olarak oluşturuyorum çünkü burada CppUTest ile C kodlarının nasıl test edildiğini göstermek istiyorum.

Bu aşamadan sonra Proje dosya yapısı aşağıdaki gibi oluyor.

Bu kütüphaneye basit bir toplama fonksiyonu ekleyelim ve testlerimizin çalıştığından emin olalım. Bunun için my_lib.h ve my_lib.c dosyalarını aşağıdaki gibi düzenliyorum.

#ifndef MY_LIB_H_
#define MY_LIB_H_
#ifdef __cplusplus
extern "C"
{
#endif
int sumOfTwoNumbers(int a,int b);
#ifdef __cplusplus
}
#endif
#endif /* MY_LIB_H_ */

#include "my_lib.h"

int sumOfTwoNumbers(int a,int b)
{
 return a+b;
}

#include "CppUTest/TestHarness.h"
#include "my_lib.h"
TEST_GROUP(FirstTestGroup)
{
};
TEST(FirstTestGroup, FirstTest)
{
 STRCMP_EQUAL("hello", "world");
}
TEST(FirstTestGroup, SecondTest)
{
 LONGS_EQUAL(5,sumOfTwoNumbers(2, 3));
}

#include "CppUTest/TestHarness.h"
#include "my_lib.h"
TEST_GROUP(FirstTestGroup)
{
};
TEST(FirstTestGroup, FirstTest)
{
 STRCMP_EQUAL("topuz", "topuz");
}
TEST(FirstTestGroup, SecondTest)
{
 LONGS_EQUAL(5,sumOfTwoNumbers(2, 3));
}

...
#include "main.h"

extern UART_HandleTypeDef huart1;
...

...
__attribute__((weak)) int _write(int file, char *ptr, int len)
{
 int DataIdx;
 for (DataIdx = 0; DataIdx < len; DataIdx++)
 {
   //       __io_putchar(*ptr++);
  //          ITM_SendChar(*ptr++);
HAL_UART_Transmit(&huart1, (uint8_t *)(ptr++), 1, HAL_MAX_DELAY);
 }
 return len;
}
...