File: test_system_mapping.py

package info (click to toggle)
input-remapper 2.1.1-2
  • links: PTS, VCS
  • area: main
  • in suites: forky, sid
  • size: 2,856 kB
  • sloc: python: 27,277; sh: 191; xml: 33; makefile: 3
file content (165 lines) | stat: -rw-r--r-- 6,236 bytes parent folder | download | duplicates (2)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
#!/usr/bin/env python3
# -*- coding: utf-8 -*-
# input-remapper - GUI for device specific keyboard mappings
# Copyright (C) 2025 sezanzeb <b8x45ygc9@mozmail.com>
#
# This file is part of input-remapper.
#
# input-remapper is free software: you can redistribute it and/or modify
# it under the terms of the GNU General Public License as published by
# the Free Software Foundation, either version 3 of the License, or
# (at your option) any later version.
#
# input-remapper is distributed in the hope that it will be useful,
# but WITHOUT ANY WARRANTY; without even the implied warranty of
# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
# GNU General Public License for more details.
#
# You should have received a copy of the GNU General Public License
# along with input-remapper.  If not, see <https://www.gnu.org/licenses/>.

import json
import os
import subprocess
import unittest
from unittest.mock import patch

from evdev.ecodes import BTN_LEFT, KEY_A

from inputremapper.configs.paths import PathUtils
from inputremapper.configs.keyboard_layout import KeyboardLayout, XMODMAP_FILENAME
from tests.lib.test_setup import test_setup


@test_setup
class TestSystemMapping(unittest.TestCase):
    def test_update(self):
        keyboard_layout = KeyboardLayout()
        keyboard_layout.update({"foo1": 101, "bar1": 102})
        keyboard_layout.update({"foo2": 201, "bar2": 202})
        self.assertEqual(keyboard_layout.get("foo1"), 101)
        self.assertEqual(keyboard_layout.get("bar2"), 202)

    def test_xmodmap_file(self):
        keyboard_layout = KeyboardLayout()
        path = os.path.join(PathUtils.config_path(), XMODMAP_FILENAME)
        os.remove(path)

        keyboard_layout.populate()
        self.assertTrue(os.path.exists(path))
        with open(path, "r") as file:
            content = json.load(file)
            self.assertEqual(content["a"], KEY_A)
            # only xmodmap stuff should be present
            self.assertNotIn("key_a", content)
            self.assertNotIn("KEY_A", content)
            self.assertNotIn("disable", content)

    def test_empty_xmodmap(self):
        # if xmodmap returns nothing, don't write the file
        empty_xmodmap = ""

        class SubprocessMock:
            def decode(self):
                return empty_xmodmap

        def check_output(*args, **kwargs):
            return SubprocessMock()

        with patch.object(subprocess, "check_output", check_output):
            keyboard_layout = KeyboardLayout()
            path = os.path.join(PathUtils.config_path(), XMODMAP_FILENAME)
            os.remove(path)

            keyboard_layout.populate()
            self.assertFalse(os.path.exists(path))

    def test_xmodmap_command_missing(self):
        # if xmodmap is not installed, don't write the file
        def check_output(*args, **kwargs):
            raise FileNotFoundError

        with patch.object(subprocess, "check_output", check_output):
            keyboard_layout = KeyboardLayout()
            path = os.path.join(PathUtils.config_path(), XMODMAP_FILENAME)
            os.remove(path)

            keyboard_layout.populate()
            self.assertFalse(os.path.exists(path))

    def test_correct_case(self):
        keyboard_layout = KeyboardLayout()
        keyboard_layout.clear()
        keyboard_layout._set("A", 31)
        keyboard_layout._set("a", 32)
        keyboard_layout._set("abcd_B", 33)

        self.assertEqual(keyboard_layout.correct_case("a"), "a")
        self.assertEqual(keyboard_layout.correct_case("A"), "A")
        self.assertEqual(keyboard_layout.correct_case("ABCD_b"), "abcd_B")
        # unknown stuff is returned as is
        self.assertEqual(keyboard_layout.correct_case("FOo"), "FOo")

        self.assertEqual(keyboard_layout.get("A"), 31)
        self.assertEqual(keyboard_layout.get("a"), 32)
        self.assertEqual(keyboard_layout.get("ABCD_b"), 33)
        self.assertEqual(keyboard_layout.get("abcd_B"), 33)

    def test_keyboard_layout(self):
        keyboard_layout = KeyboardLayout()
        keyboard_layout.populate()
        self.assertGreater(len(keyboard_layout._mapping), 100)

        # this is case-insensitive
        self.assertEqual(keyboard_layout.get("1"), 2)
        self.assertEqual(keyboard_layout.get("KeY_1"), 2)

        self.assertEqual(keyboard_layout.get("AlT_L"), 56)
        self.assertEqual(keyboard_layout.get("KEy_LEFtALT"), 56)

        self.assertEqual(keyboard_layout.get("kEY_LeFTSHIFT"), 42)
        self.assertEqual(keyboard_layout.get("ShiFt_L"), 42)

        self.assertEqual(keyboard_layout.get("BTN_left"), 272)

        self.assertIsNotNone(keyboard_layout.get("KEY_KP4"))
        self.assertEqual(keyboard_layout.get("KP_Left"), keyboard_layout.get("KEY_KP4"))

        # this only lists the correct casing,
        # includes linux constants and xmodmap symbols
        names = keyboard_layout.list_names()
        self.assertIn("2", names)
        self.assertIn("c", names)
        self.assertIn("KEY_3", names)
        self.assertNotIn("key_3", names)
        self.assertIn("KP_Down", names)
        self.assertNotIn("kp_down", names)
        names = keyboard_layout._mapping.keys()
        self.assertIn("F4", names)
        self.assertNotIn("f4", names)
        self.assertIn("BTN_RIGHT", names)
        self.assertNotIn("btn_right", names)
        self.assertIn("KEY_KP7", names)
        self.assertIn("KP_Home", names)
        self.assertNotIn("kp_home", names)

        self.assertEqual(keyboard_layout.get("disable"), -1)

    def test_get_name_no_xmodmap(self):
        # if xmodmap is not installed, uses the linux constant names
        keyboard_layout = KeyboardLayout()

        def check_output(*args, **kwargs):
            raise FileNotFoundError

        with patch.object(subprocess, "check_output", check_output):
            keyboard_layout.populate()
            self.assertEqual(keyboard_layout.get_name(KEY_A), "KEY_A")

            # testing for BTN_LEFT is especially important, because
            # `evdev.ecodes.BTN.get(code)` returns an array of ['BTN_LEFT', 'BTN_MOUSE']
            self.assertEqual(keyboard_layout.get_name(BTN_LEFT), "BTN_LEFT")


if __name__ == "__main__":
    unittest.main()