Merge branch 'main' into dependabot/pip/docs/pip-60b803aef9

eProsima · Oct 7, 2024 · 0f72aac · 0f72aac
2 parents d4226a8 + 600a397
commit 0f72aac
Show file tree

Hide file tree

Showing 64 changed files with 797 additions and 2,005 deletions.
diff --git a/.github/actions/project_dependencies/action.yml b/.github/actions/project_dependencies/action.yml
@@ -55,7 +55,7 @@ runs:
     - name: Download dependencies artifact
       uses: eProsima/eProsima-CI/multiplatform/download_dependency@v0
       with:
-        artifact_name: built_ddspipe_${{ inputs.custom_version_build }}_${{ inputs.os }}_${{ inputs.cmake_build_type }}${{ inputs.dependencies_artifact_postfix }}
+        artifact_name: build_ddspipe_${{ inputs.custom_version_build }}_${{ inputs.os }}_${{ inputs.cmake_build_type }}${{ inputs.dependencies_artifact_postfix }}
         workflow_source: build_ddspipe.yml
         workflow_source_repository: eProsima/eProsima-CI
         target_workspace: ${{ inputs.target_workspace }}

diff --git a/.github/workflows/mirror.yml b/.github/workflows/mirror.yml
@@ -0,0 +1,25 @@
+name: mirror-branch
+
+on:
+  push:
+    branches:
+      - 'main'
+
+jobs:
+  mirror_job_main:
+    if: github.ref == 'refs/heads/main'
+    runs-on: ubuntu-latest
+    name: Mirror main branch to API & ABI compatible minor version branches
+    strategy:
+      fail-fast: false
+      matrix:
+          dest_branch:
+            - '1.x'
+    steps:
+      - name: Mirror action step
+        id: mirror
+        uses: eProsima/eProsima-CI/external/mirror-branch-action@v0
+        with:
+            github-token: ${{ secrets.GITHUB_TOKEN }}
+            source: 'main'
+            dest: ${{ matrix.dest_branch }}
diff --git a/.github/workflows/nightly.yml b/.github/workflows/nightly.yml
@@ -13,14 +13,14 @@ jobs:
     with:
       custom_version_build: 'v2'
       dependencies_artifact_postfix: '_nightly'
+      ref: '0.x'
     secrets: inherit
 
-  # Uncomment this block to run the tests for Fast DDS v3 when Fast DDS Spy is updated
-  # Also specify here (and above) the workflow version/branch to use (@v0, @main, etc.)
-  # reusable_tests_v3:
-  #   name: reusable_tests_v3
-  #   uses: ./.github/workflows/reusable-workflow.yml
-  #   with:
-  #     custom_version_build: 'v3'
-  #     dependencies_artifact_postfix: '_nightly'
-  #   secrets: inherit
+  reusable_tests_v3:
+    name: reusable_tests_v3
+    uses: ./.github/workflows/reusable-workflow.yml
+    with:
+      custom_version_build: 'v3'
+      dependencies_artifact_postfix: '_nightly'
+      ref: 'main'
+    secrets: inherit
diff --git a/.github/workflows/reusable-workflow.yml b/.github/workflows/reusable-workflow.yml
@@ -1,7 +1,7 @@
 # Reusable workflow to run the following jobs:
 #
 #   - multiplatform-tests
-#     - [ ubuntu-22.04 | ubuntu-20.04 | windows-2019 | windows-2022 ]
+#     - [ ubuntu-22.04 | ubuntu-24.04 | windows-2019 | windows-2022 ]
 #     - [ Debug | Release ]
 #     - execute tests in different versions of ubuntu with different build types
 #
@@ -53,6 +53,13 @@ on:
         default: '_nightly'
         type: string
 
+      ref:
+        description: >
+          The branch or tag name to checkout.
+        required: true
+        type: string
+        default: 'main'
+
 env:
   code_packages_names: 'fastddsspy_participants fastddsspy_yaml fastddsspy_tool'
   docs_packages_names: 'fastddsspy_docs'
@@ -72,8 +79,8 @@ jobs:
           - Release
           - Debug
         os:
