Conan package distribution (BehaviorTree#39)

uilianries · facontidavide · commit acaac99beafd · 2018-12-31T15:48:47.000+01:00
diff --git a/.travis.yml b/.travis.yml
@@ -11,6 +11,30 @@ os:
 compiler:
   - gcc
 
+conan-linux: &conan-linux
+    os: linux
+    dist: xenial
+    language: python
+    python: "3.7"
+    services:
+      - docker
+    before_install:
+      - true
+    install:
+      - ./conan/travis/install.sh
+    script:
+      - ./conan/travis/build.sh
+
+conan-osx: &conan-osx
+    os: osx
+    language: generic
+    before_install:
+      - true
+    install:
+      - ./conan/travis/install.sh
+    script:
+      - ./conan/travis/build.sh
+
 matrix:
     include:
       - bare_linux:
@@ -21,10 +45,38 @@ matrix:
         env: ROS_DISTRO="kinetic"
       - ros_melodic:
         env: ROS_DISTRO="melodic"
+      - <<: *conan-linux
+        env: CONAN_GCC_VERSIONS=5 CONAN_DOCKER_IMAGE=conanio/gcc5
+      - <<: *conan-linux
+        env: CONAN_GCC_VERSIONS=6 CONAN_DOCKER_IMAGE=conanio/gcc6
+      - <<: *conan-linux
+        env: CONAN_GCC_VERSIONS=7 CONAN_DOCKER_IMAGE=conanio/gcc7
+      - <<: *conan-linux
+        env: CONAN_GCC_VERSIONS=8 CONAN_DOCKER_IMAGE=conanio/gcc8
+      - <<: *conan-linux
+        env: CONAN_CLANG_VERSIONS=3.9 CONAN_DOCKER_IMAGE=conanio/clang39
+      - <<: *conan-linux
+        env: CONAN_CLANG_VERSIONS=4.0 CONAN_DOCKER_IMAGE=conanio/clang40
+      - <<: *conan-linux
+        env: CONAN_CLANG_VERSIONS=5.0 CONAN_DOCKER_IMAGE=conanio/clang50
+      - <<: *conan-linux
+        env: CONAN_CLANG_VERSIONS=6.0 CONAN_DOCKER_IMAGE=conanio/clang60
+      - <<: *conan-osx
+        osx_image: xcode8.3
+        env: CONAN_APPLE_CLANG_VERSIONS=8.1
+      - <<: *conan-osx
+        osx_image: xcode9
+        env: CONAN_APPLE_CLANG_VERSIONS=9.0
+      - <<: *conan-osx
+        osx_image: xcode9.4
+        env: CONAN_APPLE_CLANG_VERSIONS=9.1
+      - <<: *conan-osx
+        osx_image: xcode10.1
+        env: CONAN_APPLE_CLANG_VERSIONS=10.0
     fast_finish: false
 
 before_install:
-  - sudo apt-get update && sudo apt-get --reinstall install -qq build-essential 
+  - sudo apt-get update && sudo apt-get --reinstall install -qq build-essential
   - if [ "$ROS_DISTRO" = "none" ]; then sudo apt-get --reinstall install -qq libzmq3-dev; fi
   # GTest: see motivation here https://www.eriksmistad.no/getting-started-with-google-test-on-ubuntu/
   - sudo apt-get --reinstall install -qq libgtest-dev cmake
@@ -40,7 +92,7 @@ install:
 before_script:
   # Prepare build directory
   - mkdir -p build
-  
+
 script:
   - if [ "$ROS_DISTRO"  = "none" ]; then (cd build; cmake .. ; sudo cmake --build . --target install; ./bin/behaviortree_cpp_test); fi
   - if [ "$ROS_DISTRO" != "none" ]; then (.ci_config/travis.sh); fi
diff --git a/conan/build.py b/conan/build.py
@@ -0,0 +1,78 @@
+#!/usr/bin/env python
+# -*- coding: utf-8 -*-
+
+import os
+import re
+from cpt.packager import ConanMultiPackager
+from cpt.ci_manager import CIManager
+from cpt.printer import Printer
+
+
+class BuilderSettings(object):
+
+    @property
+    def branch(self):
+        """ Get branch name
+        """
+        printer = Printer(None)
+        ci_manager = CIManager(printer)
+        return ci_manager.get_branch()
+
+    @property
+    def username(self):
+        """ Set BehaviorTree as package's owner
+        """
+        return os.getenv("CONAN_USERNAME", "BehaviorTree")
+
+    @property
+    def upload(self):
+        """ Set BehaviorTree repository to be used on upload.
+            The upload server address could be customized by env var
+            CONAN_UPLOAD. If not defined, the method will check the branch name.
+            Only master or CONAN_STABLE_BRANCH_PATTERN will be accepted.
+            The master branch will be pushed to testing channel, because it does
+            not match the stable pattern. Otherwise it will upload to stable
+            channel.
+        """
+        if os.getenv("CONAN_UPLOAD", None) is not None:
+            return os.getenv("CONAN_UPLOAD")
+
+        prog = re.compile(self.stable_branch_pattern)
+        if self.branch and prog.match(self.branch):
+            return "https://api.bintray.com/conan/BehaviorTree/conan"
+
+        return None
+
+    @property
+    def upload_only_when_stable(self):
+        """ Force to upload when match stable pattern branch
+        """
+        return os.getenv("CONAN_UPLOAD_ONLY_WHEN_STABLE", True)
+
+    @property
+    def stable_branch_pattern(self):
+        """ Only upload the package the branch name is like a tag
+        """
+        return os.getenv("CONAN_STABLE_BRANCH_PATTERN", r"\d+\.\d+\.\d+")
+
+    @property
+    def version(self):
+        return self.branch if re.match(self.stable_branch_pattern, self.branch) else "latest"
+
+    @property
+    def reference(self):
+        """ Read project version from branch name to create Conan referece
+        """
+        return os.getenv("CONAN_REFERENCE", "BehaviorTree.CPP/{}".format(self.version))
+
+if __name__ == "__main__":
+    settings = BuilderSettings()
+    builder = ConanMultiPackager(
+        reference=settings.reference,
+        username=settings.username,
+        upload=settings.upload,
+        upload_only_when_stable=settings.upload_only_when_stable,
+        stable_branch_pattern=settings.stable_branch_pattern,
+        test_folder=os.path.join("conan", "test_package"))
+    builder.add_common_builds(pure_c=False)
+    builder.run()
diff --git a/conan/test_package/CMakeLists.txt b/conan/test_package/CMakeLists.txt
@@ -0,0 +1,9 @@
+project(test_package CXX)
+cmake_minimum_required(VERSION 2.8.11)
+
+include(${CMAKE_BINARY_DIR}/conanbuildinfo.cmake)
+conan_basic_setup()
+
+add_executable(${PROJECT_NAME} test_package.cpp)
+target_link_libraries(${PROJECT_NAME} ${CONAN_LIBS})
+set_property(TARGET ${PROJECT_NAME} PROPERTY CXX_STANDARD 11)
diff --git a/conan/test_package/conanfile.py b/conan/test_package/conanfile.py
@@ -0,0 +1,19 @@
+#!/usr/bin/env python
+# -*- coding: utf-8 -*-
+import os
+from conans import ConanFile, CMake
+
+
+class TestPackageConan(ConanFile):
+    settings = "os", "compiler", "build_type", "arch"
+    generators = "cmake"
+
+    def build(self):
+        cmake = CMake(self)
+        cmake.configure()
+        cmake.build()
+
+    def test(self):
+        assert os.path.isfile(os.path.join(self.deps_cpp_info["BehaviorTree.CPP"].rootpath, "licenses", "LICENSE"))
+        bin_path = os.path.join("bin", "test_package")
+        self.run(bin_path, run_environment=True)
diff --git a/conan/test_package/test_package.cpp b/conan/test_package/test_package.cpp
@@ -0,0 +1,68 @@
+#include "behaviortree_cpp/behavior_tree.h"
+#include "behaviortree_cpp/bt_factory.h"
+
+using namespace BT;
+
+NodeStatus SayHello()
+{
+    printf("hello\n");
+    return NodeStatus::SUCCESS;
+}
+
+class ActionTestNode : public ActionNode
+{
+  public:
+    ActionTestNode(const std::string& name) : ActionNode(name)
+    {
+    }
+
+    NodeStatus tick() override
+    {
+        time_ = 5;
+        stop_loop_ = false;
+        int i = 0;
+        while (!stop_loop_ && i++ < time_)
+        {
+            std::this_thread::sleep_for(std::chrono::milliseconds(100));
+        }
+        return NodeStatus::SUCCESS;
+    }
+
+    virtual void halt() override
+    {
+        stop_loop_ = true;
+        setStatus(NodeStatus::IDLE);
+    }
+
+  private:
+    int time_;
+    std::atomic_bool stop_loop_;
+};
+
+int main()
+{
+    BT::SequenceNode root("root");
+    BT::SimpleActionNode action1("say_hello", std::bind(SayHello));
+    ActionTestNode action2("async_action");
+
+    root.addChild(&action1);
+    root.addChild(&action2);
+
+    int count = 0;
+
+    NodeStatus status = NodeStatus::RUNNING;
+
+    while (status == NodeStatus::RUNNING)
+    {
+        status = root.executeTick();
+
+        std::cout << count++ << " : " << root.status() << " / " << action1.status() << " / "
+                  << action2.status() << std::endl;
+
+        std::this_thread::sleep_for(std::chrono::milliseconds(100));
+    }
+
+    haltAllActions(&root);
+
+    return 0;
+}
diff --git a/conan/travis/build.sh b/conan/travis/build.sh
@@ -0,0 +1,14 @@
+#!/bin/bash
+
+set -e
+set -x
+
+if [[ "$(uname -s)" == 'Darwin' ]]; then
+    if which pyenv > /dev/null; then
+        eval "$(pyenv init -)"
+    fi
+    pyenv activate conan
+fi
+
+conan user
+python conan/build.py
diff --git a/conan/travis/install.sh b/conan/travis/install.sh
@@ -0,0 +1,21 @@
+#!/bin/bash
+
+set -ex
+
+if [[ "$(uname -s)" == 'Darwin' ]]; then
+    brew update || brew update
+    brew outdated pyenv || brew upgrade pyenv
+    brew install pyenv-virtualenv
+    brew install cmake || true
+
+    if which pyenv > /dev/null; then
+        eval "$(pyenv init -)"
+    fi
+
+    pyenv install 3.7.1
+    pyenv virtualenv 3.7.1 conan
+    pyenv rehash
+    pyenv activate conan
+fi
+
+pip install -U conan_package_tools conan
diff --git a/conanfile.py b/conanfile.py
@@ -4,6 +4,8 @@
 """Conan recipe package for BehaviorTree.CPP
 """
 from conans import ConanFile, CMake, tools
+from conans.model.version import Version
+from conans.errors import ConanInvalidConfiguration
 
 
 class BehaviorTreeConan(ConanFile):
@@ -19,10 +21,15 @@ class BehaviorTreeConan(ConanFile):
     generators = "cmake"
     exports = "LICENSE"
     exports_sources = ("cmake/*", "include/*", "src/*", "3rdparty/*", "CMakeLists.txt")
+    requires = "cppzmq/4.3.0@bincrafters/stable"
 
-    def requirements(self):
-
-        self.requires("cppzmq/4.3.0@bincrafters/stable")
+    def configure(self):
+        if self.settings.os == "Linux" and \
+           self.settings.compiler == "gcc" and \
+           Version(self.settings.compiler.version.value) < "5":
+            raise ConanInvalidConfiguration("BehaviorTree.CPP can not be built by GCC < 5")
+        if self.settings.os == "Windows":
+            raise ConanInvalidConfiguration("BehaviorTree.CPP is not prepared to be built on Windows yet")
 
     def _configure_cmake(self):
         """Create CMake instance and execute configure step
@@ -41,6 +48,10 @@ def build(self):
                               """project(behaviortree_cpp)
                               include(${CMAKE_BINARY_DIR}/conanbuildinfo.cmake)
                               conan_basic_setup()""")
+        # INFO (uilian): zmq could require libsodium
+        tools.replace_in_file("CMakeLists.txt",
+                             "BEHAVIOR_TREE_EXTERNAL_LIBRARIES zmq",
+                             "BEHAVIOR_TREE_EXTERNAL_LIBRARIES ${CONAN_LIBS}")
         cmake = self._configure_cmake()
         cmake.build()
 
