eProsima Developers Utils

The packages that conform this repository are:

• CMake utils: cmake_utils CMake utilities to build packages.
• C++ utils: cpp_utils C++ classes and functions for common use.
• Dev utils: dev_utils Tools and applications to help in code development.

Commercial support

Looking for commercial support? Write us to info@eprosima.com

Find more about us at eProsima’s webpage.

Documentation

There is no public documentation for this repository. Please, refer the the README.md files of each subpackage for information regarding the API and functionality.

Installation Guide

The instructions for installing the Dev Utils application from sources and its required dependencies on a Linux environment are provided below. These installation instructions are a summarized version of the complete installation guide available online.

Requirements

eProsima Dev Utils requires the following tools to be installed in the system:

• CMake, g++, pip, wget and git
• Colcon [optional, not required for CMake-only installation]
• Gtest [for test only]

CMake, g++, pip, wget and git

These packages provide the tools required to install Dev Utils and its dependencies from command line. Install CMake, g++, pip, wget and git using the package manager of the appropriate Linux distribution. For example, on Ubuntu use the command:

sudo apt install cmake g++ pip wget git

Colcon

colcon is a command line tool based on CMake aimed at building sets of software packages. Install the ROS 2 development tools (colcon and vcstool) by executing the following command:

pip3 install -U colcon-common-extensions vcstool

If this fails due to an Environment Error, add the --user flag to the pip3 installation command.

Gtest

Gtest is a unit testing library for C++. By default, Dev Utils does not compile tests. It is possible to activate them with the opportune CMake options when calling colcon or CMake. For a detailed description of the Gtest installation process, please refer to the Gtest Installation Guide.

Dependencies

Asio and TinyXML2 libraries

Asio is a cross-platform C++ library for network and low-level I/O programming, which provides a consistent asynchronous model. TinyXML2 is a simple, small and efficient C++ XML parser. Install these libraries using the package manager of the appropriate Linux distribution. For example, on Ubuntu use the command:

sudo apt install libasio-dev libtinyxml2-dev

OpenSSL

OpenSSL is a robust toolkit for the TLS and SSL protocols and a general-purpose cryptography library. Install OpenSSL using the package manager of the appropriate Linux distribution. For example, on Ubuntu use the command:

sudo apt install libssl-dev

eProsima dependencies

If it already exists in the system an installation of Fast DDS library with version greater than 2.4.0, just source this library when building the Dev Utils application by using the command:

source <fastdds-installation-path>/install/setup.bash

In other case, just download Fast DDS project from sources and build it together with Dev Utils using colcon as it is explained in the following section.

Colcon installation

1. Create a dev-utils directory and download the .repos file that will be used to install Dev Utils and its dependencies:

mkdir -p ~/DDS-Router/src
cd ~/DDS-Router
wget https://raw.githubusercontent.com/eProsima/dev-utils/main/dev_utils.repos
vcs import src < dev_utils.repos

1. Build the packages:

colcon build

This repository holds several colcon packages. These packages are:

• cmake_utils
• cpp_utils

NOTE: Those packages could be installed and use independently (according with each package dependency). In order to compile only a package and its dependencies, use the colcon argument --packages-up-to <package>. In order to explicitly skip some of these packages, use the colcon argument --packages-skip <package1> [<package2> ...].

Testing

By default, Dev Utils does not compile tests. However, they can be activated by downloading and installing Gtest and building with CMake option -DBUILD_TESTS=ON. Once done, tests can be run with the following command:

colcon test --event-handler=console_direct+

Contribution Guidelines

The following documents constitutes a set of guidelines to which contributors must adhere.

• Contributions Licensing
• Developer Certificate of Origin
• Code Coverage
• Issues and Support

Contributions Licensing

Any contribution that you make to this repository will be under the Apache 2 License, as dictated by that license:

5. Submission of Contributions. Unless You explicitly state otherwise,
   any Contribution intentionally submitted for inclusion in the Work
   by You to the Licensor shall be under the terms and conditions of
   this License, without any additional terms or conditions.
   Notwithstanding the above, nothing herein shall supersede or modify
   the terms of any separate license agreement you may have executed
   with Licensor regarding such Contributions.

Developer Certificate of Origin

Contributors must sign-off each commit by adding a Signed-off-by: ... line to commit messages to certify that they have the right to submit the code they are contributing to the project according to the Developer Certificate of Origin (DCO).

Code Coverage

All contributions to the project should increase the line code coverage whenever possible. Because of this, contributors are asked to locally run a coverage assessment that ensures that code coverage has increased when compared to the latest execution of the nightly coverage CI job.

Issues and Support

eProsima Dev Utils developers welcome all contributions, and we will be grateful if you follow the guidelines below while contributing to this project.

Also, this project classifies user issues in the following categories. Please, help us giving you a better support by opening your issue in the corresponding category.

Issues

Dev Utils issues are understood as bug reports and may be opened by anyone here. Consequently, this section handles malfunctions in the current documented behavior of the library or non-compliances to the DDS specification. If you are unsure on whether your experienced behavior falls into this category, please open a ticket in the Support discussion forum and, if it is a malfunction, an issue will be opened on your behalf with the provided report.

It is really appreciated if all related information is provided so the issue may be reproduced. Otherwise, more information could be required in order to reproduce and solve the issue. If this is the case, the issue will be labeled with need more info. Please, be advised that in case that no response is received within a month, the issue would be closed due to inactivity. The issue may be reopened if the required information is provided.

Feature request

Feature requests and improvements suggestions should be opened in the Ideas discussion forum. Please, remember to select the corresponding category while opening the discussion. It is also encouraged to contact directly with eProsima support team for a feature evaluation.

Q&A

Questions about eProsima Dev Utils behavior and features should be opened in the Q&A (Questions & Answers) discussion forum. Please, remember to select the correct category while opening the discussion.

Support

Most user issues would fall in this category. eProsima Dev Utils provides a lot of features and tuning the library for optimal behavior for each use case is not an easy task. These issues should be opened in the Support discussion forum. Please, remember to select the corresponding category while opening the discussion. Please, take into account that eProsima Dev Utils provides official support for the Tier 1 platforms, architectures and compilers defined here. Any other support should be opened in the next section: Unofficial support

Unofficial support

Any issue related with a non-officially supported platform, architecture and/or compiler should be opened in the Unofficial support discussion forum. Please, remember to select the corresponding category while opening the discussion. If official support is wanted for any platform, architecture and/or compiler, please contact directly with eProsima support team for an evaluation.