Fail test if no scene can be created

Replace current print by a FAIL in Gtest to make the test that can not create an scene to fail. This should help to avoid false positives in testing. Signed-off-by: Jose Luis Rivero <[email protected]>
gazebosim · Dec 3, 2024 · 0b76fce · 0b76fce
1 parent dd143fb
commit 0b76fce
Show file tree

Hide file tree

Showing 36 changed files with 161 additions and 72 deletions.
diff --git a/src/ArrowVisual_TEST.cc b/src/ArrowVisual_TEST.cc
@@ -52,9 +52,8 @@ void ArrowVisualTest::ArrowVisual(const std::string &_renderEngine)
   RenderEngine *engine = rendering::engine(_renderEngine);
   if (!engine)
   {
-    igndbg << "Engine '" << _renderEngine
-           << "' is not supported" << std::endl;
-    return;
+    FAIL() << "Engine '" << _renderEngine
+      << "' is not supported" << std::endl;
   }
 
   ScenePtr scene = engine->CreateScene("scene");

diff --git a/src/AxisVisual_TEST.cc b/src/AxisVisual_TEST.cc
@@ -52,7 +52,7 @@ void AxisVisualTest::AxisVisual(const std::string &_renderEngine)
   RenderEngine *engine = rendering::engine(_renderEngine);
   if (!engine)
   {
-    igndbg << "Engine '" << _renderEngine
+    FAIL() << "Engine '" << _renderEngine
            << "' is not supported" << std::endl;
     return;
   }

diff --git a/src/BoundingBoxCamera_TEST.cc b/src/BoundingBoxCamera_TEST.cc
@@ -42,7 +42,7 @@ void BoundingBoxCameraTest::BoundingBoxCamera(const std::string &_renderEngine)
   if (_renderEngine.compare("optix") == 0 ||
       _renderEngine.compare("ogre") == 0)
   {
-    igndbg << "Engine '" << _renderEngine
+    FAIL() << "Engine '" << _renderEngine
            << "' doesn't support bounding box cameras" << std::endl;
     return;
   }
@@ -51,7 +51,7 @@ void BoundingBoxCameraTest::BoundingBoxCamera(const std::string &_renderEngine)
   RenderEngine *engine = rendering::engine(_renderEngine);
   if (!engine)
   {
-    igndbg << "Engine '" << _renderEngine
+    FAIL() << "Engine '" << _renderEngine
               << "' is not supported" << std::endl;
     return;
   }

diff --git a/src/COMVisual_TEST.cc b/src/COMVisual_TEST.cc
@@ -43,7 +43,7 @@ void COMVisualTest::COMVisual(const std::string &_renderEngine)
   RenderEngine *engine = rendering::engine(_renderEngine);
   if (!engine)
   {
-    igndbg << "Engine '" << _renderEngine
+    FAIL() << "Engine '" << _renderEngine
               << "' is not supported" << std::endl;
     return;
   }

diff --git a/src/Camera_TEST.cc b/src/Camera_TEST.cc
@@ -64,7 +64,7 @@ void CameraTest::ViewProjectionMatrix(const std::string &_renderEngine)
   RenderEngine *engine = rendering::engine(_renderEngine);
   if (!engine)
   {
-    igndbg << "Engine '" << _renderEngine
+    FAIL() << "Engine '" << _renderEngine
               << "' is not supported" << std::endl;
     return;
   }
@@ -171,7 +171,7 @@ void CameraTest::RenderTexture(const std::string &_renderEngine)
   RenderEngine *engine = rendering::engine(_renderEngine);
   if (!engine)
   {
-    igndbg << "Engine '" << _renderEngine
+    FAIL() << "Engine '" << _renderEngine
               << "' is not supported" << std::endl;
     return;
   }
@@ -229,7 +229,7 @@ void CameraTest::TrackFollow(const std::string &_renderEngine)
   RenderEngine *engine = rendering::engine(_renderEngine);
   if (!engine)
   {
-    igndbg << "Engine '" << _renderEngine
+    FAIL() << "Engine '" << _renderEngine
               << "' is not supported" << std::endl;
     return;
   }
@@ -305,7 +305,7 @@ void CameraTest::AddRemoveRenderPass(const std::string &_renderEngine)
   RenderEngine *engine = rendering::engine(_renderEngine);
   if (!engine)
   {
-    igndbg << "Engine '" << _renderEngine
+    FAIL() << "Engine '" << _renderEngine
               << "' is not supported" << std::endl;
     return;
   }
