So testen Sie eine statische Funktion

Question 1

Beim Anwenden von Komponententests auf einigen C-Code stoßen wir auf ein Problem, dass einige statische Funktionen nicht in der Testdatei aufgerufen werden können, ohne den Quellcode zu ändern. Gibt es eine einfache oder vernünftige Möglichkeit, dieses Problem zu lösen?

Question 2

Ich habe einen Prüfstand. In schlimmen Fällen – wie beim Versuch, eine statische Funktion zu testen, verwende ich:

#include "code_under_test.c"
...test framework...

Das heißt, ich füge die gesamte Datei, die die zu testende Funktion enthält, in die Testumgebung ein. Es ist ein letzter Ausweg – aber es funktioniert.

Question 3

Können Sie weitere Informationen darüber geben, warum Sie die Funktion nicht aufrufen können?

Ist es nicht verfügbar, weil es in einer .c-Datei privat ist? Wenn dies der Fall ist, verwenden Sie am besten eine bedingte Kompilierung, die den Zugriff auf die Funktion ermöglicht, damit andere Kompilierungseinheiten darauf zugreifen können. Zum Beispiel

SomeHeaderSomewhere.h

#if UNIT_TEST
#define unit_static 
#else
#define unit_static static
#endif

Fooh

#if UNIT_TEST
void some_method
#endif

Foo.cpp

unit_static void some_method() ...

Question 4

Bei Komponententests haben wir den Testcode tatsächlich in der Quelldatei selbst und wir kompilieren ihn beim Testen bedingt ein. Dadurch erhalten die Komponententests vollen Zugriff auf alle Funktionen und Variablen auf Dateiebene (statisch oder anderweitig).

Die Unit-Tests selbst sind nicht statisch – dies ermöglicht es uns, die Unit-Tests von einem einzigen Super-Test-Programm aufzurufen, das alle Kompilierungseinheiten Unit-Tests durchführt.

Wenn wir den Code versenden, kompilieren wir bedingt die Komponententests, aber das ist eigentlich nicht notwendig (wenn Sie sicher sein wollen, dass Sie versenden exakt derselbe Code, den Sie getestet haben).

Wir fanden es immer von unschätzbarem Wert, die Komponententests am selben Ort wie den zu testenden Code zu haben, da es offensichtlicher wird, dass Sie die Tests aktualisieren müssen, wenn sich der Code ändert.

Question 5

Nein – Sie können eine statische Funktion nicht direkt testen, ohne die Quelle zumindest ein wenig zu ändern (das ist die Definition von static in C – dass sie nicht von einer Funktion in einer anderen Datei aufgerufen werden kann).

Sie könnten eine separate Funktion innerhalb der Testdatei erstellen, die nur die statische Funktion aufruft?

Zum Beispiel:

//Your fn to test
static int foo(int bar)
{
  int retVal;
  //do something
  return retVal;
}

//Wrapper fn
int test_foo(int bar)
{
  return foo(bar);
}

Normalerweise testen wir unsere statischen Funktionen nicht direkt, sondern stellen sicher, dass die von ihnen ausgeführte Logik durch verschiedene Tests der aufrufenden Funktion angemessen getestet wird.

Question 6

Statische Funktionen sind im Wesentlichen Hilfsfunktionen für die öffentlichen (dh exponierten) Funktionen. IMO sollten Ihre Komponententests also die öffentliche Schnittstelle mit Eingaben aufrufen, die alle Pfade in der statischen Funktion ausführen.

Die Ausgabe (Rückgabewerte / Seiteneffekte) der öffentlichen Funktion sollte verwendet werden, um die Wirkung der Statik zu testen.

Das bedeutet, dass Sie geeignete Stubs haben müssen, um diese Nebenwirkungen „abzufangen“. (z. B. wenn eine Funktion Datei-IO aufruft, müssen Sie Stubs bereitstellen, um diese Datei-IO-Bibliotheksfunktionen zu überschreiben). Der beste Weg, dies zu tun, indem Sie jede Testsuite zu einem separaten Projekt / einer separaten ausführbaren Datei machen und die Verknüpfung mit externen Bibliotheksfunktionen vermeiden. Sie können sogar C-Funktionen simulieren, aber es lohnt sich nicht.

Wie auch immer, das ist der Ansatz, den ich bisher verwendet habe und der für mich funktioniert. Viel Glück

Question 7

#define static

Das ist eine sehr schlechte Idee. Wenn Sie eine Variable lokal für eine Funktion deklariert haben, ändert sie das Verhalten der Funktion. Beispiel:

static int func(int data)
{
   static int count = 0;

   count += data;
   return count;
}

Sie könnten die Funktion aus dem Komponententest aufrufen, da func() exportiert würde, jedoch würde die grundlegende Funktionalität des Codes geändert.

-kurt

Question 8

Wenn Sie sich in einer Unix-Umgebung befinden, können Sie einen zusätzlichen Header in die Testdatei aufnehmen yourheader_static.h mit Deklarationen Ihrer statischen Funktionen und übersetzen Sie die obj-Datei code_under_test.o durch objdump --globalize-symbols=syms_name_file lokale Symbole zu globalisieren. Sie sind sichtbar, als ob sie nicht statische Funktionen wären.