buildtool: functionalize, use incremental build

test:subprocess: env make own executable

Author: scivision

.github/workflows/ci-nojvm.yml

@@ -34,4 +34,8 @@ jobs:
 
     - uses: ./.github/workflows/composite-install-matlab
 
+    - name: Fortran FC
+      if: runner.os == 'macOS'
+      run: echo "FC=gfortran-14" >> $GITHUB_ENV
+
     - uses: ./.github/workflows/composite-buildtool

.gitignore

@@ -10,6 +10,7 @@ docs/
 *.mex*
 *.oct
 
+test/printenv.exe
 test/stdout_stderr_c.exe
 test/stdout_stderr_fortran.exe
 test/stdin_cpp.exe

buildfile.m

@@ -9,6 +9,7 @@
 
 addpath(plan.RootFolder)
 
+%% Self-test setup
 if isMATLABReleaseOlderThan("R2023b")
   plan("test") = matlab.buildtool.Task(Actions=@legacy_test);
 elseif isMATLABReleaseOlderThan("R2024a")
@@ -19,19 +20,25 @@
   plan("test") = matlab.buildtool.tasks.TestTask("test", Strict=false, TestResults="TestResults.xml");
 end
 
+td = plan.RootFolder + "/test";
+srcs = [td+"/stdout_stderr_c.c", td+"/stdin_cpp.cpp", td+"/printenv.cpp"];
+exes = [td+"/stdout_stderr_c.exe", td+"/stdin_cpp.exe", td+"/printenv.exe"];
+if ~isempty(get_compiler("fortran"))
+  srcs = [srcs, td + "/stdout_stderr_fortran.f90", td + "/stdin_fortran.f90"];
+  exes = [exes, td+"/stdout_stderr_fortran.exe", td+"/stdin_fortran.exe"];
+end
+plan("exe") = matlab.buildtool.Task(Inputs=srcs, Outputs=exes, Actions=@build_exe);
+plan("test").Dependencies = "exe";
+
 if ~isMATLABReleaseOlderThan("R2023b")
   plan("clean") = matlab.buildtool.tasks.CleanTask;
 end
 
-plan("build_c") = matlab.buildtool.Task(Actions=@subprocess_build_c);
-plan("build_cpp") = matlab.buildtool.Task(Actions=@subprocess_build_cpp);
-plan("build_fortran") = matlab.buildtool.Task(Actions=@subprocess_build_fortran);
-plan("test").Dependencies = ["build_c", "build_cpp", "build_fortran"];
-
 if ~isMATLABReleaseOlderThan("R2024a")
   plan("check") = matlab.buildtool.tasks.CodeIssuesTask(pkg_name, IncludeSubfolders=true, ...
     WarningThreshold=0, Results="CodeIssues.sarif");
- plan("coverage") = matlab.buildtool.tasks.TestTask(Description="code coverage", Dependencies="clean", SourceFiles="test", Strict=false, CodeCoverageResults="code-coverage.xml");
+
+  plan("coverage") = matlab.buildtool.tasks.TestTask(Description="code coverage", Dependencies="clean", SourceFiles="test", Strict=false, CodeCoverageResults="code-coverage.xml");
 end
 
 %% MexTask
@@ -51,11 +58,8 @@
   % name of MEX target function is name of first source file
   if isMATLABReleaseOlderThan("R2024b")
     mex_name = "mex_" + name;
