Skip to content

Add a way to correctly handle references that are in Regression #78

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
hugtalbot merged 8 commits into from
Apr 2, 2025
Merged

Add a way to correctly handle references that are in Regression #78

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
8 commits
Select commit Hold shift + click to select a range
1dde840
Use $REFERENCE_DIR in reference file
bakpaul Mar 28, 2025
ebf3dee
Update env variable name
bakpaul Mar 28, 2025
dbee8ec
Update readme
bakpaul Mar 28, 2025
971ad6b
fix env variable
bakpaul Mar 28, 2025
9c14918
Add information for debug
bakpaul Mar 28, 2025
6c3b870
Fix compilation
bakpaul Mar 28, 2025
2e6869c
Fix path
bakpaul Mar 28, 2025
bf71b41
Fix regression
bakpaul Mar 28, 2025
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
18 changes: 16 additions & 2 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -15,7 +15,16 @@ SOFA Regression Documentation
## 1.a - Non regression-tests files ##
The **Regression_test** program will search for **\*.regression-tests** files in the target directory (SOFA directory).
This file contains a list of scene to be tested.
Each line of the list file must contain:

The first information that is not a comment in this file should be the path to the reference folder containing all data needed for regression testing. This path should be relative to this folder path.
The folder should be structured as the folder containing this file and each reference of each scene should have a relative path to the reference folder equivalent to the relative path of the corresponding scene in this folder.

--> e.g. for the scene in `very/specific/path/to/MyScene.scn`, a reference with the same name as the scene should be found in `referenceFolder/very/specific/path/to`

--> A special string can be use while specifying this path: `$REGRESSION_DIR`. If used at the beginning of the path, then it will be used as an absolute path with `$REGRESSION_DIR` replaced by the content of the environment variable with the same name.
Use this, when the reference are not in the repository containing the examples but directly in the repo Regression

Each following line of the list file must contain:
1. A local path to the scene
2. The number of simulation steps to run
3. A numerical epsilon for comparison
Expand All @@ -25,6 +34,10 @@ Each line of the list file must contain:
See for example: SOFA_DIR/examples/RegressionStateScenes.regression-tests
```
### Demo scenes ###
# References folder
../path/to/the/references (OR $REGRESSION_DIR/path/to/the/references)

# Tested Scenes
Demos/caduceus.scn 100 1e-3 0 1
Demos/TriangleSurfaceCutting.scn 100 1e-4 1 1
Demos/liver.scn 100 1e-4 1 1
Expand Down Expand Up @@ -62,7 +75,8 @@ For the moment non regression tests class are:
## 2.a - Full solution: By setting up environment
The program **Regression_test** can not take arguments because of its internal mechanism. Thus to run it correctly, several Environment variables need to be set :
- REGRESSION_SCENES_DIR : path to the root folder containing the scenes (usually SOFA_SRC_DIR/examples)
- REGRESSION_REFERENCES_DIR : path to the root folder containing the references (this repository/References)
- REGRESSION_REFERENCES_DIR : path to the root folder containing the references (this repository/References). The reference file normally provides a path to the reference directory, but when it doesn't exist, this will be the fallback.
- REGRESSION_DIR : path to the root directory of this project sources. This is only required when the references used by your project are in the Regression repo (this is the case for SOFA). If so, the path specified in your reference file should start with `$REGRESSION_DIR`
- SOFA_ROOT : path to sofa build directory.
- SOFA_PLUGIN_PATH : path to the plugin library to be loaded by "required plugin" in the scenes (usually SOFA_ROOT/lib)

Expand Down
26 changes: 24 additions & 2 deletions Regression_test/RegressionSceneList.inl
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -32,6 +32,8 @@ using sofa::helper::system::FileSystem;

#include <gtest/gtest.h>

#include <string>

namespace sofa
{

Expand Down Expand Up @@ -110,10 +112,28 @@ void RegressionSceneList<T>::collectScenesFromList(const std::string& scenesDir,
break;
}

std::string fullPathReferenceDir = listDir + "/" + referencesDir;
std::string fullPathReferenceDir;
//Check if reference dir starts with $REGRESSION_DIR
if (referencesDir.starts_with("$REGRESSION_DIR"))
{
char* refDirVar = getenv("REGRESSION_DIR");
if (refDirVar == nullptr)
{
msg_error(msgHeader) << "The reference path contains '$REGRESSION_DIR', and the environment variable REGRESSION_DIR is not set.";
return;
}
msg_info(msgHeader)<<"Use REGRESSION_DIR as prefix";
fullPathReferenceDir = std::string(refDirVar) + referencesDir.substr(15);
}
else
{
fullPathReferenceDir = listDir + "/" + referencesDir;
}

// Check if the reference folder does exist
if (!referencesDir.empty())
{
msg_info(msgHeader)<<"Regression file path : "<<fullPathReferenceDir;
if (!sofa::helper::system::FileSystem::exists(fullPathReferenceDir))
{
// relative reference path is wrong, check if the user set a env var instead
Expand Down Expand Up @@ -197,9 +217,11 @@ void RegressionSceneList<T>::collectScenesFromList(const std::string& scenesDir,
if (results.size() > 5)
period = std::stoi(results[5]);



std::string scene = listDir + "/" + sceneFromList;
std::string sceneFromScenesDir(scene);
sceneFromScenesDir.erase( sceneFromScenesDir.find(scenesDir+"/"), scenesDir.size()+1 );
sceneFromScenesDir.erase( sceneFromScenesDir.find(scenesDir+(scenesDir[scenesDir.size()-1] == '/' ? "" : "/")), scenesDir.size()+1 );
std::string reference = fullPathReferenceDir + "/" + sceneFromList + ".reference";

#ifdef WIN32
Expand Down