feat: allow setting environment variables inside project configuration

FriendsOfShopware · Jan 23, 2024 · 5fa20a5 · 5fa20a5
1 parent dc81eba
commit 5fa20a5
Show file tree

Hide file tree

Showing 4 changed files with 66 additions and 3 deletions.
diff --git a/cmd/project/docker_build.go b/cmd/project/docker_build.go
@@ -3,6 +3,7 @@ package project
 import (
 	"bytes"
 	_ "embed"
+	"fmt"
 	"github.com/FriendsOfShopware/shopware-cli/extension"
 	"github.com/FriendsOfShopware/shopware-cli/logging"
 	"github.com/FriendsOfShopware/shopware-cli/shop"
@@ -48,12 +49,35 @@ var dockerBuildCmd = &cobra.Command{
 			logging.FromContext(cmd.Context()).Infof("No PHP version set, using PHP version %s", phpVersion)
 		}
 
+		buildEnvironments := make([]string, 0)
+		runEnvironments := make([]string, 0)
+
+		for _, value := range shopCfg.Docker.Environment {
+			envLine := fmt.Sprintf("%s=%s", value.Name, value.Value)
+
+			if value.Only == "" {
+				buildEnvironments = append(buildEnvironments, envLine)
+				runEnvironments = append(runEnvironments, envLine)
+			} else if value.Only == "build" {
+				buildEnvironments = append(buildEnvironments, envLine)
+			} else if value.Only == "runtime" {
+				runEnvironments = append(runEnvironments, envLine)
+			}
+		}
+
+		templateVars := map[string]interface{}{
+			"PHP":          shopCfg.Docker.PHP,
+			"ExcludePaths": shopCfg.Docker.ExcludePaths,
+			"BuildEnv":     strings.Join(buildEnvironments, " "),
+			"RunEnv":       strings.Join(runEnvironments, " "),
+		}
+
 		var buf bytes.Buffer
 
 		if err := template.
 			Must(template.New("Dockerfile").
 				Parse(dockerFileTemplate)).
-			Execute(&buf, *shopCfg.Docker); err != nil {
+			Execute(&buf, templateVars); err != nil {
 			return err
 		}
 

diff --git a/cmd/project/templates/Dockerfile.tpl b/cmd/project/templates/Dockerfile.tpl
@@ -30,11 +30,19 @@ FROM shopware-cli as build
 ADD . /src
 WORKDIR /src
 
+{{- if .BuildEnv }}
+ENV {{ .BuildEnv }}
+{{- end }}
+
 RUN --mount=type=secret,id=composer_auth,dst=/src/auth.json \
     --mount=type=cache,target=/root/.composer \
     --mount=type=cache,target=/root/.npm \
     /usr/local/bin/entrypoint.sh shopware-cli project ci /src
 
 FROM base-extended
 
+{{- if .RunEnv }}
+ENV {{ .RunEnv }}
+{{- end }}
+
 COPY --from=build --chown=www-data --link /src /var/www/html
diff --git a/shop/config.go b/shop/config.go
@@ -38,8 +38,15 @@ type ConfigDockerPHP struct {
 }
 
 type ConfigDocker struct {
-	PHP          ConfigDockerPHP `yaml:"php"`
-	ExcludePaths []string        `yaml:"exclude_paths,omitempty"`
+	Environment  []ConfigDockerEnvironmentVariable `yaml:"env,omitempty"`
+	PHP          ConfigDockerPHP                   `yaml:"php"`
+	ExcludePaths []string                          `yaml:"exclude_paths,omitempty"`
+}
+
+type ConfigDockerEnvironmentVariable struct {
+	Name  string `yaml:"name"`
+	Value string `yaml:"value"`
+	Only  string `yaml:"only"`
 }
 
 type ConfigAdminApi struct {

diff --git a/shop/shopware-project-schema.json b/shop/shopware-project-schema.json
@@ -24,6 +24,9 @@
                 },
                 "build": {
                     "$ref": "#/definitions/Build"
+                },
+                "docker": {
+                    "$ref": "#/definitions/Docker"
                 }
             }
         },
@@ -36,6 +39,27 @@
                     "type": "array",
                     "items": {"type": "string"}
                 },
+                "env": {
+                    "type": "array",
+                    "items": {
+                        "type": "object",
+                        "additionalProperties": false,
+                        "required": ["name", "value"],
+                        "properties": {
+                            "name": {
+                                "type": "string"
+                            },
+                            "value": {
+                                "type": "string"
+                            },
+                            "only": {
+                                "type": "string",
+                                "description": "Only set the environment variable for the given stage",
+                                "enum": ["build", "runtime"]
+                            }
+                        }
+                    }
+                },
                 "php": {
                     "type": "object",
                     "additionalProperties": false,