mcneel / mx_testing

NUnit based and data driven mesh intersection tests

Mesh intersections unit tests

🎯 Goals

This is a an NUnit 3.7 testing project for Mesh Intersection.

Its purpose is to run tests in Visual Studio, without the need of a big setup. In fact, right now there is no automatic testing system before PR are automatically merged.

YOUR TESTS ADDITIONS ARE WELCOME!

🔬 General usage

1. In Visual Studio, open the Rhino.sln solution. It's located in rhino\src4\BuildSolutions.
2. In Visual Studio, choose Tests -> Run All Tests.
3. If the Test panel does not show up, you can open it using Tests -> Test Explorer.
4. You can explore the project in the Solution Explorer panel (Ctrl+Alt+L): you can find the projects in Solution (Rhino) -> Unit Tests.
5. There is a MxTests project and a RhinoCommonDelayed project. The first one is loaded by the testing framework by reflection and does NOT directly use RhinoCommon. This allows to set up hooks and other features to make sure that RhinoCommon is loaded properly, before RhinoCommonDelayed is loaded.
6. There is a setting file located at MxTests -> MxTests.testsettings.xml. There is generally no need to modify any settings.

🆕 New test setup

The MxTests.testsettings.xml file contains settings for model lookup, and directories are specified in the <ModelDirectory> tag.

General notes on test files:

1. When the model is placed in a watched directory, the testing system will automatically load the file, perform splits, and check that the areas and properties match the specifications.
2. When a file in a watched folder starts with an exclamation mark, !, the test will run but will be expected to fail. It is considered a failure of this test, the fact that the test later does not fail.
3. On the contrary, when the name begins with a hash sigh #, the test will be skipped. |
4. When a test fails and that wasn't expected, a debug file with the resulting geometry is created, and its name will be prefixed by the hash sign #. The result is added to the DEBUG layer. |

To add a new _MeshIntersect test:

1. Create a .3dm model with the geometry.
2. Purge all redundant geometry, plug-in data, materials, etc that does not need to be in the model to speed up file loading during each test run.
3. Keep two or more intersecting meshes. / Alternatively, some curves can be kept. They will be transformed into extrusion meshes with the same logic that applies to the MeshIntersect command.
4. Using the _Notes command, type notes following exactly this pattern:
   1. The first line should be "MEASURED INTERSECTION"
   2. Any line that begins with # will be considered a comment
   3. A list of the length of intesection curves sorted smallest to largest
   4. After each value the open/closed flag can be used.

MEASURED INTERSECTIONS
# This is a comment

1.025 closed perforation
2.025 open overlap
3.025

5. The open/closed and the perforation/overlap combos are optional, but the first is required if the second is explicited.
6. When the model is placed in a watched directory, the testing system will automatically load the file, perform intersections, and check that the lenghs and properties match the specifications.

To add a new _MeshSplit test:

1. Create a .3dm model with the geometry.
2. Purge all redundant geometry, plug-in data, materials, etc that does not need to be in the model to speed up file loading during each test run.
3. Keep two layers:
   1. by convention, they should be called A and B. Any other combination of the first two layers in the file will also work.
   2. The first layer will contain the meshes to be split
   3. The second layer the meshes that do the splitting.
   4. Any other layers will be ignored.
4. Using the _Notes command, type use the following pattern:
   1. The first line should be "MEASURED SPLITS"
   2. Any line that begins with # will be considered a comment
   3. A list of the areas of the resulting meshes sorted smallest to largest
   4. After each value the open/closed flag can be used.

MEASURED SPLITS
# This is another comment
# You can link to discourse and YT here: https://discourse.mcneel.com/t/mesh-split-for-sneeze-cfd-not-working/99761
# RH-57844

152382.474 closed
564.53861

When the model is placed in a watched directory, the testing system will automatically load the file, perform splits, and check that the areas and properties match the specifications.

To add a new _MeshBooleanxxxx test:

This logic is used for MeshBooleanUnion, MeshBooleanDifference, MeshBooleanSplit

1. Create a .3dm model with the geometry.
2. Purge all redundant geometry, plug-in data, materials, etc that does not need to be in the model to speed up file loading during each test run.
3. Keep two layers:
   1. By convention, they should be called A and B. Any other combination of the first two layers in the file will also work.
   2. The first layer will contain the meshes to be operated on.
   3. The second layer the meshes that operate on the first layer
   4. Any other layers will be ignored.
4. Using the _Notes command, type use the following pattern:
   1. The first line should be AREA
   2. Any line that begins with # will be considered a comment
   3. A list of the areas of the resulting meshes sorted smallest to largest
   4. Optionally, after each value the open/closed flag can be used.
   5. If the open/closed flag is used also optional mesh properties from the What command can be put in brackets.

AREAS
# This is another comment
# You can link to discourse and YT here: https://discourse.mcneel.com/t/mesh-split-for-sneeze-cfd-not-working/99761
# RH-57844

467.95837
564.53861 closed
152382.474 closed [Valid mesh. Closed double precision polygon mesh: 40 vertices, 19 faces (3 n-gons) Bounding box: (-17.7135,-10.7285,0 to 13.1529,15.6631,26.5192)]

When the model is placed in a watched directory, the testing system will automatically load the file, perform splits, and check that the areas and properties match the specifications.

Notes on inner mechanics

• Internally, all tests use: NUnit.Framework.Assert.IsTrue, NUnit.Framework.Assert.AreEqual, NUnit.Framework.Assert.IsEmpty, etc.
• You can debug tests using Tests -> Debug All Tests.