woodpecker/server/pipeline/stepbuilder/stepBuilder_test.go
6543 fcc57dfc38
Replay pipeline using cli exec by downloading metadata (#4103)
Co-authored-by: Anbraten <6918444+anbraten@users.noreply.github.com>
2024-09-25 07:20:51 +02:00

632 lines
12 KiB
Go

// Copyright 2022 Woodpecker Authors
// Copyright 2018 Drone.IO Inc.
//
// 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 stepbuilder
import (
"fmt"
"testing"
"github.com/stretchr/testify/assert"
"go.woodpecker-ci.org/woodpecker/v2/pipeline/errors"
"go.woodpecker-ci.org/woodpecker/v2/server/forge"
"go.woodpecker-ci.org/woodpecker/v2/server/forge/mocks"
forge_types "go.woodpecker-ci.org/woodpecker/v2/server/forge/types"
"go.woodpecker-ci.org/woodpecker/v2/server/model"
)
func TestGlobalEnvsubst(t *testing.T) {
t.Parallel()
b := StepBuilder{
Forge: getMockForge(t),
Envs: map[string]string{
"KEY_K": "VALUE_V",
"IMAGE": "scratch",
},
Repo: &model.Repo{},
Curr: &model.Pipeline{
Message: "aaa",
Event: model.EventPush,
},
Prev: &model.Pipeline{},
Netrc: &model.Netrc{},
Secs: []*model.Secret{},
Regs: []*model.Registry{},
Host: "",
Yamls: []*forge_types.FileMeta{
{Data: []byte(`
when:
event: push
steps:
build:
image: ${IMAGE}
settings:
yyy: ${CI_COMMIT_MESSAGE}
`)},
},
}
if pipelineItems, err := b.Build(); err != nil {
t.Fatal(err)
} else {
fmt.Println(pipelineItems)
}
}
func TestMissingGlobalEnvsubst(t *testing.T) {
t.Parallel()
b := StepBuilder{
Forge: getMockForge(t),
Envs: map[string]string{
"KEY_K": "VALUE_V",
"NO_IMAGE": "scratch",
},
Repo: &model.Repo{},
Curr: &model.Pipeline{
Message: "aaa",
Event: model.EventPush,
},
Prev: &model.Pipeline{},
Netrc: &model.Netrc{},
Secs: []*model.Secret{},
Regs: []*model.Registry{},
Host: "",
Yamls: []*forge_types.FileMeta{
{Data: []byte(`
when:
event: push
steps:
build:
image: ${IMAGE}
settings:
yyy: ${CI_COMMIT_MESSAGE}
`)},
},
}
if _, err := b.Build(); err != nil {
fmt.Println("test rightfully failed")
} else {
t.Fatal("test erroneously succeeded")
}
}
func TestMultilineEnvsubst(t *testing.T) {
t.Parallel()
b := StepBuilder{
Forge: getMockForge(t),
Repo: &model.Repo{},
Curr: &model.Pipeline{
Message: `aaa
bbb`,
},
Prev: &model.Pipeline{},
Netrc: &model.Netrc{},
Secs: []*model.Secret{},
Regs: []*model.Registry{},
Host: "",
Yamls: []*forge_types.FileMeta{
{Data: []byte(`
when:
event: push
steps:
xxx:
image: scratch
settings:
yyy: ${CI_COMMIT_MESSAGE}
`)},
{Data: []byte(`
when:
event: push
steps:
build:
image: scratch
settings:
yyy: ${CI_COMMIT_MESSAGE}
`)},
},
}
if pipelineItems, err := b.Build(); err != nil {
t.Fatal(err)
} else {
fmt.Println(pipelineItems)
}
}
func TestMultiPipeline(t *testing.T) {
t.Parallel()
b := StepBuilder{
Forge: getMockForge(t),
Repo: &model.Repo{},
Curr: &model.Pipeline{
Event: model.EventPush,
},
Prev: &model.Pipeline{},
Netrc: &model.Netrc{},
Secs: []*model.Secret{},
Regs: []*model.Registry{},
Host: "",
Yamls: []*forge_types.FileMeta{
{Data: []byte(`
when:
event: push
steps:
xxx:
image: scratch
`)},
{Data: []byte(`
when:
event: push
steps:
build:
image: scratch
`)},
},
}
pipelineItems, err := b.Build()
if err != nil {
t.Fatal(err)
}
if len(pipelineItems) != 2 {
t.Fatal("Should have generated 2 pipelineItems")
}
}
func TestDependsOn(t *testing.T) {
t.Parallel()
b := StepBuilder{
Forge: getMockForge(t),
Repo: &model.Repo{},
Curr: &model.Pipeline{
Event: model.EventPush,
},
Prev: &model.Pipeline{},
Netrc: &model.Netrc{},
Secs: []*model.Secret{},
Regs: []*model.Registry{},
Host: "",
Yamls: []*forge_types.FileMeta{
{Name: "lint", Data: []byte(`
when:
event: push
steps:
build:
image: scratch
`)},
{Name: "test", Data: []byte(`
when:
event: push
steps:
build:
image: scratch
`)},
{Data: []byte(`
when:
event: push
steps:
deploy:
image: scratch
depends_on:
- lint
- test
`)},
},
}
pipelineItems, err := b.Build()
if err != nil {
t.Fatal(err)
}
if len(pipelineItems[0].DependsOn) != 2 {
t.Fatal("Should have 3 dependencies")
}
if pipelineItems[0].DependsOn[1] != "test" {
t.Fatal("Should depend on test")
}
}
func TestRunsOn(t *testing.T) {
t.Parallel()
b := StepBuilder{
Forge: getMockForge(t),
Repo: &model.Repo{},
Curr: &model.Pipeline{
Event: model.EventPush,
},
Prev: &model.Pipeline{},
Netrc: &model.Netrc{},
Secs: []*model.Secret{},
Regs: []*model.Registry{},
Host: "",
Yamls: []*forge_types.FileMeta{
{Data: []byte(`
when:
event: push
steps:
deploy:
image: scratch
runs_on:
- success
- failure
`)},
},
}
pipelineItems, err := b.Build()
if err != nil {
t.Fatal(err)
}
if len(pipelineItems[0].RunsOn) != 2 {
t.Fatal("Should run on success and failure")
}
if pipelineItems[0].RunsOn[1] != "failure" {
t.Fatal("Should run on failure")
}
}
func TestPipelineName(t *testing.T) {
t.Parallel()
b := StepBuilder{
Forge: getMockForge(t),
Repo: &model.Repo{Config: ".woodpecker"},
Curr: &model.Pipeline{
Event: model.EventPush,
},
Prev: &model.Pipeline{},
Netrc: &model.Netrc{},
Secs: []*model.Secret{},
Regs: []*model.Registry{},
Host: "",
Yamls: []*forge_types.FileMeta{
{Name: ".woodpecker/lint.yml", Data: []byte(`
when:
event: push
steps:
build:
image: scratch
`)},
{Name: ".woodpecker/.test.yml", Data: []byte(`
when:
event: push
steps:
build:
image: scratch
`)},
},
}
pipelineItems, err := b.Build()
if err != nil {
t.Fatal(err)
}
pipelineNames := []string{pipelineItems[0].Workflow.Name, pipelineItems[1].Workflow.Name}
if !containsItemWithName("lint", pipelineItems) || !containsItemWithName("test", pipelineItems) {
t.Fatalf("Pipeline name should be 'lint' and 'test' but are '%v'", pipelineNames)
}
}
func TestBranchFilter(t *testing.T) {
t.Parallel()
b := StepBuilder{
Forge: getMockForge(t),
Repo: &model.Repo{},
Curr: &model.Pipeline{
Branch: "dev",
Event: model.EventPush,
},
Prev: &model.Pipeline{},
Netrc: &model.Netrc{},
Secs: []*model.Secret{},
Regs: []*model.Registry{},
Host: "",
Yamls: []*forge_types.FileMeta{
{Data: []byte(`
when:
event: push
branch: main
steps:
xxx:
image: scratch
`)},
{Data: []byte(`
when:
event: push
steps:
build:
image: scratch
`)},
},
}
pipelineItems, err := b.Build()
if err != nil {
t.Fatal(err)
}
if !assert.Len(t, pipelineItems, 1) {
t.Fatal("Should have generated 1 pipeline")
}
if pipelineItems[0].Workflow.State != model.StatusPending {
t.Fatal("Should run on dev branch")
}
}
func TestRootWhenFilter(t *testing.T) {
t.Parallel()
b := StepBuilder{
Forge: getMockForge(t),
Repo: &model.Repo{},
Curr: &model.Pipeline{Event: "tag"},
Prev: &model.Pipeline{},
Netrc: &model.Netrc{},
Secs: []*model.Secret{},
Regs: []*model.Registry{},
Host: "",
Yamls: []*forge_types.FileMeta{
{Data: []byte(`
when:
event:
- tag
steps:
xxx:
image: scratch
`)},
{Data: []byte(`
when:
event:
- push
steps:
xxx:
image: scratch
`)},
{Data: []byte(`
steps:
build:
image: scratch
`)},
},
}
pipelineItems, err := b.Build()
assert.False(t, errors.HasBlockingErrors(err))
if len(pipelineItems) != 2 {
t.Fatal("Should have generated 2 pipelineItems")
}
}
func TestZeroSteps(t *testing.T) {
t.Parallel()
pipeline := &model.Pipeline{
Branch: "dev",
Event: model.EventPush,
}
b := StepBuilder{
Forge: getMockForge(t),
Repo: &model.Repo{},
Curr: pipeline,
Prev: &model.Pipeline{},
Netrc: &model.Netrc{},
Secs: []*model.Secret{},
Regs: []*model.Registry{},
Host: "",
Yamls: []*forge_types.FileMeta{
{Data: []byte(`
when:
event: push
skip_clone: true
steps:
build:
when:
branch: notdev
image: scratch
`)},
},
}
pipelineItems, err := b.Build()
if err != nil {
t.Fatal(err)
}
if len(pipelineItems) != 0 {
t.Fatal("Should not generate a pipeline item if there are no steps")
}
}
func TestZeroStepsAsMultiPipelineDeps(t *testing.T) {
t.Parallel()
pipeline := &model.Pipeline{
Branch: "dev",
Event: model.EventPush,
}
b := StepBuilder{
Forge: getMockForge(t),
Repo: &model.Repo{},
Curr: pipeline,
Prev: &model.Pipeline{},
Netrc: &model.Netrc{},
Secs: []*model.Secret{},
Regs: []*model.Registry{},
Host: "",
Yamls: []*forge_types.FileMeta{
{Name: "zerostep", Data: []byte(`
when:
event: push
skip_clone: true
steps:
build:
when:
branch: notdev
image: scratch
`)},
{Name: "justastep", Data: []byte(`
when:
event: push
steps:
build:
image: scratch
`)},
{Name: "shouldbefiltered", Data: []byte(`
when:
event: push
steps:
build:
image: scratch
depends_on: [ zerostep ]
`)},
},
}
pipelineItems, err := b.Build()
if err != nil {
t.Fatal(err)
}
if len(pipelineItems) != 1 {
t.Fatal("Zerostep and the step that depends on it should not generate a pipeline item")
}
if pipelineItems[0].Workflow.Name != "justastep" {
t.Fatal("justastep should have been generated")
}
}
func TestZeroStepsAsMultiPipelineTransitiveDeps(t *testing.T) {
t.Parallel()
pipeline := &model.Pipeline{
Branch: "dev",
Event: model.EventPush,
}
b := StepBuilder{
Forge: getMockForge(t),
Repo: &model.Repo{},
Curr: pipeline,
Prev: &model.Pipeline{},
Netrc: &model.Netrc{},
Secs: []*model.Secret{},
Regs: []*model.Registry{},
Host: "",
Yamls: []*forge_types.FileMeta{
{Name: "zerostep", Data: []byte(`
when:
event: push
skip_clone: true
steps:
build:
when:
branch: notdev
image: scratch
`)},
{Name: "justastep", Data: []byte(`
when:
event: push
steps:
build:
image: scratch
`)},
{Name: "shouldbefiltered", Data: []byte(`
when:
event: push
steps:
build:
image: scratch
depends_on: [ zerostep ]
`)},
{Name: "shouldbefilteredtoo", Data: []byte(`
when:
event: push
steps:
build:
image: scratch
depends_on: [ shouldbefiltered ]
`)},
},
}
pipelineItems, err := b.Build()
if err != nil {
t.Fatal(err)
}
if len(pipelineItems) != 1 {
t.Fatal("Zerostep and the step that depends on it, and the one depending on it should not generate a pipeline item")
}
if pipelineItems[0].Workflow.Name != "justastep" {
t.Fatal("justastep should have been generated")
}
}
func TestSanitizePath(t *testing.T) {
t.Parallel()
testTable := []struct {
path string
sanitizedPath string
}{
{
path: ".woodpecker/test.yml",
sanitizedPath: "test",
},
{
path: ".woodpecker.yml",
sanitizedPath: "woodpecker",
},
{
path: "folder/sub-folder/test.yml",
sanitizedPath: "test",
},
{
path: ".woodpecker/test.yaml",
sanitizedPath: "test",
},
{
path: ".woodpecker.yaml",
sanitizedPath: "woodpecker",
},
{
path: "folder/sub-folder/test.yaml",
sanitizedPath: "test",
},
}
for _, test := range testTable {
if test.sanitizedPath != SanitizePath(test.path) {
t.Fatal("Path hasn't been sanitized correctly")
}
}
}
func getMockForge(t *testing.T) forge.Forge {
forge := mocks.NewForge(t)
forge.On("Name").Return("mock")
forge.On("URL").Return("https://codeberg.org")
return forge
}