@@ -363,7 +363,7 @@ void CameraTest::VisibilityMask(const std::string &_renderEngine)
   RenderEngine *engine = rendering::engine(_renderEngine);
   if (!engine)
   {
-    igndbg << "Engine '" << _renderEngine
+    FAIL() << "Engine '" << _renderEngine
               << "' is not supported" << std::endl;
     return;
   }
@@ -400,7 +400,7 @@ void CameraTest::IntrinsicMatrix(const std::string &_renderEngine)
   RenderEngine *engine = rendering::engine(_renderEngine);
   if (!engine)
   {
-    igndbg << "Engine '" << _renderEngine
+    FAIL() << "Engine '" << _renderEngine
               << "' is not supported" << std::endl;
     return;
   }

diff --git a/src/Capsule_TEST.cc b/src/Capsule_TEST.cc
@@ -53,7 +53,7 @@ void CapsuleTest::Capsule(const std::string &_renderEngine)
   RenderEngine *engine = rendering::engine(_renderEngine);
   if (!engine)
   {
-    igndbg << "Engine '" << _renderEngine
+    FAIL() << "Engine '" << _renderEngine
            << "' is not supported" << std::endl;
     return;
   }

diff --git a/src/GaussianNoisePass_TEST.cc b/src/GaussianNoisePass_TEST.cc
@@ -43,7 +43,7 @@ void GaussianNoisePassTest::GaussianNoise(const std::string &_renderEngine)
   RenderEngine *engine = rendering::engine(_renderEngine);
   if (!engine)
   {
-    igndbg << "Engine '" << _renderEngine
+    FAIL() << "Engine '" << _renderEngine
               << "' is not supported" << std::endl;
     return;
   }

diff --git a/src/GizmoVisual_TEST.cc b/src/GizmoVisual_TEST.cc
@@ -46,7 +46,7 @@ void GizmoVisualTest::GizmoVisual(const std::string &_renderEngine)
   RenderEngine *engine = rendering::engine(_renderEngine);
   if (!engine)
   {
-    igndbg << "Engine '" << _renderEngine
+    FAIL() << "Engine '" << _renderEngine
               << "' is not supported" << std::endl;
     return;
   }
@@ -117,7 +117,7 @@ void GizmoVisualTest::Material(const std::string &_renderEngine)
   RenderEngine *engine = rendering::engine(_renderEngine);
   if (!engine)
   {
-    igndbg << "Engine '" << _renderEngine
+    FAIL() << "Engine '" << _renderEngine
               << "' is not supported" << std::endl;
     return;
   }

diff --git a/src/Grid_TEST.cc b/src/Grid_TEST.cc
@@ -51,7 +51,7 @@ void GridTest::Grid(const std::string &_renderEngine)
   RenderEngine *engine = rendering::engine(_renderEngine);
   if (!engine)
   {
-    igndbg << "Engine '" << _renderEngine
+    FAIL() << "Engine '" << _renderEngine
            << "' is not supported" << std::endl;
     return;
   }

diff --git a/src/Heightmap_TEST.cc b/src/Heightmap_TEST.cc
@@ -54,7 +54,7 @@ TEST_P(HeightmapTest, IGN_UTILS_TEST_ENABLED_ONLY_ON_LINUX(Heightmap))
   auto engine = rendering::engine(renderEngine);
   if (!engine)
   {
-    igndbg << "Engine '" << renderEngine
+    FAIL() << "Engine '" << renderEngine
            << "' is not supported" << std::endl;
     return;
   }

diff --git a/src/InertiaVisual_TEST.cc b/src/InertiaVisual_TEST.cc
@@ -43,7 +43,7 @@ void InertiaVisualTest::InertiaVisual(const std::string &_renderEngine)
   RenderEngine *engine = rendering::engine(_renderEngine);
   if (!engine)
   {
-    igndbg << "Engine '" << _renderEngine
+    FAIL() << "Engine '" << _renderEngine
               << "' is not supported" << std::endl;
     return;
   }

