CONDEC-1028: Use commit time as comment creation time when transcribing a commit into a Jira issue comment (#698)

* Mock comment creation with date

* Add documentation origin when serializing knowledge elements into JSON objects and to knowledge export

Author: kleebaum

src/main/java/de/uhd/ifi/se/decision/management/jira/git/CommitMessageToCommentTranscriber.java

@@ -13,6 +13,7 @@
 import com.atlassian.jira.exception.PermissionException;
 import com.atlassian.jira.issue.Issue;
 import com.atlassian.jira.issue.comments.Comment;
+import com.atlassian.jira.issue.comments.CommentManager;
 import com.atlassian.jira.user.ApplicationUser;
 import com.atlassian.jira.user.UserDetails;
 
@@ -102,19 +103,20 @@ private List<Comment> postCommitsIntoJiraIssueComments(DiffForSingleRef diff) {
 	 *         already posted.
 	 */
 	private Comment postCommitIntoJiraIssueComment(RevCommit commit, Ref branch, String uri) {
+		CommentManager commentManager = ComponentAccessor.getCommentManager();
 		String commentText = generateCommentString(commit, branch, uri);
 		if (commentText.isBlank()) {
 			LOGGER.warn("Commit messages cannot be posted to Jira issue comment because comment text would be blank.");
 			return null;
 		}
-		for (Comment alreadyWrittenComment : ComponentAccessor.getCommentManager().getComments(jiraIssue)) {
-			// if the hash of a commit is present in a comment, do not post it again
+		for (Comment alreadyWrittenComment : commentManager.getComments(jiraIssue)) {
+			// do not post commit if the hash of a commit is present in a comment
 			if (alreadyWrittenComment.getBody().contains(commit.getName())) {
 				return null;
 			}
 		}
 		ApplicationUser user = getUser();
-		return ComponentAccessor.getCommentManager().create(jiraIssue, user, commentText, true);
+		return commentManager.create(jiraIssue, user, commentText, null, null, commit.getAuthorIdent().getWhen(), true);
 	}
 
 	/**

src/main/java/de/uhd/ifi/se/decision/management/jira/model/KnowledgeElement.java

@@ -379,14 +379,24 @@ public void setDocumentationLocation(String documentationLocation) {
 	}
 
 	/**
-	 * @return {@link Origin} that indicates the source of a knowledge element. The
-	 *         origin might be different from the current
+	 * @return documentation {@link Origin} that indicates the source of a knowledge
+	 *         element. The origin might be different from the current
 	 *         {@link DocumentationLocation}.
 	 */
 	public Origin getOrigin() {
 		return origin;
 	}
 
+	/**
+	 * @return documentation {@link Origin} that indicates the source of a knowledge
+	 *         element as a String. The origin might be different from the current
+	 *         {@link DocumentationLocation}.
+	 */
+	@XmlElement(name = "origin")
+	public String getOriginAsString() {
+		return origin == Origin.DOCUMENTATION_LOCATION ? documentationLocation.name() : origin.name();
+	}
+
 	/**
 	 * @return an URL of the knowledge element as String.
 	 */

src/main/java/de/uhd/ifi/se/decision/management/jira/model/Origin.java

@@ -40,5 +40,4 @@ public static Origin determineOrigin(String commentBody) {
 		}
 		return DOCUMENTATION_LOCATION;
 	}
-
-}
+}

src/main/resources/js/condec.export.js

@@ -70,26 +70,27 @@
 		var table = "<table><tr>";
 		table += "<th>Type</th><th>Summary</th><th>Description</th><th>Decision Groups</th><th>Status</th>";
 		table += "<th>Creator</th><th>Creation Date</th><th>Latest Author</th><th>Latest Update</th>";
