Support sha512 content

Signed-off-by: Brandon Mitchell <[email protected]>
opencontainers · Jul 24, 2024 · 063de3f · 063de3f
1 parent 58d034e
commit 063de3f
Show file tree

Hide file tree

Showing 9 changed files with 387 additions and 58 deletions.
diff --git a/.github/workflows/conformance-action-pr.yml b/.github/workflows/conformance-action-pr.yml
diff --git a/.github/workflows/conformance-action.yml b/.github/workflows/conformance-action.yml
@@ -4,6 +4,9 @@ on:
   push:
     branches:
       - main
+  pull_request:
+    branches:
+      - main
 
 jobs:
   run:
@@ -12,12 +15,14 @@ jobs:
       - name: checkout source code
         uses: actions/checkout@v3
       - name: Start a test registry (zot)
+        id: registry-zot
         run: |
           set -x
           make registry-ci
+          echo "port=$(docker port oci-conformance 5000 | head -1 | cut -f2 -d:)" >>$GITHUB_OUTPUT
       - name: Run OCI distribution-spec conformance
         env:
-          OCI_ROOT_URL: http://localhost:5000
+          OCI_ROOT_URL: http://localhost:${{ steps.registry-zot.outputs.port }}
           OCI_NAMESPACE: myorg/myrepo
           OCI_TEST_PULL: 1
           OCI_TEST_PUSH: 1

diff --git a/Makefile b/Makefile
@@ -92,27 +92,33 @@ conformance-test:
 
 conformance-binary: $(OUTPUT_DIRNAME)/conformance.test
 
-TEST_REGISTRY_CONTAINER ?= ghcr.io/project-zot/zot-minimal-linux-amd64:v2.0.0-rc6@sha256:bf95a94849cd9c6f596fb10e5a2d03b74267e7886d1ba0b3dab33337d9e46e5c
+# TODO: update image once changes are merged in zot
+# TEST_REGISTRY_CONTAINER ?= ghcr.io/project-zot/zot-minimal-linux-amd64:v2.1.0
+TEST_REGISTRY_CONTAINER ?= ghcr.io/andaaron/zot-minimal-linux-amd64:v2.1.0-manifest-digest
 registry-ci:
-	docker rm -f oci-conformance && \
-		mkdir -p $(OUTPUT_DIRNAME) && \
-		echo '{"distSpecVersion":"1.1.0-dev","storage":{"rootDirectory":"/tmp/zot","gc":false,"dedupe":false},"http":{"address":"0.0.0.0","port":"5000"},"log":{"level":"debug"}}' > $(shell pwd)/$(OUTPUT_DIRNAME)/zot-config.json
-		docker run -d \
-			-v $(shell pwd)/$(OUTPUT_DIRNAME)/zot-config.json:/etc/zot/config.json \
-			--name=oci-conformance \
-			-p 5000:5000 \
-			$(TEST_REGISTRY_CONTAINER) && \
-		sleep 5
-
-conformance-ci:
-	export OCI_ROOT_URL="http://localhost:5000" && \
+	docker rm -f oci-conformance || true
+	mkdir -p $(OUTPUT_DIRNAME)
+	docker run -d --rm \
+		--name=oci-conformance \
+		-p 5000 \
+		$(TEST_REGISTRY_CONTAINER)
+	sleep 5
+
+conformance-ci: conformance-binary
+	export OCI_ROOT_URL="http://localhost:$$(docker port oci-conformance 5000 | head -1 | cut -f2 -d:)" && \
 		export OCI_NAMESPACE="myorg/myrepo" && \
 		export OCI_TEST_PULL=1 && \
 		export OCI_TEST_PUSH=1 && \
 		export OCI_TEST_CONTENT_DISCOVERY=1 && \
 		export OCI_TEST_CONTENT_MANAGEMENT=1 && \
 		$(shell pwd)/$(OUTPUT_DIRNAME)/conformance.test
 
+conformance-clean:
+	docker stop oci-conformance || true
+	[ ! -f $(OUTPUT_DIRNAME)/conformance.test ] || rm "$(OUTPUT_DIRNAME)/conformance.test"
+	[ ! -f "junit.xml" ] || rm junit.xml
+	[ ! -f "report.html" ] || rm report.html
+
 $(OUTPUT_DIRNAME)/conformance.test:
 	cd conformance && \
 		CGO_ENABLED=0 go test -c -o $(shell pwd)/$(OUTPUT_DIRNAME)/conformance.test \

