[JENKINS-54678] Add symlink to compressed log

[AdamBrousseau]

Fixes issue related to JEP-210.

Signed-off-by: Adam Brousseau [email protected]

[AdamBrousseau]

@daniel-beck please review.
This is my first contribution to a Jenkins plugin. It seems to work locally and I have tested the theory on one of my production instances.

[jglick]

I am not sure what this is doing or how it addresses JENKINS-54678.

[AdamBrousseau]

As per the comments in the issue and my own testing, having the compressed log file named log (without the extension) allows Jenkins to render the file. Further, having a symlink log pointing at the compressed log.gz file also works. This pr simply created that symlink.

[jglick]

allows Jenkins to render the file

When used on a Pipeline build? I cannot imagine how that could be. The transparent decompression hack in Jenkins core is present in code which is overridden by workflow-job.

[AdamBrousseau]

Seems to work. On a given pipeline job (on a prod instance), I can either rename the log.gz to log or I can create a symlink and it works. The code change I've only tested in the test environment but it worked (created the symlink as expected) on a freestyle build.

[jglick]

On a given pipeline job (on a prod instance), I can either rename the log.gz to log or I can create a symlink and it works.

Then something is broken, not sure what offhand.

[AdamBrousseau]

Then something is broken

Quite the opposite from my point of view 😆

[jglick]

Ah, I see, https://github.com/jenkinsci/jenkins/blob/a510c0c8511af4f72c88938bb24a5207185009f2/core/src/main/java/hudson/console/AnnotatedLargeText.java#L84-L85 as called by https://github.com/jenkinsci/workflow-api-plugin/blob/2e0755dc5d8de75d2e4d42a4aade18a18a1c9e11/src/main/java/org/jenkinsci/plugins/workflow/log/FileLogStorage.java#L199 turns on automatic gzip detection. Basically a bug in workflow-api, though hard to fix until https://github.com/stapler/stapler/blob/0a23a9000de1dafb6a16fa883504697443cc05e3/core/src/main/java/org/kohsuke/stapler/framework/io/LargeText.java#L63 and https://github.com/stapler/stapler/blob/0a23a9000de1dafb6a16fa883504697443cc05e3/core/src/main/java/org/kohsuke/stapler/framework/io/LargeText.java#L385 are made public or AnnotatedLargeText allows transparentGunzip to be specified.

[jglick]

Do not advise this, as it only happens to work due to a mistake in current code.