Merge pull request #1270 from rawlingsj/master

jenkins-x-bot-test · web-flow · commit cf1c5ac6865f · 2021-04-01T12:18:27.000+01:00
chore: to improve kick the tyres experience and reduce the barrier to…
diff --git a/go.sum b/go.sum
@@ -465,6 +465,8 @@ github.com/jcmturner/gofork v0.0.0-20190328161633-dc7c13fece03/go.mod h1:MK8+TM0
 github.com/jcmturner/gofork v1.0.0/go.mod h1:MK8+TM0La+2rjBD4jE12Kj1pCCxK7d2LK/UM3ncEo0o=
 github.com/jenkins-x/go-scm v1.6.7 h1:Tc8yLV1B0OdKCbtQX76Bc5FfbsvShqa+HWrTky92vGY=
 github.com/jenkins-x/go-scm v1.6.7/go.mod h1:yVqpMl3ZSkPWVcPi9EhcK3QtTM/anrtYqI//FqwrdxQ=
+github.com/jenkins-x/go-scm v1.6.11 h1:rfynVghXbrJAC/wSSrBg2Qddgs1N0/HNjbuu2PGjAWM=
+github.com/jenkins-x/go-scm v1.6.11/go.mod h1:yVqpMl3ZSkPWVcPi9EhcK3QtTM/anrtYqI//FqwrdxQ=
 github.com/jenkins-x/pipeline v0.3.2-0.20210223153617-0d1186b27496 h1:yN90dXuD7TkAkYwKr5h2fT7bjA7osK7tMhuz31qL7gE=
 github.com/jenkins-x/pipeline v0.3.2-0.20210223153617-0d1186b27496/go.mod h1:y1XwzBDu4EmOCfoeV2cUW2icCto/izTyjEKK5j0UmwA=
 github.com/jessevdk/go-flags v1.4.0/go.mod h1:4FA24M0QyGHXBuZZK/XkWh8h0e1EYbRYJSGM75WSRxI=
diff --git a/pkg/plugins/approve/approve.go b/pkg/plugins/approve/approve.go
@@ -175,7 +175,7 @@ func handleGenericComment(log *logrus.Entry, spc scmProviderClient, oc ownersCli
 	}
 
 	opts := optionsForRepo(config, ce.Repo.Namespace, ce.Repo.Name)
