Move mirror to a standalone package from models (#7486)
* move mirror to a standalone package * fix mirror address in template * fix tests * fix lint * fix comment * fix tests * fix tests * fix vendor * fix fmt * fix lint * remove wrong file submitted * fix conflict * remove unrelated changes * fix go mod * fix tests * clean go mod * make vendor work * make vendor work * fix tests * remove duplicated testtokarchuk/v1.17
Lunny Xiao
5 years ago
committed by
GitHub
parent
177aedfca9
commit
7ff783b732
@ -0,0 +1,395 @@ |
|||||||
|
// Copyright 2019 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 mirror |
||||||
|
|
||||||
|
import ( |
||||||
|
"fmt" |
||||||
|
"net/url" |
||||||
|
"strings" |
||||||
|
"time" |
||||||
|
|
||||||
|
"code.gitea.io/gitea/models" |
||||||
|
"code.gitea.io/gitea/modules/cache" |
||||||
|
"code.gitea.io/gitea/modules/git" |
||||||
|
"code.gitea.io/gitea/modules/log" |
||||||
|
"code.gitea.io/gitea/modules/process" |
||||||
|
"code.gitea.io/gitea/modules/setting" |
||||||
|
"code.gitea.io/gitea/modules/sync" |
||||||
|
"code.gitea.io/gitea/modules/timeutil" |
||||||
|
"code.gitea.io/gitea/modules/util" |
||||||
|
|
||||||
|
"github.com/mcuadros/go-version" |
||||||
|
"github.com/unknwon/com" |
||||||
|
) |
||||||
|
|
||||||
|
// mirrorQueue holds an UniqueQueue object of the mirror
|
||||||
|
var mirrorQueue = sync.NewUniqueQueue(setting.Repository.MirrorQueueLength) |
||||||
|
|
||||||
|
func readAddress(m *models.Mirror) { |
||||||
|
if len(m.Address) > 0 { |
||||||
|
return |
||||||
|
} |
||||||
|
var err error |
||||||
|
m.Address, err = remoteAddress(m.Repo.RepoPath()) |
||||||
|
if err != nil { |
||||||
|
log.Error("remoteAddress: %v", err) |
||||||
|
} |
||||||
|
} |
||||||
|
|
||||||
|
func remoteAddress(repoPath string) (string, error) { |
||||||
|
var cmd *git.Command |
||||||
|
binVersion, err := git.BinVersion() |
||||||
|
if err != nil { |
||||||
|
return "", err |
||||||
|
} |
||||||
|
if version.Compare(binVersion, "2.7", ">=") { |
||||||
|
cmd = git.NewCommand("remote", "get-url", "origin") |
||||||
|
} else { |
||||||
|
cmd = git.NewCommand("config", "--get", "remote.origin.url") |
||||||
|
} |
||||||
|
|
||||||
|
result, err := cmd.RunInDir(repoPath) |
||||||
|
if err != nil { |
||||||
|
if strings.HasPrefix(err.Error(), "exit status 128 - fatal: No such remote ") { |
||||||
|
return "", nil |
||||||
|
} |
||||||
|
return "", err |
||||||
|
} |
||||||
|
if len(result) > 0 { |
||||||
|
return result[:len(result)-1], nil |
||||||
|
} |
||||||
|
return "", nil |
||||||
|
} |
||||||
|
|
||||||
|
// sanitizeOutput sanitizes output of a command, replacing occurrences of the
|
||||||
|
// repository's remote address with a sanitized version.
|
||||||
|
func sanitizeOutput(output, repoPath string) (string, error) { |
||||||
|
remoteAddr, err := remoteAddress(repoPath) |
||||||
|
if err != nil { |
||||||
|
// if we're unable to load the remote address, then we're unable to
|
||||||
|
// sanitize.
|
||||||
|
return "", err |
||||||
|
} |
||||||
|
return util.SanitizeMessage(output, remoteAddr), nil |
||||||
|
} |
||||||
|
|
||||||
|
// AddressNoCredentials returns mirror address from Git repository config without credentials.
|
||||||
|
func AddressNoCredentials(m *models.Mirror) string { |
||||||
|
readAddress(m) |
||||||
|
u, err := url.Parse(m.Address) |
||||||
|
if err != nil { |
||||||
|
// this shouldn't happen but just return it unsanitised
|
||||||
|
return m.Address |
||||||
|
} |
||||||
|
u.User = nil |
||||||
|
return u.String() |
||||||
|
} |
||||||
|
|
||||||
|
// SaveAddress writes new address to Git repository config.
|
||||||
|
func SaveAddress(m *models.Mirror, addr string) error { |
||||||
|
repoPath := m.Repo.RepoPath() |
||||||
|
// Remove old origin
|
||||||
|
_, err := git.NewCommand("remote", "remove", "origin").RunInDir(repoPath) |
||||||
|
if err != nil && !strings.HasPrefix(err.Error(), "exit status 128 - fatal: No such remote ") { |
||||||
|
return err |
||||||
|
} |
||||||
|
|
||||||
|
_, err = git.NewCommand("remote", "add", "origin", "--mirror=fetch", addr).RunInDir(repoPath) |
||||||
|
return err |
||||||
|
} |
||||||
|
|
||||||
|
// gitShortEmptySha Git short empty SHA
|
||||||
|
const gitShortEmptySha = "0000000" |
||||||
|
|
||||||
|
// mirrorSyncResult contains information of a updated reference.
|
||||||
|
// If the oldCommitID is "0000000", it means a new reference, the value of newCommitID is empty.
|
||||||
|
// If the newCommitID is "0000000", it means the reference is deleted, the value of oldCommitID is empty.
|
||||||
|
type mirrorSyncResult struct { |
||||||
|
refName string |
||||||
|
oldCommitID string |
||||||
|
newCommitID string |
||||||
|
} |
||||||
|
|
||||||
|
// parseRemoteUpdateOutput detects create, update and delete operations of references from upstream.
|
||||||
|
func parseRemoteUpdateOutput(output string) []*mirrorSyncResult { |
||||||
|
results := make([]*mirrorSyncResult, 0, 3) |
||||||
|
lines := strings.Split(output, "\n") |
||||||
|
for i := range lines { |
||||||
|
// Make sure reference name is presented before continue
|
||||||
|
idx := strings.Index(lines[i], "-> ") |
||||||
|
if idx == -1 { |
||||||
|
continue |
||||||
|
} |
||||||
|
|
||||||
|
refName := lines[i][idx+3:] |
||||||
|
|
||||||
|
switch { |
||||||
|
case strings.HasPrefix(lines[i], " * "): // New reference
|
||||||
|
results = append(results, &mirrorSyncResult{ |
||||||
|
refName: refName, |
||||||
|
oldCommitID: gitShortEmptySha, |
||||||
|
}) |
||||||
|
case strings.HasPrefix(lines[i], " - "): // Delete reference
|
||||||
|
results = append(results, &mirrorSyncResult{ |
||||||
|
refName: refName, |
||||||
|
newCommitID: gitShortEmptySha, |
||||||
|
}) |
||||||
|
case strings.HasPrefix(lines[i], " "): // New commits of a reference
|
||||||
|
delimIdx := strings.Index(lines[i][3:], " ") |
||||||
|
if delimIdx == -1 { |
||||||
|
log.Error("SHA delimiter not found: %q", lines[i]) |
||||||
|
continue |
||||||
|
} |
||||||
|
shas := strings.Split(lines[i][3:delimIdx+3], "..") |
||||||
|
if len(shas) != 2 { |
||||||
|
log.Error("Expect two SHAs but not what found: %q", lines[i]) |
||||||
|
continue |
||||||
|
} |
||||||
|
results = append(results, &mirrorSyncResult{ |
||||||
|
refName: refName, |
||||||
|
oldCommitID: shas[0], |
||||||
|
newCommitID: shas[1], |
||||||
|
}) |
||||||
|
|
||||||
|
default: |
||||||
|
log.Warn("parseRemoteUpdateOutput: unexpected update line %q", lines[i]) |
||||||
|
} |
||||||
|
} |
||||||
|
return results |
||||||
|
} |
||||||
|
|
||||||
|
// runSync returns true if sync finished without error.
|
||||||
|
func runSync(m *models.Mirror) ([]*mirrorSyncResult, bool) { |
||||||
|
repoPath := m.Repo.RepoPath() |
||||||
|
wikiPath := m.Repo.WikiPath() |
||||||
|
timeout := time.Duration(setting.Git.Timeout.Mirror) * time.Second |
||||||
|
|
||||||
|
gitArgs := []string{"remote", "update"} |
||||||
|
if m.EnablePrune { |
||||||
|
gitArgs = append(gitArgs, "--prune") |
||||||
|
} |
||||||
|
|
||||||
|
_, stderr, err := process.GetManager().ExecDir( |
||||||
|
timeout, repoPath, fmt.Sprintf("Mirror.runSync: %s", repoPath), |
||||||
|
git.GitExecutable, gitArgs...) |
||||||
|
if err != nil { |
||||||
|
// sanitize the output, since it may contain the remote address, which may
|
||||||
|
// contain a password
|
||||||
|
message, err := sanitizeOutput(stderr, repoPath) |
||||||
|
if err != nil { |
||||||
|
log.Error("sanitizeOutput: %v", err) |
||||||
|
return nil, false |
||||||
|
} |
||||||
|
desc := fmt.Sprintf("Failed to update mirror repository '%s': %s", repoPath, message) |
||||||
|
log.Error(desc) |
||||||
|
if err = models.CreateRepositoryNotice(desc); err != nil { |
||||||
|
log.Error("CreateRepositoryNotice: %v", err) |
||||||
|
} |
||||||
|
return nil, false |
||||||
|
} |
||||||
|
output := stderr |
||||||
|
|
||||||
|
gitRepo, err := git.OpenRepository(repoPath) |
||||||
|
if err != nil { |
||||||
|
log.Error("OpenRepository: %v", err) |
||||||
|
return nil, false |
||||||
|
} |
||||||
|
if err = models.SyncReleasesWithTags(m.Repo, gitRepo); err != nil { |
||||||
|
log.Error("Failed to synchronize tags to releases for repository: %v", err) |
||||||
|
} |
||||||
|
|
||||||
|
if err := m.Repo.UpdateSize(); err != nil { |
||||||
|
log.Error("Failed to update size for mirror repository: %v", err) |
||||||
|
} |
||||||
|
|
||||||
|
if m.Repo.HasWiki() { |
||||||
|
if _, stderr, err := process.GetManager().ExecDir( |
||||||
|
timeout, wikiPath, fmt.Sprintf("Mirror.runSync: %s", wikiPath), |
||||||
|
git.GitExecutable, "remote", "update", "--prune"); err != nil { |
||||||
|
// sanitize the output, since it may contain the remote address, which may
|
||||||
|
// contain a password
|
||||||
|
message, err := sanitizeOutput(stderr, wikiPath) |
||||||
|
if err != nil { |
||||||
|
log.Error("sanitizeOutput: %v", err) |
||||||
|
return nil, false |
||||||
|
} |
||||||
|
desc := fmt.Sprintf("Failed to update mirror wiki repository '%s': %s", wikiPath, message) |
||||||
|
log.Error(desc) |
||||||
|
if err = models.CreateRepositoryNotice(desc); err != nil { |
||||||
|
log.Error("CreateRepositoryNotice: %v", err) |
||||||
|
} |
||||||
|
return nil, false |
||||||
|
} |
||||||
|
} |
||||||
|
|
||||||
|
branches, err := m.Repo.GetBranches() |
||||||
|
if err != nil { |
||||||
|
log.Error("GetBranches: %v", err) |
||||||
|
return nil, false |
||||||
|
} |
||||||
|
|
||||||
|
for i := range branches { |
||||||
|
cache.Remove(m.Repo.GetCommitsCountCacheKey(branches[i].Name, true)) |
||||||
|
} |
||||||
|
|
||||||
|
m.UpdatedUnix = timeutil.TimeStampNow() |
||||||
|
return parseRemoteUpdateOutput(output), true |
||||||
|
} |
||||||
|
|
||||||
|
// Address returns mirror address from Git repository config without credentials.
|
||||||
|
func Address(m *models.Mirror) string { |
||||||
|
readAddress(m) |
||||||
|
return util.SanitizeURLCredentials(m.Address, false) |
||||||
|
} |
||||||
|
|
||||||
|
// Username returns the mirror address username
|
||||||
|
func Username(m *models.Mirror) string { |
||||||
|
readAddress(m) |
||||||
|
u, err := url.Parse(m.Address) |
||||||
|
if err != nil { |
||||||
|
// this shouldn't happen but if it does return ""
|
||||||
|
return "" |
||||||
|
} |
||||||
|
return u.User.Username() |
||||||
|
} |
||||||
|
|
||||||
|
// Password returns the mirror address password
|
||||||
|
func Password(m *models.Mirror) string { |
||||||
|
readAddress(m) |
||||||
|
u, err := url.Parse(m.Address) |
||||||
|
if err != nil { |
||||||
|
// this shouldn't happen but if it does return ""
|
||||||
|
return "" |
||||||
|
} |
||||||
|
password, _ := u.User.Password() |
||||||
|
return password |
||||||
|
} |
||||||
|
|
||||||
|
// Update checks and updates mirror repositories.
|
||||||
|
func Update() { |
||||||
|
log.Trace("Doing: Update") |
||||||
|
|
||||||
|
if err := models.MirrorsIterate(func(idx int, bean interface{}) error { |
||||||
|
m := bean.(*models.Mirror) |
||||||
|
if m.Repo == nil { |
||||||
|
log.Error("Disconnected mirror repository found: %d", m.ID) |
||||||
|
return nil |
||||||
|
} |
||||||
|
|
||||||
|
mirrorQueue.Add(m.RepoID) |
||||||
|
return nil |
||||||
|
}); err != nil { |
||||||
|
log.Error("Update: %v", err) |
||||||
|
} |
||||||
|
} |
||||||
|
|
||||||
|
// SyncMirrors checks and syncs mirrors.
|
||||||
|
// TODO: sync more mirrors at same time.
|
||||||
|
func SyncMirrors() { |
||||||
|
// Start listening on new sync requests.
|
||||||
|
for repoID := range mirrorQueue.Queue() { |
||||||
|
log.Trace("SyncMirrors [repo_id: %v]", repoID) |
||||||
|
mirrorQueue.Remove(repoID) |
||||||
|
|
||||||
|
m, err := models.GetMirrorByRepoID(com.StrTo(repoID).MustInt64()) |
||||||
|
if err != nil { |
||||||
|
log.Error("GetMirrorByRepoID [%s]: %v", repoID, err) |
||||||
|
continue |
||||||
|
} |
||||||
|
|
||||||
|
results, ok := runSync(m) |
||||||
|
if !ok { |
||||||
|
continue |
||||||
|
} |
||||||
|
|
||||||
|
m.ScheduleNextUpdate() |
||||||
|
if err = models.UpdateMirror(m); err != nil { |
||||||
|
log.Error("UpdateMirror [%s]: %v", repoID, err) |
||||||
|
continue |
||||||
|
} |
||||||
|
|
||||||
|
var gitRepo *git.Repository |
||||||
|
if len(results) == 0 { |
||||||
|
log.Trace("SyncMirrors [repo_id: %d]: no commits fetched", m.RepoID) |
||||||
|
} else { |
||||||
|
gitRepo, err = git.OpenRepository(m.Repo.RepoPath()) |
||||||
|
if err != nil { |
||||||
|
log.Error("OpenRepository [%d]: %v", m.RepoID, err) |
||||||
|
continue |
||||||
|
} |
||||||
|
} |
||||||
|
|
||||||
|
for _, result := range results { |
||||||
|
// Discard GitHub pull requests, i.e. refs/pull/*
|
||||||
|
if strings.HasPrefix(result.refName, "refs/pull/") { |
||||||
|
continue |
||||||
|
} |
||||||
|
|
||||||
|
// Create reference
|
||||||
|
if result.oldCommitID == gitShortEmptySha { |
||||||
|
if err = models.MirrorSyncCreateAction(m.Repo, result.refName); err != nil { |
||||||
|
log.Error("MirrorSyncCreateAction [repo_id: %d]: %v", m.RepoID, err) |
||||||
|
} |
||||||
|
continue |
||||||
|
} |
||||||
|
|
||||||
|
// Delete reference
|
||||||
|
if result.newCommitID == gitShortEmptySha { |
||||||
|
if err = models.MirrorSyncDeleteAction(m.Repo, result.refName); err != nil { |
||||||
|
log.Error("MirrorSyncDeleteAction [repo_id: %d]: %v", m.RepoID, err) |
||||||
|
} |
||||||
|
continue |
||||||
|
} |
||||||
|
|
||||||
|
// Push commits
|
||||||
|
oldCommitID, err := git.GetFullCommitID(gitRepo.Path, result.oldCommitID) |
||||||
|
if err != nil { |
||||||
|
log.Error("GetFullCommitID [%d]: %v", m.RepoID, err) |
||||||
|
continue |
||||||
|
} |
||||||
|
newCommitID, err := git.GetFullCommitID(gitRepo.Path, result.newCommitID) |
||||||
|
if err != nil { |
||||||
|
log.Error("GetFullCommitID [%d]: %v", m.RepoID, err) |
||||||
|
continue |
||||||
|
} |
||||||
|
commits, err := gitRepo.CommitsBetweenIDs(newCommitID, oldCommitID) |
||||||
|
if err != nil { |
||||||
|
log.Error("CommitsBetweenIDs [repo_id: %d, new_commit_id: %s, old_commit_id: %s]: %v", m.RepoID, newCommitID, oldCommitID, err) |
||||||
|
continue |
||||||
|
} |
||||||
|
if err = models.MirrorSyncPushAction(m.Repo, models.MirrorSyncPushActionOptions{ |
||||||
|
RefName: result.refName, |
||||||
|
OldCommitID: oldCommitID, |
||||||
|
NewCommitID: newCommitID, |
||||||
|
Commits: models.ListToPushCommits(commits), |
||||||
|
}); err != nil { |
||||||
|
log.Error("MirrorSyncPushAction [repo_id: %d]: %v", m.RepoID, err) |
||||||
|
continue |
||||||
|
} |
||||||
|
} |
||||||
|
|
||||||
|
// Get latest commit date and update to current repository updated time
|
||||||
|
commitDate, err := git.GetLatestCommitTime(m.Repo.RepoPath()) |
||||||
|
if err != nil { |
||||||
|
log.Error("GetLatestCommitDate [%d]: %v", m.RepoID, err) |
||||||
|
continue |
||||||
|
} |
||||||
|
|
||||||
|
if err = models.UpdateRepositoryUpdatedTime(m.RepoID, commitDate); err != nil { |
||||||
|
log.Error("Update repository 'updated_unix' [%d]: %v", m.RepoID, err) |
||||||
|
continue |
||||||
|
} |
||||||
|
} |
||||||
|
} |
||||||
|
|
||||||
|
// InitSyncMirrors initializes a go routine to sync the mirrors
|
||||||
|
func InitSyncMirrors() { |
||||||
|
go SyncMirrors() |
||||||
|
} |
||||||
|
|
||||||
|
// StartToMirror adds repoID to mirror queue
|
||||||
|
func StartToMirror(repoID int64) { |
||||||
|
go mirrorQueue.Add(repoID) |
||||||
|
} |
||||||
@ -0,0 +1,78 @@ |
|||||||
|
// Copyright 2019 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 mirror |
||||||
|
|
||||||
|
import ( |
||||||
|
"path/filepath" |
||||||
|
"testing" |
||||||
|
|
||||||
|
"code.gitea.io/gitea/models" |
||||||
|
"code.gitea.io/gitea/modules/git" |
||||||
|
release_service "code.gitea.io/gitea/services/release" |
||||||
|
|
||||||
|
"github.com/stretchr/testify/assert" |
||||||
|
) |
||||||
|
|
||||||
|
func TestMain(m *testing.M) { |
||||||
|
models.MainTest(m, filepath.Join("..", "..")) |
||||||
|
} |
||||||
|
|
||||||
|
func TestRelease_MirrorDelete(t *testing.T) { |
||||||
|
assert.NoError(t, models.PrepareTestDatabase()) |
||||||
|
|
||||||
|
user := models.AssertExistsAndLoadBean(t, &models.User{ID: 2}).(*models.User) |
||||||
|
repo := models.AssertExistsAndLoadBean(t, &models.Repository{ID: 1}).(*models.Repository) |
||||||
|
repoPath := models.RepoPath(user.Name, repo.Name) |
||||||
|
|
||||||
|
migrationOptions := models.MigrateRepoOptions{ |
||||||
|
Name: "test_mirror", |
||||||
|
Description: "Test mirror", |
||||||
|
IsPrivate: false, |
||||||
|
IsMirror: true, |
||||||
|
RemoteAddr: repoPath, |
||||||
|
Wiki: true, |
||||||
|
SyncReleasesWithTags: true, |
||||||
|
} |
||||||
|
mirror, err := models.MigrateRepository(user, user, migrationOptions) |
||||||
|
assert.NoError(t, err) |
||||||
|
|
||||||
|
gitRepo, err := git.OpenRepository(repoPath) |
||||||
|
assert.NoError(t, err) |
||||||
|
|
||||||
|
findOptions := models.FindReleasesOptions{IncludeDrafts: true, IncludeTags: true} |
||||||
|
initCount, err := models.GetReleaseCountByRepoID(mirror.ID, findOptions) |
||||||
|
assert.NoError(t, err) |
||||||
|
|
||||||
|
assert.NoError(t, release_service.CreateRelease(gitRepo, &models.Release{ |
||||||
|
RepoID: repo.ID, |
||||||
|
PublisherID: user.ID, |
||||||
|
TagName: "v0.2", |
||||||
|
Target: "master", |
||||||
|
Title: "v0.2 is released", |
||||||
|
Note: "v0.2 is released", |
||||||
|
IsDraft: false, |
||||||
|
IsPrerelease: false, |
||||||
|
IsTag: true, |
||||||
|
}, nil)) |
||||||
|
|
||||||
|
err = mirror.GetMirror() |
||||||
|
assert.NoError(t, err) |
||||||
|
|
||||||
|
_, ok := runSync(mirror.Mirror) |
||||||
|
assert.True(t, ok) |
||||||
|
|
||||||
|
count, err := models.GetReleaseCountByRepoID(mirror.ID, findOptions) |
||||||
|
assert.EqualValues(t, initCount+1, count) |
||||||
|
|
||||||
|
release, err := models.GetRelease(repo.ID, "v0.2") |
||||||
|
assert.NoError(t, err) |
||||||
|
assert.NoError(t, release_service.DeleteReleaseByID(release.ID, user, true)) |
||||||
|
|
||||||
|
_, ok = runSync(mirror.Mirror) |
||||||
|
assert.True(t, ok) |
||||||
|
|
||||||
|
count, err = models.GetReleaseCountByRepoID(mirror.ID, findOptions) |
||||||
|
assert.EqualValues(t, initCount, count) |
||||||
|
} |
||||||
Loading…
Reference in new issue