Cli reader options #1860

0xfedcafe · 2025-01-03T01:19:34Z

Added a CLI reader option #1735

github-actions · 2025-01-03T01:19:46Z

You are modifying libf3d public API! ⚠️Please update bindings accordingly⚠️!
You can find them in their respective directories: python, java, webassembly.

codecov · 2025-01-03T01:38:18Z

Codecov Report

All modified and coverable lines are covered by tests ✅

Project coverage is 95.89%. Comparing base (4bcd2ac) to head (dbaf7ba).
Report is 59 commits behind head on master.

Additional details and impacted files

@@            Coverage Diff             @@
##           master    #1860      +/-   ##
==========================================
+ Coverage   95.75%   95.89%   +0.14%     
==========================================
  Files         123      127       +4     
  Lines       10612    11062     +450     
==========================================
+ Hits        10161    10608     +447     
- Misses        451      454       +3

☔ View full report in Codecov by Sentry.
📢 Have feedback on the report? Share it here.

🚀 New features to boost your workflow:

❄️ Test Analytics: Detect flaky tests, report on failures, and find test suite problems.
📦 JS Bundle Analysis: Save yourself from yourself by tracking and limiting bundle sizes in JS merges.

library/options.json

application/F3DOptionsTools.cxx

application/F3DOptionsTools.h

library/src/factory.cxx.in

library/testing/TestSDKReaderSelection.cxx

application/F3DOptionsTools.cxx

doc/user/OPTIONS.md

library/src/factory.cxx.in

application/F3DOptionsTools.cxx

mwestphal · 2025-01-28T16:10:55Z

Do you need any help or review to move forward @0xfedcafe ?

0xfedcafe · 2025-01-28T20:42:05Z

Do you need any help or review to move forward @0xfedcafe ?

Just that upper question about an optional and I’ll push hopefully the final commit for this task with the test

mwestphal · 2025-02-22T09:20:25Z

Hi @0xfedcafe

How is it going ? Do you need any help ?

mwestphal · 2025-03-01T11:36:33Z

Hi @0xfedcafe

Please do not hesitate to reach out if you need any guidance :)

mwestphal · 2025-03-10T05:58:52Z

Hi @0xfedcafe !

Do you need a review or help with CI ?

0xfedcafe · 2025-03-12T11:40:54Z

Hi @0xfedcafe !

Do you need a review or help with CI ?

yes, i think a hint would be very helpful. i can't find why in some tests where the necessary plugins are loaded and the reader is not nullptr it still fails with "unsupported file format"

application/testing/CMakeLists.txt

doc/libf3d/OPTIONS.md

doc/user/OPTIONS.md

library/private/factory.h

fixes by mwestphal Co-authored-by: Mathieu Westphal <[email protected]>

mwestphal · 2025-03-13T20:57:10Z

There a small conflict to fix with master, let me know if you need help with that

mwestphal · 2025-03-24T20:33:58Z

Hi @0xfedcafe

Do you need help moving forward ?

mwestphal · 2025-04-21T06:26:28Z

Hi @0xfedcafe

Do you need help moving forward ?

0xfedcafe · 2025-04-21T15:08:21Z

Hi @0xfedcafe

Do you need help moving forward ?

Hey, yes, I would like to know whether I'm allowed to simply do a disjunction of the parts of error messages in failing test in my test as a regexp or that would be a bad solution? Because I'm unsure why it fails on different platforms with different error messages and I had no access to Linux/Windows so I couldn't test that.

mwestphal · 2025-04-21T17:10:34Z

Hi @0xfedcafe
Do you need help moving forward ?

Hey, yes, I would like to know whether I'm allowed to simply do a disjunction of the parts of error messages in failing test in my test as a regexp or that would be a bad solution? Because I'm unsure why it fails on different platforms with different error messages and I had no access to Linux/Windows so I couldn't test that.

I'm confused a bit by your question, lets discuss on discord ? :)

mwestphal · 2025-04-28T05:30:46Z

application/testing/CMakeLists.txt

@@ -1159,6 +1159,16 @@ if(F3D_PLUGIN_BUILD_ALEMBIC AND F3D_PLUGIN_BUILD_ASSIMP)
  f3d_test(NAME TestReadersListMultiplePlugins ARGS --list-readers --load-plugins=assimp,alembic NO_BASELINE REGEXP_FAIL "Plugin failed to load")
 endif()

+if(F3D_PLUGIN_BUILD_EXODUS) 
+ f3d_test(NAME TestForceReaderExodusFail DATA BoxAnimated.gltf ARGS --load-plugins=exodus --force-reader=ExodusII NO_BASELINE REGEXP "is not a file of a supported file format|failed to load scene")
+ f3d_test(NAME TestForceReaderExodusPass DATA disk_out_ref.ex2 ARGS --load-plugins=exodus --force-reader=ExodusII NO_BASELINE REGEXP_FAIL "is not a file of a supported file format|failed to load scene")


you need to put these test behind a if(VTK_VERSION VERSION_GREATER_EQUAL 9.3.20240707) because before that VTK did not provide feedback if a importer worked or not.

mwestphal · 2025-04-28T05:30:55Z

application/testing/CMakeLists.txt

