zot/test/blackbox/events_http_lint_failure.bats

# 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
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

    if [ ! $(command -v docker) ]; then
        echo "you need to install docker as a prerequisite to running the tests" >&3
        return 1
    fi

    if [ ! $(command -v oras) ]; then
        echo "you need to install oras 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_for_service "http")
    http_event_dir="${BATS_FILE_TMPDIR}/http_events"
    http_server_start http_receiver_lint "${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_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}"
    },
    "http": {
        "address": "0.0.0.0",
        "port": "${zot_port}"
    },
    "log": {
        "level": "debug",
        "output": "${BATS_FILE_TMPDIR}/zot.log"
    },
    "extensions": {
        "lint": {
            "enable": true,
            "mandatoryAnnotations": ["event-test"]
        },
        "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_lint
}

function wait_for_event_count() {
    local output_path="$1"
    local expected_count="$2"
    local timeout_seconds="${3:-10}"
    local elapsed=0
    local count=0

    while [ "$elapsed" -lt "$timeout_seconds" ]; do
        count=$(find "${output_path}" -type f | wc -l)
        if [ "$count" -eq "$expected_count" ]; then
            return 0
        fi

        sleep 1
        elapsed=$((elapsed + 1))
    done

    echo "timed out waiting for ${expected_count} events, found ${count}" >&3

    return 1
}

@test "http/publish image lint failure 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

    # Create dummy config
    echo '{}' > config.json

    # Create dummy layer
    echo "this is a bogus artifact" > artifact.txt

    # Push using oras with intentionally broken config + type
    run oras push --plain-http 127.0.0.1:${zot_port}/test-artifact:v0 \
        --config config.json:application/vnd.oci.image.config.v1+json \
        artifact.txt:text/plain -d -v

    rm -f artifact.txt config.json

    # Check the correct number of events were generated
    wait_for_event_count "${output_path}" 2
    count=$(find "${output_path}" -type f | wc -l)
    [ "$count" -eq 2 ]

    # Validate the event
    result=$(jq '.' ${output_path}/2.json)
    echo $result
    [ $(echo "${result}" | jq -r '.headers["Ce-Type"]') = "zotregistry.image.lint_failed" ]
    [ $(echo "${result}" | jq -r '.body.name') = "test-artifact" ]
    [ $(echo "${result}" | jq -r '.body.reference') = "v0" ]
}

@test "http/publish image with annotations" {
    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

    # Create dummy config
    echo '{}' > config.json

    # Create dummy layer
    echo "this is a bogus artifact" > artifact.txt

    # Push using oras with intentionally broken config + type
    run oras push --plain-http 127.0.0.1:${zot_port}/test-artifact:v1 \
        --annotation "event-test=true" \
        --config config.json:application/vnd.oci.image.config.v1+json \
        artifact.txt:text/plain -d -v

    rm -f artifact.txt config.json

    # Check the correct number of events were generated
    wait_for_event_count "${output_path}" 1
    count=$(find "${output_path}" -type f | wc -l)
    [ "$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') = "test-artifact" ]
    [ $(echo "${result}" | jq -r '.body.reference') = "v1" ]
}