#857 - Make the Jenkins WAR path configurable by the JENKINS_WAR env property (#873)

* [#857] Make the jenkins.war configurable by JENKINS_WAR env property

* [#857] A final new line

* [#857] Add env variables documentation and minor fixes

* [#861] Merge documentation sections

* [#861] Format default values

Author: MRamonLeon

.gitignore

@@ -6,3 +6,5 @@ tests/functions/copy_reference_file.log
 manifest-tool
 multiarch/qemu-*
 multiarch/Dockerfile-*
+/docker.iml
+/.idea/

Makefile

@@ -51,6 +51,9 @@ test-centos: prepare-test
 
 test: test-debian test-alpine test-slim test-jdk11 test-centos
 
+test-install-plugins: prepare-test
+	DOCKERFILE=Dockerfile-alpine bats/bin/bats tests/install-plugins.bats
+
 publish:
 	./publish.sh ; \
 	./publish.sh --variant alpine ; \

README.md

@@ -183,7 +183,9 @@ During the download, the script will use update centers defined by the following
   Defines Maven mirror to be used to download plugins from the
   [Incrementals repo](https://jenkins.io/blog/2018/05/15/incremental-deployment/).
   Default value: https://repo.jenkins-ci.org/incrementals
-
+* `JENKINS_UC_DOWNLOAD` - Download url of the Update Center. 
+  Default value: `$JENKINS_UC/download`
+  
 It is possible to override the environment variables in images.
 
 :exclamation: Note that changing this variables **will not** change the Update Center being used by Jenkins runtime.
@@ -207,6 +209,20 @@ There are also custom version specifiers:
     `mvn incrementals:updatePluginsTxt -DpluginsFile=plugins.txt`.
     [More Info](https://github.com/jenkinsci/incrementals-tools#updating-versions-for-jenkins-docker-images)
 
+### Fine-tune the downloads
+
+The script uses `curl` to download the plugins. You can configure the options with some environment variables:
+* `CURL_OPTIONS`: When downloading the plugins with curl. Curl options. Default value: `-sSfL`
+* `CURL_CONNECTION_TIMEOUT`: When downloading the plugins with curl. <seconds> Maximum time allowed for connection. Default value: `20`
+* `CURL_RETRY`: When downloading the plugins with curl. Retry request if transient problems occur. Default value: `3`
+* `CURL_RETRY_DELAY`: When downloading the plugins with curl. <seconds> Wait time between retries. Default value: `0`
+* `CURL_RETRY_MAX_TIME`: When downloading the plugins with curl. <seconds> Retry only within this period. Default value: `60`
+ 
+### Other environment variables
+In case you have changed some default paths in the image, you can modify their values with these environment variables:
+* `REF`: directory with preinstalled plugins. Default value: `/usr/share/jenkins/ref/plugins`
+* `JENKINS_WAR`: full path to the jenkins.war. Default value: `/usr/share/jenkins/jenkins.war`
+ 
 ### Script usage
 
 You can run the script manually in Dockerfile:

install-plugins.sh

@@ -4,12 +4,27 @@
 #
 # FROM jenkins
 # RUN install-plugins.sh docker-slaves github-branch-source
+#
+# Environment variables:
+# REF: directory with preinstalled plugins. Default: /usr/share/jenkins/ref/plugins
+# JENKINS_WAR: full path to the jenkins.war. Default: /usr/share/jenkins/jenkins.war
+# JENKINS_UC: url of the Update Center. Default: ""
+# JENKINS_UC_EXPERIMENTAL: url of the Experimental Update Center for experimental versions of plugins. Default: ""
+# JENKINS_INCREMENTALS_REPO_MIRROR: url of the incrementals repo mirror. Default: ""
+# JENKINS_UC_DOWNLOAD: download url of the Update Center. Default: JENKINS_UC/download
+# CURL_OPTIONS When downloading the plugins with curl. Curl options. Default: -sSfL
+# CURL_CONNECTION_TIMEOUT When downloading the plugins with curl. <seconds> Maximum time allowed for connection. Default: 20
+# CURL_RETRY When downloading the plugins with curl. Retry request if transient problems occur. Default: 3
+# CURL_RETRY_DELAY When downloading the plugins with curl. <seconds> Wait time between retries. Default: 0
+# CURL_RETRY_MAX_TIME When downloading the plugins with curl. <seconds> Retry only within this period. Default: 60
 
 set -o pipefail
 
 REF_DIR=${REF:-/usr/share/jenkins/ref/plugins}
 FAILED="$REF_DIR/failed-plugins.txt"
 
+JENKINS_WAR=${JENKINS_WAR:-/usr/share/jenkins/jenkins.war}
+
 . /usr/local/bin/jenkins-support
 
 getLockFile() {
@@ -147,11 +162,10 @@ resolveDependencies() {
 }
 
 bundledPlugins() {
-    local JENKINS_WAR=/usr/share/jenkins/jenkins.war
-    if [ -f $JENKINS_WAR ]
+    if [ -f "$JENKINS_WAR" ]
     then
         TEMP_PLUGIN_DIR=/tmp/plugintemp.$$
-        for i in $(jar tf $JENKINS_WAR | grep -E '[^detached-]plugins.*\..pi' | sort)
+        for i in $(jar tf "$JENKINS_WAR" | grep -E '[^detached-]plugins.*\..pi' | sort)
         do
             rm -fr $TEMP_PLUGIN_DIR
             mkdir -p $TEMP_PLUGIN_DIR
@@ -183,11 +197,9 @@ installedPlugins() {
 }
 
 jenkinsMajorMinorVersion() {
-    local JENKINS_WAR
-    JENKINS_WAR=/usr/share/jenkins/jenkins.war
     if [[ -f "$JENKINS_WAR" ]]; then
         local version major minor
-        version="$(java -jar $JENKINS_WAR --version)"
+        version="$(java -jar "$JENKINS_WAR" --version)"
         major="$(echo "$version" | cut -d '.' -f 1)"
         minor="$(echo "$version" | cut -d '.' -f 2)"
         echo "$major.$minor"
@@ -224,7 +236,7 @@ main() {
         mkdir "$(getLockFile "${plugin%%:*}")"
     done
 
-    echo "Analyzing war..."
+    echo "Analyzing war $JENKINS_WAR..."
     bundledPlugins="$(bundledPlugins)"
 
     echo "Registering preinstalled plugins..."

tests/install-plugins.bats

@@ -201,3 +201,15 @@ SUT_IMAGE=$(sut_image)
   run docker_build_child $SUT_IMAGE-install-plugins-no-war $BATS_TEST_DIRNAME/install-plugins/no-war
   assert_success
 }
+
+@test "Use a custom jenkins.war" {
+  # Build the image using the right Dockerfile setting a new war with JENKINS_WAR env and with a weird plugin inside
+  run docker_build_child $SUT_IMAGE-install-plugins-custom-war $BATS_TEST_DIRNAME/install-plugins/custom-war --no-cache
+  assert_success
+  # Assert the weird plugin is there
+  assert_output --partial 'my-happy-plugin:1.1'
+}
+
+@test "clean work directory" {
+    run bash -c "rm -rf $BATS_TEST_DIRNAME/custom-war/work-${SUT_IMAGE}"
+}

tests/install-plugins/custom-war/Dockerfile

@@ -0,0 +1,21 @@
+FROM bats-jenkins
+
+# Define a custom location for the war
+ENV JENKINS_WAR /test-custom-dockerfile/my-custom-jenkins.war
+WORKDIR /test-custom-dockerfile
+# Add there a new weird plugin to assert
+COPY --chown=jenkins:jenkins WEB-INF/ WEB-INF/
+
+USER root
+RUN chown jenkins:jenkins /test-custom-dockerfile
+USER jenkins
+
+# Copy the original jenkins.war to the custom location 
+RUN cp /usr/share/jenkins/jenkins.war $JENKINS_WAR && \
+    chown jenkins:jenkins $JENKINS_WAR
+
+# Add the weird plugin to the new custom war
+RUN jar -uf my-custom-jenkins.war WEB-INF/* 
+
+# Run the install-plugins.sh script
+RUN /usr/local/bin/install-plugins.sh maven-plugin:2.7.1