Removed logfiles (sezanzeb#418)

Author: sezanzeb

.github/ISSUE_TEMPLATE/autoloading-not-working.md

@@ -9,16 +9,18 @@ assignees: ''
 
 Please install the newest version from source to see if the problem has already been solved.
 
-Share some logs please:
+**System Information and logs**
 
 1. `input-remapper-control --version`
 2. which linux distro (ubuntu 20.04, manjaro, etc.)
-3. `echo $XDG_SESSION_TYPE`
-4. which desktop environment (gnome, plasma, xfce4, etc.)
-5. `sudo ls -l /proc/1/exe`
+3. which desktop environment (gnome, plasma, xfce4, etc.)
+4. `sudo ls -l /proc/1/exe` to check if you are using systemd
+5. `cat ~/.config/input-remapper/config.json` to see if the "autoload" config is written correctly
+6. `systemctl status input-remapper -n 50` the service has to be running
 
-6. `cat ~/.config/input-remapper/config.json`
-7. `input-remapper-control --command hello`
-8. `systemctl status input-remapper -n 50`
-9. `sudo pkill -f input-remapper-service && sudo input-remapper-service -d & sleep 2 && input-remapper-control --command autoload`, are your keys mapped now?
-10. (while the previous command is still running) `sudo evtest` and search for a device suffixed by "mapped". Select it, does it report any events? Share the output.
+**Testing the setup**
+
+1. `input-remapper-control --command hello`
+2. `sudo pkill -f input-remapper-service && sudo input-remapper-service -d & sleep 2 && input-remapper-control --command autoload`, are your keys mapped now?
+3. (while the previous command is still running) `sudo evtest` and search for a device suffixed by "mapped". Select it, does it report any events? Share the output.
+4. `sudo udevadm control --log-priority=debug && sudo udevadm control --reload-rules && journalctl -f | grep input-remapper`, now plug in the device that should autoload

bin/input-remapper-control

@@ -27,7 +27,7 @@ import argparse
 import logging
 import subprocess
 
-from inputremapper.logger import logger, update_verbosity, log_info, add_filehandler
+from inputremapper.logger import logger, update_verbosity, log_info
 from inputremapper.configs.migrations import migrate
 from inputremapper.configs.global_config import global_config
 
@@ -223,8 +223,6 @@ def main(options):
     if options.debug:
         update_verbosity(True)
 
-    add_filehandler('/var/log/input-remapper-control')
-
     if options.version:
         log_info()
         return

bin/input-remapper-service

@@ -25,7 +25,7 @@
 import sys
 from argparse import ArgumentParser
 
-from inputremapper.logger import update_verbosity, log_info, add_filehandler
+from inputremapper.logger import update_verbosity, log_info
 
 
 if __name__ == '__main__':
@@ -46,7 +46,6 @@ if __name__ == '__main__':
     # import input-remapper stuff after setting the log verbosity
     from inputremapper.daemon import Daemon
 
-    add_filehandler()
     if not options.hide_info:
         log_info('input-remapper-service')
 

data/input-remapper.service

@@ -3,7 +3,6 @@ Description=Service to inject keycodes without the GUI application
 # dbus is required for ipc between gui and input-remapper-control
 Requires=dbus.service
 After=dbus.service
-RequiresMountsFor=/var/log
 
 [Service]
 Type=dbus

inputremapper/configs/migrations.py

@@ -33,10 +33,10 @@
 
 from inputremapper.logger import logger, VERSION
 from inputremapper.user import HOME
-from inputremapper.configs.paths import get_preset_path, mkdir, CONFIG_PATH
+from inputremapper.configs.paths import get_preset_path, mkdir, CONFIG_PATH, remove
 from inputremapper.configs.system_mapping import system_mapping
 from inputremapper.injection.global_uinputs import global_uinputs
-from inputremapper.injection.macros.parse import parse, is_this_a_macro
+from inputremapper.injection.macros.parse import is_this_a_macro
 
 
 def all_presets():
@@ -244,6 +244,18 @@ def _otherwise_to_else():
             file.write("\n")
 
 
+def _remove_logs():
+    """We will try to rely on journalctl for this in the future."""
+    try:
+        remove(f"{HOME}/.log/input-remapper")
+        remove("/var/log/input-remapper")
+        remove("/var/log/input-remapper-control")
+    except Exception as error:
+        logger.debug("Failed to remove deprecated logfiles: %s", str(error))
+        # this migration is not important. Continue
+        pass
+
+
 def migrate():
     """Migrate config files to the current release."""
     v = config_version()
@@ -264,6 +276,8 @@ def migrate():
     if v < pkg_resources.parse_version("1.4.1"):
         _otherwise_to_else()
 
+    _remove_logs()
+
     # add new migrations here
 
     if v < pkg_resources.parse_version(VERSION):

inputremapper/logger.py

@@ -77,11 +77,6 @@ def debug_key(self, key, msg, *args):
 
 logging.Logger.debug_key = debug_key
 
-LOG_PATH = (
-    "/var/log/input-remapper"
-    if os.access("/var/log", os.W_OK)
-    else f"{HOME}/.log/input-remapper"
-)
 
 logger = logging.getLogger("input-remapper")
 
@@ -297,24 +292,3 @@ def trim_logfile(log_path):
         raise
     except Exception as e:
         logger.error('Failed to trim logfile: "%s"', str(e))
-
-
-def add_filehandler(log_path=LOG_PATH):
-    """Clear the existing logfile and start logging to it."""
-    try:
-        log_path = os.path.expanduser(log_path)
-        os.makedirs(os.path.dirname(log_path), exist_ok=True)
-
-        if os.path.isdir(log_path):
-            # used to be a folder < 0.8.0
-            shutil.rmtree(log_path)
-
-        trim_logfile(log_path)
-
-        file_handler = logging.FileHandler(log_path)
-        file_handler.setFormatter(ColorfulFormatter())
-        logger.addHandler(file_handler)
-
-        logger.info('Starting logging to "%s"', log_path)
-    except PermissionError:
-        logger.debug('No permission to log to "%s"', log_path)

tests/unit/test_logger.py

@@ -26,10 +26,20 @@
 import unittest
 import logging
 
-from inputremapper.logger import logger, add_filehandler, update_verbosity, log_info
+from inputremapper.logger import logger, update_verbosity, log_info, ColorfulFormatter
 from inputremapper.configs.paths import remove
 
 
+def add_filehandler(log_path):
+    """Start logging to a file."""
+    log_path = os.path.expanduser(log_path)
+    os.makedirs(os.path.dirname(log_path), exist_ok=True)
+    file_handler = logging.FileHandler(log_path)
+    file_handler.setFormatter(ColorfulFormatter())
+    logger.addHandler(file_handler)
+    logger.info('Starting logging to "%s"', log_path)
+
+
 class TestLogger(unittest.TestCase):
     def tearDown(self):
         update_verbosity(debug=True)
@@ -77,22 +87,6 @@ def test_makes_path(self):
         add_filehandler(new_path)
         self.assertTrue(os.path.exists(new_path))
 
-    def test_clears_log(self):
-        path = os.path.join(tmp, "logger-test")
-        os.makedirs(os.path.dirname(path), exist_ok=True)
-        os.mknod(path)
-
-        with open(path, "w") as f:
-            f.write("aaaa\n" * 2000 + "end")
-
-        add_filehandler(os.path.join(tmp, "logger-test"))
-        with open(path, "r") as f:
-            # it only keeps the newest information
-            content = f.readlines()
-            self.assertLess(abs(len(content) - 1000), 10)
-            # whatever the logging module decides to log into that file
-            self.assertNotIn("aaaa", content[-1])
-
     def test_debug(self):
         path = os.path.join(tmp, "logger-test")
         add_filehandler(path)