Skip to content

Modern Docker Management, Designed for Everyone

fix: keep the Compose image spelling during updates and self-updates (#4330)

Kyle Mendell9d3e85e84b87
diff --git a/backend/go.mod b/backend/go.mod
index 496b4a52b..ad6419439 100644
--- a/backend/go.mod
+++ b/backend/go.mod
@@ -71,7 +71,7 @@ require (
go.getarcane.app/streams v0.4.5
go.getarcane.app/sys/cgroup v0.2.4
go.getarcane.app/sys/crypto v0.3.0
- go.getarcane.app/updater v0.11.4
+ go.getarcane.app/updater v0.11.5
go.uber.org/fx v1.24.0
go.yaml.in/yaml/v4 v4.0.0-rc.6
golang.org/x/crypto v0.57.0
diff --git a/backend/go.sum b/backend/go.sum
index b6a03c4cc..b68a81113 100644
--- a/backend/go.sum
+++ b/backend/go.sum
@@ -761,8 +761,8 @@ go.getarcane.app/sys/cgroup v0.2.4 h1:8gwVZENjddDZmWU2LxTFEZnxHYC9pY0YZhk8f3Woup
go.getarcane.app/sys/cgroup v0.2.4/go.mod h1:hJyCjpx04VcaaSvkRsMvZl5OLUlAQ60K5gEy1ctuU4U=
go.getarcane.app/sys/crypto v0.3.0 h1:vuPTlS7yIkXsfEfJcQ6jzoWoMEQ97DP/fmCZ3Pom73U=
go.getarcane.app/sys/crypto v0.3.0/go.mod h1:Rxnq1pb5HVSoJ4VKmL6LZGCrztMONaypXKc8Zg0BMhE=
-go.getarcane.app/updater v0.11.4 h1:ek9F2uw6g0SurEK5kOVvO5v72mMJeVmly5xRnJx/JTY=
-go.getarcane.app/updater v0.11.4/go.mod h1:E5yUibklGWuqXeF0ZzS7QWWnRBnPMU48TgXEuWaSbiw=
+go.getarcane.app/updater v0.11.5 h1:1bpQrIzQjvEjE4JzNbzE2r64tNAzLUP+9YohqRtsF4Y=
+go.getarcane.app/updater v0.11.5/go.mod h1:E5yUibklGWuqXeF0ZzS7QWWnRBnPMU48TgXEuWaSbiw=
go.opencensus.io v0.21.0/go.mod h1:mSImk1erAIZhrmZN+AvHh14ztQfjbGwt4TtuofqLduU=
go.opencensus.io v0.22.0/go.mod h1:+kGneAE2xo2IficOXnaByMWTGM9T73dGwxeWcUqIpI8=
go.opencensus.io v0.22.2/go.mod h1:yxeiOL68Rb0Xd1ddK5vPZ/oVn4vY4Ynel7k9FzqtOIw=
diff --git a/backend/internal/container/service.go b/backend/internal/container/service.go
index 99dcac663..b8aaab6db 100644
--- a/backend/internal/container/service.go
+++ b/backend/internal/container/service.go
@@ -590,7 +590,7 @@ func (
// Distinguish "not found" (safe to fall back to standalone) from real DB
// errors (should surface so a transient failure doesn't silently recreate
// the container from stale cached config).
- if strings.Contains(err.Error(), "not found") {
+ if errors.Is(err, common.ErrNotFound) {
slog.WarnContext(
ctx, "RedeployContainer: compose project not registered, falling back to standalone redeploy",
"containerId", containerID,
diff --git a/backend/internal/project/children/update/service.go b/backend/internal/project/children/update/service.go
index 7ba432cfa..2634e1871 100644
--- a/backend/internal/project/children/update/service.go
+++ b/backend/internal/project/children/update/service.go
@@ -434,7 +434,7 @@ func PrepareProjectServiceImages(source []byte, effective *types.Project, change
if !strings.Contains(imageNode.Value, "$") && refs.NormalizeImageUpdateRef(imageNode.Value) != expected && refs.NormalizeImageUpdateRef(imageNode.Value) != target {
return nil, nil, fmt.Errorf("service %s source image changed since Compose was loaded", name)
}
- edit, err := composeImageSourceEdit(source, imageNode, change.TargetRef)
+ edit, err := composeImageSourceEdit(source, imageNode, refs.PreserveConfiguredRef(service.Image, change.TargetRef))
if err != nil {
return nil, nil, fmt.Errorf("service %s: %w", name, err)
}
diff --git a/backend/internal/project/service.go b/backend/internal/project/service.go
index f9c8107bc..7d8ebe66e 100644
--- a/backend/internal/project/service.go
+++ b/backend/internal/project/service.go
@@ -473,7 +473,25 @@ func (s *ProjectService) GetProjectByComposeName(ctx context.Context, name strin
return cachedProject, nil
}
- return nil, fmt.Errorf("project not found: %s", name)
+ return nil, common.Classify(common.ErrNotFound, fmt.Errorf("project not found: %s", name))
+}
+
+// ComposeServiceImage returns the effective image of serviceName in the
+// Arcane project deployed as composeName.
+func (s *ProjectService) ComposeServiceImage(ctx context.Context, composeName, serviceName string) (projectID, imageRef string, err error) {
+ proj, err := s.GetProjectByComposeName(ctx, composeName)
+ if err != nil {
+ return "", "", err
+ }
+ effective, _, err := s.loadComposeProjectForProject(ctx, proj, nil, serviceName)
+ if err != nil {
+ return "", "", fmt.Errorf("load project %s: %w", proj.Name, err)
+ }
+ service, ok := effective.Services[serviceName]
+ if !ok {
+ return "", "", fmt.Errorf("service %s is not active in project %s", serviceName, proj.Name)
+ }
+ return proj.ID, service.Image, nil
}
// EnsureProjectPathUnderRoot validates that the project's path is a safe subdirectory of the configured projects root.
@@ -971,16 +989,10 @@ func (s *ProjectService) UpdateProjectServices(ctx context.Context, projectID st
if changesErr != nil {
return changesErr
}
- // ImageChanges already rejects GitOps-managed projects; tag edits need the full project.
if len(changes) > 0 {
- full, _, fullErr := s.loadComposeProjectForProject(ctx, proj, nil)
- if fullErr != nil {
- return fmt.Errorf("load project for tag update: %w", fullErr)
- }
- if _, applyErr := s.updates.ApplyImageChanges(ctx, proj.Path, full, changes); applyErr != nil {
- return applyErr
+ if _, saveErr := s.SaveProjectServiceImages(ctx, projectID, changes); saveErr != nil {
+ return saveErr
}
- s.invalidateProjectCaches(projectID)
}
}
previousStatus := proj.Status
@@ -3172,28 +3184,39 @@ func (s *ProjectService) applyProjectRename(ctx context.Context, proj *Project,
// UpdateProjectServiceImages persists selected service image tags before recreating them.
func (s *ProjectService) UpdateProjectServiceImages(ctx context.Context, projectID string, changes map[string]updatertypes.ServiceImageChange, user usertypes.Actor) error {
+ services, err := s.SaveProjectServiceImages(ctx, projectID, changes)
+ if err != nil {
+ return err
+ }
+ // Keep the desired source on deployment failure: Compose may have partially
+ // recreated services, and the pending update must remain retryable.
+ return s.UpdateProjectServices(ctx, projectID, services, user, false)
+}
+
+// SaveProjectServiceImages persists selected service image tags without
+// deploying them and returns the changed services.
+func (s *ProjectService) SaveProjectServiceImages(ctx context.Context, projectID string, changes map[string]updatertypes.ServiceImageChange) ([]string, error) {
if len(changes) == 0 {
- return errors.New("service image changes are required")
+ return nil, errors.New("service image changes are required")
}
proj, err := s.getMutableProject(ctx, projectID)
if err != nil {
- return err
+ return nil, err
}
if gitOpsSyncID(proj) != "" {
- return errors.New("tag updates cannot edit a GitOps-managed project; update image tags in the source repository")
+ return nil, errors.New("tag updates cannot edit a GitOps-managed project; update image tags in the source repository")
}
- effective, _, err := s.loadComposeProjectForProject(ctx, proj, nil)
+ // Selecting the changed services keeps profile-gated ones active.
+ effective, _, err := s.loadComposeProjectForProject(ctx, proj, nil, slices.Collect(maps.Keys(changes))...)
if err != nil {
- return fmt.Errorf("load project for tag update: %w", err)
+ return nil, fmt.Errorf("load project for tag update: %w", err)
}
services, err := s.updates.ApplyImageChanges(ctx, proj.Path, effective, changes)
if err != nil {
- return err
+ return nil, err
}
s.invalidateProjectCaches(projectID)
- // Keep the desired source on deployment failure: Compose may have partially
- // recreated services, and the pending update must remain retryable.
- return s.UpdateProjectServices(ctx, projectID, services, user, false)
+ return services, nil
}
func (s *ProjectService) GetProjectWorkspace(ctx context.Context, projectID string) (*workspacetypes.Workspace, error) {
diff --git a/backend/internal/project/service_test.go b/backend/internal/project/service_test.go
index 3048985ab..de8a7feb9 100644
--- a/backend/internal/project/service_test.go
+++ b/backend/internal/project/service_test.go
@@ -7053,12 +7053,14 @@ func TestPrepareProjectServiceImages(t *testing.T) {
"\ufeff# operator configuration\r\n\r\nservices:\r\n web:\r\n image: \"app:${VERSION}\" # keep this comment\r\n " +
" environment:\r\n VERSION: ${VERSION}\r\n\r\n worker:\r\n image: 'app:1.2.0' \r\n tagged:\r\n " +
"image: !!str app:1.2.0\r\n escaped:\r\n image: \"app\\u003a1.2.0\"\r\n untouched:\r\n image: app:1.2.0 " +
- "# stays\r\n\r\r plain:\r\n image: app:1.2.0",
+ "# stays\r\n\r\r plain:\r\n image: app:1.2.0\r\n qualified:\r\n image: docker.io/library/app:1.2.0\r\n " +
+ "omitted:\r\n image: registry.example.com:5000/team/app",
)
expected := "\ufeff# operator configuration\r\n\r\nservices:\r\n web:\r\n image: \"app:1.3.0\" # keep this comment\r\n " +
- "environment:\r\n VERSION: ${VERSION}\r\n\r\n worker:\r\n image: 'docker.io/library/app:1.3.0' \r\n " +
+ "environment:\r\n VERSION: ${VERSION}\r\n\r\n worker:\r\n image: 'app:1.3.0' \r\n " +
"tagged:\r\n image: !!str app:1.3.0\r\n escaped:\r\n image: \"app:1.3.0\"\r\n untouched:\r\n image: " +
- "app:1.2.0 # stays\r\n\r\r plain:\r\n image: app:1.3.0"
+ "app:1.2.0 # stays\r\n\r\r plain:\r\n image: app:1.3.0\r\n qualified:\r\n image: docker.io/library/app:1.3.0\r\n " +
+ "omitted:\r\n image: registry.example.com:5000/team/app:1.3.0"
effective := &types.Project{
Services: types.Services{
"web": {
@@ -7079,17 +7081,25 @@ func TestPrepareProjectServiceImages(t *testing.T) {
"plain": {
Image: "app:1.2.0",
},
+ "qualified": {
+ Image: "docker.io/library/app:1.2.0",
+ },
+ "omitted": {
+ Image: "registry.example.com:5000/team/app",
+ },
},
}
updated, names, err := update.PrepareProjectServiceImages(source, effective, map[string]updatertypes.ServiceImageChange{
- "web": {ExpectedRef: "docker.io/library/app:1.2.0", TargetRef: "app:1.3.0"},
- "worker": {ExpectedRef: "app:1.2.0", TargetRef: "docker.io/library/app:1.3.0"},
- "tagged": {ExpectedRef: "app:1.2.0", TargetRef: "app:1.3.0"},
- "escaped": {ExpectedRef: "app:1.2.0", TargetRef: "app:1.3.0"},
- "plain": {ExpectedRef: "app:1.2.0", TargetRef: "app:1.3.0"},
+ "web": {ExpectedRef: "docker.io/library/app:1.2.0", TargetRef: "app:1.3.0"},
+ "worker": {ExpectedRef: "app:1.2.0", TargetRef: "docker.io/library/app:1.3.0"},
+ "tagged": {ExpectedRef: "app:1.2.0", TargetRef: "app:1.3.0"},
+ "escaped": {ExpectedRef: "app:1.2.0", TargetRef: "app:1.3.0"},
+ "plain": {ExpectedRef: "app:1.2.0", TargetRef: "app:1.3.0"},
+ "qualified": {ExpectedRef: "app:1.2.0", TargetRef: "app:1.3.0"},
+ "omitted": {ExpectedRef: "registry.example.com:5000/team/app", TargetRef: "registry.example.com:5000/team/app:1.3.0"},
})
require.NoError(t, err)
- require.Equal(t, []string{"escaped", "plain", "tagged", "web", "worker"}, names)
+ require.Equal(t, []string{"escaped", "omitted", "plain", "qualified", "tagged", "web", "worker"}, names)
require.Equal(t, expected, string(updated))
require.Equal(t, "app:1.2.0", effective.Services["web"].Image)
}
@@ -7495,11 +7505,11 @@ func TestProjectServiceManualUpdateDiscoversTags(t *testing.T) {
strategy string
omitLabels bool
}{
- {name: "new tag", tags: []string{"1.2.0", "1.3.0", "2.0.0"}, wantRef: "docker.io/library/app:1.3.0", wantChanged: true, wantCalls: 1},
+ {name: "new tag", tags: []string{"1.2.0", "1.3.0", "2.0.0"}, wantRef: "app:1.3.0", wantChanged: true, wantCalls: 1},
{name: "same tag digest fallback", tags: []string{"1.2.0", "2.0.0"}, wantRef: "app:1.2.0", wantCalls: 1},
{name: "planned dependency does not discover tags", tags: []string{"1.2.0", "1.3.0"}, wantRef: "app:1.2.0", skipDiscovery: true},
{name: "unlabeled digest default", tags: []string{"1.2.0", "1.3.0", "2.0.0"}, wantRef: "app:1.2.0", omitLabels: true},
- {name: "explicit automatic tag", tags: []string{"1.2.0", "1.3.0", "2.0.0"}, wantRef: "docker.io/library/app:1.3.0", wantChanged: true, wantCalls: 1, strategy: "auto"},
+ {name: "explicit automatic tag", tags: []string{"1.2.0", "1.3.0", "2.0.0"}, wantRef: "app:1.3.0", wantChanged: true, wantCalls: 1, strategy: "auto"},
{name: "explicit digest optout", tags: []string{"1.2.0", "1.3.0"}, wantRef: "app:1.2.0", strategy: "digest"},
} {
t.Run(tt.name, func(t *testing.T) {
diff --git a/backend/internal/system/children/upgrade/service.go b/backend/internal/system/children/upgrade/service.go
index 93c3ea68b..b7f455536 100644
--- a/backend/internal/system/children/upgrade/service.go
+++ b/backend/internal/system/children/upgrade/service.go
@@ -31,6 +31,8 @@ import (
"go.getarcane.app/sys/cgroup"
"go.getarcane.app/updater"
"go.getarcane.app/updater/labels"
+ "go.getarcane.app/updater/refs"
+ updatertypes "go.getarcane.app/updater/types"
"golang.org/x/mod/semver"
"github.com/getarcaneapp/arcane/backend/v2/internal/common"
@@ -38,6 +40,7 @@ import (
dockerInternal "github.com/getarcaneapp/arcane/backend/v2/internal/docker"
"github.com/getarcaneapp/arcane/backend/v2/internal/environment"
"github.com/getarcaneapp/arcane/backend/v2/internal/event"
+ "github.com/getarcaneapp/arcane/backend/v2/internal/project"
"github.com/getarcaneapp/arcane/backend/v2/internal/settings"
"github.com/getarcaneapp/arcane/backend/v2/internal/version"
"github.com/getarcaneapp/arcane/backend/v2/pkg/libarcane"
@@ -57,6 +60,7 @@ type Service struct {
versionService *version.VersionService
eventService *event.EventService
settingsService *settings.SettingsService
+ projectService *project.ProjectService
// resolveRuntimeOptions determines how the upgrader container reaches the Docker daemon.
resolveRuntimeOptions func(
ctx context.Context,
@@ -74,6 +78,7 @@ func NewService(
versionService *version.VersionService,
eventService *event.EventService,
settingsService *settings.SettingsService,
+ projectService *project.ProjectService,
resolveRuntimeOptions func(
ctx context.Context,
dockerHost string,
@@ -89,6 +94,7 @@ func NewService(
versionService: versionService,
eventService: eventService,
settingsService: settingsService,
+ projectService: projectService,
resolveRuntimeOptions: resolveRuntimeOptions,
}
}
@@ -166,6 +172,8 @@ type preparedUpgradeInternal struct {
// is the immutable reference actually pulled (the same unless frozen).
targetImage string
pullImage string
+ // saveCompose persists a tag change in the container's Compose project.
+ saveCompose func(context.Context)
}
// prepareUpgradeInternal takes the upgrading guard, released by runPreparedUpgradeInternal (or here on error).
@@ -205,6 +213,10 @@ func (s *Service) prepareUpgradeInternal(ctx context.Context, user usertypes.Act
if err != nil {
return nil, err
}
+ targetImage, saveCompose, err := s.configuredTargetImageInternal(ctx, currentContainer, targetImage)
+ if err != nil {
+ return nil, err
+ }
pullImage := cmp.Or(strings.TrimSpace(target.PullImageRef), targetImage)
// Log upgrade event
@@ -226,6 +238,7 @@ func (s *Service) prepareUpgradeInternal(ctx context.Context, user usertypes.Act
binaryPath: binaryPath,
targetImage: targetImage,
pullImage: pullImage,
+ saveCompose: saveCompose,
}, nil
}
@@ -269,6 +282,9 @@ func (s *Service) runPreparedUpgradeInternal(ctx context.Context, prepared *prep
slog.WarnContext(ctx, "Failed to close upgrader image pull reader", "error", closeErr)
}
slog.InfoContext(ctx, "Upgrader image pulled successfully", "image", upgraderImage)
+ if prepared.saveCompose != nil {
+ prepared.saveCompose(ctx)
+ }
// Try to get the /app/data mount from current container so upgrade logs persist.
appDataMount := docker.MountForDestination(prepared.current.Mounts, libarcane.UpgradeLogDirectory, libarcane.UpgradeLogDirectory)
@@ -391,6 +407,43 @@ func daemonHasSELinuxEnabledInternal(ctx context.Context, dockerClient *client.C
return slices.Contains(infoResult.Info.SecurityOptions, "name=selinux")
}
+// configuredTargetImageInternal spells targetImage like the container's Compose
+// service, or like its runtime image when Arcane does not manage that project.
+// A tag change also returns the Compose edit to save before the upgrader starts;
+// sources Arcane cannot edit keep upgrading without it, as they did before.
+func (s *Service) configuredTargetImageInternal(ctx context.Context, current container.InspectResponse, targetImage string) (string, func(context.Context), error) {
+ // Digest targets cannot be written as Compose tags.
+ if refs.NormalizeImageUpdateRef(targetImage) == "" || current.Config == nil {
+ return targetImage, nil, nil
+ }
+ runtimeRef := current.Config.Image
+ projectName, serviceName := docker.ComposeProjectLabel(current.Config.Labels), docker.ComposeServiceLabel(current.Config.Labels)
+ if projectName == "" || serviceName == "" {
+ return refs.PreserveConfiguredRef(runtimeRef, targetImage), nil, nil
+ }
+ projectID, composeRef, err := s.projectService.ComposeServiceImage(ctx, projectName, serviceName)
+ if errors.Is(err, common.ErrNotFound) {
+ return refs.PreserveConfiguredRef(runtimeRef, targetImage), nil, nil
+ }
+ if err != nil {
+ return "", nil, fmt.Errorf("resolve Compose service %s/%s: %w", projectName, serviceName, err)
+ }
+ selected := refs.PreserveConfiguredRef(composeRef, targetImage)
+ normalizedCompose := refs.NormalizeImageUpdateRef(composeRef)
+ if normalizedCompose == refs.NormalizeImageUpdateRef(targetImage) {
+ return selected, nil, nil
+ }
+ if normalizedCompose != refs.NormalizeImageUpdateRef(runtimeRef) {
+ return "", nil, fmt.Errorf("compose service %s/%s image %s does not match running image %s", projectName, serviceName, composeRef, runtimeRef)
+ }
+ changes := map[string]updatertypes.ServiceImageChange{serviceName: {ExpectedRef: runtimeRef, TargetRef: selected}}
+ return selected, func(ctx context.Context) {
+ if _, saveErr := s.projectService.SaveProjectServiceImages(ctx, projectID, changes); saveErr != nil {
+ slog.WarnContext(ctx, "Compose image not updated for self-upgrade; update it manually", "project", projectName, "service", serviceName, "image", selected, "error", saveErr)
+ }
+ }, nil
+}
+
// resolveUpgradeTargetImageInternal picks the image the upgrade should move to.
// Explicit targets from the updater engine are authoritative. A blank target
// (manual trigger, update-all) resolves against the version check so a
diff --git a/backend/internal/system/children/upgrade/service_test.go b/backend/internal/system/children/upgrade/service_test.go
index 0294f0dbd..b131734ff 100644
--- a/backend/internal/system/children/upgrade/service_test.go
+++ b/backend/internal/system/children/upgrade/service_test.go
@@ -4,24 +4,30 @@ import (
"context"
"errors"
"fmt"
+ "os"
+ "path/filepath"
+ "strings"
"testing"
"time"
versiontypes "github.com/getarcaneapp/arcane/types/v2/version"
"github.com/libtnb/sqlite"
+ "github.com/moby/moby/api/types/container"
"github.com/stretchr/testify/require"
"gorm.io/gorm"
"github.com/getarcaneapp/arcane/backend/v2/internal/common"
"github.com/getarcaneapp/arcane/backend/v2/internal/database"
"github.com/getarcaneapp/arcane/backend/v2/internal/event"
+ "github.com/getarcaneapp/arcane/backend/v2/internal/project"
+ "github.com/getarcaneapp/arcane/backend/v2/internal/settings"
"github.com/getarcaneapp/arcane/backend/v2/internal/version"
"github.com/getarcaneapp/arcane/backend/v2/pkg/remenv"
)
// TestService_UpgradeFlag tests the upgrading flag behavior
func TestService_UpgradeFlag(t *testing.T) {
- s := NewService(nil, nil, nil, nil, nil, nil)
+ s := NewService(nil, nil, nil, nil, nil, nil, nil)
// Initially should be false
require.False(t, s.upgrading.Load())
@@ -37,7 +43,7 @@ func TestService_UpgradeFlag(t *testing.T) {
// TestService_Initialization tests proper initialization
func TestService_Initialization(t *testing.T) {
- s := NewService(nil, nil, nil, nil, nil, nil)
+ s := NewService(nil, nil, nil, nil, nil, nil, nil)
require.NotNil(t, s)
require.False(t, s.upgrading.Load())
@@ -61,7 +67,7 @@ func TestService_ErrorVariables(t *testing.T) {
// TestService_UpgradingFlag_ConcurrentAccess tests upgrading flag
func TestService_UpgradingFlag_ConcurrentAccess(t *testing.T) {
- s := NewService(nil, nil, nil, nil, nil, nil)
+ s := NewService(nil, nil, nil, nil, nil, nil, nil)
// Test initial state
require.False(t, s.upgrading.Load(), "upgrading flag should start as false")
@@ -77,7 +83,7 @@ func TestService_UpgradingFlag_ConcurrentAccess(t *testing.T) {
// TestService_CompareAndSwap tests atomic CompareAndSwap operation
func TestService_CompareAndSwap(t *testing.T) {
- s := NewService(nil, nil, nil, nil, nil, nil)
+ s := NewService(nil, nil, nil, nil, nil, nil, nil)
// Test successful CompareAndSwap from false to true
swapped := s.upgrading.CompareAndSwap(false, true)
@@ -98,7 +104,7 @@ func TestService_CompareAndSwap(t *testing.T) {
// TestService_Services tests that services are stored correctly
func TestService_Services(t *testing.T) {
// Create upgrade service with nil services (valid for testing initialization)
- s := NewService(nil, nil, nil, nil, nil, nil)
+ s := NewService(nil, nil, nil, nil, nil, nil, nil)
// Verify service is created and initialized properly
require.NotNil(t, s)
@@ -107,7 +113,7 @@ func TestService_Services(t *testing.T) {
// TestService_ConcurrentUpgradeAttempts tests that concurrent upgrade attempts are prevented
func TestService_ConcurrentUpgradeAttempts(t *testing.T) {
- s := NewService(nil, nil, nil, nil, nil, nil)
+ s := NewService(nil, nil, nil, nil, nil, nil, nil)
// Simulate first upgrade starting
success := s.upgrading.CompareAndSwap(false, true)
@@ -138,7 +144,7 @@ func TestService_UpgradeInProgressError(t *testing.T) {
// TestService_AtomicOperations tests atomic.Bool operations
func TestService_AtomicOperations(t *testing.T) {
- s := NewService(nil, nil, nil, nil, nil, nil)
+ s := NewService(nil, nil, nil, nil, nil, nil, nil)
// Test Load
require.False(t, s.upgrading.Load())
@@ -262,6 +268,98 @@ func TestResolveSelfUpgradeTargetImageInternal(t *testing.T) {
require.Equal(t, tt.want, got)
})
}
+
+ // Both the updater engine and the manual upgrade respell the resolved
+ // target from the container's Compose service before the upgrader starts.
+ composeTests := []struct {
+ name, runtime, target, want, wantCompose, wantErr string
+ files map[string]string
+ }{
+ {
+ name: "unmanaged Compose keeps the runtime spelling", runtime: "getarcaneapp/manager:next",
+ target: "docker.io/getarcaneapp/manager:next", want: "getarcaneapp/manager:next",
+ },
+ {
+ name: "Compose spelling repairs a qualified runtime image", runtime: "docker.io/getarcaneapp/manager:next",
+ target: "docker.io/getarcaneapp/manager:next", want: "getarcaneapp/manager:next",
+ files: map[string]string{
+ "compose.yaml": "services:\n server:\n image: example/old:1\n",
+ "compose.override.yaml": "services:\n server:\n image: getarcaneapp/manager:${TAG}\n",
+ ".env": "TAG=next\n",
+ },
+ wantCompose: "services:\n server:\n image: example/old:1\n",
+ },
+ {
+ name: "release tag change saves Compose", runtime: "getarcaneapp/manager:v1.0.0",
+ target: "getarcaneapp/manager:v1.1.0", want: "getarcaneapp/manager:v1.1.0",
+ files: map[string]string{"compose.yaml": "services:\n server:\n image: getarcaneapp/manager:v1.0.0\n profiles: [admin]\n"},
+ wantCompose: "services:\n server:\n image: getarcaneapp/manager:v1.1.0\n profiles: [admin]\n",
+ },
+ {
+ name: "override source keeps upgrading without an edit", runtime: "getarcaneapp/manager:v1.0.0",
+ target: "docker.io/getarcaneapp/manager:v1.1.0", want: "getarcaneapp/manager:v1.1.0",
+ files: map[string]string{
+ "compose.yaml": "services:\n server:\n image: example/old:1\n",
+ "compose.override.yaml": "services:\n server:\n image: getarcaneapp/manager:v1.0.0\n",
+ },
+ wantCompose: "services:\n server:\n image: example/old:1\n",
+ },
+ {
+ name: "conflicting Compose source fails", runtime: "getarcaneapp/manager:v1.0.0",
+ target: "docker.io/getarcaneapp/manager:v1.1.0",
+ files: map[string]string{"compose.yaml": "services:\n server:\n image: getarcaneapp/manager:v1.2.0\n"},
+ wantCompose: "services:\n server:\n image: getarcaneapp/manager:v1.2.0\n", wantErr: "does not match running image",
+ },
+ {
+ name: "digest target is left alone", runtime: "getarcaneapp/manager@sha256:" + strings.Repeat("a", 64),
+ target: "getarcaneapp/manager@sha256:" + strings.Repeat("b", 64), want: "getarcaneapp/manager@sha256:" + strings.Repeat("b", 64),
+ files: map[string]string{"compose.yaml": "services:\n server:\n image: getarcaneapp/manager@sha256:" + strings.Repeat("a", 64) + "\n"},
+ },
+ }
+ for _, tt := range composeTests {
+ t.Run(tt.name, func(t *testing.T) {
+ gormDB, err := gorm.Open(sqlite.Open("file:"+t.Name()+"?mode=memory&cache=shared"), &gorm.Config{})
+ require.NoError(t, err)
+ db := &database.DB{DB: gormDB}
+ require.NoError(t, db.AutoMigrate(&project.Project{}, &settings.SettingVariable{}))
+ directory := t.TempDir()
+ t.Setenv("PROJECTS_DIRECTORY", directory)
+ settingsSvc, err := settings.NewSettingsService(t.Context(), db)
+ require.NoError(t, err)
+ t.Cleanup(func() { require.NoError(t, settingsSvc.Stop(context.WithoutCancel(t.Context()))) })
+ require.NoError(t, settingsSvc.SetStringSetting(t.Context(), "projectsDirectory", directory))
+ projectPath := filepath.Join(directory, "arcane")
+ if len(tt.files) > 0 {
+ require.NoError(t, os.MkdirAll(projectPath, 0o755))
+ for name, content := range tt.files {
+ require.NoError(t, os.WriteFile(filepath.Join(projectPath, name), []byte(content), 0o600))
+ }
+ require.NoError(t, db.Create(&project.Project{ID: "project-arcane", Name: "arcane", Path: projectPath}).Error)
+ }
+ svc := NewService(db, nil, nil, nil, nil, project.NewProjectService(db, settingsSvc, nil, nil, nil, nil, nil, nil, nil, nil, nil), nil)
+ current := container.InspectResponse{Config: &container.Config{
+ Image: tt.runtime,
+ Labels: map[string]string{"com.docker.compose.project": "arcane", "com.docker.compose.service": "server"},
+ }}
+
+ got, saveCompose, err := svc.configuredTargetImageInternal(t.Context(), current, tt.target)
+ if tt.wantErr != "" {
+ require.ErrorContains(t, err, tt.wantErr)
+ require.Nil(t, saveCompose)
+ } else {
+ require.NoError(t, err)
+ require.Equal(t, tt.want, got)
+ }
+ if saveCompose != nil {
+ saveCompose(t.Context())
+ }
+ if tt.wantCompose != "" {
+ content, readErr := os.ReadFile(filepath.Join(projectPath, "compose.yaml"))
+ require.NoError(t, readErr)
+ require.Equal(t, tt.wantCompose, string(content))
+ }
+ })
+ }
}
func TestUpdateAllResolveResumeAction(t *testing.T) {
@@ -392,7 +490,7 @@ func TestUpdateAllFailedJobMarksUpdatingResultsFailed(t *testing.T) {
db := &database.DB{DB: gormDB}
require.NoError(t, db.AutoMigrate(&EnvironmentUpdateJob{}, &event.Event{}))
- svc := NewService(db, nil, nil, event.NewEventService(db, nil, nil), nil, nil)
+ svc := NewService(db, nil, nil, event.NewEventService(db, nil, nil), nil, nil, nil)
job := &EnvironmentUpdateJob{
Status: EnvironmentUpdateJobStatusRunning,
UserID: "user-1",
@@ -441,7 +539,7 @@ func TestUpdateAllFinalizesUpToDateManagerWithoutRestart(t *testing.T) {
db := &database.DB{DB: gormDB}
require.NoError(t, db.AutoMigrate(&EnvironmentUpdateJob{}, &event.Event{}))
- svc := NewService(db, nil, nil, event.NewEventService(db, nil, nil), nil, nil)
+ svc := NewService(db, nil, nil, event.NewEventService(db, nil, nil), nil, nil, nil)
job := &EnvironmentUpdateJob{
Status: EnvironmentUpdateJobStatusPendingRestart,
UserID: "user-1",
@@ -487,7 +585,7 @@ func TestUpdateAllStageChangesPersist(t *testing.T) {
db := &database.DB{DB: gormDB}
require.NoError(t, db.AutoMigrate(&EnvironmentUpdateJob{}))
- svc := NewService(db, nil, nil, nil, nil, nil)
+ svc := NewService(db, nil, nil, nil, nil, nil, nil)
job := &EnvironmentUpdateJob{
Status: EnvironmentUpdateJobStatusRunning,
Results: EnvironmentUpdateResults{
@@ -589,7 +687,7 @@ func TestResumeUpdateAllFinalizesManagerWithoutRerunningAgents(t *testing.T) {
// The reported version differs from ManagerVersionAtStart, so the manager upgrade
// is judged successful.
versionSvc := version.NewVersionService(nil, true, "v9.9.9-new", "", nil, nil, nil, nil)
- svc := NewService(db, nil, versionSvc, event.NewEventService(db, nil, nil), nil, nil)
+ svc := NewService(db, nil, versionSvc, event.NewEventService(db, nil, nil), nil, nil, nil)
job := &EnvironmentUpdateJob{
Status: EnvironmentUpdateJobStatusPendingRestart,
diff --git a/backend/internal/system/service.go b/backend/internal/system/service.go
index a08619102..66ca6fca3 100644
--- a/backend/internal/system/service.go
+++ b/backend/internal/system/service.go
@@ -40,6 +40,7 @@ import (
"github.com/getarcaneapp/arcane/backend/v2/internal/event"
"github.com/getarcaneapp/arcane/backend/v2/internal/imageupdate"
"github.com/getarcaneapp/arcane/backend/v2/internal/network"
+ "github.com/getarcaneapp/arcane/backend/v2/internal/project"
"github.com/getarcaneapp/arcane/backend/v2/internal/s3"
"github.com/getarcaneapp/arcane/backend/v2/internal/settings"
systembackup "github.com/getarcaneapp/arcane/backend/v2/internal/system/children/backup"
@@ -80,6 +81,7 @@ func NewSystemService(
activityService *activity.ActivityService,
versionService *version.VersionService,
eventService *event.EventService,
+ projectService *project.ProjectService,
backupEngine *backup.Engine,
s3Destinations *s3.S3DestinationService,
recoveryKeys *backup.RecoveryKeyStore,
@@ -100,7 +102,7 @@ func NewSystemService(
WithTTL(dockerHostMemoryCacheTTL).
Build(),
prune: prune.NewService(location, dockerService.GetClient, activityService, imageUpdateService, volumeService, networkService),
- upgrade: upgrade.NewService(db, dockerService, versionService, eventService, settingsService, resolveUpgraderRuntimeOptionsInternal),
+ upgrade: upgrade.NewService(db, dockerService, versionService, eventService, settingsService, projectService, resolveUpgraderRuntimeOptionsInternal),
}
var sqlDB func() (*sql.DB, error)
if db != nil {
diff --git a/go.work.sum b/go.work.sum
index c41bb2401..675019256 100644
--- a/go.work.sum
+++ b/go.work.sum
@@ -2846,8 +2846,8 @@ go.getarcane.app/updater v0.8.0 h1:8R79Pxj9jiH9NBRwvGJAeiG1DFcdwATKM8MN/V6Sz2Q=
go.getarcane.app/updater v0.8.0/go.mod h1:Hci6Hziz1tublccxm48pKvhxmmg0n3GC6tPMu4bYl3c=
go.getarcane.app/updater v0.9.1 h1:kQsBIKRAEsCv1xgt7BMClStuNDj8JB2TrjY4djhgTa4=
go.getarcane.app/updater v0.9.1/go.mod h1:rMRAzw2KX5S8Ptjs4HAoN7inIHqxdSFsCHcrQWWK+vw=
-go.getarcane.app/updater v0.11.4 h1:ek9F2uw6g0SurEK5kOVvO5v72mMJeVmly5xRnJx/JTY=
-go.getarcane.app/updater v0.11.4/go.mod h1:E5yUibklGWuqXeF0ZzS7QWWnRBnPMU48TgXEuWaSbiw=
+go.getarcane.app/updater v0.11.5 h1:1bpQrIzQjvEjE4JzNbzE2r64tNAzLUP+9YohqRtsF4Y=
+go.getarcane.app/updater v0.11.5/go.mod h1:E5yUibklGWuqXeF0ZzS7QWWnRBnPMU48TgXEuWaSbiw=
go.lsp.dev/jsonrpc2 v0.10.0 h1:Pr/YcXJoEOTMc/b6OTmcR1DPJ3mSWl/SWiU1Cct6VmI=
go.lsp.dev/jsonrpc2 v0.10.0/go.mod h1:fmEzIdXPi/rf6d4uFcayi8HpFP1nBF99ERP1htC72Ac=
go.lsp.dev/pkg v0.0.0-20210717090340-384b27a52fb2 h1:hCzQgh6UcwbKgNSRurYWSqh8MufqRRPODRBblutn4TE=