Allow generating vendored-source.json for packages with multiple ament_vendor calls

.github/workflows/update.yaml

@@ -44,7 +44,7 @@ jobs:
           # permittedInsecurePackages is needed for updating some gz-*-vendor packages.
           # Note that this runs without access to SUPERFLORE_GITHUB_TOKEN.
           mkdir -p ~/.config/nixpkgs
-          echo '{ permittedInsecurePackages = [ "freeimage-unstable-2021-11-01" ]; }' > ~/.config/nixpkgs/config.nix
+          echo '{ permittedInsecurePackages = [ "freeimage-3.18.0-unstable-2024-04-18" ]; }' > ~/.config/nixpkgs/config.nix
           NIX_PATH=nixpkgs=$PWD ./maintainers/scripts/update-ament-vendor.sh || ret=$?
           git commit -m 'Update vendored-source.json files' $(find -name vendored-source.json) || :
           exit $ret

distros/ament_vendor_wrapper.cmake

@@ -0,0 +1,86 @@
+# CMake code that wraps ament_vendor macro for use with Nix. The
+# wrapped version of ament_vendor serves two purposes:
+#
+# 1) Capturing information about what needs to be prefetched from from
+# the Internet and stores it into vendored-source.json.
+#
+# 2) Modifying ament_vendor behavior to use the prefetched data
+# instead of downloading them (downloading is not possible in Nix
+# build sandbox).
+#
+# The functionality of the wrapper is controlled with the following
+# CMake variables:
+#
+# AMENT_VENDOR_NIX_PREFETCH: If true, ament_vendor captures the
+# information needed for prefetching the data. If false or undefined,
+# ament_vendor obtains the data from the Nix store.
+#
+# AMENT_VENDOR_NIX_TAR_${TARGET_NAME}: Nix store path of the vendored
+# source.
+#
+# The above variables are set in Nix function patchAmentVendorGit.
+
+if(NOT ament_cmake_vendor_package_FIND_QUIETLY)
+  message(STATUS "Using ament_vendor wrapped for Nix patching (${ament_cmake_vendor_package_DIR})")
+endif()
+
+if(AMENT_VENDOR_NIX_PREFETCH)
+  # Write empty JSON object to vendored-source.json. Subsequent calls to
+  # ament_vendor() will add entries to it.
+  file(WRITE ${CMAKE_BINARY_DIR}/vendored-source.json "{}")
+  find_program(JQ jq)
+  find_program(NIX_PREFETCH_GIT nix-prefetch-git)
+endif()
+
+macro(ament_vendor TARGET_NAME)
+  cmake_parse_arguments(_ARG "GLOBAL_HOOK;SKIP_INSTALL" "SOURCE_SUBDIR;VCS_TYPE;VCS_URL;VCS_VERSION;SATISFIED" "CMAKE_ARGS;PATCHES" ${ARGN})
+  if(_ARG_UNPARSED_ARGUMENTS)
+    message(FATAL_ERROR "ament_vendor() called with unused arguments: "
+      "${_ARG_UNPARSED_ARGUMENTS}")
+  endif()
+  if(AMENT_VENDOR_NIX_PREFETCH)
+    # Read previous version of vendored-source.json
+    file(READ ${CMAKE_BINARY_DIR}/vendored-source.json VENDORED_SOURCE_JSON)
+
+    # Add new entry to vendored-source.json
+    execute_process(
+      COMMAND ${NIX_PREFETCH_GIT} --url ${_ARG_VCS_URL} --rev ${_ARG_VCS_VERSION} --fetch-submodules
+      COMMAND ${JQ} "${VENDORED_SOURCE_JSON} + {${TARGET_NAME}: {url: \"${_ARG_VCS_URL}\", rev: \"${_ARG_VCS_VERSION}\", hash: .hash}}"
+      OUTPUT_FILE ${CMAKE_BINARY_DIR}/vendored-source.json
+      COMMAND_ECHO STDOUT
+      COMMAND_ERROR_IS_FATAL ANY)
+
+    # Minimal implementation of the original ament_vendor macro that
+    # makes zenoh_cpp_vendor happy. Without this, generation of
+    # zenoh-cpp-vendor/vendored-source.json fails. If needed, we could
+    # also use ament_vendor_orig as below, but this is faster, because
+    # is doesn't download anything.
+    include(ExternalProject)
+    externalproject_add(
+      ${TARGET_NAME}
+      DOWNLOAD_COMMAND ""
+    )
+  else()
+    if(_ARG_GLOBAL_HOOK)
+      set(_ARG_GLOBAL_HOOK "GLOBAL_HOOK")
+    else()
+      unset(_ARG_GLOBAL_HOOK)
+    endif()
+    if(_ARG_SKIP_INSTALL)
+      set(_ARG_SKIP_INSTALL "SKIP_INSTALL")
+    else()
+      unset(_ARG_SKIP_INSTALL)
+    endif()
+    cmake_language(CALL ament_vendor_orig ${TARGET_NAME}
+      VCS_TYPE tar
+      VCS_URL file://${AMENT_VENDOR_NIX_TAR_${TARGET_NAME}}
+      VCS_VERSION ${_ARG_VCS_VERSION}
+      ${_ARG_GLOBAL_HOOK}
+      SATISFIED ${_ARG_SATISFIED}
+      ${_ARG_SKIP_INSTALL}
+      SOURCE_SUBDIR ${_ARG_SOURCE_SUBDIR}
+      PATCHES ${_ARG_PATCHES}
+      CMAKE_ARGS ${_ARG_CMAKE_ARGS}
+    )
+  endif()
+endmacro()

