Merge pull request #13 from samply/feature/addedGitDiffForGitlab

Ensured Logging through the Log Function

lib/add_bc_user.sh

@@ -1,12 +1,10 @@
 #!/bin/bash -e
 source lib/functions.sh
 
-log "This script add's a user with password to the bridghead"
+log "INFO" "This script add's a user with password to the bridghead"
 
 read -p 'Username: ' bc_user
 read -sp 'Password: ' bc_password
 
-echo
+log "INFO" "\nPlease export the line in the your environment. Please replace the dollar signs with with \\\$"
-
-log "Please export the line in the your environment. Please replace the dollar signs with with \\\$"
 docker run --rm -it httpd:latest htpasswd -nb $bc_user $bc_password

lib/functions.sh

@@ -2,13 +2,13 @@
 
 exitIfNotRoot() {
   if [ "$EUID" -ne 0 ]; then
-    echo "Please run as root"
+    log "ERROR" "Please run as root"
     exit 1
   fi
 }
 
 log() {
-  echo "$(date +'%Y-%m-%d %T')" "$1:" "$2"
+  echo -e "$(date +'%Y-%m-%d %T')" "$1:" "$2"
 }
 
 printUsage() {
@@ -18,7 +18,7 @@ printUsage() {
 
 checkRequirements() {
 	if ! lib/prerequisites.sh; then
-		log ERROR "Validating Prerequisites failed, please fix the error(s) above this line."
+		log "ERROR" "Validating Prerequisites failed, please fix the error(s) above this line."
 		exit 1
 	else
 		return 0
@@ -38,12 +38,12 @@ fetchVarsFromVault() {
 		return 0
 	fi
 
-	log INFO "Fetching secrets from vault ..."
+	log "INFO" "Fetching secrets from vault ..."
 
 	[ -e /etc/bridgehead/vault.conf ] && source /etc/bridgehead/vault.conf
 
 	if [ -z "$BW_MASTERPASS" ] || [ -z "$BW_CLIENTID" ] || [ -z "$BW_CLIENTSECRET" ]; then
-		log ERROR "Please supply correct credentials in /etc/bridgehead/vault.conf."
+		log "ERROR" "Please supply correct credentials in /etc/bridgehead/vault.conf."
 		return 1
 	fi
 

lib/remove-bridgehead-units.sh

@@ -3,12 +3,12 @@
 source lib/functions.sh
 
 if [ $# -eq 0 ]; then
-    log "Please provide a Project as argument"
+    log "ERROR" "Please provide a Project as argument"
     exit 1
 fi
 
 if [ $1 != "ccp" ] && [ $1 != "nngm" ] && [ $1 != "gbn" ]; then
-    log "Please provide a supported project like ccp, gbn or nngm"
+    log "ERROR" "Please provide a supported project like ccp, gbn or nngm"
     exit 1
 fi
 
@@ -16,8 +16,10 @@ export PROJECT=$1
 
 #checkRequirements // not needed when uninstalling
 
-log "Stopping systemd services and removing bridgehead ..."
+log "INFO" "Stopping system units and removing bridgehead for ${PROJECT} ..."
 
 systemctl disable --now bridgehead@${PROJECT}.service bridgehead-update@${PROJECT}.timer bridgehead-update@${PROJECT}.service
 
 rm -v /etc/systemd/system/{bridgehead\@.service,bridgehead-update\@.timer,bridgehead-update\@.service}
+
+log "INFO" "Successfully removed bridgehead for ${PROJECT} from your system"

lib/setup-bridgehead-units.sh

@@ -5,12 +5,12 @@ source lib/functions.sh
 exitIfNotRoot
 
 if [ $# -eq 0 ]; then
-    log "Please provide a Project as argument"
+    log "ERROR" "Please provide a Project as argument"
     exit 1
 fi
 
 if [ $1 != "ccp" ] && [ $1 != "nngm" ] && [ $1 != "gbn" ]; then
-    log "Please provide a supported project like ccp, gbn or nngm"
+    log "ERROR" "Please provide a supported project like ccp, gbn or nngm"
     exit 1
 fi
 
@@ -18,7 +18,7 @@ export PROJECT=$1
 
 checkRequirements
 
-echo -e "\nInstalling systemd units ..."
+log "INFO" "Register system units for bridgehead and bridgehead-update"
 cp -v \
     lib/systemd/bridgehead\@.service \
     lib/systemd/bridgehead-update\@.service \
@@ -27,13 +27,11 @@ cp -v \
 
 systemctl daemon-reload
 
-echo
-
 if ! systemctl is-active --quiet bridgehead@"${PROJECT}"; then
-    log "Enabling autostart of bridgehead@${PROJECT}.service"
+    log "INFO" "Enabling autostart of bridgehead@${PROJECT}.service"
     systemctl enable bridgehead@"${PROJECT}"
-    log "Enabling nightly updates for bridgehead@${PROJECT}.service ..."
+    log "INFO" "Enabling nightly updates for bridgehead@${PROJECT}.service ..."
     systemctl enable --now bridgehead-update@"${PROJECT}".timer
 fi
 
-echo -e "\nDone - now start your bridgehead by running\n\tsystemctl start bridgehead@${PROJECT}.service\nor by rebooting your machine."
+log "INFO" "\nDone - now start your bridgehead by running\n\tsystemctl start bridgehead@${PROJECT}.service\nor by rebooting your machine."

lib/update-bridgehead.sh

@@ -8,15 +8,22 @@ for DIR in /etc/bridgehead $(pwd); do
   old_git_hash="$(git -C $DIR rev-parse --verify HEAD)"
   git -C $DIR fetch 2>&1
   git -C $DIR pull 2>&1
-  git -C $DIR remote -v
   new_git_hash="$(git -C $DIR rev-parse --verify HEAD)"
   git_updated="false"
   if [ "$old_git_hash" != "$new_git_hash" ]; then
     log "INFO" "Updated git repository in ${DIR} from commit $old_git_hash to $new_git_hash"
     # NOTE: Link generation doesn't work on repositories placed at an self-hosted instance of bitbucket.
     # See: https://community.atlassian.com/t5/Bitbucket-questions/BitBucket-4-14-diff-between-any-two-commits/qaq-p/632974
-    if [ "$(git -C $DIR remote get-url origin | grep "github.com")" ]; then
+    git_repository_url="$(git -C $DIR remote get-url origin)"
-      log "INFO" "You can review all changes on the repository with https://github.com/samply/bridgehead/compare/$old_git_hash...$new_git_hash"
+    git_repository_url=${git_repository_url/.git/}
+    if [ "$( echo $git_repository_url | grep "github.com")" ]; then
+      # Ensure web link even if ssh is used
+      git_repository_url="${git_repository_url/git@github.com/https:\/\/github.com\/}"
+      log "INFO" "You can review all changes on the repository with $git_repository_url/compare/$old_git_hash...$new_git_hash"
+    elif [ "$( echo $git_repository_url | grep "git.verbis.dkfz.de")" ]; then
+      git_repository_url="${git_repository_url/ssh:\/\/git@git.verbis.dkfz.de/https:\/\/git.verbis.dkfz.de\/}"
+      git_repository_url="https://$(echo $git_repository_url | awk -F '@' '{print $2}')"
+      log "INFO" "You can review all changes on the repository with $git_repository_url/compare?from=$old_git_hash&to=$new_git_hash"
     fi
     git_updated="true"
   fi