Small improvements (#21)

Small improvements

Author: MatthijsBurgh

.ci/get_install_build_packages.py

@@ -13,20 +13,24 @@
 system_dir = os.getenv("TUE_SYSTEM_DIR")
 packages = (f.path for f in os.scandir(os.path.join(system_dir, "src")) if f.is_dir())
 
-install_build_pkgs = set()
-build_pkgs = set()
+install_build_pkgs = set()  # All packages that need to be build and require all deps to be installed
+build_pkgs = set()  # All packages that need to be build
 
 for pkg_path in packages:
     pkg = os.path.split(pkg_path)[-1]
+    
+    # Messages need to build and require there depencies
     for msg_type in ["action", "msg", "srv"]:
         if os.path.isdir(os.path.join(pkg_path, msg_type)):
             install_build_pkgs.add(pkg)
             break
 
+    # Pkg with python modules need to build to be added to PYTHONPATH
     if os.path.isfile(os.path.join(pkg_path, "setup.py")):
         catkin_package = catkin_pkg.package.parse_package(
             os.path.join(pkg_path, catkin_pkg.package.PACKAGE_MANIFEST_FILENAME)
         )
+        # If cpp code in pkg, deps need to be installed
         for dep in catkin_package.build_depends:
             if "cpp" in dep.name:  # Might be replaced by a better check to determine their is cpp code in this pkg
                 install_build_pkgs.add(pkg)

.ci/install.bash

@@ -27,21 +27,21 @@ do
             # unknown option
             if [[ -n "$i" ]]
             then
-                echo -e "\e[35m\e[1m Unknown input argument '$i'. Check CI .yml file \e[0m"
+                echo -e "\e[35m\e[1mUnknown input argument '$i'. Check CI yaml file\e[0m"
                 exit 1
             fi ;;
     esac
     shift
 done
 
-echo -e "\e[35m\e[1m BRANCH       = ${BRANCH} \e[0m"
+echo -e "\e[35m\e[1mBRANCH       = ${BRANCH}\e[0m"
 
 # Set default value for IMAGE_NAME
 [ -z "$IMAGE_NAME" ] && IMAGE_NAME='tuerobotics/tue-env'
-echo -e "\e[35m\e[1m IMAGE_NAME   = ${IMAGE_NAME} \e[0m"
+echo -e "\e[35m\e[1mIMAGE_NAME   = ${IMAGE_NAME}\e[0m"
 
 # Determine docker tag if the same branch exists there
-BRANCH_TAG=$(echo "$BRANCH" | tr '[:upper:]' '[:lower:]' | sed -e 's:/:_:g')
+BRANCH_TAG=$(echo "${BRANCH}" | tr '[:upper:]' '[:lower:]' | sed -e 's:/:_:g')
 
 # Set the default fallback branch to latest
 MASTER_TAG="latest"
@@ -51,23 +51,23 @@ docker stop tue-env  &> /dev/null || true
 docker rm tue-env &> /dev/null || true
 
 # Pull the identical branch name from dockerhub if exist, use master as fallback
-echo -e "\e[35m\e[1m Trying to fetch docker image: $IMAGE_NAME:$BRANCH_TAG \e[0m"
-if ! docker pull "$IMAGE_NAME:$BRANCH_TAG"
+echo -e "\e[35m\e[1mTrying to fetch docker image: ${IMAGE_NAME}:${BRANCH_TAG}\e[0m"
+if ! docker pull "${IMAGE_NAME}:${BRANCH_TAG}"
 then
-    echo -e "\e[35m\e[1m No worries, we just test against the master branch: $IMAGE_NAME:$MASTER_TAG \e[0m"
-    docker pull "$IMAGE_NAME":"$MASTER_TAG"
-    BRANCH_TAG=$MASTER_TAG
+    echo -e "\e[35m\e[1mNo worries, we just test against the master branch: ${IMAGE_NAME}:${MASTER_TAG}\e[0m"
+    docker pull "${IMAGE_NAME}":"${MASTER_TAG}"
+    BRANCH_TAG=${MASTER_TAG}
 fi
 
 if [ -f ~/.ssh/known_hosts ]
 then
     MERGE_KNOWN_HOSTS="true"
-    DOCKER_MOUNT_KNOWN_HOSTS_ARGS="--mount type=bind,source=$HOME/.ssh/known_hosts,target=/tmp/known_hosts_extra"
+    DOCKER_MOUNT_KNOWN_HOSTS_ARGS="--mount type=bind,source=${HOME}/.ssh/known_hosts,target=/tmp/known_hosts_extra"
 fi
 
 # Run the docker image along with setting new environment variables
 # shellcheck disable=SC2086
-docker run --detach --interactive --tty -e CI="true" -e BRANCH="$BRANCH" --name tue-env $DOCKER_MOUNT_KNOWN_HOSTS_ARGS "$IMAGE_NAME:$BRANCH_TAG"
+docker run --detach --interactive --tty -e CI="true" -e BRANCH="${BRANCH}" --name tue-env ${DOCKER_MOUNT_KNOWN_HOSTS_ARGS} "${IMAGE_NAME}:${BRANCH_TAG}"
 
 if [ "$MERGE_KNOWN_HOSTS" == "true" ]
 then
@@ -76,34 +76,34 @@ fi
 
 if [ "$USE_SSH" == "true" ]
 then
-    docker exec -t tue-env bash -c "echo '$SSH_KEY' > ~/.ssh/id_rsa && chmod 700 ~/.ssh/id_rsa"
+    docker exec -t tue-env bash -c "echo '${SSH_KEY}' > ~/.ssh/id_rsa && chmod 700 ~/.ssh/id_rsa"
     docker exec -t tue-env bash -c "eval $(ssh-agent -s)"
 fi
 
-echo -e "\e[35m\e[1m tue-get install tue-documentation-github --no-ros-deps --doc-depend\e[0m"
+echo -e "\e[35m\e[1mtue-get install tue-documentation-github --no-ros-deps --doc-depend\e[0m"
 docker exec tue-env bash -c 'source ~/.bashrc; tue-get install tue-documentation-github --no-ros-deps --doc-depend'
 
 DOCKER_HOME=$(docker exec -t tue-env bash -c 'source ~/.bashrc; echo "$HOME"' | tr -d '\r')
 
-echo -e "\e[35m\e[1m docker cp ${BASEDIR}/get_install_build_packages.py tue-env:${DOCKER_HOME}\e[0m"
+echo -e "\e[35m\e[1mdocker cp ${BASEDIR}/get_install_build_packages.py tue-env:${DOCKER_HOME}\e[0m"
 docker cp "${BASEDIR}"/get_install_build_packages.py tue-env:"${DOCKER_HOME}"
 
-echo -e "\e[35m\e[1m ~/get_message_packages.py base_local_planner costmap_2d\e[0m"
+echo -e "\e[35m\e[1m~/get_message_packages.py base_local_planner costmap_2d\e[0m"
 eval "$(docker exec -t tue-env bash -c 'source ~/.bashrc; ${HOME}/get_install_build_packages.py base_local_planner costmap_2d' | tr -d '\r')" # Skip base_local_planner and costmap_2d as these take too much time
 INSTALL_BUILD_TARGETS=(${INSTALL_BUILD_PKGS[@]/#/ros-})
-echo -e "\e[35m\e[1m INSTALL_BUILD_PKGS=" "${INSTALL_BUILD_PKGS[*]}" "\e[0m"
-echo -e "\e[35m\e[1m BUILD_PKGS=" "${BUILD_PKGS[*]}" "\e[0m"
+echo -e "\e[35m\e[1mINSTALL_BUILD_PKGS=" "${INSTALL_BUILD_PKGS[*]}" "\e[0m"
+echo -e "\e[35m\e[1mBUILD_PKGS=" "${BUILD_PKGS[*]}" "\e[0m"
 
-echo -e "\e[35m\e[1m tue-get install ros-python_orocos_kdl" "${INSTALL_BUILD_TARGETS[*]}" "\e[0m"
+echo -e "\e[35m\e[1mtue-get install ros-python_orocos_kdl" "${INSTALL_BUILD_TARGETS[*]}" "\e[0m"
 # shellcheck disable=SC2145
 docker exec tue-env bash -c "source ~/.bashrc; tue-get install ros-python_orocos_kdl ${INSTALL_BUILD_TARGETS[*]}" # Needs to be installed fully as it needs to be build to generate docs
 
-echo -e '\e[35m\e[1m catkin config --workspace $TUE_SYSTEM_DIR --blacklist ed \e[0m'
+echo -e '\e[35m\e[1mcatkin config --workspace $TUE_SYSTEM_DIR --blacklist ed\e[0m'
 docker exec -t tue-env bash -c 'source ~/.bashrc; catkin config --workspace $TUE_SYSTEM_DIR --blacklist ed' # It is an exec-depend of ed_object_models, but we don't need to build it
 
-echo -e "\e[35m\e[1m tue-make --no-status python_orocos_kdl" "${INSTALL_BUILD_PKGS[*]}" "${BUILD_PKGS[*]}" "\e[0m"
+echo -e "\e[35m\e[1mtue-make --no-status python_orocos_kdl" "${INSTALL_BUILD_PKGS[*]}" "${BUILD_PKGS[*]}" "\e[0m"
 # shellcheck disable=SC2145
 docker exec -t tue-env bash -c "source ~/.bashrc; tue-make --no-status python_orocos_kdl ${INSTALL_BUILD_PKGS[*]} ${BUILD_PKGS[*]}" # Needs to be build to generate docs
 
-echo -e '\e[35m\e[1m catkin config --workspace $TUE_SYSTEM_DIR --no-blacklist\e[0m'
+echo -e '\e[35m\e[1mcatkin config --workspace $TUE_SYSTEM_DIR --no-blacklist\e[0m'
 docker exec -t tue-env bash -c 'source ~/.bashrc; catkin config --workspace $TUE_SYSTEM_DIR --no-blacklist' # Clear blacklist

.ci/pre_deploy.bash

@@ -12,14 +12,14 @@ do
             # unknown option
             if [[ -n "$i" ]]
             then
-                echo -e "\e[35m\e[1m Unknown input argument '$i'. Check CI .yml file \e[0m"
+                echo -e "\e[35m\e[1mUnknown input argument '$i'. Check CI yaml file \e[0m"
                 exit 1
             fi ;;
     esac
     shift
 done
 
-TUE_SYSTEM_DIR=$(docker exec -t tue-env bash -c 'source ~/.bashrc; echo "$TUE_SYSTEM_DIR"' | tr -d '\r')
+TUE_SYSTEM_DIR=$(docker exec -t tue-env bash -c 'source ~/.bashrc; echo "${TUE_SYSTEM_DIR}"' | tr -d '\r')
 
 echo -e "\e[35m\e[1m docker cp tue-env:${TUE_SYSTEM_DIR}/docs .\e[0m"
 docker cp tue-env:"${TUE_SYSTEM_DIR}"/docs .

.ci/script.bash

@@ -12,7 +12,7 @@ do
             # unknown option
             if [[ -n "$i" ]]
             then
-                echo -e "\e[35m\e[1m Unknown input argument '$i'. Check CI .yml file \e[0m"
+                echo -e "\e[35m\e[1mUnknown input argument '$i'. Check CI yaml file\e[0m"
                 exit 1
             fi ;;
     esac