feat(presets): support testPresets

Author: Denzel

lua/cmake-tools/config.lua

@@ -18,6 +18,7 @@ local Config = {
   kit = nil,
   configure_preset = nil,
   build_preset = nil,
+  test_preset = nil,
   base_settings = {
     env = {},
     build_dir = "",

lua/cmake-tools/init.lua

@@ -838,6 +838,54 @@ function cmake.select_configure_preset(callback)
   end
 end
 
+function cmake.select_test_preset(callback)
+  callback = type(callback) == "function" and callback
+    or function(result)
+      if result:is_ok() then
+        cmake.generate({ bang = false, fargs = {} }, nil)
+      end
+    end
+  if check_active_job_and_notify(callback) then
+    return
+  end
+
+  if get_cmake_configuration_or_notify(callback) == nil then
+    return
+  end
+
+  -- if exists presets
+  if Presets.exists(config.cwd) then
+    local presets = Presets:parse(config.cwd)
+    local test_preset_names = presets:get_test_preset_names()
+    local format_preset_name = function(p_name)
+      local p = presets:get_test_preset(p_name)
+      return p.displayName or p.name
+    end
+    vim.ui.select(
+      test_preset_names,
+      {
+        prompt = "Select cmake test preset",
+        format_item = format_preset_name,
+      },
+      vim.schedule_wrap(function(choice)
+        if not choice then
+          callback(Result:new_error(Types.NOT_SELECT_PRESET, "No test preset selected"))
+          return
+        end
+        if config.test_preset ~= choice then
+          config.test_preset = choice
+        end
+        callback(Result:new(Types.SUCCESS, nil, nil))
+      end)
+    )
+  else
+    callback(
+      Result:new_error(Types.CANNOT_FIND_PRESETS_FILE, "Cannot find CMake[User]Presets file")
+    )
+    log.error("Cannot find CMake[User]Presets.json at Root (" .. config.cwd .. ") !!")
+  end
+end
+
 function cmake.select_build_preset(callback)
   callback = type(callback) == "function" and callback
     or function(result)
@@ -1173,7 +1221,17 @@ function cmake.run_test(opt, callback)
   end
 
   local env = environment.get_build_environment(config)
-  ctest.list_all_tests(config:build_directory_path(), function(all_tests)
+  local preset_name = nil
+  if config.test_preset and Presets.exists(config.cwd) then
+    local presets = Presets:parse(config.cwd)
+    local test_preset = presets:get_test_preset(config.test_preset)
+    if test_preset and test_preset:isValid() then
+      preset_name = config.test_preset
+    end
+  end
+  local build_dir = config:build_directory_path()
+
+  ctest.list_all_tests(build_dir, preset_name, function(all_tests)
     if #all_tests == 0 then
       return
     end
@@ -1211,27 +1269,18 @@ function cmake.run_test(opt, callback)
         return
       end
       local selected = items[idx]
-      if selected.type == Type.ALL then
-        ctest.run(const.ctest_command, nil, config:build_directory_path(), env, config, opt)
-      elseif selected.type == Type.LABEL then
-        ctest.run(
-          const.ctest_command,
-          nil,
-          config:build_directory_path(),
-          env,
-          config,
-          vim.tbl_extend("force", opt, { label = selected.label })
-        )
-      else
-        ctest.run(
-          const.ctest_command,
-          selected.name,
-          config:build_directory_path(),
-          env,
-          config,
-          opt
-        )
+      local run_opt = vim.tbl_extend("force", opt, {
+        preset = preset_name,
+        build_dir = build_dir,
+      })
+
+      if selected.type == Type.LABEL then
+        run_opt.label = selected.label
+      elseif selected.type == Type.TEST then
+        run_opt.test_name = selected.name
       end
+
+      ctest.run(const.ctest_command, env, config, run_opt)
     end)
   end)
 end
@@ -1367,6 +1416,10 @@ function cmake.get_build_preset()
   return config.build_preset
 end
 
+function cmake.get_test_preset()
+  return config.test_preset
+end
+
 function cmake.get_build_directory()
   return config.build_directory
 end

lua/cmake-tools/presets.lua

@@ -1,6 +1,7 @@
 local Path = require("plenary.path")
 local Preset = require("cmake-tools.preset")
 local BuildPreset = require("cmake-tools.build_preset")
+local TestPreset = require("cmake-tools.test_preset")
 
 -- Extends (or creates a new) key-value pair in [dest] in which the
 -- key is [key] and the value is the resulting list table of merging
@@ -138,23 +139,26 @@ function Presets:parse(cwd)
     local function getPreset(name)
       return instance:get_configure_preset(name, { include_hidden = true, include_disabled = true })
     end
-    return Preset:new(cwd, obj, getPreset)
+    Preset:new(cwd, obj, getPreset)
   end
 
-  local function createBuildPreset(obj)
-    return BuildPreset:new(cwd, obj)
+  for _, preset in ipairs(instance.configurePresets) do
+    createPreset(preset)
   end
 
-  for _, preset in ipairs(instance.configurePresets) do
-    preset = createPreset(preset)
+  instance.testPresets = instance.testPresets or {}
+  for _, test_preset in ipairs(instance.testPresets) do
+    TestPreset.new(cwd, test_preset)
   end
 
+  table.insert(instance.testPresets, TestPreset.new(cwd, { name = "None", valid = false }))
+
   instance.buildPresets = instance.buildPresets or {}
   for _, build_preset in ipairs(instance.buildPresets) do
-    build_preset = createBuildPreset(build_preset)
+    BuildPreset:new(cwd, build_preset)
   end
 
-  table.insert(instance.buildPresets, createBuildPreset({ name = "None", valid = false }))
+  table.insert(instance.buildPresets, BuildPreset:new(cwd, { name = "None", valid = false }))
 
   return instance
 end
@@ -185,6 +189,10 @@ function Presets:get_configure_preset_names(opts)
   return get_preset_names(self.configurePresets, opts)
 end
 
+function Presets:get_test_preset_names(opts)
+  return get_preset_names(self.testPresets, opts)
+end
+
 function Presets:get_build_preset_names(opts)
   local presets = get_preset_names(self.buildPresets, opts)
   local ret = {}
@@ -227,6 +235,10 @@ function Presets:get_configure_preset(name, opts)
   return get_preset(name, self.configurePresets, opts)
 end
 
+function Presets:get_test_preset(name, opts)
+  return get_preset(name, self.testPresets, opts)
+end
+
 function Presets:get_build_preset(name, opts)
   return get_preset(name, self.buildPresets, { include_hidden = true, include_disabled = true })
 end

lua/cmake-tools/test/ctest.lua

@@ -5,12 +5,19 @@ local ctest = {
   job = nil,
 }
 
-function ctest.list_all_tests(build_dir, callback)
+function ctest.list_all_tests(build_dir, preset_name, callback)
   local result = {}
 
+  local args
+  if preset_name then
+    args = { "--preset", preset_name, "--show-only=json-v1" }
+  else
+    args = { "--test-dir", build_dir, "--show-only=json-v1" }
+  end
+
   ctest.job = Job:new({
     command = "ctest",
-    args = { "--test-dir", build_dir, "--show-only=json-v1" },
+    args = args,
     on_exit = function(j, _, _)
       vim.schedule(function()
         local json_data = ""
@@ -63,22 +70,27 @@ function ctest.get_all_labels(tests)
   return labels
 end
 
-function ctest.run(ctest_command, test_name, build_dir, env, config, opt)
-  local cmd = ctest_command
+function ctest.run(ctest_command, env, config, opt)
   opt = opt or {}
 
-  local args = { "--test-dir", utils.transform_path(build_dir) }
+  local args = {}
+  if opt.preset then
+    vim.list_extend(args, { "--preset", opt.preset })
+  else
+    vim.list_extend(args, { "--test-dir", utils.transform_path(opt.build_dir) })
+  end
+
   if opt.label then
-    table.insert(args, "-L")
-    table.insert(args, opt.label)
-  elseif test_name then
-    table.insert(args, "-R")
-    table.insert(args, test_name)
+    vim.list_extend(args, { "-L", opt.label })
+  elseif opt.test_name then
+    vim.list_extend(args, { "-R", opt.test_name })
   end
+
   if opt.args then
     table.insert(args, opt.args)
   end
-  utils.run(cmd, config.env_script, env, args, config.cwd, config.runner, nil)
+
+  utils.run(ctest_command, config.env_script, env, args, config.cwd, config.runner, nil)
 end
 
 function ctest.stop()

lua/cmake-tools/test_preset.lua

@@ -0,0 +1,21 @@
+---@class TestPreset: CMakeTestPreset
+local TestPreset = {}
+TestPreset.__index = TestPreset
+
+---@return TestPreset
+function TestPreset.new(cwd, obj)
+  local instance = setmetatable(obj or {}, TestPreset)
+  instance.cwd = cwd
+
+  if instance.valid == nil then
+    instance.valid = true
+  end
+
+  return instance
+end
+
+function TestPreset:isValid()
+  return self.valid
+end
+
+return TestPreset

lua/types/cmake-preset/condition.lua

@@ -0,0 +1,12 @@
+---@meta _
+
+---@class CMakeCondition
+---@field type "const"|"equals"|"notEquals"|"inList"|"notInList"|"matches"|"notMatches"|"anyOf"|"allOf"|"not"
+---@field value boolean?
+---@field lhs string?
+---@field rhs string?
+---@field string string?
+---@field list string[]?
+---@field regex string?
+---@field conditions CMakeCondition[]?
+---@field condition CMakeCondition?

lua/types/cmake-preset/test_preset.lua

@@ -0,0 +1,79 @@
+---@meta _
+
+---@class CMakeTestPresetOutputOpts
+---@field shortProgress boolean?
+---@field verbosity ("default"|"verbose"|"extra")?
+---@field debug boolean?
+---@field outputOnFailure boolean?
+---@field quiet boolean?
+---@field outputLogFile string?
+---@field outputJUnitFile string?
+---@field labelSummary boolean?
+---@field subprojectSummary boolean?
+---@field maxPassedTestOutputSize integer?
+---@field maxFailedTestOutputSize integer?
+---@field testOutputTruncation string?
+---@field maxTestNameWidth integer?
+
+---@class CMakeTestPresetFilterIncludeIndex
+---@field start integer?
+---@field end integer?
+---@field stride integer?
+---@field specificTests integer[]?
+
+---@class CMakeTestPresetFilterInclude
+---@field name string?
+---@field label string?
+---@field useUnion boolean?
+---@field index CMakeTestPresetFilterIncludeIndex|string?
+
+---@class CMakeTestPresetFilterExcludeFixtures
+---@field any string?
+---@field setup string?
+---@field cleanup string?
+
+---@class CMakeTestPresetFilterExclude
+---@field name string?
+---@field label string?
+---@field fixtures CMakeTestPresetFilterExcludeFixtures?
+
+---@class CMakeTestPresetFilter
+---@field include CMakeTestPresetFilterInclude?
+---@field exclude CMakeTestPresetFilterExclude?
+
+---@class CMakeTestPresetExecutionRepeat
+---@field mode "until-fail"|"until-pass"|"after-timeout"
+---@field count integer
+
+---@class CMakeTestPresetExecution
+---@field stopOnFailure boolean?
+---@field enableFailover boolean?
+---@field jobs integer?
+---@field resourceSpecFile string?
+---@field testLoad integer?
+---@field showOnly ("human"|"json-v1")?
+---@field repeat CMakeTestPresetExecutionRepeat?
+---@field interactiveDebugging boolean?
+---@field scheduleRandom boolean?
+---@field timeout integer?
+---@field noTestsAction ("default"|"error"|"ignore")?
+
+---@class CMakeTestPreset
+---@field name string
+---@field valid boolean
+---@field hidden boolean?
+---@field inherits string|string[]?
+---@field condition CMakeCondition?
+---@field vendor table?
+---@field displayName string?
+---@field description string?
+---@field environment table<string, string?>?
+---@field configurePreset string?
+---@field inheritConfigureEnvironment boolean?
+---@field configuration string?
+---@field overwriteConfigurationFile string[]?
+---@field output CMakeTestPresetOutputOpts?
+---@field filter CMakeTestPresetFilter?
+---@field execution CMakeTestPresetExecution?
+---@field disabled boolean?
+---@field cwd string