SONARJAVA-6196 S1451 should provide a default template for headers

[NoemieBenard]

Add default template for headerFormat in S1451.

[hashicorp-vault-sonar-prod]

SONARJAVA-6196

[sonar-review-alpha]

Summary

Changed S1451 (file header check) to provide a default header template instead of an empty default.

The check previously required users to manually configure a headerFormat property or the rule would be inactive. This PR adds a sensible default—a copyright/license header template with placeholders (<Your-Product-Name>, <Year-From>-<Year-To>, <Your-Company-Name>) that users can customize in their quality profile.

The implementation also distinguishes between "no header required" (explicit empty string) and "default header" (the new template), ensuring that when headerFormat is explicitly set to empty, no header issues are flagged. Tests confirm both cases work correctly.

What reviewers should know

Key changes to review:

• DEFAULT_HEADER_FORMAT constant (line 34): Changed from "" to a multi-line copyright/license template with instruction text
• setContext() logic (line 68-71): Added explicit handling for empty headerFormat to skip header checking without errors
• Test additions: New test cases verify that empty headerFormat produces no issues, and that files with the default header template pass

Why this matters:

• Before: Users had to supply a header format or the rule was pointless; no out-of-box experience
• After: The rule has a sensible default that users will see immediately, with clear placeholders to customize

Watch for:

• The empty-string check happens at configuration time (setContext), not during file scanning—correct and efficient
• Minor formatting fix (spacing on line 90) is unrelated cleanup

---

• Generate Walkthrough
• Generate Diagram

🗣️ Give feedback

[sonarqube-next]

Quality Gate passed

Issues
0 New issues
0 Fixed issues
0 Accepted issues

Measures
0 Security Hotspots
0 Dependency risks
100.0% Coverage on New Code
0.0% Duplication on New Code

See analysis details on SonarQube

[sonar-review-alpha]

One real test coverage gap needs fixing before merge — the rest of the implementation is correct.

🗣️ Give feedback

[sonar-review-alpha]

The test verifies that Class6.java (which contains the default header) is compliant — but there is no negative test asserting that a file without the default header gets flagged.

This gap matters concretely: if DEFAULT_HEADER_FORMAT ever became empty (e.g., due to a text-block indentation accident), the headerFormat.isEmpty() branch would fire, set expectedLines = {}, and matches() would return true for any file. The verifyNoIssues() call would still pass, giving a false sense of correctness.

Add a complementary case that runs the default FileHeaderCheck() against a file that lacks the header and asserts an issue is raised — something like:

check = new FileHeaderCheck();
CheckVerifier.newVerifier()
  .onFile(mainCodeSourcesPath("checks/FileHeaderCheck/Class1.java"))
  .withCheck(check)
  .verifyIssueOnFile("Add or update the header of this file.");

• Mark as noise

[tomasz-tylenda-sonarsource]

Let's use desciprive file names for test samples.

[tomasz-tylenda-sonarsource]

IMO it's a bad practice to do unintentional chages, because they make it hard to understand what is happening, if someone is reading a PR for some reason in the future.

[tomasz-tylenda-sonarsource]

Are these a part of this PR or is it a copied from the other changes?

[tomasz-tylenda-sonarsource]

Let's remove expectedLines.

[tomasz-tylenda-sonarsource]

Let's remove this method.

[tomasz-tylenda-sonarsource]

This should be extracted to checkExpectedLines