diff --git a/.dockerignore b/.dockerignore new file mode 100644 index 0000000..6cf6bc7 --- /dev/null +++ b/.dockerignore @@ -0,0 +1,23 @@ + +# Note: +# - libnabo cmake install require that the README.md file exist in the docker image +# - libnaboer-CI doc related step require that .svg, .png and .md be copied in the docker image + +# Graphic/image related +*.svg +*.svgz +*.png +*.drawio + +# Text related +*.pdf + +# Files + + +# Directories +drawio/* +visual/* + +# IDE +.run/* diff --git a/.env.libnabo b/.env.libnabo new file mode 100644 index 0000000..7909792 --- /dev/null +++ b/.env.libnabo @@ -0,0 +1,35 @@ +# ================================================================================================= +# +# Set project related environment variables. Those are available for convenience +# and are also required by 'norlab-shell-script-tools' library. +# +# Usage: +# +# Important! Source this file from 'libnabo' repository root +# $ cd +# $ set -o allexport && source .env.libnabo && set +o allexport +# +# ================================================================================================= + +PROJECT_PROMPT_NAME='NABO' + +# ....Programaticaly fetch source code information................................................. +PROJECT_GIT_REMOTE_URL="/~https://github.com/norlab-ulaval/libnabo" +PROJECT_GIT_NAME=$( basename "${PROJECT_GIT_REMOTE_URL}" .git ) +PROJECT_PATH=$( git rev-parse --show-toplevel ) +PROJECT_SRC_NAME="$( basename ${PROJECT_PATH} )" + +# ....Set NABO related environment variable with their own prefix.................................. +# Note: Those with "PROJECT_" prefix will get eventualy overiden in the case where N2ST is used +# as a library. Using generic testing logic require that environment variables with +# "PROJECT_" prefix be available. +NABO_PROMPT_NAME="${PROJECT_PROMPT_NAME}" +NABO_GIT_REMOTE_URL="${PROJECT_GIT_REMOTE_URL}" +NABO_GIT_NAME="${PROJECT_GIT_NAME}" +NABO_PATH="${PROJECT_PATH}" +NABO_SRC_NAME="${PROJECT_SRC_NAME}" + +# ....Set dependencies path........................................................................ +NABO_BUILD_SYSTEM_PATH="${PROJECT_PATH}/build_system" +N2ST_PATH="${PROJECT_PATH}/build_system/utilities/norlab-shell-script-tools" +NBS_PATH="${PROJECT_PATH}/build_system/utilities/norlab-build-system" diff --git a/.github/CODEOWNERS b/.github/CODEOWNERS new file mode 100644 index 0000000..b843f29 --- /dev/null +++ b/.github/CODEOWNERS @@ -0,0 +1,37 @@ +# ================================================================================================= +# Files or directories with designated code owner. +# +# Note: +# - Each line is a file pattern followed by one or more owners. +# - Branch with branch protection rule "Require review from Code Owners" +# will automaticaly trigger a request to a designated code owner +# ================================================================================================= + +# ....Repository wide code owner................................................................... +# These owners will be the default owners for everything in the repo. +#* @pomerlef + + +# ....High level files............................................................................. +/README.md @pomerlef +/LICENSE @pomerlef + +# ....Core directories and files................................................................... +/examples @boxanm @simonpierredeschenes +/nabo @boxanm @simonpierredeschenes +/python @boxanm @simonpierredeschenes +/tests @boxanm @simonpierredeschenes +/contributing @RedLeader962 + +# ....User install tools........................................................................... +/.env.libnabo @RedLeader962 +/libnabo_dependencies_installer.bash @RedLeader962 +/libnabo_installer.bash @RedLeader962 + +# ....DevOps related............................................................................... +/.github/ @RedLeader962 +/build_system/ @RedLeader962 +/.gitmodules @RedLeader962 +/.gitignore @RedLeader962 +/.dockerignore @RedLeader962 + diff --git a/.github/pull_request_template.md b/.github/pull_request_template.md new file mode 100644 index 0000000..f62a0c8 --- /dev/null +++ b/.github/pull_request_template.md @@ -0,0 +1,39 @@ +# Description + +### Summary: + +### Changes and type of changes (quick overview): + +- +- +- + +--- + +# Checklist: + +### Code related + +- [ ] I have made corresponding changes to the documentation + (i.e.: function, class, script header, README.md) +- [ ] I have commented hard-to-understand code +- [ ] I have added tests that prove my fix is effective or that my feature works +- [ ] All tests pass locally with my changes + (Check [contributing/contributing_instructions.md](/contributing/contributing_instructions.md) for local testing procedure using _libnabo-build-system_) + + +### PR creation related + +- [ ] My pull request `base ref` branch is set to the `develop` branch + (the _build-system_ won't be triggered otherwise) +- [ ] My pull request branch is up-to-date with the `develop` branch + (the _build-system_ will reject it otherwise) + +### PR description related + +- [ ] I have included a quick summary of the changes +- [ ] I have indicated the related issue's id with `# ` if changes are of type `fix` +- [ ] I have included a high-level list of changes and their corresponding types + (See [contributing/commit_msg_reference.md](/contributing/commit_msg_reference.md) for details) + +--- diff --git a/.gitmodules b/.gitmodules new file mode 100644 index 0000000..56c23ad --- /dev/null +++ b/.gitmodules @@ -0,0 +1,6 @@ +[submodule "build_system/utilities/norlab-build-system"] + path = build_system/utilities/norlab-build-system + url = /~https://github.com/norlab-ulaval/norlab-build-system.git +[submodule "utilities/norlab-shell-script-tools"] + path = build_system/utilities/norlab-shell-script-tools + url = /~https://github.com/norlab-ulaval/norlab-shell-script-tools.git diff --git a/CMakeLists.txt b/CMakeLists.txt index c0061df..7ba5fb7 100644 --- a/CMakeLists.txt +++ b/CMakeLists.txt @@ -1,4 +1,6 @@ -cmake_minimum_required(VERSION 3.8) +cmake_minimum_required(VERSION 3.10.2) + +include(CMakePackageConfigHelpers) if (NOT CMAKE_VERSION VERSION_LESS "3.1") cmake_policy(SET CMP0054 NEW) @@ -84,6 +86,8 @@ else () set (CMAKE_CXX_STANDARD 11) endif () +#======================== External Dependencies =============================== + include(GNUInstallDirs) # eigen 2 or 3 @@ -243,35 +247,35 @@ export( # Create variable with the library location -set(libnabo_library $) +set(libnabo_library $) # Create variable for the local build tree get_property(libnabo_include_dirs DIRECTORY ${CMAKE_CURRENT_SOURCE_DIR} PROPERTY INCLUDE_DIRECTORIES) # Configure & generate config file for local build tree -configure_file(libnaboConfig.cmake.in - "${PROJECT_BINARY_DIR}/libnaboConfig.cmake.conf" @ONLY) -file(GENERATE - OUTPUT "${PROJECT_BINARY_DIR}/libnaboConfig.cmake" - INPUT "${PROJECT_BINARY_DIR}/libnaboConfig.cmake.conf") +configure_package_config_file(libnaboConfig.cmake.in + "${PROJECT_BINARY_DIR}/libnaboConfig.cmake" + INSTALL_DESTINATION share/libnabo/cmake + PATH_VARS PROJECT_NAME + ) # 2- installation build # # Change the library location for an install location -set(libnabo_library ${CMAKE_INSTALL_PREFIX}/lib/$) +set(libnabo_library $) # Change the include location for the case of an install location set(libnabo_include_dirs ${CMAKE_INSTALL_PREFIX}/include) # We put the generated file for installation in a different repository (i.e., ./CMakeFiles/) -configure_file(libnaboConfig.cmake.in - "${PROJECT_BINARY_DIR}${CMAKE_FILES_DIRECTORY}/libnaboConfig.cmake.conf" @ONLY) -file(GENERATE - OUTPUT "${PROJECT_BINARY_DIR}${CMAKE_FILES_DIRECTORY}/libnaboConfig.cmake" - INPUT "${PROJECT_BINARY_DIR}${CMAKE_FILES_DIRECTORY}/libnaboConfig.cmake.conf") +configure_package_config_file(libnaboConfig.cmake.in + "${PROJECT_BINARY_DIR}${CMAKE_FILES_DIRECTORY}/libnaboConfig.cmake" + INSTALL_DESTINATION share/libnabo/cmake + PATH_VARS PROJECT_NAME + ) # The same versioning file can be used for both cases -configure_file(libnaboConfigVersion.cmake.in - "${PROJECT_BINARY_DIR}/libnaboConfigVersion.cmake" @ONLY) +write_basic_package_version_file(libnaboConfigVersion.cmake + COMPATIBILITY AnyNewerVersion) install(FILES "${PROJECT_BINARY_DIR}${CMAKE_FILES_DIRECTORY}/libnaboConfig.cmake" diff --git a/README.md b/README.md index 2cf9e00..6d111f7 100644 --- a/README.md +++ b/README.md @@ -1,73 +1,180 @@ -libnabo is a fast K Nearest Neighbour library for low-dimensional spaces. -It provides a clean, legacy-free, scalar-type–agnostic API thanks to C++ templates. -Its current CPU implementation is strongly inspired by [ANN], but with more compact data types. -On the average, libnabo is 5% to 20% faster than [ANN]. +
+ +[//]: # ( ==== Logo ================================================== ) +
+
+ + + + + Shows an the dark NorLab logo in light mode and light NorLab logo in dark mode. + + +
+
+ +[//]: # ( ==== Title ================================================= ) + +# _libnabo_ + + +[//]: # ( ==== Hyperlink ============================================= ) + +NorLab TeamCity GUI +(VPN/intranet access)   •   +norlabulaval +(Docker Hub)   + +
+
+ +[//]: # ( ==== Description =========================================== ) +**libnabo is a fast K Nearest Neighbour library for low-dimensional spaces.** +
+
+ +[//]: # (====GitHub badges========================================================================) + +GitHub Repo stars +GitHub forks +GitHub License +GitHub release (with filter) + + Docker Image Version (latest semver) +
+
+
+
+ + +libnabo provides a clean, legacy-free, scalar-type–agnostic API thanks to C++ templates. +Its current CPU implementation is strongly inspired by [ANN], but with more compact data types. On the average, libnabo is 5% to 20% faster than [ANN]. + +**Dependencies:** +- libnabo depends on [Eigen], a modern C++ matrix and linear-algebra library. +- libnabo works with either version 2 or 3 of Eigen. +- libnabo also optionally depends on [Boost], a C++ general library, for Python bindings. + +**Credit:** +- libnabo was developed by [Stéphane Magnenat](http://stephane.magnenat.net) as part of his work at [ASL-ETH](http://www.asl.ethz.ch) +- libnabo is now maintained by [NorLab](/~https://github.com/norlab-ulaval) -libnabo depends on [Eigen], a modern C++ matrix and linear-algebra library. -libnabo works with either version 2 or 3 of Eigen. -libnabo also optionally depends on [Boost], a C++ general library, for Python bindings. - -libnabo was developed by [Stéphane Magnenat](http://stephane.magnenat.net) as part of his work at [ASL-ETH](http://www.asl.ethz.ch) and is now maintained by [Simon Lynen](/~https://github.com/simonlynen). If you are interested in a pure-[Rust](https://www.rust-lang.org/) version, check [that repository](/~https://github.com/enlightware/nabo-rs) out. -Download +--- + +[//]: # (====Supported OS and aarch===============================================================) + +### Supported OS And Architecture +libnabo is tested on our build system under the following architecture and OS: + +- x86 and arm64/v8 +- Ubuntu bionic (18.04) and focal (20.04) + +[//]: # (- jammy (22.04)) + +Note: + +- libnabo reportedly works on MacOs OsX (latest) and Windows (latest) + +--- + +[//]: # (====Release note=========================================================================) + +### ★ Version `1.1.0` Release Note + +This release of _libnabo_ introduces the integration +of [norlab-build-system (NBS)](/~https://github.com/norlab-ulaval/norlab-build-system) as a _git +submodule_ for codebase development and testing. + +Execute the following to clone the repository with its submodule: + +```shell +git clone --recurse-submodules /~https://github.com/norlab-ulaval/libnabo.git +``` + +If _libnabo_ was previously cloned, execute the following to fetch its new submodule + +```shell +git submodule update --remote --recursive --init +``` + +### ★ Contributing Instructions + +See [contributing_instructions.md](contributing/contributing_instructions.md) +for instructions related to bug reporting, code contribution and for setting up +the `libnabo-build-system` +on your workstation to speed up your local development workflow. + +--- +Docker images ======== +Run the following commands to pull and run libnabo in a docker container +```shell +docker pull norlabulaval/libnabo:latest-ubuntu-focal -Ubuntu builds are available on my PPA at: https://launchpad.net/~stephane.magnenat -They provide a package with the shared library, another with the development headers and a third with the documentation. +docker run -it --rm norlabulaval/libnabo:latest-ubuntu-focal +``` +See available [libnabo image tags](https://hub.docker.com/repository/docker/norlabulaval/libnabo/) on dockerhub. -The source code is available from github, you can clone the git tree by doing: +To install docker related dependencies on ubuntu, execute the following - git clone git://github.com/ethz-asl/libnabo.git +```shell +cd ./build_system/nabo_utility_script +# Execute docker tools install script i.e. docker daemon, docker compose, docker buildx +bash nabo_install_docker_tools.bash +``` Compilation =========== -libnabo uses [CMake] as build system. -The complete compilation process depends on the system you are using (Linux, Mac OS X or Windows). -You will find a nice introductory tutorial in [this video](http://www.youtube.com/watch?v=CLvZTyji_Uw). +For conveniences, you can use the provided build script for Unix +```shell +bash libnabo_dependencies_installer.bash -Prerequisites -------------- +# Use the --help flag to see the list of optional flag +bash libnabo_installer.bash [] +``` +If you want more control, you can follow these commands: +```shell +SRC_DIR=`pwd` +BUILD_DIR=${SRC_DIR}/build +mkdir -p ${BUILD_DIR} && cd ${BUILD_DIR} +cmake ${SRC_DIR} +cmake --build ${BUILD_DIR} +sudo cmake --build ${BUILD_DIR} --target install +``` +These lines will compile libnabo in a `build` sub-directory and install it system-wide. -If your operating system does not provide it, you must get [Eigen], and [Boost] if you want to build the Python bindings. -[Eigen] only needs to be downloaded and extracted. +To uninstall libnabo, simply run `sudo make uninstall` from your build directory. -Compilation options -------------------- +### Compilation options libnabo provides the following compilation options, available through [CMake]: * `SHARED_LIBS` (boolean, default: `false`): if `true`, build a shared library, otherwise build a static library -You can specify them with a command-line tool, `ccmake`, or with a graphical tool, `cmake-gui`. -Please read the [CMake documentation] for more information. +### Documentation -Quick compilation and installation under Unix ---------------------------------------------- - -Under Unix, assuming that [Eigen] and [Boost] are installed system-wide, you can compile (with optimisation and debug information) and install libnabo in `/usr/local` with the following commands run in the top-level directory of libnabo's sources: +You can generate the documentation by typing: - SRC_DIR=`pwd` - BUILD_DIR=${SRC_DIR}/build - mkdir -p ${BUILD_DIR} && cd ${BUILD_DIR} - cmake -DCMAKE_BUILD_TYPE=RelWithDebInfo ${SRC_DIR} - # if Eigen or Boost are not available system-wide, run at that point: - # cmake-gui . - # cmake-gui allows you to tell the location of Eigen or Boost - make - sudo make install + make doc -These lines will compile libnabo in a `build` sub-directory and therefore keep your source tree clean. -Note that you could compile libnabo anywhere you have write access, such as in `/tmp/libnabo`. -This out-of-source build is a nice feature of [CMake]. -If [Eigen] or [Boost] are not installed system-wide, you might have to tell [CMake] where to find them (using `ccmake` or `cmake-gui`). +Prerequisites +------------- -You can generate the documentation by typing: +If your operating system does not provide it, you must get [Eigen], and [Boost] if you want to build the Python bindings. +[Eigen] only needs to be downloaded and extracted. - make doc +Add libnabo to your CMake project +--------------------------------------------- +```cmake +find_package(libnabo REQUIRED) +target_link_libraries(example PUBLIC ${libnabo_LIBRARIES}) +target_include_directories(example PUBLIC ${libnabo_INCLUDE_DIRS}) +``` Usage ===== @@ -147,11 +254,6 @@ If you use libnabo in the academic context, please cite this paper that evaluate } -Bug reporting -============= - -Please use [github's issue tracker](http://github.com/ethz-asl/libnabo/issues) to report bugs. - License ======= diff --git a/build_system/.env b/build_system/.env new file mode 100644 index 0000000..647adc9 --- /dev/null +++ b/build_system/.env @@ -0,0 +1,43 @@ + +# +# Dockerhub or self hosted hub domain name +# +NBS_DOCKERHUB_NAMESPACE=norlabulaval + +# +# Repository url +# +# Note: +# - Main repo: /~https://github.com/norlab-ulaval/libnabo +# - Legacy repo: /~https://github.com/ethz-asl/libnabo + +NBS_REPOSITORY_DOMAIN=norlab-ulaval + +NBS_REPOSITORY_NAME=libnabo + +# +# Install script variables +# +NBS_LIB_INSTALL_PATH=/opt/percep3d_libraries + +# +# Path to the NBS build system directory (.env.build_matrix should be there) +# +NBS_SUPERPROJECT_BUILD_SYSTEM_DIR=./build_system + +# +# NorLab-build-system & NorLab-sheel-script-tools +# +PROJECT_PROMPT_NAME=NABO +NBS_SPLASH_NAME="Libnabo" +NBS_SPLASH_NAME_BUILD_SYSTEM="Libnabo Build System" + +# +# Docker built-in environment variable (do not change the variable name +# +COMPOSE_PROJECT_NAME=libnabo + +## Unmute BUILDKIT_PROGRESS to set globaly for debugging dockerfile +## For debuging docker build localy, use `docker build --progress=plain --no-cache` flags instead +#BUILDKIT_PROGRESS=plain + diff --git a/build_system/.env.build_matrix.dependencies b/build_system/.env.build_matrix.dependencies new file mode 100644 index 0000000..e11f111 --- /dev/null +++ b/build_system/.env.build_matrix.dependencies @@ -0,0 +1,42 @@ +# +# Build matrix variables +# + +# +# The compose file on which the build matrix will be crawled +# +NBS_EXECUTE_BUILD_MATRIX_OVER_COMPOSE_FILE=docker-compose.dependencies.yaml + +# +# Libnabo version +# +# 'latest' is the latest push to the libnabo master branch +#NBS_MATRIX_REPOSITORY_VERSIONS=( '1.1.0' 'latest' ) +NBS_MATRIX_REPOSITORY_VERSIONS=( 'latest' ) + +# +# Libnabo dependencies CMAKE_BUILD_TYPE +# +# Part of the build matrix used for PR +NBS_MATRIX_CMAKE_BUILD_TYPE=( 'None' ) + +# +# Libnabo dependencies supported OS +# +# ToDo: implement OsX support for arm64-Darwin (ref task NMO-213) +#NBS_MATRIX_SUPPORTED_OS=( 'ubuntu' 'osx' ) +NBS_MATRIX_SUPPORTED_OS=( 'ubuntu' ) + +# +# ubuntu supported versions +# +# Ubuntu release: https://ubuntu.com/about/release-cycle +# bionic=18.04 focal=20.04 jammy=22.04 +# Part of the build matrix used for PR +#NBS_MATRIX_UBUNTU_SUPPORTED_VERSIONS=( 'bionic' 'focal' ) +NBS_MATRIX_UBUNTU_SUPPORTED_VERSIONS=( 'bionic' 'focal' 'jammy' ) +# +# iceboxed: implement other OS support (ref task NMO-213 OsX arm64-Darwin and NMO-210 OsX x86 CD components) +#NBS_MATRIX_OSX_SUPPORTED_VERSIONS=( 'monterey' 'ventura' ) +NBS_MATRIX_OSX_SUPPORTED_VERSIONS=( ) + diff --git a/build_system/.env.build_matrix.libnabo b/build_system/.env.build_matrix.libnabo new file mode 100644 index 0000000..e2236b1 --- /dev/null +++ b/build_system/.env.build_matrix.libnabo @@ -0,0 +1,40 @@ +# +# Build matrix variables +# + +# +# The compose file on which the build matrix will be crawled +# +NBS_EXECUTE_BUILD_MATRIX_OVER_COMPOSE_FILE=docker-compose.libnabo.yaml + +# +# Libnabo version +# +# 'latest' is the latest push to the libnabo master branch +#NBS_MATRIX_REPOSITORY_VERSIONS=( '1.1.0' 'latest' ) +NBS_MATRIX_REPOSITORY_VERSIONS=( 'latest' ) + +# +# Libnabo CMAKE_BUILD_TYPE +# +NBS_MATRIX_CMAKE_BUILD_TYPE=( 'Release' 'RelWithDebInfo' 'MinSizeRel' ) +# Note: 'None' for building dependencies images + +# +# Libnabo supported OS +# +# ToDo: implement OsX support for arm64-Darwin (ref task NMO-213) +#NBS_MATRIX_SUPPORTED_OS=( 'ubuntu' 'l4t' 'osx' ) +NBS_MATRIX_SUPPORTED_OS=( 'ubuntu' ) + +# +# ubuntu supported versions +# +# Ubuntu release: https://ubuntu.com/about/release-cycle +# bionic=18.04 focal=20.04 jammy=22.04 +NBS_MATRIX_UBUNTU_SUPPORTED_VERSIONS=( 'bionic' 'focal' ) +# +# iceboxed: implement other OS support (ref task NMO-213 OsX arm64-Darwin and NMO-210 OsX x86 CD components) +#NBS_MATRIX_OSX_SUPPORTED_VERSIONS=( 'monterey' 'ventura' ) +NBS_MATRIX_OSX_SUPPORTED_VERSIONS=( ) + diff --git a/build_system/.env.build_matrix.libnabo.bleeding b/build_system/.env.build_matrix.libnabo.bleeding new file mode 100644 index 0000000..b157ec6 --- /dev/null +++ b/build_system/.env.build_matrix.libnabo.bleeding @@ -0,0 +1,41 @@ +# +# Build matrix variables +# + +# +# The compose file on which the build matrix will be crawled +# +NBS_EXECUTE_BUILD_MATRIX_OVER_COMPOSE_FILE=docker-compose.libnabo.yaml + +# +# Libnabo version +# +# 'latest' is the latest push to the libnabo master branch +NBS_MATRIX_REPOSITORY_VERSIONS=( 'latest' ) + +# +# Libnabo CMAKE_BUILD_TYPE +# +NBS_MATRIX_CMAKE_BUILD_TYPE=( 'Debug' 'Release' 'RelWithDebInfo' 'MinSizeRel' ) +# ToDo: fixme!! (ref task NMO-306 ﹅→ Test fail › install script flag `--cmake-build-type Debug --compile-test` and for all distro) +# Note: 'None' for building dependencies images + +# +# Libnabo supported OS +# +# ToDo: implement OsX support for arm64-Darwin (ref task NMO-213) +#NBS_MATRIX_SUPPORTED_OS=( 'ubuntu' 'l4t' 'osx' ) +NBS_MATRIX_SUPPORTED_OS=( 'ubuntu' ) + +# +# ubuntu supported versions +# +# Ubuntu release: https://ubuntu.com/about/release-cycle +# bionic=18.04 focal=20.04 jammy=22.04 +NBS_MATRIX_UBUNTU_SUPPORTED_VERSIONS=( 'bionic' 'focal' 'jammy' ) +# ToDo: fixme!! (ref task NMO-305 ﹅→ Build fail: ubuntu jammy with utest compilation). +# +# iceboxed: implement other OS support (ref task NMO-213 OsX arm64-Darwin and NMO-210 OsX x86 CD components) +#NBS_MATRIX_OSX_SUPPORTED_VERSIONS=( 'monterey' 'ventura' ) +NBS_MATRIX_OSX_SUPPORTED_VERSIONS=( ) + diff --git a/build_system/.env.build_matrix.libnabo.release b/build_system/.env.build_matrix.libnabo.release new file mode 100644 index 0000000..7af69d0 --- /dev/null +++ b/build_system/.env.build_matrix.libnabo.release @@ -0,0 +1,39 @@ +# +# Build matrix variables +# + +# +# The compose file on which the build matrix will be crawled +# +NBS_EXECUTE_BUILD_MATRIX_OVER_COMPOSE_FILE=docker-compose.libnabo.yaml + +# +# Libnabo version +# +# 'latest' is the latest push to the libnabo master branch +#NBS_MATRIX_REPOSITORY_VERSIONS=( '1.1.0' 'latest' ) +NBS_MATRIX_REPOSITORY_VERSIONS=( 'latest' ) + +# +# Libnabo CMAKE_BUILD_TYPE +# +NBS_MATRIX_CMAKE_BUILD_TYPE=( 'Release' ) + +# +# Libnabo supported OS +# +# ToDo: implement OsX support for arm64-Darwin (ref task NMO-213) +#NBS_MATRIX_SUPPORTED_OS=( 'ubuntu' 'l4t' 'osx' ) +NBS_MATRIX_SUPPORTED_OS=( 'ubuntu' ) + +# +# ubuntu supported versions +# +# Ubuntu release: https://ubuntu.com/about/release-cycle +# bionic=18.04 focal=20.04 jammy=22.04 +NBS_MATRIX_UBUNTU_SUPPORTED_VERSIONS=( 'bionic' 'focal' ) +# +# iceboxed: implement other OS support (ref task NMO-213 OsX arm64-Darwin and NMO-210 OsX x86 CD components) +#NBS_MATRIX_OSX_SUPPORTED_VERSIONS=( 'monterey' 'ventura' ) +NBS_MATRIX_OSX_SUPPORTED_VERSIONS=( ) + diff --git "a/build_system/.jetbrains_run_config/(HELP) bash libnabo_installer.bash \342\200\272 --help menu.run.xml" "b/build_system/.jetbrains_run_config/(HELP) bash libnabo_installer.bash \342\200\272 --help menu.run.xml" new file mode 100644 index 0000000..f41385e --- /dev/null +++ "b/build_system/.jetbrains_run_config/(HELP) bash libnabo_installer.bash \342\200\272 --help menu.run.xml" @@ -0,0 +1,19 @@ + + + + diff --git "a/build_system/.jetbrains_run_config/(HELP) bash nabo_crawl_libnabo_build_matrix.bash \342\200\272 --help menu.run.xml" "b/build_system/.jetbrains_run_config/(HELP) bash nabo_crawl_libnabo_build_matrix.bash \342\200\272 --help menu.run.xml" new file mode 100644 index 0000000..281da6b --- /dev/null +++ "b/build_system/.jetbrains_run_config/(HELP) bash nabo_crawl_libnabo_build_matrix.bash \342\200\272 --help menu.run.xml" @@ -0,0 +1,19 @@ + + + + diff --git "a/build_system/.jetbrains_run_config/(HELP) bash nabo_install_libnabo_ubuntu.bash \342\200\272 --help menu.run.xml" "b/build_system/.jetbrains_run_config/(HELP) bash nabo_install_libnabo_ubuntu.bash \342\200\272 --help menu.run.xml" new file mode 100644 index 0000000..f03d30c --- /dev/null +++ "b/build_system/.jetbrains_run_config/(HELP) bash nabo_install_libnabo_ubuntu.bash \342\200\272 --help menu.run.xml" @@ -0,0 +1,19 @@ + + + + diff --git a/build_system/.jetbrains_run_config/[NABO] run all bats tests.run.xml b/build_system/.jetbrains_run_config/[NABO] run all bats tests.run.xml new file mode 100644 index 0000000..2fbe4d4 --- /dev/null +++ b/build_system/.jetbrains_run_config/[NABO] run all bats tests.run.xml @@ -0,0 +1,19 @@ + + + + \ No newline at end of file diff --git "a/build_system/.jetbrains_run_config/bash nabo_crawl_dependencies_build_matrix.bash \342\200\272 build dependencies-general dependencies (BUILD MATRIX SUBSET).run.xml" "b/build_system/.jetbrains_run_config/bash nabo_crawl_dependencies_build_matrix.bash \342\200\272 build dependencies-general dependencies (BUILD MATRIX SUBSET).run.xml" new file mode 100644 index 0000000..c9ccf41 --- /dev/null +++ "b/build_system/.jetbrains_run_config/bash nabo_crawl_dependencies_build_matrix.bash \342\200\272 build dependencies-general dependencies (BUILD MATRIX SUBSET).run.xml" @@ -0,0 +1,19 @@ + + + + diff --git "a/build_system/.jetbrains_run_config/bash nabo_crawl_dependencies_build_matrix.bash \342\200\272 build&push dependencies-general dependencies (AS IN TC).run.xml" "b/build_system/.jetbrains_run_config/bash nabo_crawl_dependencies_build_matrix.bash \342\200\272 build&push dependencies-general dependencies (AS IN TC).run.xml" new file mode 100644 index 0000000..804f77e --- /dev/null +++ "b/build_system/.jetbrains_run_config/bash nabo_crawl_dependencies_build_matrix.bash \342\200\272 build&push dependencies-general dependencies (AS IN TC).run.xml" @@ -0,0 +1,19 @@ + + + + diff --git "a/build_system/.jetbrains_run_config/bash nabo_crawl_libnabo_build_matrix.bash \342\200\272 build _service_ _popup_.run.xml" "b/build_system/.jetbrains_run_config/bash nabo_crawl_libnabo_build_matrix.bash \342\200\272 build _service_ _popup_.run.xml" new file mode 100644 index 0000000..5bd99fe --- /dev/null +++ "b/build_system/.jetbrains_run_config/bash nabo_crawl_libnabo_build_matrix.bash \342\200\272 build _service_ _popup_.run.xml" @@ -0,0 +1,19 @@ + + + + diff --git "a/build_system/.jetbrains_run_config/bash nabo_crawl_libnabo_build_matrix.bash \342\200\272 build dependencies_arm64v8 ci_PR_arm64v8 _popup_.run.xml" "b/build_system/.jetbrains_run_config/bash nabo_crawl_libnabo_build_matrix.bash \342\200\272 build dependencies_arm64v8 ci_PR_arm64v8 _popup_.run.xml" new file mode 100644 index 0000000..e2ab359 --- /dev/null +++ "b/build_system/.jetbrains_run_config/bash nabo_crawl_libnabo_build_matrix.bash \342\200\272 build dependencies_arm64v8 ci_PR_arm64v8 _popup_.run.xml" @@ -0,0 +1,19 @@ + + + + diff --git "a/build_system/.jetbrains_run_config/bash nabo_crawl_libnabo_build_matrix.bash \342\200\272 build test_compilation__ (Release).run.xml" "b/build_system/.jetbrains_run_config/bash nabo_crawl_libnabo_build_matrix.bash \342\200\272 build test_compilation__ (Release).run.xml" new file mode 100644 index 0000000..4f51d20 --- /dev/null +++ "b/build_system/.jetbrains_run_config/bash nabo_crawl_libnabo_build_matrix.bash \342\200\272 build test_compilation__ (Release).run.xml" @@ -0,0 +1,19 @@ + + + + \ No newline at end of file diff --git "a/build_system/.jetbrains_run_config/bash nabo_crawl_libnabo_build_matrix.bash \342\200\272 build test_compilation_prefixed_path (BUILD MATRIX SUBSET).run.xml" "b/build_system/.jetbrains_run_config/bash nabo_crawl_libnabo_build_matrix.bash \342\200\272 build test_compilation_prefixed_path (BUILD MATRIX SUBSET).run.xml" new file mode 100644 index 0000000..ff75047 --- /dev/null +++ "b/build_system/.jetbrains_run_config/bash nabo_crawl_libnabo_build_matrix.bash \342\200\272 build test_compilation_prefixed_path (BUILD MATRIX SUBSET).run.xml" @@ -0,0 +1,19 @@ + + + + \ No newline at end of file diff --git a/build_system/.jetbrains_run_config/cwd tree + docker system disk usage.run.xml b/build_system/.jetbrains_run_config/cwd tree + docker system disk usage.run.xml new file mode 100644 index 0000000..072d348 --- /dev/null +++ b/build_system/.jetbrains_run_config/cwd tree + docker system disk usage.run.xml @@ -0,0 +1,17 @@ + + + + \ No newline at end of file diff --git a/build_system/.jetbrains_run_config/interactive.run.xml b/build_system/.jetbrains_run_config/interactive.run.xml new file mode 100644 index 0000000..da68954 --- /dev/null +++ b/build_system/.jetbrains_run_config/interactive.run.xml @@ -0,0 +1,17 @@ + + + + diff --git a/build_system/.jetbrains_run_config/list docker images + container.run.xml b/build_system/.jetbrains_run_config/list docker images + container.run.xml new file mode 100644 index 0000000..255d5db --- /dev/null +++ b/build_system/.jetbrains_run_config/list docker images + container.run.xml @@ -0,0 +1,17 @@ + + + + \ No newline at end of file diff --git "a/build_system/.jetbrains_run_config/lpm_execute_compose_over_build_matrix.bash \342\200\272 test flag (popup).run.xml" "b/build_system/.jetbrains_run_config/lpm_execute_compose_over_build_matrix.bash \342\200\272 test flag (popup).run.xml" new file mode 100644 index 0000000..c1a8c5c --- /dev/null +++ "b/build_system/.jetbrains_run_config/lpm_execute_compose_over_build_matrix.bash \342\200\272 test flag (popup).run.xml" @@ -0,0 +1,17 @@ + + + + diff --git a/build_system/.jetbrains_run_config/run and open a terminal in a Ubuntu 20.04 container.run.xml b/build_system/.jetbrains_run_config/run and open a terminal in a Ubuntu 20.04 container.run.xml new file mode 100644 index 0000000..b646b2f --- /dev/null +++ b/build_system/.jetbrains_run_config/run and open a terminal in a Ubuntu 20.04 container.run.xml @@ -0,0 +1,17 @@ + + + + \ No newline at end of file diff --git a/build_system/.jetbrains_run_config/run_all_docker_dryrun_and_config_tests.bash.run.xml b/build_system/.jetbrains_run_config/run_all_docker_dryrun_and_config_tests.bash.run.xml new file mode 100644 index 0000000..b7b466b --- /dev/null +++ b/build_system/.jetbrains_run_config/run_all_docker_dryrun_and_config_tests.bash.run.xml @@ -0,0 +1,19 @@ + + + + \ No newline at end of file diff --git a/build_system/.jetbrains_run_config/test_execute_compose_over_build_matrix.bash.run.xml b/build_system/.jetbrains_run_config/test_execute_compose_over_build_matrix.bash.run.xml new file mode 100644 index 0000000..32ae760 --- /dev/null +++ b/build_system/.jetbrains_run_config/test_execute_compose_over_build_matrix.bash.run.xml @@ -0,0 +1,17 @@ + + + + diff --git a/build_system/.jetbrains_run_config/test_execute_compose_over_build_matrix_with_flag.bash.run.xml b/build_system/.jetbrains_run_config/test_execute_compose_over_build_matrix_with_flag.bash.run.xml new file mode 100644 index 0000000..362bb8f --- /dev/null +++ b/build_system/.jetbrains_run_config/test_execute_compose_over_build_matrix_with_flag.bash.run.xml @@ -0,0 +1,17 @@ + + + + diff --git a/build_system/README.md b/build_system/README.md new file mode 100644 index 0000000..aab8334 --- /dev/null +++ b/build_system/README.md @@ -0,0 +1 @@ +See [contributing/contributing_instructions.md](/contributing/contributing_instructions.md) for instructions related to bug reporting, code contribution and for setting up the `libnabo-build-system` on your workstation to speed up your local development workflow. diff --git a/build_system/docker-compose.dependencies.yaml b/build_system/docker-compose.dependencies.yaml new file mode 100644 index 0000000..7b3348a --- /dev/null +++ b/build_system/docker-compose.dependencies.yaml @@ -0,0 +1,39 @@ +services: + + # ====Dependency related services================================================================ + dependencies: + image: ${NBS_DOCKERHUB_NAMESPACE:?err}/libnabo-dependencies:${NBS_IMAGE_TAG:?err} + build: + context: .. + dockerfile: ${NBS_SUPERPROJECT_BUILD_SYSTEM_DIR:?err}/ubuntu/Dockerfile.dependencies + platforms: + - "linux/amd64" + - "linux/arm64/v8" + args: + BASE_IMAGE: ${DEPENDENCIES_BASE_IMAGE:?err} + BASE_IMAGE_TAG: ${DEPENDENCIES_BASE_IMAGE_TAG:?err} + NBS_SUPERPROJECT_BUILD_SYSTEM_DIR: ${NBS_SUPERPROJECT_BUILD_SYSTEM_DIR:?err} + IS_TEAMCITY_RUN: ${IS_TEAMCITY_RUN} + NBS_LIB_INSTALL_PATH: ${NBS_LIB_INSTALL_PATH:?err} + NBS_REPOSITORY_NAME: ${NBS_REPOSITORY_NAME:?err} + tty: true + stdin_open: true + init: true # Propagate exit code (See remark in task NMO-266) + + dependencies-doc: + image: ${NBS_DOCKERHUB_NAMESPACE:?err}/libnabo-dependencies-doc:${NBS_IMAGE_TAG:?err} + build: + context: .. + dockerfile: ${NBS_SUPERPROJECT_BUILD_SYSTEM_DIR:?err}/ubuntu/Dockerfile.dependencies.doxygen + platforms: + - "linux/amd64" + - "linux/arm64/v8" + args: + PROJECT_HUB: ${NBS_DOCKERHUB_NAMESPACE} + BASE_IMAGE: libnabo-dependencies + BASE_IMAGE_TAG: ${NBS_IMAGE_TAG} + IS_TEAMCITY_RUN: ${IS_TEAMCITY_RUN} + depends_on: + - dependencies + tty: true + stdin_open: true diff --git a/build_system/docker-compose.libnabo.yaml b/build_system/docker-compose.libnabo.yaml new file mode 100644 index 0000000..5c953a2 --- /dev/null +++ b/build_system/docker-compose.libnabo.yaml @@ -0,0 +1,104 @@ +include: + - docker-compose.dependencies.yaml + +services: + + # ====Pull-request related services============================================================== + # ....Test logic related to libnabo install casses............................................... + _integration_test: + image: ${NBS_DOCKERHUB_NAMESPACE:?err}/libnabo-integration-test:${NBS_IMAGE_TAG:?err} + pull_policy: build + build: + context: .. + dockerfile: ${NBS_SUPERPROJECT_BUILD_SYSTEM_DIR:?err}/ubuntu/Dockerfile.libnabo.integration_test + no_cache: true + target: integration-test-compile-auto-path-resolution + ## Mute 'platforms' while using arch virtualization with C++ build to prevent segmentation fault during nabo cmake install +# platforms: +# - "linux/amd64" +# - "linux/arm64/v8" + args: + PROJECT_HUB: ${NBS_DOCKERHUB_NAMESPACE} + BASE_IMAGE: libnabo-dependencies + BASE_IMAGE_TAG: ${NBS_IMAGE_TAG} + IS_TEAMCITY_RUN: ${IS_TEAMCITY_RUN} + REPOSITORY_VERSION: 'latest' + CMAKE_BUILD_TYPE: ${CMAKE_BUILD_TYPE:?err} + INSTALL_SCRIPT_FLAG: '--build-system-CI-install' + tty: true + stdin_open: true + init: true # Propagate exit code (See remark in task NMO-266) + depends_on: + - dependencies + integration_test_prefixed_path: + extends: _integration_test + build: + target: integration-test-compile-prefixed-path + depends_on: + - _integration_test + integration_test_auto_path_resolution: + extends: _integration_test + build: + target: integration-test-compile-auto-path-resolution + depends_on: + - _integration_test + + # ....Test logic related to libnabo codebase unit-test........................................... + ci_PR: + image: ${NBS_DOCKERHUB_NAMESPACE:?err}/libnabo-ci-pr:${NBS_IMAGE_TAG:?err} + pull_policy: build + build: + context: .. + dockerfile: ${NBS_SUPERPROJECT_BUILD_SYSTEM_DIR}/ubuntu/Dockerfile.libnabo.ci_PR + no_cache: true + args: + PROJECT_HUB: ${NBS_DOCKERHUB_NAMESPACE} + BASE_IMAGE: libnabo-dependencies + BASE_IMAGE_TAG: ${NBS_IMAGE_TAG} + IS_TEAMCITY_RUN: ${IS_TEAMCITY_RUN} + REPOSITORY_VERSION: 'latest' + CMAKE_BUILD_TYPE: ${CMAKE_BUILD_TYPE:?err} + INSTALL_SCRIPT_FLAG: '--build-system-CI-install --compile-test' + tty: true + stdin_open: true + init: true # Propagate exit code (See remark in task NMO-266) + depends_on: + - dependencies + ci_PR_amd64: + extends: ci_PR + build: + platforms: + - "linux/amd64" + ci_PR_arm64v8: + extends: ci_PR + build: + platforms: + - "linux/arm64/v8" + + # ====Dockerhub release image==================================================================== + release: + image: ${NBS_DOCKERHUB_NAMESPACE:?err}/libnabo:${NBS_IMAGE_TAG:?err} + container_name: libnabo + build: + context: .. + dockerfile: ${NBS_SUPERPROJECT_BUILD_SYSTEM_DIR}/ubuntu/Dockerfile.libnabo.hub_release + platforms: + - "linux/amd64" + - "linux/arm64/v8" + no_cache: true + args: + PROJECT_HUB: ${NBS_DOCKERHUB_NAMESPACE} + BASE_IMAGE: libnabo-dependencies-doc + BASE_IMAGE_TAG: ${NBS_IMAGE_TAG} + IS_TEAMCITY_RUN: ${IS_TEAMCITY_RUN} + REPOSITORY_VERSION: ${REPOSITORY_VERSION:?err} + CMAKE_BUILD_TYPE: 'Release' + INSTALL_SCRIPT_FLAG: '--compile-test --generate-doc' + tty: true + stdin_open: true + init: true # Propagate exit code (See remark in task NMO-266) + depends_on: + - dependencies + - dependencies-doc + + diff --git a/build_system/nabo_crawl_dependencies_build_matrix.bash b/build_system/nabo_crawl_dependencies_build_matrix.bash new file mode 100644 index 0000000..1449603 --- /dev/null +++ b/build_system/nabo_crawl_dependencies_build_matrix.bash @@ -0,0 +1,39 @@ +#!/bin/bash +# ================================================================================================= +# +# Execute build matrix specified in '.env.build_matrix.dependencies' +# +# Redirect the execution to 'nbs_execute_compose_over_build_matrix.bash' from the norlab-build-system library +# +# Usage: +# $ bash nabo_crawl_dependencies_build_matrix.bash [] [-- ] +# +# $ bash nabo_crawl_dependencies_build_matrix.bash -- build --dry-run +# +# Run script with the '--help' flag for details +# +# ================================================================================================= +PARAMS="$@" + +# ....path resolution logic........................................................................ +NABO_ROOT="$(dirname "$(realpath "$0")")/.." +NABO_BUILD_SYSTEM_PATH="${NABO_ROOT}/build_system" +NBS_PATH="${NABO_BUILD_SYSTEM_PATH}/utilities/norlab-build-system" +N2ST_PATH="${NABO_BUILD_SYSTEM_PATH}/utilities/norlab-shell-script-tools" + +# ....Load environment variables from file......................................................... +cd "${NABO_BUILD_SYSTEM_PATH}" || exit 1 +set -o allexport && source .env && set +o allexport + +# ....Source NBS dependencies...................................................................... +cd "${NBS_PATH}" || exit 1 +source import_norlab_build_system_lib.bash + +# ====begin======================================================================================== +cd "${NBS_PATH}/src/utility_scripts" || exit 1 + +DOTENV_BUILD_MATRIX_REALPATH=${NABO_BUILD_SYSTEM_PATH}/.env.build_matrix.dependencies + +# Note: do not double quote PARAMS or threat it as a array otherwise it will cause error +# shellcheck disable=SC2086 +source nbs_execute_compose_over_build_matrix.bash "${DOTENV_BUILD_MATRIX_REALPATH}" $PARAMS diff --git a/build_system/nabo_crawl_libnabo_build_matrix.bash b/build_system/nabo_crawl_libnabo_build_matrix.bash new file mode 100644 index 0000000..fd716a5 --- /dev/null +++ b/build_system/nabo_crawl_libnabo_build_matrix.bash @@ -0,0 +1,40 @@ +#!/bin/bash +# ================================================================================================= +# +# Execute build matrix specified in .env.build_matrix.libnabo +# +# Redirect the execution to 'nbs_execute_compose_over_build_matrix.bash' from the norlab-build-system library +# +# Usage: +# $ bash nabo_crawl_libnabo_build_matrix.bash [] [-- ] +# +# $ bash nabo_crawl_libnabo_build_matrix.bash -- build --dry-run +# +# Run script with the '--help' flag for details +# +# ================================================================================================= +PARAMS="$@" + +# ....path resolution logic........................................................................ +NABO_ROOT="$(dirname "$(realpath "$0")")/.." +NABO_BUILD_SYSTEM_PATH="${NABO_ROOT}/build_system" +NBS_PATH="${NABO_BUILD_SYSTEM_PATH}/utilities/norlab-build-system" +N2ST_PATH="${NABO_BUILD_SYSTEM_PATH}/utilities/norlab-shell-script-tools" + +# ....Load environment variables from file......................................................... +cd "${NABO_BUILD_SYSTEM_PATH}" || exit 1 +set -o allexport && source .env && set +o allexport + +# ....Source NBS dependencies...................................................................... +cd "${NBS_PATH}" || exit 1 +source import_norlab_build_system_lib.bash + +# ====begin======================================================================================== +cd "${NBS_PATH}/src/utility_scripts" || exit 1 + +DOTENV_BUILD_MATRIX_REALPATH=${NABO_BUILD_SYSTEM_PATH}/.env.build_matrix.libnabo + +# Note: do not double quote PARAMS or threat it as a array otherwise it will cause error +# shellcheck disable=SC2086 +source nbs_execute_compose_over_build_matrix.bash "${DOTENV_BUILD_MATRIX_REALPATH}" $PARAMS + diff --git a/build_system/nabo_crawl_libnabo_build_matrix.bleeding.bash b/build_system/nabo_crawl_libnabo_build_matrix.bleeding.bash new file mode 100644 index 0000000..17bb27c --- /dev/null +++ b/build_system/nabo_crawl_libnabo_build_matrix.bleeding.bash @@ -0,0 +1,39 @@ +#!/bin/bash +# ================================================================================================= +# +# Execute build matrix specified in .env.build_matrix.libnabo.bleeding +# +# Redirect the execution to 'nbs_execute_compose_over_build_matrix.bash' from the norlab-build-system library +# +# Usage: +# $ bash nabo_crawl_libnabo_build_matrix.bleeding.bash [] [-- ] +# +# $ bash nabo_crawl_libnabo_build_matrix.bleeding.bash -- build --dry-run +# +# Run script with the '--help' flag for details +# +# ================================================================================================= +PARAMS="$@" + +# ....path resolution logic........................................................................ +NABO_ROOT="$(dirname "$(realpath "$0")")/.." +NABO_BUILD_SYSTEM_PATH="${NABO_ROOT}/build_system" +NBS_PATH="${NABO_BUILD_SYSTEM_PATH}/utilities/norlab-build-system" +N2ST_PATH="${NABO_BUILD_SYSTEM_PATH}/utilities/norlab-shell-script-tools" + +# ....Load environment variables from file......................................................... +cd "${NABO_BUILD_SYSTEM_PATH}" || exit 1 +set -o allexport && source .env && set +o allexport + +# ....Source NBS dependencies...................................................................... +cd "${NBS_PATH}" || exit 1 +source import_norlab_build_system_lib.bash + +# ====begin======================================================================================== +cd "${NBS_PATH}/src/utility_scripts" || exit 1 + +DOTENV_BUILD_MATRIX_REALPATH=${NABO_BUILD_SYSTEM_PATH}/.env.build_matrix.libnabo.bleeding + +# Note: do not double quote PARAMS or threat it as a array otherwise it will cause error +# shellcheck disable=SC2086 +source nbs_execute_compose_over_build_matrix.bash "${DOTENV_BUILD_MATRIX_REALPATH}" $PARAMS diff --git a/build_system/nabo_crawl_libnabo_build_matrix.release.bash b/build_system/nabo_crawl_libnabo_build_matrix.release.bash new file mode 100644 index 0000000..ce2288e --- /dev/null +++ b/build_system/nabo_crawl_libnabo_build_matrix.release.bash @@ -0,0 +1,40 @@ +#!/bin/bash +# ================================================================================================= +# +# Execute build matrix specified in .env.build_matrix.libnabo +# +# Redirect the execution to 'nbs_execute_compose_over_build_matrix.bash' from the norlab-build-system library +# +# Usage: +# $ bash nabo_crawl_libnabo_build_matrix.bash [] [-- ] +# +# $ bash nabo_crawl_libnabo_build_matrix.bash -- build --dry-run +# +# Run script with the '--help' flag for details +# +# ================================================================================================= +PARAMS="${@:-"--fail-fast -- build --push release"}" + +# ....path resolution logic........................................................................ +NABO_ROOT="$(dirname "$(realpath "$0")")/.." +NABO_BUILD_SYSTEM_PATH="${NABO_ROOT}/build_system" +NBS_PATH="${NABO_BUILD_SYSTEM_PATH}/utilities/norlab-build-system" +N2ST_PATH="${NABO_BUILD_SYSTEM_PATH}/utilities/norlab-shell-script-tools" + +# ....Load environment variables from file......................................................... +cd "${NABO_BUILD_SYSTEM_PATH}" || exit 1 +set -o allexport && source .env && set +o allexport + +# ....Source NBS dependencies...................................................................... +cd "${NBS_PATH}" || exit 1 +source import_norlab_build_system_lib.bash + +# ====begin======================================================================================== +cd "${NBS_PATH}/src/utility_scripts" || exit 1 + +DOTENV_BUILD_MATRIX_REALPATH=${NABO_BUILD_SYSTEM_PATH}/.env.build_matrix.libnabo.release + +# Note: do not double quote PARAMS or threat it as a array otherwise it will cause error +# shellcheck disable=SC2086 +source nbs_execute_compose_over_build_matrix.bash "${DOTENV_BUILD_MATRIX_REALPATH}" $PARAMS + diff --git a/build_system/nabo_utility_script/nabo_create_multiarch_docker_builder.bash b/build_system/nabo_utility_script/nabo_create_multiarch_docker_builder.bash new file mode 100644 index 0000000..0252da8 --- /dev/null +++ b/build_system/nabo_utility_script/nabo_create_multiarch_docker_builder.bash @@ -0,0 +1,24 @@ +#!/bin/bash +# +# Utility script to create a multi-architecture docker builder +# +# usage: +# $ bash ./nabo_utility_script/nabo_create_multiarch_docker_builder.bash +# +function nabo::create_multiarch_docker_builder() { + local TMP_CWD + TMP_CWD=$(pwd) + + # ....Project root logic......................................................................... + NABO_PATH=$(git rev-parse --show-toplevel) + + # ====Begin===================================================================================== + cd "${NABO_PATH}"/build_system/utilities/norlab-build-system/install_scripts/ \ + && bash nbs_create_multiarch_docker_builder.bash + + # ====Teardown=================================================================================== + cd "${TMP_CWD}" +} + +# ::::main::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::: +nabo::create_multiarch_docker_builder diff --git a/build_system/nabo_utility_script/nabo_install_docker_tools.bash b/build_system/nabo_utility_script/nabo_install_docker_tools.bash new file mode 100644 index 0000000..6612b75 --- /dev/null +++ b/build_system/nabo_utility_script/nabo_install_docker_tools.bash @@ -0,0 +1,25 @@ +#!/bin/bash +# +# Utility script to install docker related tools and execute basic configuration +# +# usage: +# $ bash ./nabo_utility_script/nabo_install_docker_tools.bash +# + +function nabo::install_docker_tools() { + local TMP_CWD + TMP_CWD=$(pwd) + + # ....Project root logic......................................................................... + NABO_PATH=$(git rev-parse --show-toplevel) + + # ====Begin===================================================================================== + cd "${NABO_PATH}"/build_system/utilities/norlab-build-system/install_scripts/ \ + && bash nbs_install_docker_tools.bash + + # ====Teardown=================================================================================== + cd "${TMP_CWD}" +} + +# ::::main::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::: +nabo::install_docker_tools diff --git a/build_system/tests/run_all_docker_dryrun_and_config_tests.bash b/build_system/tests/run_all_docker_dryrun_and_config_tests.bash new file mode 100644 index 0000000..21c4444 --- /dev/null +++ b/build_system/tests/run_all_docker_dryrun_and_config_tests.bash @@ -0,0 +1,15 @@ +#!/bin/bash +# +# Run all tests in directory +# +# Usage: +# $ bash run_all_docker_dryrun_and_config_tests.bash +# +# + +_PATH_TO_SCRIPT="$(realpath "$0")" +SCRIPT_DIR_PATH="$(dirname "${_PATH_TO_SCRIPT}")" +TEST_DIR="$SCRIPT_DIR_PATH/tests_docker_dryrun_and_config" + +source "${SCRIPT_DIR_PATH}/../utilities/norlab-build-system/src/utility_scripts/nbs_run_all_test_and_dryrun_in_directory.bash" "${TEST_DIR}" + diff --git a/build_system/tests/run_bats_core_test_in_n2st.bash b/build_system/tests/run_bats_core_test_in_n2st.bash new file mode 100644 index 0000000..6ab3cde --- /dev/null +++ b/build_system/tests/run_bats_core_test_in_n2st.bash @@ -0,0 +1,46 @@ +#!/bin/bash +# ================================================================================================= +# Execute libnabo repo shell script tests via 'norlab-shell-script-tools' library +# +# Note the script can be executed from anywhere as long as its inside the libnabo repository +# +# Usage: +# $ bash run_bats_core_test_in_n2st.bash ['[/]' ['']] +# +# Arguments: +# - [''] The directory from which to start test, default to 'tests' +# - ['/'] A specific bats file to run, default will +# run all bats file in the test directory +# +# Globals: none +# +# ================================================================================================= +PARAMS="$@" + +if [[ -z $PARAMS ]]; then + # Set to default bats tests directory if none specified + PARAMS="build_system/tests/tests_bats/" +fi + +N2ST_PATH="build_system/utilities/norlab-shell-script-tools" + +function n2st::run_n2st_testsing_tools(){ + local TMP_CWD + TMP_CWD=$(pwd) + + # ....Project root logic......................................................................... + NABO_PATH=$(git rev-parse --show-toplevel) + N2ST_PATH=${N2ST_PATH:-"./utilities/norlab-shell-script-tools"} + + # ....Execute N2ST run_bats_tests_in_docker.bash................................................. + cd "$NABO_PATH" + + # shellcheck disable=SC2086 + bash "${N2ST_PATH}/tests/bats_testing_tools/run_bats_tests_in_docker.bash" $PARAMS + + # ....Teardown................................................................................... + cd "$TMP_CWD" + } + +n2st::run_n2st_testsing_tools + diff --git a/build_system/tests/tests_bats/bats_helper_functions.bash b/build_system/tests/tests_bats/bats_helper_functions.bash new file mode 100644 index 0000000..efbbea4 --- /dev/null +++ b/build_system/tests/tests_bats/bats_helper_functions.bash @@ -0,0 +1,9 @@ +#!/bin/bash + +function test_generic_help_flag_logic() { + assert_success + + assert_output --regexp .*"Starting".*"${TESTED_FILE}".*"\$".*"${TESTED_FILE} \[--help\] <.env.build_matrix.*> \[\] \[-- \]".*"Mandatory argument:".*"<.env.build_matrix.*>".*"Optional arguments:".*"-h, --help".*"--docker-debug-logs".*"--fail-fast" + + refute_output --regexp .*"Starting".*"${TESTED_FILE}".*"\[NBS\]".*"Build images specified in".*"'${COMPOSE_FILE}'".*"following".*"${DOTENV_BUILD_MATRIX_NAME}" +} diff --git a/build_system/tests/tests_bats/test_dotenv_libnabo.bats b/build_system/tests/tests_bats/test_dotenv_libnabo.bats new file mode 100644 index 0000000..b99d723 --- /dev/null +++ b/build_system/tests/tests_bats/test_dotenv_libnabo.bats @@ -0,0 +1,107 @@ +#!/usr/bin/env bats +# +# Usage in docker container +# $ REPO_ROOT=$(pwd) && RUN_TESTS_IN_DIR='tests' +# $ docker run -it --rm -v "$REPO_ROOT:/code" bats/bats:latest "$RUN_TESTS_IN_DIR" +# +# Note: "/code" is the working directory in the bats official image +# +# bats-core ref: +# - https://bats-core.readthedocs.io/en/stable/tutorial.html +# - https://bats-core.readthedocs.io/en/stable/writing-tests.html +# - https://opensource.com/article/19/2/testing-bash-bats +# ↳ /~https://github.com/dmlond/how_to_bats/blob/master/test/build.bats +# +# Helper library: +# - /~https://github.com/bats-core/bats-assert +# - /~https://github.com/bats-core/bats-support +# - /~https://github.com/bats-core/bats-file +# + +BATS_HELPER_PATH=/usr/lib/bats +if [[ -d ${BATS_HELPER_PATH} ]]; then + load "${BATS_HELPER_PATH}/bats-support/load" + load "${BATS_HELPER_PATH}/bats-assert/load" + load "${BATS_HELPER_PATH}/bats-file/load" + load "${SRC_CODE_PATH}/${N2ST_BATS_TESTING_TOOLS_RELATIVE_PATH}/bats_helper_functions" + #load "${BATS_HELPER_PATH}/bats-detik/load" # << Kubernetes support +else + echo -e "\n[\033[1;31mERROR\033[0m] $0 path to bats-core helper library unreachable at \"${BATS_HELPER_PATH}\"!" 1>&2 + echo '(press any key to exit)' + read -r -n 1 + exit 1 +fi + +# ====Setup======================================================================================== + +DOTENV_FILE=".env.libnabo" +TESTED_FILE_PATH="." + +# executed once before starting the first test (valide for all test in that file) +setup_file() { + BATS_DOCKER_WORKDIR=$(pwd) && export BATS_DOCKER_WORKDIR + + ## Uncomment the following for debug, the ">&3" is for printing bats msg to stdin +# pwd >&3 && tree -L 1 -a -hug >&3 +# printenv >&3 +} + +# executed before each test +setup() { + cd "$TESTED_FILE_PATH" || exit 1 +} + +# ====Teardown===================================================================================== + +# executed after each test +teardown() { + bats_print_run_env_variable_on_error +} + +## executed once after finishing the last test (valide for all test in that file) +#teardown_file() { +#} + +# ====Test casses================================================================================== +@test "${DOTENV_FILE} › Env variables set ok" { + # ....Pre-condition.............................................................................. + assert_empty "${PROJECT_PROMPT_NAME}" + assert_empty "${PROJECT_GIT_REMOTE_URL}" + assert_empty "${PROJECT_GIT_NAME}" + assert_empty "${PROJECT_SRC_NAME}" + assert_empty "${PROJECT_PATH}" + + assert_empty "${NABO_PROMPT_NAME}" + assert_empty "${NABO_GIT_REMOTE_URL}" + assert_empty "${NABO_GIT_NAME}" + assert_empty "${NABO_PATH}" + assert_empty "${NABO_SRC_NAME}" + + assert_empty "${NABO_BUILD_SYSTEM_PATH}" + assert_empty "${N2ST_PATH}" + assert_empty "${NBS_PATH}" + + # ....Source .env.project........................................................................ + set -o allexport + source "${BATS_DOCKER_WORKDIR:?err}/${DOTENV_FILE}" + set +o allexport + +# printenv | grep -e 'CONTAINER_PROJECT_' -e 'PROJECT_' >&3 + + # ....Tests...................................................................................... + assert_equal "${PROJECT_PROMPT_NAME}" "NABO" + assert_regex "${PROJECT_GIT_REMOTE_URL}" "/~https://github.com/norlab-ulaval/libnabo"'(".git")?' + assert_equal "${PROJECT_GIT_NAME}" "libnabo" + assert_equal "${PROJECT_SRC_NAME}" "libnabo" + assert_equal "${PROJECT_PATH}" "/code/libnabo" + + assert_equal "${NABO_PROMPT_NAME}" "NABO" + assert_regex "${NABO_GIT_REMOTE_URL}" "/~https://github.com/norlab-ulaval/libnabo"'(".git")?' + assert_equal "${NABO_GIT_NAME}" "libnabo" + assert_equal "${NABO_SRC_NAME}" "libnabo" + assert_equal "${NABO_PATH}" "/code/libnabo" + + assert_equal "${NABO_BUILD_SYSTEM_PATH}" "/code/libnabo/build_system" + assert_equal "${N2ST_PATH}" "/code/libnabo/build_system/utilities/norlab-shell-script-tools" + assert_equal "${NBS_PATH}" "/code/libnabo/build_system/utilities/norlab-build-system" +} diff --git a/build_system/tests/tests_bats/tests_crawler/test_nabo_crawl_dependencies_build_matrix.bats b/build_system/tests/tests_bats/tests_crawler/test_nabo_crawl_dependencies_build_matrix.bats new file mode 100644 index 0000000..b388f11 --- /dev/null +++ b/build_system/tests/tests_bats/tests_crawler/test_nabo_crawl_dependencies_build_matrix.bats @@ -0,0 +1,92 @@ +#!/usr/bin/env bats +# +# Usage in docker container +# $ REPO_ROOT=$(pwd) && RUN_TESTS_IN_DIR='tests' +# $ docker run -it --rm -v "$REPO_ROOT:/code" bats/bats:latest "$RUN_TESTS_IN_DIR" +# +# Note: "/code" is the working directory in the bats official image +# +# bats-core ref: +# - https://bats-core.readthedocs.io/en/stable/tutorial.html +# - https://bats-core.readthedocs.io/en/stable/writing-tests.html +# - https://opensource.com/article/19/2/testing-bash-bats +# ↳ /~https://github.com/dmlond/how_to_bats/blob/master/test/build.bats +# +# Helper library: +# - /~https://github.com/bats-core/bats-assert +# - /~https://github.com/bats-core/bats-support +# - /~https://github.com/bats-core/bats-file +# + +BATS_HELPER_PATH=/usr/lib/bats +if [[ -d ${BATS_HELPER_PATH} ]]; then + load "${BATS_HELPER_PATH}/bats-support/load" + load "${BATS_HELPER_PATH}/bats-assert/load" + load "${BATS_HELPER_PATH}/bats-file/load" + load "${SRC_CODE_PATH}/${N2ST_BATS_TESTING_TOOLS_RELATIVE_PATH}/bats_helper_functions" + load "${SRC_CODE_PATH}/build_system/tests/tests_bats/bats_helper_functions" + #load "${BATS_HELPER_PATH}/bats-detik/load" # << Kubernetes support +else + echo -e "\n[\033[1;31mERROR\033[0m] $0 path to bats-core helper library unreachable at \"${BATS_HELPER_PATH}\"!" 1>&2 + echo '(press any key to exit)' + read -r -n 1 + exit 1 +fi + +# ====Setup======================================================================================== + +TESTED_FILE="nabo_crawl_dependencies_build_matrix.bash" +TESTED_FILE_PATH="./build_system/" +COMPOSE_FILE="docker-compose.dependencies.yaml" +DOTENV_BUILD_MATRIX="${SRC_CODE_PATH}"/build_system/.env.build_matrix.dependencies +DOTENV_BUILD_MATRIX_NAME=$( basename "${DOTENV_BUILD_MATRIX}" ) + +# executed once before starting the first test (valide for all test in that file) +setup_file() { + BATS_DOCKER_WORKDIR=$(pwd) && export BATS_DOCKER_WORKDIR + + ## Uncomment the following for debug, the ">&3" is for printing bats msg to stdin +# pwd >&3 && tree -L 1 -a -hug >&3 +# printenv >&3 +} + +# executed before each test +setup() { + cd "$TESTED_FILE_PATH" || exit 1 +} + +# ====Teardown===================================================================================== + +# executed after each test +teardown() { + bats_print_run_env_variable_on_error +} + +## executed once after finishing the last test (valide for all test in that file) +#teardown_file() { +#} + +# ====Test casses================================================================================== + +@test "${TESTED_FILE} › docker image › execute ok › expect pass" { + + run bash "${TESTED_FILE}" "${DOTENV_BUILD_MATRIX}" --fail-fast -- build + assert_success + assert_output --regexp .*"Starting".*"${TESTED_FILE}".*"\[NBS\]".*"Build images specified in".*"'${COMPOSE_FILE}'".*"following".*"${DOTENV_BUILD_MATRIX_NAME}" + assert_output --regexp "Status of tag crawled:".*"Pass".*"› latest".*"Completed".*"${TESTED_FILE}".* +} + +# ....Test --help flag related logic............................................................... +@test "${TESTED_FILE} › --help as first argument › execute ok › expect pass" { + run bash "${TESTED_FILE}" --help + test_generic_help_flag_logic +} + +@test "${TESTED_FILE} › second arg: --help › execute ok › expect pass" { + run bash "${TESTED_FILE}" --fail-fast --help + test_generic_help_flag_logic +} + +# ToDo: implement >> test for IS_TEAMCITY_RUN==true casses +# (NICE TO HAVE) ToDo: implement >> test for python intsall casses with regard to distribution + diff --git a/build_system/tests/tests_bats/tests_crawler/test_nabo_crawl_libnabo_build_matrix.bats b/build_system/tests/tests_bats/tests_crawler/test_nabo_crawl_libnabo_build_matrix.bats new file mode 100644 index 0000000..e9e09b4 --- /dev/null +++ b/build_system/tests/tests_bats/tests_crawler/test_nabo_crawl_libnabo_build_matrix.bats @@ -0,0 +1,96 @@ +#!/usr/bin/env bats +# +# Usage in docker container +# $ REPO_ROOT=$(pwd) && RUN_TESTS_IN_DIR='tests' +# $ docker run -it --rm -v "$REPO_ROOT:/code" bats/bats:latest "$RUN_TESTS_IN_DIR" +# +# Note: "/code" is the working directory in the bats official image +# +# bats-core ref: +# - https://bats-core.readthedocs.io/en/stable/tutorial.html +# - https://bats-core.readthedocs.io/en/stable/writing-tests.html +# - https://opensource.com/article/19/2/testing-bash-bats +# ↳ /~https://github.com/dmlond/how_to_bats/blob/master/test/build.bats +# +# Helper library: +# - /~https://github.com/bats-core/bats-assert +# - /~https://github.com/bats-core/bats-support +# - /~https://github.com/bats-core/bats-file +# + +BATS_HELPER_PATH=/usr/lib/bats +if [[ -d ${BATS_HELPER_PATH} ]]; then + load "${BATS_HELPER_PATH}/bats-support/load" + load "${BATS_HELPER_PATH}/bats-assert/load" + load "${BATS_HELPER_PATH}/bats-file/load" + load "${SRC_CODE_PATH}/${N2ST_BATS_TESTING_TOOLS_RELATIVE_PATH}/bats_helper_functions" + load "${SRC_CODE_PATH}/build_system/tests/tests_bats/bats_helper_functions" + #load "${BATS_HELPER_PATH}/bats-detik/load" # << Kubernetes support +else + echo -e "\n[\033[1;31mERROR\033[0m] $0 path to bats-core helper library unreachable at \"${BATS_HELPER_PATH}\"!" 1>&2 + echo '(press any key to exit)' + read -r -n 1 + exit 1 +fi + +# ====Setup======================================================================================== + +TESTED_FILE="nabo_crawl_libnabo_build_matrix.bash" +TESTED_FILE_PATH="./build_system/" +COMPOSE_FILE="docker-compose.libnabo.yaml" +DOTENV_BUILD_MATRIX="${SRC_CODE_PATH}"/build_system/.env.build_matrix.libnabo +DOTENV_BUILD_MATRIX_NAME=$( basename "${DOTENV_BUILD_MATRIX}" ) + +# executed once before starting the first test (valide for all test in that file) +setup_file() { + BATS_DOCKER_WORKDIR=$(pwd) && export BATS_DOCKER_WORKDIR + + ## Uncomment the following for debug, the ">&3" is for printing bats msg to stdin +# pwd >&3 && tree -L 1 -a -hug >&3 +# printenv >&3 +} + +# executed before each test +setup() { + cd "$TESTED_FILE_PATH" || exit 1 +} + +# ====Teardown===================================================================================== + +# executed after each test +teardown() { + bats_print_run_env_variable_on_error +} + +## executed once after finishing the last test (valide for all test in that file) +#teardown_file() { +#} + +# ====Test casses================================================================================== + + +@test "${TESTED_FILE} › docker image › execute ok › expect pass" { + + run bash "${TESTED_FILE}" "${DOTENV_BUILD_MATRIX}" --fail-fast -- build + + assert_success + assert_output --regexp .*"Starting".*"${TESTED_FILE}".*"\[NBS\]".*"Build images specified in".*"'${COMPOSE_FILE}'".*"following".*"${DOTENV_BUILD_MATRIX_NAME}" + assert_output --regexp "Status of tag crawled:".*"Pass".*"› latest".*"Completed".*"${TESTED_FILE}".* +} + + +# ....Test --help flag related logic............................................................... + +@test "${TESTED_FILE} › --help as first argument › execute ok › expect pass" { + run bash "${TESTED_FILE}" --help + test_generic_help_flag_logic +} + +@test "${TESTED_FILE} › second arg: --help › execute ok › expect pass" { + run bash "${TESTED_FILE}" --fail-fast --help + test_generic_help_flag_logic +} + +# ToDo: implement >> test for IS_TEAMCITY_RUN==true casses +# (NICE TO HAVE) ToDo: implement >> test for python intsall casses with regard to distribution + diff --git a/build_system/tests/tests_bats/tests_crawler/test_nabo_crawl_libnabo_build_matrix.bleeding.bats b/build_system/tests/tests_bats/tests_crawler/test_nabo_crawl_libnabo_build_matrix.bleeding.bats new file mode 100644 index 0000000..d39ea67 --- /dev/null +++ b/build_system/tests/tests_bats/tests_crawler/test_nabo_crawl_libnabo_build_matrix.bleeding.bats @@ -0,0 +1,101 @@ +#!/usr/bin/env bats +# +# Usage in docker container +# $ REPO_ROOT=$(pwd) && RUN_TESTS_IN_DIR='tests' +# $ docker run -it --rm -v "$REPO_ROOT:/code" bats/bats:latest "$RUN_TESTS_IN_DIR" +# +# Note: "/code" is the working directory in the bats official image +# +# bats-core ref: +# - https://bats-core.readthedocs.io/en/stable/tutorial.html +# - https://bats-core.readthedocs.io/en/stable/writing-tests.html +# - https://opensource.com/article/19/2/testing-bash-bats +# ↳ /~https://github.com/dmlond/how_to_bats/blob/master/test/build.bats +# +# Helper library: +# - /~https://github.com/bats-core/bats-assert +# - /~https://github.com/bats-core/bats-support +# - /~https://github.com/bats-core/bats-file +# + +BATS_HELPER_PATH=/usr/lib/bats +if [[ -d ${BATS_HELPER_PATH} ]]; then + load "${BATS_HELPER_PATH}/bats-support/load" + load "${BATS_HELPER_PATH}/bats-assert/load" + load "${BATS_HELPER_PATH}/bats-file/load" + load "${SRC_CODE_PATH}/${N2ST_BATS_TESTING_TOOLS_RELATIVE_PATH}/bats_helper_functions" + load "${SRC_CODE_PATH}/build_system/tests/tests_bats/bats_helper_functions" + #load "${BATS_HELPER_PATH}/bats-detik/load" # << Kubernetes support +else + echo -e "\n[\033[1;31mERROR\033[0m] $0 path to bats-core helper library unreachable at \"${BATS_HELPER_PATH}\"!" 1>&2 + echo '(press any key to exit)' + read -r -n 1 + exit 1 +fi + +# ====Setup======================================================================================== + +TESTED_FILE="nabo_crawl_libnabo_build_matrix.bleeding.bash" +TESTED_FILE_PATH="./build_system/" +COMPOSE_FILE="docker-compose.libnabo.yaml" +DOTENV_BUILD_MATRIX="${SRC_CODE_PATH}"/build_system/.env.build_matrix.libnabo.bleeding +DOTENV_BUILD_MATRIX_NAME=$( basename "${DOTENV_BUILD_MATRIX}" ) + +# executed once before starting the first test (valide for all test in that file) +setup_file() { + BATS_DOCKER_WORKDIR=$(pwd) && export BATS_DOCKER_WORKDIR + + ## Uncomment the following for debug, the ">&3" is for printing bats msg to stdin +# pwd >&3 && tree -L 1 -a -hug >&3 +# printenv >&3 +} + +# executed before each test +setup() { + cd "$TESTED_FILE_PATH" || exit 1 +} + +# ====Teardown===================================================================================== + +# executed after each test +teardown() { + bats_print_run_env_variable_on_error +} + +## executed once after finishing the last test (valide for all test in that file) +#teardown_file() { +#} + +# ====Test casses================================================================================== + +@test "${TESTED_FILE} › docker image › execute ok › expect pass" { +# skip "tmp mute" # ToDo: on task end >> delete this line ← + + run bash "${TESTED_FILE}" "${DOTENV_BUILD_MATRIX}" --fail-fast -- build +# OPTIONS=( "${DOTENV_BUILD_MATRIX}" "--ubuntu-version-build-matrix-override jammy" "--fail-fast" "--" "config --quiet" ) +# run bash "${TESTED_FILE}" "${OPTIONS[@]}" + + assert_success + assert_output --regexp .*"Starting".*"${TESTED_FILE}".*"\[NBS\]".*"Build images specified in".*"'${COMPOSE_FILE}'".*"following".*"${DOTENV_BUILD_MATRIX_NAME}" + assert_output --regexp .*"\[NBS done\]".*"FINAL › Build matrix completed with command".*"\$".*"docker compose -f ${COMPOSE_FILE}" +# build --dry-run + assert_output --regexp "Status of tag crawled:".*"Pass".*"› latest".*"Completed".*"${TESTED_FILE}".* +} + +# ....Test --help flag related logic............................................................... + +@test "${TESTED_FILE} › --help as first argument › execute ok › expect pass" { +# skip "tmp dev" # ToDo: on task end >> delete this line ← + run bash "${TESTED_FILE}" --help + test_generic_help_flag_logic +} + +@test "${TESTED_FILE} › second arg: --help › execute ok › expect pass" { +# skip "tmp dev" # ToDo: on task end >> delete this line ← + + run bash "${TESTED_FILE}" --fail-fast --help + test_generic_help_flag_logic +} + +## ToDo: implement >> test for IS_TEAMCITY_RUN==true casses +## (NICE TO HAVE) ToDo: implement >> test for python intsall casses with regard to distribution diff --git a/build_system/tests/tests_bats/tests_crawler/test_nabo_crawl_libnabo_build_matrix.release.bats b/build_system/tests/tests_bats/tests_crawler/test_nabo_crawl_libnabo_build_matrix.release.bats new file mode 100644 index 0000000..e71b3e3 --- /dev/null +++ b/build_system/tests/tests_bats/tests_crawler/test_nabo_crawl_libnabo_build_matrix.release.bats @@ -0,0 +1,96 @@ +#!/usr/bin/env bats +# +# Usage in docker container +# $ REPO_ROOT=$(pwd) && RUN_TESTS_IN_DIR='tests' +# $ docker run -it --rm -v "$REPO_ROOT:/code" bats/bats:latest "$RUN_TESTS_IN_DIR" +# +# Note: "/code" is the working directory in the bats official image +# +# bats-core ref: +# - https://bats-core.readthedocs.io/en/stable/tutorial.html +# - https://bats-core.readthedocs.io/en/stable/writing-tests.html +# - https://opensource.com/article/19/2/testing-bash-bats +# ↳ /~https://github.com/dmlond/how_to_bats/blob/master/test/build.bats +# +# Helper library: +# - /~https://github.com/bats-core/bats-assert +# - /~https://github.com/bats-core/bats-support +# - /~https://github.com/bats-core/bats-file +# + +BATS_HELPER_PATH=/usr/lib/bats +if [[ -d ${BATS_HELPER_PATH} ]]; then + load "${BATS_HELPER_PATH}/bats-support/load" + load "${BATS_HELPER_PATH}/bats-assert/load" + load "${BATS_HELPER_PATH}/bats-file/load" + load "${SRC_CODE_PATH}/${N2ST_BATS_TESTING_TOOLS_RELATIVE_PATH}/bats_helper_functions" + load "${SRC_CODE_PATH}/build_system/tests/tests_bats/bats_helper_functions" + #load "${BATS_HELPER_PATH}/bats-detik/load" # << Kubernetes support +else + echo -e "\n[\033[1;31mERROR\033[0m] $0 path to bats-core helper library unreachable at \"${BATS_HELPER_PATH}\"!" 1>&2 + echo '(press any key to exit)' + read -r -n 1 + exit 1 +fi + +# ====Setup======================================================================================== + +TESTED_FILE="nabo_crawl_libnabo_build_matrix.release.bash" +TESTED_FILE_PATH="./build_system/" +COMPOSE_FILE="docker-compose.libnabo.yaml" +DOTENV_BUILD_MATRIX="${SRC_CODE_PATH}"/build_system/.env.build_matrix.libnabo.release +DOTENV_BUILD_MATRIX_NAME=$( basename "${DOTENV_BUILD_MATRIX}" ) + +# executed once before starting the first test (valide for all test in that file) +setup_file() { + BATS_DOCKER_WORKDIR=$(pwd) && export BATS_DOCKER_WORKDIR + + ## Uncomment the following for debug, the ">&3" is for printing bats msg to stdin +# pwd >&3 && tree -L 1 -a -hug >&3 +# printenv >&3 +} + +# executed before each test +setup() { + cd "$TESTED_FILE_PATH" || exit 1 +} + +# ====Teardown===================================================================================== + +# executed after each test +teardown() { + bats_print_run_env_variable_on_error +} + +## executed once after finishing the last test (valide for all test in that file) +#teardown_file() { +#} + +# ====Test casses================================================================================== + + +@test "${TESTED_FILE} › docker image › execute ok › expect pass" { + + run bash "${TESTED_FILE}" "${DOTENV_BUILD_MATRIX}" --fail-fast -- build --push --dry-run release + + assert_success + assert_output --regexp .*"Starting".*"${TESTED_FILE}".*"\[NBS\]".*"Build images specified in".*"'${COMPOSE_FILE}'".*"following".*"${DOTENV_BUILD_MATRIX_NAME}" + assert_output --regexp "Status of tag crawled:".*"Pass".*"› latest".*"Completed".*"${TESTED_FILE}".* +} + + +# ....Test --help flag related logic............................................................... + +@test "${TESTED_FILE} › --help as first argument › execute ok › expect pass" { + run bash "${TESTED_FILE}" --help + test_generic_help_flag_logic +} + +@test "${TESTED_FILE} › second arg: --help › execute ok › expect pass" { + run bash "${TESTED_FILE}" --fail-fast --help + test_generic_help_flag_logic +} + +# ToDo: implement >> test for IS_TEAMCITY_RUN==true casses +# (NICE TO HAVE) ToDo: implement >> test for python intsall casses with regard to distribution + diff --git a/build_system/tests/tests_bats/tests_installer/test_build_system_nabo_installer.bats b/build_system/tests/tests_bats/tests_installer/test_build_system_nabo_installer.bats new file mode 100644 index 0000000..f3574bc --- /dev/null +++ b/build_system/tests/tests_bats/tests_installer/test_build_system_nabo_installer.bats @@ -0,0 +1,149 @@ +#!/usr/bin/env bats +# +# Usage in docker container +# $ REPO_ROOT=$(pwd) && RUN_TESTS_IN_DIR='tests' +# $ docker run -it --rm -v "$REPO_ROOT:/code" bats/bats:latest "$RUN_TESTS_IN_DIR" +# +# Note: "/code" is the working directory in the bats official image +# +# bats-core ref: +# - https://bats-core.readthedocs.io/en/stable/tutorial.html +# - https://bats-core.readthedocs.io/en/stable/writing-tests.html +# - https://opensource.com/article/19/2/testing-bash-bats +# ↳ /~https://github.com/dmlond/how_to_bats/blob/master/test/build.bats +# +# Helper library: +# - /~https://github.com/bats-core/bats-assert +# - /~https://github.com/bats-core/bats-support +# - /~https://github.com/bats-core/bats-file +# + +BATS_HELPER_PATH=/usr/lib/bats +if [[ -d ${BATS_HELPER_PATH} ]]; then + load "${BATS_HELPER_PATH}/bats-support/load" + load "${BATS_HELPER_PATH}/bats-assert/load" + load "${BATS_HELPER_PATH}/bats-file/load" + load "${SRC_CODE_PATH}/${N2ST_BATS_TESTING_TOOLS_RELATIVE_PATH}/bats_helper_functions" + #load "${BATS_HELPER_PATH}/bats-detik/load" # << Kubernetes support +else + echo -e "\n[\033[1;31mERROR\033[0m] $0 path to bats-core helper library unreachable at \"${BATS_HELPER_PATH}\"!" 1>&2 + echo '(press any key to exit)' + read -r -n 1 + exit 1 +fi + +# ====Setup======================================================================================== +TESTED_FILE3="nabo_install_dependencies_ubuntu.bash" +TESTED_FILE4="nabo_install_libnabo_ubuntu.bash" +TESTED_FILE_PATH3="./build_system/ubuntu" + +# executed once before starting the first test (valide for all test in that file) +setup_file() { + BATS_DOCKER_WORKDIR=$(pwd) && export BATS_DOCKER_WORKDIR + + # Uncomment the following for debug, the ">&3" is for printing bats msg to stdin +# pwd >&3 && tree -L 1 -a -hug >&3 +# pwd >&3 && tree -L 2 -a ./build_system/utilities >&3 +# printenv >&3 +} + +# executed before each test +setup() { + echo "(Bats) Source project .env" + set -o allexport + source "${BATS_DOCKER_WORKDIR:?err}/build_system/.env" + set +o allexport + + cd "$TESTED_FILE_PATH" || exit 1 +} + +# ====Teardown===================================================================================== + +# executed after each test +teardown() { + echo "(Bats) Reset install directory" + rm -rf "${NBS_LIB_INSTALL_PATH}" + +# bats_print_run_env_variable_on_error +} + +## executed once after finishing the last test (valide for all test in that file) +#teardown_file() { +#} + +# ====Test casses================================================================================== +# ....Build system install script.................................................................. + +@test "Dependencies | run $TESTED_FILE3 › expect pass" { +# skip "tmp debug" # ToDo: on task end >> delete this line ← + cd "${BATS_DOCKER_WORKDIR}" + + run bash ./${TESTED_FILE_PATH3}/$TESTED_FILE3 --test-run + + assert_success + + assert_output --regexp .*"\[".*"NABO".*"\]".*"Install Libnabo dependencies".*"Boost" + assert_output --regexp .*"\[".*"NABO".*"\]".*"Install Libnabo dependencies".*"Eigen" + + assert_output --regexp .*"\[".*"NABO done".*"\]".*"Libnabo dependencies installed" +} + +@test "Libnabo | run $TESTED_FILE4 (default) › expect pass" { +# skip "tmp debug" # ToDo: on task end >> delete this line ← + cd "${BATS_DOCKER_WORKDIR}" + + run bash "./${TESTED_FILE_PATH3}/$TESTED_FILE4" --test-run + + assert_success + + assert_output --regexp .*"\[".*"NABO".*"\]".*"Install libnabo" + + assert_output --regexp .*"\[".*"NABO".*"\]".*"Execute".*"cmake -D CMAKE_BUILD_TYPE=RelWithDebInfo -D LIBNABO_BUILD_TESTS=OFF -D LIBNABO_BUILD_DOXYGEN=OFF /opt/percep3d_libraries/libnabo" + refute_output --regexp .*"\[".*"NABO".*"\]".*"Execute".*"cmake -D CMAKE_BUILD_TYPE=RelWithDebInfo -D LIBNABO_BUILD_TESTS=OFF -D LIBNABO_BUILD_DOXYGEN=OFF -D CMAKE_INSTALL_PREFIX=/opt/percep3d_libraries /opt/percep3d_libraries/libnabo" + + assert_output --regexp .*"\[".*"NABO done".*"\]".*"libnabo installed successfully at".* +} + +@test "Libnabo | run $TESTED_FILE4 (default) (read APPEND_TO_CMAKE_FLAG ok) › expect pass" { +# skip "tmp debug" # ToDo: on task end >> delete this line ← + cd "${BATS_DOCKER_WORKDIR}" + + export APPEND_TO_CMAKE_FLAG=( -D CMAKE_INSTALL_PREFIX=/opt/test_dir ) + run source "./${TESTED_FILE_PATH3}/$TESTED_FILE4" --test-run + + assert_success + + assert_output --regexp .*"\[".*"NABO".*"\]".*"Install libnabo" + + assert_output --regexp .*"\[".*"NABO".*"\]".*"Execute".*"cmake -D CMAKE_BUILD_TYPE=RelWithDebInfo -D LIBNABO_BUILD_TESTS=OFF -D LIBNABO_BUILD_DOXYGEN=OFF -D CMAKE_INSTALL_PREFIX=/opt/test_dir /opt/percep3d_libraries/libnabo" + refute_output --regexp .*"\[".*"NABO".*"\]".*"Execute".*"cmake -D CMAKE_BUILD_TYPE=RelWithDebInfo -D LIBNABO_BUILD_TESTS=OFF -D LIBNABO_BUILD_DOXYGEN=OFF /opt/percep3d_libraries/libnabo" + + assert_output --regexp .*"\[".*"NABO done".*"\]".*"libnabo installed successfully at".* +} + + +@test "Libnabo | run $TESTED_FILE4 (argument check) › expect pass" { +# skip "tmp debug" # ToDo: on task end >> delete this line ← + cd "${BATS_DOCKER_WORKDIR}" + + run bash "./${TESTED_FILE_PATH3}/$TESTED_FILE4" --test-run \ + --install-path /opt/test_dir \ + --repository-version 1.0.7 \ + --compile-test \ + --generate-doc \ + --cmake-build-type Release + + assert_success + assert_output --regexp .*"\[".*"NABO".*"\]".*"Install libnabo" + + assert_output --partial "switching to 'tags/1.0.7'." + + assert_output --regexp .*"\[".*"NABO".*"\]".*"Repository checkout at tag 1.0.7" + + assert_output --regexp .*"\[".*"NABO".*"\]".*"Execute".*"cmake -D CMAKE_BUILD_TYPE=Release -D LIBNABO_BUILD_TESTS=ON -D LIBNABO_BUILD_DOXYGEN=ON /opt/test_dir/libnabo" + refute_output --regexp .*"\[".*"NABO".*"\]".*"Execute".*"cmake -D CMAKE_BUILD_TYPE=RelWithDebInfo -D LIBNABO_BUILD_TESTS=OFF -D LIBNABO_BUILD_DOXYGEN=OFF /opt/percep3d_libraries/libnabo" + + + assert_output --regexp .*"\[".*"NABO done".*"\]".*"libnabo installed successfully at".* + +} diff --git a/build_system/tests/tests_bats/tests_installer/test_nabo_install_docker_tools_and_buildx_create_script.bats b/build_system/tests/tests_bats/tests_installer/test_nabo_install_docker_tools_and_buildx_create_script.bats new file mode 100644 index 0000000..7ca9dcc --- /dev/null +++ b/build_system/tests/tests_bats/tests_installer/test_nabo_install_docker_tools_and_buildx_create_script.bats @@ -0,0 +1,83 @@ +#!/usr/bin/env bats +# +# Usage in docker container +# $ REPO_ROOT=$(pwd) && RUN_TESTS_IN_DIR='tests' +# $ docker run -it --rm -v "$REPO_ROOT:/code" bats/bats:latest "$RUN_TESTS_IN_DIR" +# +# Note: "/code" is the working directory in the bats official image +# +# bats-core ref: +# - https://bats-core.readthedocs.io/en/stable/tutorial.html +# - https://bats-core.readthedocs.io/en/stable/writing-tests.html +# - https://opensource.com/article/19/2/testing-bash-bats +# ↳ /~https://github.com/dmlond/how_to_bats/blob/master/test/build.bats +# +# Helper library: +# - /~https://github.com/bats-core/bats-assert +# - /~https://github.com/bats-core/bats-support +# - /~https://github.com/bats-core/bats-file +# + +BATS_HELPER_PATH=/usr/lib/bats +if [[ -d ${BATS_HELPER_PATH} ]]; then + load "${BATS_HELPER_PATH}/bats-support/load" + load "${BATS_HELPER_PATH}/bats-assert/load" + load "${BATS_HELPER_PATH}/bats-file/load" + load "${SRC_CODE_PATH}/${N2ST_BATS_TESTING_TOOLS_RELATIVE_PATH}/bats_helper_functions" + #load "${BATS_HELPER_PATH}/bats-detik/load" # << Kubernetes support +else + echo -e "\n[\033[1;31mERROR\033[0m] $0 path to bats-core helper library unreachable at \"${BATS_HELPER_PATH}\"!" 1>&2 + echo '(press any key to exit)' + read -r -n 1 + exit 1 +fi + +# ====Setup======================================================================================== +TESTED_FILE="nabo_install_docker_tools.bash" +TESTED_FILE2="nabo_create_multiarch_docker_builder.bash" +TESTED_FILE_PATH="./build_system/nabo_utility_script" + +# executed once before starting the first test (valide for all test in that file) +setup_file() { + BATS_DOCKER_WORKDIR=$(pwd) && export BATS_DOCKER_WORKDIR + + ## Uncomment the following for debug, the ">&3" is for printing bats msg to stdin +# pwd >&3 && tree -L 1 -a -hug >&3 +# printenv >&3 +} + +# executed before each test +setup() { + cd "$TESTED_FILE_PATH" || exit 1 +} + +# ====Teardown===================================================================================== + +# executed after each test +teardown() { + bats_print_run_env_variable_on_error +} + +## executed once after finishing the last test (valide for all test in that file) +#teardown_file() { +#} + +# ====Test casses================================================================================== + +@test "run $TESTED_FILE from root › expect pass" { + cd "${BATS_DOCKER_WORKDIR}" + + run bash "./${TESTED_FILE_PATH}/$TESTED_FILE" + assert_success + run docker --version + assert_output --regexp "Docker version".*"build".* +} + +@test "run $TESTED_FILE2 (mock 'docker buildx create' step) › expect pass" { + cd "${BATS_DOCKER_WORKDIR}" + + mock_docker_command_exit_ok + + run source "./${TESTED_FILE_PATH}/$TESTED_FILE2" + assert_success +} diff --git a/build_system/tests/tests_bats/tests_installer/test_user_nabo_installer.bats b/build_system/tests/tests_bats/tests_installer/test_user_nabo_installer.bats new file mode 100644 index 0000000..0fbd6dd --- /dev/null +++ b/build_system/tests/tests_bats/tests_installer/test_user_nabo_installer.bats @@ -0,0 +1,134 @@ +#!/usr/bin/env bats +# +# Usage in docker container +# $ REPO_ROOT=$(pwd) && RUN_TESTS_IN_DIR='tests' +# $ docker run -it --rm -v "$REPO_ROOT:/code" bats/bats:latest "$RUN_TESTS_IN_DIR" +# +# Note: "/code" is the working directory in the bats official image +# +# bats-core ref: +# - https://bats-core.readthedocs.io/en/stable/tutorial.html +# - https://bats-core.readthedocs.io/en/stable/writing-tests.html +# - https://opensource.com/article/19/2/testing-bash-bats +# ↳ /~https://github.com/dmlond/how_to_bats/blob/master/test/build.bats +# +# Helper library: +# - /~https://github.com/bats-core/bats-assert +# - /~https://github.com/bats-core/bats-support +# - /~https://github.com/bats-core/bats-file +# + +BATS_HELPER_PATH=/usr/lib/bats +if [[ -d ${BATS_HELPER_PATH} ]]; then + load "${BATS_HELPER_PATH}/bats-support/load" + load "${BATS_HELPER_PATH}/bats-assert/load" + load "${BATS_HELPER_PATH}/bats-file/load" + load "${SRC_CODE_PATH}/${N2ST_BATS_TESTING_TOOLS_RELATIVE_PATH}/bats_helper_functions" + #load "${BATS_HELPER_PATH}/bats-detik/load" # << Kubernetes support +else + echo -e "\n[\033[1;31mERROR\033[0m] $0 path to bats-core helper library unreachable at \"${BATS_HELPER_PATH}\"!" 1>&2 + echo '(press any key to exit)' + read -r -n 1 + exit 1 +fi + +# ====Setup======================================================================================== +TESTED_FILE="libnabo_dependencies_installer.bash" +TESTED_FILE2="libnabo_installer.bash" +TESTED_FILE_PATH="." + +# executed once before starting the first test (valide for all test in that file) +setup_file() { + BATS_DOCKER_WORKDIR=$(pwd) && export BATS_DOCKER_WORKDIR + + ## Uncomment the following for debug, the ">&3" is for printing bats msg to stdin +# pwd >&3 && tree -L 1 -a -hug >&3 +# printenv >&3 +} + +# executed before each test +setup() { + echo "(Bats) Source project .env" + set -o allexport + source "${BATS_DOCKER_WORKDIR:?err}/build_system/.env" + set +o allexport + + cd "$TESTED_FILE_PATH" || exit 1 +} + +# ====Teardown===================================================================================== + +# executed after each test +teardown() { + echo "(Bats) Reset install directory" + rm -rf "${NBS_LIB_INSTALL_PATH}" + +# bats_print_run_env_variable_on_error +} + +## executed once after finishing the last test (valide for all test in that file) +#teardown_file() { +#} + +# ====Test casses================================================================================== + + +# ----User install script-------------------------------------------------------------------------- +# ....Test installer › pre-condition failure....................................................... +@test "Dependencies | source $TESTED_FILE › expect fail" { + cd "${BATS_DOCKER_WORKDIR}" + + run source "./${TESTED_FILE_PATH}/$TESTED_FILE" + assert_failure 1 + assert_output --regexp .*"\[".*"NABO ERROR".*"\]".*"Execute this script in a subshell".*"bash ${TESTED_FILE}" +} + +# bats test_tags=tag:1 +@test "Libnabo | source $TESTED_FILE2 › expect fail" { + cd "${BATS_DOCKER_WORKDIR}" + + run source "./${TESTED_FILE_PATH}/$TESTED_FILE" + assert_failure 1 + assert_output --regexp .*"\[".*"NABO ERROR".*"\]".*"Execute this script in a subshell".*"bash ${TESTED_FILE}" +} + +# ....Test installer › normal case................................................................. +@test "Dependencies | run $TESTED_FILE from root › expect pass" { + cd "${BATS_DOCKER_WORKDIR}" + + run bash "./${TESTED_FILE_PATH}/$TESTED_FILE" --test-run + + assert_success + + ## General dependencies + assert_output --regexp .*"\[".*"NABO".*"\]".*"Install development utilities" + assert_output --regexp .*"\[".*"NABO".*"\]".*"The install script is executed in stand alone mode" + assert_output --regexp .*"\[".*"NBS".*"\]".*"Starting nbs::install_python_dev_tools" + assert_output --regexp .*"\[".*"NBS".*"\]".*"Install python development tools for Ubuntu distro".* + assert_output --regexp .*"\[".*"NABO".*"\]".*"Install Libnabo dependencies › Boost" + assert_output --regexp .*"\[".*"NABO".*"\]".*"Install Libnabo dependencies › Eigen" +# assert_output --regexp .*"\[".*"NABO".*"\]".*"Install Libnabo dev tools" + + assert_output --regexp .*"\[".*"NABO done".*"\]".*"Libnabo dependencies installed" + + ## Documentation dependencies + assert_output --regexp .*"\[".*"NABO".*"\]".*"Install libnabo documentation related dependencies" + assert_output --regexp .*"\[".*"NABO done".*"\]".*"Libnabo documentation related dependencies installed" + + assert_output --regexp .*"\[".*"NABO done".*"\]".*"All Libnabo dependencies installed" +} + +@test "Libnabo | run $TESTED_FILE2 from root › expect pass" { + cd "${BATS_DOCKER_WORKDIR}" + + run bash "./${TESTED_FILE_PATH}/$TESTED_FILE2" --generate-doc --cmake-build-type Release --test-run + + assert_success + assert_output --regexp .*"\[".*"NABO".*"\]".*"Install libnabo" + + assert_output --regexp .*"\[".*"NABO".*"\]".*"Execute".*"cmake -D CMAKE_BUILD_TYPE=Release -D LIBNABO_BUILD_TESTS=OFF -D LIBNABO_BUILD_DOXYGEN=ON /opt/percep3d_libraries/libnabo" + refute_output --regexp .*"\[".*"NABO".*"\]".*"Execute".*"cmake -D CMAKE_BUILD_TYPE=Release -D LIBNABO_BUILD_TESTS=OFF -D LIBNABO_BUILD_DOXYGEN=ON -D CMAKE_INSTALL_PREFIX=/opt/percep3d_libraries /opt/percep3d_libraries/libnabo" + + assert_output --regexp .*"\[".*"NABO done".*"\]".*"libnabo installed successfully at".* + assert_output --regexp .*"\[".*"NABO done".*"\]".*"Libnabo install script completed. Have fun" +} diff --git a/build_system/tests/tests_docker_dryrun_and_config/dryrun_nabo_crawl_dependencies_build_matrix.bash b/build_system/tests/tests_docker_dryrun_and_config/dryrun_nabo_crawl_dependencies_build_matrix.bash new file mode 100644 index 0000000..97b9852 --- /dev/null +++ b/build_system/tests/tests_docker_dryrun_and_config/dryrun_nabo_crawl_dependencies_build_matrix.bash @@ -0,0 +1,14 @@ +#!/bin/bash + +# ....path resolution logic........................................................................ +_PATH_TO_SCRIPT="$(realpath "${BASH_SOURCE[0]}")" +NABO_ROOT_DIR="$(dirname "${_PATH_TO_SCRIPT}")" +cd "${NABO_ROOT_DIR}/../../" + +# ====begin======================================================================================== +#FLAGS=( '--fail-fast' '--' 'build' '--dry-run' ) +#bash nabo_crawl_dependencies_build_matrix.bash ${FLAGS[@]} + +#bash nabo_crawl_dependencies_build_matrix.bash --fail-fast -- build --dry-run dependencies dependencies-doc + +bash nabo_crawl_dependencies_build_matrix.bash --fail-fast -- build --dry-run diff --git a/build_system/tests/tests_docker_dryrun_and_config/dryrun_nabo_crawl_libnabo_build_matrix.bash b/build_system/tests/tests_docker_dryrun_and_config/dryrun_nabo_crawl_libnabo_build_matrix.bash new file mode 100644 index 0000000..415a227 --- /dev/null +++ b/build_system/tests/tests_docker_dryrun_and_config/dryrun_nabo_crawl_libnabo_build_matrix.bash @@ -0,0 +1,10 @@ +#!/bin/bash + +# ....path resolution logic........................................................................ +_PATH_TO_SCRIPT="$(realpath "${BASH_SOURCE[0]}")" +NABO_ROOT_DIR="$(dirname "${_PATH_TO_SCRIPT}")" +cd "${NABO_ROOT_DIR}/../../" + +# ====begin======================================================================================== +#bash nabo_crawl_libnabo_build_matrix.bash --fail-fast -- build --dry-run ci_PR_amd64 ci_PR_arm64v8 +bash nabo_crawl_libnabo_build_matrix.bash --fail-fast -- build --dry-run diff --git a/build_system/tests/tests_docker_dryrun_and_config/dryrun_nabo_crawl_libnabo_build_matrix.bleeding.bash b/build_system/tests/tests_docker_dryrun_and_config/dryrun_nabo_crawl_libnabo_build_matrix.bleeding.bash new file mode 100644 index 0000000..97901dd --- /dev/null +++ b/build_system/tests/tests_docker_dryrun_and_config/dryrun_nabo_crawl_libnabo_build_matrix.bleeding.bash @@ -0,0 +1,10 @@ +#!/bin/bash + +# ....path resolution logic........................................................................ +_PATH_TO_SCRIPT="$(realpath "${BASH_SOURCE[0]}")" +NABO_ROOT_DIR="$(dirname "${_PATH_TO_SCRIPT}")" +cd "${NABO_ROOT_DIR}/../../" + +# ====begin======================================================================================== +#bash nabo_crawl_libnabo_build_matrix.bleeding.bash --fail-fast -- build --dry-run ci_PR_amd64 ci_PR_arm64v8 +bash nabo_crawl_libnabo_build_matrix.bleeding.bash --fail-fast -- build --dry-run diff --git a/build_system/tests/tests_docker_dryrun_and_config/test_configuration_nabo_crawl_dependencies_build_matrix.bash b/build_system/tests/tests_docker_dryrun_and_config/test_configuration_nabo_crawl_dependencies_build_matrix.bash new file mode 100644 index 0000000..b655b22 --- /dev/null +++ b/build_system/tests/tests_docker_dryrun_and_config/test_configuration_nabo_crawl_dependencies_build_matrix.bash @@ -0,0 +1,9 @@ +#!/bin/bash + +# ....path resolution logic........................................................................ +_PATH_TO_SCRIPT="$(realpath "${BASH_SOURCE[0]}")" +NABO_ROOT_DIR="$(dirname "${_PATH_TO_SCRIPT}")" +cd "${NABO_ROOT_DIR}/../../" + +# ====begin======================================================================================== +bash nabo_crawl_dependencies_build_matrix.bash --fail-fast -- config --quiet diff --git a/build_system/tests/tests_docker_dryrun_and_config/test_configuration_nabo_crawl_libnabo_build_matrix.bash b/build_system/tests/tests_docker_dryrun_and_config/test_configuration_nabo_crawl_libnabo_build_matrix.bash new file mode 100644 index 0000000..2fdef7b --- /dev/null +++ b/build_system/tests/tests_docker_dryrun_and_config/test_configuration_nabo_crawl_libnabo_build_matrix.bash @@ -0,0 +1,9 @@ +#!/bin/bash + +# ....path resolution logic........................................................................ +_PATH_TO_SCRIPT="$(realpath "${BASH_SOURCE[0]}")" +NABO_ROOT_DIR="$(dirname "${_PATH_TO_SCRIPT}")" +cd "${NABO_ROOT_DIR}/../../" + +# ====begin======================================================================================== +bash nabo_crawl_libnabo_build_matrix.bash --fail-fast -- config --quiet diff --git a/build_system/tests/tests_docker_dryrun_and_config/test_configuration_nabo_crawl_libnabo_build_matrix.bleeding.bash b/build_system/tests/tests_docker_dryrun_and_config/test_configuration_nabo_crawl_libnabo_build_matrix.bleeding.bash new file mode 100644 index 0000000..b4ce470 --- /dev/null +++ b/build_system/tests/tests_docker_dryrun_and_config/test_configuration_nabo_crawl_libnabo_build_matrix.bleeding.bash @@ -0,0 +1,9 @@ +#!/bin/bash + +# ....path resolution logic........................................................................ +_PATH_TO_SCRIPT="$(realpath "${BASH_SOURCE[0]}")" +NABO_ROOT_DIR="$(dirname "${_PATH_TO_SCRIPT}")" +cd "${NABO_ROOT_DIR}/../../" + +# ====begin======================================================================================== +bash nabo_crawl_libnabo_build_matrix.bleeding.bash --fail-fast -- config --quiet diff --git a/build_system/tests/tests_docker_interactive/Dockerfile.build_system_test b/build_system/tests/tests_docker_interactive/Dockerfile.build_system_test new file mode 100644 index 0000000..485acbc --- /dev/null +++ b/build_system/tests/tests_docker_interactive/Dockerfile.build_system_test @@ -0,0 +1,90 @@ +ARG BASE_IMAGE=ubuntu +ARG BASE_IMAGE_TAG=focal +FROM ${BASE_IMAGE}:${BASE_IMAGE_TAG} AS base-image + +LABEL org.opencontainers.image.authors="luc.coupal.1@ulaval.ca" + +SHELL ["/bin/bash", "-e", "-c"] +ARG DEBIAN_FRONTEND=noninteractive +WORKDIR / + +# ....Setup timezone and localization.............................................................. +# change the locale from POSIX to UTF-8 +RUN apt-get update && \ + apt-get install --assume-yes --no-install-recommends \ + locales && \ + rm -rf /var/lib/apt/lists/* + +RUN locale-gen en_US en_US.UTF-8 && update-locale LC_ALL=en_US.UTF-8 LANG=en_US.UTF-8 +ENV LANG=en_US.UTF-8 +ENV PYTHONIOENCODING=utf-8 + +# ====Begin install================================================================================ + +# ....Install development utilities................................................................ +RUN apt-get update \ + && apt-get install --assume-yes --no-install-recommends \ + sudo \ + gnupg2 \ + lsb-release \ + cmake \ + build-essential \ + curl \ + wget \ + ca-certificates \ + git \ + vim \ + tree \ + less \ + apt-utils \ + zip gzip tar unzip \ + fontconfig \ + software-properties-common \ + bash-completion \ + && rm -rf /var/lib/apt/lists/* + + +# ....Install docker tools......................................................................... + +# Required for norlab-build-system path resolution logic +WORKDIR /libnabo +COPY ./.git ./.git + +# Copy all files from the checkout branch in the repository (except those in the .dockerignore) +WORKDIR /libnabo/build_system + +COPY ./build_system/utilities/norlab-build-system ./utilities/norlab-build-system +COPY ./build_system/utilities/norlab-shell-script-tools ./utilities/norlab-shell-script-tools + +COPY ./build_system/.env ./.env +#COPY ./build_system/.env.prompt ./.env.prompt +COPY ./build_system/nabo_utility_script/nabo_install_docker_tools.bash ./nabo_utility_script/nabo_install_docker_tools.bash +#COPY ./build_system/function_library/prompt_utilities.bash ./function_library/prompt_utilities.bash + +RUN chmod +x ./nabo_utility_script/nabo_install_docker_tools.bash +RUN source ./nabo_utility_script/nabo_install_docker_tools.bash + + +# ....Copy and prep libnabo repository main files.................................................. +WORKDIR /libnabo + +COPY .. /libnabo/ + +# Note: Build context must be at repository root +RUN /bin/bash -c " \ +if [[ ! -f LICENSE ]]; then \ + echo -e \"\nBuild context must be at repository root.\nProject root not reached! Current workdir: $(pwd).\nAborting build now!\n\"; \ + exit 1; \ +fi" + + +RUN chmod +x --recursive /libnabo/ + +# ====End========================================================================================== +WORKDIR ./build_system + +## Trick to validate the output of the file created with COPY <] +# +set -e +#set -v +#set -x + +DOCKER_CMD_ARGS=${*} + +clear + +TMP_CWD=$(pwd) + +# ....Helper function.............................................................................. +if [[ "$(basename $(pwd))" == "tests" ]]; then + cd ../ +fi + +# ....path resolution logic........................................................................ +_PATH_TO_SCRIPT="$(realpath "${BASH_SOURCE[0]}")" +NABO_ROOT_DIR="$(dirname "${_PATH_TO_SCRIPT}")/../../.." +cd "${NABO_ROOT_DIR}" + +set -o allexport && source ./build_system/.env && set +o allexport + +# ....Helper function.............................................................................................. +# import shell functions from utilities library +source "./build_system/utilities/norlab-shell-script-tools/import_norlab_shell_script_tools_lib.bash" + +# ====Begin======================================================================================== +print_formated_script_header 'build_and_run_IamBuildSystemTester.bash' "${MSG_LINE_CHAR_TEST}" + +# ....Build image.................................................................................. +echo +print_msg "Building 'nabo.ubuntu20.buildsystem.test'" +# Note: Build context must be at repository root + +pwd +tree -L 1 -a + +show_and_execute_docker "build -f build_system/tests/tests_docker_interactive/Dockerfile.build_system_test -t nabo.ubuntu20.buildsystem.test ." +#--no-cache + +# ....Run container................................................................................ +print_msg "Starting 'IamBuildSystemTester'" + +if [[ -n ${DOCKER_CMD_ARGS} ]]; then + print_msg "Passing command ${MSG_DIMMED_FORMAT}\"${DOCKER_CMD_ARGS}\"${MSG_END_FORMAT} to docker run" +fi + +show_and_execute_docker "run --name IamBuildSystemTester -it --rm nabo.ubuntu20.buildsystem.test ${DOCKER_CMD_ARGS}" + +print_formated_script_footer 'build_and_run_IamBuildSystemTester.bash' "${MSG_LINE_CHAR_TEST}" +# ====Teardown===================================================================================== +cd "${TMP_CWD}" diff --git a/build_system/tests/tests_docker_interactive/entrypoint.bash b/build_system/tests/tests_docker_interactive/entrypoint.bash new file mode 100644 index 0000000..6504199 --- /dev/null +++ b/build_system/tests/tests_docker_interactive/entrypoint.bash @@ -0,0 +1,8 @@ +#!/bin/bash + +pwd +tree -L 3 + +# ====Continue===================================================================================== +exec "${@}" + diff --git a/build_system/tests/tests_docker_interactive/test_execute_compose_over_build_matrix.bash b/build_system/tests/tests_docker_interactive/test_execute_compose_over_build_matrix.bash new file mode 100644 index 0000000..3217090 --- /dev/null +++ b/build_system/tests/tests_docker_interactive/test_execute_compose_over_build_matrix.bash @@ -0,0 +1,17 @@ +#!/bin/bash + +clear + +# ....path resolution logic........................................................................ +_PATH_TO_SCRIPT="$(realpath "${BASH_SOURCE[0]}")" +NABO_ROOT_DIR="$(dirname "${_PATH_TO_SCRIPT}")" +cd "${NABO_ROOT_DIR}/../../.." + +pwd + +# ====begin======================================================================================== +bash build_system/tests/tests_docker_interactive/build_and_run_IamBuildSystemTester.bash "bash ./nabo_crawl_libnabo_build_matrix.bash \ + --repository-version-build-matrix-override latest \ + --cmake-build-type-build-matrix-override None \ + --docker-debug-logs \ + -- build --dry-run" diff --git a/build_system/tests/tests_docker_interactive/test_execute_compose_over_build_matrix_with_flag.bash b/build_system/tests/tests_docker_interactive/test_execute_compose_over_build_matrix_with_flag.bash new file mode 100644 index 0000000..9aa9830 --- /dev/null +++ b/build_system/tests/tests_docker_interactive/test_execute_compose_over_build_matrix_with_flag.bash @@ -0,0 +1,17 @@ +#!/bin/bash + +clear + +# ....path resolution logic........................................................................ +_PATH_TO_SCRIPT="$(realpath "${BASH_SOURCE[0]}")" +NABO_ROOT_DIR="$(dirname "${_PATH_TO_SCRIPT}")" +cd "${NABO_ROOT_DIR}/../../.." + +# ====begin======================================================================================== +bash build_system/tests/tests_docker_interactive/build_and_run_IamBuildSystemTester.bash "bash ./nabo_crawl_libnabo_build_matrix.bash \ + --repository-version-build-matrix-override PR1 \ + --cmake-build-type-build-matrix-override RelWithDebInfo \ + --os-name-build-matrix-override osx \ + --osx-version-build-matrix-override ventura \ + --ubuntu-version-build-matrix-override jammy \ + -- build --dry-run dependencies" diff --git a/build_system/ubuntu/Dockerfile.dependencies b/build_system/ubuntu/Dockerfile.dependencies new file mode 100644 index 0000000..a531c5e --- /dev/null +++ b/build_system/ubuntu/Dockerfile.dependencies @@ -0,0 +1,97 @@ +ARG BASE_IMAGE=ubuntu +ARG BASE_IMAGE_TAG=focal +FROM ${BASE_IMAGE}:${BASE_IMAGE_TAG} AS base-image + +LABEL org.opencontainers.image.authors="luc.coupal.1@ulaval.ca" + +ARG NBS_LIB_INSTALL_PATH +ARG NBS_REPOSITORY_NAME +ENV NBS_LIB_INSTALL_PATH=${NBS_LIB_INSTALL_PATH:?'Build argument needs to be set and non-empty.'} +ENV NBS_REPOSITORY_NAME=${NBS_REPOSITORY_NAME:?'Build argument needs to be set and non-empty.'} + +ENV NBS_PATH=${NBS_LIB_INSTALL_PATH}/norlab-build-system +ENV N2ST_PATH=${NBS_LIB_INSTALL_PATH}/norlab-shell-script-tools + +ARG NBS_SUPERPROJECT_BUILD_SYSTEM_DIR +ENV NBS_SUPERPROJECT_BUILD_SYSTEM_DIR=${NBS_SUPERPROJECT_BUILD_SYSTEM_DIR:-"${NBS_SUPERPROJECT_BUILD_SYSTEM_DIR}"} + +ARG IS_TEAMCITY_RUN +ENV IS_TEAMCITY_RUN=${IS_TEAMCITY_RUN:-false} + +SHELL ["/bin/bash", "-c"] +ARG DEBIAN_FRONTEND=noninteractive +ENV DEBIAN_FRONTEND=${DEBIAN_FRONTEND} +ENV TZ=Etc/UTC + +ENV TERM=${TERM:-"xterm-256color"} + +# ....Setup timezone and localization.............................................................. +# change the locale from POSIX to UTF-8 +RUN apt-get update && \ + apt-get install --assume-yes --no-install-recommends \ + locales \ + tzdata && \ + rm -rf /var/lib/apt/lists/* + +RUN locale-gen en_US en_US.UTF-8 && update-locale LC_ALL=en_US.UTF-8 LANG=en_US.UTF-8 +ENV LANG=en_US.UTF-8 +ENV PYTHONIOENCODING=utf-8 + + +# ====Begin install================================================================================ + +# ....Install development utilities................................................................ +RUN apt-get update && \ + apt-get install --assume-yes --no-install-recommends \ + sudo \ + bash-completion \ + git \ + vim \ + tree \ + curl \ + wget \ + gnupg2 \ + zip gzip tar unzip \ + net-tools \ + ca-certificates \ + apt-utils && \ + rm -rf /var/lib/apt/lists/* + +# ....Install norlab-build-system library.......................................................... +WORKDIR "${NBS_LIB_INSTALL_PATH}" +RUN git clone --recurse-submodules /~https://github.com/norlab-ulaval/norlab-build-system.git +RUN git clone --recurse-submodules /~https://github.com/norlab-ulaval/norlab-shell-script-tools.git + +# ====Begin======================================================================================== + +# Required for norlab-build-system path resolution logic +WORKDIR "${NBS_LIB_INSTALL_PATH}/${NBS_REPOSITORY_NAME}" +COPY ./.git ./.git + +WORKDIR "${NBS_LIB_INSTALL_PATH}/${NBS_REPOSITORY_NAME}/${NBS_SUPERPROJECT_BUILD_SYSTEM_DIR}" + + +COPY ./${NBS_SUPERPROJECT_BUILD_SYSTEM_DIR}/.env . + +WORKDIR "${NBS_PATH}/src/utility_scripts/" +RUN chmod +x ./nbs_install_python_dev_tools.bash +RUN bash nbs_install_python_dev_tools.bash + + +# ====Install Libnabo dependencies================================================================= +FROM base-image AS libnabo-dependencies + +WORKDIR "${NBS_LIB_INSTALL_PATH}/${NBS_REPOSITORY_NAME}/${NBS_SUPERPROJECT_BUILD_SYSTEM_DIR}" + +COPY ./${NBS_SUPERPROJECT_BUILD_SYSTEM_DIR}/ubuntu/nabo_install_dependencies_ubuntu.bash ./ubuntu/ + +WORKDIR ./ubuntu +RUN chmod +x ./nabo_install_dependencies_ubuntu.bash +RUN bash ./nabo_install_dependencies_ubuntu.bash + +# ====End========================================================================================== +FROM libnabo-dependencies AS final +WORKDIR "${NBS_LIB_INSTALL_PATH}/" +RUN rm -r -f "./${NBS_REPOSITORY_NAME}" + +CMD [ "bash" ] diff --git a/build_system/ubuntu/Dockerfile.dependencies.doxygen b/build_system/ubuntu/Dockerfile.dependencies.doxygen new file mode 100644 index 0000000..56f2325 --- /dev/null +++ b/build_system/ubuntu/Dockerfile.dependencies.doxygen @@ -0,0 +1,36 @@ +ARG PROJECT_HUB=norlabulaval +ARG BASE_IMAGE=libnabo-dependencies +ARG BASE_IMAGE_TAG +FROM ${PROJECT_HUB}/${BASE_IMAGE}:${BASE_IMAGE_TAG:?err} AS libnabo-dependencies-full + +LABEL org.opencontainers.image.authors="luc.coupal.1@ulaval.ca" + +ARG IS_TEAMCITY_RUN +ENV IS_TEAMCITY_RUN=${IS_TEAMCITY_RUN:-false} + +SHELL ["/bin/bash", "-c"] +ARG DEBIAN_FRONTEND=noninteractive + +# Required for norlab-build-system path resolution logic +WORKDIR "${NBS_LIB_INSTALL_PATH}/${NBS_REPOSITORY_NAME}" +COPY ./.git ./.git + +WORKDIR "${NBS_LIB_INSTALL_PATH}/${NBS_REPOSITORY_NAME}/build_system" + +COPY ./build_system/.env . + +COPY ./build_system/ubuntu/nabo_install_doc_dependencies_ubuntu.bash ./ubuntu/ + +# ====Install Libnabo documentation related dependencies=========================================== +WORKDIR ./ubuntu + +RUN chmod +x nabo_install_doc_dependencies_ubuntu.bash + +RUN bash nabo_install_doc_dependencies_ubuntu.bash + +# ====End========================================================================================== +WORKDIR "${NBS_LIB_INSTALL_PATH}/" +RUN rm -r -f "./${NBS_REPOSITORY_NAME}" + +FROM libnabo-dependencies-full AS final +CMD [ "bash" ] diff --git a/build_system/ubuntu/Dockerfile.libnabo.ci_PR b/build_system/ubuntu/Dockerfile.libnabo.ci_PR new file mode 100644 index 0000000..4c44b55 --- /dev/null +++ b/build_system/ubuntu/Dockerfile.libnabo.ci_PR @@ -0,0 +1,56 @@ +ARG PROJECT_HUB=norlabulaval +ARG BASE_IMAGE=libnabo-dependencies +ARG BASE_IMAGE_TAG +FROM ${PROJECT_HUB}/${BASE_IMAGE}:${BASE_IMAGE_TAG:?err} AS libnabo-dependencies + +LABEL org.opencontainers.image.authors="luc.coupal.1@ulaval.ca" + +ARG REPOSITORY_VERSION='latest' +ENV REPOSITORY_VERSION=${REPOSITORY_VERSION} +LABEL libnabo.version="${REPOSITORY_VERSION}" + +ARG NBS_LIB_INSTALL_PATH +ARG NBS_REPOSITORY_NAME +ENV NBS_LIB_INSTALL_PATH=${NBS_LIB_INSTALL_PATH:?'Build argument needs to be set and non-empty.'} +ENV NBS_REPOSITORY_NAME=${NBS_REPOSITORY_NAME:?'Build argument needs to be set and non-empty.'} + +ARG CMAKE_BUILD_TYPE=RelWithDebInfo +ARG INSTALL_SCRIPT_FLAG='--build-system-CI-install --compile-test' +ENV CMAKE_BUILD_TYPE=${CMAKE_BUILD_TYPE} +ENV INSTALL_SCRIPT_FLAG=${INSTALL_SCRIPT_FLAG} + +ARG IS_TEAMCITY_RUN +ENV IS_TEAMCITY_RUN=${IS_TEAMCITY_RUN:-false} + +SHELL ["/bin/bash", "-c"] +ARG DEBIAN_FRONTEND=noninteractive + +# ToDo: validate +ENV TERM=${TERM:-"xterm-256color"} + +# ====Checkout libnabo repository================================================================== +WORKDIR "${NBS_LIB_INSTALL_PATH}/${NBS_REPOSITORY_NAME}" + +# Copy all files from the checkout branch in the repository (except those in the .dockerignore) +COPY . . + + +# ==== Build libnabo checkout branch ============================================================== +WORKDIR ./build_system/ubuntu + +RUN chmod +x nabo_install_libnabo_ubuntu.bash +RUN chmod +x nabo_execute_nabo_unittest.bash +RUN chmod +x entrypoint.bash + + +RUN bash nabo_install_libnabo_ubuntu.bash \ + --repository-version ${REPOSITORY_VERSION} \ + --cmake-build-type ${CMAKE_BUILD_TYPE} \ + ${INSTALL_SCRIPT_FLAG} + +# ==== Execute libnabo unit-test=================================================================== +RUN source nabo_execute_nabo_unittest.bash + +# ====End========================================================================================== +ENTRYPOINT [ "./entrypoint.bash" ] +CMD [ "bash" ] diff --git a/build_system/ubuntu/Dockerfile.libnabo.hub_release b/build_system/ubuntu/Dockerfile.libnabo.hub_release new file mode 100644 index 0000000..40cfaba --- /dev/null +++ b/build_system/ubuntu/Dockerfile.libnabo.hub_release @@ -0,0 +1,63 @@ +ARG PROJECT_HUB=norlabulaval +ARG BASE_IMAGE=libnabo-dependencies-doc +ARG BASE_IMAGE_TAG +FROM ${PROJECT_HUB}/${BASE_IMAGE}:${BASE_IMAGE_TAG:?err} AS libnabo-install + +LABEL org.opencontainers.image.authors="luc.coupal.1@ulaval.ca" + +ARG REPOSITORY_VERSION +ENV REPOSITORY_VERSION=${REPOSITORY_VERSION:?'Build argument needs to be set and non-empty.'} +LABEL libnabo.version="${REPOSITORY_VERSION}" + + +ARG NBS_LIB_INSTALL_PATH +ARG NBS_REPOSITORY_NAME +ENV NBS_LIB_INSTALL_PATH=${NBS_LIB_INSTALL_PATH:?'Build argument needs to be set and non-empty.'} +ENV NBS_REPOSITORY_NAME=${NBS_REPOSITORY_NAME:?'Build argument needs to be set and non-empty.'} + +ARG CMAKE_BUILD_TYPE=Release +ARG INSTALL_SCRIPT_FLAG="" +ENV CMAKE_BUILD_TYPE=${CMAKE_BUILD_TYPE} +ENV INSTALL_SCRIPT_FLAG=${INSTALL_SCRIPT_FLAG} + +ARG IS_TEAMCITY_RUN +ENV IS_TEAMCITY_RUN=${IS_TEAMCITY_RUN:-false} + +SHELL ["/bin/bash", "-c"] +ARG DEBIAN_FRONTEND=noninteractive + +# ====Build system related setup=================================================================== +WORKDIR "${NBS_LIB_INSTALL_PATH}/release-prep/" + +# Copy only the build system file for running the install and test scripts +# Note: Logic to copy files from the checkout branch is handle by 'nabo_install_libnabo_ubuntu.bash' script +COPY ./build_system/ ./build_system/ +COPY ./.git/ ./.git/ + +# ==== Build libnabo checkout branch ============================================================== +WORKDIR ./build_system/ubuntu + +RUN chmod +x nabo_install_libnabo_ubuntu.bash + +# Note: Make sure to install in "${NBS_LIB_INSTALL_PATH}//" as the "release-prep/" +# directory is deleted at the end of this install step +RUN bash nabo_install_libnabo_ubuntu.bash \ + --install-path ${NBS_LIB_INSTALL_PATH} \ + --repository-version ${REPOSITORY_VERSION} \ + --cmake-build-type ${CMAKE_BUILD_TYPE} \ + ${INSTALL_SCRIPT_FLAG} + +RUN rm -rf "${NBS_LIB_INSTALL_PATH}/release-prep/" + +# ====End========================================================================================== +FROM libnabo-install AS libnabo-release +WORKDIR "${NBS_LIB_INSTALL_PATH}/${NBS_REPOSITORY_NAME}" + +COPY ./build_system/ubuntu/entrypoint.bash ./build_system/ubuntu/entrypoint.bash +COPY ./build_system/.env ./build_system/.env + +RUN chmod +x ./build_system/ubuntu/entrypoint.bash +RUN chmod +x ./build_system/.env + +ENTRYPOINT [ "./build_system/ubuntu/entrypoint.bash" ] +CMD [ "bash" ] diff --git a/build_system/ubuntu/Dockerfile.libnabo.integration_test b/build_system/ubuntu/Dockerfile.libnabo.integration_test new file mode 100644 index 0000000..b80d783 --- /dev/null +++ b/build_system/ubuntu/Dockerfile.libnabo.integration_test @@ -0,0 +1,107 @@ +ARG PROJECT_HUB=norlabulaval +ARG BASE_IMAGE=libnabo-dependencies +ARG BASE_IMAGE_TAG +FROM ${PROJECT_HUB}/${BASE_IMAGE}:${BASE_IMAGE_TAG:?err} AS libnabo-dependencies + +LABEL org.opencontainers.image.authors="luc.coupal.1@ulaval.ca" + +ARG REPOSITORY_VERSION='latest' +ENV REPOSITORY_VERSION=${REPOSITORY_VERSION} +LABEL libnabo.version="${REPOSITORY_VERSION}" + +ARG NBS_LIB_INSTALL_PATH +ARG NBS_REPOSITORY_NAME +ENV NBS_LIB_INSTALL_PATH=${NBS_LIB_INSTALL_PATH:?'Build argument needs to be set and non-empty.'} +ENV NBS_REPOSITORY_NAME=${NBS_REPOSITORY_NAME:?'Build argument needs to be set and non-empty.'} + +ARG CMAKE_BUILD_TYPE=RelWithDebInfo +ARG INSTALL_SCRIPT_FLAG='--build-system-CI-install' +ENV CMAKE_BUILD_TYPE=${CMAKE_BUILD_TYPE} +ENV INSTALL_SCRIPT_FLAG=${INSTALL_SCRIPT_FLAG} + +ARG IS_TEAMCITY_RUN +ENV IS_TEAMCITY_RUN=${IS_TEAMCITY_RUN:-false} + +SHELL ["/bin/bash", "-c"] +ARG DEBIAN_FRONTEND=noninteractive + +# ToDo: validate +ENV TERM=${TERM:-"xterm-256color"} + +# ====Checkout libnabo repository================================================================== +WORKDIR "${NBS_LIB_INSTALL_PATH}/${NBS_REPOSITORY_NAME}" + +# Copy all files from the checkout branch in the repository (except those in the .dockerignore) +COPY . . + +WORKDIR ./build_system/ubuntu + +RUN chmod +x nabo_install_libnabo_ubuntu.bash +RUN chmod +x nabo_execute_nabo_unittest.bash +RUN chmod +x entrypoint.bash + +# ....Install libpointmatcher missing dependecnies................................................. +RUN apt-get update && \ + apt-get install --assume-yes "${APT_FLAGS[@]}" \ + libyaml-cpp-dev && \ + rm -rf /var/lib/apt/lists/* + +# ====Test compilation with automatic path resolution============================================== +FROM libnabo-dependencies AS integration-test-compile-auto-path-resolution + +#RUN echo && echo ">> nproc=$(nproc)" && echo # ToDo: on task end >> mute this line + +# .... Build libnabo checkout branch .............................................................. +WORKDIR "${NBS_LIB_INSTALL_PATH}/${NBS_REPOSITORY_NAME}/build_system/ubuntu" + +RUN source nabo_install_libnabo_ubuntu.bash \ + --repository-version ${REPOSITORY_VERSION} \ + --cmake-build-type ${CMAKE_BUILD_TYPE} \ + ${INSTALL_SCRIPT_FLAG} + +# .... Compile package dependent on libnabo ....................................................... +WORKDIR "${NBS_LIB_INSTALL_PATH}" +RUN git clone /~https://github.com/norlab-ulaval/libpointmatcher.git \ + && mkdir -p libpointmatcher/build && cd libpointmatcher/build \ + && cmake -DCMAKE_BUILD_TYPE=Release .. \ + && make -j $(nproc) \ + && make install + +ENTRYPOINT [ "./entrypoint.bash" ] +CMD [ "bash" ] + +# ====Test compilation with explicit path resolution=============================================== + +# (Priority) ToDo: implement >> test casse with 'SHARED_LIBS' cmake flag + +FROM libnabo-dependencies AS integration-test-compile-prefixed-path + +#RUN echo && echo ">> nproc=$(nproc)" && echo # ToDo: on task end >> mute this line + +# .... Build libnabo checkout branch .............................................................. +WORKDIR "${NBS_LIB_INSTALL_PATH}/${NBS_REPOSITORY_NAME}/build_system/ubuntu" + +RUN export APPEND_TO_CMAKE_FLAG=( "-D CMAKE_INSTALL_PREFIX=${NBS_LIB_INSTALL_PATH:?err}" ) \ + && source nabo_install_libnabo_ubuntu.bash \ + --repository-version ${REPOSITORY_VERSION} \ + --cmake-build-type ${CMAKE_BUILD_TYPE} \ + ${INSTALL_SCRIPT_FLAG} + + +# .... Compile package dependent on libnabo ....................................................... +WORKDIR "${NBS_LIB_INSTALL_PATH}" +RUN git clone /~https://github.com/norlab-ulaval/libpointmatcher.git \ + && mkdir -p libpointmatcher/build && cd libpointmatcher/build \ + && cmake -DCMAKE_BUILD_TYPE=Release .. \ + && make -j $(nproc) \ + && make install + +ENTRYPOINT [ "./entrypoint.bash" ] +CMD [ "bash" ] + +# ................................................................................................. +## Alternate version +#RUN chmod +x entrypoint_build_and_test_libnabo_checkout_branch.bash +#RUN chmod +x entrypoint_build_libnabo_checkout_branch.bash +#RUN source entrypoint_build_and_test_libnabo_checkout_branch.bash +#RUN source entrypoint_build_libnabo_checkout_branch.bash diff --git a/build_system/ubuntu/entrypoint.bash b/build_system/ubuntu/entrypoint.bash new file mode 100644 index 0000000..460ba3c --- /dev/null +++ b/build_system/ubuntu/entrypoint.bash @@ -0,0 +1,29 @@ +#!/bin/bash +# +# Docker entrypoint for development task +# +# Usage: +# $ bash entrypoint.bash [] +# +# Parameter +# Optional command executed in a subprocess at the end of the entrypoint script. +# + +# ....Load environment variables from file......................................................... +set -o allexport +source "${NBS_LIB_INSTALL_PATH}/${NBS_REPOSITORY_NAME}/build_system/.env" +set +o allexport + +# ....Helper function.............................................................................. +source "${N2ST_PATH:?err}/import_norlab_shell_script_tools_lib.bash" + +# ====Begin======================================================================================== +clear + +norlab_splash "${NBS_SPLASH_NAME:?err}" "/~https://github.com/${NBS_REPOSITORY_DOMAIN:?err}/${NBS_REPOSITORY_NAME:?err}" + +#ifconfig +pwd && tree -L 1 + +# ====Continue===================================================================================================== +exec "$@" diff --git a/build_system/ubuntu/nabo_execute_nabo_unittest.bash b/build_system/ubuntu/nabo_execute_nabo_unittest.bash new file mode 100644 index 0000000..c55ca90 --- /dev/null +++ b/build_system/ubuntu/nabo_execute_nabo_unittest.bash @@ -0,0 +1,74 @@ +#!/bin/bash +# ================================================================================================= +# +# Run Libnabo unit test +# +# Usage: +# $ bash nabo_execute_nabo_unittest.bash +# +# Notes: +# The script propagate the utest exit code on exit +# ================================================================================================= + +# ....Project root logic........................................................................... +TMP_CWD=$(pwd) + +NABO_PATH=$(git rev-parse --show-toplevel) +cd "${NABO_PATH}/build_system" || exit 1 + +# ....Load environment variables from file......................................................... +set -o allexport +source .env +set +o allexport + +# ....Helper function.............................................................................. +# import shell functions from utilities library +N2ST_PATH=${N2ST_PATH:-"${NABO_PATH}/build_system/utilities/norlab-shell-script-tools"} +source "${N2ST_PATH}/import_norlab_shell_script_tools_lib.bash" + +# ====Begin======================================================================================== +print_formated_script_header 'nabo_execute_nabo_unittest.bash' ':' + +cd "${NBS_LIB_INSTALL_PATH}/${NBS_REPOSITORY_NAME}/build" + +if [[ ${IS_TEAMCITY_RUN} == true ]] || [[ ${TEAMCITY_VERSION} ]]; then + echo -e "##teamcity[testSuiteStarted name='gtest']" + echo -e "##teamcity[testStarted name='gtest' captureStandardOutput='true']" +else + print_msg "Starting Libnabo GoogleTest unit-test" +fi + +# ................................................................................................. +sudo chmod +x test +make test +NABO_TEST_EXIT_CODE=$? +# ................................................................................................. + +SUCCESS_MSG="Libnabo GoogleTest unit-test completed successfully" +FAILURE_MSG="Libnabo GoogleTest unit-test completed with error" + +if [[ ${IS_TEAMCITY_RUN} == true ]] || [[ ${TEAMCITY_VERSION} ]]; then + echo -e "##teamcity[testFinished name='gtest']" + + # Report message to build log + if [[ ${NABO_TEST_EXIT_CODE} == 0 ]]; then + echo -e "##teamcity[message text='${MSG_BASE_TEAMCITY} ${SUCCESS_MSG}' status='NORMAL']" + else + echo -e "##teamcity[message text='${MSG_BASE_TEAMCITY} ${FAILURE_MSG}' errorDetails='$NABO_TEST_EXIT_CODE' status='ERROR']" 1>&2 + fi + + echo -e "##teamcity[testSuiteFinished name='gtest']" +else + + if [[ ${NABO_TEST_EXIT_CODE} == 0 ]]; then + print_msg_done "${SUCCESS_MSG}" + else + print_msg_error "${FAILURE_MSG}" + fi + +fi + +print_formated_script_footer 'nabo_execute_nabo_unittest.bash' ':' +# ====Teardown===================================================================================== +cd "${TMP_CWD}" +exit $NABO_TEST_EXIT_CODE diff --git a/build_system/ubuntu/nabo_install_dependencies_ubuntu.bash b/build_system/ubuntu/nabo_install_dependencies_ubuntu.bash new file mode 100644 index 0000000..c4491fb --- /dev/null +++ b/build_system/ubuntu/nabo_install_dependencies_ubuntu.bash @@ -0,0 +1,126 @@ +#!/bin/bash -i +# ================================================================================================= +# +# Libnabo dependencies installer +# +# Usage: +# $ source nabo_install_dependencies_ubuntu.bash [--test-run] +# +# ================================================================================================= +set -e # Note: we want the installer to always fail-fast (it wont affect the build system policy) + +declare -a APT_FLAGS + +# skip GUI dialog by setting everything to default +export DEBIAN_FRONTEND=noninteractive + +# ....Project root logic........................................................................... +TMP_CWD=$(pwd) + +NABO_PATH=$(git rev-parse --show-toplevel) +cd "${NABO_PATH}/build_system" || cd "${NABO_PATH}" || exit 1 + +NBS_PATH=${NBS_PATH:-"${NABO_PATH}/build_system/utilities/norlab-build-system"} +N2ST_PATH=${N2ST_PATH:-"${NABO_PATH}/build_system/utilities/norlab-shell-script-tools"} + +# ....Load environment variables from file......................................................... +set -o allexport +source .env +set +o allexport + +# ....Helper function.............................................................................. +# import shell functions from utilities library +source "${N2ST_PATH}/import_norlab_shell_script_tools_lib.bash" + +# Set environment variable IMAGE_ARCH_AND_OS +cd "${N2ST_PATH}"/src/utility_scripts/ && source "which_architecture_and_os.bash" + +# ====Begin======================================================================================== +SHOW_SPLASH_IDU="${SHOW_SPLASH_IDU:-true}" + +if [[ "${SHOW_SPLASH_IDU}" == 'true' ]]; then + norlab_splash "${NBS_SPLASH_NAME}" "/~https://github.com/${NBS_REPOSITORY_DOMAIN:?err}/${NBS_REPOSITORY_NAME:?err}" +fi + +print_formated_script_header "nabo_install_dependencies_ubuntu.bash (${IMAGE_ARCH_AND_OS:?err})" "${MSG_LINE_CHAR_INSTALLER}" + +# ....Script command line flags.................................................................... +while [ $# -gt 0 ]; do + + case $1 in + --test-run) + APT_FLAGS=( --dry-run ) + shift + ;; + --?* | -?*) + echo "$0: $1: unrecognized option" >&2 # Note: '>&2' = print to stderr + shift + ;; + *) # Default case + break + ;; + esac + +done + + +# ................................................................................................. +teamcity_service_msg_blockOpened "Install development utilities" + +sudo apt-get update && + sudo apt-get install --assume-yes \ + lsb-release \ + build-essential \ + ca-certificates \ + curl \ + wget \ + git \ + && sudo apt-get install --assume-yes "${APT_FLAGS[@]}" \ + g++ \ + gcc \ + catch \ + make \ + cmake \ + cmake-gui && + sudo rm -rf /var/lib/apt/lists/* + +##cmake --version + +teamcity_service_msg_blockClosed +# ................................................................................................. + +# (Priority) ToDo: add check to see if executed in a docker container. Current check does not do what its intended +if [[ ${IS_TEAMCITY_RUN} == true ]]; then + print_msg "The install script is run in teamCity >> the python install step was executed earlier in the Dockerfile.dependencies" +else + print_msg "The install script is executed in stand alone mode" + cd "${NBS_PATH:?err}/src/utility_scripts" || exit 1 + bash "./nbs_install_python_dev_tools.bash" +fi + +# ................................................................................................. +teamcity_service_msg_blockOpened "Install Libnabo dependencies › Boost" +# https://www.boost.org/doc/libs/1_79_0/more/getting_started/unix-variants.html + +sudo apt-get update && + sudo apt-get install --assume-yes "${APT_FLAGS[@]}" \ + libboost-all-dev && + sudo rm -rf /var/lib/apt/lists/* + +teamcity_service_msg_blockClosed +# ................................................................................................. +teamcity_service_msg_blockOpened "Install Libnabo dependencies › Eigen" +# https://eigen.tuxfamily.org/index.php + +sudo apt-get update && + sudo apt-get install --assume-yes "${APT_FLAGS[@]}" \ + libeigen3-dev && + sudo rm -rf /var/lib/apt/lists/* + +teamcity_service_msg_blockClosed +## ................................................................................................. + +echo " " && print_msg_done "Libnabo dependencies installed" +print_formated_script_footer "nabo_install_dependencies_ubuntu.bash (${IMAGE_ARCH_AND_OS})" "${MSG_LINE_CHAR_INSTALLER}" +# ====Teardown===================================================================================== +cd "${TMP_CWD}" diff --git a/build_system/ubuntu/nabo_install_doc_dependencies_ubuntu.bash b/build_system/ubuntu/nabo_install_doc_dependencies_ubuntu.bash new file mode 100644 index 0000000..a085dde --- /dev/null +++ b/build_system/ubuntu/nabo_install_doc_dependencies_ubuntu.bash @@ -0,0 +1,83 @@ +#!/bin/bash -i +# ================================================================================================= +# +# Libnabo documentation dependencies installer +# +# Usage: +# $ bash nabo_install_doc_dependencies_ubuntu.bash [--test-run] +# +# ================================================================================================= +set -e # Note: we want the installer to always fail-fast (it wont affect the build system policy) + +declare -a APT_FLAGS + +## skip GUI dialog by setting everything to default +export DEBIAN_FRONTEND=noninteractive + +# ....Project root logic........................................................................... +TMP_CWD=$(pwd) + +NABO_PATH=$(git rev-parse --show-toplevel) +cd "${NABO_PATH}/build_system" || exit 1 + + +# ....Load environment variables from file......................................................... +set -o allexport +source .env +set +o allexport + +# ....Helper function.............................................................................. +# import shell functions from utilities library +N2ST_PATH=${N2ST_PATH:-"${NABO_PATH}/build_system/utilities/norlab-shell-script-tools"} +source "${N2ST_PATH}/import_norlab_shell_script_tools_lib.bash" + +# Set environment variable IMAGE_ARCH_AND_OS +cd "${N2ST_PATH}"/src/utility_scripts/ && source "which_architecture_and_os.bash" + +# ====Begin======================================================================================== +SHOW_SPLASH_IDDU="${SHOW_SPLASH_IDDU:-true}" + +if [[ "${SHOW_SPLASH_IDDU}" == 'true' ]]; then + norlab_splash "${NBS_SPLASH_NAME:?err}" "/~https://github.com/${NBS_REPOSITORY_DOMAIN:?err}/${NBS_REPOSITORY_NAME:?err}" +fi + +print_formated_script_header "nabo_install_doc_dependencies_ubuntu.bash (${IMAGE_ARCH_AND_OS:?err})" "${MSG_LINE_CHAR_INSTALLER}" + +# ....Script command line flags.................................................................... +while [ $# -gt 0 ]; do + + case $1 in + --test-run) + APT_FLAGS=( --dry-run ) + shift + ;; + --?* | -?*) + echo "$0: $1: unrecognized option" >&2 # Note: '>&2' = print to stderr + shift + ;; + *) # Default case + break + ;; + esac + +done + + +# ................................................................................................. +teamcity_service_msg_blockOpened "Install libnabo documentation related dependencies" + +## Package required when LIBNABO_BUILD_DOXYGEN flag is set to true +## Note: 'texlive-full' is ~6GB. 'doxygen-latex' is a slim version tailor made for doxygen code documentation task +sudo apt-get update \ + && sudo apt-get install --assume-yes "${APT_FLAGS[@]}" \ + doxygen \ + doxygen-latex \ + && sudo rm -rf /var/lib/apt/lists/* + +teamcity_service_msg_blockClosed + +echo " " && print_msg_done "Libnabo documentation related dependencies installed" +print_formated_script_footer "nabo_install_doc_dependencies_ubuntu.bash (${IMAGE_ARCH_AND_OS})" "${MSG_LINE_CHAR_INSTALLER}" +# ====Teardown===================================================================================== +cd "${TMP_CWD}" + diff --git a/build_system/ubuntu/nabo_install_libnabo_ubuntu.bash b/build_system/ubuntu/nabo_install_libnabo_ubuntu.bash new file mode 100644 index 0000000..1777186 --- /dev/null +++ b/build_system/ubuntu/nabo_install_libnabo_ubuntu.bash @@ -0,0 +1,280 @@ +#!/bin/bash -i +# ================================================================================================= +# +# Install libnabo +# +# Usage: +# $ bash nabo_install_libnabo_ubuntu.bash [] +# +# Arguments: +# --install-path The directory where to install libnabo (absolute path) +# (default location defined in the .env) +# --repository-version 1.0.7 Install libnabo release tag version (default to master branch latest) +# --compile-test Compile the libnabo unit-test +# --generate-doc Generate the libnabo doxygen documentation +# in /usr/local/share/doc/libnabo/api/html/index.html +# --cmake-build-type RelWithDebInfo The type of cmake build: None Debug Release RelWithDebInfo MinSizeRel +# (default to RelWithDebInfo) +# --build-system-CI-install Set special configuration for CI/CD build system: +# skip the git clone install step and assume the repository is already +# pulled and checkout on the desired branch +# --test-run CI/CD build system Test-run mode +# -h, --help Get help +# +# Global +# - Read the array APPEND_TO_CMAKE_FLAG +# +# Usage: +# $ export APPEND_TO_CMAKE_FLAG=( -D CMAKE_INSTALL_PREFIX=/opt ) \ +# && source nabo_install_libnabo_ubuntu.bash +# +# Note: +# - this script required package: g++, make, cmake, build-essential, git and all libnabo dependencies +# - execute `nabo_install_dependencies_ubuntu.bash` first +# +# ================================================================================================= +set -e # Note: we want the installer to always fail-fast (it wont affect the build system policy) + +declare -a CMAKE_FLAGS + +CALLER_NAME="$(basename "$0" )" + +# ....Default...................................................................................... +REPOSITORY_VERSION='latest' +BUILD_TESTS_FLAG=OFF +LIBNABO_BUILD_DOXYGEN_FLAG=OFF +BUILD_SYSTEM_CI_INSTALL=FALSE +CMAKE_BUILD_TYPE=RelWithDebInfo + +# skip GUI dialog by setting everything to default +export DEBIAN_FRONTEND=noninteractive + +# ....Project root logic........................................................................... +TMP_CWD=$(pwd) + +NABO_PATH=$(git rev-parse --show-toplevel) +cd "${NABO_PATH}/build_system" || exit + +# ....Load environment variables from file......................................................... +set -o allexport +source .env +set +o allexport + +# ....Helper function.............................................................................. +# import shell functions from utilities library +N2ST_PATH=${N2ST_PATH:-"${NABO_PATH}/build_system/utilities/norlab-shell-script-tools"} +source "${N2ST_PATH}/import_norlab_shell_script_tools_lib.bash" + +# Set environment variable IMAGE_ARCH_AND_OS +cd "${N2ST_PATH}"/src/utility_scripts/ && source "which_architecture_and_os.bash" + +function print_help_in_terminal() { + echo -e "\$ ${0} [] + + \033[1m:\033[0m + --install-path The directory where to install (absolute path) + (default location ${MSG_DIMMED_FORMAT}${NBS_LIB_INSTALL_PATH:?err}${MSG_END_FORMAT}) + --repository-version 1.0.7 Install release tag version (default to master branch latest) + --compile-test Compile the unit-test + in ${MSG_DIMMED_FORMAT}${NBS_LIB_INSTALL_PATH}/${NBS_REPOSITORY_NAME:?err}/build${MSG_END_FORMAT} + --generate-doc Generate the libnabo doxygen documentation + in ${MSG_DIMMED_FORMAT}/usr/local/share/doc/${NBS_REPOSITORY_NAME}/api/html/index.html${MSG_END_FORMAT} + --cmake-build-type RelWithDebInfo The type of cmake build: None Debug Release RelWithDebInfo MinSizeRel + --build-system-CI-install Set special configuration for CI/CD build system: + skip the git clone install step and assume the repository is already + pulled and checkout on the desired branch + --test-run CI/CD build system Test-run mode + -h, --help Get help + + Global + - Read the array APPEND_TO_CMAKE_FLAG + + Usage: + $ export APPEND_TO_CMAKE_FLAG=( -D CMAKE_INSTALL_PREFIX=/opt ) && source nabo_install_libnabo_ubuntu.bash + + " +} + +# ====Begin======================================================================================== +SHOW_SPLASH_ILU="${SHOW_SPLASH_ILU:-true}" + +if [[ "${SHOW_SPLASH_ILU}" == 'true' ]]; then + norlab_splash "${NBS_SPLASH_NAME:?err}" "/~https://github.com/${NBS_REPOSITORY_DOMAIN:?err}/${NBS_REPOSITORY_NAME:?err}" +fi + +print_formated_script_header "${CALLER_NAME} (${IMAGE_ARCH_AND_OS:?err})" "${MSG_LINE_CHAR_INSTALLER}" + + +# ....Script command line flags.................................................................... +while [ $# -gt 0 ]; do + + case $1 in + --install-path) + unset NBS_LIB_INSTALL_PATH + NBS_LIB_INSTALL_PATH="${2}" + shift # Remove argument (--install-path) + shift # Remove argument value + ;; + --repository-version) + REPOSITORY_VERSION="${2}" + shift # Remove argument (--repository-version) + shift # Remove argument value + ;; + --cmake-build-type) + CMAKE_BUILD_TYPE="${2}" + shift # Remove argument (--cmake-build-type) + shift # Remove argument value + ;; + --compile-test) + BUILD_TESTS_FLAG=ON + shift + ;; + --generate-doc) + LIBNABO_BUILD_DOXYGEN_FLAG=ON + shift + ;; + --build-system-CI-install) + BUILD_SYSTEM_CI_INSTALL=TRUE + shift + ;; + --test-run) + TEST_RUN=true + shift + ;; + -h | --help) + print_help_in_terminal + exit + ;; + --) # no more option + shift + break + ;; + --?* | -?*) + echo "$0: $1: unrecognized option" >&2 # Note: '>&2' = print to stderr + shift + ;; + *) # Default case + break + ;; + esac + +done + + +# ....Cmake flags.................................................................................. +CMAKE_FLAGS=( -D CMAKE_BUILD_TYPE="${CMAKE_BUILD_TYPE}" -D LIBNABO_BUILD_TESTS="${BUILD_TESTS_FLAG}" -D LIBNABO_BUILD_DOXYGEN="${LIBNABO_BUILD_DOXYGEN_FLAG}" "${APPEND_TO_CMAKE_FLAG[@]}" ) + +# (CRITICAL) ToDo: validate >> LIBNABO_BUILD_DOXYGEN install dir + +# Note: +# - Previously use intall flag quick-hack to work around the install issue. +# - Keep it here as futur reference +# -D LIBNABO_INSTALL_DIR="${NBS_LIB_INSTALL_PATH}/libnabo" \ + +# ----Install steps-------------------------------------------------------------------------------- +teamcity_service_msg_blockOpened "Install ${NBS_REPOSITORY_NAME}" + +mkdir -p "${NBS_LIB_INSTALL_PATH}" +print_msg "Directories (pre libnabo install)$(tree -L 2 "${NBS_LIB_INSTALL_PATH}")" +cd "${NBS_LIB_INSTALL_PATH}" + +# ....Repository cloning step...................................................................... +if [[ ${BUILD_SYSTEM_CI_INSTALL} == FALSE ]]; then + + if [[ -d ${NBS_REPOSITORY_NAME}/.git ]]; then + print_msg_error_and_exit "${MSG_DIMMED_FORMAT}${NBS_REPOSITORY_NAME}${MSG_END_FORMAT} source code was already checkout in the specified install directory ${MSG_DIMMED_FORMAT}${NBS_LIB_INSTALL_PATH}/${MSG_END_FORMAT}, specify an other one using ${MSG_DIMMED_FORMAT}--install-path ${MSG_END_FORMAT}." + fi + + git clone /~https://github.com/"${NBS_REPOSITORY_DOMAIN}"/"${NBS_REPOSITORY_NAME}".git + + if [[ "${REPOSITORY_VERSION}" != 'latest' ]]; then + cd "${NBS_REPOSITORY_NAME}" + + git fetch --tags + git tag --list + + # Remove prefix 'v' from version tag +# GITHUB_TAG="${REPOSITORY_VERSION/v/}" + GITHUB_TAG="${REPOSITORY_VERSION}" + + git checkout tags/"${GITHUB_TAG}" + + print_msg "Repository checkout at tag $(git symbolic-ref -q --short HEAD || git describe --tags --exact-match)" + fi +fi + +cd "${NBS_LIB_INSTALL_PATH}/${NBS_REPOSITORY_NAME}" +mkdir -p build && cd build + +# ....Cmake install step........................................................................... +teamcity_service_msg_compilationStarted "cmake" + +print_msg "Execute ${MSG_DIMMED_FORMAT} +cmake ${CMAKE_FLAGS[*]} ${NBS_LIB_INSTALL_PATH}/${NBS_REPOSITORY_NAME} +${MSG_END_FORMAT}" + +if [[ $TEST_RUN == true ]]; then + print_msg "Test-run mode: Skipping cmake" + BUILD_EXIT_CODE=0 + INSTALL_EXIT_CODE=0 +else + cmake "${CMAKE_FLAGS[@]}" "${NBS_LIB_INSTALL_PATH}/${NBS_REPOSITORY_NAME}" + + BUILD_EXIT_CODE=$? + + make -j $(nproc) + sudo make install + + INSTALL_EXIT_CODE=$? + + if [[ ${LIBNABO_BUILD_DOXYGEN_FLAG} = ON ]]; then + make doc + fi + + ## List all CMake build options and their default values + ## ref: https://stackoverflow.com/questions/16851084/how-to-list-all-cmake-build-options-and-their-default-values + #cmake -LAH +fi + +print_msg "Directories (post ${NBS_REPOSITORY_NAME} install)$(tree -L 2 ${NBS_LIB_INSTALL_PATH})" + +teamcity_service_msg_compilationFinished +teamcity_service_msg_blockClosed + +# ....Install/build feedback....................................................................... +SUCCESS_MSG="${NBS_REPOSITORY_NAME} installed successfully at ${MSG_DIMMED_FORMAT}${NBS_LIB_INSTALL_PATH}/${NBS_REPOSITORY_NAME}${MSG_END_FORMAT}" +FAILURE_MSG="${NBS_REPOSITORY_NAME} installer exited with error" + +if [[ ${IS_TEAMCITY_RUN} == true ]]; then + # Report message to build log + if [[ ${BUILD_EXIT_CODE} == 0 ]] && [[ ${INSTALL_EXIT_CODE} == 0 ]]; then + echo -e "##teamcity[message text='${MSG_BASE_TEAMCITY} ${SUCCESS_MSG}' status='NORMAL']" + else + if [[ ${BUILD_EXIT_CODE} != 0 ]]; then + echo -e "##teamcity[message text='${MSG_BASE_TEAMCITY} ${FAILURE_MSG}' errorDetails='$BUILD_EXIT_CODE' status='ERROR']" + print_formated_script_footer "${CALLER_NAME} (${IMAGE_ARCH_AND_OS})" "${MSG_LINE_CHAR_INSTALLER}" + exit $BUILD_EXIT_CODE + else + echo -e "##teamcity[message text='${MSG_BASE_TEAMCITY} ${FAILURE_MSG}' errorDetails='$INSTALL_EXIT_CODE' status='ERROR']" + print_formated_script_footer "${CALLER_NAME} (${IMAGE_ARCH_AND_OS})" "${MSG_LINE_CHAR_INSTALLER}" + exit $INSTALL_EXIT_CODE + fi + fi +else + if [[ ${BUILD_EXIT_CODE} == 0 ]] && [[ ${INSTALL_EXIT_CODE} == 0 ]]; then + echo " " && print_msg_done "${SUCCESS_MSG}" + else + print_msg_error "${FAILURE_MSG}" + print_formated_script_footer "${CALLER_NAME} (${IMAGE_ARCH_AND_OS})" "${MSG_LINE_CHAR_INSTALLER}" + if [[ ${BUILD_EXIT_CODE} != 0 ]]; then + exit $BUILD_EXIT_CODE + else + exit $INSTALL_EXIT_CODE + fi + fi +fi + +print_formated_script_footer "${CALLER_NAME} (${IMAGE_ARCH_AND_OS})" "${MSG_LINE_CHAR_INSTALLER}" + +# ====Teardown===================================================================================== +cd "${TMP_CWD}" diff --git a/build_system/utilities/norlab-build-system b/build_system/utilities/norlab-build-system new file mode 160000 index 0000000..617d447 --- /dev/null +++ b/build_system/utilities/norlab-build-system @@ -0,0 +1 @@ +Subproject commit 617d447151d1438aadfd2ba44d12fabbb95d772b diff --git a/build_system/utilities/norlab-shell-script-tools b/build_system/utilities/norlab-shell-script-tools new file mode 160000 index 0000000..f7da296 --- /dev/null +++ b/build_system/utilities/norlab-shell-script-tools @@ -0,0 +1 @@ +Subproject commit f7da29662b6fa9417cab2b7b9b0c94111ffa4a89 diff --git a/contributing/commit_msg_reference.md b/contributing/commit_msg_reference.md new file mode 100644 index 0000000..6d25410 --- /dev/null +++ b/contributing/commit_msg_reference.md @@ -0,0 +1,37 @@ +# _Conventional Commits_ specification quick reference + +See https://www.conventionalcommits.org for details + + +#### Commit types description: + +- `!`: Commit that introduces a breaking API change (correlating with MAJOR in Semantic + Versioning) +- `feat`: A new feature +- `fix`: A bug fix +- `docs`: Documentation only changes +- `style`: Changes that do not affect the meaning of the code (white-space, formatting, missing + semi-colons, etc) +- `refactor`: A code change that neither fixes a bug nor adds a feature +- `perf`: A code change that improves performance +- `test`: Adding missing tests or correcting existing tests +- `build`: Changes that affect the build system or external dependencies (example scopes: gulp, + broccoli, npm) +- `ci`: Changes to our CI configuration files and scripts (example scopes: Travis, Circle, + BrowserStack, SauceLabs) +- `chore`: Other changes that don't modify src or test files +- `revert`: Reverts a previous commit + +#### Commit footer: + +- `BREAKING CHANGE`: Commit that introduces a breaking API change (correlating with MAJOR in Semantic Versioning) + +#### Commit message structure +``` +[()]: + +[optional-body] + +[optional-footer(s)] + +``` diff --git a/contributing/contributing_instructions.md b/contributing/contributing_instructions.md new file mode 100644 index 0000000..4d75537 --- /dev/null +++ b/contributing/contributing_instructions.md @@ -0,0 +1,134 @@ +# Contributing to _libnabo_ + +## Bug Reporting + +Please use our [github's issue tracker](http://github.com/norlab-ulaval/libnabo/issues) to +report bugs. + +## Code Contributions + +Libnabo codebase now +integrate [norlab-build-system (NBS)](/~https://github.com/norlab-ulaval/norlab-build-system) +and [norlab-shell-script-tools (N2ST)](/~https://github.com/norlab-ulaval/norlab-shell-script-tools). +`NBS` is a build-infrastructure-agnostic build system custom-made to meet our needs in robotic +software engineering at NorLab and `N2ST` is a library of shell script functions as well as a shell +testing tools leveraging _**bats-core**_ and _**docker**_ . +`N2ST` purpose is to speed up shell script development and improve reliability. + +`NBS` is deployed on our [TeamCity](https://www.jetbrains.com/teamcity/) continuous +integration/deployment server and oversees protected branches of +the [libnabo](/~https://github.com/norlab-ulaval/libnabo) GitHub repository: + +- The `develop` branch can only be merged through a pull-request from any `` branches. Any + contributor can submit a pull request to the `develop` branch; +- the `release` branch is a revision and preparation branch where we can freeze the codebase in a + given state without stalling to `develop` branch progression; +- The `master` branch can only be merged through a pull-request from the `release` branch. Only + repository admin can submit a PR to the `master` branch. + +In any cases, submitting a pull request to `develop` or `master` will trigger a build/test +configuration on our build system and the pull request will be granted if the build/test run +succeed. + +**Current build matrix:** +`[latest] x [x86, arm64] x [ubuntu] x [bionic, focal] x [Release, RelWithDebInfo, MinSizeRel]` + +### Development Workflow + +To speed up the development process, you can run the build system localy on your workstation and +have access to stacktrace and build log. +It support multi-OS and multi-architecture through docker container. + +#### Install _libnabo-build-system_ Dependencies + +```shell +cd + +# If libnabo is already cloned, fetch the NBS and N2ST submodule +git submodule update --remote --recursive --init + +cd ./build_system/nabo_utility_script + +# Execute docker tools install script i.e. docker daemon, docker compose, docker buildx +bash nabo_install_docker_tools.bash + +# Configure a multi-architecture docker builder +bash nabo_create_multiarch_docker_builder.bash +``` + +#### _libnabo_ Development › To Execute Build/Test Step Locally + +```shell +cd /build_system + +# Run the build matrix as specified in ".env.build_matrix.libnabo" +# on native architecture using "ci_PR" service +bash nabo_crawl_libnabo_build_matrix.bash --fail-fast -- build ci_PR + +# Run a specific case using build flags with multi-architecture +# virtualization using "ci_PR_amd64" and "ci_PR_arm64v8" services +bash nabo_crawl_libnabo_build_matrix.bash \ + --repository-version-build-matrix-override latest \ + --os-name-build-matrix-override ubuntu \ + --cmake-build-type-build-matrix-override RelWithDebInfo \ + --ubuntu-version-build-matrix-override focal \ + --fail-fast \ + -- build ci_PR_amd64 ci_PR_arm64v8 + +# Read the help for details +bash nabo_crawl_libnabo_build_matrix.bash --help +``` + +Note: To assess the state of the codebase, even for cases that are known the break the build, +execute `nabo_crawl_libnabo_build_matrix.bleeding.bash` with build +matrix `.env.build_matrix.libnabo.bleeding`. +The stable build matrix used for release is `.env.build_matrix.libnabo`. + +#### Build System Development + +```shell +cd /build_system/tests/ + +# To execute docker dryrun and configuration tests +bash run_all_docker_dryrun_and_config_tests.bash + +# To execute shell script tests +bash run_bats_core_test_in_n2st.bash + +# To spin a container in interactive mode with the codebase cloned but not compiled +cd ./tests_docker_interactive/ +bash build_and_run_IamBuildSystemTester.bash bash +``` + +#### Build System Notes + +- `nabo_crawl_dependencies_build_matrix.bash` execute the build matrix for the libnabo + dependencies. + It's not required to build them locally as they are pre-build by our TeamCity server periodically + push to dockerhub. + When executing `nabo_crawl_libnabo_build_matrix.bash`, the `libnabo-dependencies` + docker images are pull and used as base image for the `libnabo-[ci_PR_test|release]` + images. +- About `libnabo/.github/workflow/` vs `libnabo/build_system/` logic: Those are + separate build logic. + `.github/workflow/` was community contributed and as the responsibilities of building + python-binding and pushing packages. + For this reason, it run a one-dimension build matrix: multiple python version, single OS version, + single arch (x86) and + single compile flag which GitHub action computing resources can handle just fine. + +## Commit Messages + +This is optional for now but will eventually move our release workflow to semantic-versioning. +See [Commit Message References](commit_msg_reference.md) for details. + +## Note For Repository Admins + +### About Release Branch And Pull Request To Master Branch + +- Only repository admins have the privilege to `push/merge` on the default branch (ie: `master`) + and the `release` branch. +- Keep PR in `draft` mode until all the release reviewers are ready to push the release. +- Once a PR from `release` -> `master` branch is created (not in draft mode), + - it triggers the _build-system_ test + - (in-progress) and it triggers the _semantic release automation_ diff --git a/libnaboConfig.cmake.in b/libnaboConfig.cmake.in index 0de01c3..65b4834 100644 --- a/libnaboConfig.cmake.in +++ b/libnaboConfig.cmake.in @@ -1,6 +1,16 @@ # - Config file for the libnabo package +# It defines the following variables +# libnabo_INCLUDE_DIRS - include directories for libnabo +# libnabo_LIBRARIES - libraries to link against +@PACKAGE_INIT@ include(${CMAKE_CURRENT_LIST_DIR}/libnabo-targets.cmake) # This causes catkin_simple to link against these libraries set(libnabo_FOUND_CATKIN_PROJECT true) + +# Compute paths +set(libnabo_INCLUDE_DIRS "@CONF_INCLUDE_DIRS@") +set(libnabo_LIBRARIES "@libnabo_library@") + +check_required_components("@PROJECT_NAME@") \ No newline at end of file diff --git a/libnaboConfigVersion.cmake.in b/libnaboConfigVersion.cmake.in deleted file mode 100644 index 0b99844..0000000 --- a/libnaboConfigVersion.cmake.in +++ /dev/null @@ -1,11 +0,0 @@ -set(PACKAGE_VERSION "@PROJECT_VERSION@") - -# Check whether the requested PACKAGE_FIND_VERSION is compatible -if("${PACKAGE_VERSION}" VERSION_LESS "${PACKAGE_FIND_VERSION}") - set(PACKAGE_VERSION_COMPATIBLE FALSE) -else() - set(PACKAGE_VERSION_COMPATIBLE TRUE) - if ("${PACKAGE_VERSION}" VERSION_EQUAL "${PACKAGE_FIND_VERSION}") - set(PACKAGE_VERSION_EXACT TRUE) - endif() -endif() diff --git a/libnabo_dependencies_installer.bash b/libnabo_dependencies_installer.bash new file mode 100644 index 0000000..d447918 --- /dev/null +++ b/libnabo_dependencies_installer.bash @@ -0,0 +1,74 @@ +#!/bin/bash +# ================================================================================================= +# +# Install all libnabo dependencies +# +# Redirect the execution to libnabo-build-system library +# +# Usage: +# $ bash libnabo_dependencies_installer.bash [--test-run] +# +# ================================================================================================= +PARAMS="$@" + +MSG_DIMMED_FORMAT="\033[1;2m" +MSG_ERROR_FORMAT="\033[1;31m" +MSG_END_FORMAT="\033[0m" + +function nabo::install_libnabo_dependencise(){ + + # ....path resolution logic...................................................................... + NABO_ROOT="$(dirname "$(realpath "$0")")" + + cd "${NABO_ROOT}" || exit 1 + + # ....Load environment variables from file....................................................... + # . . Source NABO environment variables . . . . . . . . . . . . . . . . . . . . . . . . . . . .. + if [[ -f .env.libnabo ]]; then + set -o allexport && source .env.libnabo && set +o allexport + else + echo -e "${MSG_ERROR_FORMAT}[NABO ERROR]${MSG_END_FORMAT} .env.libnabo unreachable. Cwd $(pwd)" 1>&2 + exit 1 + fi + + # . . Source NBS dependencies . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . + cd "${N2ST_PATH}" || exit 1 + source import_norlab_shell_script_tools_lib.bash + + # . . Source NABO-build-system environment variables . . . . . . . . . . . . . . . . . . . . . .. + cd "${NABO_BUILD_SYSTEM_PATH}" || exit 1 + if [[ -f .env ]]; then + set -o allexport && source .env && set +o allexport + else + echo -e "${MSG_ERROR_FORMAT}[NABO ERROR]${MSG_END_FORMAT} .env unreachable. Cwd $(pwd)" 1>&2 + exit 1 + fi + + + # ====Begin====================================================================================== + norlab_splash "${NBS_SPLASH_NAME}" "/~https://github.com/${NBS_REPOSITORY_DOMAIN:?err}/${NBS_REPOSITORY_NAME:?err}" + export SHOW_SPLASH_IDU=false + export SHOW_SPLASH_IDDU=false + + # ....Install general dependencies............................................................... + cd "${NABO_PATH:?err}"/build_system/ubuntu || exit 1 + # shellcheck disable=SC2086 + source nabo_install_dependencies_ubuntu.bash ${PARAMS[@]} + + # ....Install documentation related dependencies................................................. + cd "${NABO_PATH:?err}"/build_system/ubuntu || exit 1 + # shellcheck disable=SC2086 + source nabo_install_doc_dependencies_ubuntu.bash ${PARAMS[@]} + + print_msg_done "All Libnabo dependencies installed" +} + +# ::::Main::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::: +if [[ "${BASH_SOURCE[0]}" = "$0" ]]; then + # This script is being run, ie: __name__="__main__" + nabo::install_libnabo_dependencise +else + # This script is being sourced, ie: __name__="__source__" + echo -e "${MSG_ERROR_FORMAT}[NABO ERROR]${MSG_END_FORMAT} Execute this script in a subshell i.e.: $ bash libnabo_dependencies_installer.bash" 1>&2 + exit 1 +fi diff --git a/libnabo_installer.bash b/libnabo_installer.bash new file mode 100644 index 0000000..dfa4728 --- /dev/null +++ b/libnabo_installer.bash @@ -0,0 +1,85 @@ +#!/bin/bash +# ================================================================================================= +# +# Install libnabo +# +# Usage: +# $ bash libnabo_installer.bash [] +# +# Arguments: +# --install-path The directory where to install libnabo (absolute path) +# (default location defined in the .env) +# --repository-version 1.0.7 Install libnabo release tag version (default to master branch latest) +# --compile-test Compile the libnabo unit-test +# --generate-doc Generate the libnabo doxygen documentation +# in /usr/local/share/doc/libnabo/api/html/index.html +# --cmake-build-type RelWithDebInfo The type of cmake build: None Debug Release RelWithDebInfo MinSizeRel +# (default to RelWithDebInfo) +# --build-system-CI-install Set special configuration for CI/CD build system: +# skip the git clone install step and assume the repository is already +# pulled and checkout on the desired branch +# --test-run CI/CD build system Test-run mode +# -h, --help Get help +# +# Note: +# - this script required package: g++, make, cmake, build-essential, git and all libnabo dependencies +# - execute `libnabo_dependencies_installer.bash` first +# +# ================================================================================================= +PARAMS="$@" + +MSG_DIMMED_FORMAT="\033[1;2m" +MSG_ERROR_FORMAT="\033[1;31m" +MSG_END_FORMAT="\033[0m" + +function nabo::install_libnabo(){ + + # ....path resolution logic...................................................................... + NABO_ROOT="$(dirname "$(realpath "$0")")" + + cd "${NABO_ROOT}" || exit 1 + + # ....Load environment variables from file....................................................... + # . . Source NABO environment variables . . . . . . . . . . . . . . . . . . . . . . . . . . . .. + if [[ -f .env.libnabo ]]; then + set -o allexport && source .env.libnabo && set +o allexport + else + echo -e "${MSG_ERROR_FORMAT}[NABO ERROR]${MSG_END_FORMAT} .env.libnabo unreachable. Cwd $(pwd)" 1>&2 + exit 1 + fi + + # . . Source NBS dependencies . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . + cd "${NBS_PATH}" || exit 1 + source import_norlab_build_system_lib.bash + + # . . Source NABO-build-system environment variables . . . . . . . . . . . . . . . . . . . . . .. + cd "${NABO_BUILD_SYSTEM_PATH}" || exit 1 + if [[ -f .env ]]; then + set -o allexport && source .env && set +o allexport + else + echo -e "${MSG_ERROR_FORMAT}[NABO ERROR]${MSG_END_FORMAT} .env unreachable. Cwd $(pwd)" 1>&2 + exit 1 + fi + + # ====Begin====================================================================================== + norlab_splash "${NBS_SPLASH_NAME}" "/~https://github.com/${NBS_REPOSITORY_DOMAIN:?err}/${NBS_REPOSITORY_NAME:?err}" + export SHOW_SPLASH_ILU=false + + # ....Install general dependencies............................................................... + cd "${NABO_PATH:?err}"/build_system/ubuntu || exit 1 + + # shellcheck disable=SC2068 + source nabo_install_libnabo_ubuntu.bash ${PARAMS[@]} + + print_msg_done "Libnabo install script completed. Have fun" +} + +# ::::Main::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::: +if [[ "${BASH_SOURCE[0]}" = "$0" ]]; then + # This script is being run, ie: __name__="__main__" + nabo::install_libnabo +else + # This script is being sourced, ie: __name__="__source__" + echo -e "${MSG_ERROR_FORMAT}[NABO ERROR]${MSG_END_FORMAT} Execute this script in a subshell i.e.: $ bash libnabo_installer.bash" 1>&2 + exit 1 +fi diff --git a/package.xml b/package.xml index cb9bac6..ceab2c5 100644 --- a/package.xml +++ b/package.xml @@ -15,6 +15,7 @@ cmake eigen boost + eigen boost catkin diff --git a/visual/norlab_logo_acronym_dark.png b/visual/norlab_logo_acronym_dark.png new file mode 100644 index 0000000..a60a746 Binary files /dev/null and b/visual/norlab_logo_acronym_dark.png differ diff --git a/visual/norlab_logo_acronym_light.png b/visual/norlab_logo_acronym_light.png new file mode 100644 index 0000000..a102f89 Binary files /dev/null and b/visual/norlab_logo_acronym_light.png differ