zot/pkg/meta/common/common_test.go

package common_test

import (
	"errors"
	"testing"
	"time"

	"github.com/opencontainers/go-digest"
	ispec "github.com/opencontainers/image-spec/specs-go/v1"
	. "github.com/smartystreets/goconvey/convey"

	"zotregistry.io/zot/pkg/meta/common"
	"zotregistry.io/zot/pkg/meta/repodb"
	"zotregistry.io/zot/pkg/test/mocks"
)

var ErrTestError = errors.New("test error")

func TestUtils(t *testing.T) {
	Convey("GetReferredSubject", t, func() {
		_, err := common.GetReferredSubject([]byte("bad json"))
		So(err, ShouldNotBeNil)
	})

	Convey("MatchesArtifactTypes", t, func() {
		res := common.MatchesArtifactTypes("", nil)
		So(res, ShouldBeTrue)

		res = common.MatchesArtifactTypes("type", []string{"someOtherType"})
		So(res, ShouldBeFalse)
	})

	Convey("CheckImageLastUpdated", t, func() {
		Convey("No image checked, it doesn't have time", func() {
			repoLastUpdated := time.Time{}
			isSigned := false
			noImageChecked := true
			manifestFilterData := repodb.FilterData{
				DownloadCount: 10,
				LastUpdated:   time.Time{},
				IsSigned:      true,
			}

			repoLastUpdated, noImageChecked, isSigned = common.CheckImageLastUpdated(repoLastUpdated, isSigned, noImageChecked,
				manifestFilterData)
			So(repoLastUpdated, ShouldResemble, manifestFilterData.LastUpdated)
			So(isSigned, ShouldEqual, manifestFilterData.IsSigned)
			So(noImageChecked, ShouldEqual, false)
		})

		Convey("First image checked, it has time", func() {
			repoLastUpdated := time.Time{}
			isSigned := false
			noImageChecked := true
			manifestFilterData := repodb.FilterData{
				DownloadCount: 10,
				LastUpdated:   time.Date(2000, 1, 1, 1, 1, 1, 1, time.UTC),
				IsSigned:      true,
			}

			repoLastUpdated, noImageChecked, isSigned = common.CheckImageLastUpdated(repoLastUpdated, isSigned, noImageChecked,
				manifestFilterData)
			So(repoLastUpdated, ShouldResemble, manifestFilterData.LastUpdated)
			So(isSigned, ShouldEqual, manifestFilterData.IsSigned)
			So(noImageChecked, ShouldEqual, false)
		})

		Convey("Not first image checked, current image is newer", func() {
			repoLastUpdated := time.Date(2000, 1, 1, 1, 1, 1, 1, time.UTC)
			isSigned := true
			noImageChecked := false
			manifestFilterData := repodb.FilterData{
				DownloadCount: 10,
				LastUpdated:   time.Date(2023, 1, 1, 1, 1, 1, 1, time.UTC),
				IsSigned:      false,
			}

			repoLastUpdated, noImageChecked, isSigned = common.CheckImageLastUpdated(repoLastUpdated, isSigned,
				noImageChecked, manifestFilterData)
			So(repoLastUpdated, ShouldResemble, manifestFilterData.LastUpdated)
			So(isSigned, ShouldEqual, manifestFilterData.IsSigned)
			So(noImageChecked, ShouldEqual, false)
		})

		Convey("Not first image checked, current image is older", func() {
			repoLastUpdated := time.Date(2024, 1, 1, 1, 1, 1, 1, time.UTC)
			isSigned := false
			noImageChecked := false
			manifestFilterData := repodb.FilterData{
				DownloadCount: 10,
				LastUpdated:   time.Date(2022, 1, 1, 1, 1, 1, 1, time.UTC),
				IsSigned:      true,
			}

			updatedRepoLastUpdated, noImageChecked, isSigned := common.CheckImageLastUpdated(repoLastUpdated, isSigned,
				noImageChecked,
				manifestFilterData)
			So(updatedRepoLastUpdated, ShouldResemble, repoLastUpdated)
			So(isSigned, ShouldEqual, false)
			So(noImageChecked, ShouldEqual, false)
		})
	})

	Convey("SignatureAlreadyExists", t, func() {
		res := common.SignatureAlreadyExists(
			[]repodb.SignatureInfo{{SignatureManifestDigest: "digest"}},
			repodb.SignatureMetadata{SignatureDigest: "digest"},
		)

		So(res, ShouldEqual, true)

		res = common.SignatureAlreadyExists(
			[]repodb.SignatureInfo{{SignatureManifestDigest: "digest"}},
			repodb.SignatureMetadata{SignatureDigest: "digest2"},
		)

		So(res, ShouldEqual, false)
	})

	Convey("FilterDataByRepo", t, func() {
		Convey("Errors", func() {
			// Unmarshal index data error
			_, _, err := common.FilterDataByRepo(
				[]repodb.RepoMetadata{{
					Tags: map[string]repodb.Descriptor{
						"tag": {
							Digest:    "indexDigest",
							MediaType: ispec.MediaTypeImageIndex,
						},
					},
				}},
				map[string]repodb.ManifestMetadata{},
				map[string]repodb.IndexData{
					"indexDigest": {
						IndexBlob: []byte("bad blob"),
					},
				},
			)

			So(err, ShouldNotBeNil)
		})
	})

	Convey("FetchDataForRepos", t, func() {
		Convey("Errors", func() {
			// Unmarshal index data error
			_, _, err := common.FetchDataForRepos(
				mocks.RepoDBMock{
					GetIndexDataFn: func(indexDigest digest.Digest) (repodb.IndexData, error) {
						return repodb.IndexData{
							IndexBlob: []byte("bad blob"),
						}, nil
					},
				},
				[]repodb.RepoMetadata{{
					Tags: map[string]repodb.Descriptor{
						"tag": {
							Digest:    "indexDigest",
							MediaType: ispec.MediaTypeImageIndex,
						},
					},
				}},
			)
			So(err, ShouldNotBeNil)
		})
	})
}

