Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

enhance: remote slack attachment #56

Merged
merged 12 commits into from
Nov 28, 2023
Merged
Show file tree
Hide file tree
Changes from 2 commits
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
23 changes: 23 additions & 0 deletions cmd/vela-slack/main.go
Original file line number Diff line number Diff line change
Expand Up @@ -5,7 +5,7 @@
import (
"encoding/json"
"fmt"
"io/ioutil"

Check failure on line 8 in cmd/vela-slack/main.go

View workflow job for this annotation

GitHub Actions / full-review

SA1019: "io/ioutil" has been deprecated since Go 1.19: As of Go 1.16, the same functionality is now provided by package [io] or package [os], and those implementations should be preferred in new code. See the specific function documentation for details. (staticcheck)

Check failure on line 8 in cmd/vela-slack/main.go

View workflow job for this annotation

GitHub Actions / diff-review

SA1019: "io/ioutil" has been deprecated since Go 1.19: As of Go 1.16, the same functionality is now provided by package [io] or package [os], and those implementations should be preferred in new code. See the specific function documentation for details. (staticcheck)

Check failure on line 8 in cmd/vela-slack/main.go

View workflow job for this annotation

GitHub Actions / golangci

[golangci] cmd/vela-slack/main.go#L8

SA1019: "io/ioutil" has been deprecated since Go 1.19: As of Go 1.16, the same functionality is now provided by package [io] or package [os], and those implementations should be preferred in new code. See the specific function documentation for details. (staticcheck)
Raw output
cmd/vela-slack/main.go:8:2: SA1019: "io/ioutil" has been deprecated since Go 1.19: As of Go 1.16, the same functionality is now provided by package [io] or package [os], and those implementations should be preferred in new code. See the specific function documentation for details. (staticcheck)
	"io/ioutil"
	^
"os"

"time"
Expand All @@ -24,7 +24,7 @@
_ "github.com/joho/godotenv/autoload"
)

// nolint: funlen // ignore length for main

Check failure on line 27 in cmd/vela-slack/main.go

View workflow job for this annotation

GitHub Actions / full-review

directive `// nolint: funlen // ignore length for main` should be written without leading space as `//nolint: funlen // ignore length for main` (nolintlint)

Check failure on line 27 in cmd/vela-slack/main.go

View workflow job for this annotation

GitHub Actions / diff-review

directive `// nolint: funlen // ignore length for main` should be written without leading space as `//nolint: funlen // ignore length for main` (nolintlint)

Check failure on line 27 in cmd/vela-slack/main.go

View workflow job for this annotation

GitHub Actions / golangci

[golangci] cmd/vela-slack/main.go#L27

directive `// nolint: funlen // ignore length for main` should be written without leading space as `//nolint: funlen // ignore length for main` (nolintlint)
Raw output
cmd/vela-slack/main.go:27:1: directive `// nolint: funlen // ignore length for main` should be written without leading space as `//nolint: funlen // ignore length for main` (nolintlint)
// nolint: funlen // ignore length for main
^
func main() {
// capture application version information
v := version.New()
Expand Down Expand Up @@ -92,6 +92,12 @@
Name: "webhook",
Usage: "slack webhook used to post log messages to channel",
},
&cli.BoolFlag{
EnvVars: []string{"PARAMETER_REMOTE", "SLACK_REMOTE"},
FilePath: "/vela/parameters/slack/remote,/vela/secrets/slack/remote",
Name: "remote",
Usage: "if filepath is remote or not",
},

// Webhook Flags

Expand Down Expand Up @@ -289,6 +295,14 @@
Usage: "environment variable reference for reading in repository trusted",
},

// Registry
&cli.StringFlag{
EnvVars: []string{"PARAMETER_REGISTRY", "REGISTRY_URL"},
FilePath: "/vela/parameters/slack/registry-url,/vela/secrets/slack/registry-url",
Name: "registry-url",
Usage: "registry url",
},

// Optional LDAP config flags

&cli.StringFlag{
Expand Down Expand Up @@ -321,6 +335,12 @@
Name: "ldap-search-base",
Usage: "environment variable for enterprise LDAP search base",
},
&cli.StringFlag{
EnvVars: []string{"PARAMETER_TOKEN", "GITHUB_TOKEN"},
FilePath: "/vela/parameters/slack/token,/vela/secrets/slack/token",
Name: "token",
Usage: "github token from user",
},
}

