mirror of
https://codeberg.org/forgejo/forgejo.git
synced 2025-08-02 08:25:20 +02:00
feat: add configuration to only push mirror selected branches (#7823)
Adds the ability to selectively choose which branches are pushed to a mirror. This change adds an additional text box on the repository settings for each push mirror. Existing behavior is preserved when the field is left blank. When the repository is being pushed, only branches matching the comma separated branch filter are pushed. Resolves forgejo/forgejo#7242 Reviewed-on: https://codeberg.org/forgejo/forgejo/pulls/7823 Reviewed-by: Gusted <gusted@noreply.codeberg.org> Co-authored-by: Paul Campbell <pcampbell@kemitix.net> Co-committed-by: Paul Campbell <pcampbell@kemitix.net>
This commit is contained in:
Paul Campbell
Gusted
parent
0b74ecebe0
commit
9dfdacf54f
16 changed files with 1089 additions and 10 deletions
|
|
@ -14,6 +14,7 @@ import (
|
|||
"os/exec"
|
||||
"path/filepath"
|
||||
"strconv"
|
||||
"strings"
|
||||
"testing"
|
||||
"time"
|
||||
|
||||
|
|
@ -142,6 +143,159 @@ func testAPIPushMirror(t *testing.T, u *url.URL) {
|
|||
}
|
||||
}
|
||||
|
||||
func TestAPIPushMirrorBranchFilter(t *testing.T) {
|
||||
onGiteaRun(t, testAPIPushMirrorBranchFilter)
|
||||
}
|
||||
|
||||
func testAPIPushMirrorBranchFilter(t *testing.T, u *url.URL) {
|
||||
defer test.MockVariableValue(&setting.Migrations.AllowLocalNetworks, true)()
|
||||
defer test.MockVariableValue(&setting.Mirror.Enabled, true)()
|
||||
defer test.MockProtect(&mirror_service.AddPushMirrorRemote)()
|
||||
defer test.MockProtect(&repo_model.DeletePushMirrors)()
|
||||
|
||||
require.NoError(t, migrations.Init())
|
||||
|
||||
user := unittest.AssertExistsAndLoadBean(t, &user_model.User{ID: 1})
|
||||
srcRepo := unittest.AssertExistsAndLoadBean(t, &repo_model.Repository{ID: 1})
|
||||
owner := unittest.AssertExistsAndLoadBean(t, &user_model.User{ID: srcRepo.OwnerID})
|
||||
session := loginUser(t, user.Name)
|
||||
token := getTokenForLoggedInUser(t, session, auth_model.AccessTokenScopeAll)
|
||||
urlStr := fmt.Sprintf("/api/v1/repos/%s/%s/push_mirrors", owner.Name, srcRepo.Name)
|
||||
|
||||
mirrorRepo, _, f := tests.CreateDeclarativeRepo(t, user, "", []unit.Type{unit.TypeCode}, nil, nil)
|
||||
defer f()
|
||||
remoteAddress := fmt.Sprintf("%s%s/%s", u.String(), url.PathEscape(user.Name), url.PathEscape(mirrorRepo.Name))
|
||||
|
||||
t.Run("Create push mirror with branch filter", func(t *testing.T) {
|
||||
req := NewRequestWithJSON(t, "POST", urlStr, &api.CreatePushMirrorOption{
|
||||
RemoteAddress: remoteAddress,
|
||||
Interval: "8h",
|
||||
BranchFilter: "main,develop",
|
||||
}).AddTokenAuth(token)
|
||||
|
||||
MakeRequest(t, req, http.StatusOK)
|
||||
|
||||
// Verify the push mirror was created with branch filter
|
||||
req = NewRequest(t, "GET", urlStr).AddTokenAuth(token)
|
||||
resp := MakeRequest(t, req, http.StatusOK)
|
||||
var pushMirrors []*api.PushMirror
|
||||
DecodeJSON(t, resp, &pushMirrors)
|
||||
require.Len(t, pushMirrors, 1)
|
||||
assert.Equal(t, "main,develop", pushMirrors[0].BranchFilter)
|
||||
|
||||
// Cleanup
|
||||
req = NewRequest(t, "DELETE", fmt.Sprintf("%s/%s", urlStr, pushMirrors[0].RemoteName)).AddTokenAuth(token)
|
||||
MakeRequest(t, req, http.StatusNoContent)
|
||||
})
|
||||
|
||||
t.Run("Create push mirror with empty branch filter", func(t *testing.T) {
|
||||
req := NewRequestWithJSON(t, "POST", urlStr, &api.CreatePushMirrorOption{
|
||||
RemoteAddress: remoteAddress,
|
||||
Interval: "8h",
|
||||
BranchFilter: "",
|
||||
}).AddTokenAuth(token)
|
||||
|
||||
MakeRequest(t, req, http.StatusOK)
|
||||
|
||||
// Verify the push mirror was created with empty branch filter
|
||||
req = NewRequest(t, "GET", urlStr).AddTokenAuth(token)
|
||||
resp := MakeRequest(t, req, http.StatusOK)
|
||||
var pushMirrors []*api.PushMirror
|
||||
DecodeJSON(t, resp, &pushMirrors)
|
||||
require.Len(t, pushMirrors, 1)
|
||||
assert.Empty(t, pushMirrors[0].BranchFilter)
|
||||
|
||||
// Cleanup
|
||||
req = NewRequest(t, "DELETE", fmt.Sprintf("%s/%s", urlStr, pushMirrors[0].RemoteName)).AddTokenAuth(token)
|
||||
MakeRequest(t, req, http.StatusNoContent)
|
||||
})
|
||||
|
||||
t.Run("Create push mirror without branch filter parameter", func(t *testing.T) {
|
||||
req := NewRequestWithJSON(t, "POST", urlStr, &api.CreatePushMirrorOption{
|
||||
RemoteAddress: remoteAddress,
|
||||
Interval: "8h",
|
||||
// BranchFilter: ""
|
||||
}).AddTokenAuth(token)
|
||||
|
||||
MakeRequest(t, req, http.StatusOK)
|
||||
|
||||
// Verify the push mirror defaults to empty branch filter
|
||||
req = NewRequest(t, "GET", urlStr).AddTokenAuth(token)
|
||||
resp := MakeRequest(t, req, http.StatusOK)
|
||||
var pushMirrors []*api.PushMirror
|
||||
DecodeJSON(t, resp, &pushMirrors)
|
||||
require.Len(t, pushMirrors, 1)
|
||||
assert.Empty(t, pushMirrors[0].BranchFilter)
|
||||
|
||||
// Cleanup
|
||||
req = NewRequest(t, "DELETE", fmt.Sprintf("%s/%s", urlStr, pushMirrors[0].RemoteName)).AddTokenAuth(token)
|
||||
MakeRequest(t, req, http.StatusNoContent)
|
||||
})
|
||||
|
||||
t.Run("Retrieve multiple push mirrors with different branch filters", func(t *testing.T) {
|
||||
// Create multiple push mirrors with different branch filters
|
||||
testCases := []struct {
|
||||
name string
|
||||
branchFilter string
|
||||
}{
|
||||
{"mirror-1", "main"},
|
||||
{"mirror-2", "develop,feature-*"},
|
||||
{"mirror-3", ""},
|
||||
}
|
||||
|
||||
// Create mirrors
|
||||
mirrorCleanups := []func(){}
|
||||
defer func() {
|
||||
for _, mirror := range mirrorCleanups {
|
||||
mirror()
|
||||
}
|
||||
}()
|
||||
for _, tc := range testCases {
|
||||
mirrorRepo, _, f := tests.CreateDeclarativeRepo(t, user, tc.name, []unit.Type{unit.TypeCode}, nil, nil)
|
||||
mirrorCleanups = append(mirrorCleanups, f)
|
||||
|
||||
remoteAddr := fmt.Sprintf("%s%s/%s", u.String(), url.PathEscape(user.Name), url.PathEscape(mirrorRepo.Name))
|
||||
req := NewRequestWithJSON(t, "POST", urlStr, &api.CreatePushMirrorOption{
|
||||
RemoteAddress: remoteAddr,
|
||||
Interval: "8h",
|
||||
BranchFilter: tc.branchFilter,
|
||||
}).AddTokenAuth(token)
|
||||
|
||||
MakeRequest(t, req, http.StatusOK)
|
||||
}
|
||||
|
||||
// Retrieve all mirrors and verify branch filters
|
||||
req := NewRequest(t, "GET", urlStr).AddTokenAuth(token)
|
||||
resp := MakeRequest(t, req, http.StatusOK)
|
||||
var pushMirrors []*api.PushMirror
|
||||
DecodeJSON(t, resp, &pushMirrors)
|
||||
require.Len(t, pushMirrors, 3)
|
||||
|
||||
// Create a map for easier verification
|
||||
filterMap := make(map[string]string)
|
||||
var createdMirrors []*api.PushMirror
|
||||
for _, mirror := range pushMirrors {
|
||||
for _, tc := range testCases {
|
||||
if strings.Contains(mirror.RemoteAddress, tc.name) {
|
||||
filterMap[tc.name] = mirror.BranchFilter
|
||||
createdMirrors = append(createdMirrors, mirror)
|
||||
break
|
||||
}
|
||||
}
|
||||
}
|
||||
|
||||
assert.Equal(t, "main", filterMap["mirror-1"])
|
||||
assert.Equal(t, "develop,feature-*", filterMap["mirror-2"])
|
||||
assert.Empty(t, filterMap["mirror-3"])
|
||||
|
||||
// Cleanup
|
||||
for _, mirror := range createdMirrors {
|
||||
req = NewRequest(t, "DELETE", fmt.Sprintf("%s/%s", urlStr, mirror.RemoteName)).AddTokenAuth(token)
|
||||
MakeRequest(t, req, http.StatusNoContent)
|
||||
}
|
||||
})
|
||||
}
|
||||
|
||||
func TestAPIPushMirrorSSH(t *testing.T) {
|
||||
_, err := exec.LookPath("ssh")
|
||||
if err != nil {
|
||||
|
|
|
|||
Loading…
Add table
Add a link
Reference in a new issue