-	if !isApprovalCommand(botName, opts.LgtmActsAsApprove, &comment{Body: ce.Body, Author: ce.Author.Login}) {
+	if !isApprovalCommand(log, botName, opts.LgtmActsAsApprove, &comment{Body: ce.Body, Author: ce.Author.Login}) {
 		return nil
 	}
 
@@ -242,7 +242,7 @@ func handleReview(log *logrus.Entry, spc scmProviderClient, oc ownersClient, ser
 	// Check for an approval command is in the body. If one exists, let the
 	// genericCommentEventHandler handle this event. Approval commands override
 	// review state.
-	if isApprovalCommand(botName, opts.LgtmActsAsApprove, &comment{Body: re.Review.Body, Author: re.Review.Author.Login}) {
+	if isApprovalCommand(log, botName, opts.LgtmActsAsApprove, &comment{Body: re.Review.Body, Author: re.Review.Author.Login}) {
 		return nil
 	}
 
@@ -442,7 +442,7 @@ func handle(log *logrus.Entry, spc scmProviderClient, repo approvers.Repo, baseU
 	sort.SliceStable(comments, func(i, j int) bool {
 		return comments[i].Created.Before(comments[j].Created)
 	})
-	approveComments := filterComments(comments, approvalMatcher(botName, opts.LgtmActsAsApprove, opts.ConsiderReviewState()))
+	approveComments := filterComments(comments, approvalMatcher(log, botName, opts.LgtmActsAsApprove, opts.ConsiderReviewState()))
 	addApprovers(&approversHandler, approveComments, pr.author, opts.ConsiderReviewState())
 
 	for _, user := range pr.assignees {
@@ -513,14 +513,17 @@ func humanAddedApproved(spc scmProviderClient, log *logrus.Entry, org, repo stri
 	}
 }
 
-func approvalMatcher(botName string, lgtmActsAsApprove, reviewActsAsApprove bool) func(*comment) bool {
+func approvalMatcher(log *logrus.Entry, botName string, lgtmActsAsApprove, reviewActsAsApprove bool) func(*comment) bool {
 	return func(c *comment) bool {
-		return isApprovalCommand(botName, lgtmActsAsApprove, c) || isApprovalState(botName, reviewActsAsApprove, c)
+		return isApprovalCommand(log, botName, lgtmActsAsApprove, c) || isApprovalState(botName, reviewActsAsApprove, c)
 	}
 }
 
-func isApprovalCommand(botName string, lgtmActsAsApprove bool, c *comment) bool {
-	if c.Author == botName || isDeprecatedBot(c.Author) {
+func isApprovalCommand(log *logrus.Entry, botName string, lgtmActsAsApprove bool, c *comment) bool {
+	if c.Author == botName {
+		log.Warn("Approval is made by the bot, for production installs it is recommended to use a different bot user account that your personal one")
+	}
+	if isDeprecatedBot(c.Author) {
 		return false
 	}
 
diff --git a/pkg/plugins/trigger/generic-comment.go b/pkg/plugins/trigger/generic-comment.go
@@ -42,8 +42,7 @@ func handleGenericComment(c Client, trigger *plugins.Trigger, gc scmprovider.Gen
 		return err
 	}
 	if commentAuthor == botName {
-		c.Logger.Debug("Comment is made by the bot, skipping.")
-		return nil
+		c.Logger.Warn("Comment is made by the bot, for production installs it is recommended to use a different bot user account that your personal one")
 	}
 
 	pr, err := c.SCMProviderClient.GetPullRequest(org, repo, number)

Original file line number	Diff line number	Diff line change
`@@ -175,7 +175,7 @@ func handleGenericComment(log *logrus.Entry, spc scmProviderClient, oc ownersCli`
`175`	`175`	`}`
`176`	`176`
`177`	`177`	`opts := optionsForRepo(config, ce.Repo.Namespace, ce.Repo.Name)`
`178`		`- if !isApprovalCommand(botName, opts.LgtmActsAsApprove, &comment{Body: ce.Body, Author: ce.Author.Login}) {`
	`178`	`+ if !isApprovalCommand(log, botName, opts.LgtmActsAsApprove, &comment{Body: ce.Body, Author: ce.Author.Login}) {`
`179`	`179`	`return nil`
`180`	`180`	`}`
`181`	`181`
`@@ -242,7 +242,7 @@ func handleReview(log *logrus.Entry, spc scmProviderClient, oc ownersClient, ser`
`242`	`242`	`// Check for an approval command is in the body. If one exists, let the`
`243`	`243`	`// genericCommentEventHandler handle this event. Approval commands override`
`244`	`244`	`// review state.`
`245`		`- if isApprovalCommand(botName, opts.LgtmActsAsApprove, &comment{Body: re.Review.Body, Author: re.Review.Author.Login}) {`
	`245`	`+ if isApprovalCommand(log, botName, opts.LgtmActsAsApprove, &comment{Body: re.Review.Body, Author: re.Review.Author.Login}) {`
`246`	`246`	`return nil`
`247`	`247`	`}`
`248`	`248`
`@@ -442,7 +442,7 @@ func handle(log *logrus.Entry, spc scmProviderClient, repo approvers.Repo, baseU`
`442`	`442`	`sort.SliceStable(comments, func(i, j int) bool {`
`443`	`443`	`return comments[i].Created.Before(comments[j].Created)`
`444`	`444`	`})`
`445`		`- approveComments := filterComments(comments, approvalMatcher(botName, opts.LgtmActsAsApprove, opts.ConsiderReviewState()))`
	`445`	`+ approveComments := filterComments(comments, approvalMatcher(log, botName, opts.LgtmActsAsApprove, opts.ConsiderReviewState()))`
`446`	`446`	`addApprovers(&approversHandler, approveComments, pr.author, opts.ConsiderReviewState())`
`447`	`447`
`448`	`448`	`for _, user := range pr.assignees {`
`@@ -513,14 +513,17 @@ func humanAddedApproved(spc scmProviderClient, log *logrus.Entry, org, repo stri`
`513`	`513`	`}`
`514`	`514`	`}`
`515`	`515`
`516`		`-func approvalMatcher(botName string, lgtmActsAsApprove, reviewActsAsApprove bool) func(*comment) bool {`
	`516`	`+func approvalMatcher(log logrus.Entry, botName string, lgtmActsAsApprove, reviewActsAsApprove bool) func(comment) bool {`
`517`	`517`	`return func(c *comment) bool {`
`518`		`- return isApprovalCommand(botName, lgtmActsAsApprove, c) \|\| isApprovalState(botName, reviewActsAsApprove, c)`
	`518`	`+ return isApprovalCommand(log, botName, lgtmActsAsApprove, c) \|\| isApprovalState(botName, reviewActsAsApprove, c)`
`519`	`519`	`}`
`520`	`520`	`}`
`521`	`521`
`522`		`-func isApprovalCommand(botName string, lgtmActsAsApprove bool, c *comment) bool {`
`523`		`- if c.Author == botName \|\| isDeprecatedBot(c.Author) {`
	`522`	`+func isApprovalCommand(log logrus.Entry, botName string, lgtmActsAsApprove bool, c comment) bool {`
	`523`	`+ if c.Author == botName {`
	`524`	`+ log.Warn("Approval is made by the bot, for production installs it is recommended to use a different bot user account that your personal one")`
	`525`	`+ }`
	`526`	`+ if isDeprecatedBot(c.Author) {`
`524`	`527`	`return false`
`525`	`528`	`}`
`526`	`529`
Original file line number	Diff line number	Diff line change
`@@ -42,8 +42,7 @@ func handleGenericComment(c Client, trigger *plugins.Trigger, gc scmprovider.Gen`
`42`	`42`	`return err`
`43`	`43`	`}`
`44`	`44`	`if commentAuthor == botName {`
`45`		`- c.Logger.Debug("Comment is made by the bot, skipping.")`
`46`		`- return nil`
	`45`	`+ c.Logger.Warn("Comment is made by the bot, for production installs it is recommended to use a different bot user account that your personal one")`
`47`	`46`	`}`
`48`	`47`
`49`	`48`	`pr, err := c.SCMProviderClient.GetPullRequest(org, repo, number)`