err = app.Run(os.Args)
Expand Down Expand Up @@ -370,6 +390,7 @@
Text: c.String("text"),
Parse: c.String("parse"),
},
Remote: c.Bool("remote"),
Env: &Env{
BuildAuthor: c.String("build-author"),
BuildAuthorEmail: c.String("build-author-email"),
Expand All @@ -392,6 +413,7 @@
BuildTag: c.String("build-tag"),
BuildTitle: c.String("build-title"),
BuildWorkspace: c.String("build-workspace"),
RegistryURL: c.String("registry-url"),
RepositoryBranch: c.String("repo-branch"),
RepoBranch: c.String("repo-branch"),
RepositoryClone: c.String("repo-clone"),
Expand All @@ -410,6 +432,7 @@
RepoTimeout: c.Int("repo-timeout"),
RepositoryTrusted: c.String("repo-trusted"),
RepoTrusted: c.String("repo-trusted"),
Token: c.String("token"),
},
}

Expand Down
82 changes: 78 additions & 4 deletions cmd/vela-slack/plugin.go
Original file line number Diff line number Diff line change
Expand Up @@ -6,13 +6,15 @@
"bytes"
"encoding/json"
"fmt"
"io/ioutil"
"io"
"os"
"regexp"
"strconv"
"strings"
"text/template"

registry "github.com/go-vela/server/compiler/registry/github"

"github.com/Masterminds/sprig/v3"
"github.com/sirupsen/logrus"
"github.com/slack-go/slack"
Expand All @@ -26,6 +28,7 @@
Env *Env
Path string
WebhookMsg *slack.WebhookMessage
Remote bool
}

// Env struct represents the environment variables the Vela injects
Expand All @@ -52,6 +55,7 @@
BuildTag string
BuildTitle string
BuildWorkspace string
RegistryURL string
RepositoryBranch string
RepoBranch string
RepositoryClone string
Expand All @@ -70,12 +74,17 @@
RepoTimeout int
RepositoryTrusted string
RepoTrusted string
Token string
}
)

