enhance: remote slack attachment

cmd/vela-slack/main.go

@@ -5,7 +5,7 @@
 import (
 	"encoding/json"
 	"fmt"
 	"io/ioutil"
 	"os"
 
 	"time"
@@ -24,7 +24,7 @@
 	_ "github.com/joho/godotenv/autoload"
 )
 
 // nolint: funlen // ignore length for main
 func main() {
 	// capture application version information
 	v := version.New()
@@ -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
 
@@ -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{
@@ -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)
@@ -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"),
@@ -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"),
@@ -410,6 +432,7 @@
 			RepoTimeout:               c.Int("repo-timeout"),
 			RepositoryTrusted:         c.String("repo-trusted"),
 			RepoTrusted:               c.String("repo-trusted"),
+			Token:                     c.String("token"),
 		},
 	}
 

cmd/vela-slack/plugin.go

@@ -6,13 +6,15 @@ import (
 	"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"
@@ -26,6 +28,7 @@ type (
 		Env        *Env
 		Path       string
 		WebhookMsg *slack.WebhookMessage
+		Remote     bool
 	}
 
 	// Env struct represents the environment variables the Vela injects
@@ -52,6 +55,7 @@ type (
 		BuildTag                  string
 		BuildTitle                string
 		BuildWorkspace            string
+		RegistryURL               string
 		RepositoryBranch          string
 		RepoBranch                string
 		RepositoryClone           string
@@ -70,11 +74,17 @@ type (
 		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")
 
 	// clean up newlines that could invalidate JSON
@@ -95,8 +105,13 @@ func (p *Plugin) Exec() error {
 
 	// 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 {
+			attachments, err = getRemoteAttachment(p)
+		} else {
+			attachments, err = getAttachmentFromFile(p)
+		}
 
 		if err != nil {
 			return fmt.Errorf("unable to parse attachment file: %w", err)
@@ -201,7 +216,7 @@ func getAttachmentFromFile(p *Plugin) ([]slack.Attachment, error) {
 	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)
 	}
@@ -233,3 +248,63 @@ func getAttachmentFromFile(p *Plugin) ([]slack.Attachment, error) {
 
 	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)
+	bytes = []byte(bStr)
+
+	logrus.Info("pip")
+	logrus.Info(bStr)
+	logrus.Info("pip")
+	// 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
+}