Added a load all plugins test. (#5878)

Adds a test that loads all available plugins in the beetsplug namespace.
This came up during #5876.

Author: snejus

.github/workflows/ci.yaml

@@ -52,15 +52,15 @@ jobs:
       - if: ${{ env.IS_MAIN_PYTHON != 'true' }}
         name: Test without coverage
         run: |
-          poetry install --extras=autobpm --extras=lyrics --extras=embedart
+          poetry install --extras=autobpm --extras=lyrics --extras=replaygain --extras=reflink --extras=fetchart --extras=chroma --extras=sonosupdate
           poe test
 
       - if: ${{ env.IS_MAIN_PYTHON == 'true' }}
         name: Test with coverage
         env:
           LYRICS_UPDATED: ${{ steps.lyrics-update.outputs.any_changed }}
         run: |
-          poetry install --extras=autobpm --extras=lyrics --extras=docs --extras=replaygain --extras=reflink --extras=fetchart
+          poetry install --extras=autobpm --extras=lyrics --extras=docs --extras=replaygain --extras=reflink --extras=fetchart --extras=chroma --extras=sonosupdate
           poe docs
           poe test-with-coverage
 

beetsplug/absubmit.py

@@ -18,9 +18,9 @@
 import hashlib
 import json
 import os
+import shutil
 import subprocess
 import tempfile
-from distutils.spawn import find_executable
 
 import requests
 
@@ -84,7 +84,7 @@ def __init__(self):
 
             # Get the executable location on the system, which we need
             # to calculate the SHA-1 hash.
-            self.extractor = find_executable(self.extractor)
+            self.extractor = shutil.which(self.extractor)
 
         # Calculate extractor hash.
         self.extractor_sha = hashlib.sha1()

docs/changelog.rst

@@ -102,6 +102,7 @@ Other changes:
   case is shown on separate lines.
 * Refactored library.py file by splitting it into multiple modules within the
   beets/library directory.
+* Added a test to check that all plugins can be imported without errors.
 
 2.3.1 (May 14, 2025)
 --------------------

test/test_plugins.py

@@ -13,8 +13,12 @@
 # included in all copies or substantial portions of the Software.
 
 
+import importlib
 import itertools
+import logging
 import os
+import pkgutil
+import sys
 from unittest.mock import ANY, Mock, patch
 
 import pytest
@@ -30,7 +34,12 @@
 )
 from beets.library import Item
 from beets.test import helper
-from beets.test.helper import AutotagStub, ImportHelper, TerminalImportMixin
+from beets.test.helper import (
+    AutotagStub,
+    ImportHelper,
+    PluginMixin,
+    TerminalImportMixin,
+)
 from beets.test.helper import PluginTestCase as BasePluginTestCase
 from beets.util import displayable_path, syspath
 
@@ -531,3 +540,56 @@ def foo(self, session, task):
         self.mock_input_options.assert_called_once_with(
             opts, default="a", require=ANY
         )
+
+
+def get_available_plugins():
+    """Get all available plugins in the beetsplug namespace."""
+    namespace_pkg = importlib.import_module("beetsplug")
+
+    return [
+        m.name
+        for m in pkgutil.iter_modules(namespace_pkg.__path__)
+        if not m.name.startswith("_")
+    ]
+
+
+class TestImportAllPlugins(PluginMixin):
+    def unimport_plugins(self):
+        """Unimport plugins before each test to avoid conflicts."""
+        self.unload_plugins()
+        for mod in list(sys.modules):
+            if mod.startswith("beetsplug."):
+                del sys.modules[mod]
+
+    @pytest.fixture(autouse=True)
+    def cleanup(self):
+        """Ensure plugins are unimported before and after each test."""
+        self.unimport_plugins()
+        yield
+        self.unimport_plugins()
+
+    @pytest.mark.skipif(
+        os.environ.get("GITHUB_ACTIONS") != "true",
+        reason="Requires all dependencies to be installed, "
+        + "which we can't guarantee in the local environment.",
+    )
+    @pytest.mark.parametrize("plugin_name", get_available_plugins())
+    def test_import_plugin(self, caplog, plugin_name):  #
+        """Test that a plugin is importable without an error using the
+        load_plugins function."""
+
+        # skip gstreamer plugins on windows
+        gstreamer_plugins = ["bpd", "replaygain"]
+        if sys.platform == "win32" and plugin_name in gstreamer_plugins:
+            pytest.xfail("GStreamer is not available on Windows: {plugin_name}")
+
+        caplog.set_level(logging.WARNING)
+        caplog.clear()
+        plugins.load_plugins([plugin_name])
+
+        # Check for warnings, is a bit hacky but we can make full use of the beets
+        # load_plugins code that way
+        assert len(caplog.records) == 0, (
+            f"Plugin '{plugin_name}' has issues during import. ",
+            caplog.records,
+        )