// Exec formats and runs the commands for sending a message via Slack.
func (p *Plugin) Exec() error {
var (
attachments []slack.Attachment
err error
)
logrus.Debug("running plugin with provided configuration")

Check failure on line 87 in cmd/vela-slack/plugin.go

View workflow job for this annotation

GitHub Actions / full-review

expressions should not be cuddled with declarations or returns (wsl)

Check failure on line 87 in cmd/vela-slack/plugin.go

View workflow job for this annotation

GitHub Actions / diff-review

expressions should not be cuddled with declarations or returns (wsl)

Check failure on line 87 in cmd/vela-slack/plugin.go

View workflow job for this annotation

GitHub Actions / golangci

[golangci] cmd/vela-slack/plugin.go#L87

expressions should not be cuddled with declarations or returns (wsl)
Raw output
cmd/vela-slack/plugin.go:87:2: expressions should not be cuddled with declarations or returns (wsl)
	logrus.Debug("running plugin with provided configuration")
	^
claire1618 marked this conversation as resolved.
Show resolved Hide resolved

// clean up newlines that could invalidate JSON
// BuildMessage is the only field that can have newlines;
Expand All @@ -95,8 +104,13 @@

// parse the slack message file
if len(p.Path) != 0 {
logrus.Infof("Parsing provided template file %s, ", p.Path)
attachments, err := getAttachmentFromFile(p)
logrus.Infof("Parsing provided template file, %s", p.Path)
if p.Remote {

Check failure on line 108 in cmd/vela-slack/plugin.go

View workflow job for this annotation

GitHub Actions / full-review

if statements should only be cuddled with assignments (wsl)

Check failure on line 108 in cmd/vela-slack/plugin.go

View workflow job for this annotation

GitHub Actions / diff-review

if statements should only be cuddled with assignments (wsl)

Check failure on line 108 in cmd/vela-slack/plugin.go

View workflow job for this annotation

GitHub Actions / golangci

[golangci] cmd/vela-slack/plugin.go#L108

if statements should only be cuddled with assignments (wsl)
Raw output
cmd/vela-slack/plugin.go:108:3: if statements should only be cuddled with assignments (wsl)
		if p.Remote {
		^
claire1618 marked this conversation as resolved.
Show resolved Hide resolved
attachments, err = getRemoteAttachment(p)

Check failure on line 110 in cmd/vela-slack/plugin.go

View workflow job for this annotation

GitHub Actions / golangci

[golangci] cmd/vela-slack/plugin.go#L110

unnecessary trailing newline (whitespace)
Raw output
cmd/vela-slack/plugin.go:110: unnecessary trailing newline (whitespace)

		} else {
claire1618 marked this conversation as resolved.
Show resolved Hide resolved
} else {

Check failure on line 111 in cmd/vela-slack/plugin.go

View workflow job for this annotation

GitHub Actions / full-review

block should not end with a whitespace (or comment) (wsl)

Check failure on line 111 in cmd/vela-slack/plugin.go

View workflow job for this annotation

GitHub Actions / diff-review

block should not end with a whitespace (or comment) (wsl)

Check failure on line 111 in cmd/vela-slack/plugin.go

View workflow job for this annotation

GitHub Actions / golangci

[golangci] cmd/vela-slack/plugin.go#L111

block should not end with a whitespace (or comment) (wsl)
Raw output
cmd/vela-slack/plugin.go:111:3: block should not end with a whitespace (or comment) (wsl)
		} else {
		^
claire1618 marked this conversation as resolved.
Show resolved Hide resolved
attachments, err = getAttachmentFromFile(p)
}

if err != nil {
return fmt.Errorf("unable to parse attachment file: %w", err)
Expand Down Expand Up @@ -201,7 +215,7 @@
defer jsonFile.Close()

// read the contents of the json template
bytes, err := ioutil.ReadAll(jsonFile)
bytes, err := io.ReadAll(jsonFile)
if err != nil {
return nil, fmt.Errorf("unable to read json file: %w", err)
}
Expand Down Expand Up @@ -233,3 +247,63 @@

return msg.Attachments, err
}

// getRemoteAttachment function to open and parse json file into
// slack webhook message payload.
func getRemoteAttachment(p *Plugin) ([]slack.Attachment, error) {
var (
bytes []byte
err error
)

reg, err := registry.New(p.Env.RegistryURL, p.Env.Token)
if err != nil {
return nil, err
}

// parse source from slack attachment
src, err := reg.Parse(p.Path)
if err != nil {
return nil, fmt.Errorf("invalid slack attachment source provided: %w", err)
}

logrus.WithFields(logrus.Fields{
"org": src.Org,
"repo": src.Repo,
"path": src.Name,
"host": src.Host,
}).Tracef("Using authenticated GitHub client to pull template")

// use private (authenticated) github instance to pull from
bytes, err = reg.Template(nil, src)
if err != nil {
return nil, err
}

// Converts bytes into string and replaces {{ .BuildCreated }}
// with a timestamp before returning it back into bytes again.
bStr := string(bytes)
// x := strconv.Itoa(p.Env.BuildCreated)
bStr = strings.Replace(bStr, "{{ .BuildCreated }}", strconv.Itoa(p.Env.BuildCreated), -1)
bStr = strings.Replace(bStr, "{{ .BuildEnqueued }}", strconv.Itoa(p.Env.BuildEnqueued), -1)
bStr = strings.Replace(bStr, "{{ .BuildFinished }}", strconv.Itoa(p.Env.BuildFinished), -1)
bStr = strings.Replace(bStr, "{{ .BuildNumber }}", strconv.Itoa(p.Env.BuildNumber), -1)
bStr = strings.Replace(bStr, "{{ .BuildParent }}", strconv.Itoa(p.Env.BuildParent), -1)
bStr = strings.Replace(bStr, "{{ .BuildStarted }}", strconv.Itoa(p.Env.BuildStarted), -1)
bStr = strings.Replace(bStr, "{{ .RepositoryTimeout }}", strconv.Itoa(p.Env.RepositoryTimeout), -1)
claire1618 marked this conversation as resolved.
Show resolved Hide resolved
bytes = []byte(bStr)

logrus.Info("pip")
logrus.Info(bStr)
logrus.Info("pip")
claire1618 marked this conversation as resolved.
Show resolved Hide resolved
// create a variable to hold our message
var msg slack.WebhookMessage

// cast bytes to go struct
err = json.Unmarshal(bytes, &msg)
if err != nil {
return nil, fmt.Errorf("unable to unmarshal json file: %w", err)
}

return msg.Attachments, err
}
Loading
Loading