Memory analyzer unit tests: embed source files

Make the unit tests less fragile by not relying on a particular
directory that they are being run from. Test files had to be loaded from
a specific location; instead, place them in the source code and generate
temporary files at runtime.

Author: tautschnig

unit/CMakeLists.txt

@@ -16,6 +16,34 @@ file(GLOB_RECURSE testing_utils "testing-utils/*.cpp" "testing-utils/*.h")
 if(NOT WITH_MEMORY_ANALYZER)
     file(GLOB_RECURSE memory_analyzer_sources "memory-analyzer/*.cpp")
     list(REMOVE_ITEM sources ${memory_analyzer_sources})
+else()
+    add_custom_command(OUTPUT "${CMAKE_CURRENT_BINARY_DIR}/memory-analyzer"
+        COMMAND ${CMAKE_COMMAND} -E make_directory ${CMAKE_CURRENT_BINARY_DIR}/memory-analyzer
+    )
+    function(make_mm_inc input output)
+        add_custom_command(OUTPUT "${CMAKE_CURRENT_BINARY_DIR}/memory-analyzer/${output}"
+            COMMAND $<TARGET_FILE:file_converter>
+                "${CMAKE_CURRENT_SOURCE_DIR}/memory-analyzer/${input}" >
+                "${CMAKE_CURRENT_BINARY_DIR}/memory-analyzer/${output}"
+            DEPENDS
+              "${CMAKE_CURRENT_SOURCE_DIR}/memory-analyzer/${input}"
+              "${CMAKE_CURRENT_BINARY_DIR}/memory-analyzer"
+              $<TARGET_FILE:file_converter>
+        )
+    endfunction(make_mm_inc)
+
+    make_mm_inc(input.txt input.inc)
+    make_mm_inc(test.c test.inc)
+
+    set(generated_mm_files
+      "${CMAKE_CURRENT_BINARY_DIR}/memory-analyzer/input.inc"
+      "${CMAKE_CURRENT_BINARY_DIR}/memory-analyzer/test.inc"
+    )
+    set_source_files_properties(
+        "${CMAKE_CURRENT_SOURCE_DIR}/memory-analyzer/gdb_api.cpp"
+        PROPERTIES
+        OBJECT_DEPENDS "${generated_mm_files}"
+    )
 endif()
 
 list(REMOVE_ITEM sources
@@ -44,6 +72,7 @@ target_include_directories(unit
     ${CBMC_BINARY_DIR}
     ${CBMC_SOURCE_DIR}
     ${CMAKE_CURRENT_SOURCE_DIR}
+    ${CMAKE_CURRENT_BINARY_DIR}
     ${CUDD_INCLUDE}
 )
 target_link_libraries(

unit/Makefile

@@ -242,7 +242,16 @@ N_CATCH_TESTS = $(shell \
                 $$(printf ' -not -name %s ' $(EXCLUDED_TESTS))) | \
                   grep -E "(SCENARIO|TEST_CASE)" | grep -c -v '\[\.\]')
 
-CLEANFILES = $(CATCH_TEST) testing-utils/testing-utils$(LIBEXT)
+memory-analyzer/input.inc: memory-analyzer/input.txt
+	../src/ansi-c/file_converter$(EXEEXT) $< > $@
+
+memory-analyzer/test.inc: memory-analyzer/test.c
+	../src/ansi-c/file_converter$(EXEEXT) $< > $@
+
+memory-analyzer/gdb_api$(OBJEXT): memory-analyzer/input.inc memory-analyzer/test.inc
+
+CLEANFILES = $(CATCH_TEST) testing-utils/testing-utils$(LIBEXT) \
+             memory-analyzer/input.inc memory-analyzer/test.inc
 
 # only add a dependency for libraries to avoid triggering implicit rules, which
 # would cause unnecessary rebuilds

unit/memory-analyzer/gdb_api.cpp

@@ -18,13 +18,28 @@ Author: Malte Mues <[email protected]>
 #include <iostream>
 
 #include <memory-analyzer/gdb_api.cpp>
+
 #include <util/run.h>
+#include <util/tempfile.h>
 
-void compile_test_file()
+struct compile_test_filet
 {
-  REQUIRE(
-    run("gcc", {"gcc", "-g", "-o", "test", "memory-analyzer/test.c"}) == 0);
-}
+  compile_test_filet() : compiled("test", "")
+  {
+    temporary_filet tmp("test", ".c");
+    std::ofstream of(tmp().c_str());
+    REQUIRE(of.is_open());
+
+    of <<
+#include <memory-analyzer/test.inc>
+      ; // NOLINT(whitespace/semicolon)
+    of.close();
+
+    REQUIRE(run("gcc", {"gcc", "-g", "-o", compiled(), tmp()}) == 0);
+  }
+
+  temporary_filet compiled;
+};
 
 void check_for_gdb()
 {
@@ -46,10 +61,10 @@ class gdb_api_testt : public gdb_apit
 void gdb_api_internals_test()
 {
   check_for_gdb();
-  compile_test_file();
+  compile_test_filet test_file;
 
   std::vector<std::string> args;
-  args.push_back("test");
+  args.push_back(test_file.compiled());
 
   SECTION("parse gdb output record")
   {
@@ -67,9 +82,18 @@ void gdb_api_internals_test()
 
   SECTION("read a line from an input stream")
   {
+    temporary_filet tmp("input", ".txt");
+    std::ofstream of(tmp().c_str());
+    REQUIRE(of.is_open());
+
+    of <<
+#include <memory-analyzer/input.inc>
+      ; // NOLINT(whitespace/semicolon)
+    of.close();
+
     gdb_api_testt gdb_api(args);
 
-    FILE *f = fopen("memory-analyzer/input.txt", "r");
+    FILE *f = fopen(tmp().c_str(), "r");
     gdb_api.response_stream = f;
 
     std::string line = gdb_api.read_next_line();
@@ -79,7 +103,7 @@ void gdb_api_internals_test()
     REQUIRE(line == std::string(1120, 'a') + "\n");
 
     line = gdb_api.read_next_line();
-    REQUIRE(line == "xyz");
+    REQUIRE(line == "xyz\n");
   }
 
   SECTION("start and exit gdb")
@@ -102,10 +126,10 @@ TEST_CASE("gdb api internals test", "[core][memory-analyzer]")
 TEST_CASE("gdb api test", "[core][memory-analyzer]")
 {
   check_for_gdb();
-  compile_test_file();
+  compile_test_filet test_file;
 
   std::vector<std::string> args;
-  args.push_back("test");
+  args.push_back(test_file.compiled());
 
   {
     gdb_apit gdb_api(args, true);