distros/jazzy/gz-cmake-vendor/vendored-source.json

@@ -1,5 +1,7 @@
 {
-  "url": "https://github.com/gazebosim/gz-cmake.git",
-  "rev": "gz-cmake3_3.5.4",
-  "hash": "sha256-mP0bBPWWAoUFsUwKn95Eqv1lW3lJdPEu3hhfmiK3mNQ="
+  "gz_cmake_vendor": {
+    "url": "https://github.com/gazebosim/gz-cmake.git",
+    "rev": "gz-cmake3_3.5.4",
+    "hash": "sha256-mP0bBPWWAoUFsUwKn95Eqv1lW3lJdPEu3hhfmiK3mNQ="
+  }
 }

distros/jazzy/gz-common-vendor/vendored-source.json

@@ -1,5 +1,7 @@
 {
-  "url": "https://github.com/gazebosim/gz-common.git",
-  "rev": "gz-common5_5.7.1",
-  "hash": "sha256-vNCjCSQYCSUHXKwXnq8vwWXiSK2+cD3yPSLT1FdAWrE="
+  "gz_common_vendor": {
+    "url": "https://github.com/gazebosim/gz-common.git",
+    "rev": "gz-common5_5.7.1",
+    "hash": "sha256-vNCjCSQYCSUHXKwXnq8vwWXiSK2+cD3yPSLT1FdAWrE="
+  }
 }

distros/jazzy/gz-dartsim-vendor/vendored-source.json

@@ -1,5 +1,7 @@
 {
-  "url": "https://github.com/dartsim/dart.git",
-  "rev": "v6.13.2",
-  "hash": "sha256-AfKPqUiW6BsM98TIzTY2ZcFP1WvURs8/dGOzanIiB9g="
+  "gz_dartsim_vendor": {
+    "url": "https://github.com/dartsim/dart.git",
+    "rev": "v6.13.2",
+    "hash": "sha256-AfKPqUiW6BsM98TIzTY2ZcFP1WvURs8/dGOzanIiB9g="
+  }
 }

distros/jazzy/gz-fuel-tools-vendor/vendored-source.json

