Change the content type to HTML and wrap ${BUILD_LOG} within pre tags.

<pre>${BUILD_LOG}</pre>

The problem is when the ${BUILD_LOG} expands to e.g. "</pre><incorrecthtml><follows...>", what then?

Code changed in hudson
User: : ashlux
Path:
trunk/hudson/plugins/email-ext/src/main/java/hudson/plugins/emailext/plugins/content/BuildLogContent.java
trunk/hudson/plugins/email-ext/src/test/java/hudson/plugins/emailext/plugins/content/BuildLogContentTest.java
http://jenkins-ci.org/commit/34761
Log:
Add tests in preperation for JENKINS-7397.

Code changed in hudson
User: : ashlux
Path:
trunk/hudson/plugins/email-ext/src/main/java/hudson/plugins/emailext/plugins/content/BuildLogContent.java
trunk/hudson/plugins/email-ext/src/test/java/hudson/plugins/emailext/plugins/content/BuildLogContentTest.java
http://jenkins-ci.org/commit/34781
Log:
[FIXED JENKINS-7397] Added escapeHtml parameter to BUILD_LOG content for escaping HTML. Usage: ${BUILD_LOG, escapeHtml=true}. Default to false for backwards compatibility.

The new parameter escapeHtml on the $BUILD_LOG token needs to be extended to other tokens as well.

A specific example is $FAILED_TESTS. My email template contains the following:

<pre>
${FAILED_TESTS}
</pre>

I have a particular failing test for which the test result, as it appears in the Hudson web interface, contains the following:

Error Message

expected:<ABORTED> but was:<COMPLETED>

However, the email as sent by the email-ext plugin looks as follows:

Error Message:
expected: but was

Another case where escaping is required: $FAILED_TESTS included a traceback containing this text:
at java.lang.System.loadLibrary(System.java:1028)
at org.nexusformat.NexusFile.<clinit>(NexusFile.java:99)
at gda.data.nexus.extractor.NexusExtractor.runLoop(NexusExtractor.java:408)

The <clinit> caused problems.

I'm thinking it would be sufficient to automatically escape HTML when the content type is HTML for all content types and just remove the escapeHtml argument altogether. Does this seem reasonable? Would this possibly break anyone?

Edit: After some thinking on this, this would certainly impact the ${JELLY} and could impact some users of $CHANGES}, ${CHANGES_SINCE_LAST_SUCCESSFUL}, and ${CHANGES_SINCE_LAST_UNSTABLE}.

What bothers me is forcing users to know about and remember to use escapeHtml is not very user friendly; I want a solution for that.

I agree that it is desirable to remove the "escapeHtml" parameter. However, you can't simply escape everything. Consider a specification like this:

${CHANGES_SINCE_LAST_UNSTABLE, reverse=true, format="====\n<b>Changes</b> for Build #%n\n", changesFormat="[%r] %d %a %m %p\n"}

Actually, last time I tried that, it didn't work, but anyhow that's a separate issue. The point here is that the <b> in the format should not be escaped.

I think the following should work:

• do not escape any output that is explicitly provided by the user (Hudson admin). This means
  BUILD_LOG_REGEX: substText
  CHANGES: format, pathFormat (why doesn't this support changesFormat?)
  CHANGES_SINCE_LAST_SUCCESS: format, changesFormat, pathFormat
  CHANGES_SINCE_LAST_UNSTABLE: format, changesFormat, pathFormat
• escape everything else. This includes change text, failed test details, environment variables, build log, etc.

The Jelly templates for html are a little more tricky. Following the same rule, the template itself should not be escaped, but anything inserted into it should be. So, looking at the default Jelly template, when I see a line like this:

<j:forEach var="cs" items="${changeSet.logs}" varStatus="loop">

Clearly whatever ${changeSet.logs} gets expanded to needs to be escaped, but the <:j does not.

I hope that makes sense.

Is this still an issue?

Please reopen if this is still an issue