diff --git a/src/JointVisual_TEST.cc b/src/JointVisual_TEST.cc
@@ -47,7 +47,7 @@ void JointVisualTest::JointVisual(const std::string &_renderEngine)
   RenderEngine *engine = rendering::engine(_renderEngine);
   if (!engine)
   {
-    igndbg << "Engine '" << _renderEngine
+    FAIL() << "Engine '" << _renderEngine
            << "' is not supported" << std::endl;
     return;
   }

diff --git a/src/LidarVisual_TEST.cc b/src/LidarVisual_TEST.cc
@@ -52,7 +52,7 @@ void LidarVisualTest::LidarVisual(const std::string &_renderEngine)
   RenderEngine *engine = rendering::engine(_renderEngine);
   if (!engine)
   {
-    igndbg << "Engine '" << _renderEngine
+    FAIL() << "Engine '" << _renderEngine
            << "' is not supported" << std::endl;
     return;
   }

diff --git a/src/LightVisual_TEST.cc b/src/LightVisual_TEST.cc
@@ -47,7 +47,7 @@ void LightVisualTest::LightVisual(const std::string &_renderEngine)
   RenderEngine *engine = rendering::engine(_renderEngine);
   if (!engine)
   {
-    igndbg << "Engine '" << _renderEngine
+    FAIL() << "Engine '" << _renderEngine
               << "' is not supported" << std::endl;
     return;
   }

diff --git a/src/Light_TEST.cc b/src/Light_TEST.cc
@@ -47,7 +47,7 @@ void LightTest::Light(const std::string &_renderEngine)
   RenderEngine *engine = rendering::engine(_renderEngine);
   if (!engine)
   {
-    igndbg << "Engine '" << _renderEngine
+    FAIL() << "Engine '" << _renderEngine
            << "' is not supported" << std::endl;
     return;
   }

diff --git a/src/LoadOgre2_TEST.cc b/src/LoadOgre2_TEST.cc
@@ -0,0 +1,45 @@
+/*
+ * Copyright (C) 2024 Open Source Robotics Foundation
+ *
+ * Licensed under the Apache License, Version 2.0 (the "License");
+ * you may not use this file except in compliance with the License.
+ * You may obtain a copy of the License at
+ *
+ *     http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ *
+*/
+
+#include <gtest/gtest.h>
+
+#include <gz/common/Console.hh>
+
+#include "test_config.h"  // NOLINT(build/include)
+
+#include "gz/rendering/RenderingIface.hh"
+#include "gz/rendering/RenderEngine.hh"
+
+using namespace gz;
+using namespace rendering;
+
+TEST(LoadOgre2Test, LoadOgre2)
+{
+  // Get engine
+  auto engine = rendering::engine("ogre2");
+  ASSERT_NE(nullptr, engine) << "Unable to load ogre2 render engine"
+                             << std::endl;
+
+  // Clean up
+  unloadEngine(engine->Name());
+}
+
+int main(int argc, char **argv)
+{
+  ::testing::InitGoogleTest(&argc, argv);
+  return RUN_ALL_TESTS();
+}
diff --git a/src/LoadOgre_TEST.cc b/src/LoadOgre_TEST.cc
@@ -0,0 +1,45 @@
+/*
+ * Copyright (C) 2024 Open Source Robotics Foundation
+ *
+ * Licensed under the Apache License, Version 2.0 (the "License");
+ * you may not use this file except in compliance with the License.
+ * You may obtain a copy of the License at
+ *
+ *     http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ *
+*/
+
+#include <gtest/gtest.h>
+
+#include <gz/common/Console.hh>
+
+#include "test_config.h"  // NOLINT(build/include)
+
+#include "gz/rendering/RenderingIface.hh"
+#include "gz/rendering/RenderEngine.hh"
+
+using namespace gz;
+using namespace rendering;
+
+TEST(LoadOgreTest, LoadOgre)
+{
+  // Get engine
+  auto engine = rendering::engine("ogre");
+  ASSERT_NE(nullptr, engine) << "Unable to load ogre render engine"
+                             << std::endl;
+
+  // Clean up
+  unloadEngine(engine->Name());
+}
+
+int main(int argc, char **argv)
+{
+  ::testing::InitGoogleTest(&argc, argv);
+  return RUN_ALL_TESTS();
+}
diff --git a/src/Marker_TEST.cc b/src/Marker_TEST.cc
@@ -56,7 +56,7 @@ void MarkerTest::Marker(const std::string &_renderEngine)
   RenderEngine *engine = rendering::engine(_renderEngine);
   if (!engine)
   {
-    igndbg << "Engine '" << _renderEngine
+    FAIL() << "Engine '" << _renderEngine
            << "' is not supported" << std::endl;
     return;
   }
