Let the footer be generated without conf.Feedback

Signed-off-by: David Pordomingo <[email protected]>

Author: dpordomingo

.helm-staging.yml

@@ -27,7 +27,7 @@ providers:
     app_id: 17877
     private_key: /local/lookout/private-key.pem
     secretName: lookout-staging-github-key
-    comment_footer: "_If you have feedback about this comment made by the analyzer {{.Name}}, please, [tell us]({{.Feedback}})._"
+    comment_footer: "_If you have feedback about this comment made by the analyzer {{.Name}}{{with .Feedback}}, please, [tell us]({{.}}){{end}}._"
     installation_sync_interval: 5m
 
 analyzers:

config.yml.tpl

@@ -8,7 +8,7 @@ analyzers:
 
 providers:
   github:
-    comment_footer: "_If you have feedback about this comment made by the analyzer {{.Name}}, please, [tell us]({{.Feedback}})._"
+    comment_footer: "_If you have feedback about this comment made by the analyzer {{.Name}}{{with .Feedback}}, please, [tell us]({{.}}){{end}}._"
     # The minimum watch interval to discover new pull requests and push events
     watch_min_interval: 2s
     # Authorization with GitHub App

docs/configuration.md

@@ -39,7 +39,7 @@ The `providers.github` key configures how **source{d} Lookout** will connect wit
 ```yaml
 providers:
   github:
-    comment_footer: "_Comment made by analyzer '{{.Name}}', [report]({{.Feedback}})._"
+    comment_footer: "_Comment made by '{{.Name}}'{{with .Feedback}}, [tell us]({{.}}){{end}}._"
     # app_id: 1234
     # private_key: ./key.pem
     # installation_sync_interval: 1h
@@ -141,29 +141,30 @@ analyzers:
 
 ### Add a Custom Message to the Posted Comments
 
-You can configure **source{d} Lookout** to add a custom message to every comment that each analyzer returns. This custom message will be created from the template defined by `providers.github.comment_footer`, using the `name` and `feedback` set for each analyzer.
+You can configure **source{d} Lookout** to add a custom message to every comment that each analyzer returns. This custom message will be created from the template defined by `providers.github.comment_footer`, using the configuration set for each analyzer.
 
 If the template (`providers.github.comment_footer`) is empty, or the analyzer configuration does not define any of the values that the template requires, the custom message won't be added.
 
-For example, for this configuration, each analyzer needs to define `name` and `feedback`:
+For example, for this configuration, each analyzer needs to define `name` and `settings.email`:
 
 ```yaml
 providers:
   github:
-    comment_footer: "Comment made by analyzer {{.Name}}, [report]({{.Feedback}})."
+    comment_footer: "Comment made by analyzer {{.Name}}, [email me]({{.Settings.email}})."
 
 analyzers:
   - name: Fancy Analyzer
     addr: ipv4://localhost:9930
-    feedback: http://example.com/report-issue
+    settings:
+      email: [email protected]
   - name: Awesome Analyzer
     addr: ipv4://localhost:9931
 ```
 
 Comments from `Fancy Analyzer` will have this footer appended:
->_Comment made by analyzer Fancy Analyzer, [report](http://example.com/report-issue)._
+>_Comment made by analyzer Fancy Analyzer, [email me](admin@example.org)._
 
-but comments from `Awesome Analyzer` will not have a footer message because its configuration is missing a `feedback` value.
+but comments from `Awesome Analyzer` wont have a footer message because in its configuration it's missing the `settings.email` value.
 
 
 ## Timeouts

provider/github/review.go

@@ -31,11 +31,10 @@ const commentsSeparator = "\n<!-- lookout comment separator -->\n---\n"
 const footnoteSeparator = "\n<!-- lookout footnote separator -->\n"
 
 var (
-	ErrEmptyTemplate   = errors.NewKind("empty footer template")
-	ErrOldTemplate     = errors.NewKind("old footer template: '%%s' placeholder is no longer supported: '%s'")
-	ErrParseTemplate   = errors.NewKind("error parsing footer template: %s")
-	ErrNoDataForFooter = errors.NewKind("there is no enough data to generate the footer")
-	ErrTemplateError   = errors.NewKind("error generating the footer: %s")
+	ErrEmptyTemplate = errors.NewKind("empty footer template")
+	ErrOldTemplate   = errors.NewKind("old footer template: '%%s' placeholder is no longer supported: '%s'")
+	ErrParseTemplate = errors.NewKind("error parsing footer template: %s")
+	ErrTemplateError = errors.NewKind("error generating the footer: %s")
 )
 
 // createReview creates pull request review on github using multiple http calls
@@ -245,16 +244,13 @@ func addFootnote(
 	footer, err := getFootnote(tmpl, analyzerConf)
 	if err != nil {
 		ctxlog.Get(ctx).Warningf("footer could not be generated: %s", err)
+		return comment
 	}
 
 	return comment + footer
 }
 
 func getFootnote(tmpl *template.Template, analyzerConf *lookout.AnalyzerConfig) (string, error) {
-	if analyzerConf == nil || analyzerConf.Feedback == "" || analyzerConf.Name == "" {
-		return "", ErrNoDataForFooter.New()
-	}
-
 	var footer strings.Builder
 	if err := tmpl.Execute(&footer, analyzerConf); err != nil {
 		return "", ErrTemplateError.New(err)

provider/github/review_test.go

@@ -233,8 +233,4 @@ func TestCouldNotExecuteFooterTemplate(t *testing.T) {
 	require.Nil(err)
 	commentsWrongTemplate := addFootnote(context.TODO(), "comments", unkonwnDataTemplate, nil)
 	require.Equal("comments", commentsWrongTemplate)
-
-	footerWrongTemplate, err := getFootnote(unkonwnDataTemplate, nil)
-	require.True(ErrNoDataForFooter.Is(err))
-	require.Equal("", footerWrongTemplate)
 }