diff --git a/action.yml b/action.yml
@@ -31,7 +31,7 @@ runs:
       run: |
         set -x
 
-        # Enter the directory containing the checkout of this action which is surpisingly hard to do (but we did it... #OCI)
+        # Enter the directory containing the checkout of this action which is surprisingly hard to do (but we did it... #OCI)
         cd "$(dirname $(find $(find ~/work/_actions -name distribution-spec -print -quit) -name Makefile -print -quit))"
         
         # The .git folder is not present, but the dirname is the requested action ref, so use this as the conformance version

diff --git a/conformance/01_pull_test.go b/conformance/01_pull_test.go
@@ -2,7 +2,6 @@ package conformance
 
 import (
 	"net/http"
-	"os"
 
 	"github.com/bloodorangeio/reggie"
 	g "github.com/onsi/ginkgo/v2"
@@ -12,8 +11,6 @@ import (
 var test01Pull = func() {
 	g.Context(titlePull, func() {
 
-		var tag string
-
 		g.Context("Setup", func() {
 			g.Specify("Populate registry with test blob", func() {
 				SkipIfDisabled(pull)
@@ -72,9 +69,8 @@ var test01Pull = func() {
 			g.Specify("Populate registry with test manifest", func() {
 				SkipIfDisabled(pull)
 				RunOnlyIf(runPullSetup)
-				tag = testTagName
 				req := client.NewRequest(reggie.PUT, "/v2/<name>/manifests/<reference>",
-					reggie.WithReference(tag)).
+					reggie.WithReference(testTagName)).
 					SetHeader("Content-Type", "application/vnd.oci.image.manifest.v1+json").
 					SetBody(manifests[0].Content)
 				resp, err := client.Do(req)
@@ -98,14 +94,41 @@ var test01Pull = func() {
 					BeNumerically("<", 300)))
 			})
 
-			g.Specify("Get tag name from environment", func() {
+			g.Specify("Populate registry with sha512 blobs", func() {
 				SkipIfDisabled(pull)
-				RunOnlyIfNot(runPullSetup)
-				tmp := os.Getenv(envVarTagName)
-				if tmp != "" {
-					tag = tmp
+				RunOnlyIf(runPull512Setup)
+				for _, blob := range testBlobs["sha512"] {
+					req := client.NewRequest(reggie.POST, "/v2/<name>/blobs/uploads/").
+						SetQueryParam("digest-algorithm", "sha512")
+					resp, err := client.Do(req)
+					Expect(err).To(BeNil())
+					req = client.NewRequest(reggie.PUT, resp.GetRelativeLocation()).
+						SetQueryParam("digest", blob.Digest).
+						SetHeader("Content-Type", "application/octet-stream").
+						SetHeader("Content-Length", blob.ContentLength).
+						SetBody(blob.Content)
+					resp, err = client.Do(req)
+					Expect(err).To(BeNil())
+					Expect(resp.StatusCode()).To(SatisfyAll(
+						BeNumerically(">=", 200),
+						BeNumerically("<", 300)))
 				}
 			})
+
+			g.Specify("Populate registry with test sha512 manifest", func() {
+				SkipIfDisabled(pull)
+				RunOnlyIf(runPull512Setup)
+				req := client.NewRequest(reggie.PUT, "/v2/<name>/manifests/<reference>",
+					reggie.WithReference(testTag512Name)).
+					SetQueryParam("digest", testManifests["sha512"].Digest).
+					SetHeader("Content-Type", "application/vnd.oci.image.manifest.v1+json").
+					SetBody(testManifests["sha512"].Content)
+				resp, err := client.Do(req)
+				Expect(err).To(BeNil())
+				Expect(resp.StatusCode()).To(SatisfyAll(
+					BeNumerically(">=", 200),
+					BeNumerically("<", 300)))
+			})
 		})
 
 		g.Context("Pull blobs", func() {
@@ -130,6 +153,18 @@ var test01Pull = func() {
 				}
 			})
 
+			g.Specify("HEAD request to existing sha512 blob should yield 200", func() {
+				SkipIfDisabled(pull)
+				req := client.NewRequest(reggie.HEAD, "/v2/<name>/blobs/<digest>",
+					reggie.WithDigest(testBlobs["sha512"][0].Digest))
+				resp, err := client.Do(req)
+				Expect(err).To(BeNil())
+				Expect(resp.StatusCode()).To(Equal(http.StatusOK))
+				if h := resp.Header().Get("Docker-Content-Digest"); h != "" {
+					Expect(h).To(Equal(testBlobs["sha512"][0].Digest))
+				}
+			})
+
 			g.Specify("GET nonexistent blob should result in 404 response", func() {
 				SkipIfDisabled(pull)
 				req := client.NewRequest(reggie.GET, "/v2/<name>/blobs/<digest>",
@@ -146,6 +181,15 @@ var test01Pull = func() {
 				Expect(err).To(BeNil())
 				Expect(resp.StatusCode()).To(Equal(http.StatusOK))
 			})
+
+			g.Specify("GET request to existing sha512 blob URL should yield 200", func() {
+				SkipIfDisabled(pull)
+				req := client.NewRequest(reggie.GET, "/v2/<name>/blobs/<digest>",
+					reggie.WithDigest(testBlobs["sha512"][0].Digest))
+				resp, err := client.Do(req)
+				Expect(err).To(BeNil())
+				Expect(resp.StatusCode()).To(Equal(http.StatusOK))
+			})
 		})
 
 		g.Context("Pull manifests", func() {
@@ -182,10 +226,23 @@ var test01Pull = func() {
 				}
 			})
 
+			g.Specify("HEAD request to sha512 manifest (digest) should yield 200 response", func() {
+				SkipIfDisabled(pull)
+				req := client.NewRequest(reggie.HEAD, "/v2/<name>/manifests/<digest>",
+					reggie.WithDigest(testManifests["sha512"].Digest)).
+					SetHeader("Accept", "application/vnd.oci.image.manifest.v1+json")
+				resp, err := client.Do(req)
+				Expect(err).To(BeNil())
+				Expect(resp.StatusCode()).To(Equal(http.StatusOK))
+				if h := resp.Header().Get("Docker-Content-Digest"); h != "" {
+					Expect(h).To(Equal(testManifests["sha512"].Digest))
+				}
+			})
+
 			g.Specify("HEAD request to manifest path (tag) should yield 200 response", func() {
 				SkipIfDisabled(pull)
-				Expect(tag).ToNot(BeEmpty())
-				req := client.NewRequest(reggie.HEAD, "/v2/<name>/manifests/<reference>", reggie.WithReference(tag)).
+				Expect(testTagName).ToNot(BeEmpty())
+				req := client.NewRequest(reggie.HEAD, "/v2/<name>/manifests/<reference>", reggie.WithReference(testTagName)).
 					SetHeader("Accept", "application/vnd.oci.image.manifest.v1+json")
 				resp, err := client.Do(req)
 				Expect(err).To(BeNil())
@@ -195,6 +252,19 @@ var test01Pull = func() {
 				}
 			})
 
+			g.Specify("HEAD request to sha512 manifest (tag) should yield 200 response", func() {
+				SkipIfDisabled(pull)
+				Expect(testTag512Name).ToNot(BeEmpty())
+				req := client.NewRequest(reggie.HEAD, "/v2/<name>/manifests/<reference>", reggie.WithReference(testTag512Name)).
+					SetHeader("Accept", "application/vnd.oci.image.manifest.v1+json")
+				resp, err := client.Do(req)
+				Expect(err).To(BeNil())
+				Expect(resp.StatusCode()).To(Equal(http.StatusOK))
+				if h := resp.Header().Get("Docker-Content-Digest"); h != "" {
+					Expect(h).To(Equal(testManifests["sha512"].Digest))
+				}
+			})
+
 			g.Specify("GET nonexistent manifest should return 404", func() {
 				SkipIfDisabled(pull)
 				req := client.NewRequest(reggie.GET, "/v2/<name>/manifests/<reference>",
@@ -222,10 +292,29 @@ var test01Pull = func() {
 				Expect(resp.StatusCode()).To(Equal(http.StatusOK))
 			})
 
+			g.Specify("GET request to sha512 manifest (digest) should yield 200 response", func() {
+				SkipIfDisabled(pull)
+				req := client.NewRequest(reggie.GET, "/v2/<name>/manifests/<digest>", reggie.WithDigest(testManifests["sha512"].Digest)).
+					SetHeader("Accept", "application/vnd.oci.image.manifest.v1+json")
+				resp, err := client.Do(req)
+				Expect(err).To(BeNil())
+				Expect(resp.StatusCode()).To(Equal(http.StatusOK))
+			})
+
 			g.Specify("GET request to manifest path (tag) should yield 200 response", func() {
 				SkipIfDisabled(pull)
-				Expect(tag).ToNot(BeEmpty())
-				req := client.NewRequest(reggie.GET, "/v2/<name>/manifests/<reference>", reggie.WithReference(tag)).
+				Expect(testTagName).ToNot(BeEmpty())
+				req := client.NewRequest(reggie.GET, "/v2/<name>/manifests/<reference>", reggie.WithReference(testTagName)).
+					SetHeader("Accept", "application/vnd.oci.image.manifest.v1+json")
+				resp, err := client.Do(req)
+				Expect(err).To(BeNil())
+				Expect(resp.StatusCode()).To(Equal(http.StatusOK))
+			})
+
+			g.Specify("GET request to sha512 manifest (tag) should yield 200 response", func() {
+				SkipIfDisabled(pull)
+				Expect(testTag512Name).ToNot(BeEmpty())
+				req := client.NewRequest(reggie.GET, "/v2/<name>/manifests/<reference>", reggie.WithReference(testTag512Name)).
 					SetHeader("Accept", "application/vnd.oci.image.manifest.v1+json")
 				resp, err := client.Do(req)
 				Expect(err).To(BeNil())
@@ -285,6 +374,20 @@ var test01Pull = func() {
 						Equal(http.StatusMethodNotAllowed),
 					))
 				})
+				g.Specify("Delete sha512 manifest created in setup", func() {
+					SkipIfDisabled(pull)
+					RunOnlyIf(runPull512Setup)
+					req := client.NewRequest(reggie.DELETE, "/v2/<name>/manifests/<digest>", reggie.WithDigest(testManifests["sha512"].Digest))
+					resp, err := client.Do(req)
+					Expect(err).To(BeNil())
+					Expect(resp.StatusCode()).To(SatisfyAny(
+						SatisfyAll(
+							BeNumerically(">=", 200),
+							BeNumerically("<", 300),
+						),
+						Equal(http.StatusMethodNotAllowed),
+					))
+				})
 			}
 
 			g.Specify("Delete config[0] blob created in setup", func() {
@@ -331,6 +434,24 @@ var test01Pull = func() {
 				))
 			})
 
+			for _, blob := range testBlobs["sha512"] {
+				g.Specify("Delete blob created in setup", func() {
+					SkipIfDisabled(pull)
+					RunOnlyIf(runPull512Setup)
+					req := client.NewRequest(reggie.DELETE, "/v2/<name>/blobs/<digest>", reggie.WithDigest(blob.Digest))
+					resp, err := client.Do(req)
+					Expect(err).To(BeNil())
+					Expect(resp.StatusCode()).To(SatisfyAny(
+						SatisfyAll(
+							BeNumerically(">=", 200),
+							BeNumerically("<", 300),
+						),
+						Equal(http.StatusNotFound),
+						Equal(http.StatusMethodNotAllowed),
+					))
+				})
+			}
+
 			if !deleteManifestBeforeBlobs {
 				g.Specify("Delete manifest[0] created in setup", func() {
 					SkipIfDisabled(pull)
@@ -360,6 +481,20 @@ var test01Pull = func() {
 						Equal(http.StatusMethodNotAllowed),
 					))
 				})
+				g.Specify("Delete sha512 manifest created in setup", func() {
+					SkipIfDisabled(pull)
+					RunOnlyIf(runPull512Setup)
+					req := client.NewRequest(reggie.DELETE, "/v2/<name>/manifests/<digest>", reggie.WithDigest(testManifests["sha512"].Digest))
+					resp, err := client.Do(req)
+					Expect(err).To(BeNil())
+					Expect(resp.StatusCode()).To(SatisfyAny(
+						SatisfyAll(
+							BeNumerically(">=", 200),
+							BeNumerically("<", 300),
+						),
+						Equal(http.StatusMethodNotAllowed),
+					))
+				})
 			}
 		})
 	})