[API] add new endpoints for push mirrors management

integrations/mirror_push_test.go

@@ -13,6 +13,7 @@ import (
 	"testing"
 
 	"code.gitea.io/gitea/models"
+	"code.gitea.io/gitea/models/db"
 	repo_model "code.gitea.io/gitea/models/repo"
 	"code.gitea.io/gitea/models/unittest"
 	user_model "code.gitea.io/gitea/models/user"
@@ -47,7 +48,7 @@ func testMirrorPush(t *testing.T, u *url.URL) {
 
 	doCreatePushMirror(ctx, fmt.Sprintf("%s%s/%s", u.String(), url.PathEscape(ctx.Username), url.PathEscape(mirrorRepo.Name)), user.LowerName, userPassword)(t)
 
-	mirrors, err := repo_model.GetPushMirrorsByRepoID(srcRepo.ID)
+	mirrors, err := repo_model.GetPushMirrorsByRepoID(srcRepo.ID, db.ListOptions{})
 	assert.NoError(t, err)
 	assert.Len(t, mirrors, 1)
 
@@ -72,7 +73,7 @@ func testMirrorPush(t *testing.T, u *url.URL) {
 
 	// Cleanup
 	doRemovePushMirror(ctx, fmt.Sprintf("%s%s/%s", u.String(), url.PathEscape(ctx.Username), url.PathEscape(mirrorRepo.Name)), user.LowerName, userPassword, int(mirrors[0].ID))(t)
-	mirrors, err = repo_model.GetPushMirrorsByRepoID(srcRepo.ID)
+	mirrors, err = repo_model.GetPushMirrorsByRepoID(srcRepo.ID, db.ListOptions{})
 	assert.NoError(t, err)
 	assert.Len(t, mirrors, 0)
 }

models/repo/pushmirror.go

@@ -64,18 +64,26 @@ func UpdatePushMirror(m *PushMirror) error {
 }
 
 // DeletePushMirrorByID deletes a push-mirrors by ID
+// WARNING: This does not check if this PushMirror belongs to a RepoID
 func DeletePushMirrorByID(ID int64) error {
 	_, err := db.GetEngine(db.DefaultContext).ID(ID).Delete(&PushMirror{})
 	return err
 }
 
+// DeletePushMirrorByRepoIDAndName deletes a push-mirrors by remote name
+func DeletePushMirrorByRepoIDAndName(repoID int64, remoteName string) error {
+	_, err := db.GetEngine(db.DefaultContext).Where("repo_id = ? AND remote_name = ?", repoID, remoteName).Delete(&PushMirror{})
+	return err
+}
+
 // DeletePushMirrorsByRepoID deletes all push-mirrors by repoID
 func DeletePushMirrorsByRepoID(repoID int64) error {
 	_, err := db.GetEngine(db.DefaultContext).Delete(&PushMirror{RepoID: repoID})
 	return err
 }
 
 // GetPushMirrorByID returns push-mirror information.
+// WARNING: You must ensure that this PushMirror belongs to the repository you are intending to use it with
 func GetPushMirrorByID(ID int64) (*PushMirror, error) {
 	m := &PushMirror{}
 	has, err := db.GetEngine(db.DefaultContext).ID(ID).Get(m)
@@ -87,10 +95,26 @@ func GetPushMirrorByID(ID int64) (*PushMirror, error) {
 	return m, nil
 }
 
+// GetPushMirrorByRepoIDAndName returns push-mirror information.
+func GetPushMirrorByRepoIDAndName(repoID int64, remoteName string) (*PushMirror, error) {
+	m := &PushMirror{}
+	has, err := db.GetEngine(db.DefaultContext).Where("repo_id = ? AND remote_name = ?", repoID, remoteName).Get(m)
+	if err != nil {
+		return nil, err
+	} else if !has {
+		return nil, ErrPushMirrorNotExist
+	}
+	return m, nil
+}
+
 // GetPushMirrorsByRepoID returns push-mirror information of a repository.
-func GetPushMirrorsByRepoID(repoID int64) ([]*PushMirror, error) {
+func GetPushMirrorsByRepoID(repoID int64, listOptions db.ListOptions) ([]*PushMirror, error) {
 	mirrors := make([]*PushMirror, 0, 10)
-	return mirrors, db.GetEngine(db.DefaultContext).Where("repo_id=?", repoID).Find(&mirrors)
+	sess := db.GetEngine(db.DefaultContext).Where("repo_id = ?", repoID)
+	if listOptions.Page != 0 {
+		sess = db.SetSessionPagination(sess, &listOptions)
+	}
+	return mirrors, sess.Find(&mirrors)
 }
 
 // PushMirrorsIterate iterates all push-mirror repositories.

modules/context/repo.go

@@ -398,7 +398,7 @@ func repoAssignment(ctx *Context, repo *repo_model.Repository) {
 		}
 	}
 
-	pushMirrors, err := repo_model.GetPushMirrorsByRepoID(repo.ID)
+	pushMirrors, err := repo_model.GetPushMirrorsByRepoID(repo.ID, db.ListOptions{})
 	if err != nil {
 		ctx.ServerError("GetPushMirrorsByRepoID", err)
 		return

modules/convert/mirror.go

@@ -0,0 +1,35 @@
+// Copyright 2022 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 convert
+
+import (
+	repo_model "code.gitea.io/gitea/models/repo"
+	"code.gitea.io/gitea/modules/git"
+	api "code.gitea.io/gitea/modules/structs"
+)
+
+// ToPushMirror convert from repo_model.PushMirror and remoteAddress to api.TopicResponse
+func ToPushMirror(pm *repo_model.PushMirror, repo *repo_model.Repository) *api.PushMirror {
+	remoteAddress, _ := getMirrorRemoteAddress(repo, pm.RemoteName)
+	return &api.PushMirror{
+		RepoName:       repo.Name,
+		RemoteName:     pm.RemoteName,
+		RemoteAddress:  remoteAddress,
+		CreatedUnix:    pm.CreatedUnix.FormatLong(),
+		LastUpdateUnix: pm.LastUpdateUnix.FormatLong(),
+		LastError:      pm.LastError,
+		Interval:       pm.Interval.String(),
+	}
+}
+
+func getMirrorRemoteAddress(repo *repo_model.Repository, remoteName string) (string, error) {
+	u, err := git.GetRemoteAddress(git.DefaultContext, repo.RepoPath(), remoteName)
+	if err != nil {
+		return "", err
+	}
+	// remove confidential information
+	u.User = nil
+	return u.String(), nil
+}

modules/structs/mirror.go

@@ -0,0 +1,25 @@
+// 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 structs
+
+// CreatePushMirrorOption represents need information to create a push mirror of a repository.
+type CreatePushMirrorOption struct {
+	RemoteAddress  string `json:"remoteAddress"`
+	RemoteUsername string `json:"remoteUsername"`
+	RemotePassword string `json:"remotePassword"`
+	Interval       string `json:"interval"`
+}
+
+// PushMirror represents information of a push mirror
+// swagger:model
+type PushMirror struct {
+	RepoName       string `json:"repoName"`
+	RemoteName     string `json:"remoteName"`
+	RemoteAddress  string `json:"remoteAddress"`
+	CreatedUnix    string `json:"created"`
+	LastUpdateUnix string `json:"lastUpdate"`
+	LastError      string `json:"lastError"`
+	Interval       string `json:"interval"`
+}

routers/api/v1/api.go

@@ -973,6 +973,15 @@ func Routes() *web.Route {
 					})
 				}, reqRepoReader(unit.TypeReleases))
 				m.Post("/mirror-sync", reqToken(), reqRepoWriter(unit.TypeCode), repo.MirrorSync)
+				m.Post("/push-mirror-sync", reqAdmin(), repo.PushMirrorSync)
+				m.Group("/push-mirror", func() {
+					m.Combo("").Get(reqAdmin(), repo.ListPushMirrors).
+						Post(reqAdmin(), bind(api.CreatePushMirrorOption{}), repo.AddPushMirror)
+					m.Combo("/{name}").
+						Delete(reqAdmin(), repo.DeletePushMirrorByID).
+						Get(reqAdmin(), repo.GetPushMirrorByName)
+				})
+
 				m.Get("/editorconfig/{filename}", context.ReferencesGitRepo(), context.RepoRefForAPI, reqRepoReader(unit.TypeCode), repo.GetEditorconfig)
 				m.Group("/pulls", func() {
 					m.Combo("").Get(repo.ListPullRequests).