diff --git a/BUILD.md b/BUILD.md new file mode 100644 index 000000000..59e9a8c7a --- /dev/null +++ b/BUILD.md @@ -0,0 +1,285 @@ +# Build from Source Instructions + +> **Supported Platforms:** As of this release, Wire CDT can be built on **Ubuntu 24.04 LTS on x86_64. Earlier Ubuntu versions (20.04, 22.04) are no longer supported for building from source. + +# Get the source code + +Clone this repo as follows: + +```bash +# Clone with HTTP +git clone --recursive https://github.com/Wire-Network/wire-cdt.git + +# Clone with SSH (if you have SSH keys set up) +# git clone --recursive git@github.com:Wire-Network/wire-cdt.git + +# Enter the repo directory +cd wire-cdt +``` + +# On Host Machine + +> **ONLY SUPPORTS:** Ubuntu 24.04 LTS. + +## Prerequisites + +You will need to build on a [supported operating system](README.md#supported-operating-systems) with the following tools and libraries available: + +- **Clang** – C/C++ compiler (system clang is sufficient for CDT) +- **CMake 3.16+** – Build system generator +- **libxml2** – XML parsing library +- **Python 3** – Python is needed for some build steps and tools +- **OCaml** – Required for certain CDT components +- **git** – Version control, used for fetching submodules + +Other standard development tools and libraries (build essentials, etc.) are needed as well. These will be installed in the steps below. + +## Step 1 - Install Dependencies + +### 1a. Install System Packages (Ubuntu 24.04) + +On Ubuntu 24.04, install the following dependencies. + +```bash +# Update package lists +sudo apt-get update + +# Install build tools and libraries +sudo apt-get install -y \ + build-essential \ + clang \ + clang-tidy \ + cmake \ + git \ + libxml2-dev \ + opam \ + ocaml-interp \ + python3 \ + python3-pip \ + time +``` + +### 1b. Install Python Dependencies + +Install required Python packages: + +```bash +python3 -m pip install pygments +``` + +### 1c. Install LLVM 11 + +Wire CDT depends on **LLVM 11**. On modern systems (Ubuntu 24.04+), you will need to build LLVM 11 from source, since it's not available in the apt repositories. + +Use the helper script from Wire Sysio to build and install LLVM 11: + +```bash +# First, you'll need the Wire Sysio repository for the LLVM 11 build script +# Clone it temporarily if you don't have it: +git clone https://github.com/Wire-Network/wire-sysio.git /tmp/wire-sysio + +# Choose an installation base directory for LLVM 11 +export BASE_DIR=/opt/llvm # (you can choose a different directory if desired) + +# Build and install LLVM 11 from source +sudo mkdir -p "$BASE_DIR"; sudo chown "$USER":"$USER" "$BASE_DIR" +/tmp/wire-sysio/scripts/llvm-11/llvm-11-ubuntu-build-source.sh + +# or: +sudo --preserve-env=BASE_DIR /tmp/wire-sysio/scripts/llvm-11/llvm-11-ubuntu-build-source.sh +``` + +This will download the LLVM 11 source code, compile it, and install the libraries and tools to `$BASE_DIR/llvm-11`. (By default, the script places the final installation in `/opt/llvm/llvm-11` if `BASE_DIR=/opt/llvm`.) + +> **IMPORTANT:** Remember the installation path of LLVM 11 – you will need to supply it to CMake in the build step. For example, `-DCMAKE_PREFIX_PATH=/opt/llvm/llvm-11`. + +### 1d. Bootstrap vcpkg + +Wire CDT uses the **vcpkg** package manager for managing third-party dependencies. After installing the required system packages above, you must bootstrap vcpkg from the root of the cloned `wire-cdt` repository: + +```bash +# From the wire-cdt repository root directory +./vcpkg/bootstrap-vcpkg.sh +``` + +This will build the vcpkg executable and set up the local vcpkg infrastructure. (It may take a few minutes on first run.) + +You are now ready to build Wire CDT. + +### 1e. Optional - Enable Integration Tests + +Integration tests require access to a build of [Wire Sysio](https://github.com/Wire-Network/wire-sysio). + +If you do not wish to build Wire Sysio, you can skip this section and continue to [Step 2](#step-2---build). Otherwise, follow the instructions below before running `cmake`. + +First, ensure that Wire Sysio has been built from source (see [BUILD.md](https://github.com/Wire-Network/wire-sysio/blob/master/BUILD.md) for details) and identify the build path, e.g. `/path/to/wire-sysio/build/`. + +Then, execute the following command in the same terminal session that you will use to build CDT: + +```bash +export sysio_DIR=/path/to/wire-sysio/build/lib/cmake/sysio +``` +When you configure the build in Step 2, you will also need to add -DENABLE_INTEGRATION_TESTS=ON and -Dsysio_DIR to the cmake command. Here is a complete example: + +```bash +cmake -B . -S .. \ +-DCMAKE_BUILD_TYPE=Release \ +-DCMAKE_PREFIX_PATH="/path/to/wire-sysio/build;/opt/llvm/llvm-11" \ +-DCMAKE_TOOLCHAIN_FILE="$PWD/../vcpkg/scripts/buildsystems/vcpkg.cmake" \ +-Dsysio_DIR=/path/to/wire-sysio/build/lib/cmake/sysio \ +-DENABLE_INTEGRATION_TESTS=ON +``` + +Now you can continue with the steps to build CDT as described. When you run `cmake` make sure that it does not report `sysio package not found`. If it does, this means CDT was not able to find a build of Wire Sysio at the specified path in `sysio_DIR` and will therefore continue without building the integration tests. + +### 1f. Optional - Disable ccache + +If issues persist with ccache when building CDT, you can disable ccache: + +```bash +export CCACHE_DISABLE=1 +``` + +You are now ready to build Wire CDT. + +## Step 2 - Build + +Make sure you are in the root of the `wire-cdt` repo, then perform the build with CMake. + +> ⚠️ **Memory/Parallelism Warning** ⚠️ +> Building Wire CDT from source can be resource-intensive. Some compilation units (.cpp files) in CDT are extremely complex and can consume a large amount of memory to compile. If you use all CPU cores for parallel compilation (e.g. `make -j$(nproc)`), you may exhaust memory and encounter compiler crashes. Consider using a lower parallel job count (`-j`) if you run into memory issues or if you need to use your machine for other tasks during the build. + +### Build Instructions + +Create a build directory and configure with CMake: + +```bash +mkdir -p build +cd build + +cmake -B . -S .. \ + -DCMAKE_BUILD_TYPE=Release \ + -DCMAKE_PREFIX_PATH="/opt/llvm/llvm-11" \ + -DCMAKE_TOOLCHAIN_FILE="$PWD/../vcpkg/scripts/buildsystems/vcpkg.cmake" +``` + +In the above command: +- `-B . -S ..` tells CMake to use the current directory for build files and parent directory for source. +- `CMAKE_BUILD_TYPE=Release` produces an optimized build. (You can use `Debug` for development, etc.) +- `CMAKE_PREFIX_PATH` is set to the location of LLVM 11 installation. Adjust the path if you installed to a different prefix (from Step 1c). +- `CMAKE_TOOLCHAIN_FILE` points to the vcpkg toolchain file, so CMake will integrate `vcpkg` dependencies automatically. + +If you enabled integration tests in Step 1e, verify the configuration output shows that Wire Sysio was found. + +Now proceed to compile: + +```bash +make -j$(nproc) +``` + +This will start the build process (using all available CPU cores by default). If you find your system running low on memory or becoming unresponsive, cancel the build (`Ctrl+C`) and re-run with a lower parallel job count, for example: + +```bash +make -j4 +``` + +(to limit to 4 threads). + +Once the build completes successfully, the Wire CDT binaries will be available in `build/bin/`. + +You can now proceed to [test](README.md#testing) your build (optional), or install CDT as described below. + +### Optional - Build in Debug Mode + +To build CDT with debug symbols for development, configure with debug flags: + +```bash +cmake -DCMAKE_BUILD_TYPE="Debug" -DTOOLS_BUILD_TYPE="Debug" -DLIBS_BUILD_TYPE="Debug" .. +make -j$(nproc) +``` + +## Step 3 - Install + +After you have [built](#step-2---build) Wire CDT (and optionally [tested](README.md#testing) it), you can install it on your system. There are three primary ways to install: + +**A. Install via Debian Package:** +We recommend installing using the Debian package that the build can produce, as it ensures all files go to appropriate system locations. To build the package, run: + +```bash +cd build/packages +./generate_package.sh deb ubuntu-24.04 amd64 +``` + +This will create the Wire CDT `.deb` package. Then install it using `apt`: + +```bash +sudo apt install ./cdt_*_amd64.deb +``` + +*(Replace `cdt_*_amd64.deb` with the actual filename of the package. Using `apt install` on the local file will automatically handle any missing dependencies.)* + +**B. Install via CMake target:** +Alternatively, you can install the built files directly to your system using CMake. This is useful if you prefer not to create a package: + +```bash +cd build +sudo cmake --install . +``` + +This will copy the Wire CDT binaries, libraries, and headers to the default installation prefixes (e.g., under `/usr/local/` by default, or whatever `CMAKE_INSTALL_PREFIX` was set to during configuration). You may omit `sudo` if installing to a location your user has write access to. + +**C. Use without installing:** +You can also use Wire CDT directly from the build directory without installing system-wide: + +```bash +# Add build/bin to your PATH +export PATH=/path/to/wire-cdt/build/bin:$PATH + +# Or use the CMake toolchain file in your CMake projects +# -DCMAKE_TOOLCHAIN_FILE=/path/to/wire-cdt/build/lib/cmake/CDTWasmToolchain.cmake +``` + +This allows you to compile contracts without installing CDT globally. + +Choose **either** method A, B, or C according to your preference. Method A (deb package) is cleaner for system installs, as it can be easily removed or upgraded using the system package manager. + +### Installed Tools + +When installed globally (via method A or B), CDT provides the following command-line tools: + +- **cdt-abidiff** – ABI comparison tool +- **cdt-ar** – Archive utility +- **cdt-cc** – C compiler wrapper +- **cdt-cpp** – C preprocessor +- **cdt-init** – Project initialization tool +- **cdt-ld** – Linker +- **cdt-nm** – Symbol listing tool +- **cdt-objcopy** – Object file utility +- **cdt-objdump** – Object file disassembler +- **cdt-ranlib** – Archive index generator +- **cdt-readelf** – ELF file reader +- **cdt-strip** – Symbol stripper +- **sysio-pp** – Pre-processor +- **sysio-wasm2wast** – WASM to WAST converter +- **sysio-wast2wasm** – WAST to WASM converter + +It also installs CMake files for CDT accessible within a `cmake/cdt` directory located within your system's `lib` directory. + +## Uninstall + +### Uninstall CDT (if installed via package): + +```bash +sudo apt remove cdt +``` + +### Uninstall CDT (if installed via CMake): + +```bash +sudo rm -fr /usr/local/cdt +sudo rm -fr /usr/local/lib/cmake/cdt +sudo rm /usr/local/bin/sysio-* +sudo rm /usr/local/bin/cdt-* +``` + +--- \ No newline at end of file diff --git a/CMakeLists.txt b/CMakeLists.txt index c90e1661c..5a4d909be 100644 --- a/CMakeLists.txt +++ b/CMakeLists.txt @@ -29,7 +29,7 @@ set(CDT_INSTALL_PREFIX ${CMAKE_INSTALL_PREFIX}) option(ENABLE_NATIVE_COMPILER "enable native builds with the CDT toolchain" ON) option(ENABLE_TESTS "enable building tests" ON) -cmake_dependent_option(ENABLE_INTEGRATION_TESTS "Build integration tests" OFF "NOT ENABLE_TESTS" OFF) +cmake_dependent_option(ENABLE_INTEGRATION_TESTS "Build integration tests" OFF "ENABLE_TESTS" OFF) option(ENABLE_PACKAGE "enable cpack" ON) include(GNUInstallDirs) @@ -85,10 +85,19 @@ set(DESC "Toolchain and supporting tools to facilitate C/C++ development of cont set(URL "https://github.com/Wire-Network/wire-cdt") set(EMAIL "support@wire.network") configure_file(${CMAKE_SOURCE_DIR}/scripts/generate_package.sh.in ${CMAKE_BINARY_DIR}/packages/generate_package.sh @ONLY) -configure_file(${CMAKE_SOURCE_DIR}/scripts/generate_deb.sh ${CMAKE_BINARY_DIR}/packages/generate_deb.sh COPYONLY) -configure_file(${CMAKE_SOURCE_DIR}/scripts/generate_bottle.sh ${CMAKE_BINARY_DIR}/packages/generate_bottle.sh COPYONLY) -configure_file(${CMAKE_SOURCE_DIR}/scripts/generate_rpm.sh ${CMAKE_BINARY_DIR}/packages/generate_rpm.sh COPYONLY) -configure_file(${CMAKE_SOURCE_DIR}/scripts/generate_tarball.sh ${CMAKE_BINARY_DIR}/packages/generate_tarball.sh COPYONLY) +file(CHMOD ${CMAKE_BINARY_DIR}/packages/generate_package.sh + PERMISSIONS OWNER_READ OWNER_WRITE OWNER_EXECUTE + GROUP_READ GROUP_EXECUTE + WORLD_READ WORLD_EXECUTE) +file(COPY + ${CMAKE_SOURCE_DIR}/scripts/generate_deb.sh + ${CMAKE_SOURCE_DIR}/scripts/generate_bottle.sh + ${CMAKE_SOURCE_DIR}/scripts/generate_rpm.sh + ${CMAKE_SOURCE_DIR}/scripts/generate_tarball.sh + DESTINATION ${CMAKE_BINARY_DIR}/packages + FILE_PERMISSIONS OWNER_READ OWNER_WRITE OWNER_EXECUTE + GROUP_READ GROUP_EXECUTE + WORLD_READ WORLD_EXECUTE) # add licenses configure_file(${CMAKE_SOURCE_DIR}/cdt-llvm/LICENSE.TXT ${CMAKE_BINARY_DIR}/licenses/llvm.license COPYONLY) diff --git a/README.md b/README.md index 1ad6ad519..974993636 100644 --- a/README.md +++ b/README.md @@ -10,198 +10,70 @@ The `master` branch is the latest stable branch. We currently support the following operating systems. -| **Operating Systems** | -|---------------------------------| -| Ubuntu 22.04 Jammy | -| Ubuntu 20.04 Focal | -| Ubuntu 18.04 Bionic | +| **Operating Systems** | +|-----------------------| +| Ubuntu 24.04 Jammy | ## Installation -In the future, we plan to support the installation of Debian packages directly from our [Release page](https://github.com/Wire-Network/wire-cdt/releases), providing a more streamlined and convenient setup process. However, for the time being, installation requires **building the software from source**. +In the future, we plan to support downloading Debian packages directly from our [release page](https://github.com/Wire-Network/wire-cdt/releases), providing a more streamlined and convenient setup process. However, for the time being, installation requires *building the software from source*. -### Building from source +Finally, verify Wire CDT was installed correctly: -The instructions below assume that you are building on Ubuntu 20.04. and 22.04. - -### Install dependencies - -```sh -sudo apt-get update && sudo apt-get install \ - build-essential \ - clang \ - clang-tidy \ - cmake \ - git \ - libxml2-dev \ - opam ocaml-interp \ - python3 \ - python3-pip \ - time -``` - -```sh -python3 -m pip install pygments +```bash +cdt-cpp --version ``` ---- - -#### Optional - Build with integration tests - -Integration tests require access to a build of [Wire Sysio](https://github.com/Wire-Network/wire-sysio). +You should see version information with no errors. For example: -If you do not wish to build Wire Sysio, you can skip this section and continue to [Build CDT](#build-cdt). Otherwise, follow the instructions below before running `cmake`. - -First, ensure that Wire Sysio has been built from source (see [README](https://github.com/Wire-Network/wire-sysio/wire_sysio#building-from-source) for details) and identify the build path, e.g. `/path/to/wire-sysio/build/`. - -Then, execute the following command in the same terminal session that you will use to build CDT: - -```sh -export sysio_DIR=/path/to/wire-sysio/build/lib/cmake/sysio ``` - -Now you can continue with the steps to build CDT as described. When you run `cmake` make sure that it does not report `sysio package not found`. If it does, this means CDT was not able to find a build of Wire Sysio at the specified path in `sysio_DIR` and will therefore continue without building the integration tests. - - -### ccache - -If issues persist with ccache when building CDT, you can disable ccache: - -```sh -export CCACHE_DISABLE=1 -``` - ---- - -### Build CDT - -> [!WARNING] -> **About Compilation Jobs (`-j` flag)**: -> -> When building C/C++ software often the build is performed in > parallel via a command such as `make -j $(nproc)` which uses the > number of CPU cores as the number of compilation jobs to perform > simultaneously. However, be aware that some compilation units (.cpp > files) in CDT are extremely complex and can consume a large amount > of memory to compile. If you are running into issues due to amount > of memory available on your build host, you may need to reduce the > level of parallelization used for the build. For example, instead of > `make -j $(nproc)` you can try `make -j2`. Failures due to memory > exhaustion will typically but not always manifest as compiler > crashes. - -Use the commands below to clone this repository along with its submodules, set up the build environment, and compile the project: - -```sh -git clone --recursive https://github.com/Wire-Network/wire-cdt && cd wire-cdt && mkdir build && cd build -cmake .. -make -j $(nproc) +Wire CDT version 4.x.x ``` -The binaries will be located at in the `build/bin` directory. +## Building from source -You can export the path to the directory to your `PATH` environment variable which allows you to conveniently use them to compile contracts without installing CDT globally. +Follow the instructions in [BUILD.md](./BUILD.md) to build Wire CDT from source. -Alternatively, you can use CMake toolchain file located in `build/lib/cmake/CDTWasmToolchain.cmake` to compile the contracts in your CMake project, which also allows you to avoid installing CDT globally. +## Testing -If you would prefer to install CDT globally, see the section [Install CDT](#install-cdt) below. +Wire CDT supports the following test suites: +| Test Suite | Test Type | Notes | +|-----------------------------------------|:--------------------:|------------------------------------------------------------------------------------------| +| [Unit tests](#unit-tests) | Unit tests | Fast unit tests covering core functionality | +| [Integration tests](#integration-tests) | Integration | Tests requiring Wire Sysio build; optional but recommended if developing contracts | -> [!NOTE] -> If you wish to build with integration tests, you cmake command would be: -> `cmake -Dsysio_DIR=/home/svetla/repos/leap-5-rename/leap/build/lib/cmake/sysio ..` -> +When building from source, we recommend running at least the [unit tests](#unit-tests). -#### Build CDT in Debug mode +#### Unit Tests -To build CDT in debug mode (with debug symbols) you need to add the following flags to cmake command: -```sh -cmake -DCMAKE_BUILD_TYPE="Debug" -DTOOLS_BUILD_TYPE="Debug" -DLIBS_BUILD_TYPE="Debug" .. -``` +The unit test suite consists of tests that verify core CDT functionality without external dependencies. +You can invoke them by running `ctest` from a terminal in your build directory: -### Generate the `.deb` -```sh -cd build/packages && bash ./generate_package.sh deb ubuntu-22.04 amd64 +```bash +ctest ``` -### Run tests - -#### Run unit tests +#### Integration Tests -```sh -cd build +The integration test suite requires a built version of [Wire Sysio](https://github.com/Wire-Network/wire-sysio) and tests contract compilation and execution end-to-end. -ctest -``` +To build and run integration tests, you must first build Wire Sysio from source and set the `sysio_DIR` environment variable before configuring the CDT build. You also need to pass `ENABLE_INTEGRATION_TESTS=ON` to cmake. See [BUILD.md](./BUILD.md) for detailed instructions. -#### Run integration tests (if CDT was build with integration tests) +You can invoke them by running `ctest` from a terminal in your integration tests directory: -```sh +```bash cd build/tests/integration - ctest ``` -### Install CDT - -Installing CDT globally on your system will install the following tools in a location accessible to your `PATH`: - -* cdt-abidiff -* cdt-ar -* cdt-cc -* cdt-cpp -* cdt-init -* cdt-ld -* cdt-nm -* cdt-objcopy -* cdt-objdump -* cdt-ranlib -* cdt-readelf -* cdt-strip -* sysio-pp -* sysio-wasm2wast -* sysio-wast2wasm - -It will also install CMake files for CDT accessible within a `cmake/cdt` directory located within your system's `lib` directory. - -#### Manual installation - -One option for installing CDT globally is via `make install`. From within the `build` directory, run the following command: - -```sh -sudo make install -``` - -#### Package installation - -A better option for installing CDT globally is to generate a package and then install the package. This makes uninstalling CDT much easier. - -From within the `build` directory, run the following commands to generate a Debian package: - -```sh -cd packages -bash ./generate_package.sh deb ubuntu-20.04 amd64 -sudo apt install ./cdt_*_amd64.deb -``` - -### Uninstall CDT - -#### Uninstall CDT(if installed via `make install`) - -```sh -sudo rm -fr /usr/local/cdt -sudo rm -fr /usr/local/lib/cmake/cdt -sudo rm /usr/local/bin/sysio-* -sudo rm /usr/local/bin/cdt-* -``` - -#### Uninstall CDT( if installed via `apt install`) - -```sh -sudo apt remove cdt -``` - -## License - -[FSL-1.1-Apache-2.0](./LICENSE.md) - --- - + -
Wire NetworkWire Network Wire Network
Website | @@ -210,4 +82,4 @@ sudo apt remove cdt © 2024 Wire Network. All rights reserved.
+ \ No newline at end of file diff --git a/cmake/TestsExternalProject.cmake b/cmake/TestsExternalProject.cmake index 2d79ce946..9e0c667b3 100644 --- a/cmake/TestsExternalProject.cmake +++ b/cmake/TestsExternalProject.cmake @@ -17,45 +17,117 @@ message(STATUS "BOOST_ROOT: ${BOOST_ROOT}") message(STATUS "==========================") ExternalProject_Add( - CDTWasmTests - SOURCE_DIR "${CMAKE_SOURCE_DIR}/tests/unit" - BINARY_DIR "${CMAKE_BINARY_DIR}/tests/unit" - CMAKE_ARGS -DCMAKE_TOOLCHAIN_FILE=${CMAKE_BINARY_DIR}/lib/cmake/cdt/CDTWasmToolchain.cmake -DCMAKE_BUILD_TYPE=${CMAKE_BUILD_TYPE} -DCDT_BIN=${CMAKE_BINARY_DIR}/lib/cmake/cdt/ -DBASE_BINARY_DIR=${CMAKE_BINARY_DIR} -D__APPLE=${APPLE} -DCMAKE_MODULE_PATH=${CMAKE_MODULE_PATH} -DCMAKE_PREFIX_PATH=${CMAKE_PREFIX_PATH} - UPDATE_COMMAND "" - PATCH_COMMAND "" - TEST_COMMAND "" - INSTALL_COMMAND "" - BUILD_ALWAYS 1 - DEPENDS CDTWasmLibraries CDTTools + CDTWasmTests + SOURCE_DIR "${CMAKE_SOURCE_DIR}/tests/unit" + BINARY_DIR "${CMAKE_BINARY_DIR}/tests/unit" + CMAKE_ARGS -DCMAKE_TOOLCHAIN_FILE=${CMAKE_BINARY_DIR}/lib/cmake/cdt/CDTWasmToolchain.cmake -DCMAKE_BUILD_TYPE=${CMAKE_BUILD_TYPE} -DCDT_BIN=${CMAKE_BINARY_DIR}/lib/cmake/cdt/ -DBASE_BINARY_DIR=${CMAKE_BINARY_DIR} -D__APPLE=${APPLE} -DCMAKE_MODULE_PATH=${CMAKE_MODULE_PATH} -DCMAKE_PREFIX_PATH=${CMAKE_PREFIX_PATH} + UPDATE_COMMAND "" + PATCH_COMMAND "" + TEST_COMMAND "" + INSTALL_COMMAND "" + BUILD_ALWAYS 1 + DEPENDS CDTWasmLibraries CDTTools ) -if(ENABLE_INTEGRATION_TESTS) - message(STATUS "Building integration tests as BUILD_INTEGRATION_TESTS is ON") - - find_package(sysio REQUIRED) - - if(CMAKE_BUILD_TYPE STREQUAL "Debug") - set(TEST_BUILD_TYPE "Debug") - else() - set(TEST_BUILD_TYPE ${CMAKE_BUILD_TYPE}) - endif() - - string(REPLACE ";" "|" TEST_FRAMEWORK_PATH "${CMAKE_FRAMEWORK_PATH}") - string(REPLACE ";" "|" TEST_MODULE_PATH "${CMAKE_MODULE_PATH}") - - ExternalProject_Add( - CDTIntegrationTests - SOURCE_DIR "${CMAKE_SOURCE_DIR}/tests/integration" - BINARY_DIR "${CMAKE_BINARY_DIR}/tests/integration" - CMAKE_ARGS -DCMAKE_BUILD_TYPE=${TEST_BUILD_TYPE} -DCMAKE_CXX_COMPILER=${CMAKE_CXX_COMPILER} -DCMAKE_C_COMPILER=${CMAKE_C_COMPILER} -DCMAKE_FRAMEWORK_PATH=${TEST_FRAMEWORK_PATH} -DCMAKE_MODULE_PATH="${TEST_MODULE_PATH};${CMAKE_MODULE_PATH}" -DCMAKE_PREFIX_PATH="${CMAKE_PREFIX_PATH}" -Dsysio_DIR=${sysio_DIR} -DLLVM_DIR=${LLVM_DIR} -DBOOST_ROOT=${BOOST_ROOT} - UPDATE_COMMAND "" - PATCH_COMMAND "" - TEST_COMMAND "" - INSTALL_COMMAND "" - BUILD_ALWAYS 1 - ) - -else() - message(STATUS "Skipping building integration tests as BUILD_INTEGRATION_TESTS is OFF") - return() -endif() \ No newline at end of file +if (ENABLE_INTEGRATION_TESTS) + message(STATUS "Building integration tests as BUILD_INTEGRATION_TESTS is ON") + + if (CMAKE_BUILD_TYPE STREQUAL "Debug") + set(TEST_BUILD_TYPE "Debug") + else () + set(TEST_BUILD_TYPE ${CMAKE_BUILD_TYPE}) + endif () + + # Prepare list variables using ExternalProject's LIST_SEPARATOR to avoid token splitting + set(EP_LIST_SEP "|") + # Normalize potential space-separated values into proper lists first + string(REPLACE " " ";" _PP_LIST "${CMAKE_PREFIX_PATH}") + string(REPLACE " " ";" _MP_LIST "${CMAKE_MODULE_PATH}") + string(REPLACE " " ";" _FP_LIST "${CMAKE_FRAMEWORK_PATH}") + # Join with custom separator that ExternalProject will respect + string(REPLACE ";" "${EP_LIST_SEP}" EP_PREFIX_PATH "${_PP_LIST}") + string(REPLACE ";" "${EP_LIST_SEP}" EP_MODULE_PATH "${_MP_LIST}") + string(REPLACE ";" "${EP_LIST_SEP}" EP_FRAMEWORK_PATH "${_FP_LIST}") + + # Try to detect vcpkg prefix to help Boost discovery inside the ExternalProject + set(VCPKG_PREFIX_HINT "") + set(VCPKG_PREFIX_HINT_DEBUG "") + foreach (_p IN LISTS _PP_LIST) + if (_p MATCHES "/vcpkg_installed/") + if (_p MATCHES "/debug$") + if (NOT VCPKG_PREFIX_HINT_DEBUG) + set(VCPKG_PREFIX_HINT_DEBUG "${_p}") + endif () + else () + # Prefer non-debug triplet root + if (NOT VCPKG_PREFIX_HINT) + set(VCPKG_PREFIX_HINT "${_p}") + endif () + endif () + endif () + endforeach () + if (NOT VCPKG_PREFIX_HINT AND VCPKG_PREFIX_HINT_DEBUG) + set(VCPKG_PREFIX_HINT "${VCPKG_PREFIX_HINT_DEBUG}") + endif () + if (VCPKG_PREFIX_HINT) + string(REPLACE "/debug" "" VCPKG_PREFIX_ND "${VCPKG_PREFIX_HINT}") + set(VCPKG_INCLUDE_DIR "${VCPKG_PREFIX_ND}/include") + endif () + + # Also try to discover wire-sysio's vcpkg install by deriving it from sysio_DIR + set(SYSIO_VCPKG_INCLUDE "") + set(SYSIO_VCPKG_PREFIX "") + if (EXISTS "${sysio_DIR}") + # sysio_DIR typically points to /lib/cmake/sysio + get_filename_component(_SYSIO_CMAKE_DIR "${sysio_DIR}" DIRECTORY) # .../lib/cmake + get_filename_component(_SYSIO_LIB_DIR "${_SYSIO_CMAKE_DIR}" DIRECTORY) # .../lib + get_filename_component(_SYSIO_BUILD_DIR "${_SYSIO_LIB_DIR}" DIRECTORY) # .../cmake-build-* + get_filename_component(_SYSIO_SRC_DIR "${_SYSIO_BUILD_DIR}" DIRECTORY) # .../wire-sysio + set(_SYSIO_VCPKG_BASE "${_SYSIO_BUILD_DIR}/vcpkg_installed/x64-linux") + if (EXISTS "${_SYSIO_VCPKG_BASE}") + set(SYSIO_VCPKG_PREFIX "${_SYSIO_VCPKG_BASE}") + set(SYSIO_VCPKG_INCLUDE "${_SYSIO_VCPKG_BASE}/include") + # Prepend sysio's vcpkg roots to the prefix path list + if (EP_PREFIX_PATH) + set(EP_PREFIX_PATH "${SYSIO_VCPKG_PREFIX}${EP_LIST_SEP}${EP_PREFIX_PATH}") + else () + set(EP_PREFIX_PATH "${SYSIO_VCPKG_PREFIX}") + endif () + endif () + endif () + + ExternalProject_Add( + CDTIntegrationTests + SOURCE_DIR "${CMAKE_SOURCE_DIR}/tests/integration" + BINARY_DIR "${CMAKE_BINARY_DIR}/tests/integration" + LIST_SEPARATOR ${EP_LIST_SEP} + CMAKE_ARGS + -DCMAKE_BUILD_TYPE:STRING=${TEST_BUILD_TYPE} + -DCMAKE_CXX_COMPILER:FILEPATH=${CMAKE_CXX_COMPILER} + -DCMAKE_C_COMPILER:FILEPATH=${CMAKE_C_COMPILER} + -DCMAKE_FRAMEWORK_PATH:PATH=${EP_FRAMEWORK_PATH} + -DCMAKE_MODULE_PATH:PATH=${EP_MODULE_PATH} + -DCMAKE_PREFIX_PATH:PATH=${EP_PREFIX_PATH} + -Dsysio_DIR:PATH=${sysio_DIR} + -DLLVM_DIR:PATH=${LLVM_DIR} + -DBOOST_ROOT:PATH=${BOOST_ROOT} + $<$:-DBOOST_ROOT:PATH=${VCPKG_PREFIX_HINT}> + $<$:-DBOOST_INCLUDEDIR:PATH=${VCPKG_INCLUDE_DIR}> + $<$:-DBOOST_INCLUDEDIR:PATH=${SYSIO_VCPKG_INCLUDE}> + # Provide SysioTester with the extra include/library dirs derived from sysio_DIR + $<$:-DSYSIO_TESTER_EXTRA_INCLUDE_DIRS:PATH=${_SYSIO_SRC_DIR}/libraries/chain/include|${_SYSIO_BUILD_DIR}/libraries/chain/include|${_SYSIO_SRC_DIR}/libraries/chaindb/include|${_SYSIO_SRC_DIR}/libraries/libfc/include|${_SYSIO_SRC_DIR}/libraries/libfc-lite/include|${_SYSIO_SRC_DIR}/libraries/testing/include> + $<$:-DSYSIO_TESTER_EXTRA_LIBRARY_DIRS:PATH=${_SYSIO_BUILD_DIR}/libraries/chain|${_SYSIO_BUILD_DIR}/libraries/libfc|${_SYSIO_BUILD_DIR}/libraries/libfc-lite|${_SYSIO_BUILD_DIR}/libraries/chaindb|${_SYSIO_BUILD_DIR}/libraries/builtins|${_SYSIO_BUILD_DIR}/libraries/testing|${_SYSIO_BUILD_DIR}/libraries/wasm-jit/Source/WAST|${_SYSIO_BUILD_DIR}/libraries/wasm-jit/Source/WASM|${_SYSIO_BUILD_DIR}/libraries/wasm-jit/Source/IR|${_SYSIO_BUILD_DIR}/libraries/wasm-jit/Source/Logging|${_SYSIO_BUILD_DIR}/vcpkg_installed/x64-linux/debug/lib> + -DBoost_NO_BOOST_CMAKE:BOOL=ON + -DBoost_USE_STATIC_LIBS:BOOL=ON + -DBoost_USE_MULTITHREADED:BOOL=ON + UPDATE_COMMAND "" + PATCH_COMMAND "" + TEST_COMMAND "" + INSTALL_COMMAND "" + BUILD_ALWAYS 1 + ) + +else () + message(STATUS "Skipping building integration tests as BUILD_INTEGRATION_TESTS is OFF") + return() +endif () \ No newline at end of file diff --git a/tests/integration/CMakeLists.txt b/tests/integration/CMakeLists.txt index 8ec509086..7f5adcaa0 100644 --- a/tests/integration/CMakeLists.txt +++ b/tests/integration/CMakeLists.txt @@ -1,10 +1,29 @@ -cmake_minimum_required( VERSION 3.5 ) +cmake_minimum_required(VERSION 3.5) +project(integration_tests) set(SYSIO_VERSION_MIN "3.1") -set(SYSIO_VERSION_SOFT_MAX "5.0") +set(SYSIO_VERSION_SOFT_MAX "6.0") #set(SYSIO_VERSION_HARD_MAX "") -find_package(sysio) +# Provide extra include dirs to SysioTester (from wire-sysio source/build trees) +get_filename_component(_SYSIO_CMAKE_DIR "${sysio_DIR}" DIRECTORY) # .../lib/cmake +get_filename_component(_SYSIO_LIB_DIR "${_SYSIO_CMAKE_DIR}" DIRECTORY) # .../lib +get_filename_component(_SYSIO_BUILD_DIR "${_SYSIO_LIB_DIR}" DIRECTORY) # .../cmake-build-* +get_filename_component(_SYSIO_SRC_DIR "${_SYSIO_BUILD_DIR}" DIRECTORY) # .../wire-sysio +if (EXISTS "${_SYSIO_SRC_DIR}/libraries/chain/include") + set(SYSIO_TESTER_EXTRA_INCLUDE_DIRS + "${_SYSIO_SRC_DIR}/libraries/chain/include;${_SYSIO_BUILD_DIR}/libraries/chain/include;${_SYSIO_SRC_DIR}/libraries/chaindb/include;${_SYSIO_SRC_DIR}/libraries/libfc/include;${_SYSIO_SRC_DIR}/libraries/libfc-lite/include;${_SYSIO_SRC_DIR}/libraries/testing/include" + CACHE INTERNAL "Extra include directories for SysioTester") + # Help SysioTester locate build-tree libraries (when not installed yet) + set(SYSIO_TESTER_EXTRA_LIBRARY_DIRS + "${_SYSIO_BUILD_DIR}/libraries/chain;${_SYSIO_BUILD_DIR}/libraries/libfc;${_SYSIO_BUILD_DIR}/libraries/libfc-lite;${_SYSIO_BUILD_DIR}/libraries/chaindb;${_SYSIO_BUILD_DIR}/libraries/builtins;${_SYSIO_BUILD_DIR}/libraries/testing;${_SYSIO_BUILD_DIR}/libraries/wasm-jit/Source/WAST;${_SYSIO_BUILD_DIR}/libraries/wasm-jit/Source/WASM;${_SYSIO_BUILD_DIR}/libraries/wasm-jit/Source/IR;${_SYSIO_BUILD_DIR}/libraries/wasm-jit/Source/Logging;${_SYSIO_BUILD_DIR}/vcpkg_installed/x64-linux/debug/lib" + CACHE INTERNAL "Extra library directories for SysioTester") + # Workaround older generated SysioTester.cmake that still consumes SYSIO_TESTER_ATOMIC_LIB + set(SYSIO_TESTER_ATOMIC_LIB atomic CACHE INTERNAL "Atomic lib name for SysioTester fallback") +endif () + +# Now consume sysio (which picks up SYSIO_TESTER_EXTRA_INCLUDE_DIRS) +find_package(sysio REQUIRED) find_path(GMP_INCLUDE_DIR NAMES gmp.h) find_library(GMP_LIBRARY gmp) @@ -12,42 +31,39 @@ find_library(GMP_LIBRARY gmp) ### Check the version of sysio set(VERSION_MATCH_ERROR_MSG "") SYSIO_CHECK_VERSION(VERSION_OUTPUT "${SYSIO_VERSION}" - "${SYSIO_VERSION_MIN}" - "${SYSIO_VERSION_SOFT_MAX}" - "${SYSIO_VERSION_HARD_MAX}" - VERSION_MATCH_ERROR_MSG) -if(VERSION_OUTPUT STREQUAL "MATCH") - message(STATUS "Using wire-sysio version ${SYSIO_VERSION}") -elseif(VERSION_OUTPUT STREQUAL "WARN") - message(WARNING "Using wire-sysio version ${SYSIO_VERSION} even though it exceeds the maximum supported version of ${SYSIO_VERSION_SOFT_MAX}; continuing with configuration, however build may fail.\nIt is recommended to use Leap version ${SYSIO_VERSION_SOFT_MAX}.x") -else() # INVALID OR MISMATCH - message(FATAL_ERROR "Found wire-sysio version ${SYSIO_VERSION} but it does not satisfy version requirements: ${VERSION_MATCH_ERROR_MSG}\nPlease use Leap version ${SYSIO_VERSION_SOFT_MAX}.x") -endif(VERSION_OUTPUT STREQUAL "MATCH") + "${SYSIO_VERSION_MIN}" + "${SYSIO_VERSION_SOFT_MAX}" + "${SYSIO_VERSION_HARD_MAX}" + VERSION_MATCH_ERROR_MSG) +if (VERSION_OUTPUT STREQUAL "MATCH") + message(STATUS "Using wire-sysio version ${SYSIO_VERSION}") +elseif (VERSION_OUTPUT STREQUAL "WARN") + message(WARNING "Using wire-sysio version ${SYSIO_VERSION} even though it exceeds the maximum supported version of ${SYSIO_VERSION_SOFT_MAX}; continuing with configuration, however build may fail.\nIt is recommended to use Leap version ${SYSIO_VERSION_SOFT_MAX}.x") +else () # INVALID OR MISMATCH + message(FATAL_ERROR "Found wire-sysio version ${SYSIO_VERSION} but it does not satisfy version requirements: ${VERSION_MATCH_ERROR_MSG}\nPlease use Leap version ${SYSIO_VERSION_SOFT_MAX}.x") +endif (VERSION_OUTPUT STREQUAL "MATCH") enable_testing() configure_file(${CMAKE_SOURCE_DIR}/contracts.hpp.in ${CMAKE_BINARY_DIR}/contracts.hpp) - include_directories(${CMAKE_BINARY_DIR}) file(GLOB INT_TESTS "*.cpp" "*.hpp") -add_sysio_test_executable( integration_tests ${INT_TESTS} ) - -target_link_libraries( integration_tests ${GMP_LIBRARY} ) - -foreach(TEST_SUITE ${INT_TESTS}) # create an independent target for each test suite - execute_process(COMMAND bash -c "grep -E 'BOOST_AUTO_TEST_SUITE\\s*[(]' ${TEST_SUITE} | grep -vE '//.*BOOST_AUTO_TEST_SUITE\\s*[(]' | cut -d ')' -f 1 | cut -d '(' -f 2" OUTPUT_VARIABLE SUITE_NAME OUTPUT_STRIP_TRAILING_WHITESPACE) # get the test suite name from the *.cpp file - if (NOT "" STREQUAL "${SUITE_NAME}") # ignore empty lines - execute_process(COMMAND bash -c "echo ${SUITE_NAME} | sed -e 's/s$//' | sed -e 's/_test$//'" OUTPUT_VARIABLE TRIMMED_SUITE_NAME OUTPUT_STRIP_TRAILING_WHITESPACE) # trim "_test" or "_tests" from the end of ${SUITE_NAME} - # to run unit_test with all log from blockchain displayed, put "--verbose" after "--", i.e. "unit_test -- --verbose" - add_test(NAME ${TRIMMED_SUITE_NAME}_integration_test COMMAND integration_tests --run_test=${SUITE_NAME} --report_level=detailed --color_output) - # build list of tests to run during coverage testing - if(ctest_tests) - string(APPEND ctest_tests "|") - endif() - string(APPEND ctest_tests ${TRIMMED_SUITE_NAME}_integration_test) - endif() -endforeach(TEST_SUITE) +add_sysio_test_executable(integration_tests ${INT_TESTS}) + +foreach (TEST_SUITE ${INT_TESTS}) # create an independent target for each test suite + execute_process(COMMAND bash -c "grep -E 'BOOST_AUTO_TEST_SUITE\\s*[(]' ${TEST_SUITE} | grep -vE '//.*BOOST_AUTO_TEST_SUITE\\s*[(]' | cut -d ')' -f 1 | cut -d '(' -f 2" OUTPUT_VARIABLE SUITE_NAME OUTPUT_STRIP_TRAILING_WHITESPACE) # get the test suite name from the *.cpp file + if (NOT "" STREQUAL "${SUITE_NAME}") # ignore empty lines + execute_process(COMMAND bash -c "echo ${SUITE_NAME} | sed -e 's/s$//' | sed -e 's/_test$//'" OUTPUT_VARIABLE TRIMMED_SUITE_NAME OUTPUT_STRIP_TRAILING_WHITESPACE) # trim "_test" or "_tests" from the end of ${SUITE_NAME} + # to run unit_test with all log from blockchain displayed, put "--verbose" after "--", i.e. "unit_test -- --verbose" + add_test(NAME ${TRIMMED_SUITE_NAME}_integration_test COMMAND integration_tests --run_test=${SUITE_NAME} --report_level=detailed --color_output) + # build list of tests to run during coverage testing + if (ctest_tests) + string(APPEND ctest_tests "|") + endif () + string(APPEND ctest_tests ${TRIMMED_SUITE_NAME}_integration_test) + endif () +endforeach (TEST_SUITE) set(ctest_tests "'${ctest_tests}' -j8") # surround test list string in apostrophies diff --git a/tests/integration/instant_finality_tests.cpp b/tests/integration/instant_finality_tests.cpp index 9cd6b8f5d..4c4a1a64d 100644 --- a/tests/integration/instant_finality_tests.cpp +++ b/tests/integration/instant_finality_tests.cpp @@ -36,7 +36,7 @@ BOOST_FIXTURE_TEST_CASE(instant_finality_test, tester) try { std::string output_json = fc::json::to_pretty_string(pretty_output); BOOST_TEST(output_json.find("finality_extension") != std::string::npos); - BOOST_TEST(output_json.find("\"generation\": 2") != std::string::npos); + BOOST_TEST(output_json.find("\"generation\": 3") != std::string::npos); BOOST_TEST(output_json.find("\"threshold\": 1") != std::string::npos); BOOST_TEST(output_json.find("\"description\": \"test_desc\"") != std::string::npos); BOOST_TEST(output_json.find("\"weight\": 1") != std::string::npos);