@@ -1,5 +1,7 @@
 {
-  "url": "https://github.com/gazebosim/gz-fuel-tools.git",
-  "rev": "gz-fuel-tools9_9.1.1",
-  "hash": "sha256-XQoBcCtzwzzPypS1kIeTCIbjtxrzaW3JvZLCYbwXAOk="
+  "gz_fuel_tools_vendor": {
+    "url": "https://github.com/gazebosim/gz-fuel-tools.git",
+    "rev": "gz-fuel-tools9_9.1.1",
+    "hash": "sha256-XQoBcCtzwzzPypS1kIeTCIbjtxrzaW3JvZLCYbwXAOk="
+  }
 }

distros/jazzy/gz-gui-vendor/vendored-source.json

@@ -1,5 +1,7 @@
 {
-  "url": "https://github.com/gazebosim/gz-gui.git",
-  "rev": "gz-gui8_8.4.0",
-  "hash": "sha256-gf9XZzAX2g6r9ThIA0v2H2X/+uu9VnwvyvrdL5ZazM0="
+  "gz_gui_vendor": {
+    "url": "https://github.com/gazebosim/gz-gui.git",
+    "rev": "gz-gui8_8.4.0",
+    "hash": "sha256-gf9XZzAX2g6r9ThIA0v2H2X/+uu9VnwvyvrdL5ZazM0="
+  }
 }

distros/jazzy/gz-launch-vendor/vendored-source.json

@@ -1,5 +1,7 @@
 {
-  "url": "https://github.com/gazebosim/gz-launch.git",
-  "rev": "gz-launch7_7.1.1",
-  "hash": "sha256-S63DWe/c3cnEztxr3uJc0A4AmuiQk4o6m9yXj0X97Yk="
+  "gz_launch_vendor": {
+    "url": "https://github.com/gazebosim/gz-launch.git",
+    "rev": "gz-launch7_7.1.1",
+    "hash": "sha256-S63DWe/c3cnEztxr3uJc0A4AmuiQk4o6m9yXj0X97Yk="
+  }
 }

distros/jazzy/gz-math-vendor/vendored-source.json

@@ -1,5 +1,7 @@
 {
-  "url": "https://github.com/gazebosim/gz-math.git",
-  "rev": "gz-math7_7.5.2",
-  "hash": "sha256-LwYeyv8nwX06n5ju+ra2uqNMedMSLRumem8qDHXtNns="
+  "gz_math_vendor": {
+    "url": "https://github.com/gazebosim/gz-math.git",
+    "rev": "gz-math7_7.5.2",
+    "hash": "sha256-LwYeyv8nwX06n5ju+ra2uqNMedMSLRumem8qDHXtNns="
+  }
 }

distros/jazzy/gz-msgs-vendor/vendored-source.json

@@ -1,5 +1,7 @@
 {
-  "url": "https://github.com/gazebosim/gz-msgs.git",
-  "rev": "gz-msgs10_10.3.2",
-  "hash": "sha256-gxhRqLzBCaDmK67T5RryDpxbDR3WLgV9DFs7w6ieMxQ="
+  "gz_msgs_vendor": {
+    "url": "https://github.com/gazebosim/gz-msgs.git",
+    "rev": "gz-msgs10_10.3.2",
+    "hash": "sha256-gxhRqLzBCaDmK67T5RryDpxbDR3WLgV9DFs7w6ieMxQ="
+  }
 }

distros/jazzy/gz-ogre-next-vendor/vendored-source.json

@@ -1,5 +1,7 @@
 {
-  "url": "https://github.com/OGRECave/ogre-next.git",
-  "rev": "v2.3.3",
-  "hash": "sha256-elSj35LwsLzj1ssDPsk9NW/KSXfiOGYmw9hQSAWdpFM="
+  "gz_ogre_next_vendor": {
+    "url": "https://github.com/OGRECave/ogre-next.git",
+    "rev": "v2.3.3",
+    "hash": "sha256-elSj35LwsLzj1ssDPsk9NW/KSXfiOGYmw9hQSAWdpFM="
+  }
 }

distros/jazzy/gz-physics-vendor/vendored-source.json

