mirror of
https://codeberg.org/forgejo/forgejo.git
synced 2024-11-26 09:09:36 -05:00
32db62515f
Fixes #20514 Fixes #20766 Fixes #20631 This PR adds Cleanup Rules for the package registry. This allows to delete unneeded packages automatically. Cleanup rules can be set up from the user or org settings. Please have a look at the documentation because I'm not a native english speaker. Rule Form  Rule List  Rule Preview  Co-authored-by: Lunny Xiao <xiaolunwen@gmail.com>
373 lines
13 KiB
Go
373 lines
13 KiB
Go
// Copyright 2021 The Gitea Authors. All rights reserved.
|
|
// Use of this source code is governed by a MIT-style
|
|
// license that can be found in the LICENSE file.
|
|
|
|
package integration
|
|
|
|
import (
|
|
"bytes"
|
|
"fmt"
|
|
"net/http"
|
|
"testing"
|
|
"time"
|
|
|
|
"code.gitea.io/gitea/models/db"
|
|
packages_model "code.gitea.io/gitea/models/packages"
|
|
container_model "code.gitea.io/gitea/models/packages/container"
|
|
"code.gitea.io/gitea/models/unittest"
|
|
user_model "code.gitea.io/gitea/models/user"
|
|
"code.gitea.io/gitea/modules/setting"
|
|
api "code.gitea.io/gitea/modules/structs"
|
|
packages_service "code.gitea.io/gitea/services/packages"
|
|
"code.gitea.io/gitea/tests"
|
|
|
|
"github.com/stretchr/testify/assert"
|
|
)
|
|
|
|
func TestPackageAPI(t *testing.T) {
|
|
defer tests.PrepareTestEnv(t)()
|
|
|
|
user := unittest.AssertExistsAndLoadBean(t, &user_model.User{ID: 4})
|
|
session := loginUser(t, user.Name)
|
|
token := getTokenForLoggedInUser(t, session)
|
|
|
|
packageName := "test-package"
|
|
packageVersion := "1.0.3"
|
|
filename := "file.bin"
|
|
|
|
url := fmt.Sprintf("/api/packages/%s/generic/%s/%s/%s", user.Name, packageName, packageVersion, filename)
|
|
req := NewRequestWithBody(t, "PUT", url, bytes.NewReader([]byte{}))
|
|
AddBasicAuthHeader(req, user.Name)
|
|
MakeRequest(t, req, http.StatusCreated)
|
|
|
|
t.Run("ListPackages", func(t *testing.T) {
|
|
defer tests.PrintCurrentTest(t)()
|
|
|
|
req := NewRequest(t, "GET", fmt.Sprintf("/api/v1/packages/%s?token=%s", user.Name, token))
|
|
resp := MakeRequest(t, req, http.StatusOK)
|
|
|
|
var apiPackages []*api.Package
|
|
DecodeJSON(t, resp, &apiPackages)
|
|
|
|
assert.Len(t, apiPackages, 1)
|
|
assert.Equal(t, string(packages_model.TypeGeneric), apiPackages[0].Type)
|
|
assert.Equal(t, packageName, apiPackages[0].Name)
|
|
assert.Equal(t, packageVersion, apiPackages[0].Version)
|
|
assert.NotNil(t, apiPackages[0].Creator)
|
|
assert.Equal(t, user.Name, apiPackages[0].Creator.UserName)
|
|
})
|
|
|
|
t.Run("GetPackage", func(t *testing.T) {
|
|
defer tests.PrintCurrentTest(t)()
|
|
|
|
req := NewRequest(t, "GET", fmt.Sprintf("/api/v1/packages/%s/dummy/%s/%s?token=%s", user.Name, packageName, packageVersion, token))
|
|
MakeRequest(t, req, http.StatusNotFound)
|
|
|
|
req = NewRequest(t, "GET", fmt.Sprintf("/api/v1/packages/%s/generic/%s/%s?token=%s", user.Name, packageName, packageVersion, token))
|
|
resp := MakeRequest(t, req, http.StatusOK)
|
|
|
|
var p *api.Package
|
|
DecodeJSON(t, resp, &p)
|
|
|
|
assert.Equal(t, string(packages_model.TypeGeneric), p.Type)
|
|
assert.Equal(t, packageName, p.Name)
|
|
assert.Equal(t, packageVersion, p.Version)
|
|
assert.NotNil(t, p.Creator)
|
|
assert.Equal(t, user.Name, p.Creator.UserName)
|
|
|
|
t.Run("RepositoryLink", func(t *testing.T) {
|
|
defer tests.PrintCurrentTest(t)()
|
|
|
|
p, err := packages_model.GetPackageByName(db.DefaultContext, user.ID, packages_model.TypeGeneric, packageName)
|
|
assert.NoError(t, err)
|
|
|
|
// no repository link
|
|
req := NewRequest(t, "GET", fmt.Sprintf("/api/v1/packages/%s/generic/%s/%s?token=%s", user.Name, packageName, packageVersion, token))
|
|
resp := MakeRequest(t, req, http.StatusOK)
|
|
|
|
var ap1 *api.Package
|
|
DecodeJSON(t, resp, &ap1)
|
|
assert.Nil(t, ap1.Repository)
|
|
|
|
// link to public repository
|
|
assert.NoError(t, packages_model.SetRepositoryLink(db.DefaultContext, p.ID, 1))
|
|
|
|
req = NewRequest(t, "GET", fmt.Sprintf("/api/v1/packages/%s/generic/%s/%s?token=%s", user.Name, packageName, packageVersion, token))
|
|
resp = MakeRequest(t, req, http.StatusOK)
|
|
|
|
var ap2 *api.Package
|
|
DecodeJSON(t, resp, &ap2)
|
|
assert.NotNil(t, ap2.Repository)
|
|
assert.EqualValues(t, 1, ap2.Repository.ID)
|
|
|
|
// link to private repository
|
|
assert.NoError(t, packages_model.SetRepositoryLink(db.DefaultContext, p.ID, 2))
|
|
|
|
req = NewRequest(t, "GET", fmt.Sprintf("/api/v1/packages/%s/generic/%s/%s?token=%s", user.Name, packageName, packageVersion, token))
|
|
resp = MakeRequest(t, req, http.StatusOK)
|
|
|
|
var ap3 *api.Package
|
|
DecodeJSON(t, resp, &ap3)
|
|
assert.Nil(t, ap3.Repository)
|
|
|
|
assert.NoError(t, packages_model.UnlinkRepositoryFromAllPackages(db.DefaultContext, 2))
|
|
})
|
|
})
|
|
|
|
t.Run("ListPackageFiles", func(t *testing.T) {
|
|
defer tests.PrintCurrentTest(t)()
|
|
|
|
req := NewRequest(t, "GET", fmt.Sprintf("/api/v1/packages/%s/dummy/%s/%s/files?token=%s", user.Name, packageName, packageVersion, token))
|
|
MakeRequest(t, req, http.StatusNotFound)
|
|
|
|
req = NewRequest(t, "GET", fmt.Sprintf("/api/v1/packages/%s/generic/%s/%s/files?token=%s", user.Name, packageName, packageVersion, token))
|
|
resp := MakeRequest(t, req, http.StatusOK)
|
|
|
|
var files []*api.PackageFile
|
|
DecodeJSON(t, resp, &files)
|
|
|
|
assert.Len(t, files, 1)
|
|
assert.Equal(t, int64(0), files[0].Size)
|
|
assert.Equal(t, filename, files[0].Name)
|
|
assert.Equal(t, "d41d8cd98f00b204e9800998ecf8427e", files[0].HashMD5)
|
|
assert.Equal(t, "da39a3ee5e6b4b0d3255bfef95601890afd80709", files[0].HashSHA1)
|
|
assert.Equal(t, "e3b0c44298fc1c149afbf4c8996fb92427ae41e4649b934ca495991b7852b855", files[0].HashSHA256)
|
|
assert.Equal(t, "cf83e1357eefb8bdf1542850d66d8007d620e4050b5715dc83f4a921d36ce9ce47d0d13c5d85f2b0ff8318d2877eec2f63b931bd47417a81a538327af927da3e", files[0].HashSHA512)
|
|
})
|
|
|
|
t.Run("DeletePackage", func(t *testing.T) {
|
|
defer tests.PrintCurrentTest(t)()
|
|
|
|
req := NewRequest(t, "DELETE", fmt.Sprintf("/api/v1/packages/%s/dummy/%s/%s?token=%s", user.Name, packageName, packageVersion, token))
|
|
MakeRequest(t, req, http.StatusNotFound)
|
|
|
|
req = NewRequest(t, "DELETE", fmt.Sprintf("/api/v1/packages/%s/generic/%s/%s?token=%s", user.Name, packageName, packageVersion, token))
|
|
MakeRequest(t, req, http.StatusNoContent)
|
|
})
|
|
}
|
|
|
|
func TestPackageAccess(t *testing.T) {
|
|
defer tests.PrepareTestEnv(t)()
|
|
|
|
admin := unittest.AssertExistsAndLoadBean(t, &user_model.User{ID: 1})
|
|
user := unittest.AssertExistsAndLoadBean(t, &user_model.User{ID: 5})
|
|
inactive := unittest.AssertExistsAndLoadBean(t, &user_model.User{ID: 9})
|
|
|
|
uploadPackage := func(doer, owner *user_model.User, expectedStatus int) {
|
|
url := fmt.Sprintf("/api/packages/%s/generic/test-package/1.0/file.bin", owner.Name)
|
|
req := NewRequestWithBody(t, "PUT", url, bytes.NewReader([]byte{1}))
|
|
AddBasicAuthHeader(req, doer.Name)
|
|
MakeRequest(t, req, expectedStatus)
|
|
}
|
|
|
|
uploadPackage(user, inactive, http.StatusUnauthorized)
|
|
uploadPackage(inactive, inactive, http.StatusUnauthorized)
|
|
uploadPackage(inactive, user, http.StatusUnauthorized)
|
|
uploadPackage(admin, inactive, http.StatusCreated)
|
|
uploadPackage(admin, user, http.StatusCreated)
|
|
}
|
|
|
|
func TestPackageQuota(t *testing.T) {
|
|
defer tests.PrepareTestEnv(t)()
|
|
|
|
limitTotalOwnerCount, limitTotalOwnerSize, limitSizeGeneric := setting.Packages.LimitTotalOwnerCount, setting.Packages.LimitTotalOwnerSize, setting.Packages.LimitSizeGeneric
|
|
|
|
admin := unittest.AssertExistsAndLoadBean(t, &user_model.User{ID: 1})
|
|
user := unittest.AssertExistsAndLoadBean(t, &user_model.User{ID: 10})
|
|
|
|
uploadPackage := func(doer *user_model.User, version string, expectedStatus int) {
|
|
url := fmt.Sprintf("/api/packages/%s/generic/test-package/%s/file.bin", user.Name, version)
|
|
req := NewRequestWithBody(t, "PUT", url, bytes.NewReader([]byte{1}))
|
|
AddBasicAuthHeader(req, doer.Name)
|
|
MakeRequest(t, req, expectedStatus)
|
|
}
|
|
|
|
// Exceeded quota result in StatusForbidden for normal users but admins are always allowed to upload.
|
|
|
|
setting.Packages.LimitTotalOwnerCount = 0
|
|
uploadPackage(user, "1.0", http.StatusForbidden)
|
|
uploadPackage(admin, "1.0", http.StatusCreated)
|
|
setting.Packages.LimitTotalOwnerCount = limitTotalOwnerCount
|
|
|
|
setting.Packages.LimitTotalOwnerSize = 0
|
|
uploadPackage(user, "1.1", http.StatusForbidden)
|
|
uploadPackage(admin, "1.1", http.StatusCreated)
|
|
setting.Packages.LimitTotalOwnerSize = limitTotalOwnerSize
|
|
|
|
setting.Packages.LimitSizeGeneric = 0
|
|
uploadPackage(user, "1.2", http.StatusForbidden)
|
|
uploadPackage(admin, "1.2", http.StatusCreated)
|
|
setting.Packages.LimitSizeGeneric = limitSizeGeneric
|
|
}
|
|
|
|
func TestPackageCleanup(t *testing.T) {
|
|
defer tests.PrepareTestEnv(t)()
|
|
|
|
duration, _ := time.ParseDuration("-1h")
|
|
|
|
t.Run("Common", func(t *testing.T) {
|
|
defer tests.PrintCurrentTest(t)()
|
|
|
|
pbs, err := packages_model.FindExpiredUnreferencedBlobs(db.DefaultContext, duration)
|
|
assert.NoError(t, err)
|
|
assert.NotEmpty(t, pbs)
|
|
|
|
_, err = packages_model.GetInternalVersionByNameAndVersion(db.DefaultContext, 2, packages_model.TypeContainer, "test", container_model.UploadVersion)
|
|
assert.NoError(t, err)
|
|
|
|
err = packages_service.Cleanup(db.DefaultContext, duration)
|
|
assert.NoError(t, err)
|
|
|
|
pbs, err = packages_model.FindExpiredUnreferencedBlobs(db.DefaultContext, duration)
|
|
assert.NoError(t, err)
|
|
assert.Empty(t, pbs)
|
|
|
|
_, err = packages_model.GetInternalVersionByNameAndVersion(db.DefaultContext, 2, packages_model.TypeContainer, "test", container_model.UploadVersion)
|
|
assert.ErrorIs(t, err, packages_model.ErrPackageNotExist)
|
|
})
|
|
|
|
t.Run("CleanupRules", func(t *testing.T) {
|
|
defer tests.PrintCurrentTest(t)()
|
|
|
|
user := unittest.AssertExistsAndLoadBean(t, &user_model.User{ID: 2})
|
|
|
|
type version struct {
|
|
Version string
|
|
ShouldExist bool
|
|
Created int64
|
|
}
|
|
|
|
cases := []struct {
|
|
Name string
|
|
Versions []version
|
|
Rule *packages_model.PackageCleanupRule
|
|
}{
|
|
{
|
|
Name: "Disabled",
|
|
Versions: []version{
|
|
{Version: "keep", ShouldExist: true},
|
|
},
|
|
Rule: &packages_model.PackageCleanupRule{
|
|
Enabled: false,
|
|
},
|
|
},
|
|
{
|
|
Name: "KeepCount",
|
|
Versions: []version{
|
|
{Version: "keep", ShouldExist: true},
|
|
{Version: "v1.0", ShouldExist: true},
|
|
{Version: "test-3", ShouldExist: false, Created: 1},
|
|
{Version: "test-4", ShouldExist: false, Created: 1},
|
|
},
|
|
Rule: &packages_model.PackageCleanupRule{
|
|
Enabled: true,
|
|
KeepCount: 2,
|
|
},
|
|
},
|
|
{
|
|
Name: "KeepPattern",
|
|
Versions: []version{
|
|
{Version: "keep", ShouldExist: true},
|
|
{Version: "v1.0", ShouldExist: false},
|
|
},
|
|
Rule: &packages_model.PackageCleanupRule{
|
|
Enabled: true,
|
|
KeepPattern: "k.+p",
|
|
},
|
|
},
|
|
{
|
|
Name: "RemoveDays",
|
|
Versions: []version{
|
|
{Version: "keep", ShouldExist: true},
|
|
{Version: "v1.0", ShouldExist: false, Created: 1},
|
|
},
|
|
Rule: &packages_model.PackageCleanupRule{
|
|
Enabled: true,
|
|
RemoveDays: 60,
|
|
},
|
|
},
|
|
{
|
|
Name: "RemovePattern",
|
|
Versions: []version{
|
|
{Version: "test", ShouldExist: true},
|
|
{Version: "test-3", ShouldExist: false},
|
|
{Version: "test-4", ShouldExist: false},
|
|
},
|
|
Rule: &packages_model.PackageCleanupRule{
|
|
Enabled: true,
|
|
RemovePattern: `t[e]+st-\d+`,
|
|
},
|
|
},
|
|
{
|
|
Name: "MatchFullName",
|
|
Versions: []version{
|
|
{Version: "keep", ShouldExist: true},
|
|
{Version: "test", ShouldExist: false},
|
|
},
|
|
Rule: &packages_model.PackageCleanupRule{
|
|
Enabled: true,
|
|
RemovePattern: `package/test|different/keep`,
|
|
MatchFullName: true,
|
|
},
|
|
},
|
|
{
|
|
Name: "Mixed",
|
|
Versions: []version{
|
|
{Version: "keep", ShouldExist: true, Created: time.Now().Add(time.Duration(10000)).Unix()},
|
|
{Version: "dummy", ShouldExist: true, Created: 1},
|
|
{Version: "test-3", ShouldExist: true},
|
|
{Version: "test-4", ShouldExist: false, Created: 1},
|
|
},
|
|
Rule: &packages_model.PackageCleanupRule{
|
|
Enabled: true,
|
|
KeepCount: 1,
|
|
KeepPattern: `dummy`,
|
|
RemoveDays: 7,
|
|
RemovePattern: `t[e]+st-\d+`,
|
|
},
|
|
},
|
|
}
|
|
|
|
for _, c := range cases {
|
|
t.Run(c.Name, func(t *testing.T) {
|
|
defer tests.PrintCurrentTest(t)()
|
|
|
|
for _, v := range c.Versions {
|
|
url := fmt.Sprintf("/api/packages/%s/generic/package/%s/file.bin", user.Name, v.Version)
|
|
req := NewRequestWithBody(t, "PUT", url, bytes.NewReader([]byte{1}))
|
|
AddBasicAuthHeader(req, user.Name)
|
|
MakeRequest(t, req, http.StatusCreated)
|
|
|
|
if v.Created != 0 {
|
|
pv, err := packages_model.GetVersionByNameAndVersion(db.DefaultContext, user.ID, packages_model.TypeGeneric, "package", v.Version)
|
|
assert.NoError(t, err)
|
|
_, err = db.GetEngine(db.DefaultContext).Exec("UPDATE package_version SET created_unix = ? WHERE id = ?", v.Created, pv.ID)
|
|
assert.NoError(t, err)
|
|
}
|
|
}
|
|
|
|
c.Rule.OwnerID = user.ID
|
|
c.Rule.Type = packages_model.TypeGeneric
|
|
|
|
pcr, err := packages_model.InsertCleanupRule(db.DefaultContext, c.Rule)
|
|
assert.NoError(t, err)
|
|
|
|
err = packages_service.Cleanup(db.DefaultContext, duration)
|
|
assert.NoError(t, err)
|
|
|
|
for _, v := range c.Versions {
|
|
pv, err := packages_model.GetVersionByNameAndVersion(db.DefaultContext, user.ID, packages_model.TypeGeneric, "package", v.Version)
|
|
if v.ShouldExist {
|
|
assert.NoError(t, err)
|
|
err = packages_service.DeletePackageVersionAndReferences(db.DefaultContext, pv)
|
|
assert.NoError(t, err)
|
|
} else {
|
|
assert.ErrorIs(t, err, packages_model.ErrPackageNotExist)
|
|
}
|
|
}
|
|
|
|
assert.NoError(t, packages_model.DeleteCleanupRuleByID(db.DefaultContext, pcr.ID))
|
|
})
|
|
}
|
|
})
|
|
}
|