-          - ubuntu-20.04
           - ubuntu-22.04
+          - ubuntu-24.04
           - windows-2019
           - windows-2022
 
@@ -83,6 +90,7 @@ jobs:
         uses: eProsima/eProsima-CI/external/checkout@v0
         with:
           path: src
+          ref: ${{ inputs.ref }}
 
       - name: Download dependencies and install requirements
         uses: ./src/.github/actions/project_dependencies
@@ -101,6 +109,7 @@ jobs:
           workspace_dependencies: './install'
           ctest_args: --label-exclude "xfail"
           colcon_meta_file: ./src/.github/workflows/configurations/${{ runner.os }}/colcon.meta
+          test_report_artifact: test_report${{ inputs.dependencies_artifact_postfix }}_${{ inputs.custom_version_build }}_${{ matrix.os }}_${{ matrix.cmake_build_type }}
 
 
 #####################################################################
@@ -114,6 +123,7 @@ jobs:
         uses: eProsima/eProsima-CI/external/checkout@v0
         with:
           path: src
+          ref: ${{ inputs.ref }}
 
       - name: Download dependencies and install requirements
         uses: ./src/.github/actions/project_dependencies
@@ -125,10 +135,14 @@ jobs:
           secret_token: ${{ secrets.GITHUB_TOKEN }}
 
       - name: Compile and run tests
-        uses: eProsima/eProsima-CI/multiplatform/asan_build_test@v0
+        uses: eProsima/eProsima-CI/multiplatform/colcon_build_test@v0
         with:
           packages_names: ${{ env.code_packages_names }}
+          cmake_args: -DBUILD_TESTS=ON -DASAN_BUILD=ON
+          ctest_args: --label-exclude "xfail|xasan"
           workspace_dependencies: './install'
+          cmake_build_type: Debug
+          test_report_artifact: test_report${{ inputs.dependencies_artifact_postfix }}_${{ inputs.custom_version_build }}_${{ matrix.os }}_${{ matrix.cmake_build_type }}
 
 
 #####################################################################
@@ -142,6 +156,7 @@ jobs:
         uses: eProsima/eProsima-CI/external/checkout@v0
         with:
           path: src
+          ref: ${{ inputs.ref }}
 
       - name: Download dependencies and install requirements
         uses: ./src/.github/actions/project_dependencies
@@ -153,10 +168,19 @@ jobs:
           secret_token: ${{ secrets.GITHUB_TOKEN }}
 
       - name: Compile and run tests
-        uses: eProsima/eProsima-CI/multiplatform/tsan_build_test@v0
+        uses: eProsima/eProsima-CI/multiplatform/colcon_build_test@v0
+        env:
+          # GCC 11.3 (Ubuntu Jammy default) produces several false positives regarding timed synchronization protocols
+          # These issues were fixed in GCC 12 so we upgrade to that version.
+          CC: gcc-12
+          CXX: g++-12
         with:
           packages_names: ${{ env.code_packages_names }}
+          cmake_args: -DBUILD_TESTS=ON -DTSAN_BUILD=ON
+          ctest_args: --label-exclude "xfail|xtsan"
           workspace_dependencies: './install'
+          cmake_build_type: Debug
+          test_report_artifact: test_report_tsan${{ inputs.dependencies_artifact_postfix }}_${{ inputs.custom_version_build }}
 
 
 #####################################################################
@@ -170,6 +194,7 @@ jobs:
         uses: eProsima/eProsima-CI/external/checkout@v0
         with:
           path: src
+          ref: ${{ inputs.ref }}
 
       - name: Download dependencies and install requirements
         uses: ./src/.github/actions/project_dependencies
@@ -200,6 +225,7 @@ jobs:
         uses: eProsima/eProsima-CI/external/checkout@v0
         with:
           path: src
+          ref: ${{ inputs.ref }}
 
       - name: Download dependencies and install requirements
         uses: ./src/.github/actions/project_dependencies
@@ -217,6 +243,7 @@ jobs:
           workspace_dependencies: './install'
           codecov_token: ${{ secrets.CODECOV_TOKEN }}
           codecov_fix_file_path: ./src/codecov.yml
