Add common::testing module

CMakeLists.txt

@@ -132,7 +132,7 @@ configure_file("${PROJECT_SOURCE_DIR}/cppcheck.suppress.in"
                ${PROJECT_BINARY_DIR}/cppcheck.suppress)
 
 ign_configure_build(QUIT_IF_BUILD_ERRORS
-  COMPONENTS av events geospatial graphics profiler)
+  COMPONENTS av events geospatial graphics profiler testing)
 
 #============================================================================
 # Create package information

av/src/AudioDecoder.cc

@@ -346,7 +346,7 @@ bool AudioDecoder::SetFile(const std::string &_filename)
 #endif
 
   // Open codec
-  if (avcodec_open2(this->dataPtr->codecCtx, 
+  if (avcodec_open2(this->dataPtr->codecCtx,
         this->dataPtr->codec, nullptr) < 0)
   {
     ignerr << "Couldn't open audio codec.\n";

events/src/Event_TEST.cc

@@ -21,6 +21,7 @@
 
 #include <functional>
 #include <ignition/common/Event.hh>
+#include <ignition/common/Util.hh>
 
 using namespace ignition;
 

include/ignition/common/TempDirectory.hh

@@ -74,6 +74,22 @@ namespace ignition
                             const std::string &_subDir = "ignition",
                             bool _cleanup = true);
 
+      /// \brief Create a directory in the tempDirectoryPath by expanding
+      /// a name template. This directory can also be automatically cleaned
+      /// up when the object goes out of scope.
+      ///
+      /// The TempDirectory will have the form _root/_subdir/_prefixXXXXX/
+      ///
+      /// \param[in[ _root Explicitly set the root directory
+      /// \param[in] _prefix String to be expanded for the template
+      /// \param[in] _subDir Subdirectory in OS _root, if desired
+      /// \param[in] _cleanup True to indicate that the filesystem should
+      ///   be cleaned as part of the destructor
+      public: explicit TempDirectory(const std::string &_root,
+                            const std::string &_prefix = "temp_dir",
+                            const std::string &_subDir = "ignition",
+                            bool _cleanup = true);
+
       /// \brief Destroy the temporary directory, removing from filesystem
       /// if cleanup is true.
       public: ~TempDirectory();

src/TempDirectory.cc

@@ -161,13 +161,22 @@ class ignition::common::TempDirectory::Implementation
 TempDirectory::TempDirectory(const std::string &_prefix,
                              const std::string &_subDir,
                              bool _cleanup):
+  TempDirectory(common::tempDirectoryPath(), _prefix, _subDir, _cleanup)
+{
+}
+
+/////////////////////////////////////////////////
+TempDirectory::TempDirectory(const std::string &_root,
+                             const std::string &_prefix,
+                             const std::string &_subDir,
+                             bool _cleanup):
   dataPtr(ignition::utils::MakeUniqueImpl<Implementation>())
 {
 
   this->dataPtr->oldPath = common::cwd();
   this->dataPtr->doCleanup = _cleanup;
 
-  auto tempPath = common::tempDirectoryPath();
+  auto tempPath = _root;
   if (!_subDir.empty())
   {
     tempPath = common::joinPaths(tempPath, _subDir);
@@ -181,6 +190,7 @@ TempDirectory::TempDirectory(const std::string &_prefix,
   this->dataPtr->path = common::cwd();
 }
 
+
 /////////////////////////////////////////////////
 TempDirectory::~TempDirectory()
 {

src/TempDirectory_TEST.cc

@@ -77,6 +77,22 @@ TEST(TempDirectory, TempDirectory)
   EXPECT_FALSE(ignition::common::exists(path));
 }
 
+/////////////////////////////////////////////////
+TEST(TempDirectory, TempDirectoryRoot)
+{
+  std::string path;
+  {
+    auto p = ignition::common::tempDirectoryPath();
+    ignition::common::TempDirectory tmp(p, "temp_dir", "ignition", true);
+    EXPECT_TRUE(tmp.Valid());
+    EXPECT_TRUE(tmp.DoCleanup());
+    path = tmp.Path();
+    EXPECT_FALSE(path.empty());
+    EXPECT_TRUE(ignition::common::exists(path));
+  }
+  EXPECT_FALSE(ignition::common::exists(path));
+}
+
 /////////////////////////////////////////////////
 TEST(TempDirectory, TempDirectoryNoClean)
 {

test/integration/video_encoder.cc

@@ -18,6 +18,7 @@
 // needed on MacOS
 #include <cmath>
 
+#include "ignition/common/Console.hh"
 #include "ignition/common/VideoEncoder.hh"
 #include "ignition/common/Video.hh"
 #include "ignition/common/ffmpeg_inc.hh"

testing/include/ignition/common/testing/AutoLogFixture.hh

@@ -0,0 +1,59 @@
+/*
+* Copyright (C) 2022 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.
+*
+*/
+#ifndef IGNITION_COMMON_TESTING_AUTOLOGFIXTURE_HH_
+#define IGNITION_COMMON_TESTING_AUTOLOGFIXTURE_HH_
+
+#include <gtest/gtest.h>
+
+#include <memory>
+#include <string>
+
+#include <ignition/utils/ImplPtr.hh>
+
+namespace ignition::common::testing
+{
+/// \brief A utility class that stores test logs in ~/.ignition/test_logs.
+/// This functionality is needed to keep all the log information reported
+/// by ignition during continuous integration. Without this, debugging
+/// failing tests is significantly more difficult.
+class AutoLogFixture : public ::testing::Test
+{
+  /// \brief Constructor
+  public: AutoLogFixture();
+
+  /// \brief Destructor
+  public: virtual ~AutoLogFixture();
+
+  /// \brief Setup the test fixture. This gets called by gtest.
+  protected: virtual void SetUp() override;
+
+  /// \brief Get a string with the full log file path.
+  /// \return The full log file path as a string.
+  protected: std::string FullLogPath() const;
+
+  /// \brief Get a string with all the log content loaded from the disk.
+  /// \return A string with all the log content.
+  protected: std::string LogContent() const;
+
+  /// \brief Pointer to private data.
+  IGN_UTILS_UNIQUE_IMPL_PTR(dataPtr)
+};
+}  // namespace ignition::common::testing
+
+#include <ignition/common/testing/detail/AutoLogFixture.hh>
+
+#endif  // IGNITION_COMMON_TESTING_AUTOLOGFIXTURE_HH_

testing/include/ignition/common/testing/BazelTestPaths.hh

@@ -0,0 +1,55 @@
+/*
+* Copyright (C) 2022 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.
+*
+*/
+#ifndef IGNITION_COMMON_TESTING_BAZELTESTPATHS_HH_
+#define IGNITION_COMMON_TESTING_BAZELTESTPATHS_HH_
+
+#include <string>
+
+#include "ignition/common/testing/TestPaths.hh"
+
+namespace ignition::common::testing
+{
+
+/// \brief Implementation of TestPaths interface for Bazel
+///
+/// It is not intended that users will directly construct this, but rather
+/// utilize the TestPathFactory.
+///
+/// The main mechanism for detecting a bazel build is via the presence of the
+/// TEST_SRCDIR and TEST_UNDECLARED_OUTPUTS_DIR environment variables.
+/// Additionally, tests built via ign-bazel should set IGN_BAZEL_DIR.
+///
+/// For source files to be available for bazel builds, they need to be set in
+/// the "data" section of the relevant cc_library or cc_test call.
+class BazelTestPaths: public TestPaths
+{
+  /// \brief Constructor from TestPaths
+  public: using TestPaths::TestPaths;
+
+  /// \brief Destructor
+  public: ~BazelTestPaths() override;
+
+  /// Documentation inherited
+  public: bool ProjectSourcePath(std::string &_sourceDir) override;
+
+  /// Documentation inherited
+  public: bool TestTmpPath(std::string &_tmpDir) override;
+};
+
+}  // namespace ignition::common::testing
+
+#endif  // IGNITION_COMMON_TESTING_AUTOLOGFIXTURE_HH_

testing/include/ignition/common/testing/CMakeLists.txt

@@ -0,0 +1,2 @@
+
+ign_install_all_headers(COMPONENT testing)

testing/include/ignition/common/testing/CMakeTestPaths.hh

@@ -0,0 +1,45 @@
+/*
+* Copyright (C) 2022 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.
+*
+*/
+#ifndef IGNITION_COMMON_TESTING_CMAKETESTPATHS_HH_
+#define IGNITION_COMMON_TESTING_CMAKETESTPATHS_HH_
+
+#include <string>
+
+#include "ignition/common/testing/TestPaths.hh"
+
+namespace ignition::common::testing
+{
+/// \brief Implementation of TestPaths interface for CMake
+///
+/// It is not intended that users will directly construct this, but rather
+/// utilize the TestPathFactory.
+class CMakeTestPaths: public TestPaths
+{
+  /// \brief Constructor from TestPaths
+  public: using TestPaths::TestPaths;
+
+  /// \brief Destructor
+  public: ~CMakeTestPaths() override;
+
+  /// Documentation inherited
+  public: bool ProjectSourcePath(std::string &_sourceDir) override;
+
+  /// Documentation inherited
+  public: bool TestTmpPath(std::string &_tmpDir) override;
+};
+}  // namespace ignition::common::testing
+#endif  // IGNITION_COMMON_TESTING_CMAKETESTPATHS_HH_