Add new configuration that limits the issue auto-link feature

Author: mbellade

README.md

@@ -41,7 +41,8 @@ with the following content:
 ---
 jira:
   projectKey: "HSEARCH" # Change to whatever your project key is
-  insertLinksInPullRequests: true # This is optional and enables automatically adding issue links to PR descriptions
+  insertLinksInPullRequests: true # This is optional and enables automatically adding links to Jira issues found in a PR's commits to its description
+  linkIssuesLimit: 3 # This is optional and allows disabling automatic issue links when more than the specified number of keys are found in a PR's commits (defaults to 3)
   # To skip JIRA-related checks (pull request title/body includes JIRA issue keys/links etc.),
   # a list of ignore rules can be configured:
   ignore:

src/main/java/org/hibernate/infra/bot/CheckPullRequestContributionRules.java

@@ -138,12 +138,14 @@ private List<Check> createChecks(RepositoryConfig repositoryConfig) {
 		checks.add( new TitleCheck() );
 
 		if ( repositoryConfig != null && repositoryConfig.jira != null ) {
-			final boolean checkMentions = repositoryConfig.jira.getInsertLinksInPullRequests().isEmpty()
-					|| repositoryConfig.jira.getInsertLinksInPullRequests().get().equals( Boolean.FALSE );
+			final Integer issueLinksLimit = repositoryConfig.jira.getInsertLinksInPullRequests().isPresent()
+					&& repositoryConfig.jira.getInsertLinksInPullRequests().get().equals( Boolean.TRUE )
+					? repositoryConfig.jira.getIssueLinksLimit()
+					: null;
 			repositoryConfig.jira.getIssueKeyPattern()
 					.ifPresent( issueKeyPattern -> checks.add(
 							new JiraIssuesCheck(
-									issueKeyPattern, checkMentions, repositoryConfig.jira.getIgnore(),
+									issueKeyPattern, issueLinksLimit, repositoryConfig.jira.getIgnore(),
 									repositoryConfig.jira.getIgnoreFiles()
 							) ) );
 		}
@@ -172,17 +174,17 @@ static class JiraIssuesCheck extends Check {
 
 		private final Pattern issueKeyPattern;
 
-		private final boolean checkMentions;
+		private final Integer issueLinksLimit;
 
 		private final List<RepositoryConfig.IgnoreConfiguration> ignoredPRConfigurations;
 		private final GlobMatcher ignoredFilesMatcher;
 
-		JiraIssuesCheck(Pattern issueKeyPattern, boolean checkMentions,
+		JiraIssuesCheck(Pattern issueKeyPattern, Integer issueLinksLimit,
 				List<RepositoryConfig.IgnoreConfiguration> ignoredPRConfigurations,
 				List<String> ignoreFilePatterns) {
 			super( "Contribution — JIRA issues" );
 			this.issueKeyPattern = issueKeyPattern;
-			this.checkMentions = checkMentions;
+			this.issueLinksLimit = issueLinksLimit;
 			this.ignoredPRConfigurations = ignoredPRConfigurations;
 			this.ignoredFilesMatcher = new GlobMatcher( ignoreFilePatterns );
 		}
@@ -222,7 +224,7 @@ public void perform(CheckRunContext context, CheckRunOutput output) throws IOExc
 				commitRule.failed( "Offending commits: " + commitsWithMessageNotStartingWithIssueKey );
 			}
 
-			if ( checkMentions ) {
+			if ( issueLinksLimit == null || issueKeys.size() > issueLinksLimit ) {
 				// We only need to check mentions if automatic body editing is disabled
 				CheckRunRule pullRequestRule = output.rule(
 						"The PR title or body should list the keys of all JIRA issues mentioned in the commits" );

src/main/java/org/hibernate/infra/bot/EditPullRequestBodyAddIssueLinks.java

@@ -79,6 +79,10 @@ private void editPullRequestBodyAddIssueLinks(
 			LOG.debug( "Found no issue keys in commits, terminating." );
 			return;
 		}
+		else if ( issueKeys.size() > repositoryConfig.jira.getIssueLinksLimit() ) {
+			LOG.debug( "Found more issues than the configured limit, terminating." );
+			return;
+		}
 
 		final String originalBody = Objects.toString( pullRequest.getBody(), "" );
 

src/main/java/org/hibernate/infra/bot/config/RepositoryConfig.java

@@ -15,6 +15,7 @@ public static class JiraConfig {
 		private Optional<Pattern> issueKeyPattern = Optional.empty();
 
 		private Optional<Boolean> insertLinksInPullRequests = Optional.empty();
+		private Integer issueLinksLimit = 3;
 
 		private List<IgnoreConfiguration> ignore = Collections.emptyList();
 
@@ -36,6 +37,14 @@ public Optional<Boolean> getInsertLinksInPullRequests() {
 			return insertLinksInPullRequests;
 		}
 
+		public Integer getIssueLinksLimit() {
+			return issueLinksLimit;
+		}
+
+		public void setIssueLinksLimit(Integer issueLinksLimit) {
+			this.issueLinksLimit = issueLinksLimit;
+		}
+
 		public List<IgnoreConfiguration> getIgnore() {
 			return ignore;
 		}

src/test/java/org/hibernate/infra/bot/tests/EditPullRequestBodyAddIssueLinksTest.java

@@ -15,8 +15,10 @@
 
 import static io.quarkiverse.githubapp.testing.GitHubAppTesting.given;
 import static org.assertj.core.api.Assertions.assertThat;
+import static org.mockito.Mockito.never;
 import static org.mockito.Mockito.times;
 import static org.mockito.Mockito.verify;
+import static org.mockito.Mockito.verifyNoMoreInteractions;
 import static org.mockito.Mockito.when;
 
 @QuarkusTest
@@ -232,4 +234,55 @@ void bodyContainsAllIssues() throws IOException {
 				} );
 	}
 
+
+	@Test
+	void tooManyIssues() throws IOException {
+		long repoId = 344815557L;
+		long prId = 585627026L;
+		given()
+				.github( mocks -> {
+					mocks.configFile("hibernate-github-bot.yml")
+							.fromString( """
+									jira:
+									  projectKey: "HSEARCH"
+									  insertLinksInPullRequests: true
+									  issueLinksLimit: 3
+									""" );
+
+					GHRepository repoMock = mocks.repository( "yrodiere/hibernate-github-bot-playground" );
+					when( repoMock.getId() ).thenReturn( repoId );
+
+					PullRequestMockHelper.start( mocks, prId, repoMock )
+							.commit( "HSEARCH-1111 Commit 1" )
+							.commit( "HSEARCH-1112 Commit 2" )
+							.commit( "HSEARCH-1113 HSEARCH-1114 HSEARCH-1115 Commit 3" )
+							.commit( "HSEARCH-1116 Commit 4" )
+							.comment( "Some comment" )
+							.comment( "Some other comment" );
+
+					mockCheckRuns( repoMock, "6e9f11a1e2946b207c6eb245ec942f2b5a3ea156" );
+				} )
+				.when()
+				.payloadFromClasspath( "/pullrequest-opened-hsearch-1111.json" )
+				.event( GHEvent.PULL_REQUEST )
+				.then()
+				.github( mocks -> {
+					GHPullRequest prMock = mocks.pullRequest( prId );
+					ArgumentCaptor<String> bodyCaptor = ArgumentCaptor.forClass( String.class );
+					verify( prMock, never() ).setBody( bodyCaptor.capture() );
+					ArgumentCaptor<String> commentCaptor = ArgumentCaptor.forClass( String.class );
+					verify( prMock ).comment( commentCaptor.capture() );
+					assertThat( commentCaptor.getValue() )
+							.isEqualTo( """
+									Thanks for your pull request!
+
+									This pull request does not follow the contribution rules. Could you have a look?
+
+									❌ The PR title or body should list the keys of all JIRA issues mentioned in the commits
+									    ↳ Issue keys mentioned in commits but missing from the PR title or body: [HSEARCH-1112, HSEARCH-1113, HSEARCH-1114, HSEARCH-1115, HSEARCH-1116]
+
+									› This message was automatically generated.""" );
+					verifyNoMoreInteractions( mocks.ghObjects() );
+				} );
+	}
 }