Add API Endpoint for Branch Creation #11607

tle-huu · 2020-05-24T16:59:28Z

This commit introduces an API endpoint for branch creation.
The added route is POST /repos/{owner}/{repo}/branches.

A JSON with the name of the new branch and the name of the "old" branch is required as parameters.

techknowlogick · 2020-05-24T17:01:28Z

Thanks for PR :) It looks like you have modified the vendors/modules.txt file, this is likely due to working with an older version of Go. Could you revert your changes from that specific file?

tle-huu · 2020-05-24T17:05:05Z

Thanks for PR :) It looks like you have modified the vendors/modules.txt file, this is likely due to working with an older version of Go. Could you revert your changes from that specific file?

Oh sorry, I amended

modules/structs/repo.go

routers/api/v1/repo/branch.go

modules/structs/repo.go

routers/api/v1/api.go

modules/structs/repo.go

routers/api/v1/repo/branch.go

6543 · 2020-05-28T13:57:19Z

since you dont use RepoRefByType you have to:

check if ctx.Repo.Repository.IsEmpty { first

and since repo_module.CreateNewBranch return no specific error if the OldBranch not exist,
at the moment it will cause a 500 errror
Either:

create a custom error and extend the function CreateNewBranch here:

gitea/modules/repository/branch.go

Lines 73 to 75 in 3aedc79

    
           if !git.IsBranchExist(repo.RepoPath(), oldBranchName) { 
        
           	return fmt.Errorf("OldBranch: %s does not exist. Cannot create new branch from this", oldBranchName) 
        
           }

a 404 responce is expected (has to be added to the swagger docs too)

Or:

check via !ctx.Repo.GitRepo.IsBranchExist(opt.OldBranchName) bevore this function is called
a 404 responce is expected (has to be added to the swagger docs too)

After this Only some Tests are missing :)

6543 · 2020-05-28T14:01:23Z

and a format question why do you created a second function (CreateRepoBranch) if you can just put the code into CreateBranch.

It would make sence if you like to re-use CreateRepoBranch but it is only used once

6543 · 2020-05-28T14:02:08Z

@tle-huu thanks for the pull, after the points above are resolved I think its good to go ;)

6543 · 2020-05-28T15:26:39Z

OK, one thing left Tests

tle-huu · 2020-05-28T16:43:55Z

OK, one thing left Tests

I have trouble running the tests locally, getting an internal error related to pushing / pre-receive hooks (when I run make test-pgsql):

CreateRepoBranch: PushRejected Error: exit status 1: remote: Gitea: Internal Server Error
        	remote: Unable to contact gitea: Post "http://localhost:3002/api/internal/hook/pre-receive/user2/repo1": dial tcp [::1]:3002: connect: connection refused

EDIT: Ok looks like it is not just locally..

6543 · 2020-05-28T18:37:43Z

the test itself looks good, so there is an issue with the CreateBranch implementation

tle-huu · 2020-05-28T20:05:03Z

Looks like it comes from an internal pre-receive hook (when I overwrite the hook in the gitea-repositories-meta repos it works), triggered because CreateNewBranch creates the new branch and then push it.

6543 · 2020-05-28T20:46:01Z

Zeripaths Idear of creating a temporary repo sound a good solution for this ...

integrations/api_branch_test.go

zeripath · 2020-05-28T22:49:57Z

modules/repository/branch.go

