Allow option showRawYaml in Jenkinsfiles

[OliverNocon]

Add option to hide pod yaml also in Jenkinsfile pipeline execution by setting showRawYaml: false.

https://issues.jenkins-ci.org/browse/JENKINS-57717

[OliverNocon]

Change has been successfully tested e2e in Jenkins instance running in a Kubernetes cluster.

[Vlatombe]

Thanks for this. Would you mind adding a small unit test ?

[OliverNocon]

sure, could you please point me to the place where I can find the test for the non-pipeline use-case. I will then take this over.

[Vlatombe]

See https://github.com/jenkinsci/kubernetes-plugin/blob/master/src/test/java/org/csanchez/jenkins/plugins/kubernetes/PodTemplateTest.java

[OliverNocon]

Thanks for the pointer. I added a simple Unit test now.
Involving ContainerTemplate does not look feasible to me here.

I looked into testing the additions to class PodTemplateStepExecution.
Unfortunately, a more detailed but simple unit test for this class does not look as easy to me without refactoring the class itself since the constructor does not set the properties but rather the start() method which already requires Jenkins.getInstance().
I don't want to go into refactoring here though.

Hope this is fine ...

[Vlatombe]

This unit test is not really useful (merely testing the getter). Usually anything involving something related to pipeline steps is better tested using an integration test.

Typically in your case, something that would look like

• https://github.com/jenkinsci/kubernetes-plugin/blob/9bb8b863c1da93cbb38a10b0d1928a0317b62bb5/src/test/resources/org/csanchez/jenkins/plugins/kubernetes/pipeline/runInPodWithMultipleContainers.groovy

• kubernetes-plugin/src/test/java/org/csanchez/jenkins/plugins/kubernetes/pipeline/KubernetesPipelineTest.java

  Lines 202 to 210 in 80bbf10

  	public void runInPodWithMultipleContainers() throws Exception {
  	r.assertBuildStatusSuccess(r.waitForCompletion(b));
  	r.assertLogContains("[jnlp] jenkins/jnlp-slave:3.10-1-alpine", b);
  	r.assertLogContains("[maven] maven:3.3.9-jdk-8-alpine", b);
  	r.assertLogContains("[golang] golang:1.6.3-alpine", b);
  	r.assertLogContains("My Kubernetes Pipeline", b);
  	r.assertLogContains("my-mount", b);
  	r.assertLogContains("Apache Maven 3.3.9", b);
  	}

using the showRawYaml:true in the pod template definition, then asserting that the yaml definition is not printed in the build logs

[OliverNocon]

I fully agree that testing getters and setters is not of much value.
I would have wished for a better unit test capability of PodTemplateStepExecution in a way that I could just run the start() method on PodTemplateStep and then assert that the correct value made it into newTemplate.
That could make testing faster in my opinion and easier for new contributors ...

Anyway, thank you for your hint.
Since I cannot run the tests locally I gave it a try with an integration test and a best guess now ...

[OliverNocon]

@Vlatombe thanks for helping out here!