From 8567cba0d978e6ab68c337c0a80244704a15718a Mon Sep 17 00:00:00 2001 From: Lunny Xiao Date: Tue, 23 Mar 2021 00:09:51 +0800 Subject: Implement delete release attachments and update release attachments' name (#14130) * Implement delete release attachment * Add attachments on release edit page * Fix bug * Finish del release attachments * Fix frontend lint * Fix tests * Support edit release attachments * Added tests * Remove the unnecessary parameter isCreate from UpdateReleaseOrCreatReleaseFromTag * Rename UpdateReleaseOrCreatReleaseFromTag to UpdateRelease * Fix middle align --- services/release/release.go | 119 ++++++++++++++++++++++++++++++++------- services/release/release_test.go | 90 +++++++++++++++++++++++++---- 2 files changed, 177 insertions(+), 32 deletions(-) (limited to 'services') diff --git a/services/release/release.go b/services/release/release.go index d04e538c92..9d201edf6d 100644 --- a/services/release/release.go +++ b/services/release/release.go @@ -5,6 +5,7 @@ package release import ( + "errors" "fmt" "strings" @@ -17,13 +18,14 @@ import ( "code.gitea.io/gitea/modules/timeutil" ) -func createTag(gitRepo *git.Repository, rel *models.Release, msg string) error { +func createTag(gitRepo *git.Repository, rel *models.Release, msg string) (bool, error) { + var created bool // Only actual create when publish. if !rel.IsDraft { if !gitRepo.IsTagExist(rel.TagName) { commit, err := gitRepo.GetCommit(rel.Target) if err != nil { - return fmt.Errorf("GetCommit: %v", err) + return false, fmt.Errorf("GetCommit: %v", err) } // Trim '--' prefix to prevent command line argument vulnerability. @@ -31,25 +33,26 @@ func createTag(gitRepo *git.Repository, rel *models.Release, msg string) error { if len(msg) > 0 { if err = gitRepo.CreateAnnotatedTag(rel.TagName, msg, commit.ID.String()); err != nil { if strings.Contains(err.Error(), "is not a valid tag name") { - return models.ErrInvalidTagName{ + return false, models.ErrInvalidTagName{ TagName: rel.TagName, } } - return err + return false, err } } else if err = gitRepo.CreateTag(rel.TagName, commit.ID.String()); err != nil { if strings.Contains(err.Error(), "is not a valid tag name") { - return models.ErrInvalidTagName{ + return false, models.ErrInvalidTagName{ TagName: rel.TagName, } } - return err + return false, err } + created = true rel.LowerTagName = strings.ToLower(rel.TagName) // Prepare Notify if err := rel.LoadAttributes(); err != nil { log.Error("LoadAttributes: %v", err) - return err + return false, err } notification.NotifyPushCommits( rel.Publisher, rel.Repo, @@ -63,13 +66,13 @@ func createTag(gitRepo *git.Repository, rel *models.Release, msg string) error { } commit, err := gitRepo.GetTagCommit(rel.TagName) if err != nil { - return fmt.Errorf("GetTagCommit: %v", err) + return false, fmt.Errorf("GetTagCommit: %v", err) } rel.Sha1 = commit.ID.String() rel.NumCommits, err = commit.CommitsCount() if err != nil { - return fmt.Errorf("CommitsCount: %v", err) + return false, fmt.Errorf("CommitsCount: %v", err) } if rel.PublisherID <= 0 { @@ -78,11 +81,10 @@ func createTag(gitRepo *git.Repository, rel *models.Release, msg string) error { rel.PublisherID = u.ID } } - } else { rel.CreatedUnix = timeutil.TimeStampNow() } - return nil + return created, nil } // CreateRelease creates a new release of repository. @@ -96,7 +98,7 @@ func CreateRelease(gitRepo *git.Repository, rel *models.Release, attachmentUUIDs } } - if err = createTag(gitRepo, rel, msg); err != nil { + if _, err = createTag(gitRepo, rel, msg); err != nil { return err } @@ -105,7 +107,7 @@ func CreateRelease(gitRepo *git.Repository, rel *models.Release, attachmentUUIDs return err } - if err = models.AddReleaseAttachments(rel.ID, attachmentUUIDs); err != nil { + if err = models.AddReleaseAttachments(models.DefaultDBContext(), rel.ID, attachmentUUIDs); err != nil { return err } @@ -143,7 +145,7 @@ func CreateNewTag(doer *models.User, repo *models.Repository, commit, tagName, m IsTag: true, } - if err = createTag(gitRepo, rel, msg); err != nil { + if _, err = createTag(gitRepo, rel, msg); err != nil { return err } @@ -154,22 +156,97 @@ func CreateNewTag(doer *models.User, repo *models.Repository, commit, tagName, m return err } -// UpdateReleaseOrCreatReleaseFromTag updates information of a release or create release from tag. -func UpdateReleaseOrCreatReleaseFromTag(doer *models.User, gitRepo *git.Repository, rel *models.Release, attachmentUUIDs []string, isCreate bool) (err error) { - if err = createTag(gitRepo, rel, ""); err != nil { +// UpdateRelease updates information, attachments of a release and will create tag if it's not a draft and tag not exist. +// addAttachmentUUIDs accept a slice of new created attachments' uuids which will be reassigned release_id as the created release +// delAttachmentUUIDs accept a slice of attachments' uuids which will be deleted from the release +// editAttachments accept a map of attachment uuid to new attachment name which will be updated with attachments. +func UpdateRelease(doer *models.User, gitRepo *git.Repository, rel *models.Release, + addAttachmentUUIDs, delAttachmentUUIDs []string, editAttachments map[string]string) (err error) { + if rel.ID == 0 { + return errors.New("UpdateRelease only accepts an exist release") + } + isCreated, err := createTag(gitRepo, rel, "") + if err != nil { return err } rel.LowerTagName = strings.ToLower(rel.TagName) - if err = models.UpdateRelease(models.DefaultDBContext(), rel); err != nil { + ctx, commiter, err := models.TxDBContext() + if err != nil { + return err + } + defer commiter.Close() + + if err = models.UpdateRelease(ctx, rel); err != nil { return err } - if err = models.AddReleaseAttachments(rel.ID, attachmentUUIDs); err != nil { - log.Error("AddReleaseAttachments: %v", err) + if err = models.AddReleaseAttachments(ctx, rel.ID, addAttachmentUUIDs); err != nil { + return fmt.Errorf("AddReleaseAttachments: %v", err) + } + + var deletedUUIDsMap = make(map[string]bool) + if len(delAttachmentUUIDs) > 0 { + // Check attachments + attachments, err := models.GetAttachmentsByUUIDs(ctx, delAttachmentUUIDs) + if err != nil { + return fmt.Errorf("GetAttachmentsByUUIDs [uuids: %v]: %v", delAttachmentUUIDs, err) + } + for _, attach := range attachments { + if attach.ReleaseID != rel.ID { + return errors.New("delete attachement of release permission denied") + } + deletedUUIDsMap[attach.UUID] = true + } + + if _, err := models.DeleteAttachments(ctx, attachments, false); err != nil { + return fmt.Errorf("DeleteAttachments [uuids: %v]: %v", delAttachmentUUIDs, err) + } + } + + if len(editAttachments) > 0 { + var updateAttachmentsList = make([]string, 0, len(editAttachments)) + for k := range editAttachments { + updateAttachmentsList = append(updateAttachmentsList, k) + } + // Check attachments + attachments, err := models.GetAttachmentsByUUIDs(ctx, updateAttachmentsList) + if err != nil { + return fmt.Errorf("GetAttachmentsByUUIDs [uuids: %v]: %v", updateAttachmentsList, err) + } + for _, attach := range attachments { + if attach.ReleaseID != rel.ID { + return errors.New("update attachement of release permission denied") + } + } + + for uuid, newName := range editAttachments { + if !deletedUUIDsMap[uuid] { + if err = models.UpdateAttachmentByUUID(ctx, &models.Attachment{ + UUID: uuid, + Name: newName, + }, "name"); err != nil { + return err + } + } + } + } + + if err = commiter.Commit(); err != nil { + return + } + + for _, uuid := range delAttachmentUUIDs { + if err := storage.Attachments.Delete(models.AttachmentRelativePath(uuid)); err != nil { + // Even delete files failed, but the attachments has been removed from database, so we + // should not return error but only record the error on logs. + // users have to delete this attachments manually or we should have a + // synchronize between database attachment table and attachment storage + log.Error("delete attachment[uuid: %s] failed: %v", uuid, err) + } } - if !isCreate { + if !isCreated { notification.NotifyUpdateRelease(doer, rel) return } diff --git a/services/release/release_test.go b/services/release/release_test.go index deb0618832..102e3d7e0c 100644 --- a/services/release/release_test.go +++ b/services/release/release_test.go @@ -6,6 +6,7 @@ package release import ( "path/filepath" + "strings" "testing" "time" @@ -90,7 +91,13 @@ func TestRelease_Create(t *testing.T) { IsTag: false, }, nil, "")) - assert.NoError(t, CreateRelease(gitRepo, &models.Release{ + attach, err := models.NewAttachment(&models.Attachment{ + UploaderID: user.ID, + Name: "test.txt", + }, []byte{}, strings.NewReader("testtest")) + assert.NoError(t, err) + + var release = models.Release{ RepoID: repo.ID, PublisherID: user.ID, TagName: "v0.1.5", @@ -100,7 +107,8 @@ func TestRelease_Create(t *testing.T) { IsDraft: false, IsPrerelease: false, IsTag: true, - }, nil, "test")) + } + assert.NoError(t, CreateRelease(gitRepo, &release, []string{attach.UUID}, "test")) } func TestRelease_Update(t *testing.T) { @@ -131,7 +139,7 @@ func TestRelease_Update(t *testing.T) { releaseCreatedUnix := release.CreatedUnix time.Sleep(2 * time.Second) // sleep 2 seconds to ensure a different timestamp release.Note = "Changed note" - assert.NoError(t, UpdateReleaseOrCreatReleaseFromTag(user, gitRepo, release, nil, false)) + assert.NoError(t, UpdateRelease(user, gitRepo, release, nil, nil, nil)) release, err = models.GetReleaseByID(release.ID) assert.NoError(t, err) assert.Equal(t, int64(releaseCreatedUnix), int64(release.CreatedUnix)) @@ -153,7 +161,7 @@ func TestRelease_Update(t *testing.T) { releaseCreatedUnix = release.CreatedUnix time.Sleep(2 * time.Second) // sleep 2 seconds to ensure a different timestamp release.Title = "Changed title" - assert.NoError(t, UpdateReleaseOrCreatReleaseFromTag(user, gitRepo, release, nil, false)) + assert.NoError(t, UpdateRelease(user, gitRepo, release, nil, nil, nil)) release, err = models.GetReleaseByID(release.ID) assert.NoError(t, err) assert.Less(t, int64(releaseCreatedUnix), int64(release.CreatedUnix)) @@ -176,10 +184,64 @@ func TestRelease_Update(t *testing.T) { time.Sleep(2 * time.Second) // sleep 2 seconds to ensure a different timestamp release.Title = "Changed title" release.Note = "Changed note" - assert.NoError(t, UpdateReleaseOrCreatReleaseFromTag(user, gitRepo, release, nil, false)) + assert.NoError(t, UpdateRelease(user, gitRepo, release, nil, nil, nil)) release, err = models.GetReleaseByID(release.ID) assert.NoError(t, err) assert.Equal(t, int64(releaseCreatedUnix), int64(release.CreatedUnix)) + + // Test create release + release = &models.Release{ + RepoID: repo.ID, + PublisherID: user.ID, + TagName: "v1.1.2", + Target: "master", + Title: "v1.1.2 is released", + Note: "v1.1.2 is released", + IsDraft: true, + IsPrerelease: false, + IsTag: false, + } + assert.NoError(t, CreateRelease(gitRepo, release, nil, "")) + assert.Greater(t, release.ID, int64(0)) + + release.IsDraft = false + tagName := release.TagName + + assert.NoError(t, UpdateRelease(user, gitRepo, release, nil, nil, nil)) + release, err = models.GetReleaseByID(release.ID) + assert.NoError(t, err) + assert.Equal(t, tagName, release.TagName) + + // Add new attachments + attach, err := models.NewAttachment(&models.Attachment{ + UploaderID: user.ID, + Name: "test.txt", + }, []byte{}, strings.NewReader("testtest")) + assert.NoError(t, err) + + assert.NoError(t, UpdateRelease(user, gitRepo, release, []string{attach.UUID}, nil, nil)) + assert.NoError(t, models.GetReleaseAttachments(release)) + assert.EqualValues(t, 1, len(release.Attachments)) + assert.EqualValues(t, attach.UUID, release.Attachments[0].UUID) + assert.EqualValues(t, release.ID, release.Attachments[0].ReleaseID) + assert.EqualValues(t, attach.Name, release.Attachments[0].Name) + + // update the attachment name + assert.NoError(t, UpdateRelease(user, gitRepo, release, nil, nil, map[string]string{ + attach.UUID: "test2.txt", + })) + release.Attachments = nil + assert.NoError(t, models.GetReleaseAttachments(release)) + assert.EqualValues(t, 1, len(release.Attachments)) + assert.EqualValues(t, attach.UUID, release.Attachments[0].UUID) + assert.EqualValues(t, release.ID, release.Attachments[0].ReleaseID) + assert.EqualValues(t, "test2.txt", release.Attachments[0].Name) + + // delete the attachment + assert.NoError(t, UpdateRelease(user, gitRepo, release, nil, []string{attach.UUID}, nil)) + release.Attachments = nil + assert.NoError(t, models.GetReleaseAttachments(release)) + assert.EqualValues(t, 0, len(release.Attachments)) } func TestRelease_createTag(t *testing.T) { @@ -205,12 +267,14 @@ func TestRelease_createTag(t *testing.T) { IsPrerelease: false, IsTag: false, } - assert.NoError(t, createTag(gitRepo, release, "")) + _, err = createTag(gitRepo, release, "") + assert.NoError(t, err) assert.NotEmpty(t, release.CreatedUnix) releaseCreatedUnix := release.CreatedUnix time.Sleep(2 * time.Second) // sleep 2 seconds to ensure a different timestamp release.Note = "Changed note" - assert.NoError(t, createTag(gitRepo, release, "")) + _, err = createTag(gitRepo, release, "") + assert.NoError(t, err) assert.Equal(t, int64(releaseCreatedUnix), int64(release.CreatedUnix)) // Test a changed draft @@ -225,11 +289,13 @@ func TestRelease_createTag(t *testing.T) { IsPrerelease: false, IsTag: false, } - assert.NoError(t, createTag(gitRepo, release, "")) + _, err = createTag(gitRepo, release, "") + assert.NoError(t, err) releaseCreatedUnix = release.CreatedUnix time.Sleep(2 * time.Second) // sleep 2 seconds to ensure a different timestamp release.Title = "Changed title" - assert.NoError(t, createTag(gitRepo, release, "")) + _, err = createTag(gitRepo, release, "") + assert.NoError(t, err) assert.Less(t, int64(releaseCreatedUnix), int64(release.CreatedUnix)) // Test a changed pre-release @@ -244,12 +310,14 @@ func TestRelease_createTag(t *testing.T) { IsPrerelease: true, IsTag: false, } - assert.NoError(t, createTag(gitRepo, release, "")) + _, err = createTag(gitRepo, release, "") + assert.NoError(t, err) releaseCreatedUnix = release.CreatedUnix time.Sleep(2 * time.Second) // sleep 2 seconds to ensure a different timestamp release.Title = "Changed title" release.Note = "Changed note" - assert.NoError(t, createTag(gitRepo, release, "")) + _, err = createTag(gitRepo, release, "") + assert.NoError(t, err) assert.Equal(t, int64(releaseCreatedUnix), int64(release.CreatedUnix)) } -- cgit v1.2.3