Add checks for environment completness (and fix a couple places where…

… it was not) slight modification on code from @Gflyer, separated the environment check into runtime and build time variable checks. Note that this reflects the reality of current dependencies (and we should always be looking for ways to reduce the dependencies). It also does not check for additional variables required for HW mode support. Signed-off-by: Mic Bowman <[email protected]>
hyperledger-labs · Jan 24, 2024 · 1204450 · 1204450
1 parent b03dfb3
commit 1204450
Show file tree

Hide file tree

Showing 33 changed files with 81 additions and 17 deletions.
diff --git a/bin/lib/common.sh b/bin/lib/common.sh
@@ -47,7 +47,7 @@ function yell () {
 }
 
 function die() {
-    recho "$(basename $0): $*" >&2
+    recho "$(basename $0): ERROR: $*" >&2
     exit 111
 }
 
@@ -80,12 +80,41 @@ function force_to_ip()
 }
 
 # -----------------------------------------
-# Check the environment for completeness
+# Check for build time environment variables
 # -----------------------------------------
-: "${PDO_HOME:-$(die Missing environment variable PDO_HOME)}"
-: "${PDO_HOSTNAME:-$(die Missing environment variable PDO_HOSTNAME)}"
-: "${PDO_INTERPRETER:-$(die Missing environment variable PDO_INTERPRETER)}"
-: "${PDO_LEDGER_KEY_ROOT:-$(die Missing environment variable PDO_LEDGER_KEY_ROOT)}"
-: "${PDO_LEDGER_TYPE:-$(die Missing environment variable PDO_LEDGER_TYPE)}"
-: "${PDO_LEDGER_URL:-$(die Missing environment variable PDO_LEDGER_URL)}"
-: "${PDO_SOURCE_ROOT:-$(die Missing environment variable PDO_SOURCE_ROOT)}"
+function check_pdo_build_env()
+{
+    # note: despite the 'die' below this does _not_ terminate, just prints error!
+    : "${PDO_SOURCE_ROOT:-$(die Missing environment variable PDO_SOURCE_ROOT)}"
+    : "${PDO_HOME:-$(die Missing environment variable PDO_HOME)}"
+    : "${PDO_INTERPRETER:-$(die Missing environment variable PDO_INTERPRETER)}"
+    : "${PDO_LEDGER_TYPE:-$(die Missing environment variable PDO_LEDGER_TYPE)}"
+    : "${PDO_LEDGER_KEY_ROOT:-$(die Missing environment variable PDO_LEDGER_KEY_ROOT)}"
+}
+
+# -----------------------------------------
+# Check for runtime environment variables
+# -----------------------------------------
+function check_pdo_runtime_env()
+{
+    # PDO_SOURCE_ROOT is a runtime dependency we should remove
+    : "${PDO_SOURCE_ROOT:-$(die Missing environment variable PDO_SOURCE_ROOT)}"
+
+    # Base path for finding libraries and configuration files
+    : "${PDO_HOME:-$(die Missing environment variable PDO_HOME)}"
+
+    # Used for building contracts
+    : "${PDO_INTERPRETER:-$(die Missing environment variable PDO_INTERPRETER)}"
+
+    # Used for selection of key formats
+    : "${PDO_LEDGER_TYPE:-$(die Missing environment variable PDO_LEDGER_TYPE)}"
+
+    # Used to find the ledger keys
+    : "${PDO_LEDGER_KEY_ROOT:-$(die Missing environment variable PDO_LEDGER_KEY_ROOT)}"
+
+    # Used to find the ledger
+    : "${PDO_LEDGER_URL:-$(die Missing environment variable PDO_LEDGER_URL)}"
+
+    # Used to identify the interface for services
+    : "${PDO_HOSTNAME:-$(die Missing environment variable PDO_HOSTNAME)}"
+}
diff --git a/build/__tools__/build.sh b/build/__tools__/build.sh
@@ -20,6 +20,7 @@ SCRIPTDIR="$(dirname $(readlink --canonicalize ${BASH_SOURCE}))"
 SRCDIR="$(realpath ${SCRIPTDIR}/../..)"
 
 source ${SRCDIR}/bin/lib/common.sh
+check_pdo_build_env
 check_python_version
 
 # Automatically determine how many cores the host system has

diff --git a/build/__tools__/clean.sh b/build/__tools__/clean.sh
@@ -18,6 +18,7 @@ SCRIPTDIR="$(dirname $(readlink --canonicalize ${BASH_SOURCE}))"
 SRCDIR="$(realpath ${SCRIPTDIR}/../..)"
 
 source ${SRCDIR}/bin/lib/common.sh
+check_pdo_build_env
 check_python_version
 
 # -----------------------------------------------------------------

diff --git a/build/__tools__/run-benchmarks.sh b/build/__tools__/run-benchmarks.sh
@@ -20,6 +20,7 @@ SCRIPTDIR="$(dirname $(readlink --canonicalize ${BASH_SOURCE}))"
 SRCDIR="$(realpath ${SCRIPTDIR}/../..)"
 
 source ${SRCDIR}/bin/lib/common.sh
+check_pdo_runtime_env
 check_python_version
 
 # -----------------------------------------------------------------

diff --git a/build/__tools__/run-perf-tests.sh b/build/__tools__/run-perf-tests.sh
@@ -20,6 +20,7 @@ SCRIPTDIR="$(dirname $(readlink --canonicalize ${BASH_SOURCE}))"
 SRCDIR="$(realpath ${SCRIPTDIR}/../..)"
 
 source ${SRCDIR}/bin/lib/common.sh
+check_pdo_runtime_env
 check_python_version
 
 # -----------------------------------------------------------------

diff --git a/build/__tools__/run-tests.sh b/build/__tools__/run-tests.sh
@@ -17,6 +17,7 @@
 # -----------------------------------------------------------------
 # -----------------------------------------------------------------
 source ${PDO_SOURCE_ROOT}/bin/lib/common.sh
+check_pdo_runtime_env
 check_python_version
 
 PDO_LOG_LEVEL=${PDO_LOG_LEVEL:-info}

diff --git a/build/__tools__/verify-pre-build.sh b/build/__tools__/verify-pre-build.sh
@@ -25,6 +25,7 @@ SCRIPTDIR="$(dirname $(readlink --canonicalize ${BASH_SOURCE}))"
 SRCDIR="$(realpath ${SCRIPTDIR}/../..)"
 
 source ${SRCDIR}/bin/lib/common.sh