-    % specifying .Inputs and .Outputs enables incremental builds
-    % https://www.mathworks.com/help/matlab/matlab_prog/improve-performance-with-incremental-builds.html
-    plan(mex_name) = matlab.buildtool.Task(Actions=@(context) legacy_mex(context, compiler_opt, linker_opt));
-    plan(mex_name).Inputs = src;
-    plan(mex_name).Outputs = fullfile(bindir, name + "." + mexext());
+    plan(mex_name) = matlab.buildtool.Task(Inputs=src, Outputs=fullfile(bindir, name + "." + mexext()), ...
+      Actions=@(context) legacy_mex(context, compiler_opt, linker_opt));
     mex_deps(end+1) = mex_name; %#ok<AGROW>
   else
     plan("mex:" + name) = matlab.buildtool.tasks.MexTask(src, bindir, ...
@@ -96,112 +100,89 @@ function publishTask(context)
 end
 
 
-function subprocess_build_c(context)
+function build_exe(context)
 
-td = context.Plan.RootFolder + "/test";
-src = td + "/stdout_stderr_c.c";
+for i = 1:length(context.Task.Inputs)
+  src = context.Task.Inputs(i);
+  exe = context.Task.Outputs(i).paths;
+  exe = exe(1);
 
-for s = src
-  [~, n] = fileparts(s);
-  exe = fullfile(td, n + ".exe");
-  if stdlib.get_modtime(s) < stdlib.get_modtime(exe)
-    continue
+  [~,~,ext] = fileparts(src.paths);
+  switch ext
+    case ".c", lang = "c";
+    case ".cpp", lang = "c++";
+    case ".f90", lang = "fortran";
+    otherwise, error("unknown code suffix " + ext)
   end
 
-  cmd = get_build_cmd("c++", s);
-  if isempty(cmd), return, end
-  cmd = cmd + exe;
-  disp(cmd)
-  [r, m] = system(cmd);
-  if r ~= 0
-    disp("failed to build TestSubprocess " + exe + " " + m)
-  end
-end
-
-end
-
-
-function subprocess_build_cpp(context)
-
-td = context.Plan.RootFolder + "/test";
-src = [td + "/sleep.cpp", td + "/stdin_cpp.cpp"];
+  [comp, shell, outFlag] = get_build_cmd(lang);
+  if isempty(comp), return, end
 
-for s = src
-  [~, n] = fileparts(s);
-  exe = fullfile(td, n + ".exe");
-  if stdlib.get_modtime(s) < stdlib.get_modtime(exe)
-    continue
+  cmd = join([comp, src.paths, outFlag + exe]);
+  if ~isempty(shell)
+    cmd = join([shell, "&&", cmd]);
   end
 
-  cmd = get_build_cmd("c++", s);
-  if isempty(cmd), return, end
-  cmd = cmd + exe;
   disp(cmd)
-  [r, m] = system(cmd);
-  if r ~= 0
-    disp("failed to build TestSubprocess " + exe + " " + m)
-  end
+  system(cmd);
 end
 
 end
 
 
-function subprocess_build_fortran(context)
+function [comp, shell] = get_compiler(lang)
 
-td = context.Plan.RootFolder + "/test";
-src = [td + "/stdout_stderr_fortran.f90", td + "/stdin_fortran.f90"];
+lang = lower(lang);
 
-for s = src
-  [~, n] = fileparts(s);
-  exe = fullfile(td, n + ".exe");
-  if stdlib.get_modtime(s) < stdlib.get_modtime(exe)
-    continue
+co = mex.getCompilerConfigurations(lang);
+
+if isempty(co)
+  switch lang
+    case "fortran"
+      comp = getenv("FC");
+      if isempty(comp)
+        disp("set FC environment variable to the Fortran compiler path, or do 'mex -setup fortran'")
+      end
+    case "c++"
+      comp = getenv("CXX");
+      if isempty(comp)
+        disp("set CXX environment variable to the C++ compiler path, or do 'mex -setup c++")
+      end
+    case "c"
+      comp = getenv("CC");
+      if isempty(comp)
+        disp("set CC environment variable to the C compiler path, or do 'mex -setup c'")
+      end
+    otherwise, error("language not known " + lang)
   end
+else
+  comp = co.Details.CompilerExecutable;
+  disp(lang + " compiler: " + co.ShortName + " " + co.Name + " " + co.Version + " " + comp)
+end
 
-  cmd = get_build_cmd("Fortran", s);
-  if isempty(cmd), return, end
-  cmd = cmd + exe;
-  disp(cmd)
-  [r, m] = system(cmd);
-  if r ~= 0
-    disp("failed to build TestSubprocess " + exe + " " + m)
+
+shell = string.empty;
+if ispc
+  disp("Shell: " + co.Details.CommandLineShell)
+  if any(startsWith(co.ShortName, ["INTEL", "MSVC"]))
+    shell = join([strcat('"',string(co.Details.CommandLineShell),'"'), ...
+                co.Details.CommandLineShellArg], " ");
   end
 end
 
 end
 
 
-function cmd = get_build_cmd(lang, src)
+function [comp, shell, outFlag] = get_build_cmd(lang)
 
-cmd = string.empty;
+outFlag = "-o";
 
-co = mex.getCompilerConfigurations(lang);
-if isempty(co)
-  if lang == "Fortran"
-    fc = getenv("FC");
-    if isempty(fc)
-      disp("set FC environment variable to the Fortran compiler executable, or do 'mex -setup fortran' to configure the Fortran compiler")
-    end
-  end
-  disp(lang + " compiler not found")
-  return
-else
-  comp = co.Details.CompilerExecutable;
-end
+[comp, shell] = get_compiler(lang);
 
-outFlag = "-o";
-shell = string.empty;
-msvcLike = ispc && (contains(co.Name, "Visual Studio"));
-if msvcLike
-  shell = join([strcat('"',string(co.Details.CommandLineShell),'"'), ...
-                co.Details.CommandLineShellArg], " ");
+if ~isempty(shell)
   outFlag = "/Fo" + tempdir + " /link /out:";
 end
 
-cmd = join([comp, src, outFlag]);
-if ~isempty(shell)
-  cmd = join([shell, "&&", cmd]);
-end
 
 end
 

test/TestSubprocess.m

@@ -68,22 +68,19 @@ function test_cwd(tc)
 
 
 function test_env_run(tc)
+import matlab.unittest.constraints.IsFile
+
+cwd = fileparts(mfilename('fullpath'));
+exe = cwd + "/printenv.exe";
+tc.assumeThat(exe, IsFile, exe + " not found")
 
 names = ["TEST1", "TEST2"];
 vals = ["test123", "test321"];
 
 env = struct(names(1), vals(1), names(2), vals(2));
 
 for i = 1:length(names)
-  if ispc
-    % in ComSpec, echo is a special shell cmd like "dir" -- also doesn't
-    % work in python subprocess.run
-    cmd = ["pwsh", "-c", "(Get-ChildItem Env:" + names(i) + ").Value"];
-  else
-    cmd = ["sh", "-c", "echo $" + names(i)];
-  end
-
-  [ret, out] = stdlib.subprocess_run(cmd, "env", env);
+  [ret, out] = stdlib.subprocess_run([exe, names(i)], env=env);
   tc.verifyEqual(ret, 0)
   tc.verifySubstring(out, vals(i))
 end

test/printenv.cpp

@@ -0,0 +1,26 @@
+#include <cstdlib>
+#include <iostream>
+
+#ifdef _MSC_VER
+#pragma warning(disable : 4996)
+#endif
+
+
+int main(int argc, char *argv[]) {
+
+  if (argc < 2) {
+    std::cerr << "Specify environment variable name to print\n";
+    return EXIT_FAILURE;
+  }
+
+  char *value = std::getenv(argv[1]);
+
+  if (value) {
+    std::cout << value << "\n";
+    return EXIT_SUCCESS;
+  }
+
+  std::cerr << "Environment variable " << argv[1] << " not found\n";
+  return EXIT_FAILURE;
+
+}