Merge pull request #243 from qlik-oss/2nd-relative

change config and cr file path relative to ~/.qliksense

cmd/qliksense/preflight.go

@@ -4,21 +4,20 @@ import (
 	"fmt"
 	"log"
 
+	"github.com/qlik-oss/sense-installer/pkg/preflight"
+
 	"github.com/qlik-oss/sense-installer/pkg/qliksense"
 	"github.com/spf13/cobra"
 )
 
 func preflightCmd(q *qliksense.Qliksense) *cobra.Command {
-	var configCmd = &cobra.Command{
-		Use:   "preflight",
-		Short: "perform preflight checks on the cluster",
-		Long:  `perform preflight checks on the cluster`,
-		Example: `qliksense preflight <preflight_check_to_run>
-Usage:
-qliksense preflight dns
-`,
+	var preflightCmd = &cobra.Command{
+		Use:     "preflight",
+		Short:   "perform preflight checks on the cluster",
+		Long:    `perform preflight checks on the cluster`,
+		Example: `qliksense preflight <preflight_check_to_run>`,
 	}
-	return configCmd
+	return preflightCmd
 }
 
 func preflightCheckDnsCmd(q *qliksense.Qliksense) *cobra.Command {
@@ -28,14 +27,55 @@ func preflightCheckDnsCmd(q *qliksense.Qliksense) *cobra.Command {
 		Long:    `perform preflight dns check to check DNS connectivity status in the cluster`,
 		Example: `qliksense preflight dns`,
 		RunE: func(cmd *cobra.Command, args []string) error {
-			err := q.DownloadPreflight()
+			qp := &preflight.QliksensePreflight{Q: q}
+			err := qp.DownloadPreflight()
 			if err != nil {
 				err = fmt.Errorf("There has been an error downloading preflight: %+v", err)
 				log.Println(err)
 				return err
 			}
-			return q.CheckDns()
+			return qp.CheckDns()
 		},
 	}
 	return preflightDnsCmd
 }
+
+func preflightCheckK8sVersionCmd(q *qliksense.Qliksense) *cobra.Command {
+	var preflightCheckK8sVersionCmd = &cobra.Command{
+		Use:     "k8s-version",
+		Short:   "check k8s version",
+		Long:    `check minimum valid k8s version on the cluster`,
+		Example: `qliksense preflight k8s-version`,
+		RunE: func(cmd *cobra.Command, args []string) error {
+			qp := &preflight.QliksensePreflight{Q: q}
+			err := qp.DownloadPreflight()
+			if err != nil {
+				err = fmt.Errorf("There has been an error downloading preflight: %+v", err)
+				log.Println(err)
+				return err
+			}
+			return qp.CheckK8sVersion()
+		},
+	}
+	return preflightCheckK8sVersionCmd
+}
+
+func preflightAllChecksCmd(q *qliksense.Qliksense) *cobra.Command {
+	var preflightAllChecksCmd = &cobra.Command{
+		Use:     "all",
+		Short:   "perform all checks",
+		Long:    `perform all preflight checks on the target cluster`,
+		Example: `qliksense preflight all`,
+		RunE: func(cmd *cobra.Command, args []string) error {
+			qp := &preflight.QliksensePreflight{Q: q}
+			err := qp.DownloadPreflight()
+			if err != nil {
+				err = fmt.Errorf("There has been an error downloading preflight: %+v", err)
+				log.Println(err)
+				return err
+			}
+			return qp.RunAllPreflightChecks()
+		},
+	}
+	return preflightAllChecksCmd
+}

cmd/qliksense/root.go

@@ -188,6 +188,8 @@ func rootCmd(p *qliksense.Qliksense) *cobra.Command {
 	// add preflight command
 	preflightCmd := preflightCmd(p)
 	preflightCmd.AddCommand(preflightCheckDnsCmd(p))
+	preflightCmd.AddCommand(preflightCheckK8sVersionCmd(p))
+	preflightCmd.AddCommand(preflightAllChecksCmd(p))
 	//preflightCmd.AddCommand(preflightCheckMongoCmd(p))
 	//preflightCmd.AddCommand(preflightCheckAllCmd(p))
 

docs/concepts.md

@@ -95,36 +95,3 @@ spec:
 ....
 ```
 
-##Preflight checks
-Preflight checks provide pre-installation cluster conformance testing and validation before we install qliksense on the cluster. We gather a suite of conformance tests that can be easily written and run on the target cluster to verify that cluster-specific requirements are met.
-The suite consists of a set of `collectors` which run the specifications of every test and `analyzers` which analyze the results of every test run by the collector.
-We support the following tests at the moment as part of preflight checks, and the range of the suite will be expanded in future.
-
-### DNS check
-Run the following command to view help about the commands supported by preflight at any moment:
-```console
-qliksense preflight
-perform preflight checks on the cluster
-
-Usage:
-  qliksense preflight [command]
-
-Examples:
-qliksense preflight <preflight_check_to_run>
-
-Usage:
-qliksense preflight dns
-
-Available Commands:
-  dns         perform preflight dns check
-```
-
-Run the following command to perform preflight DNS check. The expected output is also shown below.
-```console
-qliksense preflight dns
-  Running Preflight checks ⠧
---- PASS DNS check
-      --- DNS check passed
---- PASS   cluster-preflight-checks
-PASS
-```

docs/preflight_checks.md

@@ -0,0 +1,100 @@
+##Preflight checks
+Preflight checks provide pre-installation cluster conformance testing and validation before we install qliksense on the cluster. We gather a suite of conformance tests that can be easily written and run on the target cluster to verify that cluster-specific requirements are met.
+The suite consists of a set of `collectors` which run the specifications of every test and `analyzers` which analyze the results of every test run by the collector.
+We support the following tests at the moment as part of preflight checks, and the range of the suite will be expanded in future.
+
+Run the following command to view help about the commands supported by preflight at any moment:
+```console
+$ qliksense preflight
+perform preflight checks on the cluster
+
+Usage:
+  qliksense preflight [command]
+
+Examples:
+qliksense preflight <preflight_check_to_run>
+
+Available Commands:
+  all         perform all checks
+  dns         perform preflight dns check
+  k8s-version check k8s version
+
+Flags:
+  -h, --help   help for preflight
+```
+
+### DNS check
+Run the following command to perform preflight DNS check. We setup a kubernetes deployment and try to reach it as part of establishing DNS connectivity in this check. 
+The expected output should be similar to the one shown below.
+```console
+$ qliksense preflight dns
+
+Creating resources to run preflight checks
+deployment.apps/qnginx001 created
+service/qnginx001 created
+pod/qnginx001-6db5fc95c5-s9sl2 condition met
+  Running Preflight checks ⠇
+--- PASS DNS check
+      --- DNS check passed
+--- PASS   cluster-preflight-checks
+PASS
+
+DNS check completed, cleaning up resources now
+service "qnginx001" deleted
+deployment.extensions "qnginx001" deleted
+
+```
+
+### Kubernetes version check
+We check the version of the target kubernetes cluster and ensure that it falls in the valid range of kubernetes versions that are supported by qliksense. 
+The command to run this check and the expected similar output are as shown below:
+```console
+$ qliksense preflight k8s-version
+
+Minimum Kubernetes version supported: 1.11.0
+Client Version: version.Info{Major:"1", Minor:"17", GitVersion:"v1.17.3", GitCommit:"06ad960bfd03b39c8310aaf92d1e7c12ce618213", GitTreeState:"clean", BuildDate:"2020-02-13T18:08:14Z", GoVersion:"go1.13.8", Compiler:"gc", Platform:"darwin/amd64"}
+Server Version: version.Info{Major:"1", Minor:"15", GitVersion:"v1.15.5", GitCommit:"20c265fef0741dd71a66480e35bd69f18351daea", GitTreeState:"clean", BuildDate:"2019-10-15T19:07:57Z", GoVersion:"go1.12.10", Compiler:"gc", Platform:"linux/amd64"}
+  Running Preflight checks ⠇
+--- PASS Required Kubernetes Version
+      --- Good to go.
+--- PASS   cluster-preflight-checks
+PASS
+
+Minimum kubernetes version check completed
+```
+
+### Running all checks
+Run the command shown below to execute all preflight checks.
+```console
+$ qliksense preflight all
+
+Running all preflight checks
+
+Running DNS check...
+Creating resources to run preflight checks
+deployment.apps/qnginx001 created
+service/qnginx001 created
+pod/qnginx001-6db5fc95c5-grwv2 condition met
+  Running Preflight checks ⠇
+--- PASS DNS check
+      --- DNS check passed
+--- PASS   cluster-preflight-checks
+PASS
+
+DNS check completed, cleaning up resources now
+service "qnginx001" deleted
+deployment.extensions "qnginx001" deleted
+
+Running minimum kubernetes version check...
+Minimum Kubernetes version supported: 1.11.0
+Client Version: version.Info{Major:"1", Minor:"17", GitVersion:"v1.17.3", GitCommit:"06ad960bfd03b39c8310aaf92d1e7c12ce618213", GitTreeState:"clean", BuildDate:"2020-02-13T18:08:14Z", GoVersion:"go1.13.8", Compiler:"gc", Platform:"darwin/amd64"}
+Server Version: version.Info{Major:"1", Minor:"15", GitVersion:"v1.15.5", GitCommit:"20c265fef0741dd71a66480e35bd69f18351daea", GitTreeState:"clean", BuildDate:"2019-10-15T19:07:57Z", GoVersion:"go1.12.10", Compiler:"gc", Platform:"linux/amd64"}
+  Running Preflight checks ⠧
+--- PASS Required Kubernetes Version
+      --- Good to go.
+--- PASS   cluster-preflight-checks
+PASS
+
+Minimum kubernetes version check completed
+Completed running all preflight checks
+```

mkdocs.yml

@@ -19,5 +19,6 @@ nav:
   - getting_started.md
   - command_reference.md
   - concepts.md
+  - preflight_checks.md
   - air_gap.md
   - Releases ⧉: https://github.com/qlik-oss/sense-installer/releases

pkg/api/apis.go

@@ -46,15 +46,20 @@ func NewQConfigE(qsHome string) (*QliksenseConfig, error) {
 	qc.QliksenseHomePath = qsHome
 	return qc, nil
 }
+func NewQConfigEmpty(qsHome string) *QliksenseConfig {
+	return &QliksenseConfig{
+		QliksenseHomePath: qsHome,
+	}
+}
 
 // GetCR create a QliksenseCR object for a particular context
 // from file ~/.qliksense/contexts/<contx-name>/<contx-name>.yaml
 func (qc *QliksenseConfig) GetCR(contextName string) (*QliksenseCR, error) {
-	crFilePath := qc.getCRFilePath(contextName)
+	crFilePath := qc.GetCRFilePath(contextName)
 	if crFilePath == "" {
 		return nil, errors.New("context name " + contextName + " not found")
 	}
-	return GetCRObject(crFilePath)
+	return qc.GetAndTransformCrObject(crFilePath)
 }
 
 // GetCurrentCR create a QliksenseCR object for current context
@@ -63,14 +68,14 @@ func (qc *QliksenseConfig) GetCurrentCR() (*QliksenseCR, error) {
 }
 
 // SetCrLocation sets the CR location for a context. Helpful during test
-func (qc *QliksenseConfig) SetCrLocation(contextName, filepath string) (*QliksenseConfig, error) {
+func (qc *QliksenseConfig) SetCrLocation(contextName, filePath string) (*QliksenseConfig, error) {
 	tempQc := &QliksenseConfig{}
 	copier.Copy(tempQc, qc)
 	found := false
 	tempQc.Spec.Contexts = []Context{}
 	for _, c := range qc.Spec.Contexts {
 		if c.Name == contextName {
-			c.CrFile = filepath
+			c.CrFile = filePath
 			found = true
 		}
 		tempQc.Spec.Contexts = append(tempQc.Spec.Contexts, []Context{c}...)
@@ -93,6 +98,17 @@ func GetCRObject(crfile string) (*QliksenseCR, error) {
 	return cr, nil
 }
 
+func (qc *QliksenseConfig) GetAndTransformCrObject(crfile string) (*QliksenseCR, error) {
+	cr, err := GetCRObject(crfile)
+	if err != nil {
+		return nil, err
+	}
+	if cr.Spec.ManifestsRoot != "" && !filepath.IsAbs(cr.Spec.ManifestsRoot) {
+		cr.Spec.ManifestsRoot = filepath.Join(qc.QliksenseHomePath, cr.Spec.ManifestsRoot)
+	}
+	return cr, nil
+}
+
 //CreateCRObjectFromString create a QliksenseCR from string content
 func CreateCRObjectFromString(crContent string) (*QliksenseCR, error) {
 	if crContent == "" {
@@ -107,11 +123,11 @@ func CreateCRObjectFromString(crContent string) (*QliksenseCR, error) {
 	return cr, nil
 }
 
-func (qc *QliksenseConfig) getCRFilePath(contextName string) string {
+func (qc *QliksenseConfig) GetCRFilePath(contextName string) string {
 	crFilePath := ""
 	for _, ctx := range qc.Spec.Contexts {
 		if ctx.Name == contextName {
-			crFilePath = ctx.CrFile
+			crFilePath = filepath.Join(qc.QliksenseHomePath, ctx.CrFile)
 			break
 		}
 	}
@@ -144,13 +160,59 @@ func (qc *QliksenseConfig) BuildCurrentManifestsRoot(version string) string {
 }
 
 func (qc *QliksenseConfig) WriteCR(cr *QliksenseCR, contextName string) error {
-	crf := qc.getCRFilePath(contextName)
+	crf := qc.GetCRFilePath(contextName)
 	if crf == "" {
 		return errors.New("context name " + contextName + " not found")
 	}
-	return WriteToFile(cr, crf)
+
+	return qc.TransformAndWriteCr(cr, crf)
 }
 
+//CreateOrWriteCrAndContext create necessary folder structure, update config.yaml and context yaml files
+func (qc *QliksenseConfig) CreateOrWriteCrAndContext(cr *QliksenseCR) error {
+	if qc.QliksenseHomePath == "" {
+		return errors.New("qliksense home is not set")
+	}
+	crf := qc.GetCRFilePath(cr.GetName())
+	if crf == "" {
+		// create direcotry structure for context
+		cDir := filepath.Join(qc.QliksenseHomePath, "contexts", cr.GetName())
+		if err := os.MkdirAll(cDir, os.ModePerm); err != nil {
+			return err
+		}
+		crf = filepath.Join(cDir, cr.GetName()+".yaml")
+		ctx := Context{
+			Name:   cr.GetName(),
+			CrFile: filepath.Join("contexts", cr.GetName(), cr.GetName()+".yaml"),
+		}
+		qc.AddToContexts(ctx)
+
+		if err := WriteToFile(qc, filepath.Join(qc.QliksenseHomePath, "config.yaml")); err != nil {
+			return err
+		}
+	}
+
+	return qc.TransformAndWriteCr(cr, crf)
+}
+
+func (qc *QliksenseConfig) TransformAndWriteCr(cr *QliksenseCR, file string) error {
+	if strings.HasPrefix(cr.Spec.ManifestsRoot, qc.QliksenseHomePath) {
+		cr.Spec.ManifestsRoot = strings.Replace(cr.Spec.ManifestsRoot, qc.QliksenseHomePath+"/", "", 1)
+	}
+	if err := WriteToFile(cr, file); err != nil {
+		return err
+	}
+	if cr.Spec.ManifestsRoot != "" {
+		cr.Spec.ManifestsRoot = filepath.Join(qc.QliksenseHomePath, cr.Spec.ManifestsRoot)
+	}
+	return nil
+}
+func (qc *QliksenseConfig) AddToContexts(ctx Context) error {
+	//TODO: additional duplicate check may be added latter
+	qc.Spec.Contexts = append(qc.Spec.Contexts, ctx)
+
+	return nil
+}
 func (qc *QliksenseConfig) WriteCurrentContextCR(cr *QliksenseCR) error {
 	return qc.WriteCR(cr, qc.Spec.CurrentContext)
 }
@@ -422,12 +484,18 @@ func (qc *QliksenseConfig) CreateContextDirs(contextName string) {
 	os.MkdirAll(contexPath, os.ModePerm)
 }
 
-func (qc *QliksenseConfig) BuildCrFilePath(contextName string) string {
+//BuildCrFileAbsolutePath build absolute path for a cr ie. ~/.qliksense/contexts/qlik-defautl/qlik-default.yaml
+func (qc *QliksenseConfig) BuildCrFileAbsolutePath(contextName string) string {
 	return filepath.Join(qc.QliksenseHomePath, qliksenseContextsDirName, contextName, contextName+".yaml")
 }
 
+//BuildCrFilePath build cr file path i.e. contexts/qlik-default/qlik-default.yaml
+func (qc *QliksenseConfig) BuildCrFilePath(contextName string) string {
+	return filepath.Join(qliksenseContextsDirName, contextName, contextName+".yaml")
+}
+
 //AddToContexts add the context into qc.Spec.Contexts
-func (qc *QliksenseConfig) AddToContexts(crName, crFile string) {
+func (qc *QliksenseConfig) AddToContextsRaw(crName, crFile string) {
 	qc.Spec.Contexts = append(qc.Spec.Contexts, []Context{
 		{CrFile: crFile,
 			Name: crName},

pkg/api/apis_test.go

@@ -74,7 +74,7 @@ func TestGetCR(t *testing.T) {
 	// create CR
 	createCRFile(dir)
 
-	crFile := filepath.Join(dir, "contexts", "contx1", "contx1.yaml")
+	crFile := filepath.Join("contexts", "contx1", "contx1.yaml")
 	qct, e := qc.SetCrLocation("contx1", crFile)
 	if e != nil {
 		t.Fail()
@@ -100,7 +100,7 @@ func TestGetDecryptedCr(t *testing.T) {
 	// create CR
 	createCRFile(dir)
 
-	crFile := filepath.Join(dir, "contexts", "contx1", "contx1.yaml")
+	crFile := filepath.Join("contexts", "contx1", "contx1.yaml")
 	qct, e := qc.SetCrLocation("contx1", crFile)
 	if e != nil {
 		t.Fail()

pkg/api/utils.go

@@ -232,7 +232,6 @@ func UntarGzFile(destination, fileToUntar string) error {
 			fileAtLoc.Chmod(os.ModePerm)
 		}
 	}
-	return nil
 }
 
 func UnZipFile(destination, fileToUnzip string) error {

pkg/preflight/all_checks.go

@@ -0,0 +1,16 @@
+package preflight
+
+import (
+	"fmt"
+)
+
+func (qp *QliksensePreflight) RunAllPreflightChecks() error {
+	//run all preflight checks
+	fmt.Println("Running all preflight checks")
+	fmt.Printf("\nRunning DNS check...\n")
+	qp.CheckDns()
+	fmt.Printf("\nRunning minimum kubernetes version check...\n")
+	qp.CheckK8sVersion()
+	fmt.Println("Completed running all preflight checks")
+	return nil
+}

pkg/preflight/dns_check.go

@@ -0,0 +1,128 @@
+package preflight
+
+import (
+	"bytes"
+	"fmt"
+	"html/template"
+	"io/ioutil"
+	"path/filepath"
+
+	"github.com/qlik-oss/sense-installer/pkg/api"
+)
+
+const dnsCheckYAML = `
+apiVersion: troubleshoot.replicated.com/v1beta1
+kind: Preflight
+metadata:
+  name: cluster-preflight-checks
+  namespace: {{ . }}
+spec:
+  collectors:
+    - run: 
+        collectorName: spin-up-pod
+        args: ["-z", "-v", "-w 1", "qnginx001", "80"]
+        command: ["nc"]
+        image: subfuzion/netcat:latest
+        imagePullPolicy: IfNotPresent
+        name: spin-up-pod-check-dns
+        namespace: {{ . }}
+        timeout: 30s
+
+  analyzers:
+    - textAnalyze:
+        checkName: DNS check
+        collectorName: spin-up-pod-check-dns
+        fileName: spin-up-pod.txt
+        regex: succeeded
+        outcomes:
+          - fail:
+              message: DNS check failed
+          - pass:
+              message: DNS check passed
+`
+
+func (qp *QliksensePreflight) CheckDns() error {
+	// retrieve namespace
+	namespace := api.GetKubectlNamespace()
+
+	api.LogDebugMessage("Namespace: %s\n", namespace)
+
+	tmpl, err := template.New("dnsCheckYAML").Parse(dnsCheckYAML)
+	if err != nil {
+		fmt.Printf("cannot parse template: %v", err)
+		return err
+	}
+	tempYaml, err := ioutil.TempFile("", "")
+	if err != nil {
+		fmt.Printf("cannot create file: %v", err)
+		return err
+	}
+	api.LogDebugMessage("Temp Yaml file: %s\n", tempYaml.Name())
+
+	b := bytes.Buffer{}
+	err = tmpl.Execute(&b, namespace)
+	if err != nil {
+		fmt.Println(err)
+		return err
+	}
+
+	tempYaml.WriteString(b.String())
+
+	// creating Kubectl resources
+	appName := "qnginx001"
+	const PreflightChecksDirName = "preflight_checks"
+
+	fmt.Println("Creating resources to run preflight checks")
+
+	// kubectl create deployment
+	opr := fmt.Sprintf("create deployment %s --image=nginx", appName)
+	err = initiateK8sOps(opr, namespace)
+	if err != nil {
+		fmt.Println(err)
+		return err
+	}
+
+	defer func() {
+		// Deleting deployment..
+		opr = fmt.Sprintf("delete deployment %s", appName)
+		// we want to delete the k8s resource here, we dont care a lot about an error here
+		_ = initiateK8sOps(opr, namespace)
+		api.LogDebugMessage("delete deployment executed")
+	}()
+
+	// create service
+	opr = fmt.Sprintf("create service clusterip %s --tcp=80:80", appName)
+	err = initiateK8sOps(opr, namespace)
+	if err != nil {
+		fmt.Println(err)
+		return err
+	}
+
+	defer func() {
+		// delete service
+		opr = fmt.Sprintf("delete service %s", appName)
+		// we want to delete the k8s resource here, we dont care a lot about an error here
+		_ = initiateK8sOps(opr, namespace)
+		api.LogDebugMessage("delete service executed")
+	}()
+
+	//kubectl -n $namespace wait --for=condition=ready pod -l app=$appName --timeout=120s
+	opr = fmt.Sprintf("wait --for=condition=ready pod -l app=%s --timeout=120s", appName)
+	err = initiateK8sOps(opr, namespace)
+	if err != nil {
+		fmt.Println(err)
+		return err
+	}
+	api.LogDebugMessage("kubectl wait executed")
+
+	// call preflight
+	preflightCommand := filepath.Join(qp.Q.QliksenseHome, PreflightChecksDirName, preflightFileName)
+
+	err = invokePreflight(preflightCommand, tempYaml)
+	if err != nil {
+		fmt.Println(err)
+		return err
+	}
+	fmt.Println("DNS check completed, cleaning up resources now")
+	return nil
+}

pkg/preflight/preflight_utils.go

@@ -1,9 +1,8 @@
-package qliksense
+package preflight
 
 import (
 	"bytes"
 	"fmt"
-	"io/ioutil"
 	"log"
 	"os"
 	"os/exec"
@@ -11,11 +10,15 @@ import (
 	"runtime"
 	"strings"
 
-	"text/template"
+	"github.com/qlik-oss/sense-installer/pkg/qliksense"
 
 	"github.com/qlik-oss/sense-installer/pkg/api"
 )
 
+type QliksensePreflight struct {
+	Q *qliksense.Qliksense
+}
+
 const (
 	// preflight releases have the same version
 	preflightRelease       = "v0.9.26"
@@ -23,45 +26,15 @@ const (
 	preflightMacFile       = "preflight_darwin_amd64.tar.gz"
 	preflightWindowsFile   = "preflight_windows_amd64.zip"
 	PreflightChecksDirName = "preflight_checks"
+	preflightFileName      = "preflight"
 )
 
 var preflightBaseURL = fmt.Sprintf("https://github.com/replicatedhq/troubleshoot/releases/download/%s/", preflightRelease)
 
-const dnsCheckYAML = `
-apiVersion: troubleshoot.replicated.com/v1beta1
-kind: Preflight
-metadata:
-  name: cluster-preflight-checks
-  namespace: {{ . }}
-spec:
-  collectors:
-    - run: 
-        collectorName: spin-up-pod
-        args: ["-z", "-v", "-w 1", "qnginx001", "80"]
-        command: ["nc"]
-        image: subfuzion/netcat:latest
-        imagePullPolicy: IfNotPresent
-        name: spin-up-pod-check-dns
-        namespace: {{ . }}
-        timeout: 30s
-
-  analyzers:
-    - textAnalyze:
-        checkName: DNS check
-        collectorName: spin-up-pod-check-dns
-        fileName: spin-up-pod.txt
-        regex: succeeded
-        outcomes:
-          - fail:
-              message: DNS check failed
-          - pass:
-              message: DNS check passed
-`
-
-func (q *Qliksense) DownloadPreflight() error {
+func (qp *QliksensePreflight) DownloadPreflight() error {
 	const preflightExecutable = "preflight"
 
-	preflightInstallDir := filepath.Join(q.QliksenseHome, PreflightChecksDirName)
+	preflightInstallDir := filepath.Join(qp.Q.QliksenseHome, PreflightChecksDirName)
 	platform := runtime.GOOS
 
 	exists, err := checkInstalled(preflightInstallDir, preflightExecutable)
@@ -72,7 +45,7 @@ func (q *Qliksense) DownloadPreflight() error {
 	}
 	if exists {
 		// preflight exist, no need to download again.
-		api.LogDebugMessage("Preflight already exist, proceeding to perform checks")
+		api.LogDebugMessage("Preflight already exists, proceeding to perform checks")
 		return nil
 	}
 
@@ -160,93 +133,6 @@ func determinePlatformSpecificUrls(platform string) (string, string, error) {
 	return preflightUrl, preflightFile, nil
 }
 
-func (q *Qliksense) CheckDns() error {
-	// retrieve namespace
-	namespace := api.GetKubectlNamespace()
-
-	api.LogDebugMessage("Namespace: %s\n", namespace)
-
-	tmpl, err := template.New("test").Parse(dnsCheckYAML)
-	if err != nil {
-		fmt.Printf("cannot parse template: %v", err)
-		return err
-	}
-	tempYaml, err := ioutil.TempFile("", "")
-	if err != nil {
-		fmt.Printf("cannot create file: %v", err)
-		return err
-	}
-	api.LogDebugMessage("Temp Yaml file: %s\n", tempYaml.Name())
-
-	b := bytes.Buffer{}
-	err = tmpl.Execute(&b, namespace)
-	if err != nil {
-		fmt.Println(err)
-		return err
-	}
-
-	tempYaml.WriteString(b.String())
-
-	// creating Kubectl resources
-	appName := "qnginx001"
-	const PreflightChecksDirName = "preflight_checks"
-	const preflightFileName = "preflight"
-
-	fmt.Println("Creating resources to run preflight checks")
-
-	// kubectl create deployment
-	opr := fmt.Sprintf("create deployment %s --image=nginx", appName)
-	err = initiateK8sOps(opr, namespace)
-	if err != nil {
-		fmt.Println(err)
-		return err
-	}
-
-	defer func() {
-		// Deleting deployment..
-		opr = fmt.Sprintf("delete deployment %s", appName)
-		// we want to delete the k8s resource here, we dont care a lot about an error here
-		_ = initiateK8sOps(opr, namespace)
-		api.LogDebugMessage("delete deployment executed")
-	}()
-
-	// create service
-	opr = fmt.Sprintf("create service clusterip %s --tcp=80:80", appName)
-	err = initiateK8sOps(opr, namespace)
-	if err != nil {
-		fmt.Println(err)
-		return err
-	}
-
-	defer func() {
-		// delete service
-		opr = fmt.Sprintf("delete service %s", appName)
-		// we want to delete the k8s resource here, we dont care a lot about an error here
-		_ = initiateK8sOps(opr, namespace)
-		api.LogDebugMessage("delete service executed")
-	}()
-
-	//kubectl -n $namespace wait --for=condition=ready pod -l app=$appName --timeout=120s
-	opr = fmt.Sprintf("wait --for=condition=ready pod -l app=%s --timeout=120s", appName)
-	err = initiateK8sOps(opr, namespace)
-	if err != nil {
-		fmt.Println(err)
-		return err
-	}
-	api.LogDebugMessage("kubectl wait executed")
-
-	// call preflight
-	preflightCommand := filepath.Join(q.QliksenseHome, PreflightChecksDirName, preflightFileName)
-
-	err = invokePreflight(preflightCommand, tempYaml)
-	if err != nil {
-		fmt.Println(err)
-		return err
-	}
-
-	return nil
-}
-
 func initiateK8sOps(opr, namespace string) error {
 	opr1 := strings.Fields(opr)
 	err := api.KubectlDirectOps(opr1, namespace)
@@ -296,6 +182,6 @@ func invokePreflight(preflightCommand string, yamlFile *os.File) error {
 	//		break
 	//	}
 	//}
-	fmt.Println("Preflight checks completed, cleaning up resources now")
+
 	return nil
 }

pkg/preflight/preflight_utils_test.go

@@ -1,4 +1,4 @@
-package qliksense
+package preflight
 
 import (
 	"fmt"

pkg/preflight/version_check.go

@@ -0,0 +1,84 @@
+package preflight
+
+import (
+	"bytes"
+	"fmt"
+	"io/ioutil"
+	"path/filepath"
+	"text/template"
+
+	"github.com/qlik-oss/sense-installer/pkg/api"
+)
+
+const minK8sVersion = "1.11.0"
+const checkVersionYAML = `
+apiVersion: troubleshoot.replicated.com/v1beta1
+kind: Preflight
+metadata:
+  name: cluster-preflight-checks
+  namespace: {{ .namespace }}
+spec:
+  analyzers:
+    - clusterVersion:
+        outcomes:
+          - fail:
+              when: "< {{ .minK8sVersion }}"
+              message: The application requires at least Kubernetes {{ .minK8sVersion }} or later.
+              uri: https://www.kubernetes.io
+          - pass:
+              when: ">= {{ .minK8sVersion }}"
+              message: Good to go.
+`
+
+func (qp *QliksensePreflight) CheckK8sVersion() error {
+	// retrieve namespace
+	namespace := api.GetKubectlNamespace()
+
+	api.LogDebugMessage("Namespace: %s\n", namespace)
+
+	tmpl, err := template.New("checkVersionYAML").Parse(checkVersionYAML)
+	if err != nil {
+		fmt.Printf("cannot parse template: %v", err)
+		return err
+	}
+	tempYaml, err := ioutil.TempFile("", "")
+	if err != nil {
+		fmt.Printf("cannot create file: %v", err)
+		return err
+	}
+	api.LogDebugMessage("Temp Yaml file: %s\n", tempYaml.Name())
+
+	b := bytes.Buffer{}
+	err = tmpl.Execute(&b, map[string]string{
+		"namespace":     namespace,
+		"minK8sVersion": minK8sVersion,
+	})
+	if err != nil {
+		fmt.Println(err)
+		return err
+	}
+
+	tempYaml.WriteString(b.String())
+	//api.LogDebugMessage("Temp yaml contents: %s", b.String())
+	fmt.Printf("Minimum Kubernetes version supported: %s\n", minK8sVersion)
+
+	// current kubectl version
+	opr := fmt.Sprintf("version")
+	err = initiateK8sOps(opr, namespace)
+	if err != nil {
+		fmt.Println(err)
+		return err
+	}
+
+	// call preflight
+	preflightCommand := filepath.Join(qp.Q.QliksenseHome, PreflightChecksDirName, preflightFileName)
+
+	err = invokePreflight(preflightCommand, tempYaml)
+	if err != nil {
+		fmt.Println(err)
+		return err
+	}
+
+	fmt.Println("Minimum kubernetes version check completed")
+	return nil
+}

pkg/qliksense/context_configs.go

@@ -276,7 +276,7 @@ func (q *Qliksense) SetOtherConfigs(args []string) error {
 // SetContextConfig - set the context for qliksense kubernetes resources to live in
 func (q *Qliksense) SetContextConfig(args []string) error {
 	if len(args) == 1 {
-		err := q.SetUpQliksenseContext(args[0], false)
+		err := q.SetUpQliksenseContext(args[0])
 		if err != nil {
 			return err
 		}
@@ -301,7 +301,7 @@ func (q *Qliksense) ListContextConfigs() error {
 	w.Flush()
 	if len(qliksenseConfig.Spec.Contexts) > 0 {
 		for _, cont := range qliksenseConfig.Spec.Contexts {
-			fmt.Fprintln(w, cont.Name, "\t", cont.CrFile, "\t")
+			fmt.Fprintln(w, cont.Name, "\t", qliksenseConfig.GetCRFilePath(cont.Name), "\t")
 		}
 		w.Flush()
 		fmt.Fprintln(out, "")
@@ -374,11 +374,11 @@ func (q *Qliksense) DeleteContextConfig(args []string) error {
 
 // SetUpQliksenseDefaultContext - to setup dir structure for default qliksense context
 func (q *Qliksense) SetUpQliksenseDefaultContext() error {
-	return q.SetUpQliksenseContext(DefaultQliksenseContext, true)
+	return q.SetUpQliksenseContext(DefaultQliksenseContext)
 }
 
 // SetUpQliksenseContext - to setup qliksense context
-func (q *Qliksense) SetUpQliksenseContext(contextName string, isDefaultContext bool) error {
+func (q *Qliksense) SetUpQliksenseContext(contextName string) error {
 	if contextName == "" {
 		err := fmt.Errorf("Please enter a non-empty context-name")
 		log.Println(err)
@@ -392,83 +392,27 @@ func (q *Qliksense) SetUpQliksenseContext(contextName string, isDefaultContext b
 	}
 
 	qliksenseConfigFile := filepath.Join(q.QliksenseHome, QliksenseConfigFile)
-	var qliksenseConfig api.QliksenseConfig
-	configFileTrack := false
+	qliksenseConfig := api.NewQConfigEmpty(q.QliksenseHome)
 
 	if !api.FileExists(qliksenseConfigFile) {
 		qliksenseConfig.AddBaseQliksenseConfigs(contextName)
 	} else {
-		if err := api.ReadFromFile(&qliksenseConfig, qliksenseConfigFile); err != nil {
-			log.Println(err)
-			return err
-		}
-		if isDefaultContext { // if config file exits but a default context is requested, we want to prevent writing to config file
-			configFileTrack = true
-		}
-	}
-	// creating a file in the name of the context if it does not exist/ opening it to append/modify content if it already exists
-
-	qliksenseContextsDir1 := filepath.Join(q.QliksenseHome, QliksenseContextsDir)
-	if !api.DirExists(qliksenseContextsDir1) {
-		if err := os.Mkdir(qliksenseContextsDir1, os.ModePerm); err != nil {
-			err = fmt.Errorf("Not able to create %s dir: %v", qliksenseContextsDir1, err)
+		if err := api.ReadFromFile(qliksenseConfig, qliksenseConfigFile); err != nil {
 			log.Println(err)
 			return err
 		}
 	}
-	api.LogDebugMessage("%s exists", qliksenseContextsDir1)
 
-	// creating contexts/qlik-default/qlik-default.yaml file
-	qliksenseContextFile := filepath.Join(qliksenseContextsDir1, contextName, contextName+".yaml")
-	//var qliksenseCR api.QliksenseCR
-
-	defaultContextsDir := filepath.Join(qliksenseContextsDir1, contextName)
-	if !api.DirExists(defaultContextsDir) {
-		if err := os.Mkdir(defaultContextsDir, os.ModePerm); err != nil {
-			err = fmt.Errorf("Not able to create %s: %v", defaultContextsDir, err)
-			log.Println(err)
-			return err
-		}
+	if qliksenseConfig.IsContextExist(contextName) {
+		return nil
 	}
-	api.LogDebugMessage("%s exists", defaultContextsDir)
-	if !api.FileExists(qliksenseContextFile) {
-		qliksenseCR := &api.QliksenseCR{}
-		qliksenseCR.AddCommonConfig(contextName)
-		api.WriteToFile(&qliksenseCR, qliksenseContextFile)
-		api.LogDebugMessage("Added Context: %s", contextName)
-	}
-	// else {
-	// 	if err := api.ReadFromFile(&qliksenseCR, qliksenseContextFile); err != nil {
-	// 		log.Println(err)
-	// 		return err
-	// 	}
-	// }
-
-	//api.WriteToFile(&qliksenseCR, qliksenseContextFile)
-	ctxTrack := false
-	if len(qliksenseConfig.Spec.Contexts) > 0 {
-		for _, ctx := range qliksenseConfig.Spec.Contexts {
-			if ctx.Name == contextName {
-				ctx.CrFile = qliksenseContextFile
-				ctxTrack = true
-				break
-			}
-		}
-	}
-	if !ctxTrack {
-		qliksenseConfig.Spec.Contexts = append(qliksenseConfig.Spec.Contexts, api.Context{
-			Name:   contextName,
-			CrFile: qliksenseContextFile,
-		})
-	}
-	qliksenseConfig.Spec.CurrentContext = contextName
-	if !configFileTrack {
-		api.WriteToFile(&qliksenseConfig, qliksenseConfigFile)
+	qliksenseCR := &api.QliksenseCR{}
+	qliksenseCR.AddCommonConfig(contextName)
+	if err := qliksenseConfig.CreateOrWriteCrAndContext(qliksenseCR); err != nil {
+		return err
 	}
 	// set the encrypted default mongo
-	q.SetSecrets([]string{`qliksense.mongoDbUri="mongodb://qlik-default-mongodb:27017/qliksense?ssl=false"`}, false)
-
-	return nil
+	return q.SetSecrets([]string{`qliksense.mongoDbUri="mongodb://qlik-default-mongodb:27017/qliksense?ssl=false"`}, false)
 }
 
 func validateInput(input string) (string, error) {

pkg/qliksense/context_configs_test.go

@@ -165,7 +165,7 @@ metadata:
 spec:
   contexts:
   - name: qlik-default
-    crFile: ./tests/contexts/qlik-default/qlik-default.yaml
+    crFile: contexts/qlik-default/qlik-default.yaml
   currentContext: qlik-default
 `
 	configFile := filepath.Join(testDir, "config.yaml")
@@ -275,7 +275,7 @@ func TestSetUpQliksenseContext(t *testing.T) {
 	for _, tt := range tests {
 		t.Run(tt.name, func(t *testing.T) {
 			q := New(tt.args.qlikSenseHome)
-			if err := q.SetUpQliksenseContext(tt.args.contextName, tt.args.isDefaultContext); (err != nil) != tt.wantErr {
+			if err := q.SetUpQliksenseContext(tt.args.contextName); (err != nil) != tt.wantErr {
 				t.Errorf("SetUpQliksenseContext() error = %v, wantErr %v", err, tt.wantErr)
 			}
 		})
@@ -397,7 +397,7 @@ func TestSetConfigs(t *testing.T) {
 
 func TestSetImageRegistry(t *testing.T) {
 	getQlikSense := func(tmpQlikSenseHome string) (*Qliksense, error) {
-		if err := ioutil.WriteFile(path.Join(tmpQlikSenseHome, "config.yaml"), []byte(fmt.Sprintf(`
+		if err := ioutil.WriteFile(path.Join(tmpQlikSenseHome, "config.yaml"), []byte(`
 apiVersion: config.qlik.com/v1
 kind: QliksenseConfig
 metadata:
@@ -405,9 +405,9 @@ metadata:
 spec:
   contexts:
   - name: qlik-default
-    crFile: %s/contexts/qlik-default/qlik-default.yaml
+    crFile: contexts/qlik-default/qlik-default.yaml
   currentContext: qlik-default
-`, tmpQlikSenseHome)), os.ModePerm); err != nil {
+`), os.ModePerm); err != nil {
 			return nil, err
 		}
 
@@ -799,11 +799,11 @@ metadata:
 spec:
   contexts:
   - name: qlik-default
-    crFile: /root/.qliksense/contexts/qlik-default.yaml
+    crFile: contexts/qlik-default.yaml
   - name: qlik1
-    crFile: /root/.qliksense/contexts/qlik1.yaml
+    crFile: contexts/qlik1.yaml
   - name: qlik2
-    crFile: /root/.qliksense/contexts/qlik2.yaml
+    crFile: contexts/qlik2.yaml
   currentContext: qlik1
 `
 	configFile := filepath.Join(testDir, "config.yaml")

pkg/qliksense/docker_test.go

@@ -171,7 +171,7 @@ func Test_Pull_Push_ImagesForCurrentCR(t *testing.T) {
 }
 
 func setupQlikSenseHome(t *testing.T, tmpQlikSenseHome string, registry *testRegistryV2, clientAuth clientAuthType) error {
-	if err := ioutil.WriteFile(path.Join(tmpQlikSenseHome, "config.yaml"), []byte(fmt.Sprintf(`
+	if err := ioutil.WriteFile(path.Join(tmpQlikSenseHome, "config.yaml"), []byte(`
 apiVersion: config.qlik.com/v1
 kind: QliksenseConfig
 metadata:
@@ -179,9 +179,9 @@ metadata:
 spec:
   contexts:
   - name: qlik-default
-    crFile: %s/contexts/qlik-default/qlik-default.yaml
+    crFile: contexts/qlik-default/qlik-default.yaml
   currentContext: qlik-default
-`, tmpQlikSenseHome)), os.ModePerm); err != nil {
+`), os.ModePerm); err != nil {
 		return err
 	}
 

pkg/qliksense/fetch_test.go

@@ -0,0 +1,35 @@
+package qliksense
+
+import (
+	"io/ioutil"
+	"path/filepath"
+	"testing"
+
+	qapi "github.com/qlik-oss/sense-installer/pkg/api"
+)
+
+func TestFetchAndUpdateCR(t *testing.T) {
+	tempHome, _ := ioutil.TempDir("", "")
+
+	q := &Qliksense{
+		QliksenseHome: tempHome,
+	}
+	q.SetUpQliksenseContext("test1")
+	qConfig := qapi.NewQConfig(tempHome)
+	if err := fetchAndUpdateCR(qConfig, "v0.0.2"); err != nil {
+		t.Log(err)
+		t.FailNow()
+	}
+
+	actualCrFile := filepath.Join(tempHome, "contexts", "test1", "test1.yaml")
+	cr := &qapi.QliksenseCR{}
+	if err := qapi.ReadFromFile(cr, actualCrFile); err != nil {
+		t.Log(err)
+		t.FailNow()
+	}
+
+	if cr.Spec.ManifestsRoot != "contexts/test1/qlik-k8s/v0.0.2" {
+		t.Log("actual path: " + cr.Spec.ManifestsRoot + ", expected path: contexts/test1/qlik-k8s/v0.0.2")
+		t.FailNow()
+	}
+}

pkg/qliksense/load_cr.go

@@ -53,10 +53,11 @@ func (q *Qliksense) loadCrStringIntoFileSystem(crstr string) (string, error) {
 	}
 
 	// write to disk
-	if err = qapi.WriteToFile(cr, qConfig.BuildCrFilePath(cr.GetName())); err != nil {
+
+	if err = qConfig.CreateOrWriteCrAndContext(cr); err != nil {
 		return "", err
 	}
-	qConfig.AddToContexts(cr.GetName(), qConfig.BuildCrFilePath(cr.GetName()))
+	qConfig.AddToContextsRaw(cr.GetName(), qConfig.BuildCrFilePath(cr.GetName()))
 	qConfig.SetCurrentContextName(cr.GetName())
 	qConfig.Write()