Gazebo Common

API Reference

6.0.0
BazelTestPaths Class Reference

Implementation of TestPaths interface for Bazel. More...

#include <BazelTestPaths.hh>

Public Member Functions

GZ_COMMON_TESTING_VISIBLE ~BazelTestPaths () override
 Destructor.
 
bool GZ_COMMON_TESTING_VISIBLE ProjectSourcePath (std::string &_sourceDir) override
 Documentation inherited.
 
 TestPaths (const std::string &_projectSourcePath=kTestingProjectSourceDir)
 Constructor from TestPaths.
 
bool GZ_COMMON_TESTING_VISIBLE TestTmpPath (std::string &_tmpDir) override
 Documentation inherited.
 
- Public Member Functions inherited from TestPaths
 TestPaths (const std::string &_projectSourcePath=kTestingProjectSourceDir)
 Constructor.
 
virtual ~TestPaths ()
 Destructor.
 

Additional Inherited Members

- Protected Attributes inherited from TestPaths
std::string projectSourcePath
 Path to the root of the project source.
 

Detailed Description

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 gz-bazel should set GZ_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.

Constructor & Destructor Documentation

◆ ~BazelTestPaths()

GZ_COMMON_TESTING_VISIBLE ~BazelTestPaths ( )
override

Destructor.

Member Function Documentation

◆ ProjectSourcePath()

bool GZ_COMMON_TESTING_VISIBLE ProjectSourcePath ( std::string _sourceDir)
overridevirtual

Documentation inherited.

Implements TestPaths.

◆ TestPaths()

TestPaths ( const std::string _projectSourcePath = kTestingProjectSourceDir)
explicit

Constructor from TestPaths.

◆ TestTmpPath()

bool GZ_COMMON_TESTING_VISIBLE TestTmpPath ( std::string _tmpDir)
overridevirtual

Documentation inherited.

Implements TestPaths.


The documentation for this class was generated from the following file: