Merge pull request #97 from registreerocks/build-add-all.sh

build: add all.sh (plus README updates)

Author: PiDelport

README.md

@@ -21,30 +21,16 @@ Use `docker-compose run dev` to start the dev container. This will put you in an
 
 To run the application inside of the container, do `cd rtc-data` and then `./runall.sh`
 
-## Running tests
+## Helper scripts
 
-Helper script:
+Check, build, and test everything:
 
 ```shell
-./runtests.sh
+./all.sh
 ```
 
-Currently, some tests with static mocks can intermittently fail due to test thread concurrency.
-(For example, see test `rtc_enclave::tests::dcap_azure_attestation_works`.)
-
-To avoid this, run:
+Run tests :
 
 ```shell
-cargo test -- --test-threads=1
-```
-
-or set:
-
-```shell
-export RUST_TEST_THREADS=1
+./runtests.sh
 ```
-
-TODO(Pi): We should probably configure single-threading by default in affected crates
-once `cargo test` implements this:
-
-* [Enable specifying --test-threads in Cargo.toml #8430](https://github.com/rust-lang/cargo/issues/8430)

_hack_timestamp.sh

@@ -0,0 +1,16 @@
+#!/bin/sh -e
+
+# See all.sh
+#
+# This works around cargo rebuilding sgx_unwind unnecessarily due to config.h.in* churn.
+# Run this before (and/or after) each relevant cargo invocation.
+
+# See "Pinning SGX dependencies" in HACKING.md.
+# This revision should match the Rust SGX SDK revision we're pinned to.
+base='/root/.cargo/git/checkouts/incubator-teaclave-sgx-sdk-c63c8825343e87f0/b9d1bda/sgx_unwind/libunwind'
+
+if test -e "$base"; then
+  touch --reference "$base/configure.in" "$base/include/config.h.in" "$base/include/config.h.in~"
+else
+  echo "$0: warning: missing $base"
+fi

all.sh

@@ -0,0 +1,53 @@
+#!/bin/sh -e
+# Check, build, and test everything
+
+echo "################################################################################"
+echo "# make enclaves"
+echo "################################################################################"
+for enclave in 'rtc_data_enclave' 'rtc_auth_enclave' 'rtc_exec_enclave'; do
+  ./_hack_timestamp.sh
+  (cd "$enclave" && make)
+done
+
+# TODO: doc --document-private-items
+for action in check build doc test; do
+
+  for root in rtc_tenclave rtc_data_enclave rtc_auth_enclave rtc_exec_enclave .; do
+
+    args=''
+    case "$root $action" in
+
+      # Skip enclave tests: not supported yet.
+      'rtc_'*'_enclave test') continue ;;
+
+      # Only the root project can build all targets, so far
+      '. build') args='--all-targets' ;;
+
+
+      # FIXME: Skip enclave docs for now: rustdoc doesn't support const_evaluatable_checked yet.
+      # Issue: https://github.com/rust-lang/rust/issues/77647
+      'rtc_'*'enclave doc') continue ;;
+
+      # FIXME: Only the rtc_types docs build successfully right now.
+      '. doc') args='--no-deps --package rtc_types' ;;
+
+      # Skip documenting dependencies, by default
+      *' doc') args='--no-deps' ;;
+
+      # rtc_tenclave can test, but only with --no-default-features
+      'rtc_tenclave test') args='--no-default-features' ;;
+
+    esac
+
+    # Show a big banner to make it easier to find and re-run failing commands.
+    echo "################################################################################"
+    echo "# (cd $root && cargo $action $args)"
+    echo "################################################################################"
+    ./_hack_timestamp.sh
+    (cd "$root" && cargo "$action" $args)
+  done
+
+done
+
+# Final timestamp reset, for good measure.
+./_hack_timestamp.sh