beets/test/plugins/test_hook.py

# This file is part of beets.
# Copyright 2015, Thomas Scholtes.
#
# Permission is hereby granted, free of charge, to any person obtaining
# a copy of this software and associated documentation files (the
# "Software"), to deal in the Software without restriction, including
# without limitation the rights to use, copy, modify, merge, publish,
# distribute, sublicense, and/or sell copies of the Software, and to
# permit persons to whom the Software is furnished to do so, subject to
# the following conditions:
#
# The above copyright notice and this permission notice shall be
# included in all copies or substantial portions of the Software.


import os.path
import sys
import tempfile
import unittest

from beets import config, plugins
from beets.test.helper import BeetsTestCase, capture_log


def get_temporary_path():
    temporary_directory = tempfile._get_default_tempdir()
    temporary_name = next(tempfile._get_candidate_names())

    return os.path.join(temporary_directory, temporary_name)


class HookTest(BeetsTestCase):
    TEST_HOOK_COUNT = 5

    def tearDown(self):
        self.unload_plugins()
        super().tearDown()

    def _add_hook(self, event, command):
        hook = {"event": event, "command": command}

        hooks = config["hook"]["hooks"].get(list) if "hook" in config else []
        hooks.append(hook)

        config["hook"]["hooks"] = hooks

    def test_hook_empty_command(self):
        self._add_hook("test_event", "")

        self.load_plugins("hook")

        with capture_log("beets.hook") as logs:
            plugins.send("test_event")

        self.assertIn('hook: invalid command ""', logs)

    # FIXME: fails on windows
    @unittest.skipIf(sys.platform == "win32", "win32")
    def test_hook_non_zero_exit(self):
        self._add_hook("test_event", 'sh -c "exit 1"')

        self.load_plugins("hook")

        with capture_log("beets.hook") as logs:
            plugins.send("test_event")

        self.assertIn("hook: hook for test_event exited with status 1", logs)

    def test_hook_non_existent_command(self):
        self._add_hook("test_event", "non-existent-command")

        self.load_plugins("hook")

        with capture_log("beets.hook") as logs:
            plugins.send("test_event")

        self.assertTrue(
            any(
                message.startswith("hook: hook for test_event failed: ")
                for message in logs
            )
        )

    # FIXME: fails on windows
    @unittest.skipIf(sys.platform == "win32", "win32")
    def test_hook_no_arguments(self):
        temporary_paths = [
            get_temporary_path() for i in range(self.TEST_HOOK_COUNT)
        ]

        for index, path in enumerate(temporary_paths):
            self._add_hook(f"test_no_argument_event_{index}", f'touch "{path}"')

        self.load_plugins("hook")

        for index in range(len(temporary_paths)):
            plugins.send(f"test_no_argument_event_{index}")

        for path in temporary_paths:
            self.assertTrue(os.path.isfile(path))
            os.remove(path)

    # FIXME: fails on windows
    @unittest.skipIf(sys.platform == "win32", "win32")
    def test_hook_event_substitution(self):
        temporary_directory = tempfile._get_default_tempdir()
        event_names = [
            f"test_event_event_{i}" for i in range(self.TEST_HOOK_COUNT)
        ]

        for event in event_names:
            self._add_hook(event, f'touch "{temporary_directory}/{{event}}"')

        self.load_plugins("hook")

        for event in event_names:
            plugins.send(event)

        for event in event_names:
            path = os.path.join(temporary_directory, event)

            self.assertTrue(os.path.isfile(path))
            os.remove(path)

    # FIXME: fails on windows
    @unittest.skipIf(sys.platform == "win32", "win32")
    def test_hook_argument_substitution(self):
        temporary_paths = [
            get_temporary_path() for i in range(self.TEST_HOOK_COUNT)
        ]

        for index, path in enumerate(temporary_paths):
            self._add_hook(f"test_argument_event_{index}", 'touch "{path}"')

        self.load_plugins("hook")

        for index, path in enumerate(temporary_paths):
            plugins.send(f"test_argument_event_{index}", path=path)

        for path in temporary_paths:
            self.assertTrue(os.path.isfile(path))
            os.remove(path)

    # FIXME: fails on windows
    @unittest.skipIf(sys.platform == "win32", "win32")
    def test_hook_bytes_interpolation(self):
        temporary_paths = [
            get_temporary_path().encode("utf-8")
            for i in range(self.TEST_HOOK_COUNT)
        ]

        for index, path in enumerate(temporary_paths):
            self._add_hook(f"test_bytes_event_{index}", 'touch "{path}"')

        self.load_plugins("hook")

        for index, path in enumerate(temporary_paths):
            plugins.send(f"test_bytes_event_{index}", path=path)

        for path in temporary_paths:
            self.assertTrue(os.path.isfile(path))
            os.remove(path)


def suite():
    return unittest.TestLoader().loadTestsFromName(__name__)


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