add context to tag commands

Author: TheFox0x7

modules/git/repo_tag.go

@@ -23,24 +23,24 @@ func IsTagExist(ctx context.Context, repoPath, name string) bool {
 }
 
 // CreateTag create one tag in the repository
-func (repo *Repository) CreateTag(name, revision string) error {
-	_, _, err := NewCommand("tag").AddDashesAndList(name, revision).RunStdString(repo.Ctx, &RunOpts{Dir: repo.Path})
+func (repo *Repository) CreateTag(ctx context.Context, name, revision string) error {
+	_, _, err := NewCommand("tag").AddDashesAndList(name, revision).RunStdString(ctx, &RunOpts{Dir: repo.Path})
 	return err
 }
 
 // CreateAnnotatedTag create one annotated tag in the repository
-func (repo *Repository) CreateAnnotatedTag(name, message, revision string) error {
-	_, _, err := NewCommand("tag", "-a", "-m").AddDynamicArguments(message).AddDashesAndList(name, revision).RunStdString(repo.Ctx, &RunOpts{Dir: repo.Path})
+func (repo *Repository) CreateAnnotatedTag(ctx context.Context, name, message, revision string) error {
+	_, _, err := NewCommand("tag", "-a", "-m").AddDynamicArguments(message).AddDashesAndList(name, revision).RunStdString(ctx, &RunOpts{Dir: repo.Path})
 	return err
 }
 
 // GetTagNameBySHA returns the name of a tag from its tag object SHA or commit SHA
-func (repo *Repository) GetTagNameBySHA(sha string) (string, error) {
+func (repo *Repository) GetTagNameBySHA(ctx context.Context, sha string) (string, error) {
 	if len(sha) < 5 {
 		return "", fmt.Errorf("SHA is too short: %s", sha)
 	}
 
-	stdout, _, err := NewCommand("show-ref", "--tags", "-d").RunStdString(repo.Ctx, &RunOpts{Dir: repo.Path})
+	stdout, _, err := NewCommand("show-ref", "--tags", "-d").RunStdString(ctx, &RunOpts{Dir: repo.Path})
 	if err != nil {
 		return "", err
 	}
@@ -62,8 +62,8 @@ func (repo *Repository) GetTagNameBySHA(sha string) (string, error) {
 }
 
 // GetTagID returns the object ID for a tag (annotated tags have both an object SHA AND a commit SHA)
-func (repo *Repository) GetTagID(name string) (string, error) {
-	stdout, _, err := NewCommand("show-ref", "--tags").AddDashesAndList(name).RunStdString(repo.Ctx, &RunOpts{Dir: repo.Path})
+func (repo *Repository) GetTagID(ctx context.Context, name string) (string, error) {
+	stdout, _, err := NewCommand("show-ref", "--tags").AddDashesAndList(name).RunStdString(ctx, &RunOpts{Dir: repo.Path})
 	if err != nil {
 		return "", err
 	}
@@ -78,8 +78,8 @@ func (repo *Repository) GetTagID(name string) (string, error) {
 }
 
 // GetTag returns a Git tag by given name.
-func (repo *Repository) GetTag(name string) (*Tag, error) {
-	idStr, err := repo.GetTagID(name)
+func (repo *Repository) GetTag(ctx context.Context, name string) (*Tag, error) {
+	idStr, err := repo.GetTagID(ctx, name)
 	if err != nil {
 		return nil, err
 	}
@@ -111,7 +111,7 @@ func (repo *Repository) GetTagWithID(idStr, name string) (*Tag, error) {
 }
 
 // GetTagInfos returns all tag infos of the repository.
-func (repo *Repository) GetTagInfos(page, pageSize int) ([]*Tag, int, error) {
+func (repo *Repository) GetTagInfos(ctx context.Context, page, pageSize int) ([]*Tag, int, error) {
 	// Generally, refname:short should be equal to refname:lstrip=2 except core.warnAmbiguousRefs is used to select the strict abbreviation mode.
 	// https://git-scm.com/docs/git-for-each-ref#Documentation/git-for-each-ref.txt-refname
 	forEachRefFmt := foreachref.NewFormat("objecttype", "refname:lstrip=2", "object", "objectname", "creator", "contents", "contents:signature")
@@ -125,7 +125,7 @@ func (repo *Repository) GetTagInfos(page, pageSize int) ([]*Tag, int, error) {
 	go func() {
 		err := NewCommand("for-each-ref").
 			AddOptionFormat("--format=%s", forEachRefFmt.Flag()).
-			AddArguments("--sort", "-*creatordate", "refs/tags").Run(repo.Ctx, rc)
+			AddArguments("--sort", "-*creatordate", "refs/tags").Run(ctx, rc)
 		if err != nil {
 			_ = stdoutWriter.CloseWithError(ConcatenateError(err, stderr.String()))
 		} else {
@@ -203,7 +203,7 @@ func parseTagRef(ref map[string]string) (tag *Tag, err error) {
 }
 
 // GetAnnotatedTag returns a Git tag by its SHA, must be an annotated tag
-func (repo *Repository) GetAnnotatedTag(sha string) (*Tag, error) {
+func (repo *Repository) GetAnnotatedTag(ctx context.Context, sha string) (*Tag, error) {
 	id, err := NewIDFromString(sha)
 	if err != nil {
 		return nil, err
@@ -218,7 +218,7 @@ func (repo *Repository) GetAnnotatedTag(sha string) (*Tag, error) {
 	}
 
 	// Get tag name
-	name, err := repo.GetTagNameBySHA(id.String())
+	name, err := repo.GetTagNameBySHA(ctx, id.String())
 	if err != nil {
 		return nil, err
 	}

modules/git/repo_tag_test.go

@@ -20,7 +20,7 @@ func TestRepository_GetTags(t *testing.T) {
 	}
 	defer bareRepo1.Close()
 
-	tags, total, err := bareRepo1.GetTagInfos(0, 0)
+	tags, total, err := bareRepo1.GetTagInfos(t.Context(), 0, 0)
 	if err != nil {
 		assert.NoError(t, err)
 		return
@@ -56,14 +56,14 @@ func TestRepository_GetTag(t *testing.T) {
 	lTagName := "lightweightTag"
 
 	// Create the lightweight tag
-	err = bareRepo1.CreateTag(lTagName, lTagCommitID)
+	err = bareRepo1.CreateTag(t.Context(), lTagName, lTagCommitID)
 	if err != nil {
 		assert.NoError(t, err, "Unable to create the lightweight tag: %s for ID: %s. Error: %v", lTagName, lTagCommitID, err)
 		return
 	}
 
 	// and try to get the Tag for lightweight tag
-	lTag, err := bareRepo1.GetTag(lTagName)
+	lTag, err := bareRepo1.GetTag(t.Context(), lTagName)
 	if err != nil {
 		assert.NoError(t, err)
 		return
@@ -83,20 +83,20 @@ func TestRepository_GetTag(t *testing.T) {
 	aTagMessage := "my annotated message \n - test two line"
 
 	// Create the annotated tag
-	err = bareRepo1.CreateAnnotatedTag(aTagName, aTagMessage, aTagCommitID)
+	err = bareRepo1.CreateAnnotatedTag(t.Context(), aTagName, aTagMessage, aTagCommitID)
 	if err != nil {
 		assert.NoError(t, err, "Unable to create the annotated tag: %s for ID: %s. Error: %v", aTagName, aTagCommitID, err)
 		return
 	}
 
 	// Now try to get the tag for the annotated Tag
-	aTagID, err := bareRepo1.GetTagID(aTagName)
+	aTagID, err := bareRepo1.GetTagID(t.Context(), aTagName)
 	if err != nil {
 		assert.NoError(t, err)
 		return
 	}
 
-	aTag, err := bareRepo1.GetTag(aTagName)
+	aTag, err := bareRepo1.GetTag(t.Context(), aTagName)
 	if err != nil {
 		assert.NoError(t, err)
 		return
@@ -116,20 +116,20 @@ func TestRepository_GetTag(t *testing.T) {
 	rTagCommitID := "8006ff9adbf0cb94da7dad9e537e53817f9fa5c0"
 	rTagName := "release/" + lTagName
 
-	err = bareRepo1.CreateTag(rTagName, rTagCommitID)
+	err = bareRepo1.CreateTag(t.Context(), rTagName, rTagCommitID)
 	if err != nil {
 		assert.NoError(t, err, "Unable to create the  tag: %s for ID: %s. Error: %v", rTagName, rTagCommitID, err)
 		return
 	}
 
-	rTagID, err := bareRepo1.GetTagID(rTagName)
+	rTagID, err := bareRepo1.GetTagID(t.Context(), rTagName)
 	if err != nil {
 		assert.NoError(t, err)
 		return
 	}
 	assert.EqualValues(t, rTagCommitID, rTagID)
 
-	oTagID, err := bareRepo1.GetTagID(lTagName)
+	oTagID, err := bareRepo1.GetTagID(t.Context(), lTagName)
 	if err != nil {
 		assert.NoError(t, err)
 		return
@@ -155,16 +155,16 @@ func TestRepository_GetAnnotatedTag(t *testing.T) {
 
 	lTagCommitID := "6fbd69e9823458e6c4a2fc5c0f6bc022b2f2acd1"
 	lTagName := "lightweightTag"
-	bareRepo1.CreateTag(lTagName, lTagCommitID)
+	bareRepo1.CreateTag(t.Context(), lTagName, lTagCommitID)
 
 	aTagCommitID := "8006ff9adbf0cb94da7dad9e537e53817f9fa5c0"
 	aTagName := "annotatedTag"
 	aTagMessage := "my annotated message"
-	bareRepo1.CreateAnnotatedTag(aTagName, aTagMessage, aTagCommitID)
-	aTagID, _ := bareRepo1.GetTagID(aTagName)
+	bareRepo1.CreateAnnotatedTag(t.Context(), aTagName, aTagMessage, aTagCommitID)
+	aTagID, _ := bareRepo1.GetTagID(t.Context(), aTagName)
 
 	// Try an annotated tag
-	tag, err := bareRepo1.GetAnnotatedTag(aTagID)
+	tag, err := bareRepo1.GetAnnotatedTag(t.Context(), aTagID)
 	if err != nil {
 		assert.NoError(t, err)
 		return
@@ -175,18 +175,18 @@ func TestRepository_GetAnnotatedTag(t *testing.T) {
 	assert.EqualValues(t, "tag", tag.Type)
 
 	// Annotated tag's Commit ID should fail
-	tag2, err := bareRepo1.GetAnnotatedTag(aTagCommitID)
+	tag2, err := bareRepo1.GetAnnotatedTag(t.Context(), aTagCommitID)
 	assert.Error(t, err)
 	assert.True(t, IsErrNotExist(err))
 	assert.Nil(t, tag2)
 
 	// Annotated tag's name should fail
-	tag3, err := bareRepo1.GetAnnotatedTag(aTagName)
+	tag3, err := bareRepo1.GetAnnotatedTag(t.Context(), aTagName)
 	assert.Errorf(t, err, "Length must be 40: %d", len(aTagName))
 	assert.Nil(t, tag3)
 
 	// Lightweight Tag should fail
-	tag4, err := bareRepo1.GetAnnotatedTag(lTagCommitID)
+	tag4, err := bareRepo1.GetAnnotatedTag(t.Context(), lTagCommitID)
 	assert.Error(t, err)
 	assert.True(t, IsErrNotExist(err))
 	assert.Nil(t, tag4)

modules/repository/repo.go

@@ -294,7 +294,7 @@ func (shortRelease) TableName() string {
 // repositories like https://github.com/vim/vim (with over 13000 tags).
 func pullMirrorReleaseSync(ctx context.Context, repo *repo_model.Repository, gitRepo *git.Repository) error {
 	log.Trace("pullMirrorReleaseSync: rebuilding releases for pull-mirror Repo[%d:%s/%s]", repo.ID, repo.OwnerName, repo.Name)
-	tags, numTags, err := gitRepo.GetTagInfos(0, 0)
+	tags, numTags, err := gitRepo.GetTagInfos(ctx, 0, 0)
 	if err != nil {
 		return fmt.Errorf("unable to GetTagInfos in pull-mirror Repo[%d:%s/%s]: %w", repo.ID, repo.OwnerName, repo.Name, err)
 	}

routers/api/v1/repo/tag.go

@@ -55,7 +55,7 @@ func ListTags(ctx *context.APIContext) {
 
 	listOpts := utils.GetListOptions(ctx)
 
-	tags, total, err := ctx.Repo.GitRepo.GetTagInfos(listOpts.Page, listOpts.PageSize)
+	tags, total, err := ctx.Repo.GitRepo.GetTagInfos(ctx, listOpts.Page, listOpts.PageSize)
 	if err != nil {
 		ctx.APIErrorInternal(err)
 		return
@@ -107,7 +107,7 @@ func GetAnnotatedTag(ctx *context.APIContext) {
 		return
 	}
 
-	if tag, err := ctx.Repo.GitRepo.GetAnnotatedTag(sha); err != nil {
+	if tag, err := ctx.Repo.GitRepo.GetAnnotatedTag(ctx, sha); err != nil {
 		ctx.APIError(http.StatusBadRequest, err)
 	} else {
 		commit, err := tag.Commit(ctx.Repo.GitRepo)
@@ -148,7 +148,7 @@ func GetTag(ctx *context.APIContext) {
 	//     "$ref": "#/responses/notFound"
 	tagName := ctx.PathParam("*")
 
-	tag, err := ctx.Repo.GitRepo.GetTag(tagName)
+	tag, err := ctx.Repo.GitRepo.GetTag(ctx, tagName)
 	if err != nil {
 		ctx.APIErrorNotFound(tagName)
 		return
@@ -218,7 +218,7 @@ func CreateTag(ctx *context.APIContext) {
 		return
 	}
 
-	tag, err := ctx.Repo.GitRepo.GetTag(form.TagName)
+	tag, err := ctx.Repo.GitRepo.GetTag(ctx, form.TagName)
 	if err != nil {
 		ctx.APIErrorInternal(err)
 		return

services/release/release.go

@@ -106,15 +106,15 @@ func createTag(ctx context.Context, gitRepo *git.Repository, rel *repo_model.Rel
 			}
 
 			if len(msg) > 0 {
-				if err = gitRepo.CreateAnnotatedTag(rel.TagName, msg, commit.ID.String()); err != nil {
+				if err = gitRepo.CreateAnnotatedTag(ctx, rel.TagName, msg, commit.ID.String()); err != nil {
 					if strings.Contains(err.Error(), "is not a valid tag name") {
 						return false, ErrInvalidTagName{
 							TagName: rel.TagName,
 						}
 					}
 					return false, err
 				}
-			} else if err = gitRepo.CreateTag(rel.TagName, commit.ID.String()); err != nil {
+			} else if err = gitRepo.CreateTag(ctx, rel.TagName, commit.ID.String()); err != nil {
 				if strings.Contains(err.Error(), "is not a valid tag name") {
 					return false, ErrInvalidTagName{
 						TagName: rel.TagName,

services/repository/push.go

@@ -356,7 +356,7 @@ func pushUpdateAddTags(ctx context.Context, repo *repo_model.Repository, gitRepo
 	emailToUser := make(map[string]*user_model.User)
 
 	for i, lowerTag := range lowerTags {
-		tag, err := gitRepo.GetTag(tags[i])
+		tag, err := gitRepo.GetTag(ctx, tags[i])
 		if err != nil {
 			return fmt.Errorf("GetTag: %w", err)
 		}

tests/integration/api_releases_test.go

@@ -114,7 +114,7 @@ func TestAPICreateAndUpdateRelease(t *testing.T) {
 	assert.NoError(t, err)
 	defer gitRepo.Close()
 
-	err = gitRepo.CreateTag("v0.0.1", "master")
+	err = gitRepo.CreateTag(t.Context(), "v0.0.1", "master")
 	assert.NoError(t, err)
 
 	target, err := gitRepo.GetTagCommitID("v0.0.1")
@@ -202,7 +202,7 @@ func TestAPICreateReleaseToDefaultBranchOnExistingTag(t *testing.T) {
 	assert.NoError(t, err)
 	defer gitRepo.Close()
 
-	err = gitRepo.CreateTag("v0.0.1", "master")
+	err = gitRepo.CreateTag(t.Context(), "v0.0.1", "master")
 	assert.NoError(t, err)
 
 	createNewReleaseUsingAPI(t, token, owner, repo, "v0.0.1", "", "v0.0.1", "test")

tests/integration/api_repo_get_contents_list_test.go

@@ -84,7 +84,7 @@ func testAPIGetContentsList(t *testing.T, u *url.URL) {
 	commitID, _ := gitRepo.GetBranchCommitID(repo1.DefaultBranch)
 	// Make a new tag in repo1
 	newTag := "test_tag"
-	err = gitRepo.CreateTag(newTag, commitID)
+	err = gitRepo.CreateTag(t.Context(), newTag, commitID)
 	assert.NoError(t, err)
 	/*** END SETUP ***/
 

tests/integration/api_repo_get_contents_test.go

@@ -88,7 +88,7 @@ func testAPIGetContents(t *testing.T, u *url.URL) {
 	assert.NoError(t, err)
 	// Make a new tag in repo1
 	newTag := "test_tag"
-	err = gitRepo.CreateTag(newTag, commitID)
+	err = gitRepo.CreateTag(t.Context(), newTag, commitID)
 	assert.NoError(t, err)
 	/*** END SETUP ***/
 

tests/integration/api_repo_git_tags_test.go

@@ -38,12 +38,12 @@ func TestAPIGitTags(t *testing.T) {
 
 	commit, _ := gitRepo.GetBranchCommit("master")
 	lTagName := "lightweightTag"
-	gitRepo.CreateTag(lTagName, commit.ID.String())
+	gitRepo.CreateTag(t.Context(), lTagName, commit.ID.String())
 
 	aTagName := "annotatedTag"
 	aTagMessage := "my annotated message"
-	gitRepo.CreateAnnotatedTag(aTagName, aTagMessage, commit.ID.String())
-	aTag, _ := gitRepo.GetTag(aTagName)
+	gitRepo.CreateAnnotatedTag(t.Context(), aTagName, aTagMessage, commit.ID.String())
+	aTag, _ := gitRepo.GetTag(t.Context(), aTagName)
 
 	// SHOULD work for annotated tags
 	req := NewRequestf(t, "GET", "/api/v1/repos/%s/%s/git/tags/%s", user.Name, repo.Name, aTag.ID.String()).