* src/iracebin/irace.h. Better handling of paths in Windows. Fixes #79.

 * tests/testthat/test-target-runner-dummy.R: Run more tests on Windows.

Author: MLopez-Ibanez

NEWS.md

@@ -43,6 +43,8 @@
 
 ## Fixes
 
+ * Fix #79: irace.exe did not encode the `libPath` correctly in R >= 4.0 on Windows, producing 'unrecognized escape in character string'. Fixed by replacing backslashes with forward slashes and quoting the arguments that may contain spaces.
+
  * Fix #76: Recovery (`--recover-file`) is working again with a completely new implementation.
 
  * Fixed documentation of `psRace()`.

src/iracebin/irace.h

@@ -5,45 +5,89 @@
 #include <unistd.h>
 #include "whereami.h"
 
-#define max_path_length 1024
+#define MAX_PATH_LENGTH 1024
+
 char *get_install_path(const char * package_path)
 {
-    char fullpath[max_path_length - 1] = "\0";
-    int dirname_length = 0;
-    int res = wai_getExecutablePath(fullpath, max_path_length, &dirname_length);
-    if (res <= 0)
-        return NULL;
-    if (res <= dirname_length)
+    char fullpath[MAX_PATH_LENGTH - 1] = "\0";
+    int fullpath_length = 0;
+    int res = wai_getExecutablePath(fullpath, MAX_PATH_LENGTH, &fullpath_length);
+    if (res <= 0 || res <= fullpath_length)
         return NULL;
-    dirname_length -= strlen(package_path);
-    char * path = (char*) malloc(dirname_length+1);
-    memcpy(path, fullpath, dirname_length);
-    path[dirname_length] = '\0';
+    // printf("fullpath: %s (%d)\n", fullpath, fullpath_length);
+#ifdef WIN32
+    for (size_t i = 0; i < fullpath_length; ++i) {
+        if (fullpath[i] == '\\') {
+            fullpath[i] = '/';
+        }
+    }
+#endif
+    // Remove package_path and everything after it from fullpath.
+    size_t package_path_len = strlen(package_path);
+    char *pos = strstr(fullpath, package_path);
+    char * last_found = NULL;
+    if (pos == NULL) {
+        printf("Error: irace is installed at an unexpected path: %s\n", fullpath);
+        exit(EXIT_FAILURE);
+    }
+    // Search the last occurrence in case fullpath is something like
+    // /irace/bin/R/x86_64-pc-linux-gnu-library/4.1/irace/bin/irace .
+    do  {
+        last_found = pos;
+        pos = strstr(pos + package_path_len, package_path);
+    } while (pos != NULL);
+    *last_found = '\0';
+    fullpath_length = strlen(fullpath);
+    char * path = (char*) malloc((fullpath_length + 1) * sizeof(char));
+    memcpy(path, fullpath, fullpath_length + 1);
+    // printf("path: %s (%d)\n", fullpath, fullpath_length);
     return path;
 }
+#undef MAX_PATH_LENGTH
 
 int exec_R(int argc, char *argv[], const char * user_code)
 {
+    const char * path = get_install_path("/irace/bin/");
+    if (path == NULL)
+        path = "";
+
+#define _libpath_str ".libPaths(c(r'{%s}', .libPaths()));%s"
 #ifdef WIN32
-# define EXE_EXT ".exe"
+// Windows execvp() does not pass command-line arguments correctly if they
+// contain space, tab, backslash, or double-quote characters.
+#define libpath_str "\"" _libpath_str "\""
 #else
-# define EXE_EXT ""
+#define libpath_str _libpath_str
 #endif
-    const char file[] = "R" EXE_EXT;
-    const char * path = get_install_path("/irace/bin");
-    if (path == NULL) path = "";
-#define libpath_str ".libPaths(c('%s', .libPaths()));%s"
+    // -4 because of two times %s.
     char * r_code = malloc(sizeof(char) * (strlen(libpath_str) - 4 + strlen(path) + strlen(user_code) + 1));
     sprintf(r_code, libpath_str, path, user_code);
-    //printf("%s\n", libpath);
-    
+#undef _libpath_str
+#undef libpath_str
+    // printf("%s\n", r_code);
+
     char * const extra_argv[] = { "--vanilla", "--slave", "-e", r_code, "--args"};
     int extra_argc = sizeof(extra_argv) / sizeof(char *);
-    char **cmd_args = calloc(extra_argc + argc + 1, sizeof(char *));
+    char **cmd_args = malloc((extra_argc + argc + 1) * sizeof(char *));
     cmd_args[0] = argv[0];
     for (int i = 0; i < extra_argc; i++)
         cmd_args[i+1] = extra_argv[i];
     for (int i = 1; i < argc; i++)
         cmd_args[extra_argc + i] = argv[i];
-    return execvp(file, cmd_args);
+    cmd_args[extra_argc + argc] = NULL;
+    // for (int i = 0; i < extra_argc + argc; i++)
+    //     printf("%d: %s\n", i, cmd_args[i]);
+
+#ifdef WIN32
+# define EXE_EXT ".exe"
+#else
+# define EXE_EXT ""
+#endif
+    const char file[] = "R" EXE_EXT;
+#undef EXE_EXT
+    if (execvp(file, cmd_args) == -1) {
+        perror("Error executing R");
+        return EXIT_FAILURE;
+    }
+    return EXIT_SUCCESS;
 }

