subprocess_run: test with actual executables built on system

Author: scivision

+stdlib/subprocess_run.m

@@ -57,6 +57,17 @@
   assert(isfolder(opt.cwd), "directory %s does not exist", opt.cwd)
   proc.directory(java.io.File(opt.cwd));
 end
+%% Gfortran streams
+% https://www.mathworks.com/matlabcentral/answers/91919-why-does-the-output-of-my-fortran-script-not-show-up-in-the-matlab-command-window-when-i-execute-it#answer_101270
+% Matlab grabs the stdout, stderr, stdin handles of a Gfortran program, even when it's using Java.
+% We must disable this behavior for the duration the running process.
+
+outold = getenv("GFORTRAN_STDOUT_UNIT");
+setenv("GFORTRAN_STDOUT_UNIT", "6");
+errold = getenv("GFORTRAN_STDERR_UNIT");
+setenv("GFORTRAN_STDERR_UNIT", "0");
+inold = getenv("GFORTRAN_STDIN_UNIT");
+setenv("GFORTRAN_STDIN_UNIT", "5");
 %% start process
 % https://docs.oracle.com/en/java/javase/21/docs/api/java.base/java/lang/ProcessBuilder.html#start()
 h = proc.start();
@@ -69,6 +80,10 @@
   writer.close()
 end
 
+%% read stdout, stderr pipes
+stdout = read_stream(h.getInputStream());
+stderr = read_stream(h.getErrorStream());
+
 %% wait for process to complete
 % https://docs.oracle.com/en/java/javase/23/docs/api/java.base/java/lang/Process.html#waitFor()
 
@@ -88,13 +103,13 @@
   status = h.waitFor();
 end
 
-%% read stdout, stderr pipes
-stdout = read_stream(h.getInputStream());
-stderr = read_stream(h.getErrorStream());
-
-%% close process
+%% close process and restore Gfortran streams
 h.destroy()
 
+setenv("GFORTRAN_STDOUT_UNIT", outold);
+setenv("GFORTRAN_STDERR_UNIT", errold);
+setenv("GFORTRAN_STDIN_UNIT", inold);
+
 stderr = tmsg + stderr;
 
 if nargout < 2 && strlength(stdout) > 0
@@ -110,9 +125,14 @@
 function msg = read_stream(stream)
 
 % https://docs.oracle.com/en/java/javase/21/docs/api/java.base/java/io/BufferedReader.html
+
+msg = "";
+
+% don't check stream.available() as it may arbitrarily return 0
+
 reader = java.io.BufferedReader(java.io.InputStreamReader(stream));
+
 line = reader.readLine();
-msg = "";
 while ~isempty(line)
   msg = append(msg, string(line), newline);
   line = reader.readLine();

.github/workflows/ci.yml

@@ -46,4 +46,8 @@ jobs:
       if: ${{ matrix.os == 'ubuntu-22.04' }}
       run: echo "CXXMEX=g++-10" >> $GITHUB_ENV
 
+    - name: Fortran FC
+      if: runner.os == 'macOS'
+      run: echo "FC=gfortran-14" >> $GITHUB_ENV
+
     - uses: ./.github/workflows/composite-buildtool

.gitignore

@@ -1,6 +1,6 @@
 Filesystem.class
 CodeIssues.sarif
-
+TestResults.xml
 code-coverage.xml
 
 .buildtool/
@@ -9,3 +9,6 @@ docs/
 
 *.mex*
 *.oct
+
+test/printer_c.exe
+test/printer_fortran.exe

buildfile.m

@@ -11,14 +11,22 @@
 
 if isMATLABReleaseOlderThan("R2023b")
   plan("test") = matlab.buildtool.Task(Actions=@legacy_test);
-else
+elseif isMATLABReleaseOlderThan("R2024a")
   plan("test") = matlab.buildtool.tasks.TestTask("test", Strict=false);
+else
   % can't use SourceFiles= if "mex" Task was run, even if plan("test").DisableIncremental = true;
   % this means incremental tests can't be used with MEX files (as of R2024b)
+  plan("test") = matlab.buildtool.tasks.TestTask("test", Strict=false, TestResults="TestResults.xml");
+end
 
+if ~isMATLABReleaseOlderThan("R2023b")
   plan("clean") = matlab.buildtool.tasks.CleanTask;
 end
 
+plan("build_c") = matlab.buildtool.Task(Actions=@subprocess_build_c);
+plan("build_fortran") = matlab.buildtool.Task(Actions=@subprocess_build_fortran);
+plan("test").Dependencies = ["build_c", "build_fortran"];
+
 if ~isMATLABReleaseOlderThan("R2024a")
   plan("check") = matlab.buildtool.tasks.CodeIssuesTask(pkg_name, IncludeSubfolders=true, ...
     WarningThreshold=0, Results="CodeIssues.sarif");
@@ -68,7 +76,7 @@ function legacy_mex(context, compiler_opt, linker_opt)
 
 
 function legacy_test(context)
