Merge pull request #56 from underdog-tech/feat/slack-block-kit

feat: Use Slack Block Kit for report formatting

internal/scan.go

@@ -53,6 +53,7 @@ func Scan(cmd *cobra.Command, args []string) {
 	}
 	reporters = append(reporters, &reporting.ConsoleReporter{Config: userConfig})
 
+	reportTime := time.Now().Format(time.RFC1123)
 	ghOrgName, allRepos := api.QueryGithubOrgVulnerabilities(ghOrgLogin, *ghClient)
 	repositoryOwners := api.QueryGithubOrgRepositoryOwners(ghOrgLogin, *ghClient)
 	// Count our vulnerabilities
@@ -62,8 +63,7 @@ func Scan(cmd *cobra.Command, args []string) {
 	vulnsByTeam := reporting.GroupVulnsByOwner(allRepos, repositoryOwners)
 	teamReports := reporting.CollateTeamReports(vulnsByTeam)
 
-	reportTime := time.Now().Format(time.RFC1123)
-	summaryHeader := fmt.Sprintf("%s Dependabot Report for %s", ghOrgName, reportTime)
+	summaryHeader := fmt.Sprintf("%s Vulnbot Report", ghOrgName)
 
 	wg := new(sync.WaitGroup)
 	for _, reporter := range reporters {
@@ -72,9 +72,10 @@ func Scan(cmd *cobra.Command, args []string) {
 			summaryHeader,
 			len(allRepos),
 			vulnSummary,
+			reportTime,
 			wg,
 		)
-		go reporter.SendTeamReports(teamReports, wg)
+		go reporter.SendTeamReports(teamReports, reportTime, wg)
 	}
 	wg.Wait()
 	log.Info().Msg("Done!")

reporting/console.go

@@ -41,6 +41,7 @@ func (c *ConsoleReporter) SendSummaryReport(
 	header string,
 	numRepos int,
 	report VulnerabilityReport,
+	reportTime string,
 	wg *sync.WaitGroup,
 ) error {
 	defer wg.Done()
@@ -71,6 +72,7 @@ func (c *ConsoleReporter) SendSummaryReport(
 // of this could be quite overwhelming.
 func (c *ConsoleReporter) SendTeamReports(
 	teamReports map[string]map[string]VulnerabilityReport,
+	reportTime string,
 	wg *sync.WaitGroup,
 ) error {
 	defer wg.Done()

reporting/console_test.go

@@ -12,7 +12,7 @@ import (
 	"github.com/underdog-tech/vulnbot/config"
 )
 
-func TestSendSummaryReport(t *testing.T) {
+func TestSendConsoleSummaryReport(t *testing.T) {
 	origStdout := os.Stdout
 	reader, writer, _ := os.Pipe()
 	os.Stdout = writer
@@ -55,7 +55,7 @@ Affected repositories: 2
 
 	wg := new(sync.WaitGroup)
 	wg.Add(1)
-	reporter.SendSummaryReport("OrgName Dependabot Report for now", 13, report, wg)
+	reporter.SendSummaryReport("OrgName Dependabot Report for now", 13, report, "now", wg)
 	writer.Close()
 	written, _ := ioutil.ReadAll(reader)
 	os.Stdout = origStdout

reporting/reporter.go

@@ -7,10 +7,12 @@ type Reporter interface {
 		header string,
 		numRepos int,
 		report VulnerabilityReport,
+		reportTime string,
 		wg *sync.WaitGroup,
 	) error
 	SendTeamReports(
 		teamReports map[string]map[string]VulnerabilityReport,
+		reportTime string,
 		wg *sync.WaitGroup,
 	) error
 }