mirror of
https://codeberg.org/forgejo/forgejo.git
synced 2026-05-13 22:40:24 +00:00
As discussed here: https://codeberg.org/forgejo/discussions/issues/444 the container v2 API logic does need some refactoring for better maintainability. This is a proposition on how to achieve that. My goal was to be able to write unit tests for functions like processImageManifest() which are currently only tested indirectly by TestPackageContainer() in tests/integration/api_packages_container_test.go. A first unit test was implemented that targets ProcessManifest(). I think that test also shows what steps are needed to successfully execute the ProcessManifest() function and hopefully helps understanding that code better. ## Checklist The [contributor guide](https://forgejo.org/docs/next/contributor/) contains information that will be helpful to first time contributors. There also are a few [conditions for merging Pull Requests in Forgejo repositories](https://codeberg.org/forgejo/governance/src/branch/main/PullRequestsAgreement.md). You are also welcome to join the [Forgejo development chatroom](https://matrix.to/#/#forgejo-development:matrix.org). ### Tests for Go changes (can be removed for JavaScript changes) - I added test coverage for Go changes... - [x ] in their respective `*_test.go` for unit tests. - [ ] in the `tests/integration` directory if it involves interactions with a live Forgejo server. - I ran... - [x] `make pr-go` before pushing ### Documentation - [ ] I created a pull request [to the documentation](https://codeberg.org/forgejo/docs) to explain to Forgejo users how to use this change. - [x ] I did not document these changes and I do not expect someone else to do it. ### Release notes - [ ] This change will be noticed by a Forgejo user or admin (feature, bug fix, performance, etc.). I suggest to include a release note for this change. - [ x] This change is not visible to a Forgejo user or admin (refactor, dependency upgrade, etc.). I think there is no need to add a release note for this change. *The decision if the pull request will be shown in the release notes is up to the mergers / release team.* The content of the `release-notes/<pull request number>.md` file will serve as the basis for the release notes. If the file does not exist, the title of the pull request will be used instead. Reviewed-on: https://codeberg.org/forgejo/forgejo/pulls/11432 Reviewed-by: Andreas Ahlenstorf <aahlenst@noreply.codeberg.org> Reviewed-by: Mathieu Fenniak <mfenniak@noreply.codeberg.org> Co-authored-by: patdyn <patdyn@noreply.codeberg.org> Co-committed-by: patdyn <patdyn@noreply.codeberg.org>
234 lines
7 KiB
Go
234 lines
7 KiB
Go
// Copyright 2022 The Gitea Authors. All rights reserved.
|
|
// SPDX-License-Identifier: MIT
|
|
|
|
package container
|
|
|
|
import (
|
|
"context"
|
|
"encoding/hex"
|
|
"errors"
|
|
"fmt"
|
|
"os"
|
|
"strings"
|
|
"sync"
|
|
|
|
"forgejo.org/models/db"
|
|
packages_model "forgejo.org/models/packages"
|
|
container_model "forgejo.org/models/packages/container"
|
|
"forgejo.org/modules/log"
|
|
packages_module "forgejo.org/modules/packages"
|
|
container_module "forgejo.org/modules/packages/container"
|
|
"forgejo.org/modules/util"
|
|
packages_service "forgejo.org/services/packages"
|
|
|
|
oci_digest "github.com/opencontainers/go-digest"
|
|
)
|
|
|
|
var uploadVersionMutex sync.Mutex
|
|
|
|
// GetLocalBlob finds a local blob if it exists, returns ErrContainerBlobNotExist otherwise
|
|
func GetLocalBlob(ctx context.Context, ownerID int64, dig, imageName string) (*packages_model.PackageFileDescriptor, error) {
|
|
if oci_digest.Digest(dig).Validate() != nil {
|
|
return nil, container_model.ErrContainerBlobNotExist
|
|
}
|
|
|
|
opts := &container_model.BlobSearchOptions{
|
|
OwnerID: ownerID,
|
|
Image: imageName,
|
|
Digest: dig,
|
|
}
|
|
|
|
// Get blob or err
|
|
log.Debug("Trying to find blob %s locally", dig)
|
|
blobDescriptor, err := WorkaroundGetContainerBlob(ctx, opts)
|
|
if err != nil {
|
|
if errors.Is(err, container_model.ErrContainerBlobNotExist) {
|
|
return nil, err
|
|
}
|
|
return nil, fmt.Errorf("could not get container blob: %s", err.Error())
|
|
}
|
|
|
|
return blobDescriptor, nil
|
|
}
|
|
|
|
// SaveAsPackageBlob creates a package blob from an upload
|
|
// The uploaded blob gets stored in a special upload version to link them to the package/image
|
|
func SaveAsPackageBlob(ctx context.Context, hsr packages_module.HashedSizeReader, pci *packages_service.PackageCreationInfo) (*packages_model.PackageBlob, error) {
|
|
pb := packages_service.NewPackageBlob(hsr)
|
|
|
|
exists := false
|
|
|
|
contentStore := packages_module.NewContentStore()
|
|
|
|
uploadVersion, err := GetOrCreateUploadVersion(ctx, &pci.PackageInfo)
|
|
if err != nil {
|
|
return nil, err
|
|
}
|
|
|
|
err = db.WithTx(ctx, func(ctx context.Context) error {
|
|
if err := packages_service.CheckSizeQuotaExceeded(ctx, pci.Creator, pci.Owner, packages_model.TypeContainer, hsr.Size()); err != nil {
|
|
return err
|
|
}
|
|
|
|
pb, exists, err = packages_model.GetOrInsertBlob(ctx, pb)
|
|
if err != nil {
|
|
log.Error("Error inserting package blob: %v", err)
|
|
return err
|
|
}
|
|
// FIXME: Workaround to be removed in v1.20
|
|
// https://github.com/go-gitea/gitea/issues/19586
|
|
if exists {
|
|
err = contentStore.Has(packages_module.BlobHash256Key(pb.HashSHA256))
|
|
if err != nil && (errors.Is(err, util.ErrNotExist) || errors.Is(err, os.ErrNotExist)) {
|
|
log.Debug("Package registry inconsistent: blob %s does not exist on file system", pb.HashSHA256)
|
|
exists = false
|
|
}
|
|
}
|
|
if !exists {
|
|
if err := contentStore.Save(packages_module.BlobHash256Key(pb.HashSHA256), hsr, hsr.Size()); err != nil {
|
|
log.Error("Error saving package blob in content store: %v", err)
|
|
return err
|
|
}
|
|
}
|
|
|
|
return CreateFileForBlob(ctx, uploadVersion, pb)
|
|
})
|
|
if err != nil {
|
|
if !exists {
|
|
if err := contentStore.Delete(packages_module.BlobHash256Key(pb.HashSHA256)); err != nil {
|
|
log.Error("Error deleting package blob from content store: %v", err)
|
|
}
|
|
}
|
|
return nil, err
|
|
}
|
|
|
|
return pb, nil
|
|
}
|
|
|
|
// MountBlob mounts the specific blob to a different package
|
|
func MountBlob(ctx context.Context, pi *packages_service.PackageInfo, pb *packages_model.PackageBlob) error {
|
|
uploadVersion, err := GetOrCreateUploadVersion(ctx, pi)
|
|
if err != nil {
|
|
return err
|
|
}
|
|
|
|
return db.WithTx(ctx, func(ctx context.Context) error {
|
|
return CreateFileForBlob(ctx, uploadVersion, pb)
|
|
})
|
|
}
|
|
|
|
func GetOrCreateUploadVersion(ctx context.Context, pi *packages_service.PackageInfo) (*packages_model.PackageVersion, error) {
|
|
var uploadVersion *packages_model.PackageVersion
|
|
|
|
// FIXME: Replace usage of mutex with database transaction
|
|
// https://github.com/go-gitea/gitea/pull/21862
|
|
uploadVersionMutex.Lock()
|
|
err := db.WithTx(ctx, func(ctx context.Context) error {
|
|
created := true
|
|
p := &packages_model.Package{
|
|
OwnerID: pi.Owner.ID,
|
|
Type: packages_model.TypeContainer,
|
|
Name: strings.ToLower(pi.Name),
|
|
LowerName: strings.ToLower(pi.Name),
|
|
}
|
|
var err error
|
|
|
|
if p, err = packages_model.TryInsertPackage(ctx, p); err != nil {
|
|
if err == packages_model.ErrDuplicatePackage {
|
|
created = false
|
|
} else {
|
|
log.Error("Error inserting package: %v", err)
|
|
return err
|
|
}
|
|
}
|
|
|
|
if created {
|
|
if _, err := packages_model.InsertProperty(ctx, packages_model.PropertyTypePackage, p.ID, container_module.PropertyRepository, strings.ToLower(pi.Owner.LowerName+"/"+pi.Name)); err != nil {
|
|
log.Error("Error setting package property %s: %v", container_module.PropertyRepository, err)
|
|
return err
|
|
}
|
|
if _, err := packages_model.InsertProperty(ctx, packages_model.PropertyTypePackage, p.ID, container_module.PropertyRepositoryAutolinkingPending, "yes"); err != nil {
|
|
log.Error("Error setting package property %s: %v", container_module.PropertyRepositoryAutolinkingPending, err)
|
|
return err
|
|
}
|
|
}
|
|
|
|
pv := &packages_model.PackageVersion{
|
|
PackageID: p.ID,
|
|
CreatorID: pi.Owner.ID,
|
|
Version: container_model.UploadVersion,
|
|
LowerVersion: container_model.UploadVersion,
|
|
IsInternal: true,
|
|
MetadataJSON: "null",
|
|
}
|
|
if pv, err = packages_model.GetOrInsertVersion(ctx, pv); err != nil {
|
|
if err != packages_model.ErrDuplicatePackageVersion {
|
|
log.Error("Error inserting package: %v", err)
|
|
return err
|
|
}
|
|
}
|
|
|
|
uploadVersion = pv
|
|
|
|
return nil
|
|
})
|
|
uploadVersionMutex.Unlock()
|
|
|
|
return uploadVersion, err
|
|
}
|
|
|
|
func CreateFileForBlob(ctx context.Context, pv *packages_model.PackageVersion, pb *packages_model.PackageBlob) error {
|
|
filename := strings.ToLower(fmt.Sprintf("sha256_%s", pb.HashSHA256))
|
|
|
|
pf := &packages_model.PackageFile{
|
|
VersionID: pv.ID,
|
|
BlobID: pb.ID,
|
|
Name: filename,
|
|
LowerName: filename,
|
|
CompositeKey: packages_model.EmptyFileKey,
|
|
}
|
|
var err error
|
|
if pf, err = packages_model.TryInsertFile(ctx, pf); err != nil {
|
|
if err == packages_model.ErrDuplicatePackageFile {
|
|
return nil
|
|
}
|
|
log.Error("Error inserting package file: %v", err)
|
|
return err
|
|
}
|
|
|
|
if _, err := packages_model.InsertProperty(ctx, packages_model.PropertyTypeFile, pf.ID, container_module.PropertyDigest, DigestFromPackageBlob(pb)); err != nil {
|
|
log.Error("Error setting package file property: %v", err)
|
|
return err
|
|
}
|
|
|
|
return nil
|
|
}
|
|
|
|
func DeleteBlob(ctx context.Context, ownerID int64, image, digest string) error {
|
|
return db.WithTx(ctx, func(ctx context.Context) error {
|
|
pfds, err := container_model.GetContainerBlobs(ctx, &container_model.BlobSearchOptions{
|
|
OwnerID: ownerID,
|
|
Image: image,
|
|
Digest: digest,
|
|
})
|
|
if err != nil {
|
|
return err
|
|
}
|
|
|
|
for _, file := range pfds {
|
|
if err := packages_service.DeletePackageFile(ctx, file.File); err != nil {
|
|
return err
|
|
}
|
|
}
|
|
return nil
|
|
})
|
|
}
|
|
|
|
func DigestFromHashSummer(h packages_module.HashSummer) string {
|
|
_, _, hashSHA256, _, _ := h.Sums()
|
|
return "sha256:" + hex.EncodeToString(hashSHA256)
|
|
}
|
|
|
|
func DigestFromPackageBlob(pb *packages_model.PackageBlob) string {
|
|
return "sha256:" + pb.HashSHA256
|
|
}
|