mirror of
https://github.com/project-zot/zot.git
synced 2026-06-17 12:58:02 +08:00
refactor: move pkg/extensions/search/common/oci_layout.go under pkg/test/ (#1325)
Signed-off-by: Nicol Draghici <idraghic@cisco.com>
This commit is contained in:
@@ -0,0 +1,581 @@
|
||||
//go:build sync && scrub && metrics && search
|
||||
// +build sync,scrub,metrics,search
|
||||
|
||||
package test
|
||||
|
||||
import (
|
||||
"encoding/json"
|
||||
goerrors "errors"
|
||||
"fmt"
|
||||
"path"
|
||||
"strconv"
|
||||
"strings"
|
||||
"time"
|
||||
|
||||
notreg "github.com/notaryproject/notation-go/registry"
|
||||
godigest "github.com/opencontainers/go-digest"
|
||||
ispec "github.com/opencontainers/image-spec/specs-go/v1"
|
||||
|
||||
zerr "zotregistry.io/zot/errors"
|
||||
"zotregistry.io/zot/pkg/extensions/search/common"
|
||||
"zotregistry.io/zot/pkg/log"
|
||||
"zotregistry.io/zot/pkg/storage"
|
||||
)
|
||||
|
||||
type OciLayoutUtils interface { //nolint: interfacebloat
|
||||
GetImageManifest(repo string, reference string) (ispec.Manifest, godigest.Digest, error)
|
||||
GetImageManifests(repo string) ([]ispec.Descriptor, error)
|
||||
GetImageBlobManifest(repo string, digest godigest.Digest) (ispec.Manifest, error)
|
||||
GetImageInfo(repo string, configDigest godigest.Digest) (ispec.Image, error)
|
||||
GetImageTagsWithTimestamp(repo string) ([]common.TagInfo, error)
|
||||
GetImagePlatform(imageInfo ispec.Image) (string, string)
|
||||
GetImageManifestSize(repo string, manifestDigest godigest.Digest) int64
|
||||
GetRepoLastUpdated(repo string) (common.TagInfo, error)
|
||||
GetExpandedRepoInfo(name string) (common.RepoInfo, error)
|
||||
GetImageConfigInfo(repo string, manifestDigest godigest.Digest) (ispec.Image, error)
|
||||
CheckManifestSignature(name string, digest godigest.Digest) bool
|
||||
GetRepositories() ([]string, error)
|
||||
ExtractImageDetails(repo string, tag string, log log.Logger) (godigest.Digest,
|
||||
*ispec.Manifest, *ispec.Image, error)
|
||||
}
|
||||
|
||||
// OciLayoutInfo ...
|
||||
type BaseOciLayoutUtils struct {
|
||||
Log log.Logger
|
||||
StoreController storage.StoreController
|
||||
}
|
||||
|
||||
// NewBaseOciLayoutUtils initializes a new OciLayoutUtils object.
|
||||
func NewBaseOciLayoutUtils(storeController storage.StoreController, log log.Logger) *BaseOciLayoutUtils {
|
||||
return &BaseOciLayoutUtils{Log: log, StoreController: storeController}
|
||||
}
|
||||
|
||||
func (olu BaseOciLayoutUtils) GetImageManifest(repo string, reference string) (ispec.Manifest, godigest.Digest, error) {
|
||||
imageStore := olu.StoreController.GetImageStore(repo)
|
||||
|
||||
if reference == "" {
|
||||
reference = "latest"
|
||||
}
|
||||
|
||||
manifestBlob, digest, _, err := imageStore.GetImageManifest(repo, reference)
|
||||
if err != nil {
|
||||
return ispec.Manifest{}, "", err
|
||||
}
|
||||
|
||||
var manifest ispec.Manifest
|
||||
|
||||
err = json.Unmarshal(manifestBlob, &manifest)
|
||||
if err != nil {
|
||||
return ispec.Manifest{}, "", err
|
||||
}
|
||||
|
||||
return manifest, digest, nil
|
||||
}
|
||||
|
||||
// Provide a list of repositories from all the available image stores.
|
||||
func (olu BaseOciLayoutUtils) GetRepositories() ([]string, error) {
|
||||
defaultStore := olu.StoreController.DefaultStore
|
||||
substores := olu.StoreController.SubStore
|
||||
|
||||
repoList, err := defaultStore.GetRepositories()
|
||||
if err != nil {
|
||||
return []string{}, err
|
||||
}
|
||||
|
||||
for _, sub := range substores {
|
||||
repoListForSubstore, err := sub.GetRepositories()
|
||||
if err != nil {
|
||||
return []string{}, err
|
||||
}
|
||||
|
||||
repoList = append(repoList, repoListForSubstore...)
|
||||
}
|
||||
|
||||
return repoList, nil
|
||||
}
|
||||
|
||||
// Below method will return image path including root dir, root dir is determined by splitting.
|
||||
func (olu BaseOciLayoutUtils) GetImageManifests(repo string) ([]ispec.Descriptor, error) {
|
||||
var lockLatency time.Time
|
||||
|
||||
imageStore := olu.StoreController.GetImageStore(repo)
|
||||
|
||||
imageStore.RLock(&lockLatency)
|
||||
defer imageStore.RUnlock(&lockLatency)
|
||||
|
||||
buf, err := imageStore.GetIndexContent(repo)
|
||||
if err != nil {
|
||||
if goerrors.Is(zerr.ErrRepoNotFound, err) {
|
||||
olu.Log.Error().Err(err).Msg("index.json doesn't exist")
|
||||
|
||||
return nil, zerr.ErrRepoNotFound
|
||||
}
|
||||
|
||||
olu.Log.Error().Err(err).Msg("unable to open index.json")
|
||||
|
||||
return nil, zerr.ErrRepoNotFound
|
||||
}
|
||||
|
||||
var index ispec.Index
|
||||
|
||||
if err := json.Unmarshal(buf, &index); err != nil {
|
||||
olu.Log.Error().Err(err).Str("dir", path.Join(imageStore.RootDir(), repo)).Msg("invalid JSON")
|
||||
|
||||
return nil, zerr.ErrRepoNotFound
|
||||
}
|
||||
|
||||
return index.Manifests, nil
|
||||
}
|
||||
|
||||
func (olu BaseOciLayoutUtils) GetImageBlobManifest(repo string, digest godigest.Digest) (ispec.Manifest, error) {
|
||||
var blobIndex ispec.Manifest
|
||||
|
||||
var lockLatency time.Time
|
||||
|
||||
imageStore := olu.StoreController.GetImageStore(repo)
|
||||
|
||||
imageStore.RLock(&lockLatency)
|
||||
defer imageStore.RUnlock(&lockLatency)
|
||||
|
||||
blobBuf, err := imageStore.GetBlobContent(repo, digest)
|
||||
if err != nil {
|
||||
olu.Log.Error().Err(err).Msg("unable to open image metadata file")
|
||||
|
||||
return blobIndex, err
|
||||
}
|
||||
|
||||
if err := json.Unmarshal(blobBuf, &blobIndex); err != nil {
|
||||
olu.Log.Error().Err(err).Msg("unable to marshal blob index")
|
||||
|
||||
return blobIndex, err
|
||||
}
|
||||
|
||||
return blobIndex, nil
|
||||
}
|
||||
|
||||
func (olu BaseOciLayoutUtils) GetImageInfo(repo string, configDigest godigest.Digest) (ispec.Image, error) {
|
||||
var imageInfo ispec.Image
|
||||
|
||||
var lockLatency time.Time
|
||||
|
||||
imageStore := olu.StoreController.GetImageStore(repo)
|
||||
|
||||
imageStore.RLock(&lockLatency)
|
||||
defer imageStore.RUnlock(&lockLatency)
|
||||
|
||||
blobBuf, err := imageStore.GetBlobContent(repo, configDigest)
|
||||
if err != nil {
|
||||
olu.Log.Error().Err(err).Msg("unable to open image layers file")
|
||||
|
||||
return imageInfo, err
|
||||
}
|
||||
|
||||
if err := json.Unmarshal(blobBuf, &imageInfo); err != nil {
|
||||
olu.Log.Error().Err(err).Msg("unable to marshal blob index")
|
||||
|
||||
return imageInfo, err
|
||||
}
|
||||
|
||||
return imageInfo, err
|
||||
}
|
||||
|
||||
// GetImageTagsWithTimestamp returns a list of image tags with timestamp available in the specified repository.
|
||||
func (olu BaseOciLayoutUtils) GetImageTagsWithTimestamp(repo string) ([]common.TagInfo, error) {
|
||||
tagsInfo := make([]common.TagInfo, 0)
|
||||
|
||||
manifests, err := olu.GetImageManifests(repo)
|
||||
if err != nil {
|
||||
olu.Log.Error().Err(err).Msg("unable to read image manifests")
|
||||
|
||||
return tagsInfo, err
|
||||
}
|
||||
|
||||
for _, manifest := range manifests {
|
||||
digest := manifest.Digest
|
||||
|
||||
val, ok := manifest.Annotations[ispec.AnnotationRefName]
|
||||
if ok {
|
||||
imageBlobManifest, err := olu.GetImageBlobManifest(repo, digest)
|
||||
if err != nil {
|
||||
olu.Log.Error().Err(err).Msg("unable to read image blob manifest")
|
||||
|
||||
return tagsInfo, err
|
||||
}
|
||||
|
||||
imageInfo, err := olu.GetImageInfo(repo, imageBlobManifest.Config.Digest)
|
||||
if err != nil {
|
||||
olu.Log.Error().Err(err).Msg("unable to read image info")
|
||||
|
||||
return tagsInfo, err
|
||||
}
|
||||
|
||||
timeStamp := common.GetImageLastUpdated(imageInfo)
|
||||
|
||||
tagsInfo = append(tagsInfo,
|
||||
common.TagInfo{
|
||||
Name: val,
|
||||
Timestamp: timeStamp,
|
||||
Descriptor: common.Descriptor{
|
||||
Digest: digest,
|
||||
MediaType: manifest.MediaType,
|
||||
},
|
||||
},
|
||||
)
|
||||
}
|
||||
}
|
||||
|
||||
return tagsInfo, nil
|
||||
}
|
||||
|
||||
// check notary signature corresponding to repo name, manifest digest and mediatype.
|
||||
func (olu BaseOciLayoutUtils) checkNotarySignature(name string, digest godigest.Digest) bool {
|
||||
imageStore := olu.StoreController.GetImageStore(name)
|
||||
mediaType := notreg.ArtifactTypeNotation
|
||||
|
||||
referrers, err := imageStore.GetReferrers(name, digest, []string{mediaType})
|
||||
if err != nil {
|
||||
olu.Log.Info().Err(err).Str("repo", name).Str("digest",
|
||||
digest.String()).Str("mediatype", mediaType).Msg("invalid notary signature")
|
||||
|
||||
return false
|
||||
}
|
||||
|
||||
if len(referrers.Manifests) == 0 {
|
||||
return false
|
||||
}
|
||||
|
||||
return true
|
||||
}
|
||||
|
||||
// check cosign signature corresponding to manifest.
|
||||
func (olu BaseOciLayoutUtils) checkCosignSignature(name string, digest godigest.Digest) bool {
|
||||
if digest.Validate() != nil {
|
||||
return false
|
||||
}
|
||||
|
||||
imageStore := olu.StoreController.GetImageStore(name)
|
||||
|
||||
// if manifest is signed using cosign mechanism, cosign adds a new manifest.
|
||||
// new manifest is tagged as sha256-<manifest-digest>.sig.
|
||||
reference := fmt.Sprintf("sha256-%s.sig", digest.Encoded())
|
||||
|
||||
_, _, _, err := imageStore.GetImageManifest(name, reference) //nolint: dogsled
|
||||
if err != nil {
|
||||
olu.Log.Info().Err(err).Str("repo", name).Str("digest",
|
||||
digest.String()).Msg("invalid cosign signature")
|
||||
|
||||
return false
|
||||
}
|
||||
|
||||
return true
|
||||
}
|
||||
|
||||
// checks if manifest is signed or not
|
||||
// checks for notary or cosign signature
|
||||
// if cosign signature found it does not looks for notary signature.
|
||||
func (olu BaseOciLayoutUtils) CheckManifestSignature(name string, digest godigest.Digest) bool {
|
||||
if !olu.checkCosignSignature(name, digest) {
|
||||
return olu.checkNotarySignature(name, digest)
|
||||
}
|
||||
|
||||
return true
|
||||
}
|
||||
|
||||
func (olu BaseOciLayoutUtils) GetImagePlatform(imageConfig ispec.Image) (
|
||||
string, string,
|
||||
) {
|
||||
return imageConfig.OS, imageConfig.Architecture
|
||||
}
|
||||
|
||||
func (olu BaseOciLayoutUtils) GetImageConfigInfo(repo string, manifestDigest godigest.Digest) (ispec.Image, error) {
|
||||
imageBlobManifest, err := olu.GetImageBlobManifest(repo, manifestDigest)
|
||||
if err != nil {
|
||||
return ispec.Image{}, err
|
||||
}
|
||||
|
||||
imageInfo, err := olu.GetImageInfo(repo, imageBlobManifest.Config.Digest)
|
||||
if err != nil {
|
||||
return ispec.Image{}, err
|
||||
}
|
||||
|
||||
return imageInfo, nil
|
||||
}
|
||||
|
||||
func (olu BaseOciLayoutUtils) GetImageManifestSize(repo string, manifestDigest godigest.Digest) int64 {
|
||||
imageStore := olu.StoreController.GetImageStore(repo)
|
||||
|
||||
var lockLatency time.Time
|
||||
|
||||
imageStore.RLock(&lockLatency)
|
||||
defer imageStore.RUnlock(&lockLatency)
|
||||
|
||||
manifestBlob, err := imageStore.GetBlobContent(repo, manifestDigest)
|
||||
if err != nil {
|
||||
olu.Log.Error().Err(err).Msg("error when getting manifest blob content")
|
||||
|
||||
return int64(len(manifestBlob))
|
||||
}
|
||||
|
||||
return int64(len(manifestBlob))
|
||||
}
|
||||
|
||||
func (olu BaseOciLayoutUtils) GetImageConfigSize(repo string, manifestDigest godigest.Digest) int64 {
|
||||
imageBlobManifest, err := olu.GetImageBlobManifest(repo, manifestDigest)
|
||||
if err != nil {
|
||||
olu.Log.Error().Err(err).Msg("can't get image blob manifest")
|
||||
|
||||
return 0
|
||||
}
|
||||
|
||||
return imageBlobManifest.Config.Size
|
||||
}
|
||||
|
||||
func (olu BaseOciLayoutUtils) GetRepoLastUpdated(repo string) (common.TagInfo, error) {
|
||||
tagsInfo, err := olu.GetImageTagsWithTimestamp(repo)
|
||||
if err != nil || len(tagsInfo) == 0 {
|
||||
return common.TagInfo{}, err
|
||||
}
|
||||
|
||||
latestTag := common.GetLatestTag(tagsInfo)
|
||||
|
||||
return latestTag, nil
|
||||
}
|
||||
|
||||
func (olu BaseOciLayoutUtils) GetExpandedRepoInfo(repoName string) (common.RepoInfo, error) {
|
||||
repo := common.RepoInfo{}
|
||||
repoBlob2Size := make(map[string]int64, 10)
|
||||
|
||||
// made up of all manifests, configs and image layers
|
||||
repoSize := int64(0)
|
||||
|
||||
imageSummaries := make([]common.ImageSummary, 0)
|
||||
|
||||
manifestList, err := olu.GetImageManifests(repoName)
|
||||
if err != nil {
|
||||
olu.Log.Error().Err(err).Msg("error getting image manifests")
|
||||
|
||||
return common.RepoInfo{}, err
|
||||
}
|
||||
|
||||
lastUpdatedTag, err := olu.GetRepoLastUpdated(repoName)
|
||||
if err != nil {
|
||||
olu.Log.Error().Err(err).Msgf("can't get last updated manifest for repo: %s", repoName)
|
||||
|
||||
return common.RepoInfo{}, err
|
||||
}
|
||||
|
||||
repoVendorsSet := make(map[string]bool, len(manifestList))
|
||||
repoPlatformsSet := make(map[string]common.Platform, len(manifestList))
|
||||
|
||||
var lastUpdatedImageSummary common.ImageSummary
|
||||
|
||||
for _, man := range manifestList {
|
||||
imageLayersSize := int64(0)
|
||||
|
||||
tag, ok := man.Annotations[ispec.AnnotationRefName]
|
||||
if !ok {
|
||||
olu.Log.Info().Msgf("skipping manifest with digest %s because it doesn't have a tag",
|
||||
man.Digest.String())
|
||||
|
||||
continue
|
||||
}
|
||||
|
||||
manifest, err := olu.GetImageBlobManifest(repoName, man.Digest)
|
||||
if err != nil {
|
||||
olu.Log.Error().Err(err).Msg("error getting image manifest blob")
|
||||
|
||||
return common.RepoInfo{}, err
|
||||
}
|
||||
|
||||
isSigned := olu.CheckManifestSignature(repoName, man.Digest)
|
||||
|
||||
manifestSize := olu.GetImageManifestSize(repoName, man.Digest)
|
||||
olu.Log.Debug().Msg(fmt.Sprintf("%v", man.Digest.String()))
|
||||
configSize := manifest.Config.Size
|
||||
|
||||
repoBlob2Size[man.Digest.String()] = manifestSize
|
||||
repoBlob2Size[manifest.Config.Digest.String()] = configSize
|
||||
|
||||
imageConfigInfo, err := olu.GetImageConfigInfo(repoName, man.Digest)
|
||||
if err != nil {
|
||||
olu.Log.Error().Err(err).Msgf("can't retrieve config info for the image %s %s", repoName, man.Digest)
|
||||
|
||||
continue
|
||||
}
|
||||
|
||||
opSys, arch := olu.GetImagePlatform(imageConfigInfo)
|
||||
platform := common.Platform{
|
||||
Os: opSys,
|
||||
Arch: arch,
|
||||
}
|
||||
|
||||
if opSys != "" || arch != "" {
|
||||
platformString := strings.TrimSpace(fmt.Sprintf("%s %s", opSys, arch))
|
||||
repoPlatformsSet[platformString] = platform
|
||||
}
|
||||
|
||||
layers := make([]common.LayerSummary, 0)
|
||||
|
||||
for _, layer := range manifest.Layers {
|
||||
layerInfo := common.LayerSummary{}
|
||||
|
||||
layerInfo.Digest = layer.Digest.String()
|
||||
|
||||
repoBlob2Size[layerInfo.Digest] = layer.Size
|
||||
|
||||
layerInfo.Size = strconv.FormatInt(layer.Size, 10)
|
||||
|
||||
imageLayersSize += layer.Size
|
||||
|
||||
layers = append(layers, layerInfo)
|
||||
}
|
||||
|
||||
imageSize := imageLayersSize + manifestSize + configSize
|
||||
|
||||
// get image info from manifest annotation, if not found get from image config labels.
|
||||
annotations := common.GetAnnotations(manifest.Annotations, imageConfigInfo.Config.Labels)
|
||||
|
||||
if annotations.Vendor != "" {
|
||||
repoVendorsSet[annotations.Vendor] = true
|
||||
}
|
||||
|
||||
imageConfigHistory := imageConfigInfo.History
|
||||
allHistory := []common.LayerHistory{}
|
||||
|
||||
if len(imageConfigHistory) == 0 {
|
||||
for _, layer := range layers {
|
||||
allHistory = append(allHistory, common.LayerHistory{
|
||||
Layer: layer,
|
||||
HistoryDescription: common.HistoryDescription{},
|
||||
})
|
||||
}
|
||||
} else {
|
||||
// iterator over manifest layers
|
||||
var layersIterator int
|
||||
// since we are appending pointers, it is important to iterate with an index over slice
|
||||
for i := range imageConfigHistory {
|
||||
allHistory = append(allHistory, common.LayerHistory{
|
||||
HistoryDescription: common.HistoryDescription{
|
||||
Created: *imageConfigHistory[i].Created,
|
||||
CreatedBy: imageConfigHistory[i].CreatedBy,
|
||||
Author: imageConfigHistory[i].Author,
|
||||
Comment: imageConfigHistory[i].Comment,
|
||||
EmptyLayer: imageConfigHistory[i].EmptyLayer,
|
||||
},
|
||||
})
|
||||
|
||||
if imageConfigHistory[i].EmptyLayer {
|
||||
continue
|
||||
}
|
||||
|
||||
if layersIterator+1 > len(layers) {
|
||||
olu.Log.Error().Err(zerr.ErrBadLayerCount).
|
||||
Msgf("error on creating layer history for image %s %s", repoName, man.Digest)
|
||||
|
||||
break
|
||||
}
|
||||
|
||||
allHistory[i].Layer = layers[layersIterator]
|
||||
|
||||
layersIterator++
|
||||
}
|
||||
}
|
||||
|
||||
olu.Log.Debug().Msgf("all history %v", allHistory)
|
||||
|
||||
size := strconv.Itoa(int(imageSize))
|
||||
manifestDigest := man.Digest.String()
|
||||
configDigest := manifest.Config.Digest.String()
|
||||
lastUpdated := common.GetImageLastUpdated(imageConfigInfo)
|
||||
|
||||
imageSummary := common.ImageSummary{
|
||||
RepoName: repoName,
|
||||
Tag: tag,
|
||||
Manifests: []common.ManifestSummary{
|
||||
{
|
||||
Digest: manifestDigest,
|
||||
ConfigDigest: configDigest,
|
||||
LastUpdated: lastUpdated,
|
||||
Size: size,
|
||||
Platform: platform,
|
||||
Layers: layers,
|
||||
History: allHistory,
|
||||
},
|
||||
},
|
||||
LastUpdated: lastUpdated,
|
||||
IsSigned: isSigned,
|
||||
Size: size,
|
||||
Description: annotations.Description,
|
||||
Title: annotations.Title,
|
||||
Documentation: annotations.Documentation,
|
||||
Licenses: annotations.Licenses,
|
||||
Labels: annotations.Labels,
|
||||
Vendor: annotations.Vendor,
|
||||
Source: annotations.Source,
|
||||
}
|
||||
|
||||
imageSummaries = append(imageSummaries, imageSummary)
|
||||
|
||||
if man.Digest.String() == lastUpdatedTag.Descriptor.Digest.String() {
|
||||
lastUpdatedImageSummary = imageSummary
|
||||
}
|
||||
}
|
||||
|
||||
repo.ImageSummaries = imageSummaries
|
||||
|
||||
for blob := range repoBlob2Size {
|
||||
repoSize += repoBlob2Size[blob]
|
||||
}
|
||||
|
||||
size := strconv.FormatInt(repoSize, 10)
|
||||
|
||||
repoPlatforms := make([]common.Platform, 0, len(repoPlatformsSet))
|
||||
|
||||
for _, platform := range repoPlatformsSet {
|
||||
repoPlatforms = append(repoPlatforms, platform)
|
||||
}
|
||||
|
||||
repoVendors := make([]string, 0, len(repoVendorsSet))
|
||||
|
||||
for vendor := range repoVendorsSet {
|
||||
vendor := vendor
|
||||
repoVendors = append(repoVendors, vendor)
|
||||
}
|
||||
|
||||
summary := common.RepoSummary{
|
||||
Name: repoName,
|
||||
LastUpdated: lastUpdatedTag.Timestamp,
|
||||
Size: size,
|
||||
Platforms: repoPlatforms,
|
||||
NewestImage: lastUpdatedImageSummary,
|
||||
Vendors: repoVendors,
|
||||
}
|
||||
|
||||
repo.Summary = summary
|
||||
|
||||
return repo, nil
|
||||
}
|
||||
|
||||
func (olu BaseOciLayoutUtils) ExtractImageDetails(
|
||||
repo, tag string,
|
||||
log log.Logger) (
|
||||
godigest.Digest, *ispec.Manifest, *ispec.Image, error,
|
||||
) {
|
||||
manifest, dig, err := olu.GetImageManifest(repo, tag)
|
||||
if err != nil {
|
||||
log.Error().Err(err).Msg("Could not retrieve image ispec manifest")
|
||||
|
||||
return "", nil, nil, err
|
||||
}
|
||||
|
||||
digest := dig
|
||||
|
||||
imageConfig, err := olu.GetImageConfigInfo(repo, digest)
|
||||
if err != nil {
|
||||
log.Error().Err(err).Msg("Could not retrieve image config")
|
||||
|
||||
return "", nil, nil, err
|
||||
}
|
||||
|
||||
return digest, &manifest, &imageConfig, nil
|
||||
}
|
||||
@@ -0,0 +1,441 @@
|
||||
//go:build sync && scrub && metrics && search
|
||||
// +build sync,scrub,metrics,search
|
||||
|
||||
package test_test
|
||||
|
||||
import (
|
||||
"encoding/json"
|
||||
"fmt"
|
||||
"os"
|
||||
"path"
|
||||
"testing"
|
||||
|
||||
godigest "github.com/opencontainers/go-digest"
|
||||
ispec "github.com/opencontainers/image-spec/specs-go/v1"
|
||||
. "github.com/smartystreets/goconvey/convey"
|
||||
|
||||
zerr "zotregistry.io/zot/errors"
|
||||
"zotregistry.io/zot/pkg/api"
|
||||
"zotregistry.io/zot/pkg/api/config"
|
||||
extconf "zotregistry.io/zot/pkg/extensions/config"
|
||||
"zotregistry.io/zot/pkg/extensions/monitoring"
|
||||
"zotregistry.io/zot/pkg/log"
|
||||
"zotregistry.io/zot/pkg/storage"
|
||||
"zotregistry.io/zot/pkg/storage/local"
|
||||
. "zotregistry.io/zot/pkg/test"
|
||||
"zotregistry.io/zot/pkg/test/mocks"
|
||||
)
|
||||
|
||||
func TestBaseOciLayoutUtils(t *testing.T) {
|
||||
manifestDigest := GetTestBlobDigest("zot-test", "config").String()
|
||||
|
||||
Convey("GetImageManifestSize fail", t, func() {
|
||||
mockStoreController := mocks.MockedImageStore{
|
||||
GetBlobContentFn: func(repo string, digest godigest.Digest) ([]byte, error) {
|
||||
return []byte{}, ErrTestError
|
||||
},
|
||||
}
|
||||
|
||||
storeController := storage.StoreController{DefaultStore: mockStoreController}
|
||||
olu := NewBaseOciLayoutUtils(storeController, log.NewLogger("debug", ""))
|
||||
|
||||
size := olu.GetImageManifestSize("", "")
|
||||
So(size, ShouldBeZeroValue)
|
||||
})
|
||||
|
||||
Convey("GetImageConfigSize: fail GetImageBlobManifest", t, func() {
|
||||
mockStoreController := mocks.MockedImageStore{
|
||||
GetBlobContentFn: func(repo string, digest godigest.Digest) ([]byte, error) {
|
||||
return []byte{}, ErrTestError
|
||||
},
|
||||
}
|
||||
|
||||
storeController := storage.StoreController{DefaultStore: mockStoreController}
|
||||
olu := NewBaseOciLayoutUtils(storeController, log.NewLogger("debug", ""))
|
||||
|
||||
size := olu.GetImageConfigSize("", "")
|
||||
So(size, ShouldBeZeroValue)
|
||||
})
|
||||
|
||||
Convey("GetImageConfigSize: config GetBlobContent fail", t, func() {
|
||||
mockStoreController := mocks.MockedImageStore{
|
||||
GetBlobContentFn: func(repo string, digest godigest.Digest) ([]byte, error) {
|
||||
if digest.String() == manifestDigest {
|
||||
return []byte{}, ErrTestError
|
||||
}
|
||||
|
||||
return []byte(
|
||||
`
|
||||
{
|
||||
"schemaVersion": 2,
|
||||
"mediaType": "application/vnd.oci.image.manifest.v1+json",
|
||||
"config": {
|
||||
"mediaType": "application/vnd.oci.image.config.v1+json",
|
||||
"digest": manifestDigest,
|
||||
"size": 1476
|
||||
},
|
||||
"layers": [
|
||||
{
|
||||
"mediaType": "application/vnd.oci.image.layer.v1.tar+gzip",
|
||||
"digest": "` + GetTestBlobDigest("zot-test", "layer").String() + `",
|
||||
"size": 76097157
|
||||
}
|
||||
]
|
||||
}`), nil
|
||||
},
|
||||
}
|
||||
|
||||
storeController := storage.StoreController{DefaultStore: mockStoreController}
|
||||
olu := NewBaseOciLayoutUtils(storeController, log.NewLogger("debug", ""))
|
||||
|
||||
size := olu.GetImageConfigSize("", "")
|
||||
So(size, ShouldBeZeroValue)
|
||||
})
|
||||
|
||||
Convey("GetRepoLastUpdated: config GetBlobContent fail", t, func() {
|
||||
mockStoreController := mocks.MockedImageStore{
|
||||
GetIndexContentFn: func(repo string) ([]byte, error) {
|
||||
return []byte{}, ErrTestError
|
||||
},
|
||||
}
|
||||
|
||||
storeController := storage.StoreController{DefaultStore: mockStoreController}
|
||||
olu := NewBaseOciLayoutUtils(storeController, log.NewLogger("debug", ""))
|
||||
|
||||
_, err := olu.GetRepoLastUpdated("")
|
||||
So(err, ShouldNotBeNil)
|
||||
})
|
||||
|
||||
Convey("GetImageTagsWithTimestamp: GetImageBlobManifest fails", t, func() {
|
||||
index := ispec.Index{
|
||||
Manifests: []ispec.Descriptor{
|
||||
{Annotations: map[string]string{ispec.AnnotationRefName: "w"}}, {},
|
||||
},
|
||||
}
|
||||
|
||||
indexBlob, err := json.Marshal(index)
|
||||
So(err, ShouldBeNil)
|
||||
|
||||
mockStoreController := mocks.MockedImageStore{
|
||||
GetBlobContentFn: func(repo string, digest godigest.Digest) ([]byte, error) {
|
||||
return nil, ErrTestError
|
||||
},
|
||||
GetIndexContentFn: func(repo string) ([]byte, error) {
|
||||
return indexBlob, nil
|
||||
},
|
||||
}
|
||||
|
||||
storeController := storage.StoreController{DefaultStore: mockStoreController}
|
||||
olu := NewBaseOciLayoutUtils(storeController, log.NewLogger("debug", ""))
|
||||
|
||||
_, err = olu.GetImageTagsWithTimestamp("rep")
|
||||
So(err, ShouldNotBeNil)
|
||||
})
|
||||
|
||||
Convey("GetImageTagsWithTimestamp: GetImageInfo fails", t, func() {
|
||||
index := ispec.Index{
|
||||
Manifests: []ispec.Descriptor{
|
||||
{Annotations: map[string]string{ispec.AnnotationRefName: "w"}}, {},
|
||||
},
|
||||
}
|
||||
|
||||
indexBlob, err := json.Marshal(index)
|
||||
So(err, ShouldBeNil)
|
||||
|
||||
manifest := ispec.Manifest{
|
||||
Config: ispec.Descriptor{
|
||||
MediaType: "application/vnd.oci.image.config.v1+json",
|
||||
Digest: "configDigest",
|
||||
},
|
||||
Layers: []ispec.Descriptor{
|
||||
{},
|
||||
{},
|
||||
},
|
||||
}
|
||||
|
||||
manifestBlob, err := json.Marshal(manifest)
|
||||
So(err, ShouldBeNil)
|
||||
|
||||
mockStoreController := mocks.MockedImageStore{
|
||||
GetBlobContentFn: func(repo string, digest godigest.Digest) ([]byte, error) {
|
||||
if digest.String() == "configDigest" {
|
||||
return nil, ErrTestError
|
||||
}
|
||||
|
||||
return manifestBlob, nil
|
||||
},
|
||||
GetIndexContentFn: func(repo string) ([]byte, error) {
|
||||
return indexBlob, nil
|
||||
},
|
||||
}
|
||||
|
||||
storeController := storage.StoreController{DefaultStore: mockStoreController}
|
||||
olu := NewBaseOciLayoutUtils(storeController, log.NewLogger("debug", ""))
|
||||
|
||||
_, err = olu.GetImageTagsWithTimestamp("repo")
|
||||
So(err, ShouldNotBeNil)
|
||||
})
|
||||
|
||||
Convey("GetExpandedRepoInfo: fails", t, func() {
|
||||
index := ispec.Index{
|
||||
Manifests: []ispec.Descriptor{
|
||||
{},
|
||||
{
|
||||
Annotations: map[string]string{
|
||||
ispec.AnnotationRefName: "w",
|
||||
ispec.AnnotationVendor: "vend",
|
||||
},
|
||||
},
|
||||
},
|
||||
}
|
||||
|
||||
indexBlob, err := json.Marshal(index)
|
||||
So(err, ShouldBeNil)
|
||||
|
||||
manifest := ispec.Manifest{
|
||||
Annotations: map[string]string{
|
||||
ispec.AnnotationRefName: "w",
|
||||
ispec.AnnotationVendor: "vend",
|
||||
},
|
||||
Layers: []ispec.Descriptor{
|
||||
{},
|
||||
{},
|
||||
},
|
||||
}
|
||||
|
||||
manifestBlob, err := json.Marshal(manifest)
|
||||
So(err, ShouldBeNil)
|
||||
|
||||
mockStoreController := mocks.MockedImageStore{
|
||||
GetIndexContentFn: func(repo string) ([]byte, error) {
|
||||
return nil, ErrTestError
|
||||
},
|
||||
}
|
||||
|
||||
storeController := storage.StoreController{DefaultStore: mockStoreController}
|
||||
olu := NewBaseOciLayoutUtils(storeController, log.NewLogger("debug", ""))
|
||||
|
||||
_, err = olu.GetExpandedRepoInfo("rep")
|
||||
So(err, ShouldNotBeNil)
|
||||
|
||||
// GetRepoLastUpdated fails
|
||||
mockStoreController = mocks.MockedImageStore{
|
||||
GetIndexContentFn: func(repo string) ([]byte, error) {
|
||||
return indexBlob, nil
|
||||
},
|
||||
}
|
||||
|
||||
storeController = storage.StoreController{DefaultStore: mockStoreController}
|
||||
olu = NewBaseOciLayoutUtils(storeController, log.NewLogger("debug", ""))
|
||||
|
||||
_, err = olu.GetExpandedRepoInfo("rep")
|
||||
So(err, ShouldNotBeNil)
|
||||
|
||||
// anotations
|
||||
|
||||
mockStoreController = mocks.MockedImageStore{
|
||||
GetIndexContentFn: func(repo string) ([]byte, error) {
|
||||
return indexBlob, nil
|
||||
},
|
||||
GetBlobContentFn: func(repo string, digest godigest.Digest) ([]byte, error) {
|
||||
return manifestBlob, nil
|
||||
},
|
||||
}
|
||||
|
||||
storeController = storage.StoreController{DefaultStore: mockStoreController}
|
||||
olu = NewBaseOciLayoutUtils(storeController, log.NewLogger("debug", ""))
|
||||
|
||||
_, err = olu.GetExpandedRepoInfo("rep")
|
||||
So(err, ShouldBeNil)
|
||||
})
|
||||
|
||||
Convey("GetImageInfo fail", t, func() {
|
||||
mockStoreController := mocks.MockedImageStore{
|
||||
GetBlobContentFn: func(repo string, digest godigest.Digest) ([]byte, error) {
|
||||
return []byte{}, ErrTestError
|
||||
},
|
||||
}
|
||||
|
||||
storeController := storage.StoreController{DefaultStore: mockStoreController}
|
||||
olu := NewBaseOciLayoutUtils(storeController, log.NewLogger("debug", ""))
|
||||
|
||||
_, err := olu.GetImageInfo("", "")
|
||||
So(err, ShouldNotBeNil)
|
||||
})
|
||||
|
||||
Convey("CheckManifestSignature: notation", t, func() {
|
||||
// GetReferrers - fails => checkNotarySignature returns false
|
||||
mockStoreController := mocks.MockedImageStore{
|
||||
GetImageManifestFn: func(name, reference string) ([]byte, godigest.Digest, string, error) {
|
||||
return []byte{}, "", "", zerr.ErrRepoNotFound
|
||||
},
|
||||
GetReferrersFn: func(name string, digest godigest.Digest, mediaTypes []string) (ispec.Index, error) {
|
||||
return ispec.Index{}, ErrTestError
|
||||
},
|
||||
}
|
||||
|
||||
storeController := storage.StoreController{DefaultStore: mockStoreController}
|
||||
olu := NewBaseOciLayoutUtils(storeController, log.NewLogger("debug", ""))
|
||||
|
||||
check := olu.CheckManifestSignature("rep", godigest.FromString(""))
|
||||
So(check, ShouldBeFalse)
|
||||
|
||||
// checkNotarySignature -> true
|
||||
dir := t.TempDir()
|
||||
|
||||
port := GetFreePort()
|
||||
baseURL := GetBaseURL(port)
|
||||
conf := config.New()
|
||||
conf.HTTP.Port = port
|
||||
conf.Storage.RootDirectory = dir
|
||||
defaultVal := true
|
||||
conf.Extensions = &extconf.ExtensionConfig{
|
||||
Search: &extconf.SearchConfig{BaseConfig: extconf.BaseConfig{Enable: &defaultVal}},
|
||||
}
|
||||
|
||||
conf.Extensions.Search.CVE = nil
|
||||
|
||||
ctlr := api.NewController(conf)
|
||||
|
||||
ctlrManager := NewControllerManager(ctlr)
|
||||
ctlrManager.StartAndWait(port)
|
||||
defer ctlrManager.StopServer()
|
||||
|
||||
// push test image to repo
|
||||
config, layers, manifest, err := GetImageComponents(100)
|
||||
So(err, ShouldBeNil)
|
||||
|
||||
layersSize1 := 0
|
||||
for _, l := range layers {
|
||||
layersSize1 += len(l)
|
||||
}
|
||||
|
||||
repo := "repo"
|
||||
tag := "1.0.1"
|
||||
err = UploadImage(
|
||||
Image{
|
||||
Manifest: manifest,
|
||||
Config: config,
|
||||
Layers: layers,
|
||||
Reference: tag,
|
||||
},
|
||||
baseURL,
|
||||
repo,
|
||||
)
|
||||
So(err, ShouldBeNil)
|
||||
|
||||
olu = NewBaseOciLayoutUtils(ctlr.StoreController, log.NewLogger("debug", ""))
|
||||
manifestList, err := olu.GetImageManifests(repo)
|
||||
So(err, ShouldBeNil)
|
||||
So(len(manifestList), ShouldEqual, 1)
|
||||
|
||||
isSigned := olu.CheckManifestSignature(repo, manifestList[0].Digest)
|
||||
So(isSigned, ShouldBeFalse)
|
||||
|
||||
err = SignImageUsingNotary(fmt.Sprintf("%s:%s", repo, tag), port)
|
||||
So(err, ShouldBeNil)
|
||||
|
||||
isSigned = olu.CheckManifestSignature(repo, manifestList[0].Digest)
|
||||
So(isSigned, ShouldBeTrue)
|
||||
})
|
||||
}
|
||||
|
||||
func TestExtractImageDetails(t *testing.T) {
|
||||
Convey("extractImageDetails good workflow", t, func() {
|
||||
dir := t.TempDir()
|
||||
testLogger := log.NewLogger("debug", "")
|
||||
imageStore := local.NewImageStore(dir, false, 0, false, false,
|
||||
testLogger, monitoring.NewMetricsServer(false, testLogger), nil, nil)
|
||||
|
||||
storeController := storage.StoreController{
|
||||
DefaultStore: imageStore,
|
||||
}
|
||||
|
||||
num := 10
|
||||
config, layers, manifest, err := GetImageComponents(num)
|
||||
So(err, ShouldBeNil)
|
||||
|
||||
err = WriteImageToFileSystem(
|
||||
Image{
|
||||
Manifest: manifest,
|
||||
Layers: layers,
|
||||
Config: config,
|
||||
Reference: "latest",
|
||||
}, "zot-test", storeController,
|
||||
)
|
||||
So(err, ShouldBeNil)
|
||||
|
||||
configBlob, err := json.Marshal(config)
|
||||
So(err, ShouldBeNil)
|
||||
configDigest := godigest.FromBytes(configBlob)
|
||||
|
||||
olu := NewBaseOciLayoutUtils(storeController, testLogger)
|
||||
resDigest, resManifest, resIspecImage, resErr := olu.ExtractImageDetails("zot-test", "latest", testLogger)
|
||||
So(string(resDigest), ShouldContainSubstring, "sha256:c52f15d2d4")
|
||||
So(resManifest.Config.Digest.String(), ShouldContainSubstring, configDigest.Encoded())
|
||||
|
||||
So(resIspecImage.Architecture, ShouldContainSubstring, "amd64")
|
||||
So(resErr, ShouldBeNil)
|
||||
})
|
||||
|
||||
Convey("extractImageDetails bad ispec.ImageManifest", t, func() {
|
||||
dir := t.TempDir()
|
||||
testLogger := log.NewLogger("debug", "")
|
||||
imageStore := local.NewImageStore(dir, false, 0, false, false,
|
||||
testLogger, monitoring.NewMetricsServer(false, testLogger), nil, nil)
|
||||
|
||||
storeController := storage.StoreController{
|
||||
DefaultStore: imageStore,
|
||||
}
|
||||
|
||||
olu := NewBaseOciLayoutUtils(storeController, testLogger)
|
||||
resDigest, resManifest, resIspecImage, resErr := olu.ExtractImageDetails("zot-test",
|
||||
"latest", testLogger)
|
||||
So(resErr, ShouldEqual, zerr.ErrRepoNotFound)
|
||||
So(string(resDigest), ShouldEqual, "")
|
||||
So(resManifest, ShouldBeNil)
|
||||
|
||||
So(resIspecImage, ShouldBeNil)
|
||||
})
|
||||
|
||||
Convey("extractImageDetails bad imageConfig", t, func() {
|
||||
dir := t.TempDir()
|
||||
testLogger := log.NewLogger("debug", "")
|
||||
imageStore := local.NewImageStore(dir, false, 0, false, false,
|
||||
testLogger, monitoring.NewMetricsServer(false, testLogger), nil, nil)
|
||||
|
||||
storeController := storage.StoreController{
|
||||
DefaultStore: imageStore,
|
||||
}
|
||||
|
||||
num := 10
|
||||
config, layers, manifest, err := GetImageComponents(num)
|
||||
So(err, ShouldBeNil)
|
||||
|
||||
err = WriteImageToFileSystem(
|
||||
Image{
|
||||
Manifest: manifest,
|
||||
Layers: layers,
|
||||
Config: config,
|
||||
Reference: "latest",
|
||||
}, "zot-test", storeController,
|
||||
)
|
||||
So(err, ShouldBeNil)
|
||||
|
||||
configBlob, err := json.Marshal(config)
|
||||
So(err, ShouldBeNil)
|
||||
configDigest := godigest.FromBytes(configBlob)
|
||||
|
||||
err = os.Remove(path.Join(dir, "zot-test/blobs/sha256", configDigest.Encoded()))
|
||||
if err != nil {
|
||||
panic(err)
|
||||
}
|
||||
|
||||
olu := NewBaseOciLayoutUtils(storeController, testLogger)
|
||||
resDigest, resManifest, resIspecImage, resErr := olu.ExtractImageDetails("zot-test", "latest", testLogger)
|
||||
So(resErr, ShouldEqual, zerr.ErrBlobNotFound)
|
||||
So(string(resDigest), ShouldEqual, "")
|
||||
So(resManifest, ShouldBeNil)
|
||||
So(resIspecImage, ShouldBeNil)
|
||||
})
|
||||
}
|
||||
Reference in New Issue
Block a user