PRE_CLEAR_INIT_GROOVY_D: Add in ability to pre-clear the init.groovy.d folder

[ac-hibbert]

Currently you can populate the init.groovy.d folder with scripts that you want to run and append .override if you require to override current scripts of the same name. However you cannot override the whole directory, this may be necessary if you wish to remove scripts, change names of scripts, change run order etc. This fix allows the user to pre-clear the init.groovy.d folder prior to the files being copied into place, meaning the files you copy over to $REF/init.groovy.d will be the only ones present

[timja]

Seems fine, anyone else got any thoughts on it? @MarkEWaite ?

[MarkEWaite]

Seems fine, anyone else got any thoughts on it? @MarkEWaite ?

It seems like this Is introducing a specific implementation of a more general concept. I think the general concept is that a subdirectory in JENKINS_HOME is to be completely managed by the contents copied from the base image.

The .override technique allows a single file to always replace the same file in the JENKINS_HOME directory. Should we extend the concept to an entire directory?

[whoami-anoint]

# Default values for JENKINS_WAR and JENKINS_HOME
JENKINS_WAR="${JENKINS_WAR:-/usr/share/jenkins/jenkins.war}"
JENKINS_HOME="${JENKINS_HOME:-/var/jenkins_home}"

# If PRE_CLEAR_INIT_GROOVY_D variable is not empty, remove init.groovy.d directory
if [[ -n "$PRE_CLEAR_INIT_GROOVY_D" ]]; then
    rm -rf "${JENKINS_HOME}/init.groovy.d"
fi

# Default values for COPY_REFERENCE_FILE_LOG and REF
COPY_REFERENCE_FILE_LOG="${COPY_REFERENCE_FILE_LOG:-${JENKINS_HOME}/copy_reference_file.log}"
REF="${REF:-/usr/share/jenkins/ref}"

# Attempt to create the COPY_REFERENCE_FILE_LOG file and handle errors if any
touch "$COPY_REFERENCE_FILE_LOG" || {
    echo "Cannot write to ${COPY_REFERENCE_FILE_LOG}. Wrong volume permissions?" >&2
    exit 1
}

Note:

• Add Comments: Although the code is relatively straightforward, adding comments can make it more understandable, especially for others who might read or maintain the code in the future.

• Consistent Quoting: The code already uses double quotes around variables in most places, which is good for handling spaces and special characters in values. Ensure consistency in using double quotes throughout the script.

• Improve Error Handling: The code includes some basic error handling for the touch command failure. Depending on the context, you might want to include more robust error handling to handle various failure scenarios gracefully.

[saper]

Would that be enough if a directory pointed to by a (not yet existing) environment variable INIT_GROOVY_D is supplied on the build host and copied over inside of the image?

(Anyway it might be easier to use -v at runtime to mount something else as init.groovy.d)