GODRIVER-2989 A Dockerfile for local development

.evergreen/run-tests.sh

@@ -4,7 +4,11 @@ set -o errexit
 
 export GOPATH=$(dirname $(dirname $(dirname `pwd`)))
 export GOCACHE="$(pwd)/.cache"
-export DRIVERS_TOOLS="$(pwd)/../drivers-tools"
+export DRIVERS_TOOLS=${DRIVERS_TOOLS:-""}
+
+if [ -z $DRIVERS_TOOLS ]; then
+  export DRIVERS_TOOLS="$(pwd)/../drivers-tools"
+fi
 
 if [ "Windows_NT" = "$OS" ]; then
     export GOPATH=$(cygpath -m $GOPATH)
@@ -14,6 +18,7 @@ fi
 
 export GOROOT="${GOROOT}"
 export PATH="${GOROOT}/bin:${GCC_PATH}:$GOPATH/bin:$PATH"
+export PATH="$DRIVERS_TOOLS/mongodb/bin:$PATH"
 export PROJECT="${project}"
 export PKG_CONFIG_PATH=$(pwd)/install/libmongocrypt/lib64/pkgconfig:$(pwd)/install/mongo-c-driver/lib/pkgconfig
 export LD_LIBRARY_PATH=$(pwd)/install/libmongocrypt/lib64

.gitignore

@@ -12,7 +12,9 @@ perf
 **mongocryptd.pid
 *.test
 .DS_Store
+install
 main.so
+test.suite
 
 # AWS SAM-generated files
 internal/test/faas/awslambda/.aws-sam

Dockerfile

@@ -0,0 +1,30 @@
+FROM ubuntu:22.04
+
+RUN apt-get -qq update && apt-get -qqy -o DPkg::Lock::Timeout=-1 install --no-install-recommends \
+  git \
+  ca-certificates \
+  curl \
+  wget \
+  sudo \
+  gnupg \
+  python3 \
+  python3.10-venv \
+  build-essential \
+  golang-go \
+  pkg-config \
+  libssl-dev \
+  make \
+  lsof \
+  net-tools \
+ && rm -rf /var/lib/apt/lists/*
+
+RUN export LIBMONGOCRYPT_TAG="1.8.0-alpha1" && \
+    cd $HOME && \
+    git clone https://github.com/mongodb/libmongocrypt --depth=1 --branch $LIBMONGOCRYPT_TAG && \
+    PKG_CONFIG_PATH=$HOME/install/libmongocrypt/lib/pkgconfig:$HOME/install/mongo-c-driver/lib/pkgconfig \
+    LD_LIBRARY_PATH=$HOME/install/libmongocrypt/lib \
+    ./libmongocrypt/.evergreen/compile.sh
+
+COPY ./etc/docker_entry.sh /root/docker_entry.sh
+
+ENTRYPOINT ["/bin/bash", "/root/docker_entry.sh"]

docs/CONTRIBUTING.md

@@ -111,6 +111,19 @@ The usage of host.docker.internal comes from the [Docker networking documentatio
 
 There is currently no arm64 support for the go1.x runtime, see [here](https://docs.aws.amazon.com/lambda/latest/dg/lambda-runtimes.html). Known issues running on linux/arm64 include the inability to network with the localhost from the public.ecr.aws/lambda/go Docker image.
 
+### Testing in Docker
+
+We have a ``Dockerfile`` and supporting files to be used for local testing in a Linux environment.
+Ensure ``docker`` is installed and running, and then run:
+
+```bash
+bash etc/run_docker.sh
+```
+
+The script takes an optional argument for the ``MAKEFILE_TARGET`` and allows for some environment variable overrides.
+The docker container will have the required binaries, including libmongocrypt.
+The entry script starts a mongodb topology, and then executes the desired ``MAKEFILE_TARGET``.
+
 ## Talk To Us
 
 If you want to work on the driver, write documentation, or have questions/complaints, please reach out to us either via [MongoDB Community Forums](https://community.mongodb.com/tags/c/drivers-odms-connectors/7/go-driver) or by creating a Question issue in [Jira](https://jira.mongodb.org/secure/CreateIssue!default.jspa).

etc/docker_entry.sh

@@ -0,0 +1,29 @@
+#!/usr/bin/env bash
+#
+# Entry point for Dockerfile for launching a server and running a go test.
+#
+set -eux
+
+# Handle env variables.
+export DRIVERS_TOOLS=$HOME/drivers-evergreen-tools
+export PROJECT_ORCHESTRATION_HOME=$DRIVERS_TOOLS/.evergreen/orchestration
+export MONGO_ORCHESTRATION_HOME=$HOME
+
+# Clone DRIVERS_TOOLS if necessary.
+if [ ! -d $DRIVERS_TOOLS ]; then
+    git clone https://github.com/mongodb-labs/drivers-evergreen-tools.git $DRIVERS_TOOLS
+fi
+
+# Disable ipv6.
+sed -i "s/\"ipv6\": true,/\"ipv6\": false,/g" $PROJECT_ORCHESTRATION_HOME/configs/${TOPOLOGY}s/$ORCHESTRATION_FILE
+
+# Start the server.
+bash $DRIVERS_TOOLS/.evergreen/run-orchestration.sh
+
+# Prep files.
+cd /src
+rm -f test.suite
+cp -r $HOME/install ./install
+
+# Run the test.
+bash ./.evergreen/run-tests.sh

etc/run_docker.sh

@@ -0,0 +1,21 @@
+#!/usr/bin/env bash
+#
+# Script to run a test suite in docker locally
+set -eux
+docker build -t go-test .
+
+# Handle environment variables and optional positional arg for the makefile target.
+MAKEFILE_TARGET=${1:-evg-test-versioned-api}
+MONGODB_VERSION=${MONGODB_VERSION:-latest}
+TOPOLOGY=${TOPOLOGY:-replica_set}
+ORCHESTRATION_FILE=${ORCHESTRATION_FILE:-basic.json}
+AUTH=${AUTH:-""}
+SSL=${SSL:=""}
+GO_BUILD_TAGS=${GO_BUILD_TAGS:-""}
+
+ENV="-e MONGODB_VERSION=$MONGODB_VERSION -e TOPOLOGY=$TOPOLOGY"
+ENV="$ENV -e MAKEFILE_TARGET=$MAKEFILE_TARGET -e AUTH=$AUTH"
+ENV="$ENV -e ORCHESTRATION_FILE=$ORCHESTRATION_FILE -e SSL=$SSL"
+ENV="$ENV -e GO_BUILD_TAGS=$GO_BUILD_TAGS"
+docker run --rm -v "`pwd`:/src" $ENV -it go-test
+tail test.suite