Skip to content

Commit 1106ed8

Browse files
committed
Added branch name in md report
1 parent 7669974 commit 1106ed8

File tree

7 files changed

+38
-1
lines changed

7 files changed

+38
-1
lines changed

src/main/java/fr/cnes/sonar/report/exporters/data/PlaceHolders.java

Lines changed: 7 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -44,6 +44,10 @@ private PlaceHolders() {
4444
* Placeholder for project's name
4545
*/
4646
private static final String PROJECTNAME_PLACEHOLDER = "XX-PROJECTNAME-XX";
47+
/**
48+
* Placeholder for the project's branch
49+
*/
50+
private static final String PROJECTBRANCH_PLACEHOLDER = "XX-PROJECTBRANCH-XX";
4751
/**
4852
* Placeholder for the quality gate's anme
4953
*/
@@ -352,6 +356,9 @@ public static Map<String, String> loadPlaceholdersMap(Report report) {
352356
replacementValues.put(
353357
PROJECTNAME_PLACEHOLDER,
354358
report.getProjectName());
359+
replacementValues.put(
360+
PROJECTBRANCH_PLACEHOLDER,
361+
report.getProjectBranch());
355362
// configuration placeholders
356363
replacementValues.put(
357364
QUALITYGATENAME_PLACEHOLDER,

src/main/java/fr/cnes/sonar/report/factory/ReportModelFactory.java

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -112,6 +112,8 @@ public Report create() throws BadSonarQubeRequestException, UnknownQualityGateEx
112112
report.setProject(projectProvider.getProject(this.project, this.branch));
113113
// project's name's setting
114114
report.setProjectName(report.getProject().getName());
115+
// project's branch's setting
116+
report.setProjectBranch(report.getProject().getBranch());
115117
// formatted issues, unconfirmed issues and raw issues' setting
116118
report.setIssues(issuesProvider.getIssues());
117119
report.setUnconfirmed(issuesProvider.getUnconfirmedIssues());

src/main/java/fr/cnes/sonar/report/model/Report.java

Lines changed: 24 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -37,6 +37,10 @@ public class Report {
3737
* Name of the project/report
3838
*/
3939
private String projectName;
40+
/**
41+
* Name of the branch
42+
*/
43+
private String branchName;
4044
/**
4145
* Name of the author
4246
*/
@@ -107,6 +111,7 @@ public class Report {
107111
*/
108112
public Report() {
109113
this.projectName = "";
114+
this.branchName = "";
110115
this.projectAuthor = "";
111116
this.projectDate = "";
112117
this.qualityProfiles = new ArrayList<>();
@@ -265,6 +270,24 @@ public void setProjectName(String pProjectName) {
265270
this.projectName = pProjectName;
266271
}
267272

273+
/**
274+
* Getter for branchName
275+
*
276+
* @return branchName
277+
*/
278+
public String getProjectBranch() {
279+
return branchName;
280+
}
281+
282+
/**
283+
* Setter for branchName
284+
*
285+
* @param pBranchName value
286+
*/
287+
public void setProjectBranch(String pBranchName) {
288+
this.branchName = pBranchName;
289+
}
290+
268291
/**
269292
* Getter for projectAuthor
270293
*
@@ -541,4 +564,5 @@ public Map<String, String> getQualityGateStatus() {
541564
public void setQualityGateStatus(Map<String, String> pQualityGateStatus) {
542565
this.qualityGateStatus = pQualityGateStatus;
543566
}
567+
544568
}

src/main/resources/template/code-analysis-template.md

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,6 @@
11
# Code analysis
22
## XX-PROJECTNAME-XX
3+
#### Branch XX-PROJECTBRANCH-XX
34
#### Version XX-VERSION-XX
45

56
**By: XX-AUTHOR-XX**
@@ -82,4 +83,4 @@ $SECURITY_HOTSPOTS_COUNT
8283

8384
### Security hotspots
8485

85-
$SECURITY_HOTSPOTS_DETAILS
86+
$SECURITY_HOTSPOTS_DETAILS

src/test/ut/java/fr/cnes/sonar/report/CommonTest.java

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -95,6 +95,7 @@ public void before() {
9595
});
9696

9797
report.setProjectName("CNES Report");
98+
report.setProjectBranch("main");
9899
report.setProjectDate(new Date().toString().substring(0,16));
99100
report.setProjectAuthor("Lequal");
100101

src/test/ut/java/fr/cnes/sonar/report/ReportTest.java

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -63,6 +63,7 @@ public void defaultReportValuesTest() {
6363
assertEquals("", report.getProjectAuthor());
6464
assertEquals("", report.getProjectDate());
6565
assertEquals("", report.getProjectName());
66+
assertEquals("", report.getProjectBranch());
6667
assertEquals("", report.getQualityProfilesFilename());
6768
assert(report.getRawIssues().isEmpty());
6869
assert(report.getQualityProfiles().isEmpty());

src/test/ut/java/fr/cnes/sonar/report/exporters/data/PlaceHoldersTest.java

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -41,6 +41,7 @@ public void loadPlaceholdersMapTest(){
4141
Map<String,String> expected = new HashMap<>();
4242
// Fill manually the placeHolders depending on what we initialized in "CommonTest"
4343
expected.put("XX-PROJECTNAME-XX", "CNES Report");
44+
expected.put("XX-PROJECTBRANCH-XX", "main");
4445
expected.put("XX-DUPLICATION-XX", "1.0");
4546
expected.put("XX-COMMENTDENSITY-XX", "1.0");
4647
expected.put("XX-MAXNCLOC-XX", "unknown");

0 commit comments

Comments
 (0)