2019-04-17 19:06:35 +03:00
// 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 integrations
import (
"encoding/base64"
"fmt"
"net/http"
2019-05-11 18:29:17 +03:00
"net/url"
2019-04-17 19:06:35 +03:00
"path/filepath"
"testing"
"code.gitea.io/gitea/models"
"code.gitea.io/gitea/modules/context"
"code.gitea.io/gitea/modules/git"
"code.gitea.io/gitea/modules/setting"
2019-05-11 13:21:34 +03:00
api "code.gitea.io/gitea/modules/structs"
2019-04-17 19:06:35 +03:00
"github.com/stretchr/testify/assert"
)
func getUpdateFileOptions ( ) * api . UpdateFileOptions {
content := "This is updated text"
contentEncoded := base64 . StdEncoding . EncodeToString ( [ ] byte ( content ) )
return & api . UpdateFileOptions {
2019-06-29 18:19:24 +03:00
DeleteFileOptions : api . DeleteFileOptions {
FileOptions : api . FileOptions {
BranchName : "master" ,
NewBranchName : "master" ,
Message : "My update of new/file.txt" ,
Author : api . Identity {
Name : "John Doe" ,
Email : "johndoe@example.com" ,
} ,
Committer : api . Identity {
2019-12-09 16:11:24 +03:00
Name : "Anne Doe" ,
Email : "annedoe@example.com" ,
2019-06-29 18:19:24 +03:00
} ,
} ,
SHA : "103ff9234cefeee5ec5361d22b49fbb04d385885" ,
} ,
Content : contentEncoded ,
2019-04-17 19:06:35 +03:00
}
}
func getExpectedFileResponseForUpdate ( commitID , treePath string ) * api . FileResponse {
sha := "08bd14b2e2852529157324de9c226b3364e76136"
2019-06-29 23:51:10 +03:00
encoding := "base64"
content := "VGhpcyBpcyB1cGRhdGVkIHRleHQ="
selfURL := setting . AppURL + "api/v1/repos/user2/repo1/contents/" + treePath + "?ref=master"
htmlURL := setting . AppURL + "user2/repo1/src/branch/master/" + treePath
gitURL := setting . AppURL + "api/v1/repos/user2/repo1/git/blobs/" + sha
downloadURL := setting . AppURL + "user2/repo1/raw/branch/master/" + treePath
2019-04-17 19:06:35 +03:00
return & api . FileResponse {
2019-06-29 23:51:10 +03:00
Content : & api . ContentsResponse {
2019-04-17 19:06:35 +03:00
Name : filepath . Base ( treePath ) ,
Path : treePath ,
SHA : sha ,
2019-06-29 23:51:10 +03:00
Type : "file" ,
2019-04-17 19:06:35 +03:00
Size : 20 ,
2019-06-29 23:51:10 +03:00
Encoding : & encoding ,
Content : & content ,
URL : & selfURL ,
HTMLURL : & htmlURL ,
GitURL : & gitURL ,
DownloadURL : & downloadURL ,
2019-04-17 19:06:35 +03:00
Links : & api . FileLinksResponse {
2019-06-29 23:51:10 +03:00
Self : & selfURL ,
GitURL : & gitURL ,
HTMLURL : & htmlURL ,
2019-04-17 19:06:35 +03:00
} ,
} ,
Commit : & api . FileCommitResponse {
CommitMeta : api . CommitMeta {
URL : setting . AppURL + "api/v1/repos/user2/repo1/git/commits/" + commitID ,
SHA : commitID ,
} ,
HTMLURL : setting . AppURL + "user2/repo1/commit/" + commitID ,
Author : & api . CommitUser {
Identity : api . Identity {
2019-12-09 16:11:24 +03:00
Name : "John Doe" ,
Email : "johndoe@example.com" ,
2019-04-17 19:06:35 +03:00
} ,
} ,
Committer : & api . CommitUser {
Identity : api . Identity {
2019-12-09 16:11:24 +03:00
Name : "Anne Doe" ,
Email : "annedoe@example.com" ,
2019-04-17 19:06:35 +03:00
} ,
} ,
2019-06-29 18:19:24 +03:00
Message : "My update of README.md\n" ,
2019-04-17 19:06:35 +03:00
} ,
Verification : & api . PayloadCommitVerification {
Verified : false ,
2019-10-16 16:42:42 +03:00
Reason : "gpg.error.not_signed_commit" ,
2019-04-17 19:06:35 +03:00
Signature : "" ,
Payload : "" ,
} ,
}
}
func TestAPIUpdateFile ( t * testing . T ) {
2019-05-11 18:29:17 +03:00
onGiteaRun ( t , func ( t * testing . T , u * url . URL ) {
user2 := models . AssertExistsAndLoadBean ( t , & models . User { ID : 2 } ) . ( * models . User ) // owner of the repo1 & repo16
user3 := models . AssertExistsAndLoadBean ( t , & models . User { ID : 3 } ) . ( * models . User ) // owner of the repo3, is an org
user4 := models . AssertExistsAndLoadBean ( t , & models . User { ID : 4 } ) . ( * models . User ) // owner of neither repos
repo1 := models . AssertExistsAndLoadBean ( t , & models . Repository { ID : 1 } ) . ( * models . Repository ) // public repo
repo3 := models . AssertExistsAndLoadBean ( t , & models . Repository { ID : 3 } ) . ( * models . Repository ) // public repo
repo16 := models . AssertExistsAndLoadBean ( t , & models . Repository { ID : 16 } ) . ( * models . Repository ) // private repo
fileID := 0
// Get user2's token
session := loginUser ( t , user2 . Name )
token2 := getTokenForLoggedInUser ( t , session )
session = emptyTestSession ( t )
// Get user4's token
session = loginUser ( t , user4 . Name )
token4 := getTokenForLoggedInUser ( t , session )
session = emptyTestSession ( t )
// Test updating a file in repo1 which user2 owns, try both with branch and empty branch
for _ , branch := range [ ... ] string {
"master" , // Branch
"" , // Empty branch
} {
fileID ++
treePath := fmt . Sprintf ( "update/file%d.txt" , fileID )
createFile ( user2 , repo1 , treePath )
updateFileOptions := getUpdateFileOptions ( )
updateFileOptions . BranchName = branch
url := fmt . Sprintf ( "/api/v1/repos/%s/%s/contents/%s?token=%s" , user2 . Name , repo1 . Name , treePath , token2 )
req := NewRequestWithJSON ( t , "PUT" , url , & updateFileOptions )
resp := session . MakeRequest ( t , req , http . StatusOK )
gitRepo , _ := git . OpenRepository ( repo1 . RepoPath ( ) )
commitID , _ := gitRepo . GetBranchCommitID ( updateFileOptions . NewBranchName )
expectedFileResponse := getExpectedFileResponseForUpdate ( commitID , treePath )
var fileResponse api . FileResponse
DecodeJSON ( t , resp , & fileResponse )
assert . EqualValues ( t , expectedFileResponse . Content , fileResponse . Content )
assert . EqualValues ( t , expectedFileResponse . Commit . SHA , fileResponse . Commit . SHA )
assert . EqualValues ( t , expectedFileResponse . Commit . HTMLURL , fileResponse . Commit . HTMLURL )
assert . EqualValues ( t , expectedFileResponse . Commit . Author . Email , fileResponse . Commit . Author . Email )
assert . EqualValues ( t , expectedFileResponse . Commit . Author . Name , fileResponse . Commit . Author . Name )
2019-11-13 10:01:19 +03:00
gitRepo . Close ( )
2019-05-11 18:29:17 +03:00
}
// Test updating a file in a new branch
updateFileOptions := getUpdateFileOptions ( )
updateFileOptions . BranchName = repo1 . DefaultBranch
updateFileOptions . NewBranchName = "new_branch"
2019-04-17 19:06:35 +03:00
fileID ++
treePath := fmt . Sprintf ( "update/file%d.txt" , fileID )
createFile ( user2 , repo1 , treePath )
url := fmt . Sprintf ( "/api/v1/repos/%s/%s/contents/%s?token=%s" , user2 . Name , repo1 . Name , treePath , token2 )
req := NewRequestWithJSON ( t , "PUT" , url , & updateFileOptions )
resp := session . MakeRequest ( t , req , http . StatusOK )
var fileResponse api . FileResponse
DecodeJSON ( t , resp , & fileResponse )
2019-05-11 18:29:17 +03:00
expectedSHA := "08bd14b2e2852529157324de9c226b3364e76136"
2019-06-29 23:51:10 +03:00
expectedHTMLURL := fmt . Sprintf ( setting . AppURL + "user2/repo1/src/branch/new_branch/update/file%d.txt" , fileID )
2019-06-08 17:31:11 +03:00
expectedDownloadURL := fmt . Sprintf ( setting . AppURL + "user2/repo1/raw/branch/new_branch/update/file%d.txt" , fileID )
2019-05-11 18:29:17 +03:00
assert . EqualValues ( t , expectedSHA , fileResponse . Content . SHA )
2019-06-29 23:51:10 +03:00
assert . EqualValues ( t , expectedHTMLURL , * fileResponse . Content . HTMLURL )
assert . EqualValues ( t , expectedDownloadURL , * fileResponse . Content . DownloadURL )
2019-06-29 18:19:24 +03:00
assert . EqualValues ( t , updateFileOptions . Message + "\n" , fileResponse . Commit . Message )
2019-05-11 18:29:17 +03:00
// Test updating a file and renaming it
updateFileOptions = getUpdateFileOptions ( )
updateFileOptions . BranchName = repo1 . DefaultBranch
fileID ++
treePath = fmt . Sprintf ( "update/file%d.txt" , fileID )
createFile ( user2 , repo1 , treePath )
updateFileOptions . FromPath = treePath
treePath = "rename/" + treePath
url = fmt . Sprintf ( "/api/v1/repos/%s/%s/contents/%s?token=%s" , user2 . Name , repo1 . Name , treePath , token2 )
req = NewRequestWithJSON ( t , "PUT" , url , & updateFileOptions )
resp = session . MakeRequest ( t , req , http . StatusOK )
DecodeJSON ( t , resp , & fileResponse )
expectedSHA = "08bd14b2e2852529157324de9c226b3364e76136"
2019-06-29 23:51:10 +03:00
expectedHTMLURL = fmt . Sprintf ( setting . AppURL + "user2/repo1/src/branch/master/rename/update/file%d.txt" , fileID )
2019-06-08 17:31:11 +03:00
expectedDownloadURL = fmt . Sprintf ( setting . AppURL + "user2/repo1/raw/branch/master/rename/update/file%d.txt" , fileID )
2019-05-11 18:29:17 +03:00
assert . EqualValues ( t , expectedSHA , fileResponse . Content . SHA )
2019-06-29 23:51:10 +03:00
assert . EqualValues ( t , expectedHTMLURL , * fileResponse . Content . HTMLURL )
assert . EqualValues ( t , expectedDownloadURL , * fileResponse . Content . DownloadURL )
2019-05-11 18:29:17 +03:00
2019-06-29 18:19:24 +03:00
// Test updating a file without a message
updateFileOptions = getUpdateFileOptions ( )
updateFileOptions . Message = ""
updateFileOptions . BranchName = repo1 . DefaultBranch
fileID ++
treePath = fmt . Sprintf ( "update/file%d.txt" , fileID )
createFile ( user2 , repo1 , treePath )
url = fmt . Sprintf ( "/api/v1/repos/%s/%s/contents/%s?token=%s" , user2 . Name , repo1 . Name , treePath , token2 )
req = NewRequestWithJSON ( t , "PUT" , url , & updateFileOptions )
resp = session . MakeRequest ( t , req , http . StatusOK )
DecodeJSON ( t , resp , & fileResponse )
expectedMessage := "Update '" + treePath + "'\n"
assert . EqualValues ( t , expectedMessage , fileResponse . Commit . Message )
2019-05-11 18:29:17 +03:00
// Test updating a file with the wrong SHA
fileID ++
treePath = fmt . Sprintf ( "update/file%d.txt" , fileID )
createFile ( user2 , repo1 , treePath )
updateFileOptions = getUpdateFileOptions ( )
correctSHA := updateFileOptions . SHA
updateFileOptions . SHA = "badsha"
url = fmt . Sprintf ( "/api/v1/repos/%s/%s/contents/%s?token=%s" , user2 . Name , repo1 . Name , treePath , token2 )
req = NewRequestWithJSON ( t , "PUT" , url , & updateFileOptions )
2020-05-31 23:59:34 +03:00
resp = session . MakeRequest ( t , req , http . StatusUnprocessableEntity )
2019-05-11 18:29:17 +03:00
expectedAPIError := context . APIError {
Message : "sha does not match [given: " + updateFileOptions . SHA + ", expected: " + correctSHA + "]" ,
2019-06-13 00:07:24 +03:00
URL : setting . API . SwaggerURL ,
2019-05-11 18:29:17 +03:00
}
var apiError context . APIError
DecodeJSON ( t , resp , & apiError )
assert . Equal ( t , expectedAPIError , apiError )
// Test creating a file in repo1 by user4 who does not have write access
fileID ++
treePath = fmt . Sprintf ( "update/file%d.txt" , fileID )
createFile ( user2 , repo16 , treePath )
updateFileOptions = getUpdateFileOptions ( )
url = fmt . Sprintf ( "/api/v1/repos/%s/%s/contents/%s?token=%s" , user2 . Name , repo16 . Name , treePath , token4 )
req = NewRequestWithJSON ( t , "PUT" , url , & updateFileOptions )
session . MakeRequest ( t , req , http . StatusNotFound )
// Tests a repo with no token given so will fail
fileID ++
treePath = fmt . Sprintf ( "update/file%d.txt" , fileID )
createFile ( user2 , repo16 , treePath )
updateFileOptions = getUpdateFileOptions ( )
url = fmt . Sprintf ( "/api/v1/repos/%s/%s/contents/%s" , user2 . Name , repo16 . Name , treePath )
req = NewRequestWithJSON ( t , "PUT" , url , & updateFileOptions )
session . MakeRequest ( t , req , http . StatusNotFound )
// Test using access token for a private repo that the user of the token owns
fileID ++
treePath = fmt . Sprintf ( "update/file%d.txt" , fileID )
createFile ( user2 , repo16 , treePath )
updateFileOptions = getUpdateFileOptions ( )
url = fmt . Sprintf ( "/api/v1/repos/%s/%s/contents/%s?token=%s" , user2 . Name , repo16 . Name , treePath , token2 )
req = NewRequestWithJSON ( t , "PUT" , url , & updateFileOptions )
session . MakeRequest ( t , req , http . StatusOK )
// Test using org repo "user3/repo3" where user2 is a collaborator
fileID ++
treePath = fmt . Sprintf ( "update/file%d.txt" , fileID )
createFile ( user3 , repo3 , treePath )
updateFileOptions = getUpdateFileOptions ( )
url = fmt . Sprintf ( "/api/v1/repos/%s/%s/contents/%s?token=%s" , user3 . Name , repo3 . Name , treePath , token2 )
req = NewRequestWithJSON ( t , "PUT" , url , & updateFileOptions )
session . MakeRequest ( t , req , http . StatusOK )
// Test using org repo "user3/repo3" with no user token
fileID ++
treePath = fmt . Sprintf ( "update/file%d.txt" , fileID )
createFile ( user3 , repo3 , treePath )
updateFileOptions = getUpdateFileOptions ( )
url = fmt . Sprintf ( "/api/v1/repos/%s/%s/contents/%s" , user3 . Name , repo3 . Name , treePath )
req = NewRequestWithJSON ( t , "PUT" , url , & updateFileOptions )
session . MakeRequest ( t , req , http . StatusNotFound )
// Test using repo "user2/repo1" where user4 is a NOT collaborator
fileID ++
treePath = fmt . Sprintf ( "update/file%d.txt" , fileID )
createFile ( user2 , repo1 , treePath )
updateFileOptions = getUpdateFileOptions ( )
url = fmt . Sprintf ( "/api/v1/repos/%s/%s/contents/%s?token=%s" , user2 . Name , repo1 . Name , treePath , token4 )
req = NewRequestWithJSON ( t , "PUT" , url , & updateFileOptions )
session . MakeRequest ( t , req , http . StatusForbidden )
} )
2019-04-17 19:06:35 +03:00
}