Skip to content

Modern Docker Management, Designed for Everyone

fix: tolerate undefined env vars in GitSync compose validation (#2380)

Giulio Savinic8b57e12a36f
diff --git a/backend/internal/services/gitops_sync_service.go b/backend/internal/services/gitops_sync_service.go
index 892036e1f..7a952562c 100644
--- a/backend/internal/services/gitops_sync_service.go
+++ b/backend/internal/services/gitops_sync_service.go
@@ -1394,7 +1394,7 @@ func (s *GitOpsSyncService) validateDirectorySyncStageInternal(ctx context.Conte
}
autoInjectEnv := s.settingsService.GetBoolSetting(ctx, "autoInjectEnv", false)
- project, err := projects.LoadComposeProject(
+ project, err := projects.LoadComposeProjectLenient(
ctx,
filepath.Join(stagePath, composeFileName),
normalizeComposeProjectName(projectName),
diff --git a/backend/pkg/projects/custom_labels.go b/backend/pkg/projects/custom_labels.go
index 5c89c8c32..ec89c5c59 100644
--- a/backend/pkg/projects/custom_labels.go
+++ b/backend/pkg/projects/custom_labels.go
@@ -175,7 +175,7 @@ func loadComposeProjectForMetadataFromFileInternal(ctx context.Context, composeF
opts.SkipValidation = true
opts.SkipConsistencyCheck = true
opts.SkipResolveEnvironment = false
- })
+ }, false)
}
func loadComposeEnvironment(workdir string) map[string]string {
diff --git a/backend/pkg/projects/load.go b/backend/pkg/projects/load.go
index 6aefce73b..6bba2576c 100644
--- a/backend/pkg/projects/load.go
+++ b/backend/pkg/projects/load.go
@@ -10,7 +10,9 @@ import (
"slices"
"strings"
+ interp "github.com/compose-spec/compose-go/v2/interpolation"
"github.com/compose-spec/compose-go/v2/loader"
+ "github.com/compose-spec/compose-go/v2/template"
composetypes "github.com/compose-spec/compose-go/v2/types"
"github.com/docker/compose/v5/pkg/api"
)
@@ -136,7 +138,16 @@ func DetectComposeFile(dir string) (string, error) {
}
func LoadComposeProject(ctx context.Context, composeFile, projectName, projectsDirectory string, autoInjectEnv bool, pathMapper *PathMapper) (*composetypes.Project, error) {
- return loadComposeProjectInternal(ctx, composeFile, projectName, projectsDirectory, autoInjectEnv, pathMapper, nil, nil)
+ return loadComposeProjectInternal(ctx, composeFile, projectName, projectsDirectory, autoInjectEnv, pathMapper, nil, nil, false)
+}
+
+// LoadComposeProjectLenient loads a compose project tolerating undefined variables.
+// Instead of substituting undefined ${VAR} references with an empty string (which
+// produces invalid volume/bind specs like ":/path"), it replaces them with a
+// placeholder value so structural validation can succeed. This is useful during
+// GitSync validation where a .env file may not yet exist.
+func LoadComposeProjectLenient(ctx context.Context, composeFile, projectName, projectsDirectory string, autoInjectEnv bool, pathMapper *PathMapper) (*composetypes.Project, error) {
+ return loadComposeProjectInternal(ctx, composeFile, projectName, projectsDirectory, autoInjectEnv, pathMapper, nil, nil, true)
}
func loadComposeProjectInternal(
@@ -148,6 +159,7 @@ func loadComposeProjectInternal(
pathMapper *PathMapper,
envOverride EnvMap,
configureLoader func(*loader.Options),
+ lenient bool,
) (project *composetypes.Project, err error) {
defer func() {
if recovered := recover(); recovered != nil {
@@ -194,6 +206,24 @@ func loadComposeProjectInternal(
if projectName != "" {
opts.SetProjectName(projectName, true)
}
+ if lenient {
+ if opts.Interpolate == nil {
+ slog.WarnContext(ctx, "compose loader did not initialize Interpolate options; lenient variable substitution will not apply", "compose_file", composeFile)
+ } else {
+ realLookup := opts.Interpolate.LookupValue
+ opts.Interpolate = &interp.Options{
+ Substitute: template.Substitute,
+ TypeCastMapping: opts.Interpolate.TypeCastMapping,
+ LookupValue: func(key string) (string, bool) {
+ if val, ok := realLookup(key); ok {
+ return val, true
+ }
+ slog.DebugContext(ctx, "compose variable undefined during lenient load, using placeholder", "variable", key, "compose_file", composeFile)
+ return "/placeholder-undefined", true
+ },
+ }
+ }
+ }
if configureLoader != nil {
configureLoader(opts)
}
diff --git a/backend/pkg/projects/load_test.go b/backend/pkg/projects/load_test.go
index 1cf09c098..307aefd8d 100644
--- a/backend/pkg/projects/load_test.go
+++ b/backend/pkg/projects/load_test.go
@@ -166,6 +166,28 @@ func TestLoadComposeProjectFromDir_EmptyProjectsDirectoryDoesNotCreateParentGlob
assert.ErrorIs(t, statErr, os.ErrNotExist)
}
+func TestLoadComposeProjectLenient_ToleratesUndefinedVariables(t *testing.T) {
+ t.Parallel()
+
+ // Reproduces the GitSync chicken-and-egg problem: a compose file references
+ // ${CONFIG_FILE} in a bind-mount source, but no .env exists yet. The strict
+ // loader would resolve ${CONFIG_FILE} to "" and produce ":/etc/app/app.conf"
+ // (empty section between colons). The lenient loader must succeed instead.
+ dir := t.TempDir()
+ composePath := filepath.Join(dir, "compose.yaml")
+ require.NoError(t, os.WriteFile(composePath, []byte(`services:
+ app:
+ image: nginx:alpine
+ volumes:
+ - ${CONFIG_FILE}:/etc/app/app.conf
+`), 0o600))
+
+ project, err := LoadComposeProjectLenient(context.Background(), composePath, "demo", dir, false, nil)
+ require.NoError(t, err)
+ require.NotNil(t, project)
+ assert.Len(t, project.Services, 1)
+}
+
func TestLoadComposeProject_UsesProjectLevelComposeLabelsForIncludedServices(t *testing.T) {
t.Parallel()