WIP: support single comment summary with orchestrator mode #1850
+283
−281
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,2 @@ | ||
| -- Modify "digger_batches" table | ||
| ALTER TABLE "public"."digger_batches" ADD COLUMN "placeholder_comment_id_for_report" text NULL; |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -86,7 +86,12 @@ func (m *MockPRManager) GetApprovals(prNumber int) ([]string, error) { | ||
|
|
||
| func (m *MockPRManager) PublishComment(prNumber int, comment string) (*ci.Comment, error) { | ||
| m.Commands = append(m.Commands, RunInfo{"PublishComment", strconv.Itoa(prNumber) + " " + comment, time.Now()}) | ||
| return &ci.Comment{ | ||
| Id: "", | ||
| DiscussionId: "", | ||
| Body: nil, | ||
| Url: "", | ||
| }, nil | ||
| } | ||
|
|
||
| func (m *MockPRManager) ListIssues() ([]*ci.Issue, error) { | ||
| @@ -241,16 +246,16 @@ func (m MockPlanPathProvider) LocalPlanFilePath() string { | ||
| } | ||
|
|
||
| func TestCorrectCommandExecutionWhenApplying(t *testing.T) { | ||
| commandRunner := &MockCommandRunner{} | ||
| terraformExecutor := &MockTerraformExecutor{} | ||
| prManager := &MockPRManager{} | ||
| lock := &MockProjectLock{} | ||
| planStorage := &MockPlanStorage{} | ||
| strategy := reporting.NewMultipleCommentsStrategy() | ||
| reporter := &reporting.CiReporter{ | ||
| CiService: prManager, | ||
| PrNumber: 1, | ||
| ReportStrategy: &strategy, | ||
| IsSupportMarkdown: true, | ||
| } | ||
| planPathProvider := &MockPlanPathProvider{} | ||
| @@ -287,7 +292,7 @@ func TestCorrectCommandExecutionWhenApplying(t *testing.T) { | ||
|
|
||
| commandStrings := allCommandsInOrderWithParams(terraformExecutor, commandRunner, prManager, lock, planStorage, planPathProvider) | ||
|
|
||
| assert.Equal(t, []string{"RetrievePlan plan", "Init ", "Apply ", "Run echo"}, commandStrings) | ||
| } | ||
|
|
||
| func TestCorrectCommandExecutionWhenDestroying(t *testing.T) { | ||
| @@ -297,10 +302,11 @@ func TestCorrectCommandExecutionWhenDestroying(t *testing.T) { | ||
| prManager := &MockPRManager{} | ||
| lock := &MockProjectLock{} | ||
| planStorage := &MockPlanStorage{} | ||
| strategy := reporting.NewMultipleCommentsStrategy() | ||
| reporter := &reporting.CiReporter{ | ||
| CiService: prManager, | ||
| PrNumber: 1, | ||
| ReportStrategy: &strategy, | ||
| } | ||
| planPathProvider := &MockPlanPathProvider{} | ||
| executor := execution.DiggerExecutor{ | ||
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -44,10 +44,11 @@ func getProjectLockForTests() (error, *locking.PullRequestLock) { | ||
| repositoryName := "test_dynamodb_lock" | ||
| ghToken := "token" | ||
| githubPrService, _ := dg_github.GithubServiceProviderBasic{}.NewService(ghToken, repositoryName, repoOwner) | ||
| strategy := reporting.NewMultipleCommentsStrategy() | ||
| reporter := reporting.CiReporter{ | ||
| CiService: &githubPrService, | ||
| PrNumber: 1, | ||
| ReportStrategy: &strategy, | ||
| } | ||
|
|
||
| projectLock := &locking.PullRequestLock{ | ||
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -333,7 +333,7 @@ func handlePullRequestEvent(gitlabProvider utils.GitlabProvider, payload *gitlab | ||
| log.Printf("strconv.ParseInt error: %v", err) | ||
| utils.InitCommentReporter(glService, prNumber, fmt.Sprintf(":x: could not handle commentId: %v", err)) | ||
| } | ||
| batchId, _, err := utils.ConvertJobsToDiggerJobs(*diggerCommand, models.DiggerVCSGitlab, organisationId, impactedJobsMap, impactedProjectsMap, projectsGraph, 0, branch, prNumber, repoOwner, repoName, repoFullName, commitSha, commentId, nil, diggeryamlStr, projectId, "", false) | ||
| if err != nil { | ||
| log.Printf("ConvertJobsToDiggerJobs error: %v", err) | ||
| utils.InitCommentReporter(glService, prNumber, fmt.Sprintf(":x: ConvertJobsToDiggerJobs error: %v", err)) | ||
| @@ -524,7 +524,7 @@ func handleIssueCommentEvent(gitlabProvider utils.GitlabProvider, payload *gitla | ||
| log.Printf("ParseInt err: %v", err) | ||
| return fmt.Errorf("parseint error: %v", err) | ||
| } | ||
| batchId, _, err := utils.ConvertJobsToDiggerJobs(*diggerCommand, models.DiggerVCSGitlab, organisationId, impactedProjectsJobMap, impactedProjectsMap, projectsGraph, 0, branch, issueNumber, repoOwner, repoName, repoFullName, commitSha, commentId64, nil, diggerYmlStr, projectId, "", false) | ||
| if err != nil { | ||
| log.Printf("ConvertJobsToDiggerJobs error: %v", err) | ||
| utils.InitCommentReporter(glService, issueNumber, fmt.Sprintf(":x: ConvertJobsToDiggerJobs error: %v", err)) | ||
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -151,7 +151,7 @@ var DriftReconcilliationHook ce_controllers.IssueCommentHook = func(gh utils.Git | ||
| utils.InitCommentReporter(ghService, issueNumber, fmt.Sprintf(":x: could not handle commentId: %v", err)) | ||
| } | ||
|
|
||
| batchId, _, err := utils.ConvertJobsToDiggerJobs(*diggerCommand, "github", orgId, impactedProjectsJobMap, impactedProjectsMap, projectsGraph, installationId, defaultBranch, issueNumber, repoOwner, repoName, repoFullName, "", reporterCommentId, nil, diggerYmlStr, 0, "", false) | ||
| if err != nil { | ||
| log.Printf("ConvertJobsToDiggerJobs error: %v", err) | ||
| utils.InitCommentReporter(ghService, issueNumber, fmt.Sprintf(":x: ConvertJobsToDiggerJobs error: %v", err)) | ||
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -14,7 +14,6 @@ import ( | ||
| "log" | ||
| "net/http" | ||
| "os" | ||
| ) | ||
|
|
||
| type RunConfig struct { | ||
| @@ -87,15 +86,11 @@ func PreRun(cmd *cobra.Command, args []string) { | ||
| BackendApi = NewBackendApi(hostName, token) | ||
|
|
||
| if os.Getenv("REPORTING_STRATEGY") == "comments_per_run" || os.Getenv("ACCUMULATE_PLANS") == "true" { | ||
| strategy := reporting.NewSingleCommentStrategy() | ||
| ReportStrategy = &strategy | ||
| } else { | ||
| strategy := reporting.NewMultipleCommentsStrategy() | ||
| ReportStrategy = &strategy | ||
| } | ||
|
|
||
| var err error | ||
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -1,8 +1,8 @@ | ||
| package reporting | ||
|
|
||
| type Reporter interface { | ||
| Report(projectName string, report string, reportFormatting func(report string) string) (error error) | ||
| Flush() ([]string, []string, error) | ||
| Suppress(projectName string) error | ||
| SupportsMarkdown() bool | ||
| } |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -4,16 +4,16 @@ type MockReporter struct { | ||
| commands []string | ||
| } | ||
|
|
||
| func (mockReporter *MockReporter) Report(projectName string, report string, reportFormatting func(report string) string) error { | ||
| mockReporter.commands = append(mockReporter.commands, "Report") | ||
| return nil | ||
|
Comment on lines
+7
to
+9
There was a problem hiding this comment. 🛠️ Refactor suggestion Enhance mock implementation consistency The mock implementation has several areas for improvement:
func (mockReporter *MockReporter) Report(projectName string, report string, reportFormatting func(report string) string) error {
mockReporter.commands = append(mockReporter.commands, "Report")
return nil
}
func (mockReporter *MockReporter) Flush() ([]string, []string, error) {
+ mockReporter.commands = append(mockReporter.commands, "Flush")
return []string{}, []string{}, nil
}
-func (mockReporter *MockReporter) Suppress(string) error {
+func (mockReporter *MockReporter) Suppress(projectName string) error {
+ mockReporter.commands = append(mockReporter.commands, "Suppress")
return nil
}Also applies to: 12-13, 16-16 |
||
| } | ||
|
|
||
| func (mockReporter *MockReporter) Flush() ([]string, []string, error) { | ||
| return []string{}, []string{}, nil | ||
| } | ||
|
|
||
| func (mockReporter *MockReporter) Suppress(string) error { | ||
| return nil | ||
| } | ||
|
|
||
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -2,18 +2,18 @@ package reporting | ||
|
|
||
| type NoopReporter struct{} | ||
|
|
||
| func (reporter NoopReporter) Report(projectName string, report string, reportFormatting func(report string) string) error { | ||
| return nil | ||
| } | ||
|
|
||
| func (reporter NoopReporter) Flush() ([]string, []string, error) { | ||
| return []string{}, []string{}, nil | ||
| } | ||
|
|
||
| func (reporter NoopReporter) SupportsMarkdown() bool { | ||
| return false | ||
| } | ||
|
|
||
| func (reporter NoopReporter) Suppress(string) error { | ||
| return nil | ||
| } | ||
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -5,197 +5,184 @@ import ( | ||
| "github.com/diggerhq/digger/libs/ci" | ||
| "github.com/diggerhq/digger/libs/comment_utils/utils" | ||
| "log" | ||
| "time" | ||
| ) | ||
|
|
||
| type CiReporter struct { | ||
| CiService ci.PullRequestService | ||
| PrNumber int | ||
| IsSupportMarkdown bool | ||
| IsSuppressed bool | ||
| ReportStrategy ReportStrategy | ||
| } | ||
|
|
||
| func (ciReporter CiReporter) Report(projectName string, report string, reportFormatting func(report string) string) error { | ||
| err := ciReporter.ReportStrategy.Report(projectName, report, reportFormatting) | ||
| return err | ||
| } | ||
|
|
||
| func (ciReporter CiReporter) Flush() ([]string, []string, error) { | ||
| commentIds, commentUrls, err := ciReporter.ReportStrategy.Flush(ciReporter.CiService, ciReporter.PrNumber, ciReporter.IsSupportMarkdown) | ||
| return commentIds, commentUrls, err | ||
| } | ||
|
|
||
| func (ciReporter CiReporter) Suppress(projectName string) error { | ||
| return ciReporter.ReportStrategy.Suppress(projectName) | ||
| } | ||
|
|
||
| func (ciReporter CiReporter) SupportsMarkdown() bool { | ||
| return ciReporter.IsSupportMarkdown | ||
| } | ||
|
|
||
| type StdOutReporter struct{} | ||
|
|
||
| func (reporter StdOutReporter) Report(projectName string, report string, reportFormatting func(report string) string) error { | ||
| log.Printf("Info: %v", report) | ||
| return nil | ||
| } | ||
|
|
||
| func (reporter StdOutReporter) Flush() ([]string, []string, error) { | ||
| return []string{}, []string{}, nil | ||
| } | ||
|
|
||
| func (reporter StdOutReporter) SupportsMarkdown() bool { | ||
| return false | ||
| } | ||
|
|
||
| func (reporter StdOutReporter) Suppress(string) error { | ||
| return nil | ||
| } | ||
|
|
||
| type ReportStrategy interface { | ||
| Report(projectName string, report string, reportFormatter func(report string) string) (error error) | ||
| Flush(ciService ci.PullRequestService, PrNumber int, supportsCollapsibleComment bool) (commentId []string, commentUrl []string, error error) | ||
| Suppress(projectName string) error | ||
| } | ||
|
|
||
| type ReportFormat struct { | ||
| Report string | ||
| ReportFormatter func(report string) string | ||
| } | ||
|
|
||
| type SingleCommentStrategy struct { | ||
| TimeOfRun time.Time | ||
| formatters map[string][]ReportFormat | ||
| } | ||
|
|
||
| func NewSingleCommentStrategy() SingleCommentStrategy { | ||
| return SingleCommentStrategy{ | ||
| TimeOfRun: time.Now(), | ||
| formatters: make(map[string][]ReportFormat), | ||
| } | ||
| } | ||
|
|
||
| func (strategy SingleCommentStrategy) Report(projectName string, report string, reportFormatter func(report string) string) error { | ||
| if _, exists := strategy.formatters[projectName]; !exists { | ||
| strategy.formatters[projectName] = []ReportFormat{} | ||
| } | ||
| strategy.formatters[projectName] = append(strategy.formatters[projectName], ReportFormat{ | ||
| Report: report, | ||
| ReportFormatter: reportFormatter, | ||
| }) | ||
|
|
||
| return nil | ||
| } | ||
|
|
||
| func (strategy SingleCommentStrategy) Flush(ciService ci.PullRequestService, PrNumber int, supportsCollapsibleComment bool) ([]string, []string, error) { | ||
| var completeComment = "" | ||
| for projectName, projectFormatters := range strategy.formatters { | ||
| projectTitle := "report for " + projectName + " " + strategy.TimeOfRun.Format("2006-01-02 15:04:05 (MST)") | ||
| var projectComment = "" | ||
| for _, f := range projectFormatters { | ||
| report := f.ReportFormatter(f.Report) | ||
| projectComment = projectComment + "\n" + report | ||
| } | ||
| if !supportsCollapsibleComment { | ||
| projectComment = utils.AsComment(projectTitle)(projectComment) | ||
| } else { | ||
| projectComment = utils.AsCollapsibleComment(projectTitle, false)(projectComment) | ||
| } | ||
| completeComment = completeComment + "\n" + projectComment | ||
| } | ||
|
|
||
| c, err := ciService.PublishComment(PrNumber, completeComment) | ||
| if err != nil { | ||
| log.Printf("error while publishing reporter comment: %v", err) | ||
| return nil, nil, fmt.Errorf("error while publishing reporter comment: %v", err) | ||
| } | ||
| return []string{c.Id}, []string{c.Url}, nil | ||
| } | ||
|
|
||
| func (strategy SingleCommentStrategy) Suppress(projectName string) error { | ||
| // TODO: figure out how to suppress a particular project (probably pop it from the formatters map?) | ||
| return nil | ||
| } | ||
|
|
||
| type MultipleCommentsStrategy struct { | ||
| formatters map[string][]ReportFormat | ||
| TimeOfRun time.Time | ||
| } | ||
|
|
||
| func NewMultipleCommentsStrategy() MultipleCommentsStrategy { | ||
| return MultipleCommentsStrategy{ | ||
| TimeOfRun: time.Now(), | ||
| formatters: make(map[string][]ReportFormat), | ||
| } | ||
| } | ||
|
|
||
| func (strategy MultipleCommentsStrategy) Report(projectName string, report string, reportFormatter func(report string) string) error { | ||
| if _, exists := strategy.formatters[projectName]; !exists { | ||
| strategy.formatters[projectName] = []ReportFormat{} | ||
| } | ||
| strategy.formatters[projectName] = append(strategy.formatters[projectName], ReportFormat{ | ||
| Report: report, | ||
| ReportFormatter: reportFormatter, | ||
| }) | ||
|
|
||
| return nil | ||
| } | ||
|
|
||
| func (strategy MultipleCommentsStrategy) Flush(ciService ci.PullRequestService, PrNumber int, supportsCollapsibleComment bool) ([]string, []string, error) { | ||
| hasError := false | ||
| var latestError error = nil | ||
| commentIds := make([]string, 0) | ||
| commentUrls := make([]string, 0) | ||
| for projectName, projectFormatters := range strategy.formatters { | ||
| projectTitle := "Digger run report for " + projectName + " " + strategy.TimeOfRun.Format("2006-01-02 15:04:05 (MST)") | ||
| var projectComment = "" | ||
| for _, f := range projectFormatters { | ||
| report := f.ReportFormatter(f.Report) | ||
| projectComment = projectComment + "\n" + report | ||
| } | ||
| if !supportsCollapsibleComment { | ||
| projectComment = utils.AsComment(projectTitle)(projectComment) | ||
| } else { | ||
| projectComment = utils.AsCollapsibleComment(projectTitle, false)(projectComment) | ||
| } | ||
| c, err := ciService.PublishComment(PrNumber, projectComment) | ||
| if err != nil { | ||
| log.Printf("error while publishing reporter comment: %v", err) | ||
| hasError = true | ||
| latestError = err | ||
| // append placeholders | ||
| commentIds = append(commentIds, "0") | ||
| commentUrls = append(commentUrls, "") | ||
|
|
||
| } else { | ||
| commentIds = append(commentIds, c.Id) | ||
| commentUrls = append(commentUrls, c.Url) | ||
| } | ||
| } | ||
|
|
||
| if hasError { | ||
| log.Printf("could not publish all comments") | ||
| return commentIds, commentUrls, latestError | ||
| } | ||
|
|
||
| return commentIds, commentUrls, nil | ||
| } | ||
|
|
||
| func (strategy MultipleCommentsStrategy) Suppress(projectName string) error { | ||
| // TODO: figure out how to suppress a particular project (probably pop it from the formatters map?) | ||
| return nil | ||
| } | ||
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -5,7 +5,6 @@ import ( | ||
| "github.com/diggerhq/digger/libs/ci" | ||
| dg_configuration "github.com/diggerhq/digger/libs/digger_config" | ||
| "log" | ||
| ) | ||
|
|
||
| type SourceDetails struct { | ||
| @@ -28,15 +27,22 @@ func PostInitialSourceComments(ghService ci.PullRequestService, prNumber int, im | ||
| reporter := CiReporter{ | ||
| PrNumber: prNumber, | ||
| CiService: ghService, | ||
| ReportStrategy: NewSingleCommentStrategy(), | ||
| } | ||
|
|
||
| err := reporter.Report(location, "Comment Reporter", func(report string) string { return "" }) | ||
| if err != nil { | ||
| log.Printf("Error reporting source module comment: %v", err) | ||
| return nil, fmt.Errorf("error reporting source module comment: %v", err) | ||
| } | ||
|
|
||
| commentIds, _, err := reporter.Flush() | ||
| if err != nil { | ||
| log.Printf("Error reporting source module comment: %v", err) | ||
| return nil, fmt.Errorf("error reporting source module comment: %v", err) | ||
| } | ||
|
|
||
| sourceDetails = append(sourceDetails, SourceDetails{location, commentIds[0], projects}) | ||
| } | ||
|
|
||
| return sourceDetails, nil | ||
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -223,7 +223,7 @@ func (d DiggerExecutor) Plan() (*iac_utils.IacSummary, bool, bool, string, strin | ||
| if step.Action == "init" { | ||
| _, stderr, err := d.TerraformExecutor.Init(step.ExtraArgs, d.StateEnvVars) | ||
| if err != nil { | ||
| reportError(d.ProjectName, d.Reporter, stderr) | ||
| return nil, false, false, "", "", fmt.Errorf("error running init: %v", err) | ||
| } | ||
| } | ||
| @@ -288,18 +288,18 @@ func (d DiggerExecutor) Plan() (*iac_utils.IacSummary, bool, bool, string, strin | ||
| } | ||
| } | ||
| } | ||
| reportAdditionalOutput(d.Reporter, d.ProjectName) | ||
| return planSummary, true, !isEmptyPlan, plan, terraformPlanOutput, nil | ||
| } | ||
|
|
||
| func reportError(projectName string, r reporting.Reporter, stderr string) { | ||
| if r.SupportsMarkdown() { | ||
| commentErr := r.Report(projectName, stderr, utils.AsCollapsibleComment("Error during init.", false)) | ||
| if commentErr != nil { | ||
| log.Printf("error publishing comment: %v", commentErr) | ||
| } | ||
| } else { | ||
| commentErr := r.Report(projectName, stderr, utils.AsComment("Error during init.")) | ||
| if commentErr != nil { | ||
| log.Printf("error publishing comment: %v", commentErr) | ||
| } | ||
| @@ -337,7 +337,7 @@ func (d DiggerExecutor) Apply() (*iac_utils.IacSummary, bool, string, error) { | ||
| if step.Action == "init" { | ||
| stdout, stderr, err := d.TerraformExecutor.Init(step.ExtraArgs, d.StateEnvVars) | ||
| if err != nil { | ||
| reportTerraformError(d.ProjectName, d.Reporter, stderr) | ||
| return nil, false, stdout, fmt.Errorf("error running init: %v", err) | ||
| } | ||
| } | ||
| @@ -346,9 +346,9 @@ func (d DiggerExecutor) Apply() (*iac_utils.IacSummary, bool, string, error) { | ||
| stdout, stderr, err := d.TerraformExecutor.Apply(applyArgs, plansFilename, d.CommandEnvVars) | ||
| applyOutput = cleanupTerraformApply(true, err, stdout, stderr) | ||
|
|
||
| reportTerraformApplyOutput(d.Reporter, d.ProjectName, applyOutput) | ||
| if err != nil { | ||
| reportApplyError(d.ProjectName, d.Reporter, err) | ||
| return nil, false, stdout, fmt.Errorf("error executing apply: %v", err) | ||
| } | ||
|
|
||
| @@ -370,65 +370,65 @@ func (d DiggerExecutor) Apply() (*iac_utils.IacSummary, bool, string, error) { | ||
| } | ||
| } | ||
| } | ||
| reportAdditionalOutput(d.Reporter, d.ProjectName) | ||
| return &summary, true, applyOutput, nil | ||
| } | ||
|
|
||
| func reportApplyError(projectName string, r reporting.Reporter, err error) { | ||
| if r.SupportsMarkdown() { | ||
| commentErr := r.Report(projectName, err.Error(), utils.AsCollapsibleComment("Error during applying.", false)) | ||
| if commentErr != nil { | ||
| log.Printf("error publishing comment: %v", err) | ||
| } | ||
| } else { | ||
| commentErr := r.Report(projectName, err.Error(), utils.AsComment("Error during applying.")) | ||
| if commentErr != nil { | ||
| log.Printf("error publishing comment: %v", err) | ||
| } | ||
| } | ||
| } | ||
|
|
||
| func reportTerraformApplyOutput(r reporting.Reporter, projectName string, applyOutput string) { | ||
| var formatter func(string) string | ||
| if r.SupportsMarkdown() { | ||
| formatter = utils.GetTerraformOutputAsCollapsibleComment("Apply output", false) | ||
| } else { | ||
| formatter = utils.GetTerraformOutputAsComment("Apply output") | ||
| } | ||
|
|
||
| commentErr := r.Report(projectName, applyOutput, formatter) | ||
| if commentErr != nil { | ||
| log.Printf("error publishing comment: %v", commentErr) | ||
| } | ||
| } | ||
|
|
||
| func reportTerraformError(projectName string, r reporting.Reporter, stderr string) { | ||
| if r.SupportsMarkdown() { | ||
| commentErr := r.Report(projectName, stderr, utils.GetTerraformOutputAsCollapsibleComment("Error during init.", false)) | ||
| if commentErr != nil { | ||
| log.Printf("error publishing comment: %v", commentErr) | ||
| } | ||
| } else { | ||
| commentErr := r.Report(projectName, stderr, utils.GetTerraformOutputAsComment("Error during init.")) | ||
| if commentErr != nil { | ||
| log.Printf("error publishing comment: %v", commentErr) | ||
| } | ||
| } | ||
| } | ||
|
|
||
| func reportAdditionalOutput(r reporting.Reporter, projectName string) { | ||
| var formatter func(string) string | ||
| if r.SupportsMarkdown() { | ||
| formatter = utils.GetTerraformOutputAsCollapsibleComment("Additional output for <b>"+projectName+"</b>", false) | ||
| } else { | ||
| formatter = utils.GetTerraformOutputAsComment("Additional output for " + projectName) | ||
| } | ||
| diggerOutPath := os.Getenv("DIGGER_OUT") | ||
| if _, err := os.Stat(diggerOutPath); err == nil { | ||
| output, _ := os.ReadFile(diggerOutPath) | ||
| outputStr := string(output) | ||
| if len(outputStr) > 0 { | ||
| commentErr := r.Report(projectName, outputStr, formatter) | ||
| if commentErr != nil { | ||
| log.Printf("error publishing comment: %v", commentErr) | ||
| } | ||
| @@ -459,7 +459,7 @@ func (d DiggerExecutor) Destroy() (bool, error) { | ||
| if step.Action == "init" { | ||
| _, stderr, err := d.TerraformExecutor.Init(step.ExtraArgs, d.StateEnvVars) | ||
| if err != nil { | ||
| reportError(d.ProjectName, d.Reporter, stderr) | ||
| return false, fmt.Errorf("error running init: %v", err) | ||
| } | ||
| } | ||
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -74,7 +74,7 @@ func (projectLock *PullRequestLock) Lock() (bool, error) { | ||
| transactionIdStr := strconv.Itoa(*existingLockTransactionId) | ||
| comment := "Project " + projectLock.projectId() + " locked by another PR #" + transactionIdStr + " (failed to acquire lock " + projectLock.ProjectNamespace + "). The locking plan must be applied or discarded before future plans can execute" | ||
|
|
||
| reportLockingFailed(projectLock.ProjectName, projectLock.Reporter, comment) | ||
| return false, fmt.Errorf(comment) | ||
| } | ||
| } | ||
| @@ -87,35 +87,35 @@ func (projectLock *PullRequestLock) Lock() (bool, error) { | ||
|
|
||
| if lockAcquired && !isNoOpLock { | ||
| comment := "Project " + projectLock.projectId() + " has been locked by PR #" + strconv.Itoa(projectLock.PrNumber) | ||
| reportingLockingSuccess(projectLock.ProjectName, projectLock.Reporter, comment) | ||
| log.Println("project " + projectLock.projectId() + " locked successfully. PR # " + strconv.Itoa(projectLock.PrNumber)) | ||
|
|
||
| } | ||
| return lockAcquired, nil | ||
| } | ||
|
|
||
| func reportingLockingSuccess(projectName string, r reporting.Reporter, comment string) { | ||
| if r.SupportsMarkdown() { | ||
| err := r.Report(projectName, comment, utils.AsCollapsibleComment("Locking successful", false)) | ||
| if err != nil { | ||
| log.Println("failed to publish comment: " + err.Error()) | ||
| } | ||
| } else { | ||
| err := r.Report(projectName, comment, utils.AsComment("Locking successful")) | ||
| if err != nil { | ||
| log.Println("failed to publish comment: " + err.Error()) | ||
| } | ||
| } | ||
| } | ||
|
|
||
| func reportLockingFailed(projectName string, r reporting.Reporter, comment string) { | ||
| if r.SupportsMarkdown() { | ||
| err := r.Report(projectName, comment, utils.AsCollapsibleComment("Locking failed", false)) | ||
| if err != nil { | ||
| log.Println("failed to publish comment: " + err.Error()) | ||
| } | ||
| } else { | ||
| err := r.Report(projectName, comment, utils.AsComment("Locking failed")) | ||
| if err != nil { | ||
| log.Println("failed to publish comment: " + err.Error()) | ||
| } | ||
| @@ -146,7 +146,7 @@ func (projectLock *PullRequestLock) verifyNoHangingLocks() (bool, error) { | ||
| } | ||
| transactionIdStr := strconv.Itoa(*transactionId) | ||
| comment := "Project " + projectLock.projectId() + " locked by another PR #" + transactionIdStr + "(failed to acquire lock " + projectLock.ProjectName + "). The locking plan must be applied or discarded before future plans can execute" | ||
| reportLockingFailed(projectLock.ProjectName, projectLock.Reporter, comment) | ||
| return false, fmt.Errorf(comment) | ||
| } | ||
| return true, nil | ||
| @@ -171,7 +171,7 @@ func (projectLock *PullRequestLock) Unlock() (bool, error) { | ||
| } | ||
| if lockReleased { | ||
| comment := "Project unlocked (" + projectLock.projectId() + ")." | ||
| reportSuccessfulUnlocking(projectLock.ProjectName, projectLock.Reporter, comment) | ||
|
|
||
| log.Println("Project unlocked") | ||
| return true, nil | ||
| @@ -181,14 +181,14 @@ func (projectLock *PullRequestLock) Unlock() (bool, error) { | ||
| return false, nil | ||
| } | ||
|
|
||
| func reportSuccessfulUnlocking(projectName string, r reporting.Reporter, comment string) { | ||
| if r.SupportsMarkdown() { | ||
| err := r.Report(projectName, comment, utils.AsCollapsibleComment("Unlocking successful", false)) | ||
| if err != nil { | ||
| log.Println("failed to publish comment: " + err.Error()) | ||
| } | ||
| } else { | ||
| err := r.Report(projectName, comment, utils.AsComment("Unlocking successful")) | ||
| if err != nil { | ||
| log.Println("failed to publish comment: " + err.Error()) | ||
| } | ||
| @@ -210,7 +210,7 @@ func (projectLock *PullRequestLock) ForceUnlock() error { | ||
|
|
||
| if lockReleased { | ||
| comment := "Project unlocked (" + projectLock.projectId() + ")." | ||
| reportSuccessfulUnlocking(projectLock.ProjectName, projectLock.Reporter, comment) | ||
| log.Println("Project unlocked") | ||
| } | ||
| return nil | ||
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -5,9 +5,10 @@ import ( | ||
| ) | ||
|
|
||
| type ReporterSpec struct { | ||
| ReporterType string `json:"reporter_type"` | ||
| ReportingStrategy string `json:"reporting_strategy"` | ||
| ReportTerraformOutput bool `json:"report_terraform_output"` | ||
| ReportCommentId *string `json:"report_comment_id,omitempty"` | ||
| } | ||
|
|
||
| type CommentUpdaterSpec struct { | ||
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -27,7 +27,6 @@ import ( | ||
| "net/http" | ||
| "os" | ||
| "strings" | ||
| ) | ||
|
|
||
| type JobSpecProvider struct{} | ||
| @@ -117,16 +116,9 @@ func (r ReporterProvider) GetReporter(title string, reporterSpec ReporterSpec, c | ||
| getStrategy := func(strategy string) reporting.ReportStrategy { | ||
| switch reporterSpec.ReportingStrategy { | ||
| case "comments_per_run": | ||
| return reporting.NewSingleCommentStrategy() | ||
| default: | ||
| return reporting.NewMultipleCommentsStrategy() | ||
| } | ||
| } | ||
|
|
||
| @@ -141,15 +133,6 @@ func (r ReporterProvider) GetReporter(title string, reporterSpec ReporterSpec, c | ||
| IsSupportMarkdown: true, | ||
| ReportStrategy: strategy, | ||
| }, nil | ||
| default: | ||
| return reporting.NoopReporter{}, nil | ||
| } | ||
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Fix incorrect error message in placeholder comment creation
The error message incorrectly references "strconv.ParseInt" when the error is from publishing a comment.
Apply this fix:
placeholderComment, err := ghService.PublishComment(prNumber, "digger report placehoder") if err != nil { - log.Printf("strconv.ParseInt error: %v", err) + log.Printf("failed to publish placeholder comment: %v", err) commentReporterManager.UpdateComment(fmt.Sprintf(":x: could not create placeholder commentId for report: %v", err)) return fmt.Errorf("comment reporter error: %v", err) }📝 Committable suggestion