zot/test/blackbox/pushpull_running_dedupe.bats

# Note: Intended to be run as "make run-blackbox-tests" or "make run-blackbox-dedupe-nightly"
#       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 ../port_helper

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

    return 0
}

function setup_file() {
    # Verify prerequisites are available
    if ! verify_prerequisites; then
        exit 1
    fi
    # Download test data to folder common for the entire suite, not just this file
    skopeo --insecure-policy copy --format=oci docker://ghcr.io/project-zot/test-images/alpine:3.17.3 oci:${TEST_DATA_DIR}/alpine:1
    # 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_for_service "zot")
    echo ${zot_port} > ${BATS_FILE_TMPDIR}/zot.port
    cat > ${zot_config_file}<<EOF
{
    "distSpecVersion": "1.1.1",
    "storage": {
        "rootDirectory": "${zot_root_dir}",
        "dedupe": false,
        "gc": true,
        "gcInterval": "30s"
    },
    "http": {
        "address": "0.0.0.0",
        "port": "${zot_port}"
    },
    "log": {
        "level": "debug",
        "output": "${BATS_FILE_TMPDIR}/zot.log"
    }
}
EOF
    git -C ${BATS_FILE_TMPDIR} clone https://github.com/project-zot/helm-charts.git
    zot_serve ${ZOT_PATH} ${zot_config_file}
    wait_zot_reachable ${zot_port}
}

function teardown() {
    # conditionally printing on failure is possible from teardown but not from from teardown_file
    cat ${BATS_FILE_TMPDIR}/zot.log
}

function teardown_file() {
    zot_stop_all
}

function get_zot_port() {
    cat ${BATS_FILE_TMPDIR}/zot.port
}

@test "push image - dedupe not running" {
    zot_port=$(get_zot_port)
    start=`date +%s`
    run skopeo --insecure-policy copy --dest-tls-verify=false \
        oci:${TEST_DATA_DIR}/alpine:1 \
        docker://127.0.0.1:${zot_port}/alpine:1
    [ "$status" -eq 0 ]
    end=`date +%s`

    runtime=$((end-start))
    echo "push image exec time: $runtime sec" >&3

    run curl http://127.0.0.1:${zot_port}/v2/_catalog
    [ "$status" -eq 0 ]
    [ $(echo "${lines[-1]}" | jq '.repositories[]') = '"alpine"' ]
    run curl http://127.0.0.1:${zot_port}/v2/alpine/tags/list
    [ "$status" -eq 0 ]
    [ $(echo "${lines[-1]}" | jq '.tags[]') = '"1"' ]
}

@test "pull image - dedupe not running" {
    zot_port=$(get_zot_port)
    local oci_data_dir=${BATS_FILE_TMPDIR}/oci
    start=`date +%s`
    run skopeo --insecure-policy copy --src-tls-verify=false \
        docker://127.0.0.1:${zot_port}/alpine:1 \
        oci:${oci_data_dir}/alpine:1
    [ "$status" -eq 0 ]
    end=`date +%s`

    runtime=$((end-start))
    echo "pull image exec time: $runtime sec" >&3
    run cat ${BATS_FILE_TMPDIR}/oci/alpine/index.json
    [ "$status" -eq 0 ]
    [ $(echo "${lines[-1]}" | jq '.manifests[].annotations."org.opencontainers.image.ref.name"') = '"1"' ]
}

@test "push 50 images with dedupe disabled" {
    zot_port=$(get_zot_port)
    for i in {1..50}
    do
        run skopeo --insecure-policy copy --dest-tls-verify=false \
            oci:${TEST_DATA_DIR}/alpine:1 \
            docker://127.0.0.1:${zot_port}/alpine${i}:1
        [ "$status" -eq 0 ]
    done
}

@test "restart zot with dedupe enabled" {
    zot_port=$(get_zot_port)
    local zot_config_file=${BATS_FILE_TMPDIR}/zot_config.json

    # stop server
    zot_stop_all

    # enable dedupe
    sed -i 's/false/true/g' ${zot_config_file}

    zot_serve ${ZOT_PATH} ${zot_config_file}

    # sleep a bit before running wait_zot_reachable(curl)
    sleep 5

    wait_zot_reachable ${zot_port}
    # deduping will now run in background (task scheduler) while we push images, shouldn't interfere
}

