Add 'install_addons_from_dir' and 'disable_addons' fixtures.

Author: mondeja

.bumpversion.cfg

@@ -1,5 +1,5 @@
 [bumpversion]
-current_version = 0.0.4
+current_version = 0.0.5
 
 [bumpversion:file:pytest_blender/__init__.py]
 

README.md

@@ -102,6 +102,46 @@ currently running session.
 Returns the version of the Python executable builtin in the Blender release of
 the currently running session.
 
+<a name="install_addons_from_dir" href="#install_addons_from_dir">#</a> <b>install_addons_from_dir</b>(<i>addons_dir</i>, <i>addon_module_names</i>, <i>save_userpref=True</i>, <i>default_set=True</i>, <i>persistent=True</i>, <i>\*\*kwargs</i>)
+
+Returns a function that installs and enables a set of addons whose modules are
+located in a directory. This function is designed to be executed before the
+pytest session to install the addons that you want to test, using the other
+fixture [`disable_addons`](https://github.com/mondeja/pytest-blender#disable_addons)
+to disable them after the execution of the suite:
+
+```python
+import os
+
+ADDON_MODULE_NAMES = ["my_awesome_addon_module_name"]
+
+@pytest.fixture(scope="session", autouse=True)
+def _register_addons(request, install_addons_from_dir, disable_addons):
+    install_addons_from_dir(os.path.abspath("src"), ADDON_MODULE_NAMES)
+    yield
+    disable_addons(ADDON_MODULE_NAMES)
+```
+- **addons_dir** (str) Directory in which are located the modules of the addons.
+- **addon_module_names** (list) Name of the addons modules (without the `.py` extension).
+- **save_userpref** (bool) Save user preferences after installation.
+- **default_set** (bool) Set the user-preference calling `addon_utils.enable`.
+- **persistent** (bool) Ensure the addon is enabled for the entire session
+ (after loading new files).
+- **\*\*kwargs** (dict) Subsecuent keyword arguments are passed to
+ [`bpy.ops.preferences.addon_install`](https://docs.blender.org/api/current/bpy.ops.preferences.html#bpy.ops.preferences.addon_install).
+
+<a name="disable_addons" href="#disable_addons">#</a> <b>disable_addons</b>(<i>addon_module_names</i>, <i>save_userpref=True</i>, <i>default_set=True</i>, <i>\*\*kwargs</i>)
+
+Returns a function that disables a set of addons by module name. Is designed to
+disables your addons after a pytest suite execution (check 
+[`install_addons_from_dir`](https://github.com/mondeja/pytest-blender#install_addons_from_dir)
+for an example).
+
+- **addon_module_names** (list) Name of the addons modules (without the `.py` extension).
+- **save_userpref** (bool) Save user preferences after installation.
+- **default_set** (bool) Set the user-preference calling `addon_utils.disable`.
+- **\*\*kwargs** (dict) Subsecuent keyword arguments are passed to `addon_utils.disable`.
+
 
 [pypi-link]: https://pypi.org/project/pytest-blender
 [pypi-version-badge-link]: https://img.shields.io/pypi/v/pytest-blender

pytest_blender/__init__.py

@@ -1 +1 @@
-__version__ = "0.0.4"
+__version__ = "0.0.5"

pytest_blender/run_pytest.py

@@ -129,6 +129,66 @@ def blender_python_version(self, request):
                 )
             return blender_python_version
 
+        @pytest.fixture(scope="session")
+        def install_addons_from_dir(self, request):
+            def _install_addons_from_dir(
+                addons_dir,
+                addon_module_names,
+                save_userpref=True,
+                default_set=True,
+                persistent=True,
+                **kwargs,
+            ):
+                import addon_utils  # noqa F401
+                import bpy  # noqa F401
+
+                for addon_module_name in addon_module_names:
+                    addon_filepath = os.path.join(addons_dir, f"{addon_module_name}.py")
+                    bpy.ops.preferences.addon_install(filepath=addon_filepath, **kwargs)
+                    addon_utils.enable(
+                        addon_module_name,
+                        default_set=default_set,
+                        persistent=persistent,
+                    )
+                if save_userpref:
+                    bpy.ops.wm.save_userpref()
+
+            return _install_addons_from_dir
+
+        @pytest.fixture(scope="session")
+        def disable_addons(self, request):
+            def _disable_addons(
+                addon_module_names,
+                save_userpref=True,
+                default_set=True,
+                **kwargs,
+            ):
+                """Disables a set of addons by module name.
+
+                Parameters
+                ----------
+
+                addon_module_names : list
+                  Name of the addons modules (without the ``.py`` extension).
+
+                save_userpref : bool
+                  Save user preferences after disable.
+                """
+                import addon_utils  # noqa F401
+
+                for addon_module_name in addon_module_names:
+                    addon_utils.disable(
+                        addon_module_name,
+                        default_set=default_set,
+                        **kwargs,
+                    )
+                if save_userpref:
+                    import bpy  # noqa F401
+
+                    bpy.ops.wm.save_userpref()
+
+            return _disable_addons
+
     return pytest.main(argv, plugins=[PytestBlenderPlugin()])
 
 

setup.cfg

@@ -1,6 +1,6 @@
 [metadata]
 name = pytest_blender
-version = 0.0.4
+version = 0.0.5
 description = Blender Pytest plugin.
 long_description = file: README.md
 long_description_content_type = text/markdown

tests/conftest.py

@@ -8,27 +8,17 @@
 
 
 @pytest.fixture(scope="session", autouse=True)
-def _register_addon(request):
-    import addon_utils
-    import bpy
-
+def _register_addons(request, install_addons_from_dir, disable_addons):
     addons_dir = os.path.join(
         os.path.abspath(os.path.dirname(__file__)),
         "addons",
     )
-
-    addons_module_names = ["pytest_blender_basic"]
+    addon_module_names = ["pytest_blender_basic"]
 
     f = io.StringIO()
     with redirect_stdout(f):
-        for addon_module_name in addons_module_names:
-            addon_filepath = os.path.join(addons_dir, f"{addon_module_name}.py")
-            bpy.ops.preferences.addon_install(filepath=addon_filepath, overwrite=True)
-            addon_utils.enable(addon_module_name, default_set=True, persistent=True)
-        bpy.ops.wm.save_userpref()
+        install_addons_from_dir(addons_dir, addon_module_names)
 
         yield
 
-        for addon_module_name in addons_module_names:
-            addon_utils.disable(addon_module_name, default_set=True)
-        bpy.ops.wm.save_userpref()
+        disable_addons(addon_module_names)