Disable BFT in CCF releases (#2359)

.azure-pipelines-templates/install.yml

@@ -23,7 +23,7 @@ steps:
 
   - script: |
       sudo apt -y install ./$(pkgname)
-      cat /tmp/install_prefix | xargs -i bash -c "PYTHON_PACKAGE_PATH=../python ./test_install.sh {}"
+      cat /tmp/install_prefix | xargs -i bash -c "PYTHON_PACKAGE_PATH=../python ./test_install.sh {} release"
     workingDirectory: build
     displayName: Test installed CCF
 

.azure-pipelines-templates/matrix.yml

@@ -26,6 +26,8 @@ parameters:
       cmake_args: "-DCMAKE_BUILD_TYPE=Debug -DBUILD_SMALLBANK=OFF -DBUILD_TPCC=OFF"
     perf:
       cmake_args: '-DBUILD_UNIT_TESTS=OFF -DDISTRIBUTE_PERF_TESTS="`../.nodes.sh`"'
+    release:
+      cmake_args: "-DTLS_TEST=ON -DENABLE_BFT=OFF"
 
   test:
     NoSGX:
@@ -67,7 +69,7 @@ jobs:
         parameters:
           target: SGX
           env: ${{ parameters.env.SGX }}
-          cmake_args: "${{ parameters.build.common.cmake_args }} -DTLS_TEST=ON"
+          cmake_args: "${{ parameters.build.common.cmake_args }} ${{ parameters.build.release.cmake_args }}"
           suffix: "Release"
           artifact_name: "SGX_Release"
 

CMakeLists.txt

@@ -47,7 +47,11 @@ configure_file(
 )
 configure_file(${CCF_DIR}/python/setup.py.in ${CCF_DIR}/python/setup.py @ONLY)
 
-set(CONSENSUSES cft bft)
+if(ENABLE_BFT)
+  set(CONSENSUSES cft bft)
+else()
+  set(CONSENSUSES cft)
+endif()
 
 option(BUILD_TESTS "Build tests" ON)
 option(BUILD_UNIT_TESTS "Build unit tests" ON)

cmake/common.cmake

@@ -50,6 +50,11 @@ option(COVERAGE "Enable coverage mapping" OFF)
 option(SHUFFLE_SUITE "Shuffle end to end test suite" OFF)
 option(LONG_TESTS "Enable long end-to-end tests" OFF)
 
+option(ENABLE_BFT "Enable experimental BFT consensus at compile time" ON)
+if(ENABLE_BFT)
+  add_compile_definitions(ENABLE_BFT)
+endif()
+
 option(DEBUG_CONFIG "Enable non-production options options to aid debugging"
        OFF
 )

src/enclave/main.cpp

@@ -56,6 +56,15 @@ extern "C"
       return false;
     }
 
+#ifndef ENABLE_BFT
+    // As BFT consensus is currently experimental, disable it in release
+    // enclaves
+    if (consensus_type != ConsensusType::CFT)
+    {
+      return false;
+    }
+#endif
+
     num_pending_threads = (uint16_t)num_worker_threads + 1;
 
     if (

src/host/main.cpp

@@ -784,6 +784,17 @@ int main(int argc, char** argv)
       LOG_FATAL_FMT("Start command should be start|join|recover. Exiting.");
     }
 
+    if (consensus == ConsensusType::BFT)
+    {
+#ifdef ENABLE_BFT
+      LOG_INFO_FMT(
+        "Selected consensus BFT is experimental in {}", ccf::ccf_version);
+#else
+      LOG_FAIL_FMT(
+        "Selected consensus BFT is not supported in {}", ccf::ccf_version);
+#endif
+    }
+
     enclave.create_node(
       enclave_config,
       ccf_config,

tests/test_install.sh

@@ -1,19 +1,42 @@
 #!/bin/bash
 # Copyright (c) Microsoft Corporation. All rights reserved.
 # Licensed under the Apache 2.0 License.
-set -ex
+set -e
 
 function service_http_status()
 {
     curl -o /dev/null -s https://127.0.0.1:8000/app/commit -w "%{http_code}" --key ./workspace/sandbox_common/user0_privk.pem --cert ./workspace/sandbox_common/user0_cert.pem --cacert ./workspace/sandbox_common/networkcert.pem
 }
 
-if [ "$#" -ne 1 ]; then
+function poll_for_service_open()
+{
+    network_live_time=$1
+    polls=0
+    while [ ! "$(service_http_status)" == "200" ] && [ "${polls}" -lt "${network_live_time}" ]; do
+        echo "Waiting for service to open..."
+        polls=$((polls+1))
+        sleep 1
+    done
+
+    if [ "$(service_http_status)" == "200" ]; then
+        return 1
+    fi
+
+    return 0
+}
+
+if [ "$#" -lt 1 ]; then
     echo "Install prefix should be passed as first argument to $0"
     exit 1
 fi
 
-echo "Install prefix is ${1}"
+# If "release" is passed as second argument to the script, run additional
+# tests at the end of this script
+is_release=false
+if [ "${2}" == "release" ]; then
+    echo "Testing release"
+    is_release=true
+fi
 
 # Setup env
 INSTALL_PREFIX="$1"
@@ -30,15 +53,7 @@ network_live_time=60
 timeout --signal=SIGINT --kill-after=${network_live_time}s --preserve-status ${network_live_time}s \
 "$INSTALL_PREFIX"/bin/sandbox.sh -e release --verbose &
 
-# Poll until service is open
-polls=0
-while [ ! "$(service_http_status)" == "200" ] && [ ${polls} -lt ${network_live_time} ]; do
-    echo "Waiting for service to open..."
-    polls=$((polls+1))
-    sleep 1
-done
-
-if [ ! "$(service_http_status)" == "200" ]; then
+if poll_for_service_open ${network_live_time}; then
     echo "Error: Timeout waiting for service to open"
     kill "$(jobs -p)"
     exit 1
@@ -74,3 +89,18 @@ timeout --signal=SIGINT --kill-after=${recovered_network_live_time}s --preserve-
     --ledger-dir 0.ledger \
     --common-dir ./workspace/sandbox_common/
 
+# If the install is a release, run additional tests. Otherwise, exit successfully.
+if [ "$is_release" == false ]; then
+    exit 0
+fi
+
+# In release, running a BFT service should not be possible
+network_live_time=30
+timeout --signal=SIGINT --kill-after=${network_live_time}s --preserve-status ${network_live_time}s \
+"$INSTALL_PREFIX"/bin/sandbox.sh -e release --consensus=bft --verbose &
+
+if ! poll_for_service_open ${network_live_time}; then
+    echo "Error: Experimental BFT consensus should not be allowed in release install"
+    kill "$(jobs -p)"
+    exit 1
+fi