@@ -1,5 +1,7 @@
 {
-  "url": "https://github.com/gazebosim/gz-physics.git",
-  "rev": "gz-physics7_7.5.0",
-  "hash": "sha256-75myTqDeEybvj5rsJxRambLPle1cen6HIatZGbVoXro="
+  "gz_physics_vendor": {
+    "url": "https://github.com/gazebosim/gz-physics.git",
+    "rev": "gz-physics7_7.5.0",
+    "hash": "sha256-75myTqDeEybvj5rsJxRambLPle1cen6HIatZGbVoXro="
+  }
 }

distros/jazzy/gz-plugin-vendor/vendored-source.json

@@ -1,5 +1,7 @@
 {
-  "url": "https://github.com/gazebosim/gz-plugin.git",
-  "rev": "gz-plugin2_2.0.4",
-  "hash": "sha256-iL4+EdFFAU55FVqE/CvyTv1zNaXxBWqWx44L0BeG2MU="
+  "gz_plugin_vendor": {
+    "url": "https://github.com/gazebosim/gz-plugin.git",
+    "rev": "gz-plugin2_2.0.4",
+    "hash": "sha256-iL4+EdFFAU55FVqE/CvyTv1zNaXxBWqWx44L0BeG2MU="
+  }
 }

distros/jazzy/gz-rendering-vendor/vendored-source.json

@@ -1,5 +1,7 @@
 {
-  "url": "https://github.com/gazebosim/gz-rendering.git",
-  "rev": "gz-rendering8_8.2.2",
-  "hash": "sha256-x+QHn8d+19U12CG1+HEmP0KcM3beY00Vvrc8mrxvAs0="
+  "gz_rendering_vendor": {
+    "url": "https://github.com/gazebosim/gz-rendering.git",
+    "rev": "gz-rendering8_8.2.2",
+    "hash": "sha256-x+QHn8d+19U12CG1+HEmP0KcM3beY00Vvrc8mrxvAs0="
+  }
 }

distros/jazzy/gz-sensors-vendor/vendored-source.json

@@ -1,5 +1,7 @@
 {
-  "url": "https://github.com/gazebosim/gz-sensors.git",
-  "rev": "gz-sensors8_8.2.2",
-  "hash": "sha256-TRDMCMesJXVSVGA3bnRngtXTi4VVf0y12AJQ79EEMiI="
+  "gz_sensors_vendor": {
+    "url": "https://github.com/gazebosim/gz-sensors.git",
+    "rev": "gz-sensors8_8.2.2",
+    "hash": "sha256-TRDMCMesJXVSVGA3bnRngtXTi4VVf0y12AJQ79EEMiI="
+  }
 }

distros/jazzy/gz-sim-vendor/vendored-source.json

@@ -1,5 +1,7 @@
 {
-  "url": "https://github.com/gazebosim/gz-sim.git",
-  "rev": "gz-sim8_8.9.0",
-  "hash": "sha256-hvhq2XBzcIoupJdJyJzk38LDXoEnd9iBCCiXvPZsPqY="
+  "gz_sim_vendor": {
+    "url": "https://github.com/gazebosim/gz-sim.git",
+    "rev": "gz-sim8_8.9.0",
+    "hash": "sha256-hvhq2XBzcIoupJdJyJzk38LDXoEnd9iBCCiXvPZsPqY="
+  }
 }

distros/jazzy/gz-tools-vendor/vendored-source.json

@@ -1,5 +1,7 @@
 {
-  "url": "https://github.com/gazebosim/gz-tools.git",
-  "rev": "gz-tools2_2.0.2",
-  "hash": "sha256-CY+W1jWIkszKwKuLgKmJpZMXHn0RnueMHFSDhOXIzLg="
+  "gz_tools_vendor": {
+    "url": "https://github.com/gazebosim/gz-tools.git",
+    "rev": "gz-tools2_2.0.2",
+    "hash": "sha256-CY+W1jWIkszKwKuLgKmJpZMXHn0RnueMHFSDhOXIzLg="
+  }
 }

