Skip to content

Latest commit

 

History

History
 
 

MaterialXTest

Folders and files

NameName
Last commit message
Last commit date

parent directory

..
Catch
Catch
 
 
CMakeLists.txt
CMakeLists.txt
 
 
Document.cpp
Document.cpp
 
 
Element.cpp
Element.cpp
 
 
File.cpp
File.cpp
 
 
GenGlsl.cpp
GenGlsl.cpp
 
 
GenGlsl.h
GenGlsl.h
 
 
GenOsl.cpp
GenOsl.cpp
 
 
GenOsl.h
GenOsl.h
 
 
GenShader.cpp
GenShader.cpp
 
 
GenShaderUtil.cpp
GenShaderUtil.cpp
 
 
GenShaderUtil.h
GenShaderUtil.h
 
 
Geom.cpp
Geom.cpp
 
 
Look.cpp
Look.cpp
 
 
Main.cpp
Main.cpp
 
 
Material.cpp
Material.cpp
 
 
Node.cpp
Node.cpp
 
 
Observer.cpp
Observer.cpp
 
 
README.md
README.md
 
 
Render.cpp
Render.cpp
 
 
RenderGlsl.cpp
RenderGlsl.cpp
 
 
RenderOsl.cpp
RenderOsl.cpp
 
 
RenderUtil.cpp
RenderUtil.cpp
 
 
RenderUtil.h
RenderUtil.h
 
 
Traversal.cpp
Traversal.cpp
 
 
Types.cpp
Types.cpp
 
 
Util.cpp
Util.cpp
 
 
Value.cpp
Value.cpp
 
 
XmlIo.cpp
XmlIo.cpp
 
 

README.md

Unit tests

Unit tests can be run using the MaterialXTest executable. This can be performed using ctest or directly running the executable with the desired test tag(s). The default build options executes all tags except the ones using for shader compilation and rendering.

1. Core Tests

The names of the files reflect the Element type being tested for the following:

  • Document.cpp
  • Element.cpp
  • Geom.cpp
  • Look.cpp
  • Material.cpp
  • Node.cpp
  • Types.cpp
  • Value.cpp

2. Document utilities

  • Observer.cpp : Document observation.
  • Traversal.cpp : Document traversal.
  • Util.cpp : Basic utilities.

3. I/O Tests

  • File.cpp : Basic file path tests.
  • XmlIo.cpp : XML document I/O tests.

4. Render Test Suite

4.1 Test Inputs

Refer to the test suite documentation for more information about the organization of the test suite data used for these tests.

4.2 Shader Generation Tests

  • GenShader.cpp : Core shader generation tests which are run when the test tag [genshader] is specified.
  • GenOsl.cpp : OSL shader generation tests which are run when the test tag [genosl] is specified.
  • GenGlsl.cpp : GLSL shader generation tests which are run when the test tag [genglsl] is specified.

Per language tests will scan MaterialX files in the test suite for input Elements.

Test Outputs

Depending on which tests are executed log files are produced at the location that MaterialXTest was executed.

  • gen<language>_<target>_generatetest.txt: Contains a log of generation for a give language and target pair.
  • gen<language>_<target>_implementation_check.txt: Contains a log of whether implementations exist for all nodedefs for a given language and target pair.

4.3 Rendering Tests

  • Render.cpp : Core render tests which are run when the test tag [rendercore] is specified.
  • RenderOsl.cpp : OSL render tests which are run when the test tag [renderosl] is specified.
  • RenderGlsl.cpp : GLSL render tests which are run when the test tag [renderglsl] is specified.

Per language tests will scan MaterialX files in the test suite for input Elements.

Per Language Render Setup

If rendering tests are enabled via the build options then code for each Element tested will be compiled and rendered if the appropriate backend support is available.

  • GLSL:
    • Will execute on a Windows machine which supports OpenGL 4.0 or above.
  • OSL: Uses the utilities oslc and testrender utilities from the OSL distribution.
    • The utilities are not generated as part of the MaterialX build.
    • The test suite has been tested with version 1.9.10.
    • The following build options are required to be set:
      • MATERIALX_OSLC_EXECUTABLE: Full path to the oslc binary.
      • MATERIALX_TESTRENDER_EXECUTABLE: Full path to the testrender binary.
      • MATERIALX_OSL_INCLUDE_PATH: Full path to OSL include paths (i.e. location of stdosl.h).

Test Outputs

  • gen<language>_<target>_render_doc_validation_log.txt: Contains a log of whether input document validation check errors for a language and target pair.
  • gen<language>_<target>_render_profiling_log.txt: Contains a log of execution times for a give language and target pair.
  • gen<language>_<target>_render_log.txt: Contains a log of compilation and rendering checks for a language and target pair. Note that if an error occurred a reference to a per Element error file will be given.
HTML Preview Script
  • A Python utility is provided in python/MaterialXTest which can be run to generate an HTML file with the rendered images referenced for visual checking. It assumes that both GLSL and OSL rendering has been performed.