Merge remote-tracking branch 'upstream/master' into chore/resources/keyboard3-epic-ldml

Author: srl295

HISTORY.md

@@ -1,5 +1,10 @@
 # Keyman Version History
 
+## 17.0.177 alpha 2023-09-20
+
+* chore(linux): Add coverage action to `ibus-keyman/build.sh` (#9583)
+* docs(common): Fix documentation for `builder_describe_internal_dependency` (#9582)
+
 ## 17.0.176 alpha 2023-09-19
 
 * chore(oem/fv/android): Update Gradle to 7.4 (#9590)

VERSION.md

@@ -1 +1 @@
-17.0.177
+17.0.178

docs/settings/linux/tasks.json

@@ -166,6 +166,23 @@
       "group": "build",
       "detail": "run unit and integration tests of ibus-keyman"
     },
+    {
+      "type": "shell",
+      "label": "ibus-keyman: report",
+      "command": "./build.sh",
+      "args": [
+        "test",
+        "--report",
+        "--debug",
+        "--coverage",
+        "--no-integration"
+      ],
+      "options": {
+        "cwd": "${workspaceFolder}/linux/ibus-keyman/",
+      },
+      "group": "build",
+      "detail": "run tests and create unit test coverage report"
+    },
     {
       "type": "shell",
       "label": "keyman-config: tests",

linux/ibus-keyman/build.sh

@@ -20,7 +20,9 @@ builder_describe \
   "install                   install artifacts" \
   "uninstall                 uninstall artifacts" \
   "@/core:arch" \
-  "--no-integration          don't run integration tests"
+  "--no-integration          don't run integration tests" \
+  "--report                  create coverage report" \
+  "--coverage                capture test coverage"
 
 builder_parse "$@"
 
@@ -40,6 +42,12 @@ builder_describe_outputs \
   configure "${MESON_PATH}/build.ninja" \
   build "${MESON_PATH}/src/ibus-engine-keyman"
 
+if builder_has_option --coverage; then
+  MESON_COVERAGE=-Db_coverage=true
+else
+  MESON_COVERAGE=
+fi
+
 if builder_start_action clean; then
   rm -rf "$THIS_SCRIPT_PATH/../build/"
   builder_finish_action success clean
@@ -48,7 +56,7 @@ fi
 if builder_start_action configure; then
   cd "$THIS_SCRIPT_PATH"
   # shellcheck disable=SC2086
-  meson setup "$MESON_PATH" --werror --buildtype $MESON_TARGET "${builder_extra_params[@]}"
+  meson setup "$MESON_PATH" --werror --buildtype $MESON_TARGET ${MESON_COVERAGE} "${builder_extra_params[@]}"
   builder_finish_action success configure
 fi
 
@@ -65,6 +73,10 @@ if builder_start_action test; then
   else
     meson test --print-errorlogs $builder_verbose
   fi
+  if builder_has_option --coverage; then
+    # Note: requires lcov > 1.16 to properly work (see https://github.com/mesonbuild/meson/issues/6747)
+    ninja coverage-html
+  fi
   builder_finish_action success test
 fi
 

resources/build/build-utils.md

@@ -510,8 +510,8 @@ builder_describe_internal_dependency action:target depaction:deptarget ...
 
 ```bash
 builder_describe_internal_dependency \
-  mac:build mac-x86_64:build \
-  mac:build mac-arm64:build
+  build:mac build:mac-x86_64 \
+  build:mac build:mac-arm64
 ```
 
 **Note:** actions and targets must be fully specified, and this _must_ be called

resources/builder.inc.sh

@@ -1143,8 +1143,8 @@ _builder_define_default_internal_dep() {
 #   2: depaction:deptarget   The dependency action and target
 # Example:
 #   builder_describe_internal_dependency \
-#     mac:build mac-x86_64:build \
-#     mac:build mac-arm64:build
+#     build:mac build:mac-x86_64 \
+#     build:mac build:mac-arm64
 #
 # Note: actions and targets must be fully specified, and this _must_
 # be called before either builder_describe_outputs or builder_parse in