Reportinglib integration tests (#97)

* add integration test concerning reportinglib
* regenerate dataset from vanilla nmodl special

Author: fouriaux

CMake/packages/Findreportinglib.cmake

@@ -58,14 +58,15 @@
 
 # UNIX paths are standard, no need to write.
 find_path(reportinglib_INCLUDE_DIR reportinglib/Report.h)
-
 find_library(reportinglib_LIBRARY reportinglib)
 get_filename_component(reportinglib_LIB_DIR ${reportinglib_LIBRARY} DIRECTORY)
+find_program (reportinglib_somaDump somaDump ${reportinglib_LIB_DIR}/../bin)
 
 # Checks 'REQUIRED', 'QUIET' and versions.
 include(FindPackageHandleStandardArgs)
 
 find_package_handle_standard_args(reportinglib
   FOUND_VAR reportinglib_FOUND
   REQUIRED_VARS reportinglib_INCLUDE_DIR reportinglib_LIBRARY reportinglib_LIB_DIR)
-  
+
+# reporting_BIN_DIR is required only for running tests 

coreneuron/nrniv/nrn_filehandler.cpp

@@ -41,6 +41,7 @@ void FileHandler::open(const char* filename, bool reorder, std::ios::openmode mo
     reorder_bytes = reorder;
     close();
     F.open(filename, mode | std::ios::binary);
+    if (! F.is_open()) fprintf (stderr, "cannot open file %s\n", filename);
     nrn_assert(F.is_open());
     current_mode = mode;
     char version[256];

coreneuron/utils/reports/report_configuration_parser.cpp

@@ -69,7 +69,7 @@ std::vector<ReportConfiguration> create_report_configurations(const char* conf_f
 
     FILE* fp = fopen(conf_file, "r");
     if (!fp) {
-        std::cerr << "Error while reading report configuration " << conf_file << std::endl;
+        std::cerr << "Cannot open configuration file: " << conf_file << ", aborting execution" << std::endl;
         abort();
     }
 

tests/integration/CMakeLists.txt

@@ -117,3 +117,16 @@ endif()
   endfunction(exec_test)
 
 endif()
+
+if (ENABLE_REPORTINGLIB)
+    foreach(TEST_NAME "1")
+        set (SIM_NAME "reporting_${TEST_NAME}")
+        set (CONFIG_ARG "${TEST_NAME}")
+        configure_file(reportinglib/${TEST_NAME}.conf.in ${SIM_NAME}/${TEST_NAME}.conf @ONLY)
+        configure_file(reportinglib/reporting_test.sh.in ${SIM_NAME}/reporting_test.sh @ONLY)
+        configure_file(reportinglib/${TEST_NAME}.check.in ${SIM_NAME}/${TEST_NAME}.check @ONLY)
+        add_test(NAME ${SIM_NAME}
+            COMMAND "/bin/sh" ${CMAKE_CURRENT_BINARY_DIR}/${SIM_NAME}/reporting_test.sh
+             WORKING_DIRECTORY "${CMAKE_CURRENT_BINARY_DIR}/${SIM_NAME}")
+    endforeach()
+endif()

tests/integration/reportinglib/1.check.in

@@ -0,0 +1,21 @@
+#! /bin/sh
+
+#NOTE: binary diff is not a good idea as it dont reflect what people use to read reports
+
+OK=0
+FAILED=1
+
+if [ -f test_1.bbp ] 
+then
+   #checking something with @reportinglib_BIN_DIR@/dump test_1.bbp
+   # for ascii files that will be using grep for instance.
+   nb_recorded=$(@reportinglib_somaDump@ test_1.bbp 1| wc -l)
+   if [ $nb_recorded -eq 100 ]; then
+     exit $OK
+   else
+     exit $FAILED
+   fi
+else
+   exit $FAILED
+fi
+

tests/integration/reportinglib/1.conf.in

@@ -0,0 +1,8 @@
+--outpath ./
+--datpath @CMAKE_CURRENT_SOURCE_DIR@/ring/
+--tstop 10.000000
+--dt 0.025000
+--forwardskip 0.000000
+--prcellgid -1
+--report-conf @CMAKE_CURRENT_SOURCE_DIR@/reportinglib/1.report
+--cell-permute 0

tests/integration/reportinglib/1.report

@@ -0,0 +1,7 @@
+#! /bin/sh 
+
+export LD_LIBRARY_PATH=$LD_LIBRARY_PATH:@CMAKE_BINARY_DIR@/lib:@reportinglib_LIB_DIR@
+export OMP_NUM_THREADS=1
+@SRUN_PREFIX@ @CMAKE_BINARY_DIR@/bin/coreneuron_exec --read-config @[email protected] -mpi
+chmod +x ./@[email protected]
+exit `./@[email protected]`