@test "push image - dedupe running" {
    zot_port=$(get_zot_port)
    start=`date +%s`
    run skopeo --insecure-policy copy --dest-tls-verify=false \
        oci:${TEST_DATA_DIR}/alpine:1 \
        docker://127.0.0.1:${zot_port}/dedupe/alpine:1
    [ "$status" -eq 0 ]
    end=`date +%s`

    runtime=$((end-start))
    echo "push image exec time: $runtime sec" >&3
}

@test "pull image - dedupe running" {
    zot_port=$(get_zot_port)
    local oci_data_dir=${BATS_FILE_TMPDIR}/oci

    mkdir -p ${oci_data_dir}/dedupe/

    start=`date +%s`
    run skopeo --insecure-policy copy --src-tls-verify=false \
        docker://127.0.0.1:${zot_port}/dedupe/alpine:1 \
        oci:${oci_data_dir}/dedupe/alpine:1
    [ "$status" -eq 0 ]
    end=`date +%s`
    runtime=$((end-start))

    echo "pull image exec time: $runtime sec" >&3
}

@test "pull deduped image - dedupe running" {
    zot_port=$(get_zot_port)
    local oci_data_dir=${BATS_FILE_TMPDIR}/oci

    mkdir -p ${oci_data_dir}/dedupe/

    start=`date +%s`
    run skopeo --insecure-policy copy --src-tls-verify=false \
        docker://127.0.0.1:${zot_port}/alpine2:1 \
        oci:${oci_data_dir}/dedupe/alpine2:1
    [ "$status" -eq 0 ]
    end=`date +%s`
    runtime=$((end-start))

    echo "pull image exec time: $runtime sec" >&3
}

@test "push image index - dedupe running" {
    zot_port=$(get_zot_port)
    # --multi-arch below pushes an image index (containing many images) instead
    # of an image manifest (single image)
    start=`date +%s`
    run skopeo --insecure-policy copy --format=oci --dest-tls-verify=false --multi-arch=all \
        docker://public.ecr.aws/docker/library/busybox:latest \
        docker://127.0.0.1:${zot_port}/busybox:latest
    [ "$status" -eq 0 ]
    end=`date +%s`
    runtime=$((end-start))

    echo "push image index exec time: $runtime sec" >&3
    run curl http://127.0.0.1:${zot_port}/v2/busybox/tags/list
    [ "$status" -eq 0 ]
    [ $(echo "${lines[-1]}" | jq '.tags[]') = '"latest"' ]
}

@test "pull image index - dedupe running" {
    zot_port=$(get_zot_port)
    local oci_data_dir=${BATS_FILE_TMPDIR}/oci
    start=`date +%s`
    run skopeo --insecure-policy copy --src-tls-verify=false --multi-arch=all \
        docker://127.0.0.1:${zot_port}/busybox:latest \
        oci:${oci_data_dir}/busybox:latest
    [ "$status" -eq 0 ]
    end=`date +%s`
    runtime=$((end-start))

    echo "pull image index exec time: $runtime sec" >&3
    run cat ${BATS_FILE_TMPDIR}/oci/busybox/index.json
    [ "$status" -eq 0 ]
    [ $(echo "${lines[-1]}" | jq '.manifests[].annotations."org.opencontainers.image.ref.name"') = '"latest"' ]
    run skopeo --insecure-policy --override-arch=arm64 --override-os=linux copy --src-tls-verify=false --multi-arch=all \
        docker://127.0.0.1:${zot_port}/busybox:latest \
        oci:${oci_data_dir}/busybox:latest
    [ "$status" -eq 0 ]
    run cat ${BATS_FILE_TMPDIR}/oci/busybox/index.json
    [ "$status" -eq 0 ]
    [ $(echo "${lines[-1]}" | jq '.manifests[].annotations."org.opencontainers.image.ref.name"') = '"latest"' ]
    run curl -X DELETE http://127.0.0.1:${zot_port}/v2/busybox/manifests/latest
    [ "$status" -eq 0 ]
}

