e2e test to run provider with env variable injection

Signed-off-by: Nicolas De Loof <nicolas.deloof@gmail.com>

Author: ndeloof

Makefile

@@ -74,7 +74,8 @@ install: binary
 	install $(or $(DESTDIR),./bin/build)/docker-compose ~/.docker/cli-plugins/docker-compose
 
 .PHONY: e2e-compose
-e2e-compose: ## Run end to end local tests in plugin mode. Set E2E_TEST=TestName to run a single test
+e2e-compose: example-provider
+    ## Run end to end local tests in plugin mode. Set E2E_TEST=TestName to run a single test
 	go run gotest.tools/gotestsum@latest --format testname --junitfile "/tmp/report/report.xml" -- -v $(TEST_FLAGS) -count=1 ./pkg/e2e
 
 .PHONY: e2e-compose-standalone
@@ -156,3 +157,6 @@ pre-commit: validate check-dependencies lint build test e2e-compose
 help: ## Show help
 	@echo Please specify a build target. The choices are:
 	@grep -E '^[0-9a-zA-Z_-]+:.*?## .*$$' $(MAKEFILE_LIST) | awk 'BEGIN {FS = ":.*?## "}; {printf "\033[36m%-30s\033[0m %s\n", $$1, $$2}'
+
+example-provider:
+	go build -o bin/build/example-provider docs/examples/provider.go

docs/examples/provider.go

@@ -39,20 +39,30 @@ func main() {
 	}
 }
 
+type options struct {
+	db   string
+	size int
+}
+
 func composeCommand() *cobra.Command {
 	c := &cobra.Command{
 		Use:              "compose EVENT",
 		TraverseChildren: true,
 	}
 	c.PersistentFlags().String("project-name", "", "compose project name") // unused
+
+	var options options
+
 	upCmd := &cobra.Command{
-		Use:  "up",
-		Run:  up,
+		Use: "up",
+		Run: func(_ *cobra.Command, args []string) {
+			up(options, args)
+		},
 		Args: cobra.ExactArgs(1),
 	}
-	upCmd.Flags().String("type", "", "Database type (mysql, postgres, etc.)")
+	upCmd.Flags().StringVar(&options.db, "type", "", "Database type (mysql, postgres, etc.)")
 	_ = upCmd.MarkFlagRequired("type")
-	upCmd.Flags().Int("size", 10, "Database size in GB")
+	upCmd.Flags().IntVar(&options.size, "size", 10, "Database size in GB")
 	upCmd.Flags().String("name", "", "Name of the database to be created")
 	_ = upCmd.MarkFlagRequired("name")
 
@@ -71,13 +81,13 @@ func composeCommand() *cobra.Command {
 
 const lineSeparator = "\n"
 
-func up(_ *cobra.Command, args []string) {
+func up(options options, args []string) {
 	servicename := args[0]
 	fmt.Printf(`{ "type": "debug", "message": "Starting %s" }%s`, servicename, lineSeparator)
 
-	for i := 0; i < 100; i += 10 {
+	for i := 0; i < options.size; i++ {
 		time.Sleep(1 * time.Second)
-		fmt.Printf(`{ "type": "info", "message": "Processing ... %d%%" }%s`, i, lineSeparator)
+		fmt.Printf(`{ "type": "info", "message": "Processing ... %d%%" }%s`, i*100/options.size, lineSeparator)
 	}
 	fmt.Printf(`{ "type": "setenv", "message": "URL=https://magic.cloud/%s" }%s`, servicename, lineSeparator)
 }

pkg/e2e/fixtures/interpolation/compose.yaml

@@ -5,5 +5,16 @@ services:
     environment:
       FOO: ${FOO}
       BAR: bar_from_environment
+      BY_PROVIDER_FROM_ENV: ${EXAMPLE_URL}
     env_file:
-     - env_file.env
+     - env_file.env
+    depends_on:
+      - example
+
+  example:
+    provider:
+      type: example-provider
+      options:
+        type: test
+        name: example
+        size: 0

pkg/e2e/fixtures/interpolation/env_file.env

@@ -1,3 +1,4 @@
 ZOT=${FOO:-ZOT}
 QIX=some ${FOO} value
-BAR_FROM_ENV_FILE=${BAR}
+BAR_FROM_ENV_FILE=${BAR}
+BY_PROVIDER_FROM_ENV_FILE: ${EXAMPLE_URL}

pkg/e2e/interpolation_test.go

@@ -18,6 +18,9 @@ package e2e
 
 import (
 	"bufio"
+	"fmt"
+	"os"
+	"path/filepath"
 	"slices"
 	"strings"
 	"testing"
@@ -26,15 +29,21 @@ import (
 )
 
 func Test_interpolation(t *testing.T) {
-	c := NewParallelCLI(t)
+	provider, err := findExecutable("example-provider")
+	assert.NilError(t, err)
+	path := fmt.Sprintf("%s%s%s", os.Getenv("PATH"), string(os.PathListSeparator), filepath.Dir(provider))
+	c := NewParallelCLI(t, WithEnv("PATH="+path))
+
 	const projectName = "interpolation"
 	t.Cleanup(func() {
 		c.cleanupWithDown(t, projectName)
 	})
 
-	res := c.RunDockerComposeCmdNoCheck(t, "-f", "fixtures/interpolation/compose.yaml", "--project-name", projectName, "up")
+	res := c.RunDockerComposeCmd(t, "-f", "fixtures/interpolation/compose.yaml", "--project-name", projectName, "up")
 	var env []string
-	scanner := bufio.NewScanner(strings.NewReader(res.Stdout()))
+	out := res.Combined()
+	fmt.Println(out)
+	scanner := bufio.NewScanner(strings.NewReader(out))
 	for scanner.Scan() {
 		line := scanner.Text()
 		if strings.HasPrefix(line, "test-1  | ") {
@@ -48,4 +57,7 @@ func Test_interpolation(t *testing.T) {
 	assert.Check(t, slices.Contains(env, "QIX=some BAR value"))
 	assert.Check(t, slices.Contains(env, "BAR_FROM_ENV_FILE=bar_from_environment"))
 
+	assert.Check(t, slices.Contains(env, "BY_PROVIDER_FROM_ENV=https://magic.cloud/example"))
+	assert.Check(t, slices.Contains(env, "BY_PROVIDER_FROM_ENV_FILE=https://magic.cloud/example"))
+
 }