added gitignore

.gitignore

@@ -0,0 +1 @@
+.scannerwork

common/types.go

@@ -0,0 +1,108 @@
+// 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 common
+
+import (
+	"regexp"
+	"strings"
+
+	"github.com/woodpecker-ci/woodpecker/pipeline/frontend"
+)
+
+type (
+	AdditionalData struct {
+		WorkspaceBase string
+		WorkspacePath string
+		Workspace     string
+		SCM           string
+	}
+
+	BuildData struct {
+		Metadata       frontend.Metadata
+		AdditionalData AdditionalData
+	}
+)
+
+func (b BuildData) IsPR() bool {
+	return b.Metadata.Curr.Event == frontend.EventPull
+}
+
+func (b BuildData) PullRequest() string {
+	if b.IsPR() {
+		var pullRegexp = regexp.MustCompile(`\d+`)
+		return pullRegexp.FindString(b.Metadata.Curr.Commit.Ref)
+	}
+	return ""
+}
+
+func (b BuildData) IsTag() bool {
+	return b.Metadata.Curr.Event == frontend.EventTag
+}
+
+func (b BuildData) Tag() string {
+	if b.IsTag() {
+		return strings.TrimPrefix(b.Metadata.Curr.Commit.Ref, "refs/tags/")
+	}
+	return ""
+}
+
+func (b BuildData) RepoShortName() string {
+	_, _, name := b.splitRepoName()
+	return name
+}
+
+func (b BuildData) RepoOwner() string {
+	hasOwner, owner, _ := b.splitRepoName()
+	if hasOwner {
+		return owner
+	}
+	return ""
+}
+
+func (b BuildData) splitRepoName() (bool, string, string) {
+	var repoOwner string
+	var repoName string
+
+	repoParts := strings.Split(b.Metadata.Repo.Name, "/")
+	if len(repoParts) == 2 {
+		repoOwner = repoParts[0]
+		repoName = repoParts[1]
+	} else {
+		repoName = b.Metadata.Repo.Name
+	}
+
+	return (len(repoParts) == 2), repoOwner, repoName
+}
+
+func (b BuildData) SourceBranch() string {
+	hasSource, source, _ := b.splitRefSpec()
+	if hasSource {
+		return source
+	}
+	return ""
+}
+
+func (b BuildData) TargetBranch() string {
+	_, _, target := b.splitRefSpec()
+	return target
+}
+
+func (b BuildData) splitRefSpec() (bool, string, string) {
+	branchParts := strings.Split(b.Metadata.Curr.Commit.Refspec, ":")
+	if len(branchParts) == 2 {
+		return true, branchParts[0], branchParts[1]
+	}
+	return false, "", branchParts[0]
+}

go.mod

@@ -1,12 +1,15 @@
-module git.kle.li/gapodo/woodpecker-plugin-lib
+module git.kle.li/woodpecker/plugin-lib
 
 go 1.19
 
+require (
+	github.com/urfave/cli/v2 v2.20.3
+	github.com/woodpecker-ci/woodpecker v0.15.5
+)
+
 require (
 	github.com/cpuguy83/go-md2man/v2 v2.0.2 // indirect
 	github.com/russross/blackfriday/v2 v2.1.0 // indirect
-	github.com/urfave/cli/v2 v2.20.3 // indirect
-	github.com/woodpecker-ci/woodpecker v0.15.5 // indirect
 	github.com/xrash/smetrics v0.0.0-20201216005158-039620a65673 // indirect
 	gopkg.in/yaml.v3 v3.0.1 // indirect
 )

go.sum

@@ -1,5 +1,6 @@
 github.com/cpuguy83/go-md2man/v2 v2.0.2 h1:p1EgwI/C7NhT0JmVkwCD2ZBK8j4aeHQX2pMHHBfMQ6w=
 github.com/cpuguy83/go-md2man/v2 v2.0.2/go.mod h1:tgQtvFlXSQOSOSIRvRPT7W67SCa46tRHOmNcaadrF8o=
