tests: Add (disabled) test combining cloe with external package

Author: cassava

README.md

@@ -275,6 +275,26 @@ both. Unfortunately, this is only fixed in Conan 2.
 The use-case for build-all is to build everything in editable mode.
 For that, use the new super-build instead of building individual packages.
 
+### Superbuild 'cloe' package "provides the same functionality" error
+
+When using the `cloe` super-build package in tests, you may run into the
+following error:
+
+    ERROR: At least two recipes provides the same functionality:
+    - 'fable' provided by 'cloe/0.25.0@cloe/develop', 'fable/0.25.0@cloe/develop'
+    - 'cloe-runtime' provided by 'cloe/0.25.0@cloe/develop', 'cloe-runtime/0.25.0@cloe/develop'
+    - 'cloe-models' provided by 'cloe/0.25.0@cloe/develop', 'cloe-models/0.25.0@cloe/develop'
+
+This problem occurs when both `cloe` and one of the packages that `cloe`
+*provides* are pulled in as dependencies. Ideally, Conan should then
+use `cloe` instead, but it would appear that Conan, at least in v1,
+is unable to do this.
+
+The `cloe` super-build package is primarily used for development purposes,
+and until these kinks can be worked out, you should use the set of
+individual packages for production.
+
+
 [1]: https://conan.io
 [2]: https://docs.microsoft.com/en-us/windows/wsl/about
 [3]: https://ubuntu.com

conanfile.py

@@ -15,7 +15,16 @@ class Cloe(ConanFile):
     name = "cloe"
     license = "Apache-2.0"
     url = "https://github.com/eclipse/cloe"
