Tag built images with the commit's short hash (closes #239)
Builds are tagged upaas-<app>:<short hash>, git's own short form of the commit checked out, instead of the deployment number. A redeploy of a commit gives the tag to the new image. The cleanup after a deploy now also finds the app's untagged images among those its deployments recorded, and removes them by ID once the app neither runs them nor would roll back to them. It keeps every image any app uses, since apps that build the same commit can share one. The clone reads the commits from git's output after removing Docker's log headers, which had hidden the COMMIT: line; commit_sha is now saved on update so manual deploys keep the commit they recorded. Model: opus-5-5
This commit is contained in:
@@ -735,44 +735,103 @@ func (svc *Service) recordDeployedImage(
|
||||
return nil
|
||||
}
|
||||
|
||||
// removeUnusedImages removes the app's tags (upaas-<app>:<deployment>, set by
|
||||
// buildImage) except those of the image the running container uses and the
|
||||
// one Rollback would start. Docker deletes an image only once no other tag,
|
||||
// such as another app's, and no container still uses it.
|
||||
// removeUnusedImages removes the app's images except those an app's running
|
||||
// container uses or its Rollback would start. Docker deletes a tagged image
|
||||
// only once no other tag, such as another app's, and no container still
|
||||
// uses it.
|
||||
func (svc *Service) removeUnusedImages(
|
||||
ctx context.Context,
|
||||
app *models.App,
|
||||
deployment *models.Deployment,
|
||||
) {
|
||||
tags, err := svc.docker.ListImageTags(ctx, "upaas-"+app.Name)
|
||||
images, err := svc.findAppImages(ctx, app)
|
||||
if err != nil {
|
||||
svc.log.Error("failed to list app images", "error", err, "app", app.Name)
|
||||
|
||||
return
|
||||
}
|
||||
|
||||
for _, tag := range slices.Sorted(maps.Keys(tags)) {
|
||||
imageID := tags[tag].String()
|
||||
if imageID == app.ImageID.String || imageID == app.PreviousImageID.String {
|
||||
keep, err := svc.imagesToKeep(ctx)
|
||||
if err != nil {
|
||||
svc.log.Error("failed to list the images apps use", "error", err, "app", app.Name)
|
||||
|
||||
return
|
||||
}
|
||||
|
||||
for _, name := range slices.Sorted(maps.Keys(images)) {
|
||||
if keep[images[name].String()] {
|
||||
continue
|
||||
}
|
||||
|
||||
removeErr := svc.docker.RemoveImageTag(ctx, tag)
|
||||
removeErr := svc.docker.RemoveImageTag(ctx, name)
|
||||
if removeErr != nil {
|
||||
svc.log.Error("failed to remove old image",
|
||||
"error", removeErr, "app", app.Name, "tag", tag)
|
||||
"error", removeErr, "app", app.Name, "image", name)
|
||||
_ = deployment.AppendLog(
|
||||
ctx,
|
||||
"WARNING: failed to remove old image "+tag+": "+removeErr.Error(),
|
||||
"WARNING: failed to remove old image "+name+": "+removeErr.Error(),
|
||||
)
|
||||
|
||||
continue
|
||||
}
|
||||
|
||||
_ = deployment.AppendLog(ctx, "Removed old image: "+tag)
|
||||
_ = deployment.AppendLog(ctx, "Removed old image: "+name)
|
||||
}
|
||||
}
|
||||
|
||||
// findAppImages returns the app's images, each under the name it is removed
|
||||
// by: its tag, upaas-<app>:<short hash> as set by buildImage, or its ID if
|
||||
// it has none. A redeploy of a commit gives the commit's tag to the new
|
||||
// image, so the old one is found among the images the app's deployments
|
||||
// recorded.
|
||||
func (svc *Service) findAppImages(
|
||||
ctx context.Context,
|
||||
app *models.App,
|
||||
) (map[string]docker.ImageID, error) {
|
||||
images, err := svc.docker.ListImageTags(ctx, "upaas-"+app.Name)
|
||||
if err != nil {
|
||||
return nil, fmt.Errorf("failed to list image tags: %w", err)
|
||||
}
|
||||
|
||||
untagged, err := svc.docker.ListUntaggedImages(ctx)
|
||||
if err != nil {
|
||||
return nil, fmt.Errorf("failed to list untagged images: %w", err)
|
||||
}
|
||||
|
||||
recorded, err := models.FindDeploymentImageIDs(ctx, svc.db, app.ID)
|
||||
if err != nil {
|
||||
return nil, fmt.Errorf("failed to find deployment images: %w", err)
|
||||
}
|
||||
|
||||
for _, imageID := range untagged {
|
||||
if slices.Contains(recorded, imageID.String()) {
|
||||
images[imageID.String()] = imageID
|
||||
}
|
||||
}
|
||||
|
||||
return images, nil
|
||||
}
|
||||
|
||||
// imagesToKeep returns the IDs of the image each app's running container
|
||||
// uses and the one its Rollback would start. It covers every app because
|
||||
// apps that build the same commit can share an image, and a redeploy can
|
||||
// take the tag that kept the image for one of them.
|
||||
func (svc *Service) imagesToKeep(ctx context.Context) (map[string]bool, error) {
|
||||
apps, err := models.AllApps(ctx, svc.db)
|
||||
if err != nil {
|
||||
return nil, fmt.Errorf("failed to list apps: %w", err)
|
||||
}
|
||||
|
||||
keep := make(map[string]bool)
|
||||
|
||||
for _, app := range apps {
|
||||
keep[app.ImageID.String] = true
|
||||
keep[app.PreviousImageID.String] = true
|
||||
}
|
||||
|
||||
return keep, nil
|
||||
}
|
||||
|
||||
// cleanupCancelledDeploy removes orphan resources left by a cancelled deployment.
|
||||
func (svc *Service) cleanupCancelledDeploy(
|
||||
ctx context.Context,
|
||||
@@ -912,14 +971,14 @@ func (svc *Service) buildImage(
|
||||
app *models.App,
|
||||
deployment *models.Deployment,
|
||||
) (docker.ImageID, error) {
|
||||
workDir, cleanup, err := svc.cloneRepository(ctx, app, deployment)
|
||||
workDir, shortSHA, cleanup, err := svc.cloneRepository(ctx, app, deployment)
|
||||
if err != nil {
|
||||
return "", err
|
||||
}
|
||||
|
||||
defer cleanup()
|
||||
|
||||
imageTag := fmt.Sprintf("upaas-%s:%d", app.Name, deployment.ID)
|
||||
imageTag := "upaas-" + app.Name + ":" + shortSHA
|
||||
|
||||
// Create log writer that flushes build output to deployment logs every second
|
||||
logWriter := newDeploymentLogWriter(ctx, deployment)
|
||||
@@ -954,11 +1013,14 @@ func (svc *Service) buildImage(
|
||||
return imageID, nil
|
||||
}
|
||||
|
||||
// cloneRepository clones the app's repository for a build. It returns the
|
||||
// directory of the clone, git's short form of the commit checked out, and a
|
||||
// function that removes the clone.
|
||||
func (svc *Service) cloneRepository(
|
||||
ctx context.Context,
|
||||
app *models.App,
|
||||
deployment *models.Deployment,
|
||||
) (string, func(), error) {
|
||||
) (string, string, func(), error) {
|
||||
// Use a subdirectory of DataDir for builds since it's mounted from the host
|
||||
// and accessible to Docker for bind mounts (unlike /tmp inside the container).
|
||||
// Structure: builds/<appname>/<deployment-id>-<random>/
|
||||
@@ -975,7 +1037,7 @@ func (svc *Service) cloneRepository(
|
||||
fmt.Errorf("failed to create builds dir: %w", err),
|
||||
)
|
||||
|
||||
return "", nil, fmt.Errorf("failed to create builds dir: %w", err)
|
||||
return "", "", nil, fmt.Errorf("failed to create builds dir: %w", err)
|
||||
}
|
||||
|
||||
buildDir, err := os.MkdirTemp(appBuildsDir, fmt.Sprintf("%d-*", deployment.ID))
|
||||
@@ -987,7 +1049,7 @@ func (svc *Service) cloneRepository(
|
||||
fmt.Errorf("failed to create temp dir: %w", err),
|
||||
)
|
||||
|
||||
return "", nil, fmt.Errorf("failed to create temp dir: %w", err)
|
||||
return "", "", nil, fmt.Errorf("failed to create temp dir: %w", err)
|
||||
}
|
||||
|
||||
cleanup := func() { _ = os.RemoveAll(buildDir) }
|
||||
@@ -1023,7 +1085,7 @@ func (svc *Service) cloneRepository(
|
||||
fmt.Errorf("failed to clone repo: %w", cloneErr),
|
||||
)
|
||||
|
||||
return "", nil, fmt.Errorf("failed to clone repo: %w", cloneErr)
|
||||
return "", "", nil, fmt.Errorf("failed to clone repo: %w", cloneErr)
|
||||
}
|
||||
|
||||
svc.processCloneResult(ctx, app, deployment, cloneResult, commitSHA)
|
||||
@@ -1031,7 +1093,7 @@ func (svc *Service) cloneRepository(
|
||||
// Return the 'work' subdirectory where the repo was cloned
|
||||
workDir := filepath.Join(buildDir, "work")
|
||||
|
||||
return workDir, cleanup, nil
|
||||
return workDir, cloneResult.ShortSHA, cleanup, nil
|
||||
}
|
||||
|
||||
// processCloneResult handles the result of a git clone operation.
|
||||
|
||||
@@ -34,6 +34,8 @@ func TestBuildImageLogsBuildErrorBeforeDeployError(t *testing.T) {
|
||||
switch {
|
||||
case strings.HasSuffix(r.URL.Path, "/containers/create"):
|
||||
_, _ = w.Write([]byte(`{"Id":"gitcontainer"}`))
|
||||
case strings.HasSuffix(r.URL.Path, "/logs"):
|
||||
writeCloneOutput(w, "abc1234")
|
||||
case strings.HasSuffix(r.URL.Path, "/version"):
|
||||
_, _ = w.Write([]byte(`{"Version":"27.3.1","ApiVersion":"1.47"}`))
|
||||
case strings.HasSuffix(r.URL.Path, "/build"):
|
||||
@@ -77,7 +79,7 @@ func TestBuildImageLogsBuildErrorBeforeDeployError(t *testing.T) {
|
||||
|
||||
// The service has no notify service: the app has no ntfy topic and no
|
||||
// Slack webhook, so the build failure notification sends nothing.
|
||||
svc := deploy.NewTestServiceWithConfig(log, cfg, dockerClient)
|
||||
svc := deploy.NewTestServiceWithConfig(log, cfg, db, dockerClient)
|
||||
|
||||
_, err = svc.BuildImage(ctx, app, deployment)
|
||||
require.EqualError(t, err, "failed to build image: exit code: 1")
|
||||
|
||||
@@ -20,7 +20,7 @@ func TestCleanupCancelledDeploy_RemovesBuildDir(t *testing.T) {
|
||||
tmpDir := t.TempDir()
|
||||
cfg := &config.Config{DataDir: tmpDir}
|
||||
|
||||
svc := deploy.NewTestServiceWithConfig(slog.Default(), cfg, nil)
|
||||
svc := deploy.NewTestServiceWithConfig(slog.Default(), cfg, nil, nil)
|
||||
|
||||
// Create a fake build directory matching the deployment pattern
|
||||
appName := "test-app"
|
||||
@@ -59,7 +59,7 @@ func TestCleanupCancelledDeploy_NoBuildDir(t *testing.T) {
|
||||
tmpDir := t.TempDir()
|
||||
cfg := &config.Config{DataDir: tmpDir}
|
||||
|
||||
svc := deploy.NewTestServiceWithConfig(slog.Default(), cfg, nil)
|
||||
svc := deploy.NewTestServiceWithConfig(slog.Default(), cfg, nil, nil)
|
||||
|
||||
// Should not panic when build dir doesn't exist
|
||||
svc.CleanupCancelledDeploy(context.Background(), "nonexistent-app", 1, "")
|
||||
|
||||
@@ -3,14 +3,21 @@ package deploy_test
|
||||
import (
|
||||
"context"
|
||||
"database/sql"
|
||||
"encoding/json"
|
||||
"fmt"
|
||||
"io"
|
||||
"log/slog"
|
||||
"maps"
|
||||
"net/http"
|
||||
"net/http/httptest"
|
||||
"os"
|
||||
"slices"
|
||||
"strings"
|
||||
"sync"
|
||||
"testing"
|
||||
|
||||
"github.com/docker/docker/api/types/image"
|
||||
"github.com/docker/docker/pkg/stdcopy"
|
||||
"github.com/stretchr/testify/assert"
|
||||
"github.com/stretchr/testify/require"
|
||||
"go.uber.org/fx/fxtest"
|
||||
@@ -23,45 +30,133 @@ import (
|
||||
"sneak.berlin/go/upaas/internal/service/deploy"
|
||||
)
|
||||
|
||||
// TestRecordDeployedImageRemovesOldImages runs the step after a deploy
|
||||
// against a fake Docker API. Image one is also tagged for another app,
|
||||
// image two was the previous image, three the current one, four is new.
|
||||
func TestRecordDeployedImageRemovesOldImages(t *testing.T) {
|
||||
t.Parallel()
|
||||
// fakeImageAPI is a fake Docker API that keeps images and their tags as
|
||||
// Docker does: a build gives its tag to the image it builds, and removing
|
||||
// an image's last tag, or an untagged image by its ID, deletes the image.
|
||||
// It also answers the steps of a git clone that reports shortSHA.
|
||||
type fakeImageAPI struct {
|
||||
mu sync.Mutex
|
||||
images map[string][]string // image ID -> tags
|
||||
shortSHA string // the commit's short hash the clone reports
|
||||
nextID string // ID of the image the next build creates
|
||||
removed []string // each tag or ID removed
|
||||
forced bool // whether a removal was forced
|
||||
}
|
||||
|
||||
var (
|
||||
mu sync.Mutex
|
||||
removed []string
|
||||
forced bool
|
||||
)
|
||||
func (api *fakeImageAPI) ServeHTTP(w http.ResponseWriter, r *http.Request) {
|
||||
api.mu.Lock()
|
||||
defer api.mu.Unlock()
|
||||
|
||||
srv := httptest.NewServer(http.HandlerFunc(
|
||||
func(w http.ResponseWriter, r *http.Request) {
|
||||
w.Header().Set("Content-Type", "application/json")
|
||||
w.Header().Set("Content-Type", "application/json")
|
||||
|
||||
switch {
|
||||
case r.Method == http.MethodDelete:
|
||||
_, name, _ := strings.Cut(r.URL.Path, "/images/")
|
||||
_, name, isImage := strings.Cut(r.URL.Path, "/images/")
|
||||
|
||||
mu.Lock()
|
||||
switch {
|
||||
case strings.HasSuffix(r.URL.Path, "/images/json"):
|
||||
dangling := strings.Contains(r.URL.Query().Get("filters"), "dangling")
|
||||
api.listImages(w, dangling)
|
||||
case isImage && r.Method == http.MethodDelete:
|
||||
api.forced = api.forced || r.URL.Query().Get("force") != ""
|
||||
api.removeImage(w, name)
|
||||
case isImage && strings.HasSuffix(name, "/json"):
|
||||
api.inspectImage(w, strings.TrimSuffix(name, "/json"))
|
||||
case strings.HasSuffix(r.URL.Path, "/build"):
|
||||
tag := r.URL.Query().Get("t")
|
||||
api.untag(tag)
|
||||
api.images[api.nextID] = append(api.images[api.nextID], tag)
|
||||
case strings.HasSuffix(r.URL.Path, "/version"):
|
||||
_, _ = w.Write([]byte(`{"Version":"27.3.1","ApiVersion":"1.47"}`))
|
||||
case strings.HasSuffix(r.URL.Path, "/containers/create"):
|
||||
_, _ = w.Write([]byte(`{"Id":"gitcontainer"}`))
|
||||
case strings.HasSuffix(r.URL.Path, "/logs"):
|
||||
writeCloneOutput(w, api.shortSHA)
|
||||
default:
|
||||
// The other steps of the git clone, which succeeds.
|
||||
_, _ = w.Write([]byte(`{}`))
|
||||
}
|
||||
}
|
||||
|
||||
removed = append(removed, name)
|
||||
forced = forced || r.URL.Query().Get("force") != ""
|
||||
mu.Unlock()
|
||||
// listImages lists the untagged images, or else the tagged ones.
|
||||
func (api *fakeImageAPI) listImages(w http.ResponseWriter, dangling bool) {
|
||||
list := []image.Summary{}
|
||||
|
||||
_, _ = w.Write([]byte(`[]`))
|
||||
case strings.HasSuffix(r.URL.Path, "/images/json"):
|
||||
_, _ = w.Write([]byte(`[
|
||||
{"Id":"sha256:one","RepoTags":["upaas-myapp:1","upaas-otherapp:7"]},
|
||||
{"Id":"sha256:two","RepoTags":["upaas-myapp:2"]},
|
||||
{"Id":"sha256:three","RepoTags":["upaas-myapp:3"]},
|
||||
{"Id":"sha256:four","RepoTags":["upaas-myapp:4"]}
|
||||
]`))
|
||||
default:
|
||||
_, _ = w.Write([]byte(`{}`))
|
||||
}
|
||||
},
|
||||
))
|
||||
for _, id := range slices.Sorted(maps.Keys(api.images)) {
|
||||
if (len(api.images[id]) == 0) == dangling {
|
||||
list = append(list, image.Summary{ID: id, RepoTags: api.images[id]})
|
||||
}
|
||||
}
|
||||
|
||||
data, _ := json.Marshal(list)
|
||||
_, _ = w.Write(data)
|
||||
}
|
||||
|
||||
func (api *fakeImageAPI) inspectImage(w http.ResponseWriter, name string) {
|
||||
for id, tags := range api.images {
|
||||
if id == name || slices.Contains(tags, name) {
|
||||
_, _ = fmt.Fprintf(w, `{"Id":%q}`, id)
|
||||
|
||||
return
|
||||
}
|
||||
}
|
||||
|
||||
w.WriteHeader(http.StatusNotFound)
|
||||
_, _ = w.Write([]byte(`{"message":"No such image"}`))
|
||||
}
|
||||
|
||||
func (api *fakeImageAPI) removeImage(w http.ResponseWriter, name string) {
|
||||
api.removed = append(api.removed, name)
|
||||
|
||||
id := name
|
||||
if _, isID := api.images[name]; !isID {
|
||||
id = api.untag(name)
|
||||
}
|
||||
|
||||
if len(api.images[id]) == 0 {
|
||||
delete(api.images, id)
|
||||
}
|
||||
|
||||
_, _ = w.Write([]byte(`[]`))
|
||||
}
|
||||
|
||||
// untag removes tag from the image that has it, leaving the image, and
|
||||
// returns the image's ID.
|
||||
func (api *fakeImageAPI) untag(tag string) string {
|
||||
for id, tags := range api.images {
|
||||
if slices.Contains(tags, tag) {
|
||||
api.images[id] = slices.DeleteFunc(tags, func(t string) bool { return t == tag })
|
||||
|
||||
return id
|
||||
}
|
||||
}
|
||||
|
||||
return ""
|
||||
}
|
||||
|
||||
// state returns each image's tags and each tag or ID removed.
|
||||
func (api *fakeImageAPI) state() (map[string][]string, []string) {
|
||||
api.mu.Lock()
|
||||
defer api.mu.Unlock()
|
||||
|
||||
return maps.Clone(api.images), slices.Clone(api.removed)
|
||||
}
|
||||
|
||||
// writeCloneOutput writes the line of a git clone's output that gives the
|
||||
// commit's short hash, as Docker sends a container's log: after a header.
|
||||
func writeCloneOutput(w io.Writer, shortSHA string) {
|
||||
out := stdcopy.NewStdWriter(w, stdcopy.Stdout)
|
||||
|
||||
_, _ = fmt.Fprintf(out, "SHORT_SHA:%s\n", shortSHA)
|
||||
}
|
||||
|
||||
// newImageTestService returns a deploy service that uses api as its
|
||||
// Docker API, and its database.
|
||||
func newImageTestService(
|
||||
t *testing.T,
|
||||
api *fakeImageAPI,
|
||||
) (*deploy.Service, *database.Database) {
|
||||
t.Helper()
|
||||
|
||||
srv := httptest.NewServer(api)
|
||||
t.Cleanup(srv.Close)
|
||||
|
||||
log := slog.New(slog.NewTextHandler(os.Stderr, nil))
|
||||
@@ -77,30 +172,155 @@ func TestRecordDeployedImageRemovesOldImages(t *testing.T) {
|
||||
t.Cleanup(lifecycle.RequireStop)
|
||||
|
||||
db := database.NewTestDatabase(t)
|
||||
ctx := context.Background()
|
||||
dataDir := t.TempDir()
|
||||
cfg := &config.Config{DataDir: dataDir, HostDataDir: dataDir}
|
||||
|
||||
return deploy.NewTestServiceWithConfig(log, cfg, db, dockerClient), db
|
||||
}
|
||||
|
||||
// saveApp saves an app with the given current and previous image.
|
||||
func saveApp(
|
||||
t *testing.T,
|
||||
db *database.Database,
|
||||
name, imageID, previousImageID string,
|
||||
) *models.App {
|
||||
t.Helper()
|
||||
|
||||
app := models.NewApp(db)
|
||||
app.ID = "myapp-id"
|
||||
app.Name = "myapp"
|
||||
app.ImageID = sql.NullString{String: "sha256:three", Valid: true}
|
||||
app.PreviousImageID = sql.NullString{String: "sha256:two", Valid: true}
|
||||
require.NoError(t, app.Save(ctx))
|
||||
app.ID = name + "-id"
|
||||
app.Name = name
|
||||
app.ImageID = sql.NullString{String: imageID, Valid: true}
|
||||
app.PreviousImageID = sql.NullString{String: previousImageID, Valid: true}
|
||||
require.NoError(t, app.Save(context.Background()))
|
||||
|
||||
return app
|
||||
}
|
||||
|
||||
// TestRecordDeployedImageRemovesOldImages runs the step after a deploy
|
||||
// against a fake Docker API. Image one has a tag from before images were
|
||||
// tagged with their commit, and is also tagged for another app. Image two
|
||||
// was the previous image, three the current one, four is new. Image five is
|
||||
// the other app's previous image, which a redeploy of its commit left
|
||||
// without the other app's tag.
|
||||
func TestRecordDeployedImageRemovesOldImages(t *testing.T) {
|
||||
t.Parallel()
|
||||
|
||||
api := &fakeImageAPI{images: map[string][]string{
|
||||
"sha256:one": {"upaas-myapp:140", "upaas-otherapp:1a2b3c4"},
|
||||
"sha256:two": {"upaas-myapp:2b3c4d5"},
|
||||
"sha256:three": {"upaas-myapp:3c4d5e6"},
|
||||
"sha256:four": {"upaas-myapp:4d5e6f7"},
|
||||
"sha256:five": {"upaas-myapp:5e6f7a8"},
|
||||
}}
|
||||
svc, db := newImageTestService(t, api)
|
||||
ctx := context.Background()
|
||||
|
||||
app := saveApp(t, db, "myapp", "sha256:three", "sha256:two")
|
||||
saveApp(t, db, "otherapp", "sha256:other", "sha256:five")
|
||||
|
||||
deployment := models.NewDeployment(db)
|
||||
deployment.AppID = app.ID
|
||||
require.NoError(t, deployment.Save(ctx))
|
||||
|
||||
svc := deploy.NewTestServiceWithConfig(log, &config.Config{}, dockerClient)
|
||||
|
||||
err = svc.RecordDeployedImage(ctx, app, deployment, "sha256:four")
|
||||
err := svc.RecordDeployedImage(ctx, app, deployment, "sha256:four")
|
||||
require.NoError(t, err)
|
||||
|
||||
assert.Equal(t, "sha256:four", app.ImageID.String)
|
||||
assert.Equal(t, "sha256:three", app.PreviousImageID.String)
|
||||
|
||||
mu.Lock()
|
||||
defer mu.Unlock()
|
||||
images, removed := api.state()
|
||||
|
||||
assert.Equal(t, []string{"upaas-myapp:1", "upaas-myapp:2"}, removed)
|
||||
assert.False(t, forced, "old image tags must be removed without force")
|
||||
assert.Equal(t, []string{"upaas-myapp:140", "upaas-myapp:2b3c4d5"}, removed)
|
||||
assert.Equal(t, map[string][]string{
|
||||
"sha256:one": {"upaas-otherapp:1a2b3c4"},
|
||||
"sha256:three": {"upaas-myapp:3c4d5e6"},
|
||||
"sha256:four": {"upaas-myapp:4d5e6f7"},
|
||||
"sha256:five": {"upaas-myapp:5e6f7a8"},
|
||||
}, images)
|
||||
assert.False(t, api.forced, "old images must be removed without force")
|
||||
}
|
||||
|
||||
// TestRedeployRemovesImagesLeftWithoutTag deploys commits against a fake
|
||||
// Docker API, some of them again. A build takes the commit's tag from the
|
||||
// image an earlier build of it made. That image is kept, without a tag,
|
||||
// while the app runs it or Rollback would start it, and is removed by its
|
||||
// ID once neither does.
|
||||
func TestRedeployRemovesImagesLeftWithoutTag(t *testing.T) {
|
||||
t.Parallel()
|
||||
|
||||
const (
|
||||
tagABC1234 = "upaas-myapp:abc1234"
|
||||
tag0123ABC = "upaas-myapp:0123abc"
|
||||
retriedImage = "sha256:retried-0123abc"
|
||||
)
|
||||
|
||||
// The app runs commit abc1234 and would roll back to def5678. The last
|
||||
// deploy, of commit 0123abc, failed after its build.
|
||||
api := &fakeImageAPI{images: map[string][]string{
|
||||
"sha256:built-abc1234": {tagABC1234},
|
||||
"sha256:built-def5678": {"upaas-myapp:def5678"},
|
||||
"sha256:failed-0123abc": {tag0123ABC},
|
||||
}}
|
||||
svc, db := newImageTestService(t, api)
|
||||
ctx := context.Background()
|
||||
|
||||
app := saveApp(t, db, "myapp", "sha256:built-abc1234", "sha256:built-def5678")
|
||||
|
||||
for imageID := range api.images {
|
||||
deployment := models.NewDeployment(db)
|
||||
deployment.AppID = app.ID
|
||||
deployment.ImageID = sql.NullString{String: imageID, Valid: true}
|
||||
require.NoError(t, deployment.Save(ctx))
|
||||
}
|
||||
|
||||
deployCommit := func(shortSHA, imageID string) {
|
||||
t.Helper()
|
||||
|
||||
api.mu.Lock()
|
||||
api.shortSHA = shortSHA
|
||||
api.nextID = imageID
|
||||
api.mu.Unlock()
|
||||
|
||||
deployment := models.NewDeployment(db)
|
||||
deployment.AppID = app.ID
|
||||
require.NoError(t, deployment.Save(ctx))
|
||||
|
||||
built, err := svc.BuildImage(ctx, app, deployment)
|
||||
require.NoError(t, err)
|
||||
require.NoError(t, svc.RecordDeployedImage(ctx, app, deployment, built))
|
||||
}
|
||||
|
||||
// The failed deploy's image loses its tag, and nothing uses it.
|
||||
deployCommit("0123abc", retriedImage)
|
||||
|
||||
images, _ := api.state()
|
||||
assert.Equal(t, map[string][]string{
|
||||
"sha256:built-abc1234": {tagABC1234},
|
||||
retriedImage: {tag0123ABC},
|
||||
}, images)
|
||||
|
||||
// The running image loses its tag and becomes the one Rollback starts.
|
||||
deployCommit("0123abc", "sha256:rebuilt-0123abc")
|
||||
|
||||
images, _ = api.state()
|
||||
assert.Equal(t, map[string][]string{
|
||||
"sha256:rebuilt-0123abc": {tag0123ABC},
|
||||
retriedImage: {},
|
||||
}, images)
|
||||
assert.Equal(t, retriedImage, app.PreviousImageID.String)
|
||||
|
||||
// Once Rollback no longer needs it, the untagged image is removed.
|
||||
deployCommit("4567def", "sha256:built-4567def")
|
||||
|
||||
images, removed := api.state()
|
||||
assert.Equal(t, map[string][]string{
|
||||
"sha256:built-4567def": {"upaas-myapp:4567def"},
|
||||
"sha256:rebuilt-0123abc": {tag0123ABC},
|
||||
}, images)
|
||||
assert.Equal(t, []string{
|
||||
"sha256:failed-0123abc", "upaas-myapp:def5678", // first deploy
|
||||
tagABC1234, // second deploy
|
||||
retriedImage, // third deploy
|
||||
}, removed)
|
||||
assert.False(t, api.forced, "old images must be removed without force")
|
||||
}
|
||||
|
||||
@@ -9,6 +9,7 @@ import (
|
||||
"strings"
|
||||
|
||||
"sneak.berlin/go/upaas/internal/config"
|
||||
"sneak.berlin/go/upaas/internal/database"
|
||||
"sneak.berlin/go/upaas/internal/docker"
|
||||
"sneak.berlin/go/upaas/internal/models"
|
||||
)
|
||||
@@ -44,15 +45,18 @@ func (svc *Service) UnlockApp(appID string) {
|
||||
svc.unlockApp(appID)
|
||||
}
|
||||
|
||||
// NewTestServiceWithConfig creates a Service with config and docker client for testing.
|
||||
// NewTestServiceWithConfig creates a Service with config, database and
|
||||
// docker client for testing.
|
||||
func NewTestServiceWithConfig(
|
||||
log *slog.Logger,
|
||||
cfg *config.Config,
|
||||
db *database.Database,
|
||||
dockerClient *docker.Client,
|
||||
) *Service {
|
||||
return &Service{
|
||||
log: log,
|
||||
config: cfg,
|
||||
db: db,
|
||||
docker: dockerClient,
|
||||
}
|
||||
}
|
||||
|
||||
Reference in New Issue
Block a user