RUST-1283 Build docs in read-only directory and install cargo and rustup in project directory on Evergreen (#656)

* build docs in read-only directory
* install cargo and rustup in project dir on Evg
* check clippy and rustdoc with all available features

Author: kmahar

.evergreen/check-all.sh

@@ -1,4 +1,4 @@
-#!/bin/sh
+#!/bin/bash
 
 set -o errexit
 

.evergreen/check-clippy.sh

@@ -1,13 +1,13 @@
-#!/bin/sh
+#!/bin/bash
 
 set -o errexit
 
-. ~/.cargo/env
+source ./.evergreen/configure-rust.sh
 # Pin clippy to the lastest version. This should be updated when new versions of Rust are released.
 rustup default 1.59.0
-cargo clippy --all-targets -p mongodb -- -D warnings
-# check clippy with compressors separately
-cargo clippy --all-targets -p mongodb --features zstd-compression,snappy-compression,zlib-compression -- -D warnings
-cargo clippy --all-targets --no-default-features --features async-std-runtime -p mongodb -- -D warnings
-cargo clippy --all-targets --no-default-features --features sync -p mongodb -- -D warnings
-cargo clippy --all-targets --features tokio-sync -p mongodb -- -D warnings
+
+source ./.evergreen/feature-combinations.sh
+
+for ((i = 0; i < ${#FEATURE_COMBINATIONS[@]}; i++)); do
+    cargo clippy --all-targets ${FEATURE_COMBINATIONS[$i]}  -p mongodb -- -D warnings
+done

.evergreen/check-rustdoc.sh

@@ -1,9 +1,27 @@
-#!/bin/sh
+#!/bin/bash
 
 set -o errexit
 
-. ~/.cargo/env
-cargo +nightly rustdoc -- -D warnings --cfg docsrs
-cargo +nightly rustdoc --no-default-features --features async-std-runtime -- -D warnings --cfg docsrs
-cargo +nightly rustdoc --no-default-features --features sync -- -D warnings --cfg docsrs
-cargo +nightly rustdoc --features tokio-sync -- -D warnings --cfg docsrs
+source ./.evergreen/configure-rust.sh
+
+# docs.rs builds the driver on a read-only file system. to create a more realistic environment, we first
+# build the driver to ensure we have all the deps already in src, and then limit the permissions on that directory
+# and rebuild the docs.
+# this is to help us avoid introducing problems like those described here 
+# https://docs.rs/about/builds#read-only-directories where we or a dependency modify source code during the
+# build process.
+
+source ./.evergreen/feature-combinations.sh
+
+# build with all available features to ensure all optional dependencies are brought in too.
+for ((i = 0; i < ${#FEATURE_COMBINATIONS[@]}; i++)); do
+    cargo +nightly build ${FEATURE_COMBINATIONS[$i]}
+done
+cargo clean
+
+chmod -R 555 ${CARGO_HOME}/registry/src
+
+for ((i = 0; i < ${#FEATURE_COMBINATIONS[@]}; i++)); do
+    cargo +nightly rustdoc ${FEATURE_COMBINATIONS[$i]} -- -D warnings --cfg docsrs
+done
+

.evergreen/check-rustfmt.sh

@@ -2,6 +2,6 @@
 
 set -o errexit
 
-. ~/.cargo/env
+source ./.evergreen/configure-rust.sh
 rustfmt +nightly --unstable-features --check src/**/*.rs
 rustfmt +nightly --unstable-features --check src/*.rs

.evergreen/compile-only-async-std.sh

@@ -1,8 +1,8 @@
-#!/bin/sh
+#!/bin/bash
 
 set -o errexit
 
-. ~/.cargo/env
+source ./.evergreen/configure-rust.sh
 
 rustup run $RUST_VERSION cargo build --no-default-features --features async-std-runtime
 rustup run $RUST_VERSION cargo build --no-default-features --features sync

.evergreen/compile-only-tokio.sh

@@ -1,8 +1,8 @@
-#!/bin/sh
+#!/bin/bash
 
 set -o errexit
 
-. ~/.cargo/env
+source ./.evergreen/configure-rust.sh
 
 # Enable snappy, zlib unconditionally
 FEATURE_FLAGS=snappy-compression,zlib-compression

.evergreen/compile-only.sh

@@ -1,8 +1,8 @@
-#!/bin/sh
+#!/bin/bash
 
 set -o errexit
 
-. ~/.cargo/env
+source ./.evergreen/configure-rust.sh
 rustup update $RUST_VERSION
 
 if [ "$ASYNC_RUNTIME" = "tokio" ]; then

.evergreen/config.yml

@@ -252,6 +252,7 @@ functions:
     - command: shell.exec
       type: test
       params:
+        shell: bash
         working_dir: "src"
         script: |
           ${PREPARE_SHELL}
@@ -265,7 +266,7 @@ functions:
 
           # compile mini test project
           cd $PROJECT_DIRECTORY/.evergreen/aws-ecs-test
-          . ~/.cargo/env
+          . ${PROJECT_DIRECTORY}/.evergreen/configure-rust.sh
           cargo build
           cd -
 
@@ -431,6 +432,7 @@ functions:
           export MONGO_ATLAS_TLS11_URI_SRV='${MONGO_ATLAS_TLS11_URI_SRV}'
           export MONGO_ATLAS_TLS12_URI='${MONGO_ATLAS_TLS12_URI}'
           export MONGO_ATLAS_TLS12_URI_SRV='${MONGO_ATLAS_TLS12_URI_SRV}'
+          export PROJECT_DIRECTORY='${PROJECT_DIRECTORY}'
           ASYNC_RUNTIME=${ASYNC_RUNTIME} .evergreen/run-atlas-tests.sh
 
   "run ocsp test":
@@ -617,7 +619,6 @@ functions:
       params:
         script: |
           ${PREPARE_SHELL}
-          rm -rf ~/.rustup
           rm -rf $DRIVERS_TOOLS || true
 
   "fix absolute paths":

.evergreen/configure-rust.sh

@@ -0,0 +1,14 @@
+#!/bin/bash
+
+export RUSTUP_HOME="${PROJECT_DIRECTORY}/.rustup"
+export PATH="${RUSTUP_HOME}/bin:$PATH"
+export CARGO_HOME="${PROJECT_DIRECTORY}/.cargo"
+export PATH="${CARGO_HOME}/bin:$PATH"
+
+if [[ "Windows_NT" == "$OS" ]]; then
+    # rustup/cargo need the native Windows paths; $PROJECT_DIRECTORY is a cygwin path
+    export RUSTUP_HOME=$(cygpath ${RUSTUP_HOME} --windows)
+    export CARGO_HOME=$(cygpath ${CARGO_HOME} --windows)
+fi
+
+. ${CARGO_HOME}/env

.evergreen/env.sh

@@ -1,8 +1,6 @@
 #!/bin/bash
 
-export PATH="/opt/mongodbtoolchain/v2/bin:$PATH"
-
-source ~/.cargo/env
+source ./.evergreen/configure-rust.sh
 
 NODE_ARTIFACTS_PATH="${PROJECT_DIRECTORY}/node-artifacts"
 export NVM_DIR="${NODE_ARTIFACTS_PATH}/nvm"