mirror of
https://github.com/woodpecker-ci/woodpecker.git
synced 2024-12-12 08:23:48 +02:00
14177635b6
# Summary This PR drops the outdated former swagger.yaml/json and introduced automatic API document generation from Go code. The generated code is also used to generate documentation/markdown for the community page, as well as enable the Woodpecker server to serve a Swagger Web UI for manual tinkering. I did opt-in for gin-swagger, a middleware for the Gin framework, to ease implementation and have a sophisticated output. This middleware only produces Swagger v2 specs. AFAIK the newer OpenApi 3x tooling is not yet that mature, so I guess that's fine for now. ## Implemenation notes - former swagger.json files removed - former // swagger godocs removed - introduced new dependency gin-swagger, which uses godoc annotations on top of Gin Handler functions. - reworked Makefile to automatically generate Go code for the server - introduce new dependency go-swagger, to generate Markdown for documentation purposes - add a Swagger Web UI, incl. capabilities for manual API exploration - consider relative root paths in the implementation - write documentation for all exposed API endpoints - incl. API docs in the community website (auto-generated) - provide developer documentation, for the Woodpecker authors - no other existing logic/code was intentionally changed --------- close #292 --------- Co-authored-by: qwerty287 <80460567+qwerty287@users.noreply.github.com> Co-authored-by: 6543 <6543@obermui.de>
99 lines
2.5 KiB
Go
99 lines
2.5 KiB
Go
// Copyright 2021 Woodpecker Authors
|
|
//
|
|
// 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
|
|
//
|
|
// http://www.apache.org/licenses/LICENSE-2.0
|
|
//
|
|
// 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.
|
|
|
|
package model
|
|
|
|
import (
|
|
"fmt"
|
|
"strings"
|
|
)
|
|
|
|
// TaskStore defines storage for scheduled Tasks.
|
|
type TaskStore interface {
|
|
TaskList() ([]*Task, error)
|
|
TaskInsert(*Task) error
|
|
TaskDelete(string) error
|
|
}
|
|
|
|
// Task defines scheduled pipeline Task.
|
|
type Task struct {
|
|
ID string `json:"id" xorm:"PK UNIQUE 'task_id'"`
|
|
Data []byte `json:"data" xorm:"'task_data'"`
|
|
Labels map[string]string `json:"labels" xorm:"json 'task_labels'"`
|
|
Dependencies []string `json:"dependencies" xorm:"json 'task_dependencies'"`
|
|
RunOn []string `json:"run_on" xorm:"json 'task_run_on'"`
|
|
DepStatus map[string]StatusValue `json:"dep_status" xorm:"json 'task_dep_status'"`
|
|
AgentID int64 `json:"agent_id" xorm:"'agent_id'"`
|
|
} // @name Task
|
|
|
|
// TableName return database table name for xorm
|
|
func (Task) TableName() string {
|
|
return "tasks"
|
|
}
|
|
|
|
func (t *Task) String() string {
|
|
var sb strings.Builder
|
|
sb.WriteString(fmt.Sprintf("%s (%s) - %s", t.ID, t.Dependencies, t.DepStatus))
|
|
return sb.String()
|
|
}
|
|
|
|
// ShouldRun tells if a task should be run or skipped, based on dependencies
|
|
func (t *Task) ShouldRun() bool {
|
|
if t.runsOnFailure() && t.runsOnSuccess() {
|
|
return true
|
|
}
|
|
|
|
if !t.runsOnFailure() && t.runsOnSuccess() {
|
|
for _, status := range t.DepStatus {
|
|
if status != StatusSuccess {
|
|
return false
|
|
}
|
|
}
|
|
return true
|
|
}
|
|
|
|
if t.runsOnFailure() && !t.runsOnSuccess() {
|
|
for _, status := range t.DepStatus {
|
|
if status == StatusSuccess {
|
|
return false
|
|
}
|
|
}
|
|
return true
|
|
}
|
|
|
|
return false
|
|
}
|
|
|
|
func (t *Task) runsOnFailure() bool {
|
|
for _, status := range t.RunOn {
|
|
if status == string(StatusFailure) {
|
|
return true
|
|
}
|
|
}
|
|
return false
|
|
}
|
|
|
|
func (t *Task) runsOnSuccess() bool {
|
|
if len(t.RunOn) == 0 {
|
|
return true
|
|
}
|
|
|
|
for _, status := range t.RunOn {
|
|
if status == string(StatusSuccess) {
|
|
return true
|
|
}
|
|
}
|
|
return false
|
|
}
|