Package: pytest-blender
pytest-blenderPytest plugin for Blender testing. Executes your pytest testsuite with
Blender in headless mode using its builtin Python interpreter.Installpipinstallpytest-blenderDocumentationUsageBefore execute it, you need to install your testing dependencies inside the
builtin Blender Python interpreter. To get the interpreter location you can
use the CLI utilitypytest-blender, something like:blender_python="$(pytest-blender)"$blender_python-mensurepip$blender_python-mpipinstall-rtest-requirements.txtAfter installing dependencies, just call pytest as usually.pytest-svvBlender 2.82 (sub 7)
Read prefs: ~/.config/blender/2.82/config/userpref.blend
=================== test session starts ===================
platform linux -- Python 3.8.5, pytest-6.1.2, py-1.9.0, pluggy-0.13.1 -- /usr/bin/blender
cachedir: .pytest_cache
rootdir: /home/mondeja/files/code/pytest-blender
collected 1 item

tests/test_bpy_import.py::test_inside_blender <module 'bpy' from '/usr/share/blender/scripts/modules/bpy/__init__.py'>
PASSED
==================== 1 passed in 0.01s ====================ReferenceConfigurationAll options can be passed as a CLI argument like--[option-name]or
defined inside aconfiguration file.blender-executableSpecify a customblenderexecutable location.pytest--blender-executable~/blender-2.91.2-linux64/blender[pytest]blender-executable=~/blender-2.91.2-linux64/blenderBlender 2.91.2 (hash 5be9ef417703 built 2021-01-19 16:16:34)
Read prefs: ~/.config/blender/2.91/config/userpref.blend
found bundled python: ~/blender-2.91.2-linux64/2.91/python
=================== test session starts ===================
platform linux -- Python 3.7.7, pytest-6.2.2, py-1.10.0, pluggy-0.13.1
rootdir: ~/pytest-blender
collected 1 item

tests/test_bpy_import.py .                                                [100%]

==================== 1 passed in 0.00s ====================blender-templateLoad a custom startup.blendtemplate.pytest-svv--blender-template~/.config/blender/2.93/config/startup.blend[pytest]blender-template=~/.config/blender/2.93/config/startup.blendaddopts=-svvblender-addons-dirsInstall addons inside Blender before executing the test suite. This allows
you to easily test them.By "addons" Blender understands Python scripts whose file names
end with.py,.zipfiles for compressed packages with multiple modules
or directories for Python packages which contain a__init__.pyfile.
These must be located in the root of each directory passed toblender-addons-dirs.For example, given the next directory tree:📁 addons-dirs
├── 📁 private-addons
│   └── 📁 package_addon
│       ├── 📄 __init__.py 
│       └── 📄 main.py
|
└── 📁 public-addons
    ├── 📄 module_addon.py
    └── 📄 compressed_addon.zip
        ├── 📄 __init__.py 
        └── 📄 main.pyThe next configurations will install the addonspackage_addon,module_addonandcompressed_addon.pytesttests--blender-addons-dirsaddons-dirs/private-addonsaddons-dirs/public-addons[pytest]blender-addons-dirs=addons-dirs/private-addonsaddons-dirs/public-addonsYou can also define a unique addons directory in configuration files
defining it as a string:[pytest]blender-addons-dirs=addons-dirs/public-addonsIf you need more complex setups see the fixturesinstall_addons_from_dir,disable_addonsanduninstall_addons.blender-addons-cleaningDefine the addons cleaning strategy to follow after executing your
test suite. It only affects to the addons installed usingblender-addons-dirs.It accepts one of the next values:uninstall(default): Uninstall the addons after executing the
test suite.disable: Just disable the addons in user preferences, but does
not uninstall them.keep: Keep the addons enabled. Useful if you want to manually
review the addons or while you're developing.pytest--blender-addons-cleaningdisable[pytest]blender-addons-cleaning=disablepytest-blender-debugShow in STDOUT the command executed by pytest-blender executing your
test suite.pytest--pytest-blender-debug[pytest]pytest-blender-debug=true[DEBUG (pytest-blender)] Running blender with: /usr/bin/blender -b --python /home/foo/files/code/pytest-blender/pytest_blender/run_pytest.py -- --pytest-blender-executable /usr/bin/blender -svv --rootdir=/tmp/tmpdsh0wnsf --strict-markers --strict-config -c /tmp/tmpdsh0wnsf/pytest.ini
Blender 2.82 (sub 7)
Read prefs: /home/foo/.config/blender/2.82/config/userpref.blend
=================== test session starts ===================
platform linux -- Python 3.8.10, pytest-7.0.1, pluggy-0.13.1 -- /usr/bin/blender
cachedir: .pytest_cache
rootdir: /tmp/tmpyio7hlc2, configfile: pytest.ini
plugins: cov-3.0.0, Faker-12.1.0
collecting ... collected 1 item

tests/test_foo.py::test_foo PASSED