distros/jazzy/gz-transport-vendor/vendored-source.json

@@ -1,5 +1,7 @@
 {
-  "url": "https://github.com/gazebosim/gz-transport.git",
-  "rev": "gz-transport13_13.4.1",
-  "hash": "sha256-hCP+yVoyl1c3KNmQ5jKrYvPT1IlAy9JkCh0c0mOF+KM="
+  "gz_transport_vendor": {
+    "url": "https://github.com/gazebosim/gz-transport.git",
+    "rev": "gz-transport13_13.4.1",
+    "hash": "sha256-hCP+yVoyl1c3KNmQ5jKrYvPT1IlAy9JkCh0c0mOF+KM="
+  }
 }

distros/jazzy/gz-utils-vendor/vendored-source.json

@@ -1,5 +1,7 @@
 {
-  "url": "https://github.com/gazebosim/gz-utils.git",
-  "rev": "gz-utils2_2.2.1",
-  "hash": "sha256-utVW8pTP/emEWblTxVb6jzulKdxss+2VfS552MWMqm4="
+  "gz_utils_vendor": {
+    "url": "https://github.com/gazebosim/gz-utils.git",
+    "rev": "gz-utils2_2.2.1",
+    "hash": "sha256-utVW8pTP/emEWblTxVb6jzulKdxss+2VfS552MWMqm4="
+  }
 }

distros/jazzy/overrides.nix

@@ -250,4 +250,6 @@ in {
       })
     ];
   });
+
+  zenoh-cpp-vendor = lib.patchAmentVendorGit rosSuper.zenoh-cpp-vendor { };
 }

distros/jazzy/rviz-ogre-vendor/vendored-source.json

@@ -1,5 +1,7 @@
 {
-  "url": "https://github.com/OGRECave/ogre.git",
-  "rev": "v1.12.10",
-  "hash": "sha256-Z0ixdSmkV93coBBVZ5R3lPLfVMXRfWsFz/RsSyqPWFY="
+  "ogre_vendor": {
+    "url": "https://github.com/OGRECave/ogre.git",
+    "rev": "v1.12.10",
+    "hash": "sha256-Z0ixdSmkV93coBBVZ5R3lPLfVMXRfWsFz/RsSyqPWFY="
+  }
 }

distros/jazzy/sdformat-vendor/vendored-source.json

@@ -1,5 +1,7 @@
 {
-  "url": "https://github.com/gazebosim/sdformat.git",
-  "rev": "sdformat14_14.7.0",
-  "hash": "sha256-p2e01bCoMpDhia1yOFa5wIP2ritBiWNT5jYbp/bg1+g="
+  "sdformat_vendor": {
+    "url": "https://github.com/gazebosim/sdformat.git",
+    "rev": "sdformat14_14.7.0",
+    "hash": "sha256-p2e01bCoMpDhia1yOFa5wIP2ritBiWNT5jYbp/bg1+g="
+  }
 }

distros/jazzy/zenoh-cpp-vendor/vendored-source.json

@@ -0,0 +1,12 @@
+{
+  "zenoh_c_vendor": {
+    "url": "https://github.com/eclipse-zenoh/zenoh-c.git",
+    "rev": "e6a1971139f405f7887bf5bb54f0efe402123032",
+    "hash": "sha256-eJbnb1UJbtuYb+dSpKqVgI1p/97bSc+KTcbO1GNg9jU="
+  },
+  "zenoh_cpp_vendor": {
+    "url": "https://github.com/eclipse-zenoh/zenoh-cpp",
+    "rev": "8ad67f6c7a9031acd437c8739bbc8ddab0ca8173",
+    "hash": "sha256-0iRhmMtrhDdM7X0ByiICT4s7lDFcGLSR1dEImzT1mWs="
+  }
+}

distros/rolling/gz-cmake-vendor/vendored-source.json