@@ -200,7 +200,7 @@ void MarkerTest::Material(const std::string &_renderEngine)
   RenderEngine *engine = rendering::engine(_renderEngine);
   if (!engine)
   {
-    igndbg << "Engine '" << _renderEngine
+    FAIL() << "Engine '" << _renderEngine
            << "' is not supported" << std::endl;
     return;
   }

diff --git a/src/Material_TEST.cc b/src/Material_TEST.cc
@@ -63,7 +63,7 @@ void MaterialTest::MaterialProperties(const std::string &_renderEngine)
   RenderEngine *engine = rendering::engine(_renderEngine);
   if (!engine)
   {
-    igndbg << "Engine '" << _renderEngine
+    FAIL() << "Engine '" << _renderEngine
               << "' is not supported" << std::endl;
     return;
   }
@@ -301,7 +301,7 @@ void MaterialTest::Copy(const std::string &_renderEngine)
   RenderEngine *engine = rendering::engine(_renderEngine);
   if (!engine)
   {
-    igndbg << "Engine '" << _renderEngine
+    FAIL() << "Engine '" << _renderEngine
               << "' is not supported" << std::endl;
     return;
   }

diff --git a/src/MeshDescriptor_TEST.cc b/src/MeshDescriptor_TEST.cc
@@ -45,7 +45,7 @@ void MeshDescriptorTest::Descriptor(const std::string &_renderEngine)
   RenderEngine *engine = rendering::engine(_renderEngine);
   if (!engine)
   {
-    igndbg << "Engine '" << _renderEngine
+    FAIL() << "Engine '" << _renderEngine
               << "' is not supported" << std::endl;
     return;
   }

diff --git a/src/Mesh_TEST.cc b/src/Mesh_TEST.cc
@@ -64,7 +64,7 @@ void MeshTest::MeshSubMesh(const std::string &_renderEngine)
   RenderEngine *engine = rendering::engine(_renderEngine);
   if (!engine)
   {
-    igndbg << "Engine '" << _renderEngine
+    FAIL() << "Engine '" << _renderEngine
               << "' is not supported" << std::endl;
     return;
   }
@@ -134,7 +134,7 @@ void MeshTest::MeshSkeleton(const std::string &_renderEngine)
   RenderEngine *engine = rendering::engine(_renderEngine);
   if (!engine)
   {
-    igndbg << "Engine '" << _renderEngine
+    FAIL() << "Engine '" << _renderEngine
               << "' is not supported" << std::endl;
     return;
   }
@@ -237,7 +237,7 @@ void MeshTest::MeshSkeletonAnimation(const std::string &_renderEngine)
   RenderEngine *engine = rendering::engine(_renderEngine);
   if (!engine)
   {
-    igndbg << "Engine '" << _renderEngine
+    FAIL() << "Engine '" << _renderEngine
               << "' is not supported" << std::endl;
     return;
   }
@@ -337,7 +337,7 @@ void MeshTest::MeshClone(const std::string &_renderEngine)
   RenderEngine *engine = rendering::engine(_renderEngine);
   if (!engine)
   {
-    igndbg << "Engine '" << _renderEngine
+    FAIL() << "Engine '" << _renderEngine
            << "' is not supported" << std::endl;
     return;
   }

diff --git a/src/MoveToHelper_TEST.cc b/src/MoveToHelper_TEST.cc
@@ -82,7 +82,7 @@ void MoveToHelperTest::MoveTo(const std::string &_renderEngine)
   RenderEngine *engine = rendering::engine(_renderEngine);
   if (!engine)
   {
-    igndbg << "Engine '" << _renderEngine
+    FAIL() << "Engine '" << _renderEngine
               << "' is not supported" << std::endl;
     return;
   }

diff --git a/src/Node_TEST.cc b/src/Node_TEST.cc
@@ -48,7 +48,7 @@ void NodeTest::Pose(const std::string &_renderEngine)
   RenderEngine *engine = rendering::engine(_renderEngine);
   if (!engine)
   {
-    igndbg << "Engine '" << _renderEngine
+    FAIL() << "Engine '" << _renderEngine
               << "' is not supported" << std::endl;
     return;
   }