==================== 1 passed in 0.09s ====================Fixtures#blender_executable⇒strReturns the path of the executable that has started the current Blender
session.#blender_version⇒strReturns the version of Blender running in the current session.#blender_python_executable⇒strReturns the path of the Python executable builtin in the Blender release of the
currently running session.#blender_python_version⇒strReturns the version of the Python executable builtin in the Blender release of
the currently running session.#blender_addons_dir⇒strReturns thescripts/addonsdirectory of Blender (seeBlender Directory Layout), the directory in which by default are located
the addons installed using theinstall_addons_from_dirfixture.It tries to get it using theBLENDER_USER_SCRIPTSenvironment variable, but
if is not defined attempts to discover it from thePATH.#install_addons_from_dir(addons_dir,addon_ids=None,save_userpref=True,default_set=True,persistent=True,quiet=True,**kwargs) ⇒listFunction that installs and enables a set of addons which are located in
a directory. By "addons" Blender understands Python scripts whose file names
end with.py,.zipfiles for compressed packages with multiple modules
or directories for Python packages which contain a__init__.pyfile.This function is designed to be executed before the pytest session
to install the addons that you want to test, using the others fixturesdisable_addonsoruninstall_addonsto disable or remove them after the execution of the test suite:importpytest@pytest.fixture(scope="session",autouse=True)defregister_addons(install_addons_from_dir,disable_addons):addons_ids=install_addons_from_dir("src")yielddisable_addons(addons_ids)importpytest@pytest.fixture(scope="session",autouse=True)defregister_addons(install_addons_from_dir,uninstall_addons):addons_ids=install_addons_from_dir("src")yielduninstall_addons(addons_ids)The difference between disabling addons and uninstalling them is that disabling
removes the files from the Blender's addons directory but disabling keep the
files there, allowing you to enable it manually from the preferences.addons_dir(str) Directory in whose root are located the files of the
addons.addons_ids(list) Identifiers of the addons modules, packages or ZIP
files (without extensions) to install. If not defined (default) all Python
modules, Python packages and ZIP files containing addon packages or modules
located at the root of theaddons_dirdirectory will be installed.
These identifiers are either:The name of the module for addons composed by a single file
([identifier].py).The name of the directory for addons composed by a package.The name of the ZIP file without extension for addons composed by a
ZIP file ([identifier].zip).save_userpref(bool) Save user preferences after installation callingbpy.ops.wm.save_userprefdefault_set(bool) Set the user-preference callingaddon_utils.enable.persistent(bool) Ensure that the addon is enabled for the entire
session, after loading new files.quiet(bool) If enabled, don't show standard output produced
installing addons.**kwargs(dict) Subsecuent keyword arguments are passed tobpy.ops.preferences.addon_install.Returns the addons identifiers as a list, ready to be passed todisable_addonsoruninstall_addons.#disable_addons(addons_ids,save_userpref=True,default_set=True,quiet=True,**kwargs)Function that disables a set of addons by addons identifiers. Is designed
to disable your addons after a pytest suite execution (checkinstall_addons_from_dirfor an example).addons_ids(list) Identifiers of the addons modules as are returned byinstall_addons_from_dir.save_userpref(bool) Save user preferences after installation.default_set(bool) Set the user-preference callingaddon_utils.disable.quiet(bool) If enabled, don't show stdout produced disabling addons.**kwargs(dict) Subsecuent keyword arguments are passed toaddon_utils.disable.#uninstall_addons(addons_ids,quiet=True)Function that uninstall a set of addons by addon identifiers. Is designed to
remove your addons from the Blender's addons directory after a pytest suite
execution (checkinstall_addons_from_dirfor an example).addons_ids(list) Name of the addons modules as is returned byinstall_addons_from_dir.quiet(bool) If enabled, don't show stdout produced disabling addons.Arguments propagationWhen you callpytest, all options like--blender-executableare passed
to thepytestsuite runningpytest-blender. If you want to pass arguments
toblenderin its headless execution, add a--betweenpytestandblenderarguments.
For example:pytest-svv--blender-executable~/blender----debugMeasuring code coverageYou can usepytest-covto measure code coverage. If so, instead of
usingblender-addons-dirsconfiguration option
usepytest'spythonpathoption.Example forpytest.ini:[pytest]pythonpath=path/to/blender/addonsaddopts=--cov path/to/blender/addonsCI integrationYou can useblender-downloaderto download multiple
versions of Blender in your CI and test against them. There is an example
for Github Actions in the CI configuration of this repository, something
like:jobs:test:name:Testruns-on:${{ matrix.platform }}strategy:matrix:platform:-ubuntu-latest-macos-latestblender-version:-'3.1.2'-'2.93.9'-'2.83.9'steps:-uses:actions/checkout@v3-name:Set up Python v3.9uses:actions/setup-python@v3with:python-version:3.9-name:Upgrade PIPrun:python -m pip install --upgrade pip-name:Cache Blender ${{ matrix.blender-version }}uses:actions/cache@v3id:cache-blenderwith:path:|blender-*_blender-executable-path.txtkey:${{ runner.os }}-${{ matrix.blender-version }}-name:Download Blender ${{ matrix.blender-version }}if:steps.cache-blender.outputs.cache-hit != 'true'id:download-blenderrun:|python -m pip install --upgrade blender-downloaderprintf "%s" "$(blender-downloader \${{ matrix.blender-version }} --extract --remove-compressed \--quiet --print-blender-executable)" > _blender-executable-path.txt-name:Install dependenciesid:install-dependenciesrun:|python -m pip install .[test]blender_executable="$(< _blender-executable-path.txt)"python_blender_executable="$(pytest-blender --blender-executable $blender_executable)"$python_blender_executable -m ensurepip$python_blender_executable -m pip install pytestecho "blender-executable=$BLENDER_EXECUTABLE" >> $GITHUB_OUTPUT-name:Test with pytestrun:pytest -svv --blender-executable \"${{ steps.install-dependencies.outputs.blender-executable }}" testsVersions compatibilityLatest version that officially supports Python3.6 isv1.2.1.