@@ -71,7 +71,9 @@ func CreateNewBranch(doer *models.User, repo *models.Repository, oldBranchName,
 	}

 	if !git.IsBranchExist(repo.RepoPath(), oldBranchName) {
-		return fmt.Errorf("OldBranch: %s does not exist. Cannot create new branch from this", oldBranchName)
+		return models.ErrBranchDoesNotExist{


Have you checked every call to CreateNewBranch and made sure they handle your new error correctly?

The other place where CreateNewBranch is used is in routers/repo/branch.go CreateBranch function and uses the ctx.Repo.BranchName as the "OldBranchName".

It does not "models.isErr" it but treats it as a ServerErr. Should we add a check there as well ? If so, should we do it in this PR or in another CL ?

integrations/api_branch_test.go

integrations/integration_test.go

integrations/api_branch_test.go

Issue: go-gitea#11376 This commit introduces an API endpoint for branch creation. The added route is POST /repos/{owner}/{repo}/branches. A JSON with the name of the new branch and the name of the old branch is required as parameters. Signed-off-by: Terence Le Huu Phuong <[email protected]>

- Made the CreateNewBranch function return an errBranchDoesNotExist error when the OldBranch does not exist - Made the CreateBranch API function checks that the repository is not empty and that branch exists.

fine-tune test env resetting - Added api test for CreateBranch - Used resetFixture instead of the more general prepareTestEnv in the repo_branch_test CreateBranch tests

…tion

tle-huu · 2020-05-29T11:02:35Z

Sorry, I accidentally "merged" master into this branch.

I rebased on master (but this is equivalent to 5df39561490e79cb3237d541cf906c09eab8cfed)

6543 · 2020-05-29T11:24:20Z

merging master int this (or hit the "update" button) is the normal way to let pulls be up-to-date
@tle-huu so dont worry

zeripath · 2020-05-29T18:15:37Z

make lg-tm work

6543 · 2020-05-29T18:49:15Z

https://gitea.com/gitea/go-sdk/issues/354

* [FEATURE] [API] Add Endpoint for Branch Creation Issue: go-gitea#11376 This commit introduces an API endpoint for branch creation. The added route is POST /repos/{owner}/{repo}/branches. A JSON with the name of the new branch and the name of the old branch is required as parameters. Signed-off-by: Terence Le Huu Phuong <[email protected]> * Put all the logic into CreateBranch and removed CreateRepoBranch * - Added the error ErrBranchDoesNotExist in error.go - Made the CreateNewBranch function return an errBranchDoesNotExist error when the OldBranch does not exist - Made the CreateBranch API function checks that the repository is not empty and that branch exists. * - Added a resetFixtures helper function in integration_test.go to fine-tune test env resetting - Added api test for CreateBranch - Used resetFixture instead of the more general prepareTestEnv in the repo_branch_test CreateBranch tests * Moved the resetFixtures call inside the loop for APICreateBranch function * Put the prepareTestEnv back in repo_branch_test * fix import order/sort api branch test Co-authored-by: zeripath <[email protected]>

techknowlogick added this to the 1.13.0 milestone May 24, 2020

techknowlogick added modifies/api This PR adds API routes or modifies them type/feature Completely new functionality. Can only be merged if feature freeze is not active. labels May 24, 2020

GiteaBot added the lgtm/need 2 This PR needs two approvals by maintainers to be considered for merging. label May 24, 2020

tle-huu force-pushed the terence/add_create_branch_to_api branch from e34cddc to 4aafa8b Compare May 24, 2020 17:03

zeripath reviewed May 25, 2020

View reviewed changes

modules/structs/repo.go Outdated Show resolved Hide resolved

zeripath reviewed May 25, 2020

View reviewed changes

modules/structs/repo.go Outdated Show resolved Hide resolved

zeripath reviewed May 25, 2020

View reviewed changes

routers/api/v1/repo/branch.go Show resolved Hide resolved

zeripath approved these changes May 25, 2020

View reviewed changes

GiteaBot added lgtm/need 1 This PR needs approval from one additional maintainer to be merged. and removed lgtm/need 2 This PR needs two approvals by maintainers to be considered for merging. labels May 25, 2020

zeripath changed the title ~~[FEATURE] [API] Add Endpoint for Branch Creation~~ Add API Endpoint for Branch Creation May 25, 2020

6543 reviewed May 27, 2020

View reviewed changes

modules/structs/repo.go Show resolved Hide resolved

6543 requested changes May 27, 2020

View reviewed changes

routers/api/v1/api.go Outdated Show resolved Hide resolved

modules/structs/repo.go Show resolved Hide resolved

routers/api/v1/repo/branch.go Show resolved Hide resolved

tle-huu force-pushed the terence/add_create_branch_to_api branch 2 times, most recently from 997c392 to f2978d9 Compare May 28, 2020 13:24

tle-huu force-pushed the terence/add_create_branch_to_api branch from 0d1bd15 to 2ce8212 Compare May 28, 2020 14:54

tle-huu force-pushed the terence/add_create_branch_to_api branch from ac34af1 to 7604857 Compare May 28, 2020 16:46

zeripath reviewed May 28, 2020

View reviewed changes

integrations/api_branch_test.go Outdated Show resolved Hide resolved

zeripath reviewed May 28, 2020

View reviewed changes

integrations/api_branch_test.go Show resolved Hide resolved

tle-huu force-pushed the terence/add_create_branch_to_api branch from 1e635de to 98245b4 Compare May 28, 2020 22:32

zeripath reviewed May 28, 2020

View reviewed changes

6543 reviewed May 28, 2020

View reviewed changes

integrations/api_branch_test.go Show resolved Hide resolved

6543 reviewed May 29, 2020

View reviewed changes

integrations/integration_test.go Show resolved Hide resolved

6543 reviewed May 29, 2020

View reviewed changes

integrations/api_branch_test.go Show resolved Hide resolved

6543 approved these changes May 29, 2020

View reviewed changes

GiteaBot added lgtm/done This PR has enough approvals to get merged. There are no important open reservations anymore. and removed lgtm/need 1 This PR needs approval from one additional maintainer to be merged. labels May 29, 2020

tle-huu added 7 commits May 29, 2020 13:00

Put all the logic into CreateBranch and removed CreateRepoBranch

19483e1

- Added the error ErrBranchDoesNotExist in error.go

fc682dc

- Made the CreateNewBranch function return an errBranchDoesNotExist error when the OldBranch does not exist - Made the CreateBranch API function checks that the repository is not empty and that branch exists.

- Added a resetFixtures helper function in integration_test.go to

32e3057

fine-tune test env resetting - Added api test for CreateBranch - Used resetFixture instead of the more general prepareTestEnv in the repo_branch_test CreateBranch tests

Moved the resetFixtures call inside the loop for APICreateBranch func…

f6100a1

…tion

Put the prepareTestEnv back in repo_branch_test

c87a2b4

fix import order/sort api branch test

9651305

tle-huu force-pushed the terence/add_create_branch_to_api branch from 3758d73 to 9651305 Compare May 29, 2020 11:00

Merge branch 'master' into terence/add_create_branch_to_api

d84f9ff

zeripath merged commit 141d52c into go-gitea:master May 29, 2020

lunny mentioned this pull request Jul 11, 2020

[Feature] [API] Add Endpoint for Branch creation #11376

Closed

go-gitea locked and limited conversation to collaborators Nov 24, 2020

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Add API Endpoint for Branch Creation #11607

Add API Endpoint for Branch Creation #11607

tle-huu commented May 24, 2020 •

edited

Loading

techknowlogick commented May 24, 2020

tle-huu commented May 24, 2020

6543 commented May 28, 2020

6543 commented May 28, 2020

6543 commented May 28, 2020

6543 commented May 28, 2020

tle-huu commented May 28, 2020 •

edited

Loading

6543 commented May 28, 2020 •

edited

Loading

tle-huu commented May 28, 2020

6543 commented May 28, 2020

zeripath May 28, 2020

tle-huu May 28, 2020 •

edited

Loading

tle-huu commented May 29, 2020

6543 commented May 29, 2020

zeripath commented May 29, 2020

6543 commented May 29, 2020

Add API Endpoint for Branch Creation #11607

Add API Endpoint for Branch Creation #11607

Conversation

tle-huu commented May 24, 2020 • edited Loading

techknowlogick commented May 24, 2020

tle-huu commented May 24, 2020

6543 commented May 28, 2020

6543 commented May 28, 2020

6543 commented May 28, 2020

6543 commented May 28, 2020

tle-huu commented May 28, 2020 • edited Loading

6543 commented May 28, 2020 • edited Loading

tle-huu commented May 28, 2020

6543 commented May 28, 2020

zeripath May 28, 2020

Choose a reason for hiding this comment

tle-huu May 28, 2020 • edited Loading

Choose a reason for hiding this comment

tle-huu commented May 29, 2020

6543 commented May 29, 2020

zeripath commented May 29, 2020

6543 commented May 29, 2020

tle-huu commented May 24, 2020 •

edited

Loading

tle-huu commented May 28, 2020 •

edited

Loading

6543 commented May 28, 2020 •

edited

Loading

tle-huu May 28, 2020 •

edited

Loading