+          test_report_artifact: test_report_coverage${{ inputs.dependencies_artifact_postfix }}_${{ inputs.custom_version_build }}
 
 
 #####################################################################
@@ -230,6 +257,7 @@ jobs:
         uses: eProsima/eProsima-CI/external/checkout@v0
         with:
           path: src
+          ref: ${{ inputs.ref }}
 
       - name: Download dependencies and install requirements
         uses: ./src/.github/actions/project_dependencies

diff --git a/.github/workflows/test.yml b/.github/workflows/test.yml
@@ -35,6 +35,7 @@ jobs:
     name: reusable_tests
     uses: ./.github/workflows/reusable-workflow.yml
     with:
-      custom_version_build: ${{ inputs.custom_version_build || 'v2' }}
+      custom_version_build: ${{ inputs.custom_version_build || 'v3' }}
       dependencies_artifact_postfix: ${{ inputs.dependencies_artifact_postfix || '_nightly' }}
+      ref: ${{ github.ref }}
     secrets: inherit
diff --git a/VERSION b/VERSION
@@ -1,3 +1,3 @@
-VERSION_MAJOR 0
-VERSION_MINOR 4
+VERSION_MAJOR 1
+VERSION_MINOR 0
 VERSION_PATCH 0
diff --git a/docs/package.xml b/docs/package.xml
@@ -2,7 +2,7 @@
 <?xml-model href="http://download.ros.org/schema/package_format3.xsd" schematypens="http://www.w3.org/2001/XMLSchema"?>
 <package format="3">
   <name>fastddsspy_docs</name>
-  <version>0.4.0</version>
+  <version>1.0.0</version>
   <description>
      *eprosima Fast DDS Spy* Documentation built with sphinx and deployed in ReadTheDocs.
   </description>

diff --git a/docs/rst/developer_manual/installation/sources/linux.rst b/docs/rst/developer_manual/installation/sources/linux.rst
@@ -25,7 +25,7 @@ The following packages will be installed:
 
 - ``foonathan_memory_vendor``, an STL compatible C++ memory allocation library.
 - ``fastcdr``, a C++ library that serializes according to the standard CDR serialization mechanism.
-- ``fastrtps``, the core library of eProsima Fast DDS library.
+- ``fastdds``, the core library of eProsima Fast DDS library.
 - ``cmake_utils``, an eProsima utils library for CMake.
 - ``cpp_utils``, an eProsima utils library for C++.
 - ``ddspipe``, an eProsima internal library that enables the communication of DDS interfaces.
@@ -93,7 +93,7 @@ Use the following command to download the code:
 
 .. code-block:: bash
 
-    git clone --branch release-1.11.0 https://github.com/google/googletest src/googletest-distribution
+    git clone --branch release-1.12.0 https://github.com/google/googletest src/googletest-distribution
 
 
 .. _dependencies:

diff --git a/docs/rst/developer_manual/installation/sources/windows.rst b/docs/rst/developer_manual/installation/sources/windows.rst
@@ -25,7 +25,7 @@ The following packages will be installed:
 
 - ``foonathan_memory_vendor``, an STL compatible C++ memory allocation library.
 - ``fastcdr``, a C++ library that serializes according to the standard CDR serialization mechanism.
-- ``fastrtps``, the core library of eProsima Fast DDS library.
+- ``fastdds``, the core library of eProsima Fast DDS library.
 - ``cmake_utils``, an eProsima utils library for CMake.
 - ``cpp_utils``, an eProsima utils library for C++.
 - ``ddspipe``, an eProsima internal library that enables the communication of DDS interfaces.
@@ -255,7 +255,7 @@ There are two possibilities:
 However, when running an instance of a |spy| compiled using CMake, it must be linked with its dependencies where the packages have been installed.
 This can be done by opening the *Edit system environment variables* control panel and adding to the ``PATH`` the |espy|, *Fast DDS*, *Fast CDR*, *DDS Pipe* installation directories:
 