@test "push oras artifact - dedupe running" {
    zot_port=$(get_zot_port)
    echo "{\"name\":\"foo\",\"value\":\"bar\"}" > config.json
    echo "hello world" > artifact.txt
    start=`date +%s`
    run oras push --plain-http 127.0.0.1:${zot_port}/hello-artifact:v2 \
        --config config.json:application/vnd.acme.rocket.config.v1+json artifact.txt:text/plain -d -v
    [ "$status" -eq 0 ]
    end=`date +%s`
    runtime=$((end-start))

    echo "push oras artifact exec time: $runtime sec" >&3
    rm -f artifact.txt
    rm -f config.json
}

@test "pull oras artifact - dedupe running" {
    zot_port=$(get_zot_port)
    start=`date +%s`
    run oras pull --plain-http 127.0.0.1:${zot_port}/hello-artifact:v2 -d -v
    [ "$status" -eq 0 ]
    end=`date +%s`
    runtime=$((end-start))

    echo "pull oras artifact exec time: $runtime sec" >&3
    grep -q "hello world" artifact.txt
    rm -f artifact.txt
}

@test "attach oras artifacts - dedupe running" {
    zot_port=$(get_zot_port)
    # attach signature
    echo "{\"artifact\": \"\", \"signature\": \"pat hancock\"}" > ${BATS_FILE_TMPDIR}/signature.json
    start=`date +%s`
    run oras attach --disable-path-validation --plain-http 127.0.0.1:${zot_port}/alpine:1 --artifact-type 'signature/example' ${BATS_FILE_TMPDIR}/signature.json:application/json
    [ "$status" -eq 0 ]
    end=`date +%s`
    runtime=$((end-start))

    echo "attach signature exec time: $runtime sec" >&3
    # attach sbom
    echo "{\"version\": \"0.0.0.0\", \"artifact\": \"'127.0.0.1:${zot_port}/alpine:1'\", \"contents\": \"good\"}" > ${BATS_FILE_TMPDIR}/sbom.json
    start=`date +%s`
    run oras attach --disable-path-validation --plain-http 127.0.0.1:${zot_port}/alpine:1 --artifact-type 'sbom/example' ${BATS_FILE_TMPDIR}/sbom.json:application/json
    [ "$status" -eq 0 ]
    end=`date +%s`
    runtime=$((end-start))

    echo "attach sbom exec time: $runtime sec" >&3
}

@test "discover oras artifacts - dedupe running" {
    zot_port=$(get_zot_port)
    start=`date +%s`
    run oras discover --plain-http --format json 127.0.0.1:${zot_port}/alpine:1
    [ "$status" -eq 0 ]
    end=`date +%s`
    runtime=$((end-start))

    echo "discover oras artifacts exec time: $runtime sec" >&3
    [ $(echo "$output" | jq -r ".manifests | length") -eq 2 ]
}

@test "push helm chart - dedupe running" {
    zot_port=$(get_zot_port)
    run helm package ${BATS_FILE_TMPDIR}/helm-charts/charts/zot -d ${BATS_FILE_TMPDIR}
    [ "$status" -eq 0 ]
    local chart_version=$(awk '/version/{printf $2}' ${BATS_FILE_TMPDIR}/helm-charts/charts/zot/Chart.yaml)
    start=`date +%s`
    run helm push ${BATS_FILE_TMPDIR}/zot-${chart_version}.tgz oci://localhost:${zot_port}/zot-chart
    [ "$status" -eq 0 ]
    end=`date +%s`
    runtime=$((end-start))

    echo "helm push exec time: $runtime sec" >&3
}

@test "pull helm chart - dedupe running" {
    zot_port=$(get_zot_port)
    local chart_version=$(awk '/version/{printf $2}' ${BATS_FILE_TMPDIR}/helm-charts/charts/zot/Chart.yaml)
    start=`date +%s`
    run helm pull oci://localhost:${zot_port}/zot-chart/zot --version ${chart_version} -d ${BATS_FILE_TMPDIR}
    [ "$status" -eq 0 ]
    end=`date +%s`
    runtime=$((end-start))

    echo "helm pull exec time: $runtime sec" >&3
}

@test "push image with regclient - dedupe running" {
    zot_port=$(get_zot_port)
    run regctl registry set localhost:${zot_port} --tls disabled
    [ "$status" -eq 0 ]
    start=`date +%s`
    run regctl image copy ocidir://${TEST_DATA_DIR}/alpine:1 localhost:${zot_port}/test-regclient
    [ "$status" -eq 0 ]
    end=`date +%s`
    runtime=$((end-start))

    echo "regclient push exec time: $runtime" >&3
}