func TestFetchDataForRepos(t *testing.T) {
	Convey("GetReferredSubject", t, func() {
		mockRepoDB := mocks.RepoDBMock{}

		Convey("GetManifestData errors", func() {
			mockRepoDB.GetManifestDataFn = func(manifestDigest digest.Digest) (repodb.ManifestData, error) {
				return repodb.ManifestData{}, ErrTestError
			}

			_, _, err := common.FetchDataForRepos(mockRepoDB, []repodb.RepoMetadata{
				{
					Tags: map[string]repodb.Descriptor{
						"tag1": {Digest: "dig1", MediaType: ispec.MediaTypeImageManifest},
					},
				},
			})
			So(err, ShouldNotBeNil)
		})

		Convey("GetIndexData errors", func() {
			mockRepoDB.GetIndexDataFn = func(indexDigest digest.Digest) (repodb.IndexData, error) {
				return repodb.IndexData{}, ErrTestError
			}

			_, _, err := common.FetchDataForRepos(mockRepoDB, []repodb.RepoMetadata{
				{
					Tags: map[string]repodb.Descriptor{
						"tag1": {Digest: "dig1", MediaType: ispec.MediaTypeImageIndex},
					},
				},
			})
			So(err, ShouldNotBeNil)
		})

		Convey("GetIndexData ok, GetManifestData errors", func() {
			mockRepoDB.GetIndexDataFn = func(indexDigest digest.Digest) (repodb.IndexData, error) {
				return repodb.IndexData{
					IndexBlob: []byte(`{
						"manifests": [
							{"digest": "dig1"}
						]
					}`),
				}, nil
			}
			mockRepoDB.GetManifestDataFn = func(manifestDigest digest.Digest) (repodb.ManifestData, error) {
				return repodb.ManifestData{}, ErrTestError
			}

			_, _, err := common.FetchDataForRepos(mockRepoDB, []repodb.RepoMetadata{
				{
					Tags: map[string]repodb.Descriptor{
						"tag1": {Digest: "dig1", MediaType: ispec.MediaTypeImageIndex},
					},
				},
			})
			So(err, ShouldNotBeNil)
		})
	})
}