tests/testthat/test-target-runner-dummy.R

@@ -33,21 +33,25 @@ withr::with_output_sink("test-target-runner-dummy.Rout", {
     skip_if_not(nzchar(iraceexe), "Not run because 'irace' is not installed")
     expect_true(file.exists(iraceexe))
     # FIXME: For some reason, this does not generate any output on Windows
-    output <- expect_silent(system2(iraceexe, "--help", stdout = TRUE, stderr = TRUE))
-    skip_on_os("windows")
-    expect_match(paste(collapse="", output),
-                 "irace: An implementation in R of.*called with: --help")
+    output <- expect_silent(runexe(iraceexe, "--help"))
+    ## cat("irace --help\n")
+    ## print(output)
+    expected_output <- if (system_os_is_windows()) "^$"
+                       else "irace: An implementation in R.*called with: --help"
+    expect_match(paste(collapse="", output), expected_output)
   })
 
   test_that("ablation exe works", {
     ablationexe <- get_executable("ablation")
     skip_if_not(nzchar(ablationexe), "Not run because 'ablation' is not installed")
     expect_true(file.exists(ablationexe))
     # FIXME: For some reason, this does not generate any output on Windows
-    output <- expect_silent(system2(ablationexe, "--help", stdout = TRUE, stderr = TRUE))
-    skip_on_os("windows")
-    expect_match(paste(collapse="", output),
-      "ablation: An implementation in R of Ablation Analysis.*called with: --help")
+    output <- expect_silent(runexe(ablationexe, "--help"))
+    ## cat("ablation --help\n")
+    ## print(output)
+    expected_output <- if (system_os_is_windows()) "^$"
+                       else "ablation: An implementation in R of Ablation Analysis.*called with: --help"
+    expect_match(paste(collapse="", output), expected_output)
   })
 
   run_cmdline <- function(parameters, args) {
@@ -65,7 +69,7 @@ withr::with_output_sink("test-target-runner-dummy.Rout", {
   target_runner_dummy <- get_executable("target-runner-dummy")
   skip_if_not(nzchar(target_runner_dummy), "Not run because 'target-runner-dummy' is not installed")
   expect_true(file.exists(target_runner_dummy))
-  
+
   test_that("--check", {
     expect_warning(
       run_cmdline(paste0('p_int  "--p_int " i (1, 10)\n',
@@ -91,7 +95,7 @@ withr::with_output_sink("test-target-runner-dummy.Rout", {
                            'capping "--opt-time " c (1)\n'),
                     '--max-time 1000 --bound-max 100 --capping 1'),
         "is too large"),
-      "No scenario file given")      
+      "No scenario file given")
   })
   test_that("--capping", {
     expect_warning(
@@ -120,7 +124,7 @@ withr::with_output_sink("test-target-runner-dummy.Rout", {
                            'capping "--opt-time " c (1)\n'),
                     '--max-time 500 --bound-max 1 --capping 1 '),
         "With the current settings and estimated time per run"),
-      "No scenario file given")      
+      "No scenario file given")
   })
   test_that("Error cost time", {
     expect_error(
@@ -151,5 +155,5 @@ withr::with_output_sink("test-target-runner-dummy.Rout", {
                   '--min-experiments 50'),
       "No scenario file given"))
   })
-  
+
 }) # withr::with_output_sink()