Display file content in tutorials (#25)

Author: kangasta

docs/examples/jenkins/ansible-kubernetes/README.md

@@ -29,8 +29,24 @@ First, create a new pipeline via [New Item](http://localhost:8080/view/all/newJo
 
 In the configure pipeline view, scroll to the bottom and under Pipeline sub-header select `Pipeline script from SCM`. SCM type should be `Git` and Repository URL the url of this repository: `https://github.com/kangasta/cicd-examples.git`. Ensure that branch specifier includes `main` branch of the repository and modify the Script Path to be `docs/examples/jenkins/ansible-kubernetes/Jenkinsfile`.
 
+The pipeline deploys an example application to a Kubernetes cluster using Ansible playbook. The playbook selects a container image tag based on Jenkins build parameter.
+
+```groovy title="Jenkinsfile"
+---8<--- "docs/examples/jenkins/ansible-kubernetes/Jenkinsfile"
+```
+
 After you have created the pipeline, try to execute it by clicking _Build Now_. The pipeline should have deployed the example application into the Kubernetes cluster with the default image tag (`cow`) defined in the [deploy-to-kubernetes.yml](./deploy-to-kubernetes.yml) Ansible playbook.
 
+```yaml title="deploy-to-kubernetes.yml"
+---8<--- "docs/examples/jenkins/ansible-kubernetes/deploy-to-kubernetes.yml"
+```
+
+After the Ansible playbook has been executed, the pipeline runs [wait-until-service-up.sh](./wait-until-service-up.sh) script. The script waits until the load-balancer created by the Kubernetes service has reached running state and parses the URL where the example application is running.
+
+```sh
+---8<--- "docs/examples/jenkins/ansible-kubernetes/wait-until-service-up.sh"
+```
+
 You can find the URL of the created load-balancer from the console output of the build. Open the application with your browser or user curl to see the application response.
 
 In addition, after the first execution Jenkins should have updated the project configuration to contain parameters defined in the pipeline and we can configure the image tag in _Build with Parameters_ menu.

docs/examples/jenkins/build-status-pipelines/README.md

@@ -24,3 +24,43 @@ node {
 ```
 
 The execution will likely fail with `ERROR: script not yet approved for use` message. To enable this script, navigate to [Manage Jenkins > In-process Script Approval](http://localhost:8080/scriptApproval/), inspect the script, and click _Approve_. Then try to run the created seed project again. It should now succeed and list the created resources.
+
+The scripted pipeline listed above executes [jobs.groovy](./jobs.groovy) script. This script creates five new pipelines and executes four of those.
+
+```groovy title="jobs.groovy"
+---8<--- "docs/examples/jenkins/build-status-pipelines/jobs.groovy"
+```
+
+The four different pipeline scripts used to create the jobs are listed below. The final job, `Status/Not built`, uses the same script as `Status/Success`, but the build is not executed.
+
+=== "Aborted"
+
+    Defines a pipeline that has a three minute timeout and build step that takes more than three minutes.
+
+    ```groovy title="aborted.Jenkinsfile"
+    ---8<--- "docs/examples/jenkins/build-status-pipelines/aborted.Jenkinsfile"
+    ```
+
+=== "Failed"
+
+    Defines a pipeline with single `sh` step that produces a non-zero exit code.
+
+    ```groovy title="failed.Jenkinsfile"
+    ---8<--- "docs/examples/jenkins/build-status-pipelines/failed.Jenkinsfile"
+    ```
+
+=== "Success"
+
+    Defines a pipeline with single succeeding `sh` step.
+
+    ```groovy title="success.Jenkinsfile"
+    ---8<--- "docs/examples/jenkins/build-status-pipelines/success.Jenkinsfile"
+    ```
+
+=== "Unstable"
+
+    Defines a pipeline with single `unstable` step.
+
+    ```groovy title="unstable.Jenkinsfile"
+    ---8<--- "docs/examples/jenkins/build-status-pipelines/unstable.Jenkinsfile"
+    ```

docs/examples/jenkins/parallel-robot-pipeline/README.md

@@ -18,15 +18,41 @@ First, create a new pipeline via _[New Item](http://localhost:8080/view/all/newJ
 
 In the configure pipeline view, scroll to the bottom and under Pipeline sub-header select `Pipeline script from SCM`. SCM type should be `Git` and Repository URL the url of this repository: `https://github.com/kangasta/cicd-examples.git`. Ensure that branch specifier includes `main` branch of the repository and modify the Script Path to be `docs/examples/jenkins/parallel-robot-pipeline/Jenkinsfile`.
 
-After you have created the pipeline, try to execute it by clicking _Build Now_. All Robot Framework tasks should be in Skipped state as we did not specify URL variable, see `.robot` file for details. In addition, after the first execution Jenkins should have updated the project configuration to contain parameters defined in the pipeline and we can now pass target URL to our automation tasks in Build with Parameters menu.
+The pipeline executes the same Robot Framework suite twice: once with Firefox and once with Chromium. This is done in parallel. After the test suites have finished, the log files are combined in the next stage.
+
+```groovy title="Jenkinsfile"
+---8<--- "docs/examples/jenkins/parallel-robot-pipeline/Jenkinsfile"
+```
+
+After you have created the pipeline, try to execute it by clicking _Build Now_. All Robot Framework tasks should be in Skipped state as we did not specify an URL variable. In addition, after the first execution Jenkins should have updated the project configuration to contain parameters defined in the pipeline and we can now pass target URL to our automation tasks in _Build with Parameters_ menu.
+
+The Robot Framework suite defined in [suites/screenshot.robot](./suites/screenshot.robot) uses Browser library to take a screenshot of the page available in the URL defined with the URL variable.
+
+```robot title="suites/screenshot.robot"
+---8<--- "docs/examples/jenkins/parallel-robot-pipeline/suites/screenshot.robot"
+```
 
 Finally, If the robot log cannot be loaded after task execution, see [this stackoverflow post](https://stackoverflow.com/questions/36607394/error-opening-robot-framework-log-failed) for solution. To summarize, run following command in Jenkins Script Console to modify Jenkins servers Content Security Policy (CSP):
 
 ```groovy
 System.setProperty("hudson.model.DirectoryBrowserSupport.CSP","sandbox allow-scripts; default-src 'none'; img-src 'self' data: ; style-src 'self' 'unsafe-inline' data: ; script-src 'self' 'unsafe-inline' 'unsafe-eval' ;")
 ```
 
-## Running the example scripts locally
+## Building and running the Docker container
+
+The Jenkins pipeline listed above uses container image from Github Container Registry to run the pipelines. The container image is created using [Dockerfile](./Dockerfile) defined by this tutorial.
+
+```Dockerfile title="Dockerfile"
+---8<--- "docs/examples/jenkins/parallel-robot-pipeline/Dockerfile"
+```
+
+The Dockerfile is based on Playwright image that contains the Browser binaries and other Playwright related dependencies of the Browser library. In addition, the Dockerfile installs Python and Python libraries defined in [requirements.txt](./requirements.txt) to the container image.
+
+```txt title="requirements.txt"
+---8<--- "docs/examples/jenkins/parallel-robot-pipeline/requirements.txt"
+```
+
+## Running the tasks locally
 
 Build the Docker containers with `docker build`: