Merge branch 'release/v2.1.0'

Author: Joshua Sprey

CHANGELOG.md

@@ -4,6 +4,14 @@ All notable changes to this project will be documented in this file.
 The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/),
 and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html).
 
+## [Unreleased]
+
+## [v2.1.0](https://github.com/cloudogu/zalenium-build-lib/releases/tag/v2.1.0) - 2020-12-14
+
+### Added
+
+- config parameter for controlling the video recording during test execution (#11)
+
 ## [v2.0.0](https://github.com/cloudogu/zalenium-build-lib/releases/tag/v2.0.0) - 2020-02-21
 
 Heads-up: Breaking change ahead!

README.md

@@ -224,4 +224,18 @@ withZalenium([ debugZalenium : true ]) { zaleniumIp ->
 * [cloudogu/jenkins](https://github.com/cloudogu/jenkins/blob/3bc8b6ab406477e0c3bb232e05f745b1fc91ba70/Jenkinsfile)  (JavaScript / yarn)
 * [cloudogu/redmine](https://github.com/cloudogu/redmine/blob/740dd3a99a8111c31e4ada1ccb3023d84d6d205f/Jenkinsfile)  (JavaScript / yarn)
 * [cloudogu/scm](https://github.com/cloudogu/scm/blob/4f1c998425e175a7a52f97dff5b78e82f244a9bf/Jenkinsfile)  (JavaScript / yarn)
-* [cloudogu/sonar](https://github.com/cloudogu/sonar/blob/3488a6e7e38ee5e2e8fde807de570028e15835a1/Jenkinsfile)  (JavaScript / yarn)
+* [cloudogu/sonar](https://github.com/cloudogu/sonar/blob/3488a6e7e38ee5e2e8fde807de570028e15835a1/Jenkinsfile)  (JavaScript / yarn)
+
+---
+### What is the Cloudogu EcoSystem?
+The Cloudogu EcoSystem is an open platform, which lets you choose how and where your team creates great software. Each service or tool is delivered as a Dogu, a Docker container. Each Dogu can easily be integrated in your environment just by pulling it from our registry. We have a growing number of ready-to-use Dogus, e.g. SCM-Manager, Jenkins, Nexus, SonarQube, Redmine and many more. Every Dogu can be tailored to your specific needs. Take advantage of a central authentication service, a dynamic navigation, that lets you easily switch between the web UIs and a smart configuration magic, which automatically detects and responds to dependencies between Dogus. The Cloudogu EcoSystem is open source and it runs either on-premises or in the cloud. The Cloudogu EcoSystem is developed by Cloudogu GmbH under [MIT License](https://cloudogu.com/license.html).
+
+### How to get in touch?
+Want to talk to the Cloudogu team? Need help or support? There are several ways to get in touch with us:
+
+* [Website](https://cloudogu.com)
+* [myCloudogu-Forum](https://forum.cloudogu.com/topic/34?ctx=1)
+* [Email [email protected]](mailto:[email protected])
+
+---
+© 2020 Cloudogu GmbH - MADE WITH :heart: FOR DEV ADDICTS. [Legal notice / Impressum](https://cloudogu.com/imprint.html)

vars/withZalenium.groovy

@@ -4,27 +4,29 @@
  *
  * @param config contains a map of settings that change the Zalenium behavior. Can be a partial map or even left out.
  *      The defaults are:
- *      [seleniumVersion   : '3.141.59-p8',
- *      seleniumImage      : 'elgalu/selenium',
- *      zaleniumVersion    : '3.141.59g',
- *      zaleniumImage      : 'dosel/zalenium',
- *      zaleniumVideoDir   : 'zalenium',
- *      sendGoogleAnalytics: false,
- *      debugZalenium      : false]
+ *      [seleniumVersion     : '3.141.59-p8',
+ *      seleniumImage        : 'elgalu/selenium',
+ *      zaleniumVersion      : '3.141.59g',
+ *      zaleniumImage        : 'dosel/zalenium',
+ *      zaleniumVideoDir     : 'zalenium',
+ *      debugZalenium        : false,
+ *      videoRecordingEnabled: false,
+ *      sendGoogleAnalytics  : false]
  * @param zaleniumNetwork The Zalenium container will be added to this docker network. This is useful if other containers
  *      must communicate with Zalenium while being in a docker network. If empty or left out, Zalenium will stay in the
  *      default network.
  * @param closure the body
  */
 void call(Map config = [:], String zaleniumNetwork, Closure closure) {
 
-    def defaultConfig = [seleniumVersion    : '3.141.59-p8',
-                         seleniumImage      : 'elgalu/selenium',
-                         zaleniumVersion    : '3.141.59g',
-                         zaleniumImage      : 'dosel/zalenium',
-                         zaleniumVideoDir   : 'zalenium',
-                         debugZalenium      : false,
-                         sendGoogleAnalytics: false]
+    def defaultConfig = [seleniumVersion      : '3.141.59-p8',
+                         seleniumImage        : 'elgalu/selenium',
+                         zaleniumVersion      : '3.141.59g',
+                         zaleniumImage        : 'dosel/zalenium',
+                         zaleniumVideoDir     : 'zalenium',
+                         debugZalenium        : false,
+                         videoRecordingEnabled: false,
+                         sendGoogleAnalytics  : false]
 
     // Merge default config with the one passed as parameter
     config = defaultConfig << config
@@ -58,6 +60,7 @@ void call(Map config = [:], String zaleniumNetwork, Closure closure) {
                         "-v ${WORKSPACE}/${config.zaleniumVideoDir}:/home/seluser/videos",
                 'start ' +
                         "--seleniumImageName ${config.seleniumImage} " +
+                        "--videoRecordingEnabled ${config.videoRecordingEnabled} " +
                         "${config.debugZalenium ? '--debugEnabled true' : ''} " +
                         // switch off analytic gathering
                         "${config.sendGoogleAnalytics ? '--sendAnonymousUsageInfo false' : ''} "
@@ -77,7 +80,9 @@ void call(Map config = [:], String zaleniumNetwork, Closure closure) {
                 // Wait for Selenium sessions to end (i.e. videos to be copied)
                 // Leaving the withRun() closure leads to "docker rm -f" being called, cancelling copying
                 waitForSeleniumSessionsToEnd(zaleniumIp)
-                archiveArtifacts allowEmptyArchive: true, artifacts: "${config.zaleniumVideoDir}/*.mp4"
+                if(config.videoRecordingEnabled) {
+                    archiveArtifacts allowEmptyArchive: true, artifacts: "${config.zaleniumVideoDir}/*.mp4"
+                }
 
                 // Stop container gracefully and wait
                 sh "docker stop ${zaleniumContainer.id}"

vars/withZalenium.txt

@@ -10,6 +10,7 @@ Requires Docker!
 - zaleniumVersion - version of the zalenium docker image
 - zaleniumVideoDir - path where the videos are stored, relative to the Jenkins workspace.
 - debugZalenium - makes the zalenium container write a lot more logs
+- videoRecordingEnabled - enables the video recording during the test execution; defaults to false
 - sendGoogleAnalytics - if true this will send analytic data to Google/Zalando
 
 Exemplary calls: