[JENKINS-48467] - Updated UserIdCause.print() to use ModelHyperlinkNo…

…te (#3238) [JENKINS-48467] - Updated UserIdCause.print() to use ModelHyperlinkNote
jenkinsci · Feb 24, 2018 · 831fdb1 · 831fdb1
1 parent e0070aa
commit 831fdb1
Show file tree

Hide file tree

Showing 2 changed files with 52 additions and 4 deletions.
diff --git a/core/src/main/java/hudson/model/Cause.java b/core/src/main/java/hudson/model/Cause.java
@@ -453,9 +453,14 @@ public String getShortDescription() {
 
         @Override
         public void print(TaskListener listener) {
-            listener.getLogger().println(Messages.Cause_UserIdCause_ShortDescription(
-                    // TODO JENKINS-48467 - better to use ModelHyperlinkNote.encodeTo(User), or User.getUrl, since it handles URL escaping
-                    ModelHyperlinkNote.encodeTo("/user/"+getUserIdOrUnknown(), getUserName())));
+            User user = getUserId() == null ? null : User.getById(getUserId(), false);
+            if (user != null) {
+                listener.getLogger().println(Messages.Cause_UserIdCause_ShortDescription(
+                        ModelHyperlinkNote.encodeTo(user)));
+            } else {
+                listener.getLogger().println(Messages.Cause_UserIdCause_ShortDescription(
+                        "unknown or anonymous"));
+            }
         }
 
         @Override

diff --git a/test/src/test/java/hudson/model/CauseTest.java b/test/src/test/java/hudson/model/CauseTest.java
@@ -25,10 +25,17 @@
 package hudson.model;
 
 import hudson.XmlFile;
-import java.io.File;
+
+import java.io.*;
 import java.util.concurrent.Future;
 import java.util.regex.Pattern;
+
+import static org.hamcrest.CoreMatchers.containsString;
 import static org.junit.Assert.*;
+
+import hudson.security.*;
+import hudson.util.StreamTaskListener;
+import jenkins.model.Jenkins;
 import org.junit.Rule;
 import org.junit.Test;
 import org.jvnet.hudson.test.Issue;
@@ -79,4 +86,40 @@ public class CauseTest {
         //j.interactiveBreak();
     }
 
+
+    @Issue("JENKINS-48467")
+    @Test public void userIdCausePrintTest() throws Exception {
+        ByteArrayOutputStream baos = new ByteArrayOutputStream();
+        TaskListener listener = new StreamTaskListener(baos);
+
+        //null userId - print unknown or anonymous
+        Cause causeA = new Cause.UserIdCause(null);
+        causeA.print(listener);
+
+        assertEquals(baos.toString().trim(),"Started by user unknown or anonymous");
+        baos.reset();
+
+        //SYSTEM userid  - getDisplayName() should be SYSTEM
+        Cause causeB = new Cause.UserIdCause();
+        causeB.print(listener);
+
+        assertThat(baos.toString(), containsString("SYSTEM"));
+        baos.reset();
+
+        //unknown userid - print unknown or anonymous
+        Cause causeC = new Cause.UserIdCause("abc123");
+        causeC.print(listener);
+
+        assertEquals(baos.toString().trim(),"Started by user unknown or anonymous");
+        baos.reset();
+
+        //More or less standard operation
+        //user userid  - getDisplayName() should be foo
+        User user = User.getById("foo", true);
+        Cause causeD = new Cause.UserIdCause(user.getId());
+        causeD.print(listener);
+
+        assertThat(baos.toString(), containsString(user.getDisplayName()));
+        baos.reset();
+    }
 }