+github.com/franela/goblin v0.0.0-20211003143422-0a4f594942bf h1:NrF81UtW8gG2LBGkXFQFqlfNnvMt9WdB46sfdJY4oqc=
 github.com/russross/blackfriday/v2 v2.1.0 h1:JIOH55/0cWyOuilr9/qlrm0BSXldqnqwMsf35Ld67mk=
 github.com/russross/blackfriday/v2 v2.1.0/go.mod h1:+Rmxgy9KzJVeS9/2gXHxylqXiyQDYRxCVz55jmeOWTM=
 github.com/urfave/cli/v2 v2.20.3 h1:lOgGidH/N5loaigd9HjFsOIhXSTrzl7tBpHswZ428w4=
@@ -8,6 +9,7 @@ github.com/woodpecker-ci/woodpecker v0.15.5 h1:8l6p1qhwUpjNXQNCkEpH6lQf0npfips4I
 github.com/woodpecker-ci/woodpecker v0.15.5/go.mod h1:Po9JhNe1H/AInF5eeqOAfAsXMfdmfR8E7ghUxM0sDEY=
 github.com/xrash/smetrics v0.0.0-20201216005158-039620a65673 h1:bAn7/zixMGCfxrRTfdpNzjtPYqr8smhKouy9mxVdGPU=
 github.com/xrash/smetrics v0.0.0-20201216005158-039620a65673/go.mod h1:N3UwUGtsrSj3ccvlPHLoLsHnpR27oXr4ZE984MbSER8=
+gopkg.in/check.v1 v0.0.0-20161208181325-20d25e280405 h1:yhCVgyC4o1eVCa2tZl7eS0r+SDo693bJlVdllGtEeKM=
 gopkg.in/check.v1 v0.0.0-20161208181325-20d25e280405/go.mod h1:Co6ibVJAznAaIkqp8huTwlJQCZ016jof/cbN4VW5Yz0=
 gopkg.in/yaml.v3 v3.0.1 h1:fxVm/GzAzEWqLHuvctI91KS9hhNmmWOoWu0XTYJS7CA=
 gopkg.in/yaml.v3 v3.0.1/go.mod h1:K4uyk7z7BCEPqu6E+C64Yfv1cQ7kz7rIZviUmN+EgEM=

urfave/build.go

@@ -15,106 +15,96 @@
 package urfave
 
 import (
+	"git.kle.li/woodpecker/plugin-lib/common"
 	"github.com/urfave/cli/v2"
 	"github.com/woodpecker-ci/woodpecker/pipeline/frontend"
 	"github.com/woodpecker-ci/woodpecker/pipeline/frontend/yaml/matrix"
 )
 
