add exit_if_unreachable source config setting for #66

README.md

@@ -246,6 +246,27 @@ go get
 BUILDTIME=$(date -u '+%Y-%m-%d_%H:%M:%S') && go build -ldflags "-s -w -X main.buildtime=$BUILDTIME"
 ```
 
+- abort g10k run if source repository is unreachable
+
+```
+---
+:cachedir: '/tmp/g10k'
+
+sources:
+  example:
+    remote: 'git://github.com/xorpaul/g10k-environment-unavailable.git'
+    basedir: '/tmp/example/'
+    exit_if_unreachable: true
+```
+
+If you then call g10k with that config file. You should get:
+
+```
+WARN: git repository git://github.com/xorpaul/g10k-environment-unavailable.git does not exist or is unreachable at this moment!
+WARNING: Could not resolve git repository in source 'example' (git://github.com/xorpaul/g10k-environment-unavailable.git)
+```
+with an exit code 1
+
 # execute example with debug output
 ```
 ./g10k -debug -config test.yaml

g10k.go

@@ -24,6 +24,7 @@ var (
 	moduleDirParam         string
 	cacheDirParam          string
 	branchParam            string
+	configFile             string
 	config                 ConfigSettings
 	wg                     sync.WaitGroup
 	mutex                  sync.Mutex
@@ -81,6 +82,7 @@ type Source struct {
 	PrivateKey         string `yaml:"private_key"`
 	ForceForgeVersions bool   `yaml:"force_forge_versions"`
 	WarnMissingBranch  bool   `yaml:"warn_if_branch_is_missing"`
+	ExitIfUnreachable  bool   `yaml:"exit_if_unreachable"`
 }
 
 // Puppetfile contains the key value pairs from the Puppetfile
@@ -156,7 +158,7 @@ func main() {
 	flag.BoolVar(&quiet, "quiet", false, "no output, defaults to false")
 	flag.Parse()
 
-	configFile := *configFileFlag
+	configFile = *configFileFlag
 	version := *versionFlag
 
 	if version {

g10k_test.go

@@ -369,3 +369,56 @@ func TestModuleDirOverride(t *testing.T) {
 		t.Error("Expected '", moduleDirParam, "' for module dir, but got", got.moduleDir)
 	}
 }
+
+func TestResolvConfigExitIfUnreachable(t *testing.T) {
+	funcName := strings.Split(funcName(), ".")[len(strings.Split(funcName(), "."))-1]
+	config = readConfigfile("tests/TestConfigExitIfUnreachable.yaml")
+	purgeDir(config.CacheDir, "TestResolvConfigExitIfUnreachable()")
+	if os.Getenv("TEST_FOR_CRASH_"+funcName) == "1" {
+		resolvePuppetEnvironment("single")
+		return
+	}
+
+	cmd := exec.Command(os.Args[0], "-test.run="+funcName+"$")
+	cmd.Env = append(os.Environ(), "TEST_FOR_CRASH_"+funcName+"=1")
+	out, err := cmd.CombinedOutput()
+
+	exitCode := 0
+	if msg, ok := err.(*exec.ExitError); ok { // there is error code
+		exitCode = msg.Sys().(syscall.WaitStatus).ExitStatus()
+	}
+
+	if 1 != exitCode {
+		t.Errorf("resolvePuppetEnvironment() terminated with %v, but we expected exit status %v", exitCode, 1)
+	}
+	//fmt.Println(string(out))
+	if !strings.Contains(string(out), "WARN: git repository git://github.com/xorpaul/g10k-environment-unavailable.git does not exist or is unreachable at this moment!\nWARNING: Could not resolve git repository in source 'example' (git://github.com/xorpaul/g10k-environment-unavailable.git)") {
+		t.Errorf("resolvePuppetEnvironment() terminated with the correct exit code, but the expected output was missing")
+	}
+}
+
+func TestResolvConfigExitIfUnreachableFalse(t *testing.T) {
+	funcName := strings.Split(funcName(), ".")[len(strings.Split(funcName(), "."))-1]
+	config = readConfigfile("tests/TestConfigExitIfUnreachableFalse.yaml")
+	purgeDir(config.CacheDir, "TestResolvConfigExitIfUnreachableFalse()")
+	if os.Getenv("TEST_FOR_CRASH_"+funcName) == "1" {
+		resolvePuppetEnvironment("single")
+		return
+	}
+
+	cmd := exec.Command(os.Args[0], "-test.run="+funcName+"$")
+	cmd.Env = append(os.Environ(), "TEST_FOR_CRASH_"+funcName+"=1")
+	out, err := cmd.CombinedOutput()
+
+	exitCode := 0
+	if msg, ok := err.(*exec.ExitError); ok { // there is error code
+		exitCode = msg.Sys().(syscall.WaitStatus).ExitStatus()
+	}
+
+	if 0 != exitCode {
+		t.Errorf("resolvePuppetEnvironment() terminated with %v, but we expected exit status %v", exitCode, 1)
+	}
+	if !strings.Contains(string(out), "WARN: git repository git://github.com/xorpaul/g10k-environment-unavailable.git does not exist or is unreachable at this moment!\nWARNING: Could not resolve git repository in source 'example' (git://github.com/xorpaul/g10k-environment-unavailable.git)") {
+		t.Errorf("resolvePuppetEnvironment() terminated with the correct exit code, but the expected output was missing")
+	}
+}

git.go

@@ -110,7 +110,7 @@ func doMirrorOrUpdate(url string, workDir string, sshPrivateKey string, allowFai
 	}
 
 	if er.returnCode != 0 {
-		fmt.Println("WARN: git repository " + url + " does not exist or is unreachable at this moment!")
+		Warnf("WARN: git repository " + url + " does not exist or is unreachable at this moment!")
 		return false
 	}
 	return true

puppetfile.go

@@ -1,6 +1,7 @@
 package main
 
 import (
+	"fmt"
 	"io/ioutil"
 	"os"
 	"strings"
@@ -9,6 +10,21 @@ import (
 	"github.com/henvic/uiprogress"
 )
 
+// sourceSanityCheck is a validation function that checks if the given source has all neccessary attributes (basedir, remote, SSH key exists if given)
+func sourceSanityCheck(source string, sa Source) {
+	if len(sa.PrivateKey) > 0 {
+		if _, err := os.Stat(sa.PrivateKey); err != nil {
+			Fatalf("resolvePuppetEnvironment(): could not find SSH private key " + sa.PrivateKey + " for source " + source + " in config file " + configFile + " Error: " + err.Error())
+		}
+	}
+	if len(sa.Basedir) <= 0 {
+		Fatalf("resolvePuppetEnvironment(): config setting basedir is not set for source " + source + " in config file " + configFile)
+	}
+	if len(sa.Remote) <= 0 {
+		Fatalf("resolvePuppetEnvironment(): config setting remote is not set for source " + source + " in config file " + configFile)
+	}
+}
+
 func resolvePuppetEnvironment(envBranch string) {
 	allPuppetfiles := make(map[string]Puppetfile)
 	for source, sa := range config.Sources {
@@ -20,12 +36,10 @@ func resolvePuppetEnvironment(envBranch string) {
 			}
 
 			sa.Basedir = checkDirAndCreate(sa.Basedir, "basedir for source "+source)
-			Debugf("Puppet environment: " + source + " (remote=" + sa.Remote + ", basedir=" + sa.Basedir + ", private_key=" + sa.PrivateKey + ", prefix=" + sa.Prefix + ")")
-			if len(sa.PrivateKey) > 0 {
-				if _, err := os.Stat(sa.PrivateKey); err != nil {
-					Fatalf("resolvePuppetEnvironment(): could not find SSH private key " + sa.PrivateKey + "error: " + err.Error())
-				}
-			}
+			Debugf("Puppet environment: " + source + " (" + fmt.Sprintf("%+v", sa) + ")")
+
+			// check for a valid source that has all neccessary attributes (basedir, remote, SSH key exists if given)
+			sourceSanityCheck(source, sa)
 
 			workDir := config.EnvCacheDir + source + ".git"
 			// check if sa.Basedir exists
@@ -83,6 +97,11 @@ func resolvePuppetEnvironment(envBranch string) {
 				if sa.WarnMissingBranch && !foundBranch {
 					Warnf("WARNING: Couldn't find specified branch '" + envBranch + "' anywhere in source '" + source + "' (" + sa.Remote + ")")
 				}
+			} else {
+				Warnf("WARNING: Could not resolve git repository in source '" + source + "' (" + sa.Remote + ")")
+				if sa.ExitIfUnreachable == true {
+					os.Exit(1)
+				}
 			}
 		}(source, sa)
 	}

tests/TestConfigExitIfUnreachable.yaml

@@ -0,0 +1,8 @@
+---
+:cachedir: '/tmp/g10k'
+
+sources:
+  example:
+    remote: 'git://github.com/xorpaul/g10k-environment-unavailable.git'
+    basedir: '/tmp/example/'
+    exit_if_unreachable: true

tests/TestConfigExitIfUnreachableFalse.yaml

@@ -0,0 +1,8 @@
+---
+:cachedir: '/tmp/g10k'
+
+sources:
+  example:
+    remote: 'git://github.com/xorpaul/g10k-environment-unavailable.git'
+    basedir: '/tmp/example/'
+    exit_if_unreachable: false