-    description = "Closed-loop automated driving simulation environment"
+    description = """
+        Development package containing most cloe-* packages from the primary Eclipse repository.
+
+        WARNING:
+          This package "provides" the cloe-* packages it contains,
+          but unfortunately this is NOT compatible with other packages that
+          require these. This is a severe limitation of Conan (v1).
+
+          As such, this package should only be used for development purposes.
+    """
     topics = ["simulation"]
     settings = "os", "compiler", "build_type", "arch"
     provides = (

optional/example_external/.gitignore

@@ -0,0 +1 @@
+build/

optional/example_external/CMakeLists.txt

@@ -0,0 +1,16 @@
+cmake_minimum_required(VERSION 3.15...3.27 FATAL_ERROR)
+
+project(cloe_plugin_example_external LANGUAGES CXX)
+
+find_package(cloe-runtime REQUIRED QUIET)
+find_package(cloe-models REQUIRED QUIET)
+
+include(CloePluginSetup)
+cloe_add_plugin(
+    TARGET controller_example_external
+    SOURCES
+        src/external_printer.cpp
+    LINK_LIBRARIES
+        cloe::runtime
+        cloe::models
+)

optional/example_external/Makefile

@@ -0,0 +1 @@
+include ../../Makefile.package

optional/example_external/conanfile.py

@@ -0,0 +1,65 @@
+# mypy: ignore-errors
+# pylint: skip-file
+
+from pathlib import Path
+
+from conan import ConanFile
+from conan.tools import cmake, files, scm
+
+required_conan_version = ">=1.52.0"
+
+
+class CloeControllerExampleExternal(ConanFile):
+    """
+    This package is used for internal tests, and is not part of the
+    cloe package distribution. This is used for testing combining
+    external packages and cloe with Conan.
+    """
+
+    name = "cloe-plugin-example-external"
+    url = "https://github.com/eclipse/cloe"
+    description = "Cloe controller plugin mocks used for testing integration"
+    license = "Apache-2.0"
+    settings = "os", "compiler", "build_type", "arch"
+    generators = "CMakeDeps", "CMakeToolchain"
+    no_copy_source = True
+    exports_sources = [
+        "src/*",
+        "CMakeLists.txt",
+    ]
+
+    def set_version(self):
+        version_file = Path(self.recipe_folder) / "../../VERSION"
+        if version_file.exists():
+            self.version = files.load(self, version_file).strip()
+        else:
+            git = scm.Git(self, self.recipe_folder)
+            self.version = git.run("describe --dirty=-dirty")[1:]
+
+    def requirements(self):
+        self.requires(f"cloe-runtime/{self.version}@cloe/develop")
+        self.requires(f"cloe-models/{self.version}@cloe/develop")
+
+    def layout(self):
+        cmake.cmake_layout(self)
+
+    def build(self):
+        cm = cmake.CMake(self)
+        if self.should_configure:
+            cm.configure()
+        if self.should_build:
+            cm.build()
+
+    def package(self):
+        cm = cmake.CMake(self)
+        if self.should_install:
+            cm.install()
+
+    def package_info(self):
+        self.cpp_info.set_property("cmake_find_mode", "both")
+        self.cpp_info.set_property("cmake_file_name", self.name)
+        self.cpp_info.set_property("pkg_config_name", self.name)
+
+        if not self.in_local_cache: # editable mode
+            libdir = Path(self.build_folder) / "lib"
+            self.runenv_info.append_path("LD_LIBRARY_PATH", str(libdir))

optional/example_external/src/external_printer.cpp

@@ -0,0 +1,76 @@
+/*
+ * Copyright 2024 Robert Bosch GmbH
+ *
+ * Licensed under the Apache License, Version 2.0 (the "License");
+ * you may not use this file except in compliance with the License.
+ * You may obtain a copy of the License at
+ *
+ *     http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ *
+ * SPDX-License-Identifier: Apache-2.0
+ */
+/**
+ * \file external_printer.cpp
+ */
+
+#include <cassert>  // for assert
+
+#include <cloe/component/object_sensor.hpp>  // for ObjectSensor
+#include <cloe/controller.hpp>               // for Controller, ControllerFactory, ...
+#include <cloe/models.hpp>                   // for CloeComponent
+#include <cloe/plugin.hpp>                   // for EXPORT_CLOE_PLUGIN
+#include <cloe/sync.hpp>                     // for Sync
+#include <cloe/vehicle.hpp>                  // for Vehicle
+
+namespace external {
+
+struct ExternalPrinterConf : public cloe::Confable {
+  CONFABLE_FRIENDS(ExternalPrinterConf)
+};
+
+class ExternalPrinter : public cloe::Controller {
+ public:
+  using Controller::Controller;
+
+  void reset() override {
+    // Nothing to do here.
+  }
+
+  void abort() override {
+    // Nothing to do here.
+  }
+
+  cloe::Duration process(const cloe::Sync& sync) override {
+    assert(veh_ != nullptr);
+    auto log = this->logger();
+    log->info("External Step {} @ {}", sync.step(), sync.time().count());
+    if (veh_->has(cloe::CloeComponent::DEFAULT_WORLD_SENSOR)) {
+      auto sensor = veh_->get<cloe::ObjectSensor>(cloe::CloeComponent::DEFAULT_WORLD_SENSOR);
+      auto& objs = sensor->sensed_objects();
+      log->info("  {} Objects", objs.size());
+      for (auto o : objs) {
+        log->info("    id={} pos=({:3f}, {:3f}, {:3f})", o->id, o->pose.translation()(0),
+                  o->pose.translation()(1), o->pose.translation()(2));
+      }
+    }
+    return sync.time();
+  }
+};
+
+DEFINE_CONTROLLER_FACTORY(ExternalPrinterFactory, ExternalPrinterConf, "external_printer",
+                          "print a lot of information")
+
+std::unique_ptr<cloe::Controller> ExternalPrinterFactory::make(const cloe::Conf&) const {
+  return std::make_unique<ExternalPrinter>(this->name());
+}
+
+}  // namespace external
+
+// Register factory as plugin entrypoint
+EXPORT_CLOE_PLUGIN(external::ExternalPrinterFactory)

tests/test_conanfile_external.py

@@ -0,0 +1,54 @@
+# mypy: ignore-errors
+# pylint: skip-file
+#
+# NOTE:
+#   This filename needs to not match ^conanfile_*.py$ in order to not be
+#   used in the automatic smoketest test suite.
+
+from pathlib import Path
+
+from conan import ConanFile
+from conan.tools import files, scm
+
+required_conan_version = ">=1.52.0"
+
+
+class CloeSuperbuildWithExternalTest(ConanFile):
+    """
+    This recipe shows how to combine the cloe package -- which provides
+    cloe-runtime, etc. -- with packages that depend on these provided
+    packages.
+
+    NOTE:
+      This test is disabled until the use-case works with Conan.
+      See "Known Issues" in the README.md of the repository.
+    """
+
+    python_requires = "cloe-launch-profile/[>=0.20.0]@cloe/develop"
+    python_requires_extend = "cloe-launch-profile.Base"
+
+    name = "cloe-superbuild-test"
+    license = "Apache-2.0"
+    url = "https://github.com/eclipse/cloe"
+    description = "Closed-loop automated driving simulation environment"
+    topics = ["simulation"]
+    settings = "os", "compiler", "build_type", "arch"
+
+    @property
+    def cloe_launch_env(self):
+        return {
+            "CLOE_ENGINE_WITH_SERVER": "1" if self.options["cloe"].engine_server else "0",
+            "CLOE_LOG_LEVEL": "debug",
+            "CLOE_STRICT_MODE": "1",
+            "CLOE_WRITE_OUTPUT": "0",
+            "CLOE_ROOT": Path(self.recipe_folder) / "..",
+        }
+
+    def set_version(self):
+        self.version = self.project_version("../VERSION")
+
+    def requirements(self):
+        self.requires(f"cloe/{self.version}@cloe/develop")
+        self.requires(f"cloe-plugin-example-external/{self.version}@cloe/develop")
+        self.requires("esmini-data/2.37.4@cloe/stable")
+        self.requires("fmt/9.1.0", override=True)