feat(repodb): update referrers api to use repodb (#1230)

Signed-off-by: Laurentiu Niculae <niculae.laurentiu1@gmail.com>
2026-06-15 20:07:55 +08:00 · 2023-03-10 20:37:29 +02:00
parent c731acf6de
commit 5d1f91a79f
37 changed files with 2011 additions and 201 deletions
@@ -37,6 +37,7 @@ function setup() {
            "cacheTablename": "BlobTable",
            "repoMetaTablename": "RepoMetadataTable",
            "manifestDataTablename": "ManifestDataTable",
+            "artifactDataTablename": "ArtifactDataTable",
            "indexDataTablename": "IndexDataTable",
            "versionTablename": "Version"
        }
@@ -0,0 +1,80 @@
+ROOT_DIR=$(git rev-parse --show-toplevel)
+TEST_DATA_DIR=${ROOT_DIR}/test/data/
+OS="${OS:-linux}"
+ARCH="${ARCH:-amd64}"
+ZOT_PATH=${ROOT_DIR}/bin/zot-${OS}-${ARCH}
+
+mkdir -p ${TEST_DATA_DIR}
+
+function verify_prerequisites {
+    if [ ! -f ${BATS_RUN_TMPDIR}/.firstrun ]; then
+        env | grep proxy >&3
+        touch ${BATS_RUN_TMPDIR}/.firstrun
+    fi
+
+    if [ ! -f ${ZOT_PATH} ]; then
+        echo "you need to build ${ZOT_PATH} before running the tests" >&3
+        return 1
+    fi
+
+    if [ ! -f ${ZOT_MINIMAL_PATH} ]; then
+        echo "you need to build ${ZOT_MINIMAL_PATH} before running tests" >&3
+        return 1
+    fi
+
+    if [ ! command -v curl ] &>/dev/null; then
+        echo "you need to install curl as a prerequisite to running the tests" >&3
+        return 1
+    fi
+
+    if [ ! command -v jq ] &>/dev/null; then
+        echo "you need to install jq as a prerequisite to running the tests" >&3
+        return 1
+    fi
+
+    if [ ! command -v skopeo ] &>/dev/null; then
+        echo "you need to install skopeo as a prerequisite to running the tests" >&3
+        return 1
+    fi
+
+    if [ ! command -v oras ] &>/dev/null; then
+        echo "you need to install oras as a prerequisite to running the tests" >&3
+        return 1
+    fi
+    return 0
+}
+
+function zot_serve() {
+    local zot_path=${1}
+    local config_file=${2}
+    local pid_dir=${3}
+    ${zot_path} serve ${config_file} &
+    echo $! >>${pid_dir}/zot.pid
+}
+
+function zot_stop() {
+    local pid_dir=${1}
+    cat ${pid_dir}/zot.pid
+    kill $(cat ${pid_dir}/zot.pid)
+    rm ${pid_dir}/zot.pid
+}
+
+function setup_zot_file_level() {
+    local config_file=${1}
+    zot_serve ${ZOT_PATH} ${config_file} ${BATS_FILE_TMPDIR}
+}
+
+function teardown_zot_file_level() {
+    zot_stop ${BATS_FILE_TMPDIR}
+}
+
+function wait_zot_reachable() {
+    zot_url=${1}
+    curl --connect-timeout 3 \
+        --max-time 3 \
+        --retry 10 \
+        --retry-delay 0 \
+        --retry-max-time 60 \
+        --retry-connrefused \
+        ${zot_url}
+}
@@ -0,0 +1,109 @@
+load helpers_referrers
+
+function setup() {
+    # 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://alpine:latest oci:${TEST_DATA_DIR}alpine:latest
+
+    # Setup zot server
+    ZOT_ROOT_DIR=${BATS_FILE_TMPDIR}/zot
+    echo ${ZOT_ROOT_DIR}
+    ZOT_LOG_FILE=${ZOT_ROOT_DIR}/zot-log.json
+    ZOT_CONFIG_FILE=${BATS_FILE_TMPDIR}/zot_config.json
+    mkdir -p ${ZOT_ROOT_DIR}
+    touch ${ZOT_LOG_FILE}
+    cat >${ZOT_CONFIG_FILE} <<EOF
+{
+    "distSpecVersion": "1.1.0",
+    "storage": {
+        "rootDirectory": "${ZOT_ROOT_DIR}"
+    },
+    "http": {
+        "address": "0.0.0.0",
+        "port": "8080"
+    },
+    "log": {
+        "level": "debug",
+        "output": "${ZOT_LOG_FILE}"
+    },
+    "extensions": {
+        "search": {
+            "enable": true
+        }
+    }
+}
+EOF
+
+    # Add artifact contents to files
+    ARTIFACT_BLOBS_DIR=${BATS_FILE_TMPDIR}/artifact-blobs
+    mkdir -p ${ARTIFACT_BLOBS_DIR}
+
+    IMAGE_MANIFEST_REFERRER=${ARTIFACT_BLOBS_DIR}/image-manifest-ref-blob
+    echo IMAGE_MANIFEST_REFERRER=${IMAGE_MANIFEST_REFERRER}
+    touch ${IMAGE_MANIFEST_REFERRER}
+    cat >${IMAGE_MANIFEST_REFERRER} <<EOF
+        This artifact is represented as an ispec image manifest, this is the layer inside the manifest.
+EOF
+
+    ARTIFACT_MANIFEST_REFERRER=${ARTIFACT_BLOBS_DIR}/artifact-manifest-ref-blob
+    touch ${ARTIFACT_MANIFEST_REFERRER}
+    cat >${ARTIFACT_MANIFEST_REFERRER} <<EOF
+        This artifact is represented as an ispec artifact manifest, this is the blob inside the manifest.
+EOF
+
+    setup_zot_file_level ${ZOT_CONFIG_FILE}
+    echo "yes"
+    wait_zot_reachable "http://127.0.0.1:8080/v2/_catalog"
+
+    run skopeo --insecure-policy copy --dest-tls-verify=false \
+        oci:${TEST_DATA_DIR}/alpine:latest \
+        docker://127.0.0.1:8080/alpine:latest
+    [ "$status" -eq 0 ]
+    run curl http://127.0.0.1:8080/v2/_catalog
+    [ "$status" -eq 0 ]
+    [ $(echo "${lines[-1]}" | jq '.repositories[]') = '"alpine"' ]
+
+    run oras attach --plain-http --image-spec v1.1-image --artifact-type image.type 127.0.0.1:8080/alpine:latest ${IMAGE_MANIFEST_REFERRER}
+    [ "$status" -eq 0 ]
+
+    run oras attach --plain-http --image-spec v1.1-artifact --artifact-type artifact.type 127.0.0.1:8080/alpine:latest ${ARTIFACT_MANIFEST_REFERRER}
+    [ "$status" -eq 0 ]
+
+    MANIFEST_DIGEST=$(skopeo inspect --tls-verify=false docker://localhost:8080/alpine:latest | jq -r '.Digest')
+    echo ${MANIFEST_DIGEST}
+
+    curl -X GET http://127.0.0.1:8080/v2/alpine/referrers/${MANIFEST_DIGEST}?artifactType=image.type
+}
+
+function teardown() {
+    local ZOT_ROOT_DIR=${BATS_FILE_TMPDIR}/zot
+    zot_stop ${BATS_FILE_TMPDIR}
+    rm -rf ${ZOT_ROOT_DIR}
+}
+
+@test "add referrers, one artifact and one image" {
+
+    # Check referrers API using the normal REST endpoint
+    run curl -X GET http://127.0.0.1:8080/v2/alpine/referrers/${MANIFEST_DIGEST}?artifactType=image.type
+    [ "$status" -eq 0 ]
+    [ $(echo "${lines[-1]}" | jq '.manifests[].artifactType') = '"image.type"' ]
+
+    run curl -X GET http://127.0.0.1:8080/v2/alpine/referrers/${MANIFEST_DIGEST}?artifactType=artifact.type
+    [ "$status" -eq 0 ]
+    [ $(echo "${lines[-1]}" | jq '.manifests[].artifactType') = '"artifact.type"' ]
+
+    # Check referrers API using the GQL endpoint
+    REFERRER_QUERY_DATA="{ \"query\": \"{ Referrers(repo:\\\"alpine\\\", digest:\\\"${MANIFEST_DIGEST}\\\", type:[\\\"image.type\\\"]) { MediaType ArtifactType Digest Size} }\"}"
+    run curl -X POST -H "Content-Type: application/json" --data "${REFERRER_QUERY_DATA}" http://localhost:8080/v2/_zot/ext/search
+    [ "$status" -eq 0 ]
+    [ $(echo "${lines[-1]}" | jq '.data.Referrers[].ArtifactType') = '"image.type"' ]
+
+    REFERRER_QUERY_DATA="{ \"query\": \"{ Referrers(repo:\\\"alpine\\\", digest:\\\"${MANIFEST_DIGEST}\\\", type:[\\\"artifact.type\\\"]) { MediaType ArtifactType Digest Size} }\"}"
+    run curl -X POST -H "Content-Type: application/json" --data "${REFERRER_QUERY_DATA}" http://localhost:8080/v2/_zot/ext/search
+    [ "$status" -eq 0 ]
+    [ $(echo "${lines[-1]}" | jq '.data.Referrers[].ArtifactType') = '"artifact.type"' ]
+}