2022-10-18 01:24:12 +00:00
|
|
|
// Copyright 2022 Woodpecker Authors
|
2018-02-19 22:24:10 +00:00
|
|
|
// Copyright 2018 Drone.IO Inc.
|
2018-03-21 13:02:17 +00:00
|
|
|
//
|
2018-02-19 22:24:10 +00:00
|
|
|
// Licensed under the Apache License, Version 2.0 (the "License");
|
|
|
|
// you may not use this file except in compliance with the License.
|
|
|
|
// You may obtain a copy of the License at
|
2018-03-21 13:02:17 +00:00
|
|
|
//
|
2018-02-19 22:24:10 +00:00
|
|
|
// http://www.apache.org/licenses/LICENSE-2.0
|
2018-03-21 13:02:17 +00:00
|
|
|
//
|
2018-02-19 22:24:10 +00:00
|
|
|
// Unless required by applicable law or agreed to in writing, software
|
|
|
|
// distributed under the License is distributed on an "AS IS" BASIS,
|
|
|
|
// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
|
|
|
|
// See the License for the specific language governing permissions and
|
|
|
|
// limitations under the License.
|
|
|
|
|
2016-05-03 20:01:16 +00:00
|
|
|
package github
|
|
|
|
|
|
|
|
import (
|
|
|
|
"bytes"
|
2022-01-17 22:46:59 +00:00
|
|
|
"fmt"
|
2016-05-03 20:01:16 +00:00
|
|
|
"io"
|
|
|
|
"net/http"
|
2022-01-17 22:46:59 +00:00
|
|
|
"strings"
|
|
|
|
|
|
|
|
"github.com/google/go-github/v39/github"
|
2016-05-03 20:01:16 +00:00
|
|
|
|
2021-09-27 17:51:55 +00:00
|
|
|
"github.com/woodpecker-ci/woodpecker/server/model"
|
2022-01-17 22:46:59 +00:00
|
|
|
"github.com/woodpecker-ci/woodpecker/shared/utils"
|
2016-05-03 20:01:16 +00:00
|
|
|
)
|
|
|
|
|
|
|
|
const (
|
2022-01-17 22:46:59 +00:00
|
|
|
hookField = "payload"
|
2016-05-03 20:01:16 +00:00
|
|
|
|
|
|
|
actionOpen = "opened"
|
|
|
|
actionSync = "synchronize"
|
|
|
|
|
|
|
|
stateOpen = "open"
|
|
|
|
)
|
|
|
|
|
2021-09-21 15:35:32 +00:00
|
|
|
// parseHook parses a GitHub hook from an http.Request request and returns
|
2022-10-18 01:24:12 +00:00
|
|
|
// Repo and Pipeline detail. If a hook type is unsupported nil values are returned.
|
|
|
|
func parseHook(r *http.Request, merge bool) (*github.PullRequest, *model.Repo, *model.Pipeline, error) {
|
2016-05-03 20:01:16 +00:00
|
|
|
var reader io.Reader = r.Body
|
|
|
|
|
|
|
|
if payload := r.FormValue(hookField); payload != "" {
|
|
|
|
reader = bytes.NewBufferString(payload)
|
|
|
|
}
|
|
|
|
|
2022-08-29 23:14:07 +00:00
|
|
|
raw, err := io.ReadAll(reader)
|
2016-05-03 20:01:16 +00:00
|
|
|
if err != nil {
|
2022-01-17 22:46:59 +00:00
|
|
|
return nil, nil, nil, err
|
|
|
|
}
|
|
|
|
|
|
|
|
payload, err := github.ParseWebHook(github.WebHookType(r), raw)
|
|
|
|
if err != nil {
|
|
|
|
return nil, nil, nil, err
|
2016-05-03 20:01:16 +00:00
|
|
|
}
|
|
|
|
|
2022-01-17 22:46:59 +00:00
|
|
|
switch hook := payload.(type) {
|
|
|
|
case *github.PushEvent:
|
2022-10-18 01:24:12 +00:00
|
|
|
repo, pipeline, err := parsePushHook(hook)
|
|
|
|
return nil, repo, pipeline, err
|
2022-01-17 22:46:59 +00:00
|
|
|
case *github.DeploymentEvent:
|
2022-10-18 01:24:12 +00:00
|
|
|
repo, pipeline, err := parseDeployHook(hook)
|
|
|
|
return nil, repo, pipeline, err
|
2022-01-17 22:46:59 +00:00
|
|
|
case *github.PullRequestEvent:
|
2022-01-31 14:38:00 +00:00
|
|
|
return parsePullHook(hook, merge)
|
2016-05-03 20:01:16 +00:00
|
|
|
}
|
2022-01-17 22:46:59 +00:00
|
|
|
return nil, nil, nil, nil
|
2016-05-03 20:01:16 +00:00
|
|
|
}
|
|
|
|
|
2022-10-18 01:24:12 +00:00
|
|
|
// parsePushHook parses a push hook and returns the Repo and Pipeline details.
|
2016-05-03 20:01:16 +00:00
|
|
|
// If the commit type is unsupported nil values are returned.
|
2022-10-18 01:24:12 +00:00
|
|
|
func parsePushHook(hook *github.PushEvent) (*model.Repo, *model.Pipeline, error) {
|
2022-01-17 22:46:59 +00:00
|
|
|
if hook.Deleted != nil && *hook.Deleted {
|
|
|
|
return nil, nil, nil
|
2016-05-03 20:01:16 +00:00
|
|
|
}
|
2022-01-17 22:46:59 +00:00
|
|
|
|
2022-10-18 01:24:12 +00:00
|
|
|
pipeline := &model.Pipeline{
|
2022-01-17 22:46:59 +00:00
|
|
|
Event: model.EventPush,
|
|
|
|
Commit: hook.GetHeadCommit().GetID(),
|
|
|
|
Ref: hook.GetRef(),
|
|
|
|
Link: hook.GetHeadCommit().GetURL(),
|
|
|
|
Branch: strings.Replace(hook.GetRef(), "refs/heads/", "", -1),
|
|
|
|
Message: hook.GetHeadCommit().GetMessage(),
|
|
|
|
Email: hook.GetHeadCommit().GetAuthor().GetEmail(),
|
|
|
|
Avatar: hook.GetSender().GetAvatarURL(),
|
|
|
|
Author: hook.GetSender().GetLogin(),
|
2022-11-04 23:35:06 +00:00
|
|
|
CloneURL: hook.GetRepo().GetCloneURL(),
|
2022-01-17 22:46:59 +00:00
|
|
|
Sender: hook.GetSender().GetLogin(),
|
|
|
|
ChangedFiles: getChangedFilesFromCommits(hook.Commits),
|
|
|
|
}
|
|
|
|
|
2022-10-18 01:24:12 +00:00
|
|
|
if len(pipeline.Author) == 0 {
|
|
|
|
pipeline.Author = hook.GetHeadCommit().GetAuthor().GetLogin()
|
2016-05-03 20:01:16 +00:00
|
|
|
}
|
2022-10-18 01:24:12 +00:00
|
|
|
// if len(pipeline.Email) == 0 {
|
2022-01-17 22:46:59 +00:00
|
|
|
// TODO: default to gravatar?
|
|
|
|
// }
|
2022-10-18 01:24:12 +00:00
|
|
|
if strings.HasPrefix(pipeline.Ref, "refs/tags/") {
|
2022-01-17 22:46:59 +00:00
|
|
|
// just kidding, this is actually a tag event. Why did this come as a push
|
|
|
|
// event we'll never know!
|
2022-10-18 01:24:12 +00:00
|
|
|
pipeline.Event = model.EventTag
|
|
|
|
pipeline.ChangedFiles = nil
|
2022-01-17 22:46:59 +00:00
|
|
|
// For tags, if the base_ref (tag's base branch) is set, we're using it
|
2022-10-18 01:24:12 +00:00
|
|
|
// as pipeline's branch so that we can filter events base on it
|
2022-01-17 22:46:59 +00:00
|
|
|
if strings.HasPrefix(hook.GetBaseRef(), "refs/heads/") {
|
2022-10-18 01:24:12 +00:00
|
|
|
pipeline.Branch = strings.Replace(hook.GetBaseRef(), "refs/heads/", "", -1)
|
2022-01-17 22:46:59 +00:00
|
|
|
}
|
|
|
|
}
|
|
|
|
|
2022-10-18 01:24:12 +00:00
|
|
|
return convertRepoHook(hook.GetRepo()), pipeline, nil
|
2016-05-03 20:01:16 +00:00
|
|
|
}
|
|
|
|
|
2022-10-18 01:24:12 +00:00
|
|
|
// parseDeployHook parses a deployment and returns the Repo and Pipeline details.
|
2016-05-03 20:01:16 +00:00
|
|
|
// If the commit type is unsupported nil values are returned.
|
2022-10-18 01:24:12 +00:00
|
|
|
func parseDeployHook(hook *github.DeploymentEvent) (*model.Repo, *model.Pipeline, error) {
|
|
|
|
pipeline := &model.Pipeline{
|
2022-01-17 22:46:59 +00:00
|
|
|
Event: model.EventDeploy,
|
|
|
|
Commit: hook.GetDeployment().GetSHA(),
|
|
|
|
Link: hook.GetDeployment().GetURL(),
|
|
|
|
Message: hook.GetDeployment().GetDescription(),
|
|
|
|
Ref: hook.GetDeployment().GetRef(),
|
|
|
|
Branch: hook.GetDeployment().GetRef(),
|
|
|
|
Deploy: hook.GetDeployment().GetEnvironment(),
|
|
|
|
Avatar: hook.GetSender().GetAvatarURL(),
|
|
|
|
Author: hook.GetSender().GetLogin(),
|
|
|
|
Sender: hook.GetSender().GetLogin(),
|
2016-05-03 20:01:16 +00:00
|
|
|
}
|
2022-01-17 22:46:59 +00:00
|
|
|
// if the ref is a sha or short sha we need to manually construct the ref.
|
2022-10-18 01:24:12 +00:00
|
|
|
if strings.HasPrefix(pipeline.Commit, pipeline.Ref) || pipeline.Commit == pipeline.Ref {
|
|
|
|
pipeline.Branch = hook.GetRepo().GetDefaultBranch()
|
|
|
|
if pipeline.Branch == "" {
|
|
|
|
pipeline.Branch = defaultBranch
|
2022-01-17 22:46:59 +00:00
|
|
|
}
|
2022-10-18 01:24:12 +00:00
|
|
|
pipeline.Ref = fmt.Sprintf("refs/heads/%s", pipeline.Branch)
|
2022-01-17 22:46:59 +00:00
|
|
|
}
|
|
|
|
// if the ref is a branch we should make sure it has refs/heads prefix
|
2022-10-18 01:24:12 +00:00
|
|
|
if !strings.HasPrefix(pipeline.Ref, "refs/") { // branch or tag
|
|
|
|
pipeline.Ref = fmt.Sprintf("refs/heads/%s", pipeline.Branch)
|
2022-01-17 22:46:59 +00:00
|
|
|
}
|
|
|
|
|
2022-10-18 01:24:12 +00:00
|
|
|
return convertRepo(hook.GetRepo()), pipeline, nil
|
2016-05-03 20:01:16 +00:00
|
|
|
}
|
|
|
|
|
2022-10-18 01:24:12 +00:00
|
|
|
// parsePullHook parses a pull request hook and returns the Repo and Pipeline
|
2016-05-03 20:01:16 +00:00
|
|
|
// details. If the pull request is closed nil values are returned.
|
2022-10-18 01:24:12 +00:00
|
|
|
func parsePullHook(hook *github.PullRequestEvent, merge bool) (*github.PullRequest, *model.Repo, *model.Pipeline, error) {
|
2022-01-17 22:46:59 +00:00
|
|
|
// only listen to new merge-requests and pushes to open ones
|
|
|
|
if hook.GetAction() != actionOpen && hook.GetAction() != actionSync {
|
|
|
|
return nil, nil, nil, nil
|
|
|
|
}
|
|
|
|
if hook.GetPullRequest().GetState() != stateOpen {
|
|
|
|
return nil, nil, nil, nil
|
2016-05-03 20:01:16 +00:00
|
|
|
}
|
|
|
|
|
2022-10-18 01:24:12 +00:00
|
|
|
pipeline := &model.Pipeline{
|
2022-11-04 23:35:06 +00:00
|
|
|
Event: model.EventPull,
|
|
|
|
Commit: hook.GetPullRequest().GetHead().GetSHA(),
|
|
|
|
Link: hook.GetPullRequest().GetHTMLURL(),
|
|
|
|
Ref: fmt.Sprintf(headRefs, hook.GetPullRequest().GetNumber()),
|
|
|
|
Branch: hook.GetPullRequest().GetBase().GetRef(),
|
|
|
|
Message: hook.GetPullRequest().GetTitle(),
|
|
|
|
Author: hook.GetPullRequest().GetUser().GetLogin(),
|
|
|
|
Avatar: hook.GetPullRequest().GetUser().GetAvatarURL(),
|
|
|
|
Title: hook.GetPullRequest().GetTitle(),
|
|
|
|
Sender: hook.GetSender().GetLogin(),
|
|
|
|
CloneURL: hook.GetPullRequest().GetHead().GetRepo().GetCloneURL(),
|
2022-01-17 22:46:59 +00:00
|
|
|
Refspec: fmt.Sprintf(refSpec,
|
|
|
|
hook.GetPullRequest().GetHead().GetRef(),
|
|
|
|
hook.GetPullRequest().GetBase().GetRef(),
|
|
|
|
),
|
2016-05-03 20:01:16 +00:00
|
|
|
}
|
2022-01-17 22:46:59 +00:00
|
|
|
if merge {
|
2022-10-18 01:24:12 +00:00
|
|
|
pipeline.Ref = fmt.Sprintf(mergeRefs, hook.GetPullRequest().GetNumber())
|
2022-01-17 22:46:59 +00:00
|
|
|
}
|
|
|
|
|
2022-10-18 01:24:12 +00:00
|
|
|
return hook.GetPullRequest(), convertRepo(hook.GetRepo()), pipeline, nil
|
2022-01-17 22:46:59 +00:00
|
|
|
}
|
|
|
|
|
|
|
|
func getChangedFilesFromCommits(commits []*github.HeadCommit) []string {
|
|
|
|
// assume a capacity of 4 changed files per commit
|
|
|
|
files := make([]string, 0, len(commits)*4)
|
|
|
|
for _, cm := range commits {
|
|
|
|
files = append(files, cm.Added...)
|
|
|
|
files = append(files, cm.Removed...)
|
|
|
|
files = append(files, cm.Modified...)
|
2016-05-03 20:01:16 +00:00
|
|
|
}
|
2022-01-17 22:46:59 +00:00
|
|
|
return utils.DedupStrings(files)
|
2016-05-03 20:01:16 +00:00
|
|
|
}
|