Tests: Add tests for global shortcuts in X11

Author: hluk

.github/workflows/build-linux.yml

@@ -23,6 +23,7 @@ env:
 
     xvfb
     openbox
+    xdotool
   qt6_packages: >-
     libegl-dev
 
@@ -60,6 +61,9 @@ env:
 
     libkf5notifications-dev
     extra-cmake-modules
+  # FIXME: Sending signal to client process does not cause the process
+  # to exit with non-zero code with GitHub Actions. Why?
+  COPYQ_TESTS_SKIP_SIGNAL: '1'
 
 jobs:
   build:
@@ -166,7 +170,6 @@ jobs:
           # Remove system and 3rd party files
           lcov --remove coverage-full.info \
               '/usr/*' \
-              '*/qxt/*' \
               '*/plugins/itemfakevim/fakevim/*' \
               '*/src/gui/fix_icon_id.h' \
               --output-file coverage.info

utils/github/test-linux-global-shortcuts.sh

@@ -0,0 +1,54 @@
+#!/bin/bash
+# Tests global shortcuts on X11.
+set -xeuo pipefail
+
+export COPYQ_SESSION_NAME=__COPYQ_SHORTCUT
+
+source "$(dirname "$0")/test-start-server.sh"
+trap "kill $copyq_pid || true" QUIT TERM INT HUP EXIT
+
+./copyq removeTab TEST || true
+
+# register Ctrl+Alt+T to exit CopyQ
+./copyq - <<EOF
+setCommands(
+    [
+        {
+            name: "Test Command",
+            cmd: "copyq tab TEST add TEST",
+            globalShortcuts: ["ctrl+alt+t"],
+            isGlobalShortcut: true,
+        }
+    ]
+)
+EOF
+sleep 2
+
+trigger_shortcut() {
+    xdotool \
+        keydown Control_L \
+        keydown Alt_L \
+        key t \
+        keyup Alt_L \
+        keyup Control_L
+}
+
+trigger_shortcut
+
+if [[ $(./copyq tab TEST count) == 1 ]]; then
+    echo "✅ PASSED: Global shortcut registered: Command executed"
+else
+    echo "❌ FAILED: Global shortcut registered: Command not executed"
+    exit 1
+fi
+
+# Unregister the shortcut
+./copyq 'setCommands([])'
+trigger_shortcut
+
+if [[ $(./copyq tab TEST count) == 1 ]]; then
+    echo "✅ PASSED: Global shortcut unregistered: Command not executed"
+else
+    echo "❌ FAILED: Global shortcut unregistered: Command executed"
+    exit 1
+fi

utils/github/test-linux.sh

@@ -22,8 +22,10 @@ sleep 8
 ./copyq --start-server exit
 
 # Test handling Unix signals.
-script_root="$(dirname "$(readlink -f "$0")")"
-"$script_root/test-signals.sh"
+"$(dirname "$0")/test-signals.sh"
+
+# Test global shortcuts on X11.
+"$(dirname "$0")/test-linux-global-shortcuts.sh"
 
 # Run tests.
 export COPYQ_TESTS_RERUN_FAILED=1

utils/github/test-signals.sh

@@ -2,46 +2,40 @@
 # Tests for handling Unix signals.
 set -xeuo pipefail
 
-# Enable verbose logging.
-export COPYQ_LOG_LEVEL=DEBUG
-export QT_LOGGING_RULES="*.debug=true;qt.*.debug=false;qt.*.warning=true"
 export COPYQ_SESSION_NAME=__COPYQ_SIGTEST
 
+source "$(dirname "$0")/test-start-server.sh"
+
 exit_code=0
 
-./copyq &
-copyq_pid=$!
+# Test interrupting a long sleep command
+if [[ ${COPYQ_TESTS_SKIP_SIGNAL:-0} == "1" ]]; then
+    echo "⚠️ Skipping signal test"
+else
+    ./copyq 'sleep(100000)' &
+    copyq_sleep_pid=$!
 
-# Wait for server to start
-for i in {1..3}; do
-    echo "Trying to start CopyQ server ($i)"
-    if ./copyq 'serverLog("Server started")'; then
-        break
-    elif [[ $i == 5 ]]; then
-        echo "❌ FAILED: Could not start CopyQ server"
-        exit 1
-    fi
-    sleep $((i * 2))
-done
+    sigterm=15
+    expected_exit_code=$((128 + sigterm))
 
-sigterm=15
-expected_exit_code=$((128 + sigterm))
-script_pid=$$
-{
     sleep 2
     if ! pkill -$sigterm -f '^\./copyq sleep\(100000\)$'; then
         echo "❌ FAILED: Could not send SIGTERM to the command"
-        kill $script_pid $copyq_pid
+        kill $copyq_sleep_pid
+        exit_code=1
     fi
-} &
-if ./copyq 'sleep(100000)'; then
-    echo "❌ FAILED: Interrupt sleep: should exit with an error"
-else
-    actual_exit_code=$?
-    if [[ $actual_exit_code == $expected_exit_code ]]; then
-        echo "✅ PASSED: Interrupt sleep: exited with an error as expected"
+
+    if wait $copyq_sleep_pid; then
+        echo "❌ FAILED: Interrupt sleep: should exit with an error"
+        exit_code=1
     else
-        echo "❌ FAILED: Interrupt sleep: expected exit code $expected_exit_code, got $actual_exit_code"
+        actual_exit_code=$?
+        if [[ $actual_exit_code == $expected_exit_code ]]; then
+            echo "✅ PASSED: Interrupt sleep: exited with an error as expected"
+        else
+            echo "❌ FAILED: Interrupt sleep: expected exit code $expected_exit_code, got $actual_exit_code"
+            exit_code=1
+        fi
     fi
 fi
 
@@ -51,7 +45,7 @@ copyq_sleep_pid=$!
 ./copyq 'while(true){read(9999999);}' &
 copyq_loop_pid=$!
 
-trap "kill -9 $copyq_sleep_pid $copyq_loop_pid" TERM INT
+trap "kill -9 $copyq_sleep_pid $copyq_loop_pid || true" TERM INT
 
 sleep 2
 echo "⏱️ Sending SIGTERM to server"

utils/github/test-start-server.sh

@@ -0,0 +1,22 @@
+#!/bin/bash
+# Starts CopyQ server for tests.
+# Usage: source test-start-server.sh
+
+# Enable verbose logging.
+export COPYQ_LOG_LEVEL=DEBUG
+export QT_LOGGING_RULES="*.debug=true;qt.*.debug=false;qt.*.warning=true"
+
+./copyq &
+copyq_pid=$!
+
+# Wait for server to start
+for i in {1..3}; do
+    echo "Trying to start CopyQ server ($i)"
+    if ./copyq 'serverLog("Server started")'; then
+        break
+    elif [[ $i == 5 ]]; then
+        echo "❌ FAILED: Could not start CopyQ server"
+        exit 1
+    fi
+    sleep $((i * 2))
+done