-*   *Fast DDS*: ``C:\\Program Files\\fastrtps``
+*   *Fast DDS*: ``C:\\Program Files\\fastdds``
 *   *Fast CDR*: ``C:\\Program Files\\fastcdr``
 *   *DDS Pipe*: ``C:\\Program Files\\ddspipe``
 *   |espy|: ``C:\\Program Files\\ddsrecord``

diff --git a/docs/rst/installation/docker.rst b/docs/rst/installation/docker.rst
@@ -48,7 +48,7 @@ The steps to run |spy| in a Docker container are explained below.
             --ipc=host \
             --privileged \
             -v /<fastddsspy>/FASTDDSSPY_CONFIGURATION.yaml:/root/FASTDDSSPY_CONFIGURATION.yaml \
-            ubuntu-fastddsspy:v0.4.0
+            ubuntu-fastddsspy:v1.0.0
 
     It is important to mention that both the path to the configuration file hosted in the local machine and the one
     created in the Docker container must be absolute paths in order to share just one single file as a shared volume.

diff --git a/docs/rst/notes/forthcoming_version.rst b/docs/rst/notes/forthcoming_version.rst
@@ -1,12 +1,8 @@
 
 .. add orphan tag when new info added to this file
 
-.. :orphan:
+:orphan:
 
 ###################
 Forthcoming Version
 ###################
-
-This release includes the following **Configuration Features**:
-
-* New :ref:`domain argument <user_manual_user_interface_domain_argument>` to configure the ``domain`` through the command-line.
diff --git a/docs/rst/notes/notes.rst b/docs/rst/notes/notes.rst
@@ -2,19 +2,27 @@
 
 .. _notes:
 
-.. include:: forthcoming_version.rst
+.. .. include:: forthcoming_version.rst
 
 ##############
-Version v0.4.0
+Version v1.0.0
 ##############
 
+This release includes the following **Features**:
+
+* Add support for Fast DDS v3.
+
 This release includes the following **Configuration Features**:
 
-* New configuration option ``logging`` to configure the :ref:`Logs <spy_specs_logging>`.
+* New :ref:`domain argument <user_manual_user_interface_domain_argument>` to configure the ``domain`` through the command-line.
+* Change default log filter to ``FASTDDSSPY``.
+* Change default log verbosity to ``error``.
 
-This release includes the following **Documentation Updates**:
+This release includes the following **CI improvements**:
 
-* Add a new :ref:`Logging <spy_specs_logging>` section to the :ref:`Configuration <user_manual_configuration>` page.
+* Upgrade to Ubuntu Noble (24.04).
+* Remove Ubuntu Focal (20.04) from the CI.
+* Empty XTSAN tests list to run all tests with Thread Sanitizer.
 
 This release includes the following **Dependencies Update**:
 
@@ -31,26 +39,27 @@ This release includes the following **Dependencies Update**:
         - `v1.3.1 <https://github.com/eProsima/foonathan_memory_vendor/releases/tag/v1.3.1>`_
     *   - Fast CDR
         - `eProsima/Fast-CDR <https://github.com/eProsima/Fast-CDR>`_
-        - `v2.1.3 <https://github.com/eProsima/Fast-CDR/releases/tag/v2.1.3>`_
         - `v2.2.0 <https://github.com/eProsima/Fast-CDR/releases/tag/v2.2.0>`_
+        - `v2.2.4 <https://github.com/eProsima/Fast-CDR/releases/tag/v2.2.4>`_
     *   - Fast DDS
         - `eProsima/Fast-DDS <https://github.com/eProsima/Fast-DDS>`_
-        - `v2.13.1 <https://github.com/eProsima/Fast-DDS/releases/tag/v2.13.1>`_
         - `v2.14.0 <https://github.com/eProsima/Fast-DDS/releases/tag/v2.14.0>`_
+        - `v3.0.1 <https://github.com/eProsima/Fast-DDS/releases/tag/v3.0.1>`_
     *   - Dev Utils
         - `eProsima/dev-utils <https://github.com/eProsima/dev-utils>`_
