-
Notifications
You must be signed in to change notification settings - Fork 671
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
[antithesis] Refactor image build for reuse by other repos (#3198)
- Loading branch information
Showing
12 changed files
with
275 additions
and
197 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,110 @@ | ||
| #!/usr/bin/env bash | ||
|
|
||
| set -euo pipefail | ||
|
|
||
| # This script defines helper functions to enable building images for antithesis test setups. It is | ||
| # intended to be reusable by repos other than avalanchego so almost all inputs are accepted as parameters | ||
| # rather than being discovered from the environment. | ||
| # | ||
| # Since this file only defines functions, it is intended to be sourced rather than executed. | ||
|
|
||
| # Build the image that enables compiling golang binaries for the node and workload image | ||
| # builds. The builder image is intended to enable building instrumented binaries if built | ||
| # on amd64 and non-instrumented binaries if built on arm64. | ||
| function build_antithesis_builder_image { | ||
| local go_version=$1 | ||
| local image_name=$2 | ||
| local avalanchego_path=$3 | ||
| local target_path=$4 | ||
|
|
||
| local base_dockerfile="${avalanchego_path}/tests/antithesis/Dockerfile" | ||
| local builder_dockerfile="${base_dockerfile}.builder-instrumented" | ||
| if [[ "$(go env GOARCH)" == "arm64" ]]; then | ||
| # Antithesis instrumentation is only supported on amd64. On apple silicon (arm64), | ||
| # an uninstrumented Dockerfile will be used to enable local test development. | ||
| builder_dockerfile="${base_dockerfile}.builder-uninstrumented" | ||
| fi | ||
|
|
||
| docker buildx build --build-arg GO_VERSION="${go_version}" -t "${image_name}" -f "${builder_dockerfile}" "${target_path}" | ||
| } | ||
|
|
||
| # Build the antithesis node, workload, and config images. | ||
| function build_antithesis_images { | ||
| local go_version=$1 | ||
| local image_prefix=$2 | ||
| local base_image_name=$3 | ||
| local image_tag=$4 | ||
| local node_image_tag=$5 | ||
| local base_dockerfile=$6 | ||
| local uninstrumented_node_dockerfile=$7 | ||
| local target_path=$8 | ||
| local node_only=${9:-} | ||
|
|
||
| # Define image names | ||
| if [[ -n "${image_prefix}" ]]; then | ||
| base_image_name="${image_prefix}/${base_image_name}" | ||
| fi | ||
| local node_image_name="${base_image_name}-node:${image_tag}" | ||
| local workload_image_name="${base_image_name}-workload:${image_tag}" | ||
| local config_image_name="${base_image_name}-config:${image_tag}" | ||
|
|
||
| # Define dockerfiles | ||
| local node_dockerfile="${base_dockerfile}.node" | ||
| # Working directory for instrumented builds | ||
| local builder_workdir="/instrumented/customer" | ||
| if [[ "$(go env GOARCH)" == "arm64" ]]; then | ||
| # Antithesis instrumentation is only supported on amd64. On apple silicon (arm64), | ||
| # uninstrumented Dockerfiles will be used to enable local test development. | ||
| node_dockerfile="${uninstrumented_node_dockerfile}" | ||
| # Working directory for uninstrumented builds | ||
| builder_workdir="/build" | ||
| fi | ||
|
|
||
| # Define default build command | ||
| local docker_cmd="docker buildx build\ | ||
| --build-arg GO_VERSION=${go_version}\ | ||
| --build-arg BUILDER_IMAGE_TAG=${image_tag}\ | ||
| --build-arg BUILDER_WORKDIR=${builder_workdir}\ | ||
| --build-arg AVALANCHEGO_NODE_IMAGE=antithesis-avalanchego-node:${node_image_tag}" | ||
|
|
||
| if [[ -n "${image_prefix}" && -z "${node_only}" ]]; then | ||
| # Push images with an image prefix since the prefix defines a registry location, and only if building | ||
| # all images. When building just the node image the image is only intended to be used locally. | ||
| docker_cmd="${docker_cmd} --push" | ||
| fi | ||
|
|
||
| # Build node image first to allow the workload image to use it. | ||
| ${docker_cmd} -t "${node_image_name}" -f "${node_dockerfile}" "${target_path}" | ||
|
|
||
| if [[ -n "${node_only}" ]]; then | ||
| # Skip building the config and workload images. Supports building the avalanchego node image as the | ||
| # base image for a VM node image. | ||
| return | ||
| fi | ||
|
|
||
| # Build the config image | ||
| ${docker_cmd} -t "${config_image_name}" -f "${base_dockerfile}.config" "${target_path}" | ||
|
|
||
| # Build the workload image | ||
| ${docker_cmd} -t "${workload_image_name}" -f "${base_dockerfile}.workload" "${target_path}" | ||
| } | ||
|
|
||
| # Generate the docker compose configuration for the antithesis config image. | ||
| function gen_antithesis_compose_config { | ||
| local image_tag=$1 | ||
| local exe_path=$2 | ||
| local target_path=$3 | ||
| local extra_compose_args=${4:-} | ||
|
|
||
| if [[ -d "${target_path}" ]]; then | ||
| # Ensure the target path is empty before generating the compose config | ||
| rm -r "${target_path:?}" | ||
| fi | ||
|
|
||
| # Define the env vars for the compose config generation | ||
| local compose_env="TARGET_PATH=${target_path} IMAGE_TAG=${image_tag} ${extra_compose_args}" | ||
|
|
||
| # Generate compose config for copying into the config image | ||
| # shellcheck disable=SC2086 | ||
| env ${compose_env} go run "${exe_path}" | ||
| } |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,58 @@ | ||
| #!/usr/bin/env bash | ||
|
|
||
| set -euo pipefail | ||
|
|
||
| # Validates the compose configuration of the antithesis config image | ||
| # identified by IMAGE_NAME and IMAGE_TAG by: | ||
| # | ||
| # 1. Extracting the docker compose configuration from the image | ||
| # 2. Running the workload and its target network without error for a minute | ||
| # 3. Stopping the workload and its target network | ||
| # | ||
| # This script is intended to be sourced rather than executed directly. | ||
|
|
||
| if [[ -z "${IMAGE_NAME:-}" || -z "${IMAGE_TAG:-}" ]]; then | ||
| echo "IMAGE_NAME and IMAGE_TAG must be set" | ||
| exit 1 | ||
| fi | ||
|
|
||
| # Create a container from the config image to extract compose configuration from | ||
| CONTAINER_NAME="tmp-${IMAGE_NAME}" | ||
| docker create --name "${CONTAINER_NAME}" "${IMAGE_NAME}:${IMAGE_TAG}" /bin/true | ||
|
|
||
| # Create a temporary directory to write the compose configuration to | ||
| TMPDIR="$(mktemp -d)" | ||
| echo "using temporary directory ${TMPDIR} as the docker compose path" | ||
|
|
||
| COMPOSE_FILE="${TMPDIR}/docker-compose.yml" | ||
| COMPOSE_CMD="docker compose -f ${COMPOSE_FILE}" | ||
|
|
||
| # Ensure cleanup | ||
| function cleanup { | ||
| echo "removing temporary container" | ||
| docker rm "${CONTAINER_NAME}" | ||
| echo "stopping and removing the docker compose project" | ||
| ${COMPOSE_CMD} down --volumes | ||
| if [[ -z "${DEBUG:-}" ]]; then | ||
| echo "removing temporary dir" | ||
| rm -rf "${TMPDIR}" | ||
| fi | ||
| } | ||
| trap cleanup EXIT | ||
|
|
||
| # Copy the docker-compose.yml file out of the container | ||
| docker cp "${CONTAINER_NAME}":/docker-compose.yml "${COMPOSE_FILE}" | ||
|
|
||
| # Copy the volume paths out of the container | ||
| docker cp "${CONTAINER_NAME}":/volumes "${TMPDIR}/" | ||
|
|
||
| # Run the docker compose project for 30 seconds without error. Local | ||
| # network bootstrap is ~6s, but github workers can be much slower. | ||
| ${COMPOSE_CMD} up -d | ||
| sleep 30 | ||
| if ${COMPOSE_CMD} ps -q | xargs docker inspect -f '{{ .State.Status }}' | grep -v 'running'; then | ||
| echo "An error occurred." | ||
| exit 1 | ||
| fi | ||
|
|
||
| echo "Successfully invoked the antithesis test setup configured by ${IMAGE_NAME}:${IMAGE_TAG}" |
Oops, something went wrong.