Merge branch 'master' of https://github.com/loft-sh/devspace

Author: FabianKramm

.vscode/launch.json

@@ -1,6 +1,16 @@
 {
   "version": "0.2.0",
   "configurations": [
+    {
+      "name": "Launch e2e tests",
+      "type": "go",
+      "request": "launch",
+      "mode": "test",
+      "program": "${workspaceRoot}/e2e/e2e_suite_test.go",
+      "args": [
+        "-ginkgo.v"
+      ]
+    },
     {
       "name": "nodejs > devspace up",
       "type": "go",

CONTRIBUTING.md

@@ -19,12 +19,12 @@ This project is mainly written in Golang. To contribute code,
 4. Clone the project: `git clone https://github.com/[YOUR_USERNAME]/devspace && cd devspace`
 5. Run `go clean -modcache`
 6. Run `go mod vendor` to install the dependencies
-7. Make changes to the code (add new dependencies to the Gopkg.toml)
-8. Build the project, e.g. via `go build -o devspace.exe`
-9. Make changes
-10. Run tests: `go test ./...`
+7. Build the project, e.g. via `go build -o devspace.exe`
+8. Make changes
+9.  Run unit tests: `./hack/coverage.bash`
+10. Run E2E tests: `cd e2e/ && go test -v -ginkgo.v`
 11. Format your code: `go fmt ./...`
-12. Commit changes
+12. Commit changes *([Please refer the commit message conventions](https://www.conventionalcommits.org/en/v1.0.0/))*
 13. Push commits
 14. Open pull request
 

cmd/init.go

@@ -1,6 +1,7 @@
 package cmd
 
 import (
+	"bytes"
 	"fmt"
 	"io/ioutil"
 	"net/http"
@@ -10,7 +11,9 @@ import (
 	"strconv"
 	"strings"
 
-	"github.com/loft-sh/devspace/pkg/devspace/imageselector"
+	"github.com/loft-sh/devspace/cmd/flags"
+	"github.com/vmware-labs/yaml-jsonpath/pkg/yamlpath"
+	yaml "gopkg.in/yaml.v3"
 
 	"github.com/loft-sh/devspace/pkg/devspace/compose"
 	"github.com/loft-sh/devspace/pkg/devspace/hook"
@@ -205,14 +208,10 @@ func (cmd *InitCmd) Run(f factory.Factory) error {
 			}
 
 			if selectedDeploymentOption == HelmChartOption {
-				imageQuestion = "What is the main container image of this project which is deployed by this Helm chart? (e.g. ecr.io/project/image)"
+				imageQuestion = "Which image do you want to develop with DevSpace?"
 				err = configureManager.AddHelmDeployment(deploymentName)
 			} else if selectedDeploymentOption == ManifestsOption || selectedDeploymentOption == KustomizeOption {
-				if selectedDeploymentOption == ManifestsOption {
-					imageQuestion = "What is the main container image of this project which is deployed by these manifests? (e.g. ecr.io/project/image)"
-				} else {
-					imageQuestion = "What is the main container image of this project which is deployed by this Kustomization? (e.g. ecr.io/project/image)"
-				}
+				imageQuestion = "Which image do you want to develop with DevSpace?"
 				err = configureManager.AddKubectlDeployment(deploymentName, selectedDeploymentOption == KustomizeOption)
 			}
 
@@ -238,13 +237,24 @@ func (cmd *InitCmd) Run(f factory.Factory) error {
 		for {
 			image := ""
 			if imageQuestion != "" {
+				manifests, err := cmd.render(f, config)
+				if err != nil {
+					return errors.Wrap(err, "error rendering deployment")
+				}
+
+				images, err := parseImages(manifests)
+				if err != nil {
+					return errors.Wrap(err, "error parsing images")
+				}
+
+				if len(images) == 0 {
+					return fmt.Errorf("no images found for the selected deployments")
+				}
+
 				image, err = cmd.log.Question(&survey.QuestionOptions{
-					Question:          imageQuestion,
-					ValidationMessage: "Please enter a valid container image from a Kubernetes pod (e.g. myregistry.tld/project/image)",
-					ValidationFunc: func(name string) error {
-						_, _, err := imageselector.GetStrippedDockerImageName(strings.ToLower(name))
-						return err
-					},
+					Question:     imageQuestion,
+					DefaultValue: images[0],
+					Options:      images,
 				})
 				if err != nil {
 					return err
@@ -727,3 +737,57 @@ func (cmd *InitCmd) addProfileConfig(config *latest.Config, imageName string) er
 	}
 	return nil
 }
+
+func (cmd *InitCmd) render(f factory.Factory, config *latest.Config) (string, error) {
+	// Save temporary file to render it
+	renderPath := loader.ConfigPath("render.yaml")
+	configLoader := loader.NewConfigLoader(renderPath)
+
+	err := configLoader.Save(config)
+	defer os.Remove(renderPath)
+	if err != nil {
+		return "", err
+	}
+
+	// Use the render command to render it.
+	writer := &bytes.Buffer{}
+	renderCmd := &RenderCmd{
+		GlobalFlags: &flags.GlobalFlags{
+			Silent:     true,
+			ConfigPath: renderPath,
+		},
+		SkipPush:  true,
+		SkipBuild: true,
+		Writer:    writer,
+	}
+	err = renderCmd.Run(f)
+	if err != nil {
+		return "", err
+	}
+
+	return writer.String(), nil
+}
+
+func parseImages(manifests string) ([]string, error) {
+	images := []string{}
+
+	var doc yaml.Node
+	dec := yaml.NewDecoder(bytes.NewReader([]byte(manifests)))
+	for dec.Decode(&doc) == nil {
+		path, err := yamlpath.NewPath("..image")
+		if err != nil {
+			return nil, err
+		}
+
+		matches, err := path.Find(&doc)
+		if err != nil {
+			return nil, err
+		}
+
+		for _, match := range matches {
+			images = append(images, match.Value)
+		}
+	}
+
+	return images, nil
+}

cmd/init_test.go

@@ -1,5 +1,12 @@
 package cmd
 
+import (
+	"testing"
+
+	"gotest.tools/assert"
+	"gotest.tools/assert/cmp"
+)
+
 /*import (
 	"io/ioutil"
 	"os"
@@ -303,3 +310,114 @@ func testInit(t *testing.T, testCase initTestCase) {
 	})
 	assert.NilError(t, err, "Error cleaning up in testCase %s", testCase.name)
 }*/
+
+type parseImagesTestCase struct {
+	name      string
+	manifests string
+	expected  []string
+}
+
+func TestParseImages(t *testing.T) {
+	testCases := []parseImagesTestCase{
+		{
+			name: `Single`,
+			manifests: `
+apiVersion: apps/v1
+kind: Deployment
+metadata:
+  name: "new"
+  labels:
+    "app.kubernetes.io/name": "devspace-app"
+    "app.kubernetes.io/component": "test"
+    "app.kubernetes.io/managed-by": "Helm"
+spec:
+  replicas: 1
+  strategy:
+    type: Recreate
+  selector:
+    matchLabels:
+      "app.kubernetes.io/name": "devspace-app"
+      "app.kubernetes.io/component": "test"
+      "app.kubernetes.io/managed-by": "Helm"
+  template:
+    metadata:
+      labels:
+        "app.kubernetes.io/name": "devspace-app"
+        "app.kubernetes.io/component": "test"
+        "app.kubernetes.io/managed-by": "Helm"
+    spec:
+      containers:
+        - image: "username/app"
+          name: "container-0"
+`,
+			expected: []string{
+				"username/app",
+			},
+		},
+		{
+			name: `Multiple`,
+			manifests: `
+---
+# Source: my-app/templates/service.yaml
+apiVersion: v1
+kind: Service
+metadata:
+  name: php
+  labels:
+    release: "test-helm"
+spec:
+  ports:
+  - port: 80
+    protocol: TCP
+  selector:
+    release: "test-helm"
+---
+# Source: my-app/templates/deployment.yaml
+apiVersion: apps/v1
+kind: Deployment
+metadata:
+  name: test-helm
+  labels:
+    release: "test-helm"
+spec:
+  replicas: 1
+  selector:
+    matchLabels:
+      release: "test-helm"
+  template:
+    metadata:
+      annotations:
+        revision: "1"
+      labels:
+        release: "test-helm"
+    spec:
+      containers:
+      - name: default
+        image: "php"
+`,
+			expected: []string{
+				"php",
+			},
+		},
+	}
+
+	for _, testCase := range testCases {
+		manifests := testCase.manifests
+
+		actual, err := parseImages(manifests)
+		assert.NilError(
+			t,
+			err,
+			"Unexpected error in test case %s",
+			testCase.name,
+		)
+
+		expected := testCase.expected
+		assert.Assert(
+			t,
+			cmp.DeepEqual(expected, actual),
+			"Unexpected values in test case %s",
+			testCase.name,
+		)
+	}
+}

docs/pages/configuration/deployments/basics.mdx

@@ -107,8 +107,8 @@ deployments:
 </TabItem>
 </Tabs>
 
-:::info Sequential Deployment
-Unlike images which are build in parallel, deployments will be deployed sequentially following the order in which they are specified in the `devspace.yaml`.
+:::info Sequential and Concurrent Deployment
+Unlike images, which are built in parallel by default, deployments will be deployed sequentially following the order in which they are specified in the `devspace.yaml`. If a deployment has `concurrent: true` set, then it will run before any sequential deployments and in parallel with other deployments that also have concurrency enabled.
 :::
 
 ## Run Deployments
@@ -123,8 +123,11 @@ The following flags are available for all commands that trigger the deployment p
 
 
 ## Deployment Process
-DevSpace loads the `deployments` configuration from `devspace.yaml` and builds one deployment after another in the order that they are specified in the `deployments` array. Additionally, DevSpace also deploys related projects speficied in `dependencies`.
+DevSpace loads the `deployments` configuration from `devspace.yaml` and by default deploys each deployment sequentially in the order that they are specified in the `deployments` array. Alternatively, some or all deployments can be configured to deploy in parallel by setting `concurrent: true`. Deployments with concurrency enabled will deploy before sequential deployments. Additionally, DevSpace also deploys related projects specified in `dependencies`.
 
+:::warning Helm hooks and concurrency
+When using concurrency for Helm deployments that have Helm hooks, be cautious if those hooks depend on resources created by other deployments. You may want such a deployments to be run sequentially after concurrent deployments are completed. Otherwise, appropriate retry logic will be necessary for the affected Helm hook in order to avoid deployment failure.
+:::
 
 ### 1. Deploy Dependencies
 

docs/pages/fragments/config-deployments.mdx

@@ -3,6 +3,7 @@ deployments:                        # struct[] | Array of deployments
 - name: my-deployment               # string   | Name of the deployment
   namespace: ""                     # string   | Namespace to deploy to (Default: "" = namespace of the active namespace/Space)
   disabled: false                   # bool     | If true, the deployment will not be deployed, purged or rendered
+  concurrent: false                 # bool     | Deploy concurrently with other deployments that also have concurrency enabled (Default: false)
   helm: ...                         # struct   | Use Helm as deployment tool and set options for Helm
   kubectl: ...                      # struct   | Use "kubectl apply" as deployment tool and set options for kubectl
 ```

docs/versioned_docs/version-5.18/configuration/development/auto-reloading.mdx

@@ -35,7 +35,7 @@ dev:
     - custom-manifests
 ```
 
-Take a look at the [redeploy-instead-of-hot-reload exmaple](https://github.com/loft-sh/devspace/tree/master/examples/redeploy-instead-of-hot-reload) to see how to disable hot reloading at all and enable redeployment on every file change instead.
+Take a look at the [redeploy-instead-of-hot-reload example](https://github.com/loft-sh/devspace/tree/master/examples/redeploy-instead-of-hot-reload) to see how to disable hot reloading at all and enable redeployment on every file change instead.
 
 
 ## Configuration

e2e/framework/util.go

@@ -91,7 +91,7 @@ func CleanupTempDir(initialDir, tempDir string) {
 }
 
 func CopyToTempDir(relativePath string) (string, error) {
-	dir, err := ioutil.TempDir("", "")
+	dir, err := ioutil.TempDir("", "temp-*")
 	if err != nil {
 		return "", err
 	}