From e4ac2312d333960e231777e573411a2148d911e8 Mon Sep 17 00:00:00 2001 From: Shizun Ge Date: Thu, 19 Sep 2024 23:31:20 -0700 Subject: [PATCH] [readme] Document `GANTRY_MANIFEST_NUM_WORKERS`. Add tests --- README.md | 5 ++- tests/gantry_parallel_spec.sh | 69 ++++++++++++++++++++++++++++++----- 2 files changed, 62 insertions(+), 12 deletions(-) diff --git a/README.md b/README.md index dd53de1..5d57ac2 100644 --- a/README.md +++ b/README.md @@ -76,8 +76,9 @@ You can configure the most behaviors of *Gantry* via environment variables. | Environment Variable | Default | Description | |-----------------------|---------|-------------| -| GANTRY_MANIFEST_CMD | buildx | Valid values are `buildx`, `manifest`, and `none`.
Set which command for manifest inspection. Also see FAQ section [when to set `GANTRY_MANIFEST_CMD`](docs/faq.md#when-to-set-gantry_manifest_cmd).Set to `none` to skip checking the manifest. As a result of skipping, `docker service update` always runs. In case you add `--force` to `GANTRY_UPDATE_OPTIONS`, you also want to disable the inspection. | -| GANTRY_MANIFEST_OPTIONS | | [Options](https://docs.docker.com/engine/reference/commandline/buildx_imagetools_inspect/#options) added to the `docker buildx imagetools inspect` or [options](https://docs.docker.com/engine/reference/commandline/manifest_inspect/#options) to `docker manifest inspect`, depending on `GANTRY_MANIFEST_CMD` value. | +| GANTRY_MANIFEST_CMD | buildx | Valid values are `buildx`, `manifest`, and `none`.
Set which command for manifest inspection. Also see FAQ section [when to set `GANTRY_MANIFEST_CMD`](docs/faq.md#when-to-set-gantry_manifest_cmd).Set to `none` to skip checking the manifest. As a result of skipping, `docker service update` always runs. In case you add `--force` to `GANTRY_UPDATE_OPTIONS`, you also want to disable the inspection. | +| GANTRY_MANIFEST_NUM_WORKERS | 1 | The maximum number of `GANTRY_MANIFEST_CMD` that can run in parallel. | +| GANTRY_MANIFEST_OPTIONS | | [Options](https://docs.docker.com/engine/reference/commandline/buildx_imagetools_inspect/#options) added to the `docker buildx imagetools inspect` or [options](https://docs.docker.com/engine/reference/commandline/manifest_inspect/#options) to `docker manifest inspect`, depending on `GANTRY_MANIFEST_CMD` value. | ### To add options to services update diff --git a/tests/gantry_parallel_spec.sh b/tests/gantry_parallel_spec.sh index c0f4336..9aa2576 100644 --- a/tests/gantry_parallel_spec.sh +++ b/tests/gantry_parallel_spec.sh @@ -23,6 +23,7 @@ Describe 'service-parallel' TEST_NAME="test_parallel_less_workers" IMAGE_WITH_TAG=$(get_image_with_tag "${SUITE_NAME}") SERVICE_NAME="gantry-test-$(unique_id)" + MANIFEST_NUM_WORKERS=2 MAX_SERVICES_NUM=6 MAX_NO_NEW_IMAGE=3 test_start() { @@ -50,6 +51,7 @@ Describe 'service-parallel' local SERVICE_NAME="${2}" local MAX_SERVICES_NUM="${3}" reset_gantry_env "${SERVICE_NAME}" + export GANTRY_MANIFEST_NUM_WORKERS="${MANIFEST_NUM_WORKERS}" export GANTRY_UPDATE_NUM_WORKERS=$((MAX_SERVICES_NUM/2+1)) run_gantry "${TEST_NAME}" } @@ -60,11 +62,13 @@ Describe 'service-parallel' The status should be success The stdout should satisfy display_output The stderr should satisfy display_output - SERVICE_NAME_NUM="${SERVICE_NAME}-0" - The stderr should satisfy spec_expect_no_message "${SKIP_UPDATING}.* ${SERVICE_NAME_NUM} " - The stderr should satisfy spec_expect_message "${PERFORM_UPDATING}.* ${SERVICE_NAME_NUM} .*${PERFORM_REASON_HAS_NEWER_IMAGE}" - The stderr should satisfy spec_expect_message "${UPDATED}.* ${SERVICE_NAME_NUM}" - for NUM in $(seq 1 "${MAX_SERVICES_NUM}"); do + for NUM in $(seq 0 $((MANIFEST_NUM_WORKERS-1)) ); do + SERVICE_NAME_NUM="${SERVICE_NAME}-${NUM}" + The stderr should satisfy spec_expect_no_message "${SKIP_UPDATING}.* ${SERVICE_NAME_NUM} " + The stderr should satisfy spec_expect_message "${PERFORM_UPDATING}.* ${SERVICE_NAME_NUM} .*${PERFORM_REASON_HAS_NEWER_IMAGE}" + The stderr should satisfy spec_expect_message "${UPDATED}.* ${SERVICE_NAME_NUM}" + done + for NUM in $(seq "${MANIFEST_NUM_WORKERS}" "${MAX_SERVICES_NUM}"); do SERVICE_NAME_NUM="${SERVICE_NAME}-${NUM}" The stderr should satisfy spec_expect_no_message "${SKIP_UPDATING}.* ${SERVICE_NAME_NUM} " The stderr should satisfy spec_expect_message "${PERFORM_UPDATING}.* ${SERVICE_NAME_NUM} .*${PERFORM_REASON_KNOWN_NEWER_IMAGE}" @@ -99,12 +103,14 @@ Describe 'service-parallel' TEST_NAME="test_parallel_more_workers" IMAGE_WITH_TAG=$(get_image_with_tag "${SUITE_NAME}") SERVICE_NAME="gantry-test-$(unique_id)" + MANIFEST_NUM_WORKERS=2 MAX_SERVICES_NUM=10 test_parallel_more_workers() { local TEST_NAME="${1}" local SERVICE_NAME="${2}" local MAX_SERVICES_NUM="${3}" reset_gantry_env "${SERVICE_NAME}" + export GANTRY_MANIFEST_NUM_WORKERS="${MANIFEST_NUM_WORKERS}" export GANTRY_UPDATE_NUM_WORKERS=$((MAX_SERVICES_NUM*3)) run_gantry "${TEST_NAME}" } @@ -115,11 +121,13 @@ Describe 'service-parallel' The status should be success The stdout should satisfy display_output The stderr should satisfy display_output - SERVICE_NAME_NUM="${SERVICE_NAME}-0" - The stderr should satisfy spec_expect_no_message "${SKIP_UPDATING}.* ${SERVICE_NAME_NUM} " - The stderr should satisfy spec_expect_message "${PERFORM_UPDATING}.* ${SERVICE_NAME_NUM} .*${PERFORM_REASON_HAS_NEWER_IMAGE}" - The stderr should satisfy spec_expect_message "${UPDATED}.* ${SERVICE_NAME_NUM}" - for NUM in $(seq 1 "${MAX_SERVICES_NUM}"); do + for NUM in $(seq 0 $((MANIFEST_NUM_WORKERS-1)) ); do + SERVICE_NAME_NUM="${SERVICE_NAME}-${NUM}" + The stderr should satisfy spec_expect_no_message "${SKIP_UPDATING}.* ${SERVICE_NAME_NUM} " + The stderr should satisfy spec_expect_message "${PERFORM_UPDATING}.* ${SERVICE_NAME_NUM} .*${PERFORM_REASON_HAS_NEWER_IMAGE}" + The stderr should satisfy spec_expect_message "${UPDATED}.* ${SERVICE_NAME_NUM}" + done + for NUM in $(seq "${MANIFEST_NUM_WORKERS}" "${MAX_SERVICES_NUM}"); do SERVICE_NAME_NUM="${SERVICE_NAME}-${NUM}" The stderr should satisfy spec_expect_no_message "${SKIP_UPDATING}.* ${SERVICE_NAME_NUM} " The stderr should satisfy spec_expect_message "${PERFORM_UPDATING}.* ${SERVICE_NAME_NUM} .*${PERFORM_REASON_KNOWN_NEWER_IMAGE}" @@ -140,6 +148,47 @@ Describe 'service-parallel' The stderr should satisfy spec_expect_no_message "${FAILED_TO_REMOVE_IMAGE}.*${IMAGE_WITH_TAG}" End End + Describe "test_parallel_GANTRY_MANIFEST_NUM_WORKERS_not_a_number" "container_test:false" + TEST_NAME="test_parallel_GANTRY_MANIFEST_NUM_WORKERS_not_a_number" + IMAGE_WITH_TAG=$(get_image_with_tag "${SUITE_NAME}") + SERVICE_NAME="gantry-test-$(unique_id)" + test_parallel_GANTRY_MANIFEST_NUM_WORKERS_not_a_number() { + local TEST_NAME="${1}" + local SERVICE_NAME="${2}" + reset_gantry_env "${SERVICE_NAME}" + export GANTRY_MANIFEST_NUM_WORKERS="NotANumber" + run_gantry "${TEST_NAME}" + } + BeforeEach "common_setup_new_image ${TEST_NAME} ${IMAGE_WITH_TAG} ${SERVICE_NAME}" + AfterEach "common_cleanup ${TEST_NAME} ${IMAGE_WITH_TAG} ${SERVICE_NAME}" + It 'run_test' + When run test_parallel_GANTRY_MANIFEST_NUM_WORKERS_not_a_number "${TEST_NAME}" "${SERVICE_NAME}" + The status should be failure + The stdout should satisfy display_output + The stderr should satisfy display_output + The stderr should satisfy spec_expect_message "GANTRY_MANIFEST_NUM_WORKERS ${MUST_BE_A_NUMBER}.*" + The stderr should satisfy spec_expect_no_message "${SKIP_UPDATING}.*${SERVICE_NAME}" + The stderr should satisfy spec_expect_no_message "${PERFORM_UPDATING}.*${SERVICE_NAME}.*${PERFORM_REASON_HAS_NEWER_IMAGE}" + The stderr should satisfy spec_expect_no_message "${NUM_SERVICES_SKIP_JOBS}" + The stderr should satisfy spec_expect_no_message "${NUM_SERVICES_INSPECT_FAILURE}" + The stderr should satisfy spec_expect_no_message "${NUM_SERVICES_NO_NEW_IMAGES}" + The stderr should satisfy spec_expect_no_message "${NUM_SERVICES_UPDATING}" + The stderr should satisfy spec_expect_no_message "${UPDATED}.*${SERVICE_NAME}" + The stderr should satisfy spec_expect_no_message "${NO_UPDATES}.*${SERVICE_NAME}" + The stderr should satisfy spec_expect_no_message "${ROLLING_BACK}.*${SERVICE_NAME}" + The stderr should satisfy spec_expect_no_message "${FAILED_TO_ROLLBACK}.*${SERVICE_NAME}" + The stderr should satisfy spec_expect_no_message "${ROLLED_BACK}.*${SERVICE_NAME}" + The stderr should satisfy spec_expect_message "${NO_SERVICES_UPDATED}" + The stderr should satisfy spec_expect_no_message "${NUM_SERVICES_UPDATED}" + The stderr should satisfy spec_expect_no_message "${NUM_SERVICES_UPDATE_FAILED}" + The stderr should satisfy spec_expect_message "${NUM_SERVICES_ERRORS}" + The stderr should satisfy spec_expect_message "${NO_IMAGES_TO_REMOVE}" + The stderr should satisfy spec_expect_no_message "${REMOVING_NUM_IMAGES}" + The stderr should satisfy spec_expect_no_message "${SKIP_REMOVING_IMAGES}" + The stderr should satisfy spec_expect_no_message "${REMOVED_IMAGE}.*${IMAGE_WITH_TAG}" + The stderr should satisfy spec_expect_no_message "${FAILED_TO_REMOVE_IMAGE}.*${IMAGE_WITH_TAG}" + End + End Describe "test_parallel_GANTRY_UPDATE_NUM_WORKERS_not_a_number" "container_test:false" TEST_NAME="test_parallel_GANTRY_UPDATE_NUM_WORKERS_not_a_number" IMAGE_WITH_TAG=$(get_image_with_tag "${SUITE_NAME}")