Skip to Content

Changes for page Jenkins Shared Library

Last modified by Boris Folgmann on 2025/11/03 09:41
From version 2.2
edited by Boris Folgmann
on 2025/04/29 12:03
Change comment: merged cells
To version 10.1
edited by Boris Folgmann
on 2025/11/03 09:35
Change comment: There is no comment for this version

Summary

Details

Page properties
Content
... ... @@ -6,7 +6,7 @@
6 6  
7 7  == Getting Started ==
8 8  
9 -Since the Shared Library is globally configured on all Jenkins instances managed by DevOps-as-a-Service you just need to place the following very short Jenkinsfile in the root folder of your git repository to automatically build your maven or node project or simply build a container using a Dockerfile.
9 +Since the Shared Library is globally configured on all Jenkins instances managed by DevOps-as-a-Service you just need to place the following very short Jenkinsfile in the root folder of your git repository to automatically build your maven, node or go project or simply build a container using a Dockerfile.
10 10  
11 11  {{code}}
12 12  @Library('sdcloud') _
... ... @@ -21,28 +21,35 @@
21 21  
22 22  What the pipeline currently does is visualised in the following image which shows an example for a maven-based Java project.
23 23  
24 -[[image:attach:image2022-5-17_17-51-43.png||height="250"]]
24 +[[image:1762161531690-966.png||data-xwiki-image-style-border="true" height="247" width="1654"]]
25 25  
26 -1. Checking out the source code from git.
27 -1. If a pom.xml is found your favorite JDK is selected, by default jdk11. Then a maven build is done.
28 -1. If there's no pom.xml but a package.json is found a nodejs build is done.
26 +1. **sdcPipeline **prints some valuable information about this shared Jenkinslib. Allocates a node (Jenkins Agent) to start executing the pipeline.
27 +1. **Checkout**: checking out the source code from git.
28 +1. **JDK**: If a pom.xml is found, your favorite JDK or the current default is selected .
29 +1. **Maven Build**: If a pom.xml is found, a maven build is done.
30 +1. If there's no pom.xml, but a package.json is found a nodejs build is done.
31 +1. If there is no pom.xml or package.json but a go.mod file, a go build is done.
29 29  1. Then the following stages are executed in parallel
30 -11. Analysis: For maven projects the Java source code is checked by checkstyle, pmd and spotbugs. Furthermore the job output will be checked for any warnings generated by maven, javac or javadoc. If Python modules (.py files) exist in the git repository they will be analyzed using pylint and flake8. If pylint or flake8 are not available on the Jenkins agent the steps will be skipped. Python files that are generated or downloaded into the workspace will not be checked. The results will be displayed on the classical Jenkins build page after the build.
31 -11. Security: If it's not a feature or bugfix branch a dependency check is done which checks if e.g. libraries are used which have known vulnerabilities. The results will be displayed in Jenkins after the build.
32 -11. Docker: this will also work for projects which are neither maven or nodejs. A Dockerfile is enough to trigger this part of the pipeline.
33 -111. If a Dockerfile is found a docker image is built.
34 -111. The image is started as an isolated container on the Jenkins agent.
35 -111. Any loglines written to stdout or stderr by the container will be displayed.
36 -111. A smoke test is performed which is a simple query for a valid answer on the exposed port of the container.
37 -111. If the smoke test was successful and the build was not done for a pull request the docker image will be pushed to the docker registry.
38 -111. For easy identification of the image 3 image tags are defined:
33 +11. **Analysis**: For maven projects the Java source code is checked by checkstyle, pmd and spotbugs. Furthermore the job output will be checked for any warnings generated by maven, javac or javadoc.
34 +If Python modules (.py files) exist in the git repository they will be analyzed using pylint and flake8. If pylint or flake8 are not available on the Jenkins agent the steps will be skipped. Python files that are generated or downloaded into the workspace will not be checked. The results will be displayed on the classical Jenkins build page after the build. For Go projects, the Go test tool is used to run all tests and produce a coverage output file for SonarQube. Additionally, the gotestsum tool is used to produce a report which is picked up by Jenkins.
35 +If SonarQube is configured fore this Jenkins instance, a **Sonar Scan** is performed on the agent and the result is pushed to SonarQube for further processing.
36 +11. **Security**:
37 +111. If it's not a feature or bugfix branch, a dependency check is done which checks if e.g. libraries are used which have known vulnerabilities. The results will be displayed in Jenkins after the build.
38 +111. If Dependency Track is enabled for the current project, an SBOM file is created and archived in the build. In addition it's pushed to Dependency Track. Jenkins will wait for DepTrack to process the SBOM and display information about found potential vulnerabilities in the build.
39 +11. **Docker**: this will also work for projects which are neither maven, nodejs or go. A Dockerfile is enough to trigger this part of the pipeline.
40 +111. **Build Container Image**: If a Dockerfile is found a docker image is built.
41 +111. **Test Container Image**: The image is started as an isolated container on the Jenkins agent. Any loglines written to stdout or stderr by the container will be displayed.A smoke test is performed which is a simple query for a valid answer on the exposed port of the container.
42 +111. **Push Container Image**: If the smoke test was successful and the build was not done for a pull request the docker image will be pushed to the docker registry.
43 +For easy identification of the image 3 image tags are defined:
39 39  1111. BRANCH_NAME-BUILD_NUMBER (e.g. 'production-1014')
40 40  1111. BRANCH_NAME-GIT_HASH (e.g. 'develop-8a7c4f2')
41 41  1111. BRANCH_NAME-latest (e.g. 'feature-PKEY-42-latest')
42 42  1111. (If BRANCH_NAME is defaultBranch the prefix 'BRANCH_NAME-' will not be included.)
43 -111. When a chart/Chart.yaml is found and  it's not a pull request a Helm Chart will be created and pushed to the Helm Chart repository.
44 -1. Yamllint will check all YAML files in the workspace for errors and warnings. This is done at this place since the Create Helm Chart stage modifies or creates YAML files which should be also checked before the pipeline proceeds.
45 -1. When depolyHelmChart is set to true the Helm chart will be deployed to the Kubernestes cluster and namespace of your choice. Not done in the example diagram.
48 +111. **Create Helm Chart**: When a chart/Chart.yaml is found and it's not a pull-request, a Helm Chart will be created and pushed to the Helm Chart repository.
49 +1. **Yamllint **will check all YAML files in the workspace for errors and warnings. This is done at this place since the Create Helm Chart stage modifies or creates YAML files which should be also checked before the pipeline proceeds.
50 +1. **Deploy application**: when depolyHelmChart is set to true the Helm chart will be deployed to the Kubernestes cluster and namespace of your choice. Not done in the example diagram.
51 +1. **Trivy Results**: if a container image was pushed to Harbor as the container registry, the results of the Trivy security scan are fetched from Harbor
52 +1. **Sonar Results**: finally the pipeline waits for the result of the Sonar Quality Gate to decide on the success of the build.
46 46  
47 47  == {{id name="pipeline_customization"/}}Pipeline Customization ==
48 48  
... ... @@ -125,10 +125,16 @@
125 125  )))|(((
126 126  'npm install && npm run build ~-~-prod'
127 127  )))|(((
128 -npm command to execute for building Node.JS projects.
135 +npm command to execute for building Node.JS projects.
129 129  )))
137 +|= |go|'go'|Golang version to use.
138 +Refers to a symbolic name of a go tool configuration in Jenkins.
139 +|= |goBuildCommand|(((
140 +'go build -o app cmd/server/main.go'
141 +)))|go build run. Should be overridden for your project.
142 +|= |goTestCommand|'gotestsum ~-~-format pkgname ~-~-junitfile report.xml ~-~- -failfast -race -coverprofile=coverage.out -tags=test ./...'|Runs gotestsum tool which in turn calls 'go test' for all packages in the project. Should be overridden for your project. The gotestsum tool is available out-of-the-box and produces a report file which is picked up by Jenkins automatically.
130 130  |=(% rowspan="10" %)(((
131 -Docker build
144 +Container build
132 132  )))|(((
133 133  dockerBuildPath
134 134  )))|(((
... ... @@ -202,7 +202,7 @@
202 202  Id of the Jenkins Credentials which have to be used to authenticate to the //pullDockerRegistry//.
203 203  )))
204 204  |=(% rowspan="7" %)(((
205 -Docker container test
218 +Container test
206 206  )))|(((
207 207  skipSmokeTest
208 208  )))|(((
... ... @@ -253,7 +253,7 @@
253 253  Total time in seconds after which the container is expected to be up and running even if it's still writing loglines to stdout. After this time has passed the container will be queried for an answer.
254 254  )))
255 255  |=(% rowspan="2" %)(((
256 -Docker push
269 +Image push
257 257  )))|(((
258 258  pushDockerRegistry
259 259  )))|(((
... ... @@ -269,7 +269,7 @@
269 269  Id of the Jenkins Credentials which have to be used to authenticate to the //pullDockerRegistry//.
270 270  )))
271 271  |=(% rowspan="6" %)(((
272 -Helm chart
285 +Helm Chart
273 273  )))|(((
274 274  helmChartPath
275 275  )))|(((
... ... @@ -305,9 +305,11 @@
305 305  |(((
306 306  helmRegistry
307 307  )))|(((
308 -Nexus registry of your DOaaS instance
321 +Helm registry of your DOaaS instance, which is usally 'https:~/~/registry-CUSTOMER.devops.t-systems.net/chartrepo/PROJECTKEY'
309 309  )))|(((
310 -Name of registry to which the packaged Helm chart is uploaded.
323 +Helm registry to which the packaged Helm chart is uploaded.
324 +
325 +
311 311  )))
312 312  |(((
313 313  helmRegistryCredentialsId
... ... @@ -346,7 +346,7 @@
346 346  )))|(((
347 347  Id of the Jenkins Credentials for signers private keyfile.
348 348  )))
349 -|=(% colspan="1" rowspan="12" %)(((
364 +|=(% colspan="1" rowspan="8" %)(((
350 350  Static Source Code Analysis
351 351  )))|(((
352 352  checkstyleConfig
... ... @@ -371,40 +371,16 @@
371 371  )))|(((
372 372   Name of a config file to use for yamllint. If not set a best-practice[[ relaxed configuration >>url:https://prd.sdc.t-systems.net/bitbucket/projects/DEVOPSAAS/repos/sdcloud-caas-jenkins-libs/browse/resources/com/tsystems/sdc/jenkinslib/yamllint.yml||shape="rect"]]is used which is different from the original yamllint[[ config>>url:https://yamllint.readthedocs.io/en/stable/configuration.html#default-configuration||shape="rect"]].
373 373  )))
374 -|skipDependencyCheck|false|Set to true to skip the dependency-check.
375 375  |(((
376 -dependencyCheckTool
377 -)))|(((
378 -'dependency-check'
379 -)))|(((
380 -Defines which named dependency-check tool should be used.
381 -)))
382 -|(((
383 -dependencyCheckArgs
384 -)))|(((
385 -'~-~-disableAssembly ~-~-nvdValidForHours 720'
386 -)))|(((
387 -Addtional arguments which are be passed to dependency-check. See [[Dependency>>url:https://jeremylong.github.io/DependencyCheck/dependency-check-cli/arguments.html||shape="rect"]][[ Check CLI Arguments>>url:https://jeremylong.github.io/DependencyCheck/dependency-check-cli/arguments.html||shape="rect"]] for more information.
388 -)))
389 -|(((
390 -dependencyCheckNvdApiKeyCredentialsId
391 -)))|(((
392 -'dependency-check-nvdapikey'
393 -)))|(((
394 -If you have your own NVD API Key, set it as a credential of type text in Jenkins. Then specify the credential id using this argument. It will be automatically passed to dependency-check. There will be no error if no credential is found. Just the NVD download will be slower. Please note, on DevOps-as-a-Service a shared NVD API Key is automatically supplied for the default credential id.
395 -)))
396 -|(((
397 397  sonarQube
398 398  )))|(((
399 -true for the defaultBranch
392 +true for the defaultBranch and for pull-requests, if a SonarQube version is detected which supports scanning multiple branches
400 400  
401 -false for all other branches and pull-requests
394 +false for all other branches
402 402  )))|(((
403 -Boolean which determines if SonarQube should be used if an installation is found.
396 +Set this to true to force a SonarQube scan for the current branch. Usually this makes only sense if you explicitly want to scan feature and bugfix branches.
404 404  
405 -The default is the best choice for the free community edition of SonarQube, which supports just one branch.
406 -
407 -If you have the Developer or Enterprise edition consider setting sonarQube to true to cover all branches. For more information see [[SonarQube>>SonarQube.WebHome]].
398 +If not set or set to false, the default branch will be scanned automatically as well as pull-requests, if a SonarQube version is detected which supports scanning multiple branches. This is currently the case for SonarQube Developer and Enterprise editions. The free SonarQube Community edition supports just one branch.
408 408  )))
409 409  |(((
410 410  sonarScanMavenOpts
... ... @@ -446,6 +446,23 @@
446 446  |sonarQualityGate| |Sets the desired quality gate to use for the scan result in SonarQube.
447 447  If not specified, the quality gate is not changed.
448 448  As a default, SonarQube will use the quality gate "Sonar way" for new scan results.
440 +|=(% colspan="1" rowspan="5" %)Dependency Check|skipDependencyCheck|false|Set to true to skip the dependency-check.
441 +|dependencyCheckTool|'dependency-check'|Defines which named dependency-check tool should be used.
442 +|dependencyCheckMvnArgs|'-DassemblyAnalyzerEnabled=false'|Additional arguments which are be passed to dependency-check for maven projects.(((
443 +See [[Dependency Check Maven Configuration>>https://jeremylong.github.io/DependencyCheck/dependency-check-maven/configuration.html]] for more information.
444 +)))
445 +|dependencyCheckArgs|'~-~-disableAssembly'|Addtional arguments which are be passed to dependency-check. See [[Dependency>>url:https://jeremylong.github.io/DependencyCheck/dependency-check-cli/arguments.html||shape="rect"]][[ Check CLI Arguments>>url:https://jeremylong.github.io/DependencyCheck/dependency-check-cli/arguments.html||shape="rect"]] for more information.
446 +|dependencyCheckNvdApiKeyCredentialsId|'dependency-check-nvdapikey'|If you have your own NVD API Key, set it as a credential of type text in Jenkins. Then specify the credential id using this argument. It will be automatically passed to dependency-check. There will be no error if no credential is found. Just the NVD download will be slower. Please note, on DevOps-as-a-Service a shared NVD API Key is automatically supplied for the default credential id.
447 +|=(% colspan="1" rowspan="2" %)Dependency Track|depTrackCredentialsId|'PROJECTKEY-deptrack-projectcreator'|(((
448 +Id of the Jenkins Credential which has to be used to authenticate to Dependency Track for publishing the SBOM.
449 +)))
450 +|depTrackClassifier|'application'|The component type (e.g. application, library, firmware, ...) that should be set in the SBOM file.
451 +Will be later shown as classifier for the project in Dependency Track.
452 +See [[CycloneDX Metadata Component Type>>https://cyclonedx.org/docs/1.6/json/#metadata_component_type]] for supported values.
453 +|=(% colspan="1" rowspan="2" %)Trivy|trivySeverity|'High'|String which sets the minimum severity of Trivy findings that has to be reached to mark the Trivy Results stage as unstable.
454 +Possible values are: "None", "Unknown", "Negligible", "Low", "Medium", "High", "Critical".
455 +|trivyBuildResult|'SUCCESS'|String which sets the overall build result when the result of the Trivy scan reaches trivyServerity.
456 +Possible values are: "SUCCESS", "UNSTABLE" or "FAILURE"
449 449  |=(% rowspan="7" %)(((
450 450  Deployment
451 451  )))|(((
1762161476370-318.png
Author
... ... @@ -1,0 +1,1 @@
1 +xwiki:XWiki.borisfolgmannt-systemscom
Size
... ... @@ -1,0 +1,1 @@
1 +79.4 KB
Content
1762161531690-966.png
Author
... ... @@ -1,0 +1,1 @@
1 +xwiki:XWiki.borisfolgmannt-systemscom
Size
... ... @@ -1,0 +1,1 @@
1 +82.3 KB
Content
© 2018-2026 T-Systems International GmbH