Refactor envs

.gitignore

@@ -3,3 +3,4 @@ build
 testbuild
 test/mypippkg
 .idea
+*.pyc

.travis.yml

@@ -13,19 +13,19 @@ env:
   # This will check any ROS distro supported on this OS
   # checking devel and install separately so that they don't influence each other (dependencies, path, env, etc.)
   matrix:
-    - CI_ROS_DISTRO=indigo ROS_FLOW=devel
-    - CI_ROS_DISTRO=indigo ROS_FLOW=install
-    - CI_ROS_DISTRO=jade ROS_FLOW=devel
-    - CI_ROS_DISTRO=jade ROS_FLOW=install
-    - CI_ROS_DISTRO=kinetic ROS_FLOW=devel
-    - CI_ROS_DISTRO=kinetic ROS_FLOW=install
+    - ROS_DISTRO=indigo ROS_FLOW=devel
+    - ROS_DISTRO=indigo ROS_FLOW=install
+    - ROS_DISTRO=jade ROS_FLOW=devel
+    - ROS_DISTRO=jade ROS_FLOW=install
+    - ROS_DISTRO=kinetic ROS_FLOW=devel
+    - ROS_DISTRO=kinetic ROS_FLOW=install
   # TODO : test all possible flows (installing deps on devel or not, etc.)
 
 before_install:
   # Getting docker ros image
-  - docker pull ros:${CI_ROS_DISTRO}-ros-core
+  - docker pull ros:${ROS_DISTRO}-ros-core
   # Running as daemon
-  - docker run --name ${CONTAINER_NAME} -d -t ros:${CI_ROS_DISTRO}-ros-core /bin/bash | tee container.id
+  - docker run --name ${CONTAINER_NAME} -d -t ros:${ROS_DISTRO}-ros-core /bin/bash | tee container.id
   # Checking current container
   - docker ps -a
   - docker exec -ti ${CONTAINER_NAME} hostname
@@ -41,15 +41,15 @@ install:
   # copying local clone to the running container (volume is currently broken)
   - docker cp . ${CONTAINER_NAME}:/git_clone
   # Installing package dependencies
-  - docker exec -ti ${CONTAINER_NAME} rosdep install --default-yes --from-paths /git_clone --rosdistro $CI_ROS_DISTRO
+  - docker exec -ti ${CONTAINER_NAME} rosdep install --default-yes --from-paths /git_clone --rosdistro $ROS_DISTRO
 
 # full ROS setup, build and test
 script:
   - CONTAINER_ID=$(cat container.id)
   - docker ps -a
-  - docker exec -ti ${CONTAINER_NAME} /bin/bash -c "source /opt/ros/$CI_ROS_DISTRO/setup.bash && rospack profile"
+  - docker exec -ti ${CONTAINER_NAME} /bin/bash -c "source /opt/ros/$ROS_DISTRO/setup.bash && rospack profile"
   # Passing env vars here since passing in docker run currently breaks (2016-08-25)
-  - docker exec -ti ${CONTAINER_NAME} /bin/bash -c "export CI_ROS_DISTRO=$CI_ROS_DISTRO && export ROS_FLOW=$ROS_FLOW && /git_clone/travis_checks.bash"
+  - docker exec -ti ${CONTAINER_NAME} /bin/bash -c "export ROS_DISTRO=$ROS_DISTRO && export ROS_FLOW=$ROS_FLOW && /git_clone/travis_checks.bash"
   - docker stop "${CONTAINER_ID}"
 
 notifications:

CMakeLists.txt

@@ -1,6 +1,18 @@
 cmake_minimum_required(VERSION 2.8.3)
 project(catkin_pip)
 
+# Attempting auto detection of ros install if needed
+# sourcing a ros workspace would have already fill up the CMAKE_PREFIX_PATH
+if ( NOT CMAKE_PREFIX_PATH )
+    if (EXISTS "/opt/ros/kinetic")
+        set(CMAKE_PREFIX_PATH "/opt/ros/kinetic")
+    elif (EXISTS "/opt/ros/jade")
+        set(CMAKE_PREFIX_PATH "/opt/ros/jade")
+    elif (EXISTS "/opt/ros/indigo")
+        set(CMAKE_PREFIX_PATH "/opt/ros/indigo")
+    endif ()
+endif ()
+
 find_package(catkin REQUIRED)
 
 #
@@ -19,9 +31,8 @@ endif()
 catkin_package(
   CFG_EXTRAS
   catkin-pip.cmake
-  catkin-pip-env.cmake
   catkin-pip-runcmd.cmake
-  catkin-pip-setup.cmake
+  catkin-pip-package.cmake
   catkin-pip-prefix.cmake
   catkin-pip-requirements.cmake
   pytest.cmake
@@ -31,9 +42,9 @@ catkin_package(
 # to be found in devel space
 configure_file(cmake/catkin-pip-base.req ${CATKIN_DEVEL_PREFIX}/${CATKIN_PACKAGE_SHARE_DESTINATION}/cmake/catkin-pip-base.req COPYONLY)
 configure_file(cmake/catkin-pip-fixups.req ${CATKIN_DEVEL_PREFIX}/${CATKIN_PACKAGE_SHARE_DESTINATION}/cmake/catkin-pip-fixups.req COPYONLY)
-configure_file(cmake/scripts/pythonpath_prepend.bash ${CATKIN_DEVEL_PREFIX}/${CATKIN_PACKAGE_SHARE_DESTINATION}/cmake/scripts/pythonpath_prepend.bash COPYONLY)
+configure_file(cmake/scripts/path_prepend.sh ${CATKIN_DEVEL_PREFIX}/${CATKIN_PACKAGE_SHARE_DESTINATION}/cmake/scripts/path_prepend.sh COPYONLY)
+configure_file(cmake/env-hooks/42.site_packages.sh.installspace.in ${CATKIN_DEVEL_PREFIX}/${CATKIN_PACKAGE_SHARE_DESTINATION}/cmake/env-hooks/42.site_packages.sh.installspace.in COPYONLY)
 configure_file(cmake/env-hooks/42.site_packages.sh.develspace.in ${CATKIN_DEVEL_PREFIX}/${CATKIN_PACKAGE_SHARE_DESTINATION}/cmake/env-hooks/42.site_packages.sh.develspace.in COPYONLY)
-configure_file(cmake/env-hooks/42.site_packages.bash.develspace.in ${CATKIN_DEVEL_PREFIX}/${CATKIN_PACKAGE_SHARE_DESTINATION}/cmake/env-hooks/42.site_packages.bash.develspace.in COPYONLY)
 #configure_file(cmake/templates/python_setuptools_install.bat.in ${CATKIN_DEVEL_PREFIX}/${CATKIN_PACKAGE_SHARE_DESTINATION}/cmake/templates/python_setuptools_install.bat.in COPYONLY)
 configure_file(cmake/templates/python_setuptools_install.sh.in ${CATKIN_DEVEL_PREFIX}/${CATKIN_PACKAGE_SHARE_DESTINATION}/cmake/templates/python_setuptools_install.sh.in COPYONLY)
 
@@ -46,15 +57,15 @@ install(FILES
 )
 
 install(PROGRAMS
-    cmake/scripts/pythonpath_prepend.bash
+    cmake/scripts/path_prepend.sh
     DESTINATION
     ${CATKIN_PACKAGE_SHARE_DESTINATION}/cmake/scripts
 )
 
 # We install in cmake folder the files that are needed by cmake code
 install(FILES
     cmake/env-hooks/42.site_packages.sh.develspace.in
-    cmake/env-hooks/42.site_packages.bash.develspace.in
+    cmake/env-hooks/42.site_packages.sh.installspace.in
     DESTINATION
     ${CATKIN_PACKAGE_SHARE_DESTINATION}/cmake/env-hooks
 )

cmake/catkin-pip-base.req

@@ -1,4 +1,7 @@
 # Basic tools to install, simulating virtualenv creation behavior.
-# Not setting any version here to force catkin-pip to follow python and not remain stuck on deprecated versions.
-pip==8.1.2  # pip > 9.0 tries to remove egg-info/entry_points.txt from /opt/yujin/amd64/indigo-devel/lib/python2.7/dist-packages/pyros-... even if we specify /home/alexv/ROS/gopher_bootstrap/build/catkin_pip_env/bin/pip install -e /home/alexv/ROS/gopher_bootstrap/src/pyros --ignore-installed --no-dependencies --prefix /home/alexv/ROS/gopher_bootstrap/devel
-setuptools
+# It is better here to pin packages to a verified version, especially since we are explointing a borderline usecase
+# However this means we need a short maintenance cycle to not be outdated by python folks...
+
+pip==8.1.2  # pip > 9.0 tries to remove system packages data, even if we specify /home/alexv/ROS/gopher_bootstrap/build/catkin_pip_env/bin/pip install -e /home/alexv/ROS/gopher_bootstrap/src/pyros --ignore-installed --no-dependencies --prefix /home/alexv/ROS/gopher_bootstrap/devel
+# Issue : https://github.com/asmodehn/catkin_pip/issues/58
+setuptools==33.1.1

cmake/catkin-pip-setup.cmake.in → cmake/catkin-pip-package.cmake.in

@@ -1,5 +1,3 @@
-message(STATUS "Loading catkin-pip-setup.cmake from ${CMAKE_CURRENT_LIST_DIR}... ")
-
 if ( CMAKE_BACKWARDS_COMPATIBILITY LESS 2.8 )
 	message ( FATAL_ERROR " CMAKE MINIMUM BACKWARD COMPATIBILITY REQUIRED : 2.8 !" )
 endif( CMAKE_BACKWARDS_COMPATIBILITY LESS 2.8 )
@@ -10,11 +8,8 @@ if(catkin_pip_setup_included)
 endif(catkin_pip_setup_included)
 set(catkin_pip_setup_included true)
 
-# protecting against missing cmake file
-include ( "${CMAKE_CURRENT_LIST_DIR}/catkin-pip-env.cmake" RESULT_VARIABLE CATKIN_PIP_ENV_FOUND )
-IF ( NOT CATKIN_PIP_ENV_FOUND )
-    message ( FATAL_ERROR "{CMAKE_CURRENT_LIST_DIR}/catkin-pip-env.cmake Not Found !!!" )
-ENDIF ( NOT CATKIN_PIP_ENV_FOUND )
+message(STATUS "Loading catkin-pip-package.cmake from ${CMAKE_CURRENT_LIST_DIR}... ")
+
 
 # protecting against missing cmake file
 include ( "${CMAKE_CURRENT_LIST_DIR}/catkin-pip-runcmd.cmake" RESULT_VARIABLE CATKIN_PIP_RUNCMD_FOUND )
@@ -42,6 +37,10 @@ function(catkin_pip_python_setup)
     # Setting up variables for scripts configuration (in a function to keep it here)
     set(CATKIN_PIP_PACKAGE_PATH ${package_path})
 
+    # sourcing envhooks to keep coherence between cmake run and shell run (especially for tests)
+    # DUPLICATED with catkin_pip_setup
+    #catkin_pip_runcmd(${CATKIN_PIP} install -e ${package_path} --no-dependencies --prefix "${CATKIN_DEVEL_PREFIX}")
+
     # BEGIN : This is from catkin_python_setup
     # we follow same process but with slightly different scripts
     #
@@ -77,7 +76,10 @@ function(catkin_pip_python_setup)
 
 endfunction()
 
-function(catkin_pip_setup)
+# TODO : we now create an actual cmake target -> rename to catkin_pip_target ?
+function(catkin_pip_package package_name)
+
+    set(${PROJECT_NAME}_PIP_TARGET ${package_name} CACHE STRING "Make target generated to install this pip package as --editable for development")
 
     set (extra_macro_args ${ARGN})
 
@@ -93,21 +95,29 @@ function(catkin_pip_setup)
     # Note : environment should already be setup at configure time for devel
 
     # Then we can run the pip command
+    # Note when installing in editable mode (for development) we shouldnt care about already installed versions.
+    # However : https://github.com/asmodehn/catkin_pip/issues/58
     if(CATKIN_PIP_NO_DEPS)
-        catkin_pip_runcmd(${CATKIN_PIP} install -e ${package_path} --no-dependencies --prefix "${CATKIN_DEVEL_PREFIX}")
+        catkin_pip_install_devel_target(${package_name} ${package_path} --no-dependencies --ignore-installed)
+        #catkin_pip_runcmd(${CATKIN_PIP} install -e ${package_path} --no-dependencies --prefix "${CATKIN_DEVEL_PREFIX}" --ignore-installed)
     else()
-        catkin_pip_runcmd(${CATKIN_PIP} install -e ${package_path} --prefix "${CATKIN_DEVEL_PREFIX}")
+        catkin_pip_install_devel_target(${package_name} ${package_path} --ignore-installed)
+        #catkin_pip_runcmd(${CATKIN_PIP} install -e ${package_path} --prefix "${CATKIN_DEVEL_PREFIX}" --ignore-installed)
     endif()
 
     if(NOT EXISTS ${package_path}/setup.py)
         message(FATAL_ERROR "catkin_pip_setup() called without 'setup.py' in project folder '${package_path}'")
     endif()
 
+    # Probably better to do that here (dont do anything "special" for python)
     catkin_pip_python_setup()
 
     # TODO : we might want to generate a package.xml on the fly from setup.py contents...
 
     # Hijacking catkin scripts again
     #set(_PACKAGE_XML_DIRECTORY ${package_path})
 
+    # Here we plug back into usual catkin package build flow
+    catkin_package()
+
 endfunction()

cmake/catkin-pip-prefix.cmake.in

@@ -1,26 +1,21 @@
-message(STATUS "Loading catkin-pip-prefix.cmake from ${CMAKE_CURRENT_LIST_DIR}... ")
-
 if ( CMAKE_BACKWARDS_COMPATIBILITY LESS 2.8 )
 	message ( FATAL_ERROR " CMAKE MINIMUM BACKWARD COMPATIBILITY REQUIRED : 2.8 !" )
 endif( CMAKE_BACKWARDS_COMPATIBILITY LESS 2.8 )
 
-#
-# Important : This script is included by multiple cmake scripts at configure and build time
-# So it needs to be idempotent (no change if called multiple time with same settings/environment)
-#
-
 # Enforcing one time include https://cmake.org/Wiki/CMake_Performance_Tips#Use_an_include_guard
 if(catkin_pip_prefix_included)
   return()
 endif(catkin_pip_prefix_included)
 set(catkin_pip_prefix_included true)
 
+message(STATUS "Loading catkin-pip-prefix.cmake from ${CMAKE_CURRENT_LIST_DIR}... ")
+
+
+#
+# Important : This script is included by multiple cmake scripts at configure and build time
+# So it needs to be idempotent (no change if called multiple time with same settings/environment)
+#
 
-# protecting against missing cmake file
-include ( "${CMAKE_CURRENT_LIST_DIR}/catkin-pip-env.cmake" RESULT_VARIABLE CATKIN_PIP_ENV_FOUND )
-IF ( NOT CATKIN_PIP_ENV_FOUND )
-    message ( FATAL_ERROR "{CMAKE_CURRENT_LIST_DIR}/catkin-pip-env.cmake Not Found !!!" )
-ENDIF ( NOT CATKIN_PIP_ENV_FOUND )
 
 # protecting against missing cmake file
 include ( "${CMAKE_CURRENT_LIST_DIR}/catkin-pip-runcmd.cmake" RESULT_VARIABLE CATKIN_PIP_RUNCMD_FOUND )
@@ -123,20 +118,19 @@ endfunction(find_catkin_system_pip)
 
 function(catkin_pip_setup_prefix ws_prefix)
 
-    # Setting up our environment (for devel space only)
-    catkin_pip_check_env(${ws_prefix})
-
     # Trying to find our own pip
     # Careful this creates a CACHE variable that we need to recreate here in case people clean devel without cleaning build
     unset(CATKIN_PIP CACHE)
     find_program(CATKIN_PIP NAMES pip pip2 pip2.7 PATHS ${ws_prefix}/@CATKIN_GLOBAL_BIN_DESTINATION@ NO_DEFAULT_PATH)
 
     if (CATKIN_PIP)
-        message(STATUS "    ... Catkin pip was found at ${CATKIN_PIP} ...")
+        set(CATKIN_PIP "${CATKIN_PIP} -q")  # we can add all default basic options here.
     else ()
         # If not found, it means we need to do the whole setup...
         unset(CATKIN_PIP CACHE)
+        # TODO:  cleanup if unnecessary message (the find_program already outputs something
         message(STATUS "    ... Catkin pip was not found in ${ws_prefix}/@CATKIN_GLOBAL_BIN_DESTINATION@ ...")
+
         # Assuming Ubuntu Trusty here. platform detection is another hurdle
         set(CMAKE_SYSTEM_PREFIX_PATH / /usr /usr/local)
 
@@ -158,7 +152,7 @@ function(catkin_pip_setup_prefix ws_prefix)
             # which means we have to reinstall dependencies everytime and specify --exists-action w to avoid "already exists" errors
             # Avoid --install-option since the setuptools version found will be different the first time and the following times
             execute_process(
-              COMMAND ${CATKIN_SYS_PIP} -q install ${OPT_SYSTEM} -r "${CATKIN_PIP_REQUIREMENTS_PATH}/catkin-pip-base.req" --download-cache "${CMAKE_BINARY_DIR}/pip-cache" --target "${ws_prefix}/@CATKIN_PIP_GLOBAL_PYTHON_DESTINATION@" --exists-action w
+              COMMAND ${CATKIN_ENV} ${CATKIN_SYS_PIP} install ${OPT_SYSTEM} -r "${CATKIN_PIP_REQUIREMENTS_PATH}/catkin-pip-base.req" --download-cache "${CMAKE_BINARY_DIR}/pip-cache" --target "${ws_prefix}/@CATKIN_PIP_GLOBAL_PYTHON_DESTINATION@" --exists-action w
               WORKING_DIRECTORY ${CMAKE_CURRENT_SOURCE_DIR}
               RESULT_VARIABLE PIP_RESULT
               OUTPUT_VARIABLE PIP_VARIABLE
@@ -173,7 +167,7 @@ function(catkin_pip_setup_prefix ws_prefix)
             # We need to find a pip command that works for pip versions (kinetic supports xenial which is pip v8.1.1)
             # Careful --system is a debian porting extension. This will not work if the system pip command loads the pip package of pip itself, after the environment has been setup...
             execute_process(
-              COMMAND ${CATKIN_SYS_PIP} -q install ${OPT_SYSTEM} -r "${CATKIN_PIP_REQUIREMENTS_PATH}/catkin-pip-base.req" --cache-dir "${CMAKE_BINARY_DIR}/pip-cache" --target "${ws_prefix}/@CATKIN_PIP_GLOBAL_PYTHON_DESTINATION@" --exists-action w
+              COMMAND ${CATKIN_ENV} ${CATKIN_SYS_PIP} install ${OPT_SYSTEM} -r "${CATKIN_PIP_REQUIREMENTS_PATH}/catkin-pip-base.req" --cache-dir "${CMAKE_BINARY_DIR}/pip-cache" --target "${ws_prefix}/@CATKIN_PIP_GLOBAL_PYTHON_DESTINATION@" --exists-action w
               WORKING_DIRECTORY ${CMAKE_CURRENT_SOURCE_DIR}
               RESULT_VARIABLE PIP_RESULT
               OUTPUT_VARIABLE PIP_VARIABLE
@@ -187,14 +181,17 @@ function(catkin_pip_setup_prefix ws_prefix)
         endif()
 
 
-        set(CATKIN_PIP python -m pip)  # to make sure we use our recently downloaded pip version (its entrypoints were not installed by old pip/setuptools)
+        set(CATKIN_PIP ${PYTHON_EXECUTABLE} -m pip)  # to make sure we use our recently downloaded pip version (its entrypoints were not installed by old pip/setuptools)
 
         unset(CATKIN_SYS_PIP CACHE)  # we dont need this any longer
         # We are now using the latest pip from pip package, and not the system one.
 
         # Fixing security since python 2.7.6 on trusty is broken : https://stackoverflow.com/questions/29099404/ssl-insecureplatform-error-when-using-requests-package
         # Also reinstalling pip to finally get it in bin/
 
+        # To debug the python environment at this stage
+        #catkin_pip_runcmd(${PYTHON_EXECUTABLE} -m site)
+
         catkin_pip_runcmd(${CATKIN_PIP} install --ignore-installed -r "${CATKIN_PIP_REQUIREMENTS_PATH}/catkin-pip-fixups.req" --src ${CMAKE_SOURCE_DIR} --exists-action b --prefix "${ws_prefix}")
 
         unset(CATKIN_PIP)

cmake/catkin-pip-requirements.cmake.in

@@ -1,5 +1,3 @@
-message(STATUS "Loading catkin-pip-requirements.cmake from ${CMAKE_CURRENT_LIST_DIR}... ")
-
 if ( CMAKE_BACKWARDS_COMPATIBILITY LESS 2.8 )
 	message ( FATAL_ERROR " CMAKE MINIMUM BACKWARD COMPATIBILITY REQUIRED : 2.8 !" )
 endif( CMAKE_BACKWARDS_COMPATIBILITY LESS 2.8 )
@@ -10,6 +8,9 @@ if(catkin_pip_requirements_included)
 endif(catkin_pip_requirements_included)
 set(catkin_pip_requirements_included true)
 
+message(STATUS "Loading catkin-pip-requirements.cmake from ${CMAKE_CURRENT_LIST_DIR}... ")
+
+
 # protecting against missing cmake file
 include ( "${CMAKE_CURRENT_LIST_DIR}/catkin-pip-prefix.cmake" RESULT_VARIABLE CATKIN_PIP_PREFIX_FOUND )
 IF ( NOT CATKIN_PIP_PREFIX_FOUND )