+check_pdo_build_env
 
 function warn () {
     recho "WARNING: $*"

diff --git a/build/__tools__/verify-pre-conf.sh b/build/__tools__/verify-pre-conf.sh
@@ -25,6 +25,7 @@ SCRIPTDIR="$(dirname $(readlink --canonicalize ${BASH_SOURCE}))"
 SRCDIR="$(realpath ${SCRIPTDIR}/../..)"
 
 source ${SRCDIR}/bin/lib/common.sh
+check_pdo_build_env
 
 function warn () {
     recho "WARNING: $*"

diff --git a/build/tests/multi-user.sh b/build/tests/multi-user.sh
@@ -17,6 +17,7 @@
 # -----------------------------------------------------------------
 # -----------------------------------------------------------------
 source ${PDO_SOURCE_ROOT}/bin/lib/common.sh
+check_pdo_runtime_env
 check_python_version
 
 # -----------------------------------------------------------------

diff --git a/build/tests/service-test.sh b/build/tests/service-test.sh
@@ -17,6 +17,7 @@
 # -----------------------------------------------------------------
 # -----------------------------------------------------------------
 source ${PDO_SOURCE_ROOT}/bin/lib/common.sh
+check_pdo_runtime_env
 check_python_version
 
 # -----------------------------------------------------------------

diff --git a/build/tests/unit-test.sh b/build/tests/unit-test.sh
@@ -17,6 +17,7 @@
 # -----------------------------------------------------------------
 # -----------------------------------------------------------------
 source ${PDO_SOURCE_ROOT}/bin/lib/common.sh
+check_pdo_runtime_env
 check_python_version
 
 PDO_LOG_LEVEL=${PDO_LOG_LEVEL:-info}

diff --git a/common/crypto/verify_ias_report/fetch_ias_certificates.sh b/common/crypto/verify_ias_report/fetch_ias_certificates.sh
@@ -23,6 +23,7 @@
 # -----------------------------------------------------------------
 # -----------------------------------------------------------------
 source ${PDO_SOURCE_ROOT}/bin/lib/common.sh
+check_pdo_build_env
 
 IAS_CERTIFICATE_URL=$1
 

diff --git a/docker/tools/build_client.sh b/docker/tools/build_client.sh
@@ -15,9 +15,9 @@
 
 source /project/pdo/tools/environment.sh
 
-# these variables should be unused during build
-export PDO_HOSTNAME=
-export PDO_LEDGER_URL=
+# to get build without (ignored) errors
+export PDO_HOSTNAME=localhost
+export PDO_LEDGER_URL=https://127.0.0.1:6600
 
 make -C ${PDO_SOURCE_ROOT}/build environment
 make -C ${PDO_SOURCE_ROOT}/build template

diff --git a/docker/tools/build_services.sh b/docker/tools/build_services.sh
@@ -13,9 +13,9 @@
 # See the License for the specific language governing permissions and
 # limitations under the License.
 
-# these variables should be unused during build
-export PDO_HOSTNAME=
-export PDO_LEDGER_URL=
+# to get build without (ignored) errors
+export PDO_HOSTNAME=localhost
+export PDO_LEDGER_URL=https://127.0.0.1:6600
 
 source /opt/intel/sgxsdk/environment
 source /project/pdo/tools/environment.sh

diff --git a/docker/tools/run_ccf_tests.sh b/docker/tools/run_ccf_tests.sh
@@ -21,6 +21,8 @@ export PDO_HOSTNAME=localhost
 export PDO_LEDGER_ADDRESS=$(force_to_ip ${PDO_HOSTNAME})
 export PDO_LEDGER_URL="http://${PDO_LEDGER_ADDRESS}:6600"
 
+check_pdo_runtime_env
+
 export no_proxy=$PDO_HOSTNAME,$PDO_LEDGER_ADDRESS,$no_proxy
 export NO_PROXY=$PDO_HOSTNAME,$PDO_LEDGER_ADDRESS,$NO_PROXY
 

diff --git a/docker/tools/run_client_tests.sh b/docker/tools/run_client_tests.sh
@@ -14,14 +14,15 @@
 # limitations under the License.
 
 # Tests are run EXCLUSIVELY with all services running on localhost
-
 source /project/pdo/tools/environment.sh
 source ${PDO_HOME}/bin/lib/common.sh
 
 export PDO_HOSTNAME=localhost
 export PDO_LEDGER_ADDRESS=$(force_to_ip ${PDO_HOSTNAME})
 export PDO_LEDGER_URL="http://${PDO_LEDGER_ADDRESS}:6600"
 
+check_pdo_runtime_env
+
 export no_proxy=$PDO_HOSTNAME,$PDO_LEDGER_ADDRESS,$no_proxy
 export NO_PROXY=$PDO_HOSTNAME,$PDO_LEDGER_ADDRESS,$NO_PROXY
 

diff --git a/docker/tools/run_services_tests.sh b/docker/tools/run_services_tests.sh
@@ -14,7 +14,6 @@
 # limitations under the License.
 
 # Tests are run EXCLUSIVELY with all services running on localhost
-
 source /opt/intel/sgxsdk/environment
 source /project/pdo/tools/environment.sh
 source ${PDO_HOME}/bin/lib/common.sh
@@ -23,6 +22,8 @@ export PDO_HOSTNAME=localhost
 export PDO_LEDGER_ADDRESS=$(force_to_ip ${PDO_HOSTNAME})
 export PDO_LEDGER_URL="http://${PDO_LEDGER_ADDRESS}:6600"
 
+check_pdo_runtime_env
+
 export no_proxy=$PDO_HOSTNAME,$PDO_LEDGER_ADDRESS,$no_proxy
 export NO_PROXY=$PDO_HOSTNAME,$PDO_LEDGER_ADDRESS,$NO_PROXY
 

diff --git a/docker/tools/start_ccf.sh b/docker/tools/start_ccf.sh
@@ -66,6 +66,8 @@ fi
 export PDO_LEDGER_ADDRESS=$(force_to_ip ${PDO_HOSTNAME})
 export PDO_LEDGER_URL="http://${PDO_LEDGER_ADDRESS}:6600"
 
+check_pdo_runtime_env
+
 export no_proxy=$PDO_HOSTNAME,$PDO_LEDGER_ADDRESS,$no_proxy
 export NO_PROXY=$PDO_HOSTNAME,$PDO_LEDGER_ADDRESS,$NO_PROXY
 

diff --git a/docker/tools/start_client.sh b/docker/tools/start_client.sh
@@ -68,6 +68,8 @@ if [ ! -z "${F_LEDGER_URL}" ] ; then
     export PDO_LEDGER_URL=${F_LEDGER_URL}
 fi
 
+check_pdo_runtime_env
+
 export no_proxy=$PDO_HOSTNAME,$no_proxy
 export NO_PROXY=$PDO_HOSTNAME,$NO_PROXY
 

diff --git a/docker/tools/start_development.sh b/docker/tools/start_development.sh
@@ -13,6 +13,8 @@ fi
 source /project/pdo/tools/environment.sh
 source ${PDO_SOURCE_ROOT}/bin/lib/common.sh
 
+check_pdo_runtime_env
+
 export no_proxy=$PDO_HOSTNAME,$no_proxy
 export NO_PROXY=$PDO_HOSTNAME,$NO_PROXY
 

diff --git a/docker/tools/start_services.sh b/docker/tools/start_services.sh
@@ -77,6 +77,8 @@ if [ ! -z "${F_LEDGER_URL}" ] ; then
     export PDO_LEDGER_ADDRESS=$( echo $PDO_LEDGER_URL | awk -F[/:] '{print $4}' )
 fi
 
+check_pdo_runtime_env
+
 export no_proxy=$PDO_HOSTNAME,$PDO_LEDGER_ADDRESS,$no_proxy
 export NO_PROXY=$PDO_HOSTNAME,$PDO_LEDGER_ADDRESS,$NO_PROXY
 

diff --git a/eservice/bin/es-start.sh b/eservice/bin/es-start.sh
@@ -16,6 +16,7 @@
 
 F_SERVICEHOME="$( cd -P "$( dirname ${BASH_SOURCE[0]} )/.." && pwd )"
 source ${F_SERVICEHOME}/bin/lib/common.sh
+check_pdo_runtime_env
 source ${F_SERVICEHOME}/bin/lib/common_service.sh
 
 check_python_version

diff --git a/eservice/bin/es-status.sh b/eservice/bin/es-status.sh
@@ -16,6 +16,7 @@
 
 F_SERVICEHOME="$( cd -P "$( dirname ${BASH_SOURCE[0]} )/.." && pwd )"
 source ${F_SERVICEHOME}/bin/lib/common.sh
+check_pdo_runtime_env
 source ${F_SERVICEHOME}/bin/lib/common_service.sh
 
 

diff --git a/eservice/bin/es-stop.sh b/eservice/bin/es-stop.sh
@@ -16,6 +16,7 @@
 
 F_SERVICEHOME="$( cd -P "$( dirname ${BASH_SOURCE[0]} )/.." && pwd )"
 source ${F_SERVICEHOME}/bin/lib/common.sh
+check_pdo_runtime_env
 source ${F_SERVICEHOME}/bin/lib/common_service.sh
 
 

diff --git a/eservice/bin/register-with-ledger.sh b/eservice/bin/register-with-ledger.sh
@@ -29,6 +29,7 @@ PDO_IAS_KEY_PEM=${PDO_SGX_KEY_ROOT}/sgx_ias_key.pem
 eservice_enclave_info_file=$(mktemp /tmp/pdo-test.XXXXXXXXX)
 
 source ${SRCDIR}/bin/lib/common.sh
+check_pdo_runtime_env
 check_python_version
 
 function cleanup {

diff --git a/ledgers/ccf/scripts/start_ccf_network.sh b/ledgers/ccf/scripts/start_ccf_network.sh
@@ -17,6 +17,7 @@
 # -----------------------------------------------------------------
 # -----------------------------------------------------------------
 source ${PDO_HOME}/bin/lib/common.sh
+check_pdo_runtime_env
 check_python_version
 
 # -----------------------------------------------------------------

diff --git a/ledgers/ccf/scripts/stop_cchost.sh b/ledgers/ccf/scripts/stop_cchost.sh
@@ -17,6 +17,7 @@
 # -----------------------------------------------------------------
 # -----------------------------------------------------------------
 source ${PDO_HOME}/bin/lib/common.sh
+check_pdo_runtime_env
 
 if [ -f ${PDO_HOME}/ccf/workspace/sandbox_0/node.pid ]; then
     kill $(cat ${PDO_HOME}/ccf/workspace/sandbox_0/node.pid)

diff --git a/pservice/bin/ps-start.sh b/pservice/bin/ps-start.sh
@@ -16,6 +16,7 @@
 
 F_SERVICEHOME="$( cd -P "$( dirname ${BASH_SOURCE[0]} )/.." && pwd )"
 source ${F_SERVICEHOME}/bin/lib/common.sh
+check_pdo_runtime_env
 source ${F_SERVICEHOME}/bin/lib/common_service.sh
 
 check_python_version

diff --git a/pservice/bin/ps-status.sh b/pservice/bin/ps-status.sh
@@ -16,6 +16,7 @@
 
 F_SERVICEHOME="$( cd -P "$( dirname ${BASH_SOURCE[0]} )/.." && pwd )"
 source ${F_SERVICEHOME}/bin/lib/common.sh
+check_pdo_runtime_env
 source ${F_SERVICEHOME}/bin/lib/common_service.sh
 
 F_BASENAME='pservice'

diff --git a/pservice/bin/ps-stop.sh b/pservice/bin/ps-stop.sh
@@ -16,6 +16,7 @@
 
 F_SERVICEHOME="$( cd -P "$( dirname ${BASH_SOURCE[0]} )/.." && pwd )"
 source ${F_SERVICEHOME}/bin/lib/common.sh
+check_pdo_runtime_env
 source ${F_SERVICEHOME}/bin/lib/common_service.sh
 
 F_BASENAME='pservice'

diff --git a/sservice/bin/ss-start.sh b/sservice/bin/ss-start.sh
@@ -16,6 +16,7 @@
 
 F_SERVICEHOME="$( cd -P "$( dirname ${BASH_SOURCE[0]} )/.." && pwd )"
 source ${F_SERVICEHOME}/bin/lib/common.sh
+check_pdo_runtime_env
 source ${F_SERVICEHOME}/bin/lib/common_service.sh
 
 check_python_version

diff --git a/sservice/bin/ss-status.sh b/sservice/bin/ss-status.sh
@@ -16,6 +16,7 @@
 
 F_SERVICEHOME="$( cd -P "$( dirname ${BASH_SOURCE[0]} )/.." && pwd )"
 source ${F_SERVICEHOME}/bin/lib/common.sh
+check_pdo_runtime_env
 source ${F_SERVICEHOME}/bin/lib/common_service.sh
 
 

diff --git a/sservice/bin/ss-stop.sh b/sservice/bin/ss-stop.sh
@@ -16,6 +16,7 @@
 
 F_SERVICEHOME="$( cd -P "$( dirname ${BASH_SOURCE[0]} )/.." && pwd )"
 source ${F_SERVICEHOME}/bin/lib/common.sh
+check_pdo_runtime_env
 source ${F_SERVICEHOME}/bin/lib/common_service.sh
 
 F_BASENAME='sservice'