-r = runtests(fullfile(context.Plan.RootFolder, "test"), Strict=false);
+r = runtests(context.Plan.RootFolder + "/test", Strict=false);
 % Parallel Computing Toolbox takes more time to startup than is worth it for this task
 
 assert(~isempty(r), "No tests were run")
@@ -78,7 +86,7 @@ function legacy_test(context)
 
 function publishTask(context)
 % publish HTML inline documentation strings to individual HTML files
-outdir = fullfile(context.Plan.RootFolder, "docs");
+outdir = context.Plan.RootFolder + "/docs";
 
 publish_gen_index_html("stdlib", ...
   "A standard library of functions for Matlab.", ...
@@ -87,6 +95,68 @@ function publishTask(context)
 end
 
 
+function subprocess_build_c(context)
+
+td = context.Plan.RootFolder + "/test";
+src_c = td + "/main.c";
+exe = td + "/printer_c.exe";
+
+ccObj = mex.getCompilerConfigurations('c');
+
+cc = ccObj.Details.CompilerExecutable;
+
+outFlag = "-o";
+shell = "";
+shell_arg = "";
+msvcLike = ispc && endsWith(cc, "cl");
+if msvcLike
+  shell = strtrim(ccObj.Details.CommandLineShell);
+  shell_arg = ccObj.Details.CommandLineShellArg;
+  outFlag = "/link /out:";
+end
+
+cmd = join([cc, src_c, outFlag, exe]);
+if shell ~= ""
+  cmd = join([shell, shell_arg, cmd]);
+end
+
+[r, m] = system(cmd);
+if r ~= 0
+  warning("failed to build TestSubprocess printer_c.exe " + m)
+end
+
+end
+
+
+function subprocess_build_fortran(context)
+
+td = context.Plan.RootFolder + "/test";
+src = td + "/main.f90";
+exe = td + "/printer_fortran.exe";
+
+fcObj = mex.getCompilerConfigurations('Fortran');
+if isempty(fcObj)
+  fc = getenv("FC");
+  if isempty(fc)
+    warning("set FC environment variable to the Fortran compiler executable, or do 'mex -setup fortran' to configure the Fortran compiler")
+    return
+  end
+else
+  fc = fcObj.Details.CompilerExecutable;
+end
+
+outFlag = "-o";
+
+cmd = join([fc, src, outFlag, exe]);
+
+[r, m] = system(cmd);
+if r ~= 0
+  warning("failed to build TestSubprocess printer_fortran.exe " + m)
+end
+
+end
+
+
 function srcs = get_mex_sources(build_all)
 arguments
   build_all (1,1) logical = false

test/TestSubprocess.m

@@ -9,18 +9,32 @@ function java_required(tc)
 
 methods (Test)
 
-function test_simple_run(tc)
+function test_exe_c(tc)
+import matlab.unittest.constraints.IsFile
+
+cwd = fileparts(mfilename('fullpath'));
+exe = cwd + "/printer_c.exe";
+tc.assumeThat(exe, IsFile, exe + " not found")
+
+[status, msg, err] = stdlib.subprocess_run(exe);
+tc.assertEqual(status, 0, err)
+tc.verifyEqual(msg, "stdout")
+tc.verifyEqual(err, "stderr")
 
-if ispc
-  c = ["cmd", "/c", "dir"];
-else
-  c = 'ls';
 end
 
-[status, msg, err] = stdlib.subprocess_run(c);
+
+function test_exe_fortran(tc)
+import matlab.unittest.constraints.IsFile
+
+cwd = fileparts(mfilename('fullpath'));
+exe = cwd + "/printer_fortran.exe";
+tc.assumeThat(exe, IsFile, exe + " not found")
+
+[status, msg, err] = stdlib.subprocess_run(exe);
 tc.assertEqual(status, 0, err)
-tc.verifyGreaterThan(strlength(msg),  0)
-tc.verifyEqual(strlength(err), 0)
+tc.verifyEqual(msg, "stdout")
+tc.verifyEqual(err, "stderr")
 
 end
 
@@ -41,7 +55,7 @@ function test_cwd(tc)
 
 td = tc.createTemporaryFolder();
 
-[s, mc, e] = stdlib.subprocess_run(c, "cwd", td);
+[s, mc, e] = stdlib.subprocess_run(c, cwd=td);
 tc.assertEqual(s, 0, "status non-zero")
 tc.verifyNotEqual(m, mc, "expected different directory to have different contents")
 tc.verifyEqual(strlength(e), 0, e)

test/main.c

@@ -1,6 +1,7 @@
 #include <stdio.h>
 
 int main(void){
-  printf("Hello\n");
+  printf("stdout\n");
+  fprintf(stderr, "stderr\n");
   return 0;
 }

test/main.f90

@@ -0,0 +1,10 @@
+program main
+
+use, intrinsic :: iso_fortran_env
+
+implicit none
+
+write(output_unit, '(a)') "stdout"
+write(error_unit, '(a)') "stderr"
+
+end program