-        - `v0.5.0 <https://github.com/eProsima/dev-utils/releases/tag/v0.5.0>`_
         - `v0.6.0 <https://github.com/eProsima/dev-utils/releases/tag/v0.6.0>`_
+        - `v1.0.0 <https://github.com/eProsima/dev-utils/releases/tag/v1.0.0>`_
     *   - DDS Pipe
         - `eProsima/DDS-Pipe <https://github.com/eProsima/DDS-Pipe.git>`_
-        - `v0.3.0 <https://github.com/eProsima/DDS-Pipe/releases/tag/v0.3.0>`_
         - `v0.4.0 <https://github.com/eProsima/DDS-Pipe/releases/tag/v0.4.0>`_
+        - `v1.0.0 <https://github.com/eProsima/DDS-Pipe/releases/tag/v0.4.0>`_
 
 
 #################
 Previous Versions
 #################
 
+.. include:: ./previous_versions/v0.4.0.rst
 .. include:: ./previous_versions/v0.3.0.rst
 .. include:: ./previous_versions/v0.2.0.rst
 .. include:: ./previous_versions/v0.1.0.rst
diff --git a/docs/rst/notes/previous_versions/v0.4.0.rst b/docs/rst/notes/previous_versions/v0.4.0.rst
@@ -0,0 +1,40 @@
+Version v0.4.0
+==============
+
+This release includes the following **Configuration Features**:
+
+* New configuration option ``logging`` to configure the :ref:`Logs <spy_specs_logging>`.
+
+This release includes the following **Documentation Updates**:
+
+* Add a new :ref:`Logging <spy_specs_logging>` section to the :ref:`Configuration <user_manual_configuration>` page.
+
+This release includes the following **Dependencies Update**:
+
+.. list-table::
+    :header-rows: 1
+
+    *   -
+        - Repository
+        - Old Version
+        - New Version
+    *   - Foonathan Memory Vendor
+        - `eProsima/foonathan_memory_vendor <https://github.com/eProsima/foonathan_memory_vendor>`_
+        - `v1.3.1 <https://github.com/eProsima/foonathan_memory_vendor/releases/tag/v1.3.1>`_
+        - `v1.3.1 <https://github.com/eProsima/foonathan_memory_vendor/releases/tag/v1.3.1>`_
+    *   - Fast CDR
+        - `eProsima/Fast-CDR <https://github.com/eProsima/Fast-CDR>`_
+        - `v2.1.3 <https://github.com/eProsima/Fast-CDR/releases/tag/v2.1.3>`_
+        - `v2.2.0 <https://github.com/eProsima/Fast-CDR/releases/tag/v2.2.0>`_
+    *   - Fast DDS
+        - `eProsima/Fast-DDS <https://github.com/eProsima/Fast-DDS>`_
+        - `v2.13.1 <https://github.com/eProsima/Fast-DDS/releases/tag/v2.13.1>`_
+        - `v2.14.0 <https://github.com/eProsima/Fast-DDS/releases/tag/v2.14.0>`_
+    *   - Dev Utils
+        - `eProsima/dev-utils <https://github.com/eProsima/dev-utils>`_
+        - `v0.5.0 <https://github.com/eProsima/dev-utils/releases/tag/v0.5.0>`_
+        - `v0.6.0 <https://github.com/eProsima/dev-utils/releases/tag/v0.6.0>`_
+    *   - DDS Pipe
+        - `eProsima/DDS-Pipe <https://github.com/eProsima/DDS-Pipe.git>`_
+        - `v0.3.0 <https://github.com/eProsima/DDS-Pipe/releases/tag/v0.3.0>`_
+        - `v0.4.0 <https://github.com/eProsima/DDS-Pipe/releases/tag/v0.4.0>`_
diff --git a/docs/rst/user_manual/configuration.rst b/docs/rst/user_manual/configuration.rst
@@ -364,10 +364,6 @@ The type of the logs published is defined as follows:
       string timestamp;
     };
 
-.. note::
-
-    The type of the logs can be published by setting ``publish-type: true``.
-
 **Example of usage**
 
 .. code-block:: yaml