Python tests: Split re-usable test related functionality to a module
[blender-staging.git] / tests / python / modules / test_utils.py
1 #!/usr/bin/env python3
2 # ##### BEGIN GPL LICENSE BLOCK #####
3 #
4 #  This program is free software; you can redistribute it and/or
5 #  modify it under the terms of the GNU General Public License
6 #  as published by the Free Software Foundation; either version 2
7 #  of the License, or (at your option) any later version.
8 #
9 #  This program is distributed in the hope that it will be useful,
10 #  but WITHOUT ANY WARRANTY; without even the implied warranty of
11 #  MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
12 #  GNU General Public License for more details.
13 #
14 #  You should have received a copy of the GNU General Public License
15 #  along with this program; if not, write to the Free Software Foundation,
16 #  Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA.
17 #
18 # ##### END GPL LICENSE BLOCK #####
19
20 # <pep8 compliant>
21
22 import argparse
23 import functools
24 import shutil
25 import pathlib
26 import re
27 import subprocess
28 import sys
29 import tempfile
30 import unittest
31
32
33 def with_tempdir(wrapped):
34     """Creates a temporary directory for the function, cleaning up after it returns normally.
35
36     When the wrapped function raises an exception, the contents of the temporary directory
37     remain available for manual inspection.
38
39     The wrapped function is called with an extra positional argument containing
40     the pathlib.Path() of the temporary directory.
41     """
42
43     @functools.wraps(wrapped)
44     def decorator(*args, **kwargs):
45         dirname = tempfile.mkdtemp(prefix='blender-alembic-test')
46         try:
47             retval = wrapped(*args, pathlib.Path(dirname), **kwargs)
48         except:
49             print('Exception in %s, not cleaning up temporary directory %s' % (wrapped, dirname))
50             raise
51         else:
52             shutil.rmtree(dirname)
53         return retval
54
55     return decorator
56
57
58 class AbstractBlenderRunnerTest(unittest.TestCase):
59     """Base class for all test suites which needs to run Blender"""
60
61     @classmethod
62     def setUpClass(cls):
63         global args
64         cls.blender = args.blender
65         cls.testdir = pathlib.Path(args.testdir)
66
67     def run_blender(self, filepath: str, python_script: str, timeout: int=300) -> str:
68         """Runs Blender by opening a blendfile and executing a script.
69
70         Returns Blender's stdout + stderr combined into one string.
71
72         :param filepath: taken relative to self.testdir.
73         :param timeout: in seconds
74         """
75
76         blendfile = self.testdir / filepath
77
78         command = (
79             self.blender,
80             '--background',
81             '-noaudio',
82             '--factory-startup',
83             '--enable-autoexec',
84             str(blendfile),
85             '-E', 'CYCLES',
86             '--python-exit-code', '47',
87             '--python-expr', python_script,
88         )
89
90         proc = subprocess.run(command, stdout=subprocess.PIPE, stderr=subprocess.STDOUT,
91                               timeout=timeout)
92         output = proc.stdout.decode('utf8')
93         if proc.returncode:
94             self.fail('Error %d running Blender:\n%s' % (proc.returncode, output))
95
96         return output
97