Archives
/
input-remapper
mirror of https://github.com/sezanzeb/input-remapper
2
0
Fork 0
Code Issues Packages Projects Releases Wiki Activity

Add service start and stop commands to setup script (#632)

Browse Source
pull/669/head
Uwe Jugel 1 year ago committed by GitHub
parent 858c5059e5
commit d0cc1b82a8
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
2 changed files with 82 additions and 49 deletions
Show Stats Download Patch File Download Diff File

121
readme/development.md
Unescape Escape View File

@ -1,27 +1,30 @@
# Development
Development
===========
Contributions are very welcome, I will gladly review and discuss any merge
requests. If you have questions about the code and architecture, feel free
to [open an issue](https://github.com/sezanzeb/input-remapper/issues). This
file should give an overview about some internals of input-remapper.
Contributions are very welcome, I will gladly review and discuss any merge requests.
If you have questions about the code and architecture, feel free to
[open an issue](https://github.com/sezanzeb/input-remapper/issues).
This file should give an overview about some internals of input-remapper.
All pull requests will at some point require unittests (see below for more
info), the code coverage may only be improved, not decreased. It also has to
be mostly compliant with pylint.
All pull requests will at some point require unittests (see below for more info).
The code coverage may only be improved, not decreased. It also has to be mostly
compliant with pylint.
## Linting
Linting
-------
```bash
mypy inputremapper
black . # modifies code in-place
mypy inputremapper # find typing issues
black . # auto-format all code in-place
pip install pylint-pydantic --user # https://github.com/fcfangcc/pylint-pydantic
pylint inputremapper
pylint inputremapper # get a code quality rating from pylint
```
Pylint gives lots of great advice on how to write better python code and even
detects errors. Mypy checks for typing errors. Use black to format it.
Pylint gives lots of great advice on how to write better python code and even detects
errors. Mypy checks for typing errors. Use black to format it.
## Automated tests
Automated tests
---------------
```bash
pip install coverage --user # https://github.com/nedbat/coveragepy
@ -30,51 +33,75 @@ sudo pip install . && coverage run tests/test.py
coverage combine && coverage report -m
```
Single tests can be executed via
This assumes you are using your system's `pip`. If you are in a virtual env,
a `sudo pip install` is not recommened. See [Scripts](#scripts) for alternatives.
```bash
python3 tests/test.py test_paths.TestPaths.test_mkdir
Single tests can be executed via `tests/test.py` using the full code path as argment.
```
python3 tests/test.py tests.unit.test_ipc.TestSocket.test_select
```
Don't use your computer during integration tests to avoid interacting
with the gui, which might make tests fail.
Also `python -m unittest` can be used, which provides more control over which tests to
run and how to fail on errors. See `python -m unittest -h` for more.
```
python -m unittest tests.unit.test_ipc.TestPipe -k "test_pipe" -f
```
Don't use your computer during integration tests to avoid interacting with the gui,
which might make tests fail.
There is also a "run configuration" for PyCharm called "All Tests" included.
To read events for manual testing, `evtest` is very helpful. Add `-d` to
`input-remapper-gtk` to get debug output.
To read events for manual testing, `evtest` is very helpful.
Add `-d` to `input-remapper-gtk` to get debug output.
## Writing Tests
Writing Tests
-------------
Tests are in https://github.com/sezanzeb/input-remapper/tree/main/tests
https://github.com/sezanzeb/input-remapper/blob/main/tests/test.py patches some modules and runs tests. The tests need
patches because every environment that runs them will be different. By using patches they all look the same to the
individual tests. Some patches also allow to make some handy assertions, like the `write_history` of `UInput`.
https://github.com/sezanzeb/input-remapper/blob/main/tests/test.py patches some modules
and runs tests. The tests need patches because every environment that runs them will be
different. By using patches they all look the same to the individual tests. Some
patches also allow to make some handy assertions, like the `write_history` of `UInput`.
Test files are usually named after the module they are in.
In the tearDown functions, usually one of `quick_cleanup` or `cleanup` should be called. This avoids making a test
fail that comes after your new test, because some state variables might still be modified by yours.
In the tearDown functions, usually one of `quick_cleanup` or `cleanup` should be called.
This avoids making a test fail that comes after your new test, because some state
variables might still be modified by yours.
## Advices
Scripts
-------
To automate some of the development tasks, you can use the
[setup.sh](/scripts/setup.sh) script. The script avoids using `pip` for installation.
Instead, it uses either your local `python3` in your virtual env, or using
`/usr/bin/python3` explicitly. For more information run
```
scripts/setup.sh help
```
Do not use GTKs `foreach` methods, because when the function fails it just freezes up completely.
Use `get_children()` and iterate over it with regular python `for` loops.
Advices
-------
use `gtk_iteration` in tests when interacting with GTK methods to trigger events to be emitted.
Do not use GTKs `foreach` methods, because when the function fails it just freezes up
completely. Use `get_children()` and iterate over it with regular python `for` loops.
Use `gtk_iteration()` in tests when interacting with GTK methods to trigger events to
be emitted.
## Releasing
Releasing
---------
ssh/login into a debian/ubuntu environment
```bash
./scripts/build.sh
scripts/build.sh
```
This will generate `input-remapper/deb/input-remapper-2.0.0-rc.deb`
## Badges
Badges
------
```bash
sudo pip install anybadge pylint
@ -84,13 +111,13 @@ sudo pip install .
./scripts/badges.sh
```
New badges, if needed, will be created in `readme/` and they
just need to be commited.
New badges, if needed, will be created in `readme/` and they just need to be commited.
Beware that coverage can suffer if old files reside in your python path. Remove the build folder
and reinstall it.
Beware that coverage can suffer if old files reside in your python path. Remove the
build folder and reinstall it.
## Translations
Translations
------------
To regenerate the `po/input-remapper.pot` file, run
@ -99,12 +126,13 @@ xgettext -k --keyword=translatable --sort-output -o po/input-remapper.pot data/i
xgettext --keyword=_ -L Python --sort-output -jo po/input-remapper.pot inputremapper/configs/mapping.py inputremapper/gui/*.py inputremapper/gui/components/*.py
```
This is the template file that you can copy to fill in the translations.
See https://github.com/sezanzeb/input-remapper/tree/main/po for examples.
Also create the symlink, like `ln -s it_IT.po it.po`, because some environments
expect different names apparently.
This is the template file that you can copy to fill in the translations. Also create a
corresponding symlink, like `ln -s it_IT.po it.po`, because some environments expect
different names apparently. See https://github.com/sezanzeb/input-remapper/tree/main/po
for examples.
## Architecture
Architecture
------------
There is a miro board describing input-remappers architecture:
@ -112,7 +140,8 @@ https://miro.com/app/board/uXjVPLa8ilM=/?share_link_id=272180986764
![architecture.png](./architecture.png)
## Resources
Resources
---------
- [Guidelines for device capabilities](https://www.kernel.org/doc/Documentation/input/event-codes.txt)
- [PyGObject API Reference](https://lazka.github.io/pgi-docs/)

10
scripts/setup.sh
Unescape Escape View File

@ -98,9 +98,9 @@ remove_system_files() {
sudo rm -f /usr/lib/systemd/system/input-remapper.service
echo "manual removal: cleaning up /etc, config, and startup files"
sudo rm -f /etc/dbus-1/system.d/inputremapper.Control.conf
sudo rm -f /etc/xdg/autostart/input-remapper-autoload.desktop
sudo rm -f /usr/lib/udev/rules.d/99-input-remapper.rules
sudo rm -f /etc/dbus-1/system.d/inputremapper.Control.conf
sudo rm -f /etc/xdg/autostart/input-remapper-autoload.desktop
sudo rm -f /usr/lib/udev/rules.d/99-input-remapper.rules
}
# find what is installed and print it (returns 1 if anything is found)
@ -152,6 +152,8 @@ commands:
purge find and remove everything that was installed
inject [path] inject a 'sys.path' into the files in '$bin'
uninject undo the path injection
start start the service
stop stop the service
EOF
}
@ -160,6 +162,8 @@ while test $# -gt 0; do case "$1" in
inst*) stop_service; system_install && start_service || exit 1 ;;
local-inst*) stop_service; local_install && start_service || exit 1 ;;
uninst*) stop_service; uninstall && check_system_files || exit 1 ;;
start) start_service ;;
stop) stop_service ;;
show) check_system_files ;;
clean) remove_build_files ;;
inject) if test -e "$2" # check if next arg is a 'path'

Write Preview
Loading…
Cancel
Save