feat(ctest): add option to include labels into test selection

Author: Denzel

README.md

@@ -28,6 +28,7 @@ local osys = require("cmake-tools.osys")
 require("cmake-tools").setup {
   cmake_command = "cmake", -- this is used to specify cmake command path
   ctest_command = "ctest", -- this is used to specify ctest command path
+  ctest_show_labels = false, -- also show labels in the test picker
   cmake_use_preset = true,
   cmake_regenerate_on_save = true, -- auto generate when save CMakeLists.txt
   cmake_generate_options = { "-DCMAKE_EXPORT_COMPILE_COMMANDS=1" }, -- this will be passed when invoke `CMakeGenerate`

lua/cmake-tools/config.lua

@@ -26,6 +26,7 @@ local Config = {
     generate_options = {},
     build_options = {},
     show_disabled_build_presets = true,
+    ctest_show_labels = false,
   }, -- general config
   target_settings = {}, -- target specific config
   executor = nil,
@@ -45,6 +46,7 @@ function Config:new(const)
   obj.base_settings.use_preset = const.cmake_use_preset
 
   obj.base_settings.show_disabled_build_presets = const.cmake_show_disabled_build_presets
+  obj.base_settings.ctest_show_labels = const.ctest_show_labels
 
   obj.executor = const.cmake_executor
   obj.runner = const.cmake_runner
@@ -148,6 +150,10 @@ function Config:show_disabled_build_presets()
   return self.base_settings.show_disabled_build_presets
 end
 
+function Config:ctest_show_labels()
+  return self.base_settings.ctest_show_labels
+end
+
 function Config:generate_build_directory()
   local build_directory = Path:new(self.build_directory)
 

lua/cmake-tools/const.lua

@@ -2,6 +2,7 @@ local osys = require("cmake-tools.osys")
 local const = {
   cmake_command = "cmake", -- this is used to specify cmake command path
   ctest_command = "ctest", -- this is used to specify ctest command path
+  ctest_show_labels = false, -- show test labels in the test picker (when true, labels from ctest are shown as filterable entries)
   cmake_use_preset = true, -- when `false`, this is used to define if the `--preset` option should be use on cmake commands
   cmake_regenerate_on_save = true, -- auto generate when save CMakeLists.txt
   cmake_generate_options = { "-DCMAKE_EXPORT_COMPILE_COMMANDS=1" }, -- this will be passed when invoke `CMakeGenerate`

lua/cmake-tools/init.lua

@@ -1177,17 +1177,55 @@ function cmake.run_test(opt, callback)
     if #all_tests == 0 then
       return
     end
-    table.insert(all_tests, 1, "all")
-    vim.ui.select(all_tests, { prompt = "select test to run" }, function(_, idx)
+
+    local items = {}
+    local display = {}
+
+    local Type = {
+      ALL = 1,
+      LABEL = 2,
+      TEST = 3,
+    }
+
+    table.insert(items, { type = Type.ALL })
+    table.insert(display, "all")
+
+    if config:ctest_show_labels() then
+      local labels = ctest.get_all_labels(all_tests)
+      for _, entry in ipairs(labels) do
+        table.insert(items, { type = Type.LABEL, label = entry.label })
+        table.insert(
+          display,
+          table.concat({ "[label]", entry.label, "(" .. entry.count, "tests)" }, " ")
+        )
+      end
+    end
+
+    for _, test in ipairs(all_tests) do
+      table.insert(items, { type = Type.TEST, name = test.name })
+      table.insert(display, test.name)
+    end
+
+    vim.ui.select(display, { prompt = "select test to run" }, function(_, idx)
       if not idx then
         return
       end
-      if idx == 1 then
+      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,
-          all_tests[idx],
+          selected.name,
           config:build_directory_path(),
           env,
           config,

lua/cmake-tools/test/ctest.lua

@@ -1,6 +1,5 @@
 local Job = require("plenary.job")
 local utils = require("cmake-tools.utils")
-local const = require("cmake-tools.const")
 
 local ctest = {
   job = nil,
@@ -24,7 +23,16 @@ function ctest.list_all_tests(build_dir, callback)
 
         local tests = {}
         for _, item in ipairs(result.tests) do
-          table.insert(tests, item["name"])
+          local labels = {}
+          if item["properties"] then
+            for _, prop in ipairs(item["properties"]) do
+              if prop["name"] == "LABELS" then
+                labels = prop["value"] or {}
+                break
+              end
+            end
+          end
+          table.insert(tests, { name = item["name"], labels = labels })
         end
         callback(tests)
       end)
@@ -34,12 +42,36 @@ function ctest.list_all_tests(build_dir, callback)
   ctest.job:start()
 end
 
+--- Collect all labels from test objects with counts
+--- @param tests { name: string, labels: string[] }[]
+--- @return { label: string, count: number }[] sorted list of labels with their test counts
+function ctest.get_all_labels(tests)
+  local label_counts = {}
+  for _, test in ipairs(tests) do
+    for _, label in ipairs(test.labels) do
+      label_counts[label] = (label_counts[label] or 0) + 1
+    end
+  end
+
+  local labels = {}
+  for label, count in pairs(label_counts) do
+    table.insert(labels, { label = label, count = count })
+  end
+  table.sort(labels, function(a, b)
+    return a.label < b.label
+  end)
+  return labels
+end
+
 function ctest.run(ctest_command, test_name, build_dir, env, config, opt)
   local cmd = ctest_command
   opt = opt or {}
 
   local args = { "--test-dir", utils.transform_path(build_dir) }
-  if test_name then
+  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)
   end