pull.go 24 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387388389390391392393394395396397398399400401402403404405406407408409410411412413414415416417418419420421422423424425426427428429430431432433434435436437438439440441442443444445446447448449450451452453454455456457458459460461462463464465466467468469470471472473474475476477478479480481482483484485486487488489490491492493494495496497498499500501502503504505506507508509510511512513514515516517518519520521522523524525526527528529530531532533534535536537538539540541542543544545546547548549550551552553554555556557558559560561562563564565566567568569570571572573574575576577578579580581582583584585586587588589590591592593594595596597598599600601602603604605606607608609610611612613614615616617618619620621622623624625626627628629630631632633634635636637638639640641642643644645646647648649650651652653654655656657658659660661662663664665666667668669670671672673674675676677678679680681682683684685686687688689690691692693694695696697698699700701702703704705706707708709710711712713714715716717718719720721722723724725726727728729730731732733734735736737738739740741742743744745746747748749750751752753754755756757758759760761762763764765766767768769770771772773774775776777778779780781782783784785786787788789790791792793794795796797798799800801802803804805806807808809810811812813814815816817818819820821822823824825
  1. // Copyright 2015 The Gogs Authors. All rights reserved.
  2. // Use of this source code is governed by a MIT-style
  3. // license that can be found in the LICENSE file.
  4. package models
  5. import (
  6. "fmt"
  7. "os"
  8. "path"
  9. "strings"
  10. "time"
  11. "github.com/Unknwon/com"
  12. "github.com/go-xorm/xorm"
  13. log "gopkg.in/clog.v1"
  14. "github.com/gogits/git-module"
  15. api "github.com/gogits/go-gogs-client"
  16. "github.com/gogits/gogs/models/errors"
  17. "github.com/gogits/gogs/pkg/process"
  18. "github.com/gogits/gogs/pkg/setting"
  19. "github.com/gogits/gogs/pkg/sync"
  20. )
  21. var PullRequestQueue = sync.NewUniqueQueue(setting.Repository.PullRequestQueueLength)
  22. type PullRequestType int
  23. const (
  24. PULL_REQUEST_GOGS PullRequestType = iota
  25. PLLL_ERQUEST_GIT
  26. )
  27. type PullRequestStatus int
  28. const (
  29. PULL_REQUEST_STATUS_CONFLICT PullRequestStatus = iota
  30. PULL_REQUEST_STATUS_CHECKING
  31. PULL_REQUEST_STATUS_MERGEABLE
  32. )
  33. // PullRequest represents relation between pull request and repositories.
  34. type PullRequest struct {
  35. ID int64
  36. Type PullRequestType
  37. Status PullRequestStatus
  38. IssueID int64 `xorm:"INDEX"`
  39. Issue *Issue `xorm:"-"`
  40. Index int64
  41. HeadRepoID int64
  42. HeadRepo *Repository `xorm:"-"`
  43. BaseRepoID int64
  44. BaseRepo *Repository `xorm:"-"`
  45. HeadUserName string
  46. HeadBranch string
  47. BaseBranch string
  48. MergeBase string `xorm:"VARCHAR(40)"`
  49. HasMerged bool
  50. MergedCommitID string `xorm:"VARCHAR(40)"`
  51. MergerID int64
  52. Merger *User `xorm:"-"`
  53. Merged time.Time `xorm:"-"`
  54. MergedUnix int64
  55. }
  56. func (pr *PullRequest) BeforeUpdate() {
  57. pr.MergedUnix = pr.Merged.Unix()
  58. }
  59. // Note: don't try to get Issue because will end up recursive querying.
  60. func (pr *PullRequest) AfterSet(colName string, _ xorm.Cell) {
  61. switch colName {
  62. case "merged_unix":
  63. if !pr.HasMerged {
  64. return
  65. }
  66. pr.Merged = time.Unix(pr.MergedUnix, 0).Local()
  67. }
  68. }
  69. // Note: don't try to get Issue because will end up recursive querying.
  70. func (pr *PullRequest) loadAttributes(e Engine) (err error) {
  71. if pr.HeadRepo == nil {
  72. pr.HeadRepo, err = getRepositoryByID(e, pr.HeadRepoID)
  73. if err != nil && !errors.IsRepoNotExist(err) {
  74. return fmt.Errorf("getRepositoryByID.(HeadRepo) [%d]: %v", pr.HeadRepoID, err)
  75. }
  76. }
  77. if pr.BaseRepo == nil {
  78. pr.BaseRepo, err = getRepositoryByID(e, pr.BaseRepoID)
  79. if err != nil {
  80. return fmt.Errorf("getRepositoryByID.(BaseRepo) [%d]: %v", pr.BaseRepoID, err)
  81. }
  82. }
  83. if pr.HasMerged && pr.Merger == nil {
  84. pr.Merger, err = getUserByID(e, pr.MergerID)
  85. if errors.IsUserNotExist(err) {
  86. pr.MergerID = -1
  87. pr.Merger = NewGhostUser()
  88. } else if err != nil {
  89. return fmt.Errorf("getUserByID [%d]: %v", pr.MergerID, err)
  90. }
  91. }
  92. return nil
  93. }
  94. func (pr *PullRequest) LoadAttributes() error {
  95. return pr.loadAttributes(x)
  96. }
  97. func (pr *PullRequest) LoadIssue() (err error) {
  98. if pr.Issue != nil {
  99. return nil
  100. }
  101. pr.Issue, err = GetIssueByID(pr.IssueID)
  102. return err
  103. }
  104. // This method assumes following fields have been assigned with valid values:
  105. // Required - Issue, BaseRepo
  106. // Optional - HeadRepo, Merger
  107. func (pr *PullRequest) APIFormat() *api.PullRequest {
  108. // In case of head repo has been deleted.
  109. var apiHeadRepo *api.Repository
  110. if pr.HeadRepo == nil {
  111. apiHeadRepo = &api.Repository{
  112. Name: "deleted",
  113. }
  114. } else {
  115. apiHeadRepo = pr.HeadRepo.APIFormat(nil)
  116. }
  117. apiIssue := pr.Issue.APIFormat()
  118. apiPullRequest := &api.PullRequest{
  119. ID: pr.ID,
  120. Index: pr.Index,
  121. Poster: apiIssue.Poster,
  122. Title: apiIssue.Title,
  123. Body: apiIssue.Body,
  124. Labels: apiIssue.Labels,
  125. Milestone: apiIssue.Milestone,
  126. Assignee: apiIssue.Assignee,
  127. State: apiIssue.State,
  128. Comments: apiIssue.Comments,
  129. HeadBranch: pr.HeadBranch,
  130. HeadRepo: apiHeadRepo,
  131. BaseBranch: pr.BaseBranch,
  132. BaseRepo: pr.BaseRepo.APIFormat(nil),
  133. HTMLURL: pr.Issue.HTMLURL(),
  134. HasMerged: pr.HasMerged,
  135. }
  136. if pr.Status != PULL_REQUEST_STATUS_CHECKING {
  137. mergeable := pr.Status != PULL_REQUEST_STATUS_CONFLICT
  138. apiPullRequest.Mergeable = &mergeable
  139. }
  140. if pr.HasMerged {
  141. apiPullRequest.Merged = &pr.Merged
  142. apiPullRequest.MergedCommitID = &pr.MergedCommitID
  143. apiPullRequest.MergedBy = pr.Merger.APIFormat()
  144. }
  145. return apiPullRequest
  146. }
  147. // IsChecking returns true if this pull request is still checking conflict.
  148. func (pr *PullRequest) IsChecking() bool {
  149. return pr.Status == PULL_REQUEST_STATUS_CHECKING
  150. }
  151. // CanAutoMerge returns true if this pull request can be merged automatically.
  152. func (pr *PullRequest) CanAutoMerge() bool {
  153. return pr.Status == PULL_REQUEST_STATUS_MERGEABLE
  154. }
  155. // MergeStyle represents the approach to merge commits into base branch.
  156. type MergeStyle string
  157. const (
  158. MERGE_STYLE_REGULAR MergeStyle = "create_merge_commit"
  159. MERGE_STYLE_REBASE MergeStyle = "rebase_before_merging"
  160. )
  161. // Merge merges pull request to base repository.
  162. // FIXME: add repoWorkingPull make sure two merges does not happen at same time.
  163. func (pr *PullRequest) Merge(doer *User, baseGitRepo *git.Repository, mergeStyle MergeStyle) (err error) {
  164. defer func() {
  165. go HookQueue.Add(pr.BaseRepo.ID)
  166. go AddTestPullRequestTask(doer, pr.BaseRepo.ID, pr.BaseBranch, false)
  167. }()
  168. sess := x.NewSession()
  169. defer sess.Close()
  170. if err = sess.Begin(); err != nil {
  171. return err
  172. }
  173. if err = pr.Issue.changeStatus(sess, doer, pr.Issue.Repo, true); err != nil {
  174. return fmt.Errorf("Issue.changeStatus: %v", err)
  175. }
  176. headRepoPath := RepoPath(pr.HeadUserName, pr.HeadRepo.Name)
  177. headGitRepo, err := git.OpenRepository(headRepoPath)
  178. if err != nil {
  179. return fmt.Errorf("OpenRepository: %v", err)
  180. }
  181. // Clone base repo.
  182. tmpBasePath := path.Join(setting.AppDataPath, "tmp/repos", com.ToStr(time.Now().Nanosecond())+".git")
  183. os.MkdirAll(path.Dir(tmpBasePath), os.ModePerm)
  184. defer os.RemoveAll(path.Dir(tmpBasePath))
  185. var stderr string
  186. if _, stderr, err = process.ExecTimeout(5*time.Minute,
  187. fmt.Sprintf("PullRequest.Merge (git clone): %s", tmpBasePath),
  188. "git", "clone", baseGitRepo.Path, tmpBasePath); err != nil {
  189. return fmt.Errorf("git clone: %s", stderr)
  190. }
  191. // Check out base branch.
  192. if _, stderr, err = process.ExecDir(-1, tmpBasePath,
  193. fmt.Sprintf("PullRequest.Merge (git checkout): %s", tmpBasePath),
  194. "git", "checkout", pr.BaseBranch); err != nil {
  195. return fmt.Errorf("git checkout: %s", stderr)
  196. }
  197. // Add head repo remote.
  198. if _, stderr, err = process.ExecDir(-1, tmpBasePath,
  199. fmt.Sprintf("PullRequest.Merge (git remote add): %s", tmpBasePath),
  200. "git", "remote", "add", "head_repo", headRepoPath); err != nil {
  201. return fmt.Errorf("git remote add [%s -> %s]: %s", headRepoPath, tmpBasePath, stderr)
  202. }
  203. if _, stderr, err = process.ExecDir(-1, tmpBasePath,
  204. fmt.Sprintf("PullRequest.Merge (git fetch): %s", tmpBasePath),
  205. "git", "fetch", "head_repo"); err != nil {
  206. return fmt.Errorf("git fetch [%s -> %s]: %s", headRepoPath, tmpBasePath, stderr)
  207. }
  208. // Check if merge style is allowed, reset to default style if not
  209. if mergeStyle == MERGE_STYLE_REBASE && !pr.BaseRepo.PullsAllowRebase {
  210. mergeStyle = MERGE_STYLE_REGULAR
  211. }
  212. switch mergeStyle {
  213. case MERGE_STYLE_REGULAR: // Create merge commit
  214. if _, stderr, err = process.ExecDir(-1, tmpBasePath,
  215. fmt.Sprintf("PullRequest.Merge (git merge --no-ff --no-commit): %s", tmpBasePath),
  216. "git", "merge", "--no-ff", "--no-commit", "head_repo/"+pr.HeadBranch); err != nil {
  217. return fmt.Errorf("git merge --no-ff --no-commit [%s]: %v - %s", tmpBasePath, err, stderr)
  218. }
  219. sig := doer.NewGitSig()
  220. if _, stderr, err = process.ExecDir(-1, tmpBasePath,
  221. fmt.Sprintf("PullRequest.Merge (git merge): %s", tmpBasePath),
  222. "git", "commit", fmt.Sprintf("--author='%s <%s>'", sig.Name, sig.Email),
  223. "-m", fmt.Sprintf("Merge branch '%s' of %s/%s into %s", pr.HeadBranch, pr.HeadUserName, pr.HeadRepo.Name, pr.BaseBranch)); err != nil {
  224. return fmt.Errorf("git commit [%s]: %v - %s", tmpBasePath, err, stderr)
  225. }
  226. case MERGE_STYLE_REBASE: // Rebase before merging
  227. if _, stderr, err = process.ExecDir(-1, tmpBasePath,
  228. fmt.Sprintf("PullRequest.Merge (git rebase): %s", tmpBasePath),
  229. "git", "rebase", "-q", pr.BaseBranch, "head_repo/"+pr.HeadBranch); err != nil {
  230. return fmt.Errorf("git rebase [%s -> %s]: %s", headRepoPath, tmpBasePath, stderr)
  231. }
  232. default:
  233. return fmt.Errorf("unknown merge style: %s", mergeStyle)
  234. }
  235. // Push back to upstream.
  236. if _, stderr, err = process.ExecDir(-1, tmpBasePath,
  237. fmt.Sprintf("PullRequest.Merge (git push): %s", tmpBasePath),
  238. "git", "push", baseGitRepo.Path, pr.BaseBranch); err != nil {
  239. return fmt.Errorf("git push: %s", stderr)
  240. }
  241. pr.MergedCommitID, err = headGitRepo.GetBranchCommitID(pr.HeadBranch)
  242. if err != nil {
  243. return fmt.Errorf("GetBranchCommit: %v", err)
  244. }
  245. pr.HasMerged = true
  246. pr.Merged = time.Now()
  247. pr.MergerID = doer.ID
  248. if _, err = sess.Id(pr.ID).AllCols().Update(pr); err != nil {
  249. return fmt.Errorf("update pull request: %v", err)
  250. }
  251. if err = sess.Commit(); err != nil {
  252. return fmt.Errorf("Commit: %v", err)
  253. }
  254. if err = MergePullRequestAction(doer, pr.Issue.Repo, pr.Issue); err != nil {
  255. log.Error(2, "MergePullRequestAction [%d]: %v", pr.ID, err)
  256. }
  257. // Reload pull request information.
  258. if err = pr.LoadAttributes(); err != nil {
  259. log.Error(2, "LoadAttributes: %v", err)
  260. return nil
  261. }
  262. if err = PrepareWebhooks(pr.Issue.Repo, HOOK_EVENT_PULL_REQUEST, &api.PullRequestPayload{
  263. Action: api.HOOK_ISSUE_CLOSED,
  264. Index: pr.Index,
  265. PullRequest: pr.APIFormat(),
  266. Repository: pr.Issue.Repo.APIFormat(nil),
  267. Sender: doer.APIFormat(),
  268. }); err != nil {
  269. log.Error(2, "PrepareWebhooks: %v", err)
  270. return nil
  271. }
  272. l, err := headGitRepo.CommitsBetweenIDs(pr.MergedCommitID, pr.MergeBase)
  273. if err != nil {
  274. log.Error(2, "CommitsBetweenIDs: %v", err)
  275. return nil
  276. }
  277. // It is possible that head branch is not fully sync with base branch for merge commits,
  278. // so we need to get latest head commit and append merge commit manully
  279. // to avoid strange diff commits produced.
  280. mergeCommit, err := baseGitRepo.GetBranchCommit(pr.BaseBranch)
  281. if err != nil {
  282. log.Error(2, "GetBranchCommit: %v", err)
  283. return nil
  284. }
  285. if mergeStyle == MERGE_STYLE_REGULAR {
  286. l.PushFront(mergeCommit)
  287. }
  288. commits, err := ListToPushCommits(l).ToApiPayloadCommits(pr.BaseRepo.RepoPath(), pr.BaseRepo.HTMLURL())
  289. if err != nil {
  290. log.Error(2, "ToApiPayloadCommits: %v", err)
  291. return nil
  292. }
  293. p := &api.PushPayload{
  294. Ref: git.BRANCH_PREFIX + pr.BaseBranch,
  295. Before: pr.MergeBase,
  296. After: mergeCommit.ID.String(),
  297. CompareURL: setting.AppURL + pr.BaseRepo.ComposeCompareURL(pr.MergeBase, pr.MergedCommitID),
  298. Commits: commits,
  299. Repo: pr.BaseRepo.APIFormat(nil),
  300. Pusher: pr.HeadRepo.MustOwner().APIFormat(),
  301. Sender: doer.APIFormat(),
  302. }
  303. if err = PrepareWebhooks(pr.BaseRepo, HOOK_EVENT_PUSH, p); err != nil {
  304. log.Error(2, "PrepareWebhooks: %v", err)
  305. return nil
  306. }
  307. return nil
  308. }
  309. // testPatch checks if patch can be merged to base repository without conflit.
  310. // FIXME: make a mechanism to clean up stable local copies.
  311. func (pr *PullRequest) testPatch() (err error) {
  312. if pr.BaseRepo == nil {
  313. pr.BaseRepo, err = GetRepositoryByID(pr.BaseRepoID)
  314. if err != nil {
  315. return fmt.Errorf("GetRepositoryByID: %v", err)
  316. }
  317. }
  318. patchPath, err := pr.BaseRepo.PatchPath(pr.Index)
  319. if err != nil {
  320. return fmt.Errorf("BaseRepo.PatchPath: %v", err)
  321. }
  322. // Fast fail if patch does not exist, this assumes data is cruppted.
  323. if !com.IsFile(patchPath) {
  324. log.Trace("PullRequest[%d].testPatch: ignored cruppted data", pr.ID)
  325. return nil
  326. }
  327. repoWorkingPool.CheckIn(com.ToStr(pr.BaseRepoID))
  328. defer repoWorkingPool.CheckOut(com.ToStr(pr.BaseRepoID))
  329. log.Trace("PullRequest[%d].testPatch (patchPath): %s", pr.ID, patchPath)
  330. if err := pr.BaseRepo.UpdateLocalCopyBranch(pr.BaseBranch); err != nil {
  331. return fmt.Errorf("UpdateLocalCopy [%d]: %v", pr.BaseRepoID, err)
  332. }
  333. args := []string{"apply", "--check"}
  334. if pr.BaseRepo.PullsIgnoreWhitespace {
  335. args = append(args, "--ignore-whitespace")
  336. }
  337. args = append(args, patchPath)
  338. pr.Status = PULL_REQUEST_STATUS_CHECKING
  339. _, stderr, err := process.ExecDir(-1, pr.BaseRepo.LocalCopyPath(),
  340. fmt.Sprintf("testPatch (git apply --check): %d", pr.BaseRepo.ID),
  341. "git", args...)
  342. if err != nil {
  343. log.Trace("PullRequest[%d].testPatch (apply): has conflit\n%s", pr.ID, stderr)
  344. pr.Status = PULL_REQUEST_STATUS_CONFLICT
  345. return nil
  346. }
  347. return nil
  348. }
  349. // NewPullRequest creates new pull request with labels for repository.
  350. func NewPullRequest(repo *Repository, pull *Issue, labelIDs []int64, uuids []string, pr *PullRequest, patch []byte) (err error) {
  351. sess := x.NewSession()
  352. defer sess.Close()
  353. if err = sess.Begin(); err != nil {
  354. return err
  355. }
  356. if err = newIssue(sess, NewIssueOptions{
  357. Repo: repo,
  358. Issue: pull,
  359. LableIDs: labelIDs,
  360. Attachments: uuids,
  361. IsPull: true,
  362. }); err != nil {
  363. return fmt.Errorf("newIssue: %v", err)
  364. }
  365. pr.Index = pull.Index
  366. if err = repo.SavePatch(pr.Index, patch); err != nil {
  367. return fmt.Errorf("SavePatch: %v", err)
  368. }
  369. pr.BaseRepo = repo
  370. if err = pr.testPatch(); err != nil {
  371. return fmt.Errorf("testPatch: %v", err)
  372. }
  373. // No conflict appears after test means mergeable.
  374. if pr.Status == PULL_REQUEST_STATUS_CHECKING {
  375. pr.Status = PULL_REQUEST_STATUS_MERGEABLE
  376. }
  377. pr.IssueID = pull.ID
  378. if _, err = sess.Insert(pr); err != nil {
  379. return fmt.Errorf("insert pull repo: %v", err)
  380. }
  381. if err = sess.Commit(); err != nil {
  382. return fmt.Errorf("Commit: %v", err)
  383. }
  384. if err = NotifyWatchers(&Action{
  385. ActUserID: pull.Poster.ID,
  386. ActUserName: pull.Poster.Name,
  387. OpType: ACTION_CREATE_PULL_REQUEST,
  388. Content: fmt.Sprintf("%d|%s", pull.Index, pull.Title),
  389. RepoID: repo.ID,
  390. RepoUserName: repo.Owner.Name,
  391. RepoName: repo.Name,
  392. IsPrivate: repo.IsPrivate,
  393. }); err != nil {
  394. log.Error(2, "NotifyWatchers: %v", err)
  395. }
  396. if err = pull.MailParticipants(); err != nil {
  397. log.Error(2, "MailParticipants: %v", err)
  398. }
  399. pr.Issue = pull
  400. pull.PullRequest = pr
  401. if err = PrepareWebhooks(repo, HOOK_EVENT_PULL_REQUEST, &api.PullRequestPayload{
  402. Action: api.HOOK_ISSUE_OPENED,
  403. Index: pull.Index,
  404. PullRequest: pr.APIFormat(),
  405. Repository: repo.APIFormat(nil),
  406. Sender: pull.Poster.APIFormat(),
  407. }); err != nil {
  408. log.Error(2, "PrepareWebhooks: %v", err)
  409. }
  410. return nil
  411. }
  412. // GetUnmergedPullRequest returnss a pull request that is open and has not been merged
  413. // by given head/base and repo/branch.
  414. func GetUnmergedPullRequest(headRepoID, baseRepoID int64, headBranch, baseBranch string) (*PullRequest, error) {
  415. pr := new(PullRequest)
  416. has, err := x.Where("head_repo_id=? AND head_branch=? AND base_repo_id=? AND base_branch=? AND has_merged=? AND issue.is_closed=?",
  417. headRepoID, headBranch, baseRepoID, baseBranch, false, false).
  418. Join("INNER", "issue", "issue.id=pull_request.issue_id").Get(pr)
  419. if err != nil {
  420. return nil, err
  421. } else if !has {
  422. return nil, ErrPullRequestNotExist{0, 0, headRepoID, baseRepoID, headBranch, baseBranch}
  423. }
  424. return pr, nil
  425. }
  426. // GetUnmergedPullRequestsByHeadInfo returnss all pull requests that are open and has not been merged
  427. // by given head information (repo and branch).
  428. func GetUnmergedPullRequestsByHeadInfo(repoID int64, branch string) ([]*PullRequest, error) {
  429. prs := make([]*PullRequest, 0, 2)
  430. return prs, x.Where("head_repo_id = ? AND head_branch = ? AND has_merged = ? AND issue.is_closed = ?",
  431. repoID, branch, false, false).
  432. Join("INNER", "issue", "issue.id = pull_request.issue_id").Find(&prs)
  433. }
  434. // GetUnmergedPullRequestsByBaseInfo returnss all pull requests that are open and has not been merged
  435. // by given base information (repo and branch).
  436. func GetUnmergedPullRequestsByBaseInfo(repoID int64, branch string) ([]*PullRequest, error) {
  437. prs := make([]*PullRequest, 0, 2)
  438. return prs, x.Where("base_repo_id=? AND base_branch=? AND has_merged=? AND issue.is_closed=?",
  439. repoID, branch, false, false).
  440. Join("INNER", "issue", "issue.id=pull_request.issue_id").Find(&prs)
  441. }
  442. func getPullRequestByID(e Engine, id int64) (*PullRequest, error) {
  443. pr := new(PullRequest)
  444. has, err := e.Id(id).Get(pr)
  445. if err != nil {
  446. return nil, err
  447. } else if !has {
  448. return nil, ErrPullRequestNotExist{id, 0, 0, 0, "", ""}
  449. }
  450. return pr, pr.loadAttributes(e)
  451. }
  452. // GetPullRequestByID returns a pull request by given ID.
  453. func GetPullRequestByID(id int64) (*PullRequest, error) {
  454. return getPullRequestByID(x, id)
  455. }
  456. func getPullRequestByIssueID(e Engine, issueID int64) (*PullRequest, error) {
  457. pr := &PullRequest{
  458. IssueID: issueID,
  459. }
  460. has, err := e.Get(pr)
  461. if err != nil {
  462. return nil, err
  463. } else if !has {
  464. return nil, ErrPullRequestNotExist{0, issueID, 0, 0, "", ""}
  465. }
  466. return pr, pr.loadAttributes(e)
  467. }
  468. // GetPullRequestByIssueID returns pull request by given issue ID.
  469. func GetPullRequestByIssueID(issueID int64) (*PullRequest, error) {
  470. return getPullRequestByIssueID(x, issueID)
  471. }
  472. // Update updates all fields of pull request.
  473. func (pr *PullRequest) Update() error {
  474. _, err := x.Id(pr.ID).AllCols().Update(pr)
  475. return err
  476. }
  477. // Update updates specific fields of pull request.
  478. func (pr *PullRequest) UpdateCols(cols ...string) error {
  479. _, err := x.Id(pr.ID).Cols(cols...).Update(pr)
  480. return err
  481. }
  482. // UpdatePatch generates and saves a new patch.
  483. func (pr *PullRequest) UpdatePatch() (err error) {
  484. if pr.HeadRepo == nil {
  485. log.Trace("PullRequest[%d].UpdatePatch: ignored cruppted data", pr.ID)
  486. return nil
  487. }
  488. headGitRepo, err := git.OpenRepository(pr.HeadRepo.RepoPath())
  489. if err != nil {
  490. return fmt.Errorf("OpenRepository: %v", err)
  491. }
  492. // Add a temporary remote.
  493. tmpRemote := com.ToStr(time.Now().UnixNano())
  494. if err = headGitRepo.AddRemote(tmpRemote, RepoPath(pr.BaseRepo.MustOwner().Name, pr.BaseRepo.Name), true); err != nil {
  495. return fmt.Errorf("AddRemote: %v", err)
  496. }
  497. defer func() {
  498. headGitRepo.RemoveRemote(tmpRemote)
  499. }()
  500. remoteBranch := "remotes/" + tmpRemote + "/" + pr.BaseBranch
  501. pr.MergeBase, err = headGitRepo.GetMergeBase(remoteBranch, pr.HeadBranch)
  502. if err != nil {
  503. return fmt.Errorf("GetMergeBase: %v", err)
  504. } else if err = pr.Update(); err != nil {
  505. return fmt.Errorf("Update: %v", err)
  506. }
  507. patch, err := headGitRepo.GetPatch(pr.MergeBase, pr.HeadBranch)
  508. if err != nil {
  509. return fmt.Errorf("GetPatch: %v", err)
  510. }
  511. if err = pr.BaseRepo.SavePatch(pr.Index, patch); err != nil {
  512. return fmt.Errorf("BaseRepo.SavePatch: %v", err)
  513. }
  514. return nil
  515. }
  516. // PushToBaseRepo pushes commits from branches of head repository to
  517. // corresponding branches of base repository.
  518. // FIXME: Only push branches that are actually updates?
  519. func (pr *PullRequest) PushToBaseRepo() (err error) {
  520. log.Trace("PushToBaseRepo[%d]: pushing commits to base repo 'refs/pull/%d/head'", pr.BaseRepoID, pr.Index)
  521. headRepoPath := pr.HeadRepo.RepoPath()
  522. headGitRepo, err := git.OpenRepository(headRepoPath)
  523. if err != nil {
  524. return fmt.Errorf("OpenRepository: %v", err)
  525. }
  526. tmpRemoteName := fmt.Sprintf("tmp-pull-%d", pr.ID)
  527. if err = headGitRepo.AddRemote(tmpRemoteName, pr.BaseRepo.RepoPath(), false); err != nil {
  528. return fmt.Errorf("headGitRepo.AddRemote: %v", err)
  529. }
  530. // Make sure to remove the remote even if the push fails
  531. defer headGitRepo.RemoveRemote(tmpRemoteName)
  532. headFile := fmt.Sprintf("refs/pull/%d/head", pr.Index)
  533. // Remove head in case there is a conflict.
  534. os.Remove(path.Join(pr.BaseRepo.RepoPath(), headFile))
  535. if err = git.Push(headRepoPath, tmpRemoteName, fmt.Sprintf("%s:%s", pr.HeadBranch, headFile)); err != nil {
  536. return fmt.Errorf("Push: %v", err)
  537. }
  538. return nil
  539. }
  540. // AddToTaskQueue adds itself to pull request test task queue.
  541. func (pr *PullRequest) AddToTaskQueue() {
  542. go PullRequestQueue.AddFunc(pr.ID, func() {
  543. pr.Status = PULL_REQUEST_STATUS_CHECKING
  544. if err := pr.UpdateCols("status"); err != nil {
  545. log.Error(3, "AddToTaskQueue.UpdateCols[%d].(add to queue): %v", pr.ID, err)
  546. }
  547. })
  548. }
  549. type PullRequestList []*PullRequest
  550. func (prs PullRequestList) loadAttributes(e Engine) (err error) {
  551. if len(prs) == 0 {
  552. return nil
  553. }
  554. // Load issues
  555. set := make(map[int64]*Issue)
  556. for i := range prs {
  557. set[prs[i].IssueID] = nil
  558. }
  559. issueIDs := make([]int64, 0, len(prs))
  560. for issueID := range set {
  561. issueIDs = append(issueIDs, issueID)
  562. }
  563. issues := make([]*Issue, 0, len(issueIDs))
  564. if err = e.Where("id > 0").In("id", issueIDs).Find(&issues); err != nil {
  565. return fmt.Errorf("find issues: %v", err)
  566. }
  567. for i := range issues {
  568. set[issues[i].ID] = issues[i]
  569. }
  570. for i := range prs {
  571. prs[i].Issue = set[prs[i].IssueID]
  572. }
  573. // Load attributes
  574. for i := range prs {
  575. if err = prs[i].loadAttributes(e); err != nil {
  576. return fmt.Errorf("loadAttributes [%d]: %v", prs[i].ID, err)
  577. }
  578. }
  579. return nil
  580. }
  581. func (prs PullRequestList) LoadAttributes() error {
  582. return prs.loadAttributes(x)
  583. }
  584. func addHeadRepoTasks(prs []*PullRequest) {
  585. for _, pr := range prs {
  586. log.Trace("addHeadRepoTasks[%d]: composing new test task", pr.ID)
  587. if err := pr.UpdatePatch(); err != nil {
  588. log.Error(4, "UpdatePatch: %v", err)
  589. continue
  590. } else if err := pr.PushToBaseRepo(); err != nil {
  591. log.Error(4, "PushToBaseRepo: %v", err)
  592. continue
  593. }
  594. pr.AddToTaskQueue()
  595. }
  596. }
  597. // AddTestPullRequestTask adds new test tasks by given head/base repository and head/base branch,
  598. // and generate new patch for testing as needed.
  599. func AddTestPullRequestTask(doer *User, repoID int64, branch string, isSync bool) {
  600. log.Trace("AddTestPullRequestTask [head_repo_id: %d, head_branch: %s]: finding pull requests", repoID, branch)
  601. prs, err := GetUnmergedPullRequestsByHeadInfo(repoID, branch)
  602. if err != nil {
  603. log.Error(2, "Find pull requests [head_repo_id: %d, head_branch: %s]: %v", repoID, branch, err)
  604. return
  605. }
  606. if isSync {
  607. if err = PullRequestList(prs).LoadAttributes(); err != nil {
  608. log.Error(2, "PullRequestList.LoadAttributes: %v", err)
  609. }
  610. if err == nil {
  611. for _, pr := range prs {
  612. pr.Issue.PullRequest = pr
  613. if err = pr.Issue.LoadAttributes(); err != nil {
  614. log.Error(2, "LoadAttributes: %v", err)
  615. continue
  616. }
  617. if err = PrepareWebhooks(pr.Issue.Repo, HOOK_EVENT_PULL_REQUEST, &api.PullRequestPayload{
  618. Action: api.HOOK_ISSUE_SYNCHRONIZED,
  619. Index: pr.Issue.Index,
  620. PullRequest: pr.Issue.PullRequest.APIFormat(),
  621. Repository: pr.Issue.Repo.APIFormat(nil),
  622. Sender: doer.APIFormat(),
  623. }); err != nil {
  624. log.Error(2, "PrepareWebhooks [pull_id: %v]: %v", pr.ID, err)
  625. continue
  626. }
  627. }
  628. }
  629. }
  630. addHeadRepoTasks(prs)
  631. log.Trace("AddTestPullRequestTask [base_repo_id: %d, base_branch: %s]: finding pull requests", repoID, branch)
  632. prs, err = GetUnmergedPullRequestsByBaseInfo(repoID, branch)
  633. if err != nil {
  634. log.Error(2, "Find pull requests [base_repo_id: %d, base_branch: %s]: %v", repoID, branch, err)
  635. return
  636. }
  637. for _, pr := range prs {
  638. pr.AddToTaskQueue()
  639. }
  640. }
  641. func ChangeUsernameInPullRequests(oldUserName, newUserName string) error {
  642. pr := PullRequest{
  643. HeadUserName: strings.ToLower(newUserName),
  644. }
  645. _, err := x.Cols("head_user_name").Where("head_user_name = ?", strings.ToLower(oldUserName)).Update(pr)
  646. return err
  647. }
  648. // checkAndUpdateStatus checks if pull request is possible to levaing checking status,
  649. // and set to be either conflict or mergeable.
  650. func (pr *PullRequest) checkAndUpdateStatus() {
  651. // Status is not changed to conflict means mergeable.
  652. if pr.Status == PULL_REQUEST_STATUS_CHECKING {
  653. pr.Status = PULL_REQUEST_STATUS_MERGEABLE
  654. }
  655. // Make sure there is no waiting test to process before levaing the checking status.
  656. if !PullRequestQueue.Exist(pr.ID) {
  657. if err := pr.UpdateCols("status"); err != nil {
  658. log.Error(4, "Update[%d]: %v", pr.ID, err)
  659. }
  660. }
  661. }
  662. // TestPullRequests checks and tests untested patches of pull requests.
  663. // TODO: test more pull requests at same time.
  664. func TestPullRequests() {
  665. prs := make([]*PullRequest, 0, 10)
  666. x.Iterate(PullRequest{
  667. Status: PULL_REQUEST_STATUS_CHECKING,
  668. },
  669. func(idx int, bean interface{}) error {
  670. pr := bean.(*PullRequest)
  671. if err := pr.LoadAttributes(); err != nil {
  672. log.Error(3, "LoadAttributes: %v", err)
  673. return nil
  674. }
  675. if err := pr.testPatch(); err != nil {
  676. log.Error(3, "testPatch: %v", err)
  677. return nil
  678. }
  679. prs = append(prs, pr)
  680. return nil
  681. })
  682. // Update pull request status.
  683. for _, pr := range prs {
  684. pr.checkAndUpdateStatus()
  685. }
  686. // Start listening on new test requests.
  687. for prID := range PullRequestQueue.Queue() {
  688. log.Trace("TestPullRequests[%v]: processing test task", prID)
  689. PullRequestQueue.Remove(prID)
  690. pr, err := GetPullRequestByID(com.StrTo(prID).MustInt64())
  691. if err != nil {
  692. log.Error(4, "GetPullRequestByID[%s]: %v", prID, err)
  693. continue
  694. } else if err = pr.testPatch(); err != nil {
  695. log.Error(4, "testPatch[%d]: %v", pr.ID, err)
  696. continue
  697. }
  698. pr.checkAndUpdateStatus()
  699. }
  700. }
  701. func InitTestPullRequests() {
  702. go TestPullRequests()
  703. }