Add workflow version (#2476)

Closes #1834

---------

Co-authored-by: 6543 <6543@obermui.de>
Co-authored-by: Anbraten <anton@ju60.de>
Co-authored-by: Lauris BH <lauris@nix.lv>
This commit is contained in:
qwerty287 2023-11-06 01:37:02 +01:00 committed by GitHub
parent 9e0e62a757
commit 1bc4415075
No known key found for this signature in database
GPG key ID: 4AEE18F83AFDEB23
35 changed files with 153 additions and 4 deletions

View file

@ -1,3 +1,5 @@
version: 1
depends_on: depends_on:
- test - test
- web - web

View file

@ -1,3 +1,5 @@
version: 1
when: when:
- event: [pull_request, tag] - event: [pull_request, tag]
- event: push - event: push

View file

@ -1,3 +1,5 @@
version: 1
when: when:
- event: tag - event: tag
- event: pull_request - event: pull_request

View file

@ -1,3 +1,5 @@
version: 1
steps: steps:
release-helper: release-helper:
image: woodpeckerci/plugin-ready-release-go:0.7.0 image: woodpeckerci/plugin-ready-release-go:0.7.0

View file

@ -1,3 +1,5 @@
version: 1
when: when:
- event: [pull_request, cron] - event: [pull_request, cron]
- event: push - event: push

View file

@ -1,3 +1,5 @@
version: 1
when: when:
- event: [pull_request, tag] - event: [pull_request, tag]
- event: push - event: push

View file

@ -1,3 +1,5 @@
version: 1
when: when:
- event: [pull_request, tag] - event: [pull_request, tag]
- event: push - event: push

View file

@ -1,3 +1,4 @@
version: 1
steps: steps:
demo: demo:
image: 'alpine' image: 'alpine'

View file

@ -1,3 +1,4 @@
version: 1
steps: steps:
test_1: test_1:
image: 'alpine' image: 'alpine'

View file

@ -26,6 +26,7 @@ import (
func TestLint(t *testing.T) { func TestLint(t *testing.T) {
testdatas := []struct{ Title, Data string }{{ testdatas := []struct{ Title, Data string }{{
Title: "map", Data: ` Title: "map", Data: `
version: 1
steps: steps:
build: build:
image: docker image: docker
@ -45,6 +46,7 @@ services:
`, `,
}, { }, {
Title: "list", Data: ` Title: "list", Data: `
version: 1
steps: steps:
- name: build - name: build
image: docker image: docker
@ -61,6 +63,7 @@ steps:
`, `,
}, { }, {
Title: "merge maps", Data: ` Title: "merge maps", Data: `
version: 1
variables: variables:
step_template: &base-step step_template: &base-step
image: golang:1.19 image: golang:1.19
@ -155,7 +158,7 @@ func TestLintErrors(t *testing.T) {
} }
for _, test := range testdata { for _, test := range testdata {
conf, err := yaml.ParseString(test.from) conf, err := yaml.ParseString("version: 1\n" + test.from)
if err != nil { if err != nil {
t.Fatalf("Cannot unmarshal yaml %q. Error: %s", test.from, err) t.Fatalf("Cannot unmarshal yaml %q. Error: %s", test.from, err)
} }

View file

@ -1,3 +1,5 @@
version: 1
branches: [main, pages] branches: [main, pages]
steps: steps:

View file

@ -1,3 +1,5 @@
version: 1
branches: branches:
include: main include: main
exclude: [develop, feature/*] exclude: [develop, feature/*]

View file

@ -1,3 +1,5 @@
version: 1
branches: main branches: main
steps: steps:

View file

@ -1,3 +1,5 @@
version: 1
branches: main branches: main
matri: matri:

View file

@ -1,3 +1,5 @@
version: 1
steps: steps:
test: test:
image: alpine image: alpine

View file

@ -1,3 +1,5 @@
version: 1
clone: clone:
git: git:
image: plugins/git:next image: plugins/git:next

View file

@ -1,3 +1,5 @@
version: 1
labels: labels:
location: europe location: europe
weather: sun weather: sun

View file

@ -1,3 +1,5 @@
version: 1
steps: steps:
test: test:
image: golang:${GO_VERSION} image: golang:${GO_VERSION}

View file

@ -1,3 +1,5 @@
version: 1
variables: variables:
step_template: &base-step step_template: &base-step
image: golang:1.19 image: golang:1.19

View file

@ -1,3 +1,5 @@
version: 1
steps: steps:
deploy: deploy:
image: golang image: golang

View file

@ -1,3 +1,5 @@
version: 1
when: when:
- branch: [main, deploy] - branch: [main, deploy]
event: push event: push

View file

@ -1,3 +1,5 @@
version: 1
platform: linux/amd64 platform: linux/amd64
steps: steps:

View file

@ -1,3 +1,5 @@
version: 1
steps: steps:
build: build:
image: golang image: golang

View file

@ -1,3 +1,5 @@
version: 1
steps: steps:
build: build:
image: golang image: golang

View file

@ -1,3 +1,5 @@
version: 1
steps: steps:
build: build:
image: golang image: golang

View file

@ -1,3 +1,5 @@
version: 1
steps: steps:
image: image:
image: golang image: golang

View file

@ -1,3 +1,5 @@
version: 1
steps: steps:
when-branch: when-branch:
image: alpine image: alpine

View file

@ -1,3 +1,5 @@
version: 1
workspace: workspace:
base: /go base: /go
path: src/github.com/octocat/hello-world path: src/github.com/octocat/hello-world

View file

@ -34,7 +34,8 @@
"type": "array", "type": "array",
"minLength": 1, "minLength": 1,
"items": { "type": "string" } "items": { "type": "string" }
} },
"version": { "type": "number", "default": 1 }
}, },
"definitions": { "definitions": {
"clone": { "clone": {

View file

@ -15,6 +15,7 @@
package yaml package yaml
import ( import (
"errors"
"fmt" "fmt"
"codeberg.org/6543/xyaml" "codeberg.org/6543/xyaml"
@ -22,16 +23,27 @@ import (
"github.com/woodpecker-ci/woodpecker/pipeline/frontend/yaml/constraint" "github.com/woodpecker-ci/woodpecker/pipeline/frontend/yaml/constraint"
"github.com/woodpecker-ci/woodpecker/pipeline/frontend/yaml/types" "github.com/woodpecker-ci/woodpecker/pipeline/frontend/yaml/types"
"github.com/woodpecker-ci/woodpecker/pipeline/frontend/yaml/types/base" "github.com/woodpecker-ci/woodpecker/pipeline/frontend/yaml/types/base"
"github.com/woodpecker-ci/woodpecker/shared/constant"
) )
var ErrUnsuportedVersion = errors.New("unsuported pipeline config version detected")
// ParseBytes parses the configuration from bytes b. // ParseBytes parses the configuration from bytes b.
func ParseBytes(b []byte) (*types.Workflow, error) { func ParseBytes(b []byte) (*types.Workflow, error) {
out := new(types.Workflow) yamlVersion, err := checkVersion(b)
err := xyaml.Unmarshal(b, out)
if err != nil { if err != nil {
return nil, err return nil, err
} }
out := new(types.Workflow)
err = xyaml.Unmarshal(b, out)
if err != nil {
return nil, err
}
// make sure detected version is set
out.Version = yamlVersion
// support deprecated branch filter // support deprecated branch filter
if out.BranchesDontUseIt != nil { if out.BranchesDontUseIt != nil {
if out.When.Constraints == nil { if out.When.Constraints == nil {
@ -70,3 +82,19 @@ func ParseString(s string) (*types.Workflow, error) {
[]byte(s), []byte(s),
) )
} }
func checkVersion(b []byte) (int, error) {
ver := struct {
Version int `yaml:"version"`
}{}
_ = xyaml.Unmarshal(b, &ver)
if ver.Version == 0 {
// default: version 1
return constant.DefaultPipelineVersion, nil
}
if ver.Version != Version {
return 0, ErrUnsuportedVersion
}
return ver.Version, nil
}

View file

@ -88,6 +88,16 @@ func TestParse(t *testing.T) {
g.Assert(out.Steps.ContainerList[1].When.Constraints[0].Event.Include).Equal([]string{"success"}) g.Assert(out.Steps.ContainerList[1].When.Constraints[0].Event.Include).Equal([]string{"success"})
}) })
g.It("Should unmarshal with default version", func() {
out, err := ParseString(sampleYamlDefaultVersion)
if err != nil {
g.Fail(err)
}
g.Assert(len(out.Steps.ContainerList)).Equal(1)
g.Assert(out.Steps.ContainerList[0].Name).Equal("notify_success")
g.Assert(out.Steps.ContainerList[0].Image).Equal("xyz")
})
matchConfig, err := ParseString(sampleYaml) matchConfig, err := ParseString(sampleYaml)
if err != nil { if err != nil {
g.Fail(err) g.Fail(err)
@ -180,6 +190,7 @@ pipeline:
} }
var sampleYaml = ` var sampleYaml = `
version: 1
image: hello-world image: hello-world
when: when:
- event: - event:
@ -231,7 +242,14 @@ runs_on:
- failure - failure
` `
var sampleYamlDefaultVersion = `
steps:
- name: notify_success
image: xyz
`
var simpleYamlAnchors = ` var simpleYamlAnchors = `
version: 1
vars: vars:
image: &image plugins/slack image: &image plugins/slack
steps: steps:
@ -240,6 +258,7 @@ steps:
` `
var sampleVarYaml = ` var sampleVarYaml = `
version: 1
_slack: &SLACK _slack: &SLACK
image: plugins/slack image: plugins/slack
steps: steps:

View file

@ -31,6 +31,7 @@ type (
DependsOn []string `yaml:"depends_on,omitempty"` DependsOn []string `yaml:"depends_on,omitempty"`
RunsOn []string `yaml:"runs_on,omitempty"` RunsOn []string `yaml:"runs_on,omitempty"`
SkipClone bool `yaml:"skip_clone"` SkipClone bool `yaml:"skip_clone"`
Version int `yaml:"version"`
// Undocumented // Undocumented
Cache base.StringOrSlice `yaml:"cache,omitempty"` Cache base.StringOrSlice `yaml:"cache,omitempty"`

View file

@ -0,0 +1,18 @@
// Copyright 2023 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 yaml
// Version of this package and it's subpackages
const Version = 1

View file

@ -47,6 +47,7 @@ func TestGlobalEnvsubst(t *testing.T) {
Link: "", Link: "",
Yamls: []*forge_types.FileMeta{ Yamls: []*forge_types.FileMeta{
{Data: []byte(` {Data: []byte(`
version: 1
steps: steps:
build: build:
image: ${IMAGE} image: ${IMAGE}
@ -83,6 +84,7 @@ func TestMissingGlobalEnvsubst(t *testing.T) {
Link: "", Link: "",
Yamls: []*forge_types.FileMeta{ Yamls: []*forge_types.FileMeta{
{Data: []byte(` {Data: []byte(`
version: 1
steps: steps:
build: build:
image: ${IMAGE} image: ${IMAGE}
@ -116,6 +118,7 @@ bbb`,
Link: "", Link: "",
Yamls: []*forge_types.FileMeta{ Yamls: []*forge_types.FileMeta{
{Data: []byte(` {Data: []byte(`
version: 1
steps: steps:
xxx: xxx:
image: scratch image: scratch
@ -123,6 +126,7 @@ steps:
yyy: ${CI_COMMIT_MESSAGE} yyy: ${CI_COMMIT_MESSAGE}
`)}, `)},
{Data: []byte(` {Data: []byte(`
version: 1
steps: steps:
build: build:
image: scratch image: scratch
@ -153,11 +157,13 @@ func TestMultiPipeline(t *testing.T) {
Link: "", Link: "",
Yamls: []*forge_types.FileMeta{ Yamls: []*forge_types.FileMeta{
{Data: []byte(` {Data: []byte(`
version: 1
steps: steps:
xxx: xxx:
image: scratch image: scratch
`)}, `)},
{Data: []byte(` {Data: []byte(`
version: 1
steps: steps:
build: build:
image: scratch image: scratch
@ -188,16 +194,19 @@ func TestDependsOn(t *testing.T) {
Link: "", Link: "",
Yamls: []*forge_types.FileMeta{ Yamls: []*forge_types.FileMeta{
{Name: "lint", Data: []byte(` {Name: "lint", Data: []byte(`
version: 1
steps: steps:
build: build:
image: scratch image: scratch
`)}, `)},
{Name: "test", Data: []byte(` {Name: "test", Data: []byte(`
version: 1
steps: steps:
build: build:
image: scratch image: scratch
`)}, `)},
{Data: []byte(` {Data: []byte(`
version: 1
steps: steps:
deploy: deploy:
image: scratch image: scratch
@ -235,6 +244,7 @@ func TestRunsOn(t *testing.T) {
Link: "", Link: "",
Yamls: []*forge_types.FileMeta{ Yamls: []*forge_types.FileMeta{
{Data: []byte(` {Data: []byte(`
version: 1
steps: steps:
deploy: deploy:
image: scratch image: scratch
@ -272,11 +282,13 @@ func TestPipelineName(t *testing.T) {
Link: "", Link: "",
Yamls: []*forge_types.FileMeta{ Yamls: []*forge_types.FileMeta{
{Name: ".woodpecker/lint.yml", Data: []byte(` {Name: ".woodpecker/lint.yml", Data: []byte(`
version: 1
steps: steps:
build: build:
image: scratch image: scratch
`)}, `)},
{Name: ".woodpecker/.test.yml", Data: []byte(` {Name: ".woodpecker/.test.yml", Data: []byte(`
version: 1
steps: steps:
build: build:
image: scratch image: scratch
@ -308,12 +320,14 @@ func TestBranchFilter(t *testing.T) {
Link: "", Link: "",
Yamls: []*forge_types.FileMeta{ Yamls: []*forge_types.FileMeta{
{Data: []byte(` {Data: []byte(`
version: 1
steps: steps:
xxx: xxx:
image: scratch image: scratch
branches: main branches: main
`)}, `)},
{Data: []byte(` {Data: []byte(`
version: 1
steps: steps:
build: build:
image: scratch image: scratch
@ -347,6 +361,7 @@ func TestRootWhenFilter(t *testing.T) {
Link: "", Link: "",
Yamls: []*forge_types.FileMeta{ Yamls: []*forge_types.FileMeta{
{Data: []byte(` {Data: []byte(`
version: 1
when: when:
event: event:
- tag - tag
@ -355,6 +370,7 @@ steps:
image: scratch image: scratch
`)}, `)},
{Data: []byte(` {Data: []byte(`
version: 1
when: when:
event: event:
- push - push
@ -363,6 +379,7 @@ steps:
image: scratch image: scratch
`)}, `)},
{Data: []byte(` {Data: []byte(`
version: 1
steps: steps:
build: build:
image: scratch image: scratch
@ -396,6 +413,7 @@ func TestZeroSteps(t *testing.T) {
Link: "", Link: "",
Yamls: []*forge_types.FileMeta{ Yamls: []*forge_types.FileMeta{
{Data: []byte(` {Data: []byte(`
version: 1
skip_clone: true skip_clone: true
steps: steps:
build: build:
@ -431,6 +449,7 @@ func TestZeroStepsAsMultiPipelineDeps(t *testing.T) {
Link: "", Link: "",
Yamls: []*forge_types.FileMeta{ Yamls: []*forge_types.FileMeta{
{Name: "zerostep", Data: []byte(` {Name: "zerostep", Data: []byte(`
version: 1
skip_clone: true skip_clone: true
steps: steps:
build: build:
@ -439,11 +458,13 @@ steps:
image: scratch image: scratch
`)}, `)},
{Name: "justastep", Data: []byte(` {Name: "justastep", Data: []byte(`
version: 1
steps: steps:
build: build:
image: scratch image: scratch
`)}, `)},
{Name: "shouldbefiltered", Data: []byte(` {Name: "shouldbefiltered", Data: []byte(`
version: 1
steps: steps:
build: build:
image: scratch image: scratch
@ -480,6 +501,7 @@ func TestZeroStepsAsMultiPipelineTransitiveDeps(t *testing.T) {
Link: "", Link: "",
Yamls: []*forge_types.FileMeta{ Yamls: []*forge_types.FileMeta{
{Name: "zerostep", Data: []byte(` {Name: "zerostep", Data: []byte(`
version: 1
skip_clone: true skip_clone: true
steps: steps:
build: build:
@ -488,17 +510,20 @@ steps:
image: scratch image: scratch
`)}, `)},
{Name: "justastep", Data: []byte(` {Name: "justastep", Data: []byte(`
version: 1
steps: steps:
build: build:
image: scratch image: scratch
`)}, `)},
{Name: "shouldbefiltered", Data: []byte(` {Name: "shouldbefiltered", Data: []byte(`
version: 1
steps: steps:
build: build:
image: scratch image: scratch
depends_on: [ zerostep ] depends_on: [ zerostep ]
`)}, `)},
{Name: "shouldbefilteredtoo", Data: []byte(` {Name: "shouldbefilteredtoo", Data: []byte(`
version: 1
steps: steps:
build: build:
image: scratch image: scratch

View file

@ -40,3 +40,5 @@ var TrustedCloneImages = []string{
DefaultCloneImage, DefaultCloneImage,
"quay.io/woodpeckerci/plugin-git", "quay.io/woodpeckerci/plugin-git",
} }
const DefaultPipelineVersion = 1