@@ -1,5 +1,7 @@
 {
-  "url": "https://github.com/gazebosim/gz-cmake.git",
-  "rev": "gz-cmake4_4.1.1",
-  "hash": "sha256-BWgRm+3UW65Cu7TqXtFFG05JlYF52dbpAsIE8aDnJM0="
+  "gz_cmake_vendor": {
+    "url": "https://github.com/gazebosim/gz-cmake.git",
+    "rev": "gz-cmake4_4.1.1",
+    "hash": "sha256-BWgRm+3UW65Cu7TqXtFFG05JlYF52dbpAsIE8aDnJM0="
+  }
 }

distros/rolling/gz-common-vendor/vendored-source.json

@@ -1,5 +1,7 @@
 {
-  "url": "https://github.com/gazebosim/gz-common.git",
-  "rev": "gz-common6_6.0.2",
-  "hash": "sha256-sY9g+AatS+ddYSUAjqumfZNi2JIc+DFbiVYMaWKMC78="
+  "gz_common_vendor": {
+    "url": "https://github.com/gazebosim/gz-common.git",
+    "rev": "gz-common6_6.0.2",
+    "hash": "sha256-sY9g+AatS+ddYSUAjqumfZNi2JIc+DFbiVYMaWKMC78="
+  }
 }

distros/rolling/gz-dartsim-vendor/vendored-source.json

@@ -1,5 +1,7 @@
 {
-  "url": "https://github.com/dartsim/dart.git",
-  "rev": "v6.13.2",
-  "hash": "sha256-AfKPqUiW6BsM98TIzTY2ZcFP1WvURs8/dGOzanIiB9g="
+  "gz_dartsim_vendor": {
+    "url": "https://github.com/dartsim/dart.git",
+    "rev": "v6.13.2",
+    "hash": "sha256-AfKPqUiW6BsM98TIzTY2ZcFP1WvURs8/dGOzanIiB9g="
+  }
 }

distros/rolling/gz-fuel-tools-vendor/vendored-source.json

@@ -1,5 +1,7 @@
 {
-  "url": "https://github.com/gazebosim/gz-fuel-tools.git",
-  "rev": "gz-fuel-tools10_10.0.1",
-  "hash": "sha256-/Xfhec6kpv6srSp+hudqBaK4dKFn0QK45aGqxzNyytw="
+  "gz_fuel_tools_vendor": {
+    "url": "https://github.com/gazebosim/gz-fuel-tools.git",
+    "rev": "gz-fuel-tools10_10.0.1",
+    "hash": "sha256-/Xfhec6kpv6srSp+hudqBaK4dKFn0QK45aGqxzNyytw="
+  }
 }

distros/rolling/gz-gui-vendor/vendored-source.json

@@ -1,5 +1,7 @@
 {
-  "url": "https://github.com/gazebosim/gz-gui.git",
-  "rev": "gz-gui9_9.0.1",
-  "hash": "sha256-ZBDgd37TPBOldorGZimsCk57fVa7tTc8wRwUGFBZnDk="
+  "gz_gui_vendor": {
+    "url": "https://github.com/gazebosim/gz-gui.git",
+    "rev": "gz-gui9_9.0.1",
+    "hash": "sha256-ZBDgd37TPBOldorGZimsCk57fVa7tTc8wRwUGFBZnDk="
+  }
 }

distros/rolling/gz-launch-vendor/vendored-source.json

@@ -1,5 +1,7 @@
 {
-  "url": "https://github.com/gazebosim/gz-launch.git",
-  "rev": "gz-launch8_8.0.1",
-  "hash": "sha256-el+4sVBOmeBj8VJqKut8pIhVJeyEyodrt6titunbBF0="
+  "gz_launch_vendor": {
+    "url": "https://github.com/gazebosim/gz-launch.git",
+    "rev": "gz-launch8_8.0.1",
+    "hash": "sha256-el+4sVBOmeBj8VJqKut8pIhVJeyEyodrt6titunbBF0="
+  }
 }