@@ -1159,6 +1159,16 @@ if(F3D_PLUGIN_BUILD_ALEMBIC AND F3D_PLUGIN_BUILD_ASSIMP)
  f3d_test(NAME TestReadersListMultiplePlugins ARGS --list-readers --load-plugins=assimp,alembic NO_BASELINE REGEXP_FAIL "Plugin failed to load")
 endif()

+if(F3D_PLUGIN_BUILD_EXODUS) 
+ f3d_test(NAME TestForceReaderExodusFail DATA BoxAnimated.gltf ARGS --load-plugins=exodus --force-reader=ExodusII NO_BASELINE REGEXP "is not a file of a supported file format|failed to load scene")


Suggested change

f3d_test(NAME TestForceReaderExodusFail DATA BoxAnimated.gltf ARGS --load-plugins=exodus --force-reader=ExodusII NO_BASELINE REGEXP "is not a file of a supported file format|failed to load scene")

f3d_test(NAME TestForceReaderExodusFail DATA BoxAnimated.gltf ARGS --load-plugins=exodus --force-reader=ExodusII NO_BASELINE REGEXP "failed to load scene")

mwestphal · 2025-04-28T05:34:58Z

application/testing/CMakeLists.txt

+
+if(F3D_PLUGIN_BUILD_DRACO) 
+ f3d_test(NAME TestForceReaderGLTFDraco DATA BoxAnimated.gltf ARGS --load-plugins=draco --force-reader=GLTFDraco NO_BASELINE REGEXP_FAIL "is not a file of a supported file format|failed to load scene")
+ f3d_test(NAME TestForceReaderGLTF DATA BoxAnimated.gltf ARGS --load-plugins=draco --force-reader=GLTF NO_BASELINE REGEXP_FAIL "is not a file of a supported file format|failed to load scene")


I dont get what these two tests are testing here. I think you want a test like this:

f3d_test(NAME TestForceReaderGLTFDracoIntoGLTF DATA Box_draco.gltf ARGS --load-plugins=draco --force-reader=GLTF NO_BASELINE REGEXP "failed to load scene")

Basically, testing that you can force the usage of the GLTF importer instead of the GLTFDraco importer even when the draco importer is loaded. The test then check that the file is not loaded at all because it needs GLTFDraco to be able to load.

mwestphal · 2025-04-28T05:38:20Z

application/testing/CMakeLists.txt

@@ -1159,6 +1159,16 @@ if(F3D_PLUGIN_BUILD_ALEMBIC AND F3D_PLUGIN_BUILD_ASSIMP)
  f3d_test(NAME TestReadersListMultiplePlugins ARGS --list-readers --load-plugins=assimp,alembic NO_BASELINE REGEXP_FAIL "Plugin failed to load")
 endif()

+if(F3D_PLUGIN_BUILD_EXODUS) 
+ f3d_test(NAME TestForceReaderExodusFail DATA BoxAnimated.gltf ARGS --load-plugins=exodus --force-reader=ExodusII NO_BASELINE REGEXP "is not a file of a supported file format|failed to load scene")
+ f3d_test(NAME TestForceReaderExodusPass DATA disk_out_ref.ex2 ARGS --load-plugins=exodus --force-reader=ExodusII NO_BASELINE REGEXP_FAIL "is not a file of a supported file format|failed to load scene")


but these tests should not rely on exodus plugin being present tbh, you can just test using native provided importer, like obj and stl, eg;

f3d_test(NAME TestForceReaderFail DATA suzanne.stl ARGS --force-reader=OBJ NO_BASELINE REGEXP "failed to load scene") f3d_test(NAME TestForceReaderPass DATA suzanne.stl ARGS --force-reader=STL NO_BASELINE REGEXP "some log that you need to add") f3d_test(NAME TestForceReaderInvalid DATA suzanne.stl ARGS --force-reader=INVALID NO_BASELINE REGEXP "some log that you need to add")

mwestphal · 2025-04-28T05:40:11Z

library/src/scene_impl.cxx

@@ -240,7 +242,8 @@ scene& scene_impl::add(const std::vector<fs::path>& filePaths)
    }

    // Recover the importer for the provided file path
-    f3d::reader* reader = f3d::factory::instance()->getReader(filePath.string());
+    f3d::reader* reader = f3d::factory::instance()->getReader(
+      filePath.string(), this->Internals->Options.scene.force_reader);
    if (reader)
    {
      log::debug(


maybe improve this log to dinstinguish between:

"Found a reader for .."

"Forcing BLABLA reader for"

and maybe the exception below should also be improved, to dinstinguish when a reader was not found vs when the forced reader did not exists at all.

0xfedcafe added 4 commits January 3, 2025 00:46

implemented reader option

917db39

Merge branch 'f3d-app:master' into cli-reader-options

a039ed0

added test & bugfix

c85a20c

spelling correction

45ba1a9

reformat

5b00fcb

mwestphal reviewed Jan 3, 2025

View reviewed changes

library/options.json Outdated Show resolved Hide resolved

mwestphal reviewed Jan 3, 2025

View reviewed changes

application/F3DOptionsTools.cxx Outdated Show resolved Hide resolved

mwestphal reviewed Jan 3, 2025

View reviewed changes

application/F3DOptionsTools.h Outdated Show resolved Hide resolved

0xfedcafe added 3 commits January 3, 2025 17:35

Merge branch 'f3d-app:master' into cli-reader-options

be829e3

force-reader to scene & fixes

e916daf

bugfix

17c2dda