-func BuildMetadataFromContext(c *cli.Context, axis matrix.Axis) frontend.Metadata {
-	return frontend.Metadata{
-		Repo: frontend.Repo{
-			Name:    c.String("repo-name"),
-			Link:    c.String("repo-link"),
-			Remote:  c.String("repo-remote-url"),
-			Private: c.Bool("repo-private"),
-		},
-		Curr: frontend.Build{
-			Number:   c.Int64("build-number"),
-			Parent:   c.Int64("parent-build-number"),
-			Created:  c.Int64("build-created"),
-			Started:  c.Int64("build-started"),
-			Finished: c.Int64("build-finished"),
-			Status:   c.String("build-status"),
-			Event:    c.String("build-event"),
-			Link:     c.String("build-link"),
-			Target:   c.String("build-target"),
-			Commit: frontend.Commit{
-				Sha:     c.String("commit-sha"),
-				Ref:     c.String("commit-ref"),
-				Refspec: c.String("commit-refspec"),
-				Branch:  c.String("commit-branch"),
-				Message: c.String("commit-message"),
-				Author: frontend.Author{
-					Name:   c.String("commit-author-name"),
-					Email:  c.String("commit-author-email"),
-					Avatar: c.String("commit-author-avatar"),
+func BuildDataFromContext(c *cli.Context, axis matrix.Axis) common.BuildData {
+	bdata := common.BuildData{
+		Metadata: frontend.Metadata{
+			Repo: frontend.Repo{
+				Name:    c.String("repo"),
+				Link:    c.String("repo-link"),
+				Remote:  c.String("repo-remote-url"),
+				Private: c.Bool("repo-private"),
+				Branch:  c.String("repo-branch"),
+			},
+			Curr: frontend.Build{
+				Number:   c.Int64("build-number"),
+				Parent:   c.Int64("build-parent"),
+				Created:  c.Int64("build-created"),
+				Started:  c.Int64("build-started"),
+				Finished: c.Int64("build-finished"),
+				Status:   c.String("build-status"),
+				Event:    c.String("build-event"),
+				Link:     c.String("build-link"),
+				Target:   c.String("build-target"),
+				Commit: frontend.Commit{
+					Sha:     c.String("commit-sha"),
+					Ref:     c.String("commit-ref"),
+					Refspec: c.String("commit-refspec"),
+					Branch:  c.String("commit-branch"),
+					Message: c.String("commit-message"),
+					Author: frontend.Author{
+						Name:   c.String("commit-author"),
+						Email:  c.String("commit-author-email"),
+						Avatar: c.String("commit-author-avatar"),
+					},
 				},
 			},
-		},
-		Prev: frontend.Build{
-			Number:   c.Int64("prev-build-number"),
-			Created:  c.Int64("prev-build-created"),
-			Started:  c.Int64("prev-build-started"),
-			Finished: c.Int64("prev-build-finished"),
-			Status:   c.String("prev-build-status"),
-			Event:    c.String("prev-build-event"),
-			Link:     c.String("prev-build-link"),
-			Commit: frontend.Commit{
-				Sha:     c.String("prev-commit-sha"),
-				Ref:     c.String("prev-commit-ref"),
-				Refspec: c.String("prev-commit-refspec"),
-				Branch:  c.String("prev-commit-branch"),
-				Message: c.String("prev-commit-message"),
-				Author: frontend.Author{
-					Name:   c.String("prev-commit-author-name"),
-					Email:  c.String("prev-commit-author-email"),
-					Avatar: c.String("prev-commit-author-avatar"),
+			Prev: frontend.Build{
+				Number:   c.Int64("prev-build-number"),
+				Parent:   c.Int64("prev-build-parent"),
+				Created:  c.Int64("prev-build-created"),
+				Started:  c.Int64("prev-build-started"),
+				Finished: c.Int64("prev-build-finished"),
+				Status:   c.String("prev-build-status"),
+				Event:    c.String("prev-build-event"),
+				Link:     c.String("prev-build-link"),
+				Target:   c.String("prev-build-target"),
+				Commit: frontend.Commit{
+					Sha:     c.String("prev-commit-sha"),
+					Ref:     c.String("prev-commit-ref"),
+					Refspec: c.String("prev-commit-refspec"),
+					Branch:  c.String("prev-commit-branch"),
+					Message: c.String("prev-commit-message"),
+					Author: frontend.Author{
+						Name:   c.String("prev-commit-author"),
+						Email:  c.String("prev-commit-author-email"),
+						Avatar: c.String("prev-commit-author-avatar"),
+					},
 				},
 			},
+			Job: frontend.Job{
+				Number: c.Int("job-number"),
+				Matrix: axis,
+			},
+			Sys: frontend.System{
+				Name:    c.String("system-name"),
+				Host:    c.String("system-host"),
+				Link:    c.String("system-link"),
+				Arch:    c.String("system-arch"),
+				Version: c.String("system-version"),
+			},
 		},
-		Job: frontend.Job{
-			Number: c.Int("job-number"),
-			Matrix: axis,
-		},
-		Sys: frontend.System{
-			Name: c.String("system-name"),
-			Link: c.String("system-link"),
-			Arch: c.String("system-arch"),
+		AdditionalData: common.AdditionalData{
+			WorkspaceBase: c.String("workspace-base"),
+			WorkspacePath: c.String("workspace-path"),
+			Workspace:     c.String("workspace"),
+			SCM:           c.String("repo-scm"),
 		},
 	}
+	return bdata
 }
 
 func BuildFlags() []cli.Flag {
 	return []cli.Flag{
+		// repo
 		&cli.StringFlag{
-			EnvVars: []string{"CI_WORKSPACE_BASE"},
-			Name:    "workspace-base",
-			Value:   "/woodpecker",
-		},
-		&cli.StringFlag{
-			EnvVars: []string{"CI_WORKSPACE_PATH"},
-			Name:    "workspace-path",
-			Value:   "src",
-		},
-		&cli.StringFlag{
-			EnvVars: []string{"CI_WORKSPACE"},
-			Name:    "workspace",
-			Value:   "/woodpecker/src",
-		},
-		//
-		// metadata parameters
-		//
-		&cli.StringFlag{
-			EnvVars: []string{"CI_SYSTEM_NAME"},
-			Name:    "system-name",
-		},
-		&cli.StringFlag{
-			EnvVars: []string{"CI_SYSTEM_LINK"},
-			Name:    "system-link",
-		},
-		&cli.StringFlag{
-			EnvVars: []string{"CI_REPO_NAME"},
-			Name:    "repo-name",
+			EnvVars: []string{"CI_REPO"},
+			Name:    "repo",
 		},
 		&cli.StringFlag{
 			EnvVars: []string{"CI_REPO_LINK"},
@@ -124,17 +114,22 @@ func BuildFlags() []cli.Flag {
 			EnvVars: []string{"CI_REPO_REMOTE"},
 			Name:    "repo-remote-url",
 		},
-		&cli.StringFlag{
+		&cli.BoolFlag{
 			EnvVars: []string{"CI_REPO_PRIVATE"},
 			Name:    "repo-private",
 		},
-		&cli.IntFlag{
+		&cli.StringFlag{
+			EnvVars: []string{"CI_REPO_DEFAULT_BRANCH"},
+			Name:    "repo-branch",
+		},
+		// current build
+		&cli.Int64Flag{
 			EnvVars: []string{"CI_BUILD_NUMBER"},
 			Name:    "build-number",
 		},
-		&cli.IntFlag{
-			EnvVars: []string{"CI_PARENT_BUILD_NUMBER"},
-			Name:    "parent-build-number",
+		&cli.Int64Flag{
+			EnvVars: []string{"CI_PARENT"},
+			Name:    "build-parent",
 		},
 		&cli.Int64Flag{
 			EnvVars: []string{"CI_BUILD_CREATED"},
@@ -161,9 +156,10 @@ func BuildFlags() []cli.Flag {
 			Name:    "build-link",
 		},
 		&cli.StringFlag{
-			EnvVars: []string{"CI_BUILD_TARGET"},
+			EnvVars: []string{"CI_BUILD_DEPLOY_TARGET"},
 			Name:    "build-target",
 		},
+		// current commit
 		&cli.StringFlag{
 			EnvVars: []string{"CI_COMMIT_SHA"},
 			Name:    "commit-sha",
@@ -184,22 +180,28 @@ func BuildFlags() []cli.Flag {
 			EnvVars: []string{"CI_COMMIT_MESSAGE"},
 			Name:    "commit-message",
 		},
+		// current commit author
 		&cli.StringFlag{
-			EnvVars: []string{"CI_COMMIT_AUTHOR_NAME"},
-			Name:    "commit-author-name",
-		},
-		&cli.StringFlag{
-			EnvVars: []string{"CI_COMMIT_AUTHOR_AVATAR"},
-			Name:    "commit-author-avatar",
+			EnvVars: []string{"CI_COMMIT_AUTHOR"},
+			Name:    "commit-author",
 		},
 		&cli.StringFlag{
 			EnvVars: []string{"CI_COMMIT_AUTHOR_EMAIL"},
 			Name:    "commit-author-email",
 		},
-		&cli.IntFlag{
+		&cli.StringFlag{
+			EnvVars: []string{"CI_COMMIT_AUTHOR_AVATAR"},
+			Name:    "commit-author-avatar",
+		},
+		// previous build
+		&cli.Int64Flag{
 			EnvVars: []string{"CI_PREV_BUILD_NUMBER"},
 			Name:    "prev-build-number",
 		},
+		&cli.Int64Flag{
+			EnvVars: []string{"CI_PREV_BUILD_PARENT"},
+			Name:    "prev-build-parent",
+		},
 		&cli.Int64Flag{
 			EnvVars: []string{"CI_PREV_BUILD_CREATED"},
 			Name:    "prev-build-created",
@@ -224,6 +226,11 @@ func BuildFlags() []cli.Flag {
 			EnvVars: []string{"CI_PREV_BUILD_LINK"},
 			Name:    "prev-build-link",
 		},
+		&cli.StringFlag{
+			EnvVars: []string{"CI_PREV_BUILD_DEPLOY_TARGET"},
+			Name:    "prev-build-target",
+		},
+		// previous commit
 		&cli.StringFlag{
 			EnvVars: []string{"CI_PREV_COMMIT_SHA"},
 			Name:    "prev-commit-sha",
@@ -244,25 +251,63 @@ func BuildFlags() []cli.Flag {
 			EnvVars: []string{"CI_PREV_COMMIT_MESSAGE"},
 			Name:    "prev-commit-message",
 		},
+		// previous commit author
 		&cli.StringFlag{
-			EnvVars: []string{"CI_PREV_COMMIT_AUTHOR_NAME"},
-			Name:    "prev-commit-author-name",
-		},
-		&cli.StringFlag{
-			EnvVars: []string{"CI_PREV_COMMIT_AUTHOR_AVATAR"},
-			Name:    "prev-commit-author-avatar",
+			EnvVars: []string{"CI_PREV_COMMIT_AUTHOR"},
+			Name:    "prev-commit-author",
 		},
 		&cli.StringFlag{
 			EnvVars: []string{"CI_PREV_COMMIT_AUTHOR_EMAIL"},
 			Name:    "prev-commit-author-email",
 		},
+		&cli.StringFlag{
+			EnvVars: []string{"CI_PREV_COMMIT_AUTHOR_AVATAR"},
+			Name:    "prev-commit-author-avatar",
+		},
+		// Job
 		&cli.IntFlag{
 			EnvVars: []string{"CI_JOB_NUMBER"},
 			Name:    "job-number",
 		},
-		&cli.StringSliceFlag{
-			EnvVars: []string{"CI_ENV"},
-			Name:    "env",
+		// System
+		&cli.StringFlag{
+			EnvVars: []string{"CI_SYSTEM_NAME"},
+			Name:    "system-name",
+		},
+		&cli.StringFlag{
+			EnvVars: []string{"CI_SYSTEM_HOST"},
+			Name:    "system-host",
+		},
+		&cli.StringFlag{
+			EnvVars: []string{"CI_SYSTEM_LINK"},
+			Name:    "system-link",
+		},
+		&cli.StringFlag{
+			EnvVars: []string{"CI_SYSTEM_ARCH"},
+			Name:    "system-arch",
+		},
+		&cli.StringFlag{
+			EnvVars: []string{"CI_SYSTEM_VERSION"},
+			Name:    "system-version",
+		},
+
+		// other
+		&cli.StringFlag{
+			EnvVars: []string{"CI_WORKSPACE_BASE"},
+			Name:    "workspace-base",
+		},
+		&cli.StringFlag{
+			EnvVars: []string{"CI_WORKSPACE_PATH"},
+			Name:    "workspace-path",
+		},
+		&cli.StringFlag{
+			EnvVars: []string{"CI_WORKSPACE"},
+			Name:    "workspace",
+		},
+		&cli.StringFlag{
+			EnvVars: []string{"CI_REPO_SCM"},
+			Name:    "repo-scm",
+			Value:   "git",
 		},
 	}
 }

urfave/urfave.go

@@ -1,3 +1,17 @@
+// 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 urfave
 
 import (