How to test artifacts from pull requests for Keyman for Linux

Each pull request (PR) that touches files from Keyman for Linux or core processor gets build on our Jenkins continuous integration server. Testing those packages requires some manual steps.

Prerequisites

• create an account on Jenkins (see below)

Downloading and installing PR packages

Downloading

To download the build artifacts for Linux it is easiest to follow the "Test Artifacts" link in the "User Test Results" comment of the PR. After downloading, unzip the files.

Alternative ways

Expand to see alternative ways to install build artifacts for Linux

1. Another way to download the build artifacts for Linux is click on the link on the PR popup on the Keyman status page, and then unzip the files.

2. go through status section of PR on GitHub

Another option is to look in the status section of the PR on GitHub and click on the "Details" link behind "Test: Keyman packaging (Linux)":

Note: Do not use the "Test-14.0 (Keyman - Linux)" link.

On the PR build page on Jenkins click on the "Build Artifacts" link at the top:

You can either download all artifacts in a zip file, or click on the "results" link and then download only the packages for your Ubuntu version.

If you downloaded all artifacts, unpack the zip file.

Installing

You can install the packages in a terminal window with:

cd $HOME/Downloads/archive/results # replace with the location of the .deb files
sudo apt update
sudo dpkg -i \
{ibus-keyman,libkmnkbp0}*$(lsb_release -s -c)*$(dpkg --print-architecture).deb \
{keyman,python3-keyman-config}*$(lsb_release -s -c)*all.deb
sudo apt install -f

Afterwards reboot the machine.

Note: Don't be alarmed if you get an error message from the dpkg step that processing python3-keyman-config failed (and also keyman) failed - that is expected because dpkg doesn't automatically install the required dependencies. The next step (sudo apt install -f) will rectify this and install the dependencies.

Sanity check

Before running more detailed tests, please run a quick sanity check to verify things are in the expected state:

• open the Keyman Configuration window: from the launcher, enter Keyman Configuration. Alternatively from the command line run km-config.
• install any Keyman keyboard, either from keyman.com (Download button), or from a local .kmp file (Install button)
• verify that the keyboard appears in the dropdown with installed keyboards:

If the keyboard doesn't appear in the dropdown list

• open a terminal window and run ps -C ibus-daemon -f. Paste the output in a pull request comment.
• then reboot
• and check the dropdown again

If it still doesn't appear, scream for help - something is likely wrong with the system 😄

Creating an account on Jenkins

In order to be able to download artifacts you need an account on the Jenkins continuous integration server. Please use firstname_lastname in all lowercase characters as account name. After account creation send an email to gerrit at sil.org with your username so that you can be given the necessary permissions.