diff --git a/docs/build/macos.md b/docs/build/macos.md
index f5ff040964..aa1eea34bf 100644
--- a/docs/build/macos.md
+++ b/docs/build/macos.md
@@ -1,6 +1,8 @@
# Setup your Keyman build environment on macOS
-This document describes prerequisites and tools required for building various Keyman projects on macOS. Each project will also have additional notes linked below.
+This document describes prerequisites and tools required for building various
+Keyman projects on macOS. Each project will also have additional notes linked
+below.
## Target Projects
@@ -10,6 +12,7 @@ On macOS, you can build the following projects:
* Keyman for iOS ([additional details](../../ios/README.md))
* Keyman for macOS ([additional details](../../mac/README.md))
* KeymanWeb ([additional details](../../web/README.md))
+* Keyman Developer Command Line Tools (kmc)
The following libraries can also be built:
@@ -20,19 +23,24 @@ The following projects **cannot** be built on macOS:
* Keyman for Linux
* Keyman for Windows
-* Keyman Developer
+* Keyman Developer (IDE component)
## System Requirements
* Minimum macOS version: macOS Catalina 10.15 or Big Sur 11.0
-**Note:** to make a fully M1-compatible release build of Keyman for macOS (for the setup Applescript), Big Sur 11.0 is required, as osacompile on earlier versions does not build for arm64 (M1). The build will still work on earlier versions, but the installer won't be able to run on M1 Macs that do not have Rosetta 2 installed.
+**Note:** to make a fully M1-compatible release build of Keyman for macOS (for
+the setup Applescript), Big Sur 11.0 is required, as osacompile on earlier
+versions does not build for arm64 (M1). The build will still work on earlier
+versions, but the installer won't be able to run on M1 Macs that do not have
+Rosetta 2 installed.
## Prerequisites
Many dependencies are only required for specific projects.
-* XCode (iOS, macOS) 12.4 or later
+* XCode (iOS, macOS) 12.4 or later is needed only for Keyman for macOS and Keyman
+ for iOS.
* Install from App Store
* Accept the Xcode license: `sudo xcodebuild -license accept`
@@ -48,73 +56,83 @@ These dependencies are also listed below if you'd prefer to install manually.
## Shared Dependencies
-* Shared: HomeBrew, Bash 5.0+, jq, Python 2.7, Python 3, Meson, Ninja, coreutils, Pandoc
+* HomeBrew, Bash 5.0+, jq, Python 2.7, Python 3, Meson, Ninja, coreutils, Pandoc
+
+```shell
+/bin/bash -c "$(curl -fsSL https://raw.githubusercontent.com/Homebrew/install/HEAD/install.sh)"
+brew install bash jq python3 meson ninja coreutils pandoc pyenv
+# Python 2.7 required for DeviceKit (among others?) at present
+pyenv install 2.7.18
+pyenv global 2.7.18
+echo 'eval "$(pyenv init --path)"' >> ~/.bash_profile
+```
+
+On macOS, you will need to adjust your PATH so that coreutils’ `realpath` takes
+precedence over the BSD one:
+
+```shell
+# Credit: brew info coreutils
+PATH="$HOMEBREW_PREFIX/opt/coreutils/libexec/gnubin:$PATH"
+```
+
+## KeymanWeb Dependencies
+
+* node.js 18+, emscripten, openjdk 8
+
+```shell
+brew install node emscripten openjdk@8
+```
+
+Note: if you install emscripten with brew on macOS, only emscripten binaries are
+added to the path via symlinks. This makes it reasonably safe to have emscripten
+on the path, unlike on other platforms where emscripten also ends up adding its
+versions of node, python, and other binaries to the path.
+
+## Keyman for iOS Dependencies
+
+* XCode, swiftlint, carthage
+
+```shell
+brew install swiftlint carthage
+```
+
+## Keyman for Mac Dependencies
+
+* XCode, carthage, cocoapods
+
+```shell
+brew install carthage cocoapods
+```
+
+## Keyman for Android Dependencies
+
+* openjdk 11, Android SDK, Android Studio, Ant, Gradle, Maven
+
+```shell
+brew install openjdk@11 android-sdk android-studio ant gradle maven
+# update path
+source ../resources/devbox/macos/keyman.macos.env.sh
+# optionally install sdk images
+sdkmanager "system-images;android-30;google_apis;armeabi-v7a"
+sdkmanager --update
+sdkmanager --licenses
+```
+
+* Note: Run Android Studio once after installation to install additional
+components such as emulator images and SDK updates.
+
+## Keyman Developer Command Line (kmc)
+
+* node.js, emscripten
+
+```shell
+brew install node emscripten
+```
+
+## Optional Tools
+
+* sentry-cli: Uploading symbols for Sentry-based error reporting
```shell
- /bin/bash -c "$(curl -fsSL https://raw.githubusercontent.com/Homebrew/install/HEAD/install.sh)"
- brew install bash jq python3 meson ninja coreutils pandoc pyenv
- # Python 2.7 required for DeviceKit (among others?) at present
- pyenv install 2.7.18
- pyenv global 2.7.18
- echo 'eval "$(pyenv init --path)"' >> ~/.bash_profile
- ```
-
- On macOS, you will need to adjust your PATH so that coreutils’ `realpath` takes precedence over the BSD one:
-
- ```shell
- # Credit: brew info coreutils
- PATH="$HOMEBREW_PREFIX/opt/coreutils/libexec/gnubin:$PATH"
- ```
-
-* Web: node.js 18+, emscripten, openjdk 8
-
- ```shell
- brew install node emscripten openjdk@8
- ```
-
- Note: if you install emscripten with brew on macOS, only emscripten binaries
- are added to the path via symlinks. This makes it reasonably safe to have
- emscripten on the path, unlike on other platforms where emscripten also ends
- up adding its versions of node, python, and other binaries to the path.
-
-* iOS: swiftlint, carthage
-
- ```shell
- brew install swiftlint carthage
- ```
-
-* macOS: carthage, cocoapods
-
- ```shell
- brew install carthage cocoapods
- ```
-
-* Android: openjdk 8, Android SDK, Android Studio, Ant, Gradle, Maven
-
- ```shell
- brew install openjdk@8 android-sdk android-studio ant gradle maven
- # update path
- source ../resources/devbox/macos/keyman.macos.env.sh
- # optionally install sdk images
- sdkmanager "system-images;android-30;google_apis;armeabi-v7a"
- sdkmanager --update
- sdkmanager --licenses
- ```
-
-* kmc (optional): node
- - Required to build keyboards using kmc
-
- ```bash
- brew tap homebrew/cask-versions
- brew install --cask --no-quarantine wine-stable
- ```
-
-* sentry-cli (optional)
- - Uploading symbols for Sentry-based error reporting
-
- ```
brew install getsentry/tools/sentry-cli
```
-
-* Run Android Studio once after installation to install additional components
- such as emulator images and SDK updates.
diff --git a/docs/linux/README.md b/docs/linux/README.md
index d848e215ed..fe29b0d623 100644
--- a/docs/linux/README.md
+++ b/docs/linux/README.md
@@ -87,6 +87,39 @@ scripts/run-tests
The `run-tests` script accepts different arguments which can be seen with
`scripts/run-tests --help`.
+### Code Coverage Report
+
+#### Prerequisites
+
+Code coverage reports require some additional tools: lcov, gcovr,
+libdatetime-perl, and coverage.
+
+You can install these with:
+
+```bash
+sudo apt update
+sudo apt install -y lcov libdatetime-perl gcovr
+pip3 install coverage
+```
+
+**Note:** You want lcov > 1.16, so you might have to download and install
+a newer version e.g. from
.
+
+#### Creating and displaying code coverage reports
+
+All three projects (ibus-keyman, keyman-config, and keyman-system-service)
+can produce code coverage reports.
+
+Run `./build.sh --debug --coverage --report test` to create the report.
+
+**Note:** You might have to run `./build.sh clean` first.
+
+There's also an index page (`linux/CodecoverageReports.html`) that links to all
+three reports. You can run
+`linux/build.sh --debug --coverage --report --open --no-integration test`
+to create the coverage reports for all three Linux projects and open the
+index page in the browser.
+
## Running Keyman for Linux
### Setting up Ibus
diff --git a/docs/settings/linux/tasks.json b/docs/settings/linux/tasks.json
index b4a376b508..0d026c5afc 100644
--- a/docs/settings/linux/tasks.json
+++ b/docs/settings/linux/tasks.json
@@ -108,7 +108,7 @@
"CPPFLAGS": "-DG_MESSAGES_DEBUG -I${workspaceFolder}/core/build/arch/debug/include/ -I${workspaceFolder}/core/include/ -I/home/eberhard/Develop/keyman/ibus/ibus/src -I${workspaceFolder}/common/include",
"CFLAGS": "-g -O0",
"CXXFLAGS": "-g -O0",
- "KEYMAN_PROC_LIBS": "-L${workspaceFolder}/core/build/arch/debug/src -lkmnkbp0",
+ "KEYMAN_PROC_LIBS": "-L${workspaceFolder}/core/build/arch/debug/src -lkeymancore",
"KEYMAN_PROC_CFLAGS": "-I${workspaceFolder}/core/build/arch/debug/include -I${workspaceFolder}/core/include -I${workspaceFolder}/common/include",
"PKG_CONFIG_PATH": "${workspaceFolder}/core/build/arch/debug/meson-private"
},
@@ -195,6 +195,23 @@
"group": "test",
"detail": "unit test keyman-config"
},
+ {
+ "type": "shell",
+ "label": "keyman-config: report",
+ "command": "${workspaceFolder}/linux/keyman-config/build.sh",
+ "args": [
+ "test",
+ "--report",
+ "--debug",
+ "--coverage",
+ "--no-integration"
+ ],
+ "options": {
+ "cwd": "${workspaceFolder}/linux/keyman-config",
+ },
+ "group": "test",
+ "detail": "run tests and create unit test coverage report"
+ },
{
"type": "shell",
"label": "keyman-system-service: clean",
@@ -265,6 +282,7 @@
"command": "${workspaceFolder}/linux/keyman-system-service/build.sh",
"args": [
"--debug",
+ "--coverage",
"configure"
],
"options": {
@@ -282,7 +300,7 @@
"command": "${workspaceFolder}/linux/keyman-system-service/build.sh",
"args": [
"--debug",
- "test:arch"
+ "test"
],
"problemMatcher": [
"$gcc"
@@ -290,5 +308,22 @@
"group": "test",
"detail": "run tests for keyman-system-service"
},
+ {
+ "type": "shell",
+ "label": "keyman-system-service: report",
+ "command": "${workspaceFolder}/linux/keyman-system-service/build.sh",
+ "args": [
+ "test",
+ "--report",
+ "--debug",
+ "--coverage",
+ "--no-integration",
+ ],
+ "problemMatcher": [
+ "$gcc"
+ ],
+ "group": "test",
+ "detail": "run tests and create unit test coverage report"
+ },
]
}
diff --git a/linux/CodeCoverageReports.html b/linux/CodeCoverageReports.html
new file mode 100644
index 0000000000..d52d27d056
--- /dev/null
+++ b/linux/CodeCoverageReports.html
@@ -0,0 +1,37 @@
+
+
+ Keyman for Linux Code Coverage
+
+
+
+
+
+
Keyman for Linux Code Coverage Reports
+
+
+
+
+
+