mirror of
https://github.com/project-zot/zot.git
synced 2026-06-17 12:58:02 +08:00
bc5fd1a357
* feat: add events config Signed-off-by: Piaras Hoban <phoban01@gmail.com> * feat: implement event support with log sink Signed-off-by: Piaras Hoban <phoban01@gmail.com> * feat: integrate events and update tests Signed-off-by: Piaras Hoban <phoban01@gmail.com> * refactor: update event config Signed-off-by: Piaras Hoban <phoban01@gmail.com> * feat: implement http and nats sinks. remove log sink Signed-off-by: Piaras Hoban <phoban01@gmail.com> * refactor: events extension setup Signed-off-by: Piaras Hoban <phoban01@gmail.com> * chore: cleanup tests to use nil event recorder Signed-off-by: Piaras Hoban <phoban01@gmail.com> * chore: update events config example and add more logging Signed-off-by: Piaras Hoban <phoban01@gmail.com> * refactor: better use of build tags for minimal binary Signed-off-by: Piaras Hoban <phoban01@gmail.com> * fix: missing store param in evelated privileges tests Signed-off-by: Piaras Hoban <phoban01@gmail.com> * fix: regression in config decoding Signed-off-by: Piaras Hoban <phoban01@gmail.com> * chore: update check logs script to enable cross-platform usage via GREP_BIN_PATH envvar Signed-off-by: Piaras Hoban <phoban01@gmail.com> * chore: fix log lint issue for events Signed-off-by: Piaras Hoban <phoban01@gmail.com> * chore: fix failing events disabled test Signed-off-by: Piaras Hoban <phoban01@gmail.com> * test: add blackbox tests for events Signed-off-by: Piaras Hoban <phoban01@gmail.com> * chore: specify architecture when downloading binaries in Makefile Signed-off-by: Piaras Hoban <phoban01@gmail.com> * chore: improve failure handling when no valid sinks are provided Signed-off-by: Piaras Hoban <phoban01@gmail.com> * test: fix data race in events test Signed-off-by: Piaras Hoban <phoban01@gmail.com> * chore: cleanup event decoding Signed-off-by: Piaras Hoban <phoban01@gmail.com> * test: fix logging tests Signed-off-by: Piaras Hoban <phoban01@gmail.com> * test: make nats server test more reliable Signed-off-by: Piaras Hoban <phoban01@gmail.com> * chore: go mod cleanup Signed-off-by: Piaras Hoban <phoban01@gmail.com> * test: add sleep when setting up nats client Signed-off-by: Piaras Hoban <phoban01@gmail.com> * fix: ensure event sink errors do not propogate Signed-off-by: Piaras Hoban <phoban01@gmail.com> * test: increase coverage for events Signed-off-by: Piaras Hoban <phoban01@gmail.com> * feat(events): Refactor events to be non-blocking from caller. Signed-off-by: Asgeir Nilsen <asgeir.nilsen@bouvet.no> Signed-off-by: Piaras Hoban <phoban01@gmail.com> * chore: remove harded-coded linux Co-authored-by: Andrei Aaron <andreifdaaron@gmail.com> Signed-off-by: Piaras Hoban <phoban01@gmail.com> * feat(events): fail to start if incorrect event sink is configured Signed-off-by: Piaras Hoban <phoban01@gmail.com> * test: allow cli tests to return errors instead of panic Signed-off-by: Piaras Hoban <phoban01@gmail.com> * chore: bump nats server to v2.11.3 Signed-off-by: Piaras Hoban <phoban01@gmail.com> --------- Signed-off-by: Piaras Hoban <phoban01@gmail.com> Signed-off-by: Asgeir Nilsen <asgeir.nilsen@bouvet.no> Co-authored-by: Asgeir Nilsen <asgeir.nilsen@bouvet.no> Co-authored-by: Andrei Aaron <andreifdaaron@gmail.com>
168 lines
5.3 KiB
Bash
168 lines
5.3 KiB
Bash
# Note: Intended to be run as "make run-blackbox-tests" or "make run-blackbox-ci"
|
|
# Makefile target installs & checks all necessary tooling
|
|
# Extra tools that are not covered in Makefile target needs to be added in verify_prerequisites()
|
|
|
|
load helpers_zot
|
|
load helpers_events
|
|
|
|
function verify_prerequisites() {
|
|
if [ ! $(command -v curl) ]; then
|
|
echo "you need to install curl as a prerequisite to running the tests" >&3
|
|
return 1
|
|
fi
|
|
|
|
if [ ! $(command -v jq) ]; then
|
|
echo "you need to install jq as a prerequisite to running the tests" >&3
|
|
return 1
|
|
fi
|
|
|
|
if [ ! $(command -v docker) ]; then
|
|
echo "you need to install docker as a prerequisite to running the tests" >&3
|
|
return 1
|
|
fi
|
|
}
|
|
|
|
function setup_file() {
|
|
# verify prerequisites are available
|
|
if ! $(verify_prerequisites); then
|
|
exit 1
|
|
fi
|
|
|
|
# Setup http server
|
|
http_server_port=$(get_free_port)
|
|
http_event_dir="${BATS_FILE_TMPDIR}/http_events"
|
|
http_server_start http_receiver "${http_server_port}" "${http_event_dir}"
|
|
echo ${http_server_port} > ${BATS_FILE_TMPDIR}/http_server.port
|
|
wait_for_http_server $http_server_port
|
|
|
|
skopeo --insecure-policy copy --format=oci docker://ghcr.io/project-zot/golang:1.20 oci:${TEST_DATA_DIR}/golang:1.20
|
|
|
|
# Setup zot server
|
|
local zot_root_dir=${BATS_FILE_TMPDIR}/zot
|
|
local zot_config_file=${BATS_FILE_TMPDIR}/zot_config.json
|
|
local oci_data_dir=${BATS_FILE_TMPDIR}/oci
|
|
mkdir -p ${zot_root_dir}
|
|
mkdir -p ${oci_data_dir}
|
|
zot_port=$(get_free_port)
|
|
echo ${zot_port} > ${BATS_FILE_TMPDIR}/zot.port
|
|
cat > ${zot_config_file}<<EOF
|
|
{
|
|
"distSpecVersion": "1.1.1",
|
|
"storage": {
|
|
"rootDirectory": "${zot_root_dir}"
|
|
},
|
|
"http": {
|
|
"address": "0.0.0.0",
|
|
"port": "${zot_port}"
|
|
},
|
|
"log": {
|
|
"level": "debug",
|
|
"output": "${BATS_FILE_TMPDIR}/zot.log"
|
|
},
|
|
"extensions": {
|
|
"events": {
|
|
"enable": true,
|
|
"sinks": [{
|
|
"type": "http",
|
|
"address": "http://127.0.0.1:${http_server_port}/events",
|
|
"timeout": "15s",
|
|
"credentials": {
|
|
"username": "jane.joe",
|
|
"password": "opensesame"
|
|
}
|
|
}]
|
|
}
|
|
}
|
|
}
|
|
EOF
|
|
zot_serve ${ZOT_PATH} ${zot_config_file}
|
|
wait_zot_reachable ${zot_port}
|
|
}
|
|
|
|
function teardown_file() {
|
|
zot_stop_all
|
|
http_server_stop http_receiver
|
|
}
|
|
|
|
@test "http/publish repository created event" {
|
|
http_server_port=$(cat ${BATS_FILE_TMPDIR}/http_server.port)
|
|
zot_port=$(cat ${BATS_FILE_TMPDIR}/zot.port)
|
|
output_path=${BATS_FILE_TMPDIR}/http_events
|
|
|
|
run curl -XGET http://127.0.0.1:${http_server_port}/reset
|
|
[ "$status" -eq 0 ]
|
|
[ -d "${output_path}" ] && rm -f "${output_path}"/*.json
|
|
|
|
# Push a new image and create repository
|
|
run skopeo --insecure-policy copy --dest-tls-verify=false \
|
|
oci:${TEST_DATA_DIR}/golang:1.20 \
|
|
docker://127.0.0.1:${zot_port}/golang:1.20
|
|
[ "$status" -eq 0 ]
|
|
|
|
sleep 1
|
|
|
|
# Check the correct number of events were generated
|
|
count=$(find "${output_path}" -type f | wc -l)
|
|
[ "$count" -eq 2 ]
|
|
|
|
result=$(jq '.' ${output_path}/1.json)
|
|
[ $(echo "${result}" | jq -r '.headers["Ce-Type"]') = "zotregistry.repository.created" ]
|
|
[ $(echo "${result}" | jq -r '.body.name') = "golang" ]
|
|
}
|
|
|
|
@test "http/publish image updated event" {
|
|
http_server_port=$(cat ${BATS_FILE_TMPDIR}/http_server.port)
|
|
zot_port=$(cat ${BATS_FILE_TMPDIR}/zot.port)
|
|
output_path=${BATS_FILE_TMPDIR}/http_events
|
|
|
|
run curl -XGET http://127.0.0.1:${http_server_port}/reset
|
|
[ "$status" -eq 0 ]
|
|
[ -d "${output_path}" ] && rm -f "${output_path}"/*.json
|
|
|
|
# Push a new image tag
|
|
run skopeo --insecure-policy copy --dest-tls-verify=false \
|
|
oci:${TEST_DATA_DIR}/golang:1.20 \
|
|
docker://127.0.0.1:${zot_port}/golang:latest
|
|
[ "$status" -eq 0 ]
|
|
|
|
sleep 1
|
|
|
|
# Check the correct number of events were generated
|
|
count=$(find "${output_path}" -type f | wc -l)
|
|
ls -al $output_path
|
|
[ "$count" -eq 1 ]
|
|
|
|
# Validate the event
|
|
result=$(jq '.' ${output_path}/1.json)
|
|
[ $(echo "${result}" | jq -r '.headers["Ce-Type"]') = "zotregistry.image.updated" ]
|
|
[ $(echo "${result}" | jq -r '.body.name') = "golang" ]
|
|
[ $(echo "${result}" | jq -r '.body.reference') = "latest" ]
|
|
}
|
|
|
|
@test "http/publish image deleted event" {
|
|
http_server_port=$(cat ${BATS_FILE_TMPDIR}/http_server.port)
|
|
zot_port=$(cat ${BATS_FILE_TMPDIR}/zot.port)
|
|
output_path=${BATS_FILE_TMPDIR}/http_events
|
|
|
|
run curl -XGET http://127.0.0.1:${http_server_port}/reset
|
|
[ "$status" -eq 0 ]
|
|
[ -d "${output_path}" ] && rm -f "${output_path}"/*.json
|
|
|
|
# Delete the tag
|
|
run curl -X DELETE http://localhost:${zot_port}/v2/golang/manifests/latest
|
|
[ "$status" -eq 0 ]
|
|
|
|
sleep 1
|
|
|
|
# Check the correct number of events were generated
|
|
count=$(find "${output_path}" -type f | wc -l)
|
|
ls -al $output_path
|
|
[ "$count" -eq 1 ]
|
|
|
|
# Validate the event
|
|
result=$(jq '.' ${output_path}/1.json)
|
|
[ $(echo "${result}" | jq -r '.headers["Ce-Type"]') = "zotregistry.image.deleted" ]
|
|
[ $(echo "${result}" | jq -r '.body.name') = "golang" ]
|
|
[ $(echo "${result}" | jq -r '.body.reference') = "latest" ]
|
|
}
|