-		table += "<th>Key</th></tr>";
-		for (element of elements) {
+		table += "<th>Documentation Origin</th><th>Key</th></tr>";
+		for (const element of elements) {
 			table += "<tr color='#FF0000'>";
-			table += "<td>" + element["type"] + "</td>";
-			table += "<td>" + element["summary"] + "</td>";
-			table += "<td>" + element["description"] + "</td>";
-			table += "<td>" + element["groups"] + "</td>";
+			table += `<td> ${element["type"]} </td>`;
+			table += `<td> ${element["summary"]} </td>`;
+			table += `<td> ${element["description"]} </td>`;
+			table += `<td> ${element["groups"]} </td>`;
 			var status = element["status"] !== "undefined" ? element["status"] : "";
-			table += "<td>" + status + "</td>";
-			table += "<td>" + element["creator"] + "</td>";
+			table += `<td> ${status} </td>`;
+			table += `<td> ${element["creator"]} </td>`;
 			table += "<td>" + new Date(element["creationDate"]) + "</td>";
-			table += "<td>" + element["latestAuthor"] + "</td>";
+			table += `<td> ${element["latestAuthor"]} </td>`;
 			table += "<td>" + new Date(element["latestUpdatingDate"]) + "</td>";
-			table += "<td><a href='" + element["url"] + "'>" + element["key"] + "</a></td>";
+			table += `<td> ${element["origin"]} </td>`;
+			table += `<td><a href='${element["url"]}'> ${element["key"]} </a></td>`;
 			table += "</tr>";
 		}
 		table += "</table>";
 
 		var styleString = "table{font-family:arial,sans-serif;border-collapse:collapse;width:100%}td,th{border:1px solid #ddd;text-align:left;padding:8px}tr:nth-child(even){background-color:#ddd}";
-		var htmlString = $("<html>").html("<head><style>" + styleString + "</style></head><body>" + table + "</body>")
+		var htmlString = $("<html>").html(`<head><style> ${styleString} </style></head><body> ${table} </body>`)
 			.html();
 		return htmlString;
 	}

src/test/java/de/uhd/ifi/se/decision/management/jira/mocks/MockCommentManager.java

@@ -66,11 +66,8 @@ public List<Comment> getComments(Issue issue) {
 	}
 
 	@Override
-	public Comment create(Issue issue, ApplicationUser applicationUser, String string, boolean dispatchEvent) {
-		Comment comment = new MockComment((long) 1337, applicationUser.getName(), string, null, null, new Date(),
-				issue);
-		comments.add(comment);
-		return comment;
+	public Comment create(Issue issue, ApplicationUser applicationUser, String commentBody, boolean dispatchEvent) {
+		return create(issue, applicationUser, commentBody, null, null, new Date(), dispatchEvent);
 	}
 
 	@Override
@@ -89,9 +86,12 @@ public Comment create(Issue issue, String s, String s1, String s2, Long aLong, b
 	}
 
 	@Override
-	public Comment create(Issue issue, ApplicationUser applicationUser, String s, String s1, Long aLong, Date date,
-			boolean b) {
-		return null;
+	public Comment create(Issue issue, ApplicationUser applicationUser, String commentBody, String groupLevel,
+			Long roleLevelId, Date date, boolean dispatchEvent) {
+		Comment comment = new MockComment((long) 1337, applicationUser.getName(), commentBody, groupLevel, roleLevelId,
+				date, issue);
+		comments.add(comment);
+		return comment;
 	}
 
 	@Override

src/test/java/de/uhd/ifi/se/decision/management/jira/model/knowledgeelement/TestKnowledgeElementStrings.java

@@ -10,6 +10,7 @@
 import org.junit.Test;
 
 import de.uhd.ifi.se.decision.management.jira.TestSetUp;
+import de.uhd.ifi.se.decision.management.jira.git.model.DecisionKnowledgeElementInCommitMessage;
 import de.uhd.ifi.se.decision.management.jira.model.DocumentationLocation;
 import de.uhd.ifi.se.decision.management.jira.model.KnowledgeElement;
 import de.uhd.ifi.se.decision.management.jira.model.KnowledgeStatus;
@@ -141,6 +142,12 @@ public void testGetOrigin() {
 		assertEquals(Origin.DOCUMENTATION_LOCATION, element.getOrigin());
 	}
 
+	@Test
+	public void testGetOriginAsString() {
+		assertEquals("JIRAISSUE", element.getOriginAsString());
+		assertEquals("COMMIT", new DecisionKnowledgeElementInCommitMessage().getOriginAsString());
+	}
+
 	@Test
 	public void isLinked() {
 		assertEquals(0, element.isLinked());