1
0
mirror of https://github.com/woodpecker-ci/woodpecker.git synced 2024-12-12 08:23:48 +02:00
woodpecker/server/api/hook.go

383 lines
11 KiB
Go
Raw Normal View History

2018-02-20 00:24:10 +02:00
// Copyright 2018 Drone.IO Inc.
// Copyright 2021 Informatyka Boguslawski sp. z o.o. sp.k., http://www.ib.pl/
2018-03-21 15:02:17 +02:00
//
2018-02-20 00:24:10 +02: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 15:02:17 +02:00
//
2018-02-20 00:24:10 +02:00
// http://www.apache.org/licenses/LICENSE-2.0
2018-03-21 15:02:17 +02:00
//
2018-02-20 00:24:10 +02: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.
//
// This file has been modified by Informatyka Boguslawski sp. z o.o. sp.k.
2018-02-20 00:24:10 +02:00
package api
2015-04-09 00:43:59 +02:00
import (
2017-03-16 12:14:02 +02:00
"context"
2017-05-05 18:59:37 +02:00
"crypto/sha256"
2017-03-16 12:14:02 +02:00
"encoding/json"
2015-09-30 03:21:17 +02:00
"fmt"
2017-05-12 15:02:24 +02:00
"math/rand"
2019-06-28 08:29:57 +02:00
"net/http"
2017-03-16 12:14:02 +02:00
"regexp"
"strconv"
2017-03-16 12:14:02 +02:00
"time"
"github.com/gin-gonic/gin"
"github.com/rs/zerolog/log"
2017-03-16 12:14:02 +02:00
"github.com/woodpecker-ci/woodpecker/pipeline/frontend/yaml"
"github.com/woodpecker-ci/woodpecker/pipeline/rpc"
"github.com/woodpecker-ci/woodpecker/server"
"github.com/woodpecker-ci/woodpecker/server/model"
"github.com/woodpecker-ci/woodpecker/server/pubsub"
"github.com/woodpecker-ci/woodpecker/server/queue"
"github.com/woodpecker-ci/woodpecker/server/remote"
"github.com/woodpecker-ci/woodpecker/server/shared"
"github.com/woodpecker-ci/woodpecker/server/store"
"github.com/woodpecker-ci/woodpecker/shared/token"
2015-04-09 00:43:59 +02:00
)
2017-03-16 12:14:02 +02:00
var skipRe = regexp.MustCompile(`\[(?i:ci *skip|skip *ci)\]`)
2017-05-12 15:02:24 +02:00
func init() {
rand.Seed(time.Now().UnixNano())
}
2017-03-16 12:14:02 +02:00
func GetQueueInfo(c *gin.Context) {
c.IndentedJSON(200,
server.Config.Services.Queue.Info(c),
2017-03-16 12:14:02 +02:00
)
}
2019-06-28 08:29:57 +02:00
func PauseQueue(c *gin.Context) {
server.Config.Services.Queue.Pause()
2019-06-28 08:29:57 +02:00
c.Status(http.StatusOK)
}
func ResumeQueue(c *gin.Context) {
server.Config.Services.Queue.Resume()
2019-06-28 08:29:57 +02:00
c.Status(http.StatusOK)
}
func BlockTilQueueHasRunningItem(c *gin.Context) {
for {
info := server.Config.Services.Queue.Info(c)
if info.Stats.Running == 0 {
break
}
}
c.Status(http.StatusOK)
}
2015-04-09 00:43:59 +02:00
func PostHook(c *gin.Context) {
_store := store.FromContext(c)
2015-04-09 00:43:59 +02:00
tmpRepo, build, err := server.Config.Services.Remote.Hook(c.Request)
2015-04-09 00:43:59 +02:00
if err != nil {
msg := "failure to parse hook"
log.Debug().Err(err).Msg(msg)
c.String(http.StatusBadRequest, "%s: %v", msg, err)
2015-04-09 00:43:59 +02:00
return
}
2015-09-30 03:21:17 +02:00
if build == nil {
c.String(http.StatusOK, "ignoring hook: hook parsing resulted in empty build")
2015-04-09 00:43:59 +02:00
return
}
if tmpRepo == nil {
c.String(http.StatusBadRequest, "failure to ascertain repo from hook")
2015-04-09 00:43:59 +02:00
return
}
// skip the build if any case-insensitive combination of the words "skip" and "ci"
// wrapped in square brackets appear in the commit message
skipMatch := skipRe.FindString(build.Message)
if len(skipMatch) > 0 {
msg := fmt.Sprintf("ignoring hook: %s found in %s", skipMatch, build.Commit)
log.Debug().Msg(msg)
c.String(http.StatusNoContent, msg)
2015-04-09 00:43:59 +02:00
return
}
repo, err := _store.GetRepoName(tmpRepo.Owner + "/" + tmpRepo.Name)
2015-04-09 00:43:59 +02:00
if err != nil {
msg := fmt.Sprintf("failure to get repo %s/%s from store", tmpRepo.Owner, tmpRepo.Name)
log.Error().Err(err).Msg(msg)
c.String(http.StatusNotFound, "%s: %v", msg, err)
2015-04-09 00:43:59 +02:00
return
}
2017-07-14 21:58:38 +02:00
if !repo.IsActive {
c.String(204, "ignoring hook: %s/%s is inactive.", tmpRepo.Owner, tmpRepo.Name)
2017-07-14 21:58:38 +02:00
return
}
2015-04-09 00:43:59 +02:00
// get the token and verify the hook is authorized
parsed, err := token.ParseRequest(c.Request, func(_ *token.Token) (string, error) {
return repo.Hash, nil
})
if err != nil {
msg := fmt.Sprintf("failure to parse token from hook for %s", repo.FullName)
log.Error().Err(err).Msg(msg)
c.String(http.StatusBadRequest, "%s: %v", msg, err)
return
}
if parsed.Text != repo.FullName {
msg := fmt.Sprintf("failure to verify token from hook. Expected %s, got %s", repo.FullName, parsed.Text)
log.Debug().Msg(msg)
c.String(http.StatusForbidden, msg)
return
}
2015-09-30 03:21:17 +02:00
if repo.UserID == 0 {
msg := fmt.Sprintf("ignoring hook. repo %s has no owner.", repo.FullName)
log.Warn().Msg(msg)
c.String(http.StatusNoContent, msg)
return
2015-09-30 03:21:17 +02:00
}
if build.Event == model.EventPull && !repo.AllowPull {
msg := "ignoring hook: pull requests are disabled for this repo in woodpecker"
log.Debug().Str("repo", repo.FullName).Msg(msg)
c.String(http.StatusNoContent, msg)
2015-04-09 00:43:59 +02:00
return
}
repoUser, err := _store.GetUser(repo.UserID)
2015-04-09 00:43:59 +02:00
if err != nil {
log.Error().Err(err).Str("repo", repo.FullName).Msgf("failure to find repo owner via id '%d'", repo.UserID)
_ = c.AbortWithError(http.StatusInternalServerError, err)
2015-04-09 00:43:59 +02:00
return
}
// if the remote has a refresh token, the current access token
// may be stale. Therefore, we should refresh prior to dispatching
2017-04-02 16:13:26 +02:00
// the build.
if refresher, ok := server.Config.Services.Remote.(remote.Refresher); ok {
refreshed, err := refresher.Refresh(c, repoUser)
if err != nil {
log.Error().Err(err).Msgf("failed to refresh oauth2 token for repoUser: %s", repoUser.Login)
} else if refreshed {
if err := _store.UpdateUser(repoUser); err != nil {
log.Error().Err(err).Msgf("error while updating repoUser: %s", repoUser.Login)
// move forward
}
}
}
2019-06-01 12:52:02 +02:00
// fetch the build file from the remote
configFetcher := shared.NewConfigFetcher(server.Config.Services.Remote, repoUser, repo, build)
remoteYamlConfigs, err := configFetcher.Fetch(c)
2015-04-09 00:43:59 +02:00
if err != nil {
msg := fmt.Sprintf("cannot find '%s' in '%s', context user: '%s'", repo.Config, build.Ref, repoUser.Login)
log.Debug().Err(err).Str("repo", repo.FullName).Msg(msg)
c.String(http.StatusNotFound, "%s: %v", msg, err)
2015-04-09 00:43:59 +02:00
return
}
2019-09-09 09:53:54 +02:00
filtered, err := branchFiltered(build, remoteYamlConfigs)
if err != nil {
msg := "failure to parse yaml from hook"
log.Debug().Err(err).Str("repo", repo.FullName).Msg(msg)
c.String(http.StatusBadRequest, "%s: %v", msg, err)
2019-09-09 09:53:54 +02:00
}
if filtered {
msg := "ignoring hook: branch does not match restrictions defined in yaml"
log.Debug().Str("repo", repo.FullName).Msg(msg)
c.String(200, msg)
2019-06-19 09:36:54 +02:00
return
}
2019-07-22 13:43:18 +02:00
if zeroSteps(build, remoteYamlConfigs) {
msg := "ignoring hook: step conditions yield zero runnable steps"
log.Debug().Str("repo", repo.FullName).Msg(msg)
c.String(200, msg)
return
}
// update some build fields
build.RepoID = repo.ID
build.Verified = true
build.Status = model.StatusPending
// TODO(336) extend gated feature with an allow/block List
if repo.IsGated && build.Sender != repoUser.Login {
2019-07-18 14:21:05 +02:00
build.Status = model.StatusBlocked
}
err = _store.CreateBuild(build, build.Procs...)
if err != nil {
log.Error().Err(err).Msgf("failure to save commit for %s", repo.FullName)
_ = c.AbortWithError(http.StatusInternalServerError, err)
2015-04-24 23:25:03 +02:00
return
}
// persist the build config for historical correctness, restarts, etc
for _, remoteYamlConfig := range remoteYamlConfigs {
_, err := findOrPersistPipelineConfig(repo, build, remoteYamlConfig)
if err != nil {
log.Error().Err(err).Msgf("failure to find or persist build config for %s", repo.FullName)
_ = c.AbortWithError(http.StatusInternalServerError, err)
return
}
}
if build.Status == model.StatusBlocked {
c.JSON(200, build)
return
}
2017-03-18 13:25:53 +02:00
build, err = startBuild(c, _store, build, repoUser, repo, remoteYamlConfigs)
2017-05-19 23:36:08 +02:00
if err != nil {
c.String(http.StatusInternalServerError, fmt.Sprintf("startBuild: %v", err))
}
c.JSON(200, build)
2019-06-01 10:08:41 +02:00
}
// TODO: parse yaml once and not for each filter function
2019-09-09 09:53:54 +02:00
func branchFiltered(build *model.Build, remoteYamlConfigs []*remote.FileMeta) (bool, error) {
log.Trace().Msgf("hook.branchFiltered(): build branch: '%s' build event: '%s' config count: %d", build.Branch, build.Event, len(remoteYamlConfigs))
2019-06-19 09:36:54 +02:00
for _, remoteYamlConfig := range remoteYamlConfigs {
parsedPipelineConfig, err := yaml.ParseString(string(remoteYamlConfig.Data))
2019-09-09 09:53:54 +02:00
if err != nil {
log.Trace().Msgf("parse config '%s': %s", remoteYamlConfig.Name, err)
2019-09-09 09:53:54 +02:00
return false, err
}
log.Trace().Msgf("config '%s': %#v", remoteYamlConfig.Name, parsedPipelineConfig)
2019-09-09 09:53:54 +02:00
if !parsedPipelineConfig.Branches.Match(build.Branch) && build.Event != model.EventTag && build.Event != model.EventDeploy {
} else {
return false, nil
2019-06-19 09:36:54 +02:00
}
}
2019-09-09 09:53:54 +02:00
return true, nil
2019-06-19 09:36:54 +02:00
}
2019-07-22 13:43:18 +02:00
func zeroSteps(build *model.Build, remoteYamlConfigs []*remote.FileMeta) bool {
b := shared.ProcBuilder{
Repo: &model.Repo{},
2019-07-22 13:43:18 +02:00
Curr: build,
Last: &model.Build{},
Netrc: &model.Netrc{},
Secs: []*model.Secret{},
Regs: []*model.Registry{},
Link: "",
Yamls: remoteYamlConfigs,
}
buildItems, err := b.Build()
if err != nil {
return false
}
if len(buildItems) == 0 {
return true
}
return false
}
func findOrPersistPipelineConfig(repo *model.Repo, build *model.Build, remoteYamlConfig *remote.FileMeta) (*model.Config, error) {
2019-06-13 17:38:19 +02:00
sha := shasum(remoteYamlConfig.Data)
conf, err := server.Config.Storage.Config.ConfigFindIdentical(build.RepoID, sha)
2019-06-01 12:52:02 +02:00
if err != nil {
conf = &model.Config{
RepoID: build.RepoID,
Data: remoteYamlConfig.Data,
2019-06-01 12:52:02 +02:00
Hash: sha,
Name: shared.SanitizePath(remoteYamlConfig.Name),
2019-06-01 12:52:02 +02:00
}
err = server.Config.Storage.Config.ConfigCreate(conf)
2019-06-01 12:52:02 +02:00
if err != nil {
// retry in case we receive two hooks at the same time
conf, err = server.Config.Storage.Config.ConfigFindIdentical(build.RepoID, sha)
2019-06-01 12:52:02 +02:00
if err != nil {
return nil, err
}
}
}
buildConfig := &model.BuildConfig{
ConfigID: conf.ID,
BuildID: build.ID,
}
err = server.Config.Storage.Config.BuildConfigCreate(buildConfig)
if err != nil {
return nil, err
}
2019-06-01 12:52:02 +02:00
return conf, nil
}
2019-06-13 17:38:19 +02:00
// publishes message to UI clients
func publishToTopic(c context.Context, build *model.Build, repo *model.Repo, event model.EventType) (err error) {
2017-03-16 12:14:02 +02:00
message := pubsub.Message{
Labels: map[string]string{
"repo": repo.FullName,
"private": strconv.FormatBool(repo.IsSCMPrivate),
2017-03-16 12:14:02 +02:00
},
}
2017-04-04 11:30:06 +02:00
buildCopy := *build
if buildCopy.Procs, err = model.Tree(buildCopy.Procs); err != nil {
return err
}
2017-03-16 12:14:02 +02:00
message.Data, _ = json.Marshal(model.Event{
2016-09-28 03:30:28 +02:00
Type: model.Enqueued,
Repo: *repo,
2017-04-04 11:30:06 +02:00
Build: buildCopy,
2017-03-16 12:14:02 +02:00
})
return server.Config.Services.Pubsub.Publish(c, "topic/events", message)
2019-06-01 10:08:41 +02:00
}
func queueBuild(build *model.Build, repo *model.Repo, buildItems []*shared.BuildItem) error {
2019-06-13 17:38:19 +02:00
var tasks []*queue.Task
2019-06-01 10:08:41 +02:00
for _, item := range buildItems {
2019-06-19 09:36:54 +02:00
if item.Proc.State == model.StatusSkipped {
continue
}
2017-03-16 12:14:02 +02:00
task := new(queue.Task)
2017-04-02 16:13:26 +02:00
task.ID = fmt.Sprint(item.Proc.ID)
2017-03-16 12:14:02 +02:00
task.Labels = map[string]string{}
for k, v := range item.Labels {
task.Labels[k] = v
}
task.Labels["platform"] = item.Platform
2019-06-01 10:08:41 +02:00
task.Labels["repo"] = repo.FullName
2019-06-13 17:38:19 +02:00
task.Dependencies = taskIds(item.DependsOn, buildItems)
task.RunOn = item.RunsOn
task.DepStatus = make(map[string]string)
2017-03-16 12:14:02 +02:00
task.Data, _ = json.Marshal(rpc.Pipeline{
2017-04-02 16:13:26 +02:00
ID: fmt.Sprint(item.Proc.ID),
2017-03-16 12:14:02 +02:00
Config: item.Config,
2019-06-01 10:08:41 +02:00
Timeout: repo.Timeout,
2017-03-16 12:14:02 +02:00
})
if err := server.Config.Services.Logs.Open(context.Background(), task.ID); err != nil {
return err
}
2019-06-13 17:38:19 +02:00
tasks = append(tasks, task)
}
return server.Config.Services.Queue.PushAtOnce(context.Background(), tasks)
2019-06-13 17:38:19 +02:00
}
func taskIds(dependsOn []string, buildItems []*shared.BuildItem) (taskIds []string) {
2019-06-13 17:38:19 +02:00
for _, dep := range dependsOn {
for _, buildItem := range buildItems {
if buildItem.Proc.Name == dep {
taskIds = append(taskIds, fmt.Sprint(buildItem.Proc.ID))
}
}
}
return
2017-03-05 09:56:08 +02:00
}
2017-03-16 13:00:56 +02:00
2017-05-05 18:59:37 +02:00
func shasum(raw []byte) string {
sum := sha256.Sum256(raw)
return fmt.Sprintf("%x", sum)
}