Elements 6.3.2
A C++ base framework for the Euclid Software.
|
Classes | |
class | ConnectionConfiguration |
The connection configuration mainly holds: More... | |
class | DataSync |
A class to download test data from a data repository prior to the unit test run. More... | |
class | DataSynchronizer |
Base class to synchronize test data. More... | |
class | DependencyConfiguration |
The dependency configurations holds, for each test file to be retrieved: More... | |
class | DownloadFailed |
An exception raised when downloading fails. More... | |
class | IrodsSynchronizer |
A data synchronizer for iRODS hosts. More... | |
class | string |
STL class. More... | |
class | UnknownHost |
Exception raised when a hosting solution is not supported by the tool. More... | |
class | vector |
STL class. More... | |
class | WebdavSynchronizer |
A data synchronizer for WebDAV hosts. More... | |
Typedefs | |
using | path = Path::Item |
importing the path item from ElementsKernel | |
Enumerations | |
enum | DataHost { IRODS , WEBDAV } |
The test data hosting solution. More... | |
enum | OverwritingPolicy { ABORT , OVERWRITE } |
The overwriting policy if the local file already exists. More... | |
Functions | |
ELEMENTS_API std::shared_ptr< DataSynchronizer > | createSynchronizer (ConnectionConfiguration connection, DependencyConfiguration dependency) |
ELEMENTS_API path | confFilePath (path filename) |
ELEMENTS_API bool | checkCall (const std::string &command) |
ELEMENTS_API std::pair< std::string, std::string > | runCommandAndCaptureOutErr (std::string command) |
ELEMENTS_API bool | localDirExists (path localDir) |
ELEMENTS_API void | createLocalDirOf (path localFile) |
ELEMENTS_API std::string | environmentVariable (std::string name) |
Get the value of an environment variable. | |
ELEMENTS_API std::string | getWorkdirVariable () |
Get the datasync workdir variable. | |
ELEMENTS_API path | localWorkspacePrefix () |
ELEMENTS_API std::string | lower (std::string text) |
template<typename T> | |
ELEMENTS_API bool | valueIsListed (const T &value, const std::vector< T > &list) |
ELEMENTS_API bool | containsInThisOrder (std::string input, std::vector< std::string > substrings) |
ELEMENTS_API bool | irodsIsInstalled () |
Check whether the iRODS client is installed. | |
ELEMENTS_API bool | webdavIsInstalled () |
Check whether the WebDAV client is installed. | |
Variables | |
ELEMENTS_API const std::string | DEFAULT_WORKDIR_VAR {"WORKSPACE"} |
Name of the default variable that contains the path to the work dir. | |
ELEMENTS_API const std::string | WORKDIR_VAR_VAR {"DATASYNC_WORKDIR_VAR"} |
Name of the variable containing the name of the workspace. It that variable is not set or empty, the content of DEFAULT_WORKDIR_VAR is used as the work dir path. | |
using Elements::Services::DataSync::path = Path::Item |
importing the path item from ElementsKernel
Definition at line 39 of file DataSyncUtils.h.
The test data hosting solution.
Enumerator | |
---|---|
IRODS | |
WEBDAV |
Definition at line 41 of file ConnectionConfiguration.h.
The overwriting policy if the local file already exists.
Enumerator | |
---|---|
ABORT | |
OVERWRITE |
Definition at line 49 of file ConnectionConfiguration.h.
bool Elements::Services::DataSync::checkCall | ( | const std::string & | command | ) |
Definition at line 51 of file DataSyncUtils.cpp.
Referenced by irodsIsInstalled(), and webdavIsInstalled().
Definition at line 47 of file DataSyncUtils.cpp.
Referenced by Elements::Services::DataSync::ConnectionConfiguration::parseConfigurationFile(), and Elements::Services::DataSync::DependencyConfiguration::parseConfigurationFile().
bool Elements::Services::DataSync::containsInThisOrder | ( | std::string | input, |
std::vector< std::string > | substrings ) |
Definition at line 115 of file DataSyncUtils.cpp.
void Elements::Services::DataSync::createLocalDirOf | ( | path | localFile | ) |
Definition at line 76 of file DataSyncUtils.cpp.
References localDirExists().
Referenced by Elements::Services::DataSync::DataSynchronizer::downloadOneFile().
std::shared_ptr< DataSynchronizer > Elements::Services::DataSync::createSynchronizer | ( | ConnectionConfiguration | connection, |
DependencyConfiguration | dependency ) |
Definition at line 30 of file DataSynchronizerMaker.cpp.
References Elements::Services::DataSync::ConnectionConfiguration::host, IRODS, and WEBDAV.
Referenced by Elements::Services::DataSync::DataSync::download().
bool Elements::Services::DataSync::localDirExists | ( | path | localDir | ) |
Definition at line 72 of file DataSyncUtils.cpp.
Referenced by createLocalDirOf().
path Elements::Services::DataSync::localWorkspacePrefix | ( | ) |
Definition at line 102 of file DataSyncUtils.cpp.
References environmentVariable(), and getWorkdirVariable().
Referenced by Elements::Services::DataSync::ConnectionConfiguration::parseConfigurationFile().
string Elements::Services::DataSync::lower | ( | std::string | text | ) |
Definition at line 109 of file DataSyncUtils.cpp.
Referenced by Elements::Services::DataSync::ConnectionConfiguration::parseHost(), and Elements::Services::DataSync::ConnectionConfiguration::parseOverwritingPolicy().
std::pair< string, string > Elements::Services::DataSync::runCommandAndCaptureOutErr | ( | std::string | command | ) |
Definition at line 57 of file DataSyncUtils.cpp.
Referenced by Elements::Services::DataSync::DataSynchronizer::downloadOneFile().
ELEMENTS_API bool Elements::Services::DataSync::valueIsListed | ( | const T & | value, |
const std::vector< T > & | list ) |
Definition at line 85 of file DataSyncUtils.h.
References ELEMENTS_API.
Referenced by Elements::Services::DataSync::ConnectionConfiguration::parseOverwritingPolicy().