philipp/uncloud
1
0
Fork 0
mirror of https://github.com/psviderski/uncloud.git synced 2026-08-26 11:03:34 +00:00
Code Issues Packages Projects Releases Wiki Activity

chore(volumes): add client methods for volume management, e2e test

Browse Source
This commit is contained in:
Pavel Sviderski
2025-04-10 13:50:08 +10:00
parent c6205d4f57
commit df4ab40e12
11 changed files with 286 additions and 89 deletions
Download Patch File Download Diff File Expand all files Collapse all files
test/e2e/assert.go
+29
View File
@@ -1,16 +1,21 @@
package e2e
import (
"reflect"
"slices"
"strconv"
"strings"
"testing"
mapset "github.com/deckarep/golang-set/v2"
"github.com/docker/docker/api/types/container"
"github.com/docker/docker/api/types/mount"
"github.com/docker/go-connections/nat"
machinedocker "github.com/psviderski/uncloud/internal/machine/docker"
"github.com/psviderski/uncloud/pkg/api"
"github.com/psviderski/uncloud/pkg/client/deploy"
"github.com/stretchr/testify/assert"
"github.com/stretchr/testify/require"
)
func assertServiceMatchesSpec(t *testing.T, svc api.Service, spec api.ServiceSpec) {
@@ -34,6 +39,7 @@ func assertContainerMatchesSpec(t *testing.T, ctr api.ServiceContainer, spec api
spec = spec.SetDefaults()
// Verify labels.
assert.True(t, api.ValidateServiceID(ctr.Config.Labels[api.LabelServiceID]))
assert.Equal(t, spec.Name, ctr.Config.Labels[api.LabelServiceName])
assert.Equal(t, spec.Mode, ctr.Config.Labels[api.LabelServiceMode])
assert.Contains(t, ctr.Config.Labels, api.LabelManaged)
@@ -54,7 +60,11 @@ func assertContainerMatchesSpec(t *testing.T, ctr api.ServiceContainer, spec api
assert.Equal(t, spec.Container.Image, ctr.Config.Image)
assert.Equal(t, spec.Container.Init, ctr.HostConfig.Init)
assert.True(t, strings.HasPrefix(ctr.Name, spec.Name+"-"))
assert.Empty(t, ctr.HostConfig.Binds, "Expected empty binds as all volumes should be mapped to mounts")
assert.ElementsMatch(t, spec.Container.Volumes, ctr.HostConfig.Binds)
assertContainerMountsMatchSpec(t, ctr.HostConfig.Mounts, spec)
// Compare host ports.
portBindings := make(nat.PortMap)
@@ -84,6 +94,25 @@ func assertContainerMatchesSpec(t *testing.T, ctr api.ServiceContainer, spec api
assert.Contains(t, ctr.NetworkSettings.Networks, machinedocker.NetworkName)
}
func assertContainerMountsMatchSpec(t *testing.T, mounts []mount.Mount, spec api.ServiceSpec) {
expectedMounts, err := machinedocker.ToDockerMounts(spec.Volumes, spec.Container.VolumeMounts)
require.NoError(t, err)
sortMounts(mounts)
sortMounts(expectedMounts)
assert.Len(t, mounts, len(expectedMounts), "Expected %d mounts", len(expectedMounts))
for i, m := range mounts {
assert.True(t, reflect.DeepEqual(m, expectedMounts[i]), "Expected mount type=%s,src=%s,dst=%s to match spec")
}
}
func sortMounts(mounts []mount.Mount) {
slices.SortFunc(mounts, func(a, b mount.Mount) int {
return strings.Compare(a.Target, b.Target)
})
}
// serviceContainersByMachine returns a map of machine ID to service containers on that machine.
func serviceContainersByMachine(t *testing.T, svc api.Service) map[string][]api.ServiceContainer {
containers := make(map[string][]api.ServiceContainer)
test/e2e/service_test.go
+75 -78
View File
@@ -4,13 +4,12 @@ import (
"context"
"errors"
"net/netip"
"strings"
"testing"
"github.com/docker/docker/api/types/container"
"github.com/docker/go-connections/nat"
"github.com/docker/docker/api/types/mount"
"github.com/docker/docker/api/types/volume"
"github.com/psviderski/uncloud/internal/machine/api/pb"
machinedocker "github.com/psviderski/uncloud/internal/machine/docker"
"github.com/psviderski/uncloud/internal/secret"
"github.com/psviderski/uncloud/internal/ucind"
"github.com/psviderski/uncloud/pkg/api"
@@ -651,34 +650,7 @@ func TestServiceLifecycle(t *testing.T) {
// Verify container configuration.
mc, err := cli.InspectContainer(ctx, serviceID, resp.ID)
require.NoError(t, err)
ctr := mc.Container
assert.True(t, strings.HasPrefix(ctr.Name, "container-spec-defaults-"))
assert.Equal(t, "portainer/pause:latest", ctr.Config.Image)
// Verify default settings.
assert.Empty(t, ctr.Config.Cmd)
assert.EqualValues(t, []string{"/pause"}, ctr.Config.Entrypoint) // Populated by the image.
assert.Equal(t, []string{"PATH=/usr/local/sbin:/usr/local/bin:/usr/sbin:/usr/bin:/sbin:/bin"}, ctr.Config.Env)
assert.Nil(t, ctr.HostConfig.Init)
assert.Empty(t, ctr.HostConfig.Binds)
assert.Empty(t, ctr.HostConfig.PortBindings)
assert.Equal(t, container.RestartPolicy{
Name: container.RestartPolicyAlways,
MaximumRetryCount: 0,
}, ctr.HostConfig.RestartPolicy)
// Verify labels.
assert.Equal(t, serviceID, ctr.Config.Labels[api.LabelServiceID])
assert.Equal(t, spec.Name, ctr.Config.Labels[api.LabelServiceName])
assert.Equal(t, api.ServiceModeReplicated, ctr.Config.Labels[api.LabelServiceMode])
assert.NotContains(t, ctr.Config.Labels, api.LabelServicePorts) // No ports set.
assert.Contains(t, ctr.Config.Labels, api.LabelManaged)
// Verify network settings.
assert.Len(t, ctr.NetworkSettings.Networks, 1)
assert.Contains(t, ctr.NetworkSettings.Networks, machinedocker.NetworkName)
assertContainerMatchesSpec(t, mc.Container, spec)
})
t.Run("create container with full spec", func(t *testing.T) {
@@ -699,9 +671,28 @@ func TestServiceLifecycle(t *testing.T) {
"BOOL": "true",
"": "ignored",
},
Image: "portainer/pause:latest",
Init: &init,
Volumes: []string{"/host/path:/container/path:ro"},
Image: "portainer/pause:latest",
Init: &init,
VolumeMounts: []api.VolumeMount{
{
VolumeName: "hostpath",
ContainerPath: "/volumes/hostpath",
ReadOnly: true,
},
{
VolumeName: "container-spec-full-default-volume",
ContainerPath: "/volumes/default-volume",
},
{
VolumeName: "custom-volume",
ContainerPath: "/volumes/custom-volume",
ReadOnly: true,
},
{
VolumeName: "tmpfs",
ContainerPath: "/volumes/tmpfs",
},
},
},
Ports: []api.PortSpec{
{
@@ -718,6 +709,55 @@ func TestServiceLifecycle(t *testing.T) {
Mode: api.PortModeIngress,
},
},
Volumes: []api.VolumeSpec{
{
Name: "hostpath",
Type: api.VolumeTypeBind,
BindOptions: &api.BindOptions{
HostPath: "/tmp/container-spec-full/host/path",
CreateHostPath: true,
},
},
{
Name: "container-spec-full-default-volume",
Type: api.VolumeTypeVolume,
},
{
Name: "custom-volume",
Type: api.VolumeTypeVolume,
VolumeOptions: &api.VolumeOptions{
Driver: &mount.Driver{
Name: "local",
},
Labels: map[string]string{
"key": "value",
},
Name: "container-spec-full-custom-volume",
NoCopy: true,
},
},
{
Name: "tmpfs",
Type: api.VolumeTypeTmpfs,
},
},
}
// Create the volumes before creating the container as they must be managed externally.
volumeNames := []string{
"container-spec-full-default-volume",
"container-spec-full-custom-volume",
}
for _, name := range volumeNames {
_, err = cli.CreateVolume(ctx, c.Machines[0].Name, volume.CreateOptions{Name: name})
require.NoError(t, err)
t.Cleanup(func() {
err := cli.RemoveVolume(ctx, c.Machines[0].Name, name, false)
if !errors.Is(err, api.ErrNotFound) {
require.NoError(t, err)
}
})
}
resp, err := cli.CreateContainer(ctx, serviceID, spec, c.Machines[0].Name)
@@ -734,50 +774,7 @@ func TestServiceLifecycle(t *testing.T) {
// Verify container configuration.
mc, err := cli.InspectContainer(ctx, serviceID, resp.ID)
require.NoError(t, err)
ctr := mc.Container
assert.True(t, strings.HasPrefix(ctr.Name, "container-spec-full-"))
assert.Equal(t, "portainer/pause:latest", ctr.Config.Image)
assert.EqualValues(t, spec.Container.Command, ctr.Config.Cmd)
assert.EqualValues(t, spec.Container.Entrypoint, ctr.Config.Entrypoint)
expectedEnv := []string{
"BOOL=true",
"EMTPY=",
"PATH=/usr/local/sbin:/usr/local/bin:/usr/sbin:/usr/bin:/sbin:/bin",
"VAR=value",
}
assert.ElementsMatch(t, expectedEnv, ctr.Config.Env)
assert.True(t, *ctr.HostConfig.Init)
assert.Len(t, ctr.HostConfig.Binds, 1)
assert.Contains(t, ctr.HostConfig.Binds, spec.Container.Volumes[0])
assert.Len(t, ctr.HostConfig.PortBindings, 1)
expectedPort := []nat.PortBinding{
{
HostIP: "127.0.0.1",
HostPort: "80",
},
}
assert.Equal(t, expectedPort, ctr.HostConfig.PortBindings[nat.Port("8080/tcp")])
assert.Equal(t, container.RestartPolicy{
Name: container.RestartPolicyAlways,
MaximumRetryCount: 0,
}, ctr.HostConfig.RestartPolicy)
// Verify labels.
assert.Equal(t, serviceID, ctr.Config.Labels[api.LabelServiceID])
assert.Equal(t, spec.Name, ctr.Config.Labels[api.LabelServiceName])
assert.Equal(t, api.ServiceModeGlobal, ctr.Config.Labels[api.LabelServiceMode])
assert.Equal(t, "127.0.0.1:80:8080/tcp@host,app.example.com:8000/https", ctr.Config.Labels[api.LabelServicePorts])
assert.Contains(t, ctr.Config.Labels, api.LabelManaged)
// Verify network settings.
assert.Len(t, ctr.NetworkSettings.Networks, 1)
assert.Contains(t, ctr.NetworkSettings.Networks, machinedocker.NetworkName)
assertContainerMatchesSpec(t, mc.Container, spec)
})
t.Run("create container invalid service", func(t *testing.T) {