maxpytest 1.0.1

Command line utility for using the Pytest testing framework in 3ds Max

Overview

Command line utility for using the Pytest testing framework in 3ds Max

• Run tests with all 3ds Max Python APIs, including GUI/PySide2 libraries
• Source dependencies from a pipenv virtual environment; no need to install pip to 3ds Max
• Automate a new 3ds Max/python session for each tests invocation

Setup

Install with pip

Install with pip using Python 2.7:

pip install maxpytest

Setup pipenv

When run from a project root, modules installed to the project's associated pipenv virtual environment. To use a virtual environment associated with another directory (where Pipfile/Pipfile.lock are located) override the current working dir with maxpytest --cwd.

If you already have a pipenv virtual environment for your project, make sure it has pytest installed.

To install pipenv, run from your project root:

pip install pipenv

Then, setup a pipenv virtual environment:

pipenv --python 2.7 install

Add pytest to the virtual environment:

pipenv install pytest

Usage

Due to the caching mechanism of python's import system and Pytest's design, changes made to test files (and any modules they import) will not be reflected in subsequent Pytest invocations in the same python process. This means ensuring that your changes are reflected requires a restart of the 3ds Max/python session. You have a few options:

For maxpytest to handle closing and relaunching 3ds Max automatically: Run tests using MXSPyCOM

For a simple setup, or if targeting multiple 3ds Max versions: Run tests directly with 3ds Max

Run your tests using MXSPyCOM

If tests are invoked with MXSPyCOM, closing and relaunching 3ds Max is handled automatically. Any unsaved work will trigger a prompt to save it before closing.

For more about MXSPyCOM see the wiki.

To invoke your tests, use maxpytest -m [path to MXSPyCOM.exe] -py [pytest args], with Pytest args following -py or --pytest as the final command argument.

For example:

# Relaunch 3ds Max then invoke pytest from current working dir with verbose
maxpytest -m "C:\\Program Files\\MXSPyCOM\\MXSPyCOM.exe" -py -v .

# Relaunch 3ds Max then invoke pytest in directory ./tests
maxpytest -m "C:\\Program Files\\MXSPyCOM\\MXSPyCOM.exe" -py tests/

# Skip relaunch and just invoke pytest in directory ./tests
maxpytest -m "C:\\Program Files\\MXSPyCOM\\MXSPyCOM.exe" --no-restart -py tests/

Test results print to the 3ds Max Listener.

Run your tests directly with 3ds Max

To run tests in 3ds max without using MXSPyCOM, use -m/--max with the version year of the 3ds Max you wish to target, or a full path to 3dsmax.exe.

For example:

# Invoke pytest from current working dir in a new instance of 3ds Max 2019
maxpytest -m "C:\\Program Files\\Autodesk\\3ds Max 2019\\3dsmax.exe"

# Invoke pytest from current working dir in a new instance of 3ds Max 2019
maxpytest -m 2019

# Invoke pytest from current working dir and run tests in ./tests
maxpytest -m 2016 -py tests/ -v

Test results will print to the 3ds Max Listener.

Contact

For questions, support, or feature requests, please open an issue or reach out at [e-mail] .