Release v1.1.0 (#39)

- Not necessarily require to pass addon names to install them.
- Fix bug propagating command line arguments to `pytest`, `blender` and `python` binaries.
- Add `--blender-template` argument to pass a custom startup file.
- Raise `ValueError` if no addons passed to install to `install_addons_from_dir` fixture.

Author: mondeja

.bumpversion.cfg

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

.github/workflows/ci.yml

@@ -59,7 +59,8 @@ jobs:
           BLENDER_EXECUTABLE_PATH="$(cat _blender-executable-path.txt | tr -d '\n')"
           PYTHON_BLENDER_EXECUTABLE="$(pytest-blender --blender-executable $BLENDER_EXECUTABLE_PATH)"
           $PYTHON_BLENDER_EXECUTABLE -m ensurepip
-          $PYTHON_BLENDER_EXECUTABLE -m pip install pytest
+          pytest_version="$(< setup.cfg grep pytest== | head -n 1 | cut -d'=' -f3)"
+          $PYTHON_BLENDER_EXECUTABLE -m pip install pytest==$pytest_version
           echo "::set-output name=blender-executable::$BLENDER_EXECUTABLE_PATH"
       - name: Test with Blender Python executable (no cache)
         run: pytest -svv -p no:cacheprovider --blender-executable "${{ steps.install-dependencies.outputs.blender-executable }}" tests

README.md

@@ -81,6 +81,35 @@ tests/test_bpy_import.py .                                                [100%]
 ============================== 1 passed in 0.00s ===============================
 ```
 
+#### Arguments propagation
+
+When you call `pytest`, all options like `--blender-executable` are passed
+to the `pytest` suite running `pytest-blender`. If you want to pass arguments
+to `blender` in its headless execution, add a `--` between `pytest` and
+`blender` arguments. If you want to pass arguments to the `python` Blender's
+interpreter, you need to add another `--` between arguments in a third group.
+
+For example:
+
+```sh
+pytest -svv --blender-executable ~/blender -- --enable-event-simulate -- -b
+```
+
+In case that you don't want to pass arguments to `blender` but yes to `python`,
+use double arguments group separation (`-- --`):
+
+```sh
+pytest -svv -- -- -b
+```
+
+#### Load startup template
+
+You can use the `--blender-template` argument to pass a custom startup file:
+
+```sh
+pytest -svv --blender-template ~/.config/blender/2.93/config/startup.blend
+```
+
 ### Reference
 
 #### Fixtures
@@ -109,9 +138,9 @@ 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>)
+<b>install_addons_from_dir</b>(<i>addons_dir</i>,
+<i>addon_module_names=None</i>, <i>save_userpref=True</i>,
+<i>default_set=True</i>, <i>persistent=True</i>, <i>\*\*kwargs</i>) ⇒ `list`
 
 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
@@ -122,25 +151,30 @@ to disable them after the execution of the test suite:
 ```python
 import os
 
-ADDON_MODULE_NAMES = ["my_awesome_addon_module_name"]
+import pytest
 
 @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)
+    addon_module_names = install_addons_from_dir(os.path.abspath("src"))
     yield
-    disable_addons(ADDON_MODULE_NAMES)
+    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).
+- **addon_module_names** (list) Name of the addons modules. If not defined
+ (default) all the python modules located in `addons_dir` directory whose names
+ do not start with `__` will be considered addons.
 - **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).
 
+Returns the addon module names as a list, ready to be passed to
+[`disable_addons`](https://github.com/mondeja/pytest-blender#disable_addons)
+function.
+
 <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>)

pytest_blender/__init__.py

@@ -1 +1 @@
-__version__ = "1.0.2"
+__version__ = "1.1.0"

pytest_blender/__main__.py

@@ -23,7 +23,7 @@ def build_parser():
         dest="blender_executable",
         nargs=1,
         default=which_blender_by_os,
-        help="Blender executable location.",
+        help="Custom Blender executable location for 'pytest-blender' plugin.",
     )
     return parser
 

pytest_blender/plugin.py

@@ -17,6 +17,12 @@ def pytest_addoption(parser):
         default=which_blender_by_os,
         help="Blender executable location.",
     )
+    parser.addoption(
+        "--blender-template",
+        nargs=1,
+        default=None,
+        help="Open Blender using an empty layout as start template.",
+    )
 
 
 def _get_blender_executable(config):
@@ -26,24 +32,34 @@ def _get_blender_executable(config):
     return blender_executable[0]
 
 
+def _add_template_arg(config, args):
+    template = config.getoption("--blender-template")
+    if template:
+        args.append(template[0])
+
+
 @pytest.hookimpl(tryfirst=True)
 def pytest_configure(config):
     pytest_help_opt = False
 
     # build propagated CLI args
-    propagated_cli_args = []
-    _inside_root_invocation_arg = False
-    for arg in sys.argv[1:]:
-        if _inside_root_invocation_arg:
-            _inside_root_invocation_arg = False
-            continue
-        elif arg == "--blender-executable":
-            _inside_root_invocation_arg = True
+    args_groups, args_group_index = ([], [], []), 0
+    argv = sys.argv[1:]
+    i = 0
+    while i < len(argv):
+        arg = argv[i]
+        if arg in ["--blender-executable", "--blender-template"]:
+            i += 2
             continue
         elif arg in ["-h", "--help"]:
             pytest_help_opt = True
             break
-        propagated_cli_args.append(arg)
+        elif arg == "--":
+            args_group_index += 1
+            i += 1
+            continue
+        args_groups[args_group_index].append(arg)
+        i += 1
 
     if pytest_help_opt:
         return
@@ -53,24 +69,33 @@ def pytest_configure(config):
     if not blender_executable:
         pytest.exit("'blender' executable not found.", returncode=1)
 
+    pytest_opts, blender_opts, python_opts = args_groups
+
     # run pytest using blender
-    proc = subprocess.Popen(
+    args = [
+        blender_executable,
+        "-b",
+    ]
+
+    # template to open
+    _add_template_arg(config, args)
+
+    args.extend(
         [
-            blender_executable,
-            "-b",
+            *blender_opts,  # propagate Blender command line arguments
             "--python",
             os.path.join(
                 os.path.abspath(os.path.dirname(__file__)),
                 "run_pytest.py",
             ),
+            *python_opts,  # propagate Python command line arguments
             "--",
             "--pytest-blender-executable",
             blender_executable,
-            *propagated_cli_args,  # propagate command line arguments
-        ],
-        stdout=sys.stdout,
-        stderr=sys.stderr,
+            *pytest_opts,  # propagate Pytest command line arguments
+        ]
     )
+    proc = subprocess.Popen(args, stdout=sys.stdout, stderr=sys.stderr)
     proc.communicate()
 
     # hide "Exit:" message shown by pytest on exit

pytest_blender/run_pytest.py

@@ -207,7 +207,7 @@ def install_addons_from_dir(self, request):
 
             def _install_addons_from_dir(
                 addons_dir,
-                addon_module_names,
+                addon_module_names=None,
                 save_userpref=True,
                 default_set=True,
                 persistent=True,
@@ -216,8 +216,23 @@ def _install_addons_from_dir(
                 import addon_utils  # noqa F401
                 import bpy  # noqa F401
 
+                if addon_module_names is None:
+                    addon_module_names = [
+                        fname.rstrip(".py")
+                        for fname in os.listdir(addons_dir)
+                        if not fname.startswith("__")
+                    ]
+                    if not addon_module_names:
+                        raise ValueError(
+                            f"Any addons found in '{addons_dir}' directory."
+                        )
+                elif not addon_module_names:
+                    raise ValueError("You need to pass at least one addon to install.")
+
                 for addon_module_name in addon_module_names:
-                    addon_filepath = os.path.join(addons_dir, f"{addon_module_name}.py")
+                    addon_filepath = os.path.join(
+                        addons_dir, f"{addon_module_name.rstrip('.py')}.py"
+                    )
                     bpy.ops.preferences.addon_install(filepath=addon_filepath, **kwargs)
                     addon_utils.enable(
                         addon_module_name,
@@ -227,6 +242,8 @@ def _install_addons_from_dir(
                 if save_userpref:
                     bpy.ops.wm.save_userpref()
 
+                return addon_module_names
+
             return _install_addons_from_dir
 
         @pytest.fixture(scope="session")

setup.cfg

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

tests/addons/__init__.py

@@ -7,7 +7,7 @@
 }
 
 
-class ObjectMoveX(bpy.types.Operator):
+class PytestBlenderObjectMoveX(bpy.types.Operator):
     """My Object Moving Script"""
 
     bl_idname = "object.move_x"
@@ -23,11 +23,11 @@ def execute(self, context):
 
 
 def register():
-    bpy.utils.register_class(ObjectMoveX)
+    bpy.utils.register_class(PytestBlenderObjectMoveX)
 
 
 def unregister():
-    bpy.utils.unregister_class(ObjectMoveX)
+    bpy.utils.unregister_class(PytestBlenderObjectMoveX)
 
 
 if __name__ == "__main__":

tests/addons/pytest_blender_basic.py

@@ -2,6 +2,7 @@
 
 import io
 import os
+import sys
 from contextlib import redirect_stdout
 
 import pytest
@@ -21,12 +22,11 @@ def _register_addons(request, install_addons_from_dir, disable_addons):
             os.path.abspath(os.path.dirname(__file__)),
             "addons",
         )
-        addon_module_names = ["pytest_blender_basic"]
 
         f = io.StringIO()
         with redirect_stdout(f):
-            install_addons_from_dir(addons_dir, addon_module_names)
-
-            yield
-
+            addon_module_names = install_addons_from_dir(addons_dir)
+        yield
+        sys.stdout.write("\n")
+        with redirect_stdout(f):
             disable_addons(addon_module_names)

tests/conftest.py

@@ -17,14 +17,9 @@ def test_basic_addon():
     import _bpy
     import addon_utils
 
-    _module_loaded = False
-    for addon_module in addon_utils.modules():
-        if addon_module.__name__ == "pytest_blender_basic":
-            _module_loaded = True
-    assert _module_loaded
+    installed_addons = [addon.__name__ for addon in addon_utils.modules()]
+    assert "pytest_blender_basic" in installed_addons
+    assert "__init__" not in installed_addons
 
-    _operator_class_loaded = False
-    for operator_cls in _bpy.types.Operator.__subclasses__():
-        if operator_cls.__name__ == "ObjectMoveX":
-            _operator_class_loaded = True
-    assert _operator_class_loaded
+    operator_classes = [cls.__name__ for cls in _bpy.types.Operator.__subclasses__()]
+    assert "PytestBlenderObjectMoveX" in operator_classes