mirror of
https://github.com/psviderski/uncloud.git
synced 2026-11-10 12:44:16 +00:00
feat(labels): include detailed labels diff in service plan
This commit is contained in:
Pasha Sviderski
@@ -1,9 +1,11 @@
|
||||
package deploy
|
||||
|
||||
import (
|
||||
"strings"
|
||||
"testing"
|
||||
|
||||
"github.com/charmbracelet/x/ansi"
|
||||
"github.com/docker/docker/api/types/container"
|
||||
"github.com/psviderski/uncloud/pkg/api"
|
||||
"github.com/psviderski/uncloud/pkg/client/operation"
|
||||
"github.com/stretchr/testify/assert"
|
||||
@@ -59,3 +61,225 @@ func TestServicePlan_FormatSummary(t *testing.T) {
|
||||
})
|
||||
}
|
||||
}
|
||||
|
||||
func TestServicePlan_Format(t *testing.T) {
|
||||
t.Parallel()
|
||||
|
||||
newContainer := func(spec api.ServiceSpec) api.ServiceContainer {
|
||||
return api.ServiceContainer{
|
||||
Container: api.Container{InspectResponse: container.InspectResponse{
|
||||
ContainerJSONBase: &container.ContainerJSONBase{ID: "0f6df6593e1b0123456789abcdef"},
|
||||
}},
|
||||
ServiceSpec: spec,
|
||||
}
|
||||
}
|
||||
spec := func(image string, labels, containerLabels map[string]string) api.ServiceSpec {
|
||||
return api.ServiceSpec{
|
||||
Name: "web",
|
||||
Mode: api.ServiceModeReplicated,
|
||||
Replicas: 1,
|
||||
Labels: labels,
|
||||
Container: api.ContainerSpec{Image: image, Labels: containerLabels},
|
||||
}
|
||||
}
|
||||
|
||||
tests := []struct {
|
||||
name string
|
||||
isNewService bool
|
||||
spec api.ServiceSpec
|
||||
ops func(spec api.ServiceSpec) []operation.Operation
|
||||
expected []string
|
||||
}{
|
||||
{
|
||||
name: "service labels added, changed, and removed in place",
|
||||
spec: spec("nginx:1.25", map[string]string{"env": "prod", "team": "platform", "same": "1"}, nil),
|
||||
ops: func(api.ServiceSpec) []operation.Operation {
|
||||
return []operation.Operation{&operation.UpdateContainerOperation{
|
||||
MachineName: "machine-1",
|
||||
Container: newContainer(spec(
|
||||
"nginx:1.25", map[string]string{"old": "legacy", "team": "backend", "same": "1"}, nil,
|
||||
)),
|
||||
}}
|
||||
},
|
||||
expected: []string{
|
||||
"~ update service web",
|
||||
" │ image: nginx:1.25",
|
||||
" │ ~ labels:",
|
||||
" │ + env=prod",
|
||||
" │ - old=legacy",
|
||||
" │ ~ team=backend → platform",
|
||||
" │",
|
||||
" ╰── ~ update container web/0f6df6593e1b on machine-1 (in place)",
|
||||
},
|
||||
},
|
||||
{
|
||||
name: "container labels changed with image on replace",
|
||||
spec: spec("nginx:1.26", nil, map[string]string{"proxy": "on"}),
|
||||
ops: func(new api.ServiceSpec) []operation.Operation {
|
||||
return []operation.Operation{&operation.ReplaceContainerOperation{
|
||||
Spec: new,
|
||||
MachineName: "machine-1",
|
||||
OldContainer: newContainer(spec("nginx:1.25", nil, map[string]string{"proxy": "off"})),
|
||||
}}
|
||||
},
|
||||
expected: []string{
|
||||
"~ update service web",
|
||||
" │ ~ image: nginx:1.25 → 1.26",
|
||||
" │ ~ container labels:",
|
||||
" │ ~ proxy=off → on",
|
||||
" │",
|
||||
" ╰── +/- replace container web/0f6df6593e1b on machine-1",
|
||||
},
|
||||
},
|
||||
{
|
||||
name: "no label blocks when labels are the same",
|
||||
spec: spec("nginx:1.26", map[string]string{}, map[string]string{"proxy": "on"}),
|
||||
ops: func(new api.ServiceSpec) []operation.Operation {
|
||||
return []operation.Operation{&operation.ReplaceContainerOperation{
|
||||
Spec: new,
|
||||
MachineName: "machine-1",
|
||||
OldContainer: newContainer(spec("nginx:1.25", nil, map[string]string{"proxy": "on"})),
|
||||
}}
|
||||
},
|
||||
expected: []string{
|
||||
"~ update service web",
|
||||
" │ ~ image: nginx:1.25 → 1.26",
|
||||
" │",
|
||||
" ╰── +/- replace container web/0f6df6593e1b on machine-1",
|
||||
},
|
||||
},
|
||||
{
|
||||
name: "replaced container determines old spec over updated one",
|
||||
spec: spec("nginx:1.26", map[string]string{"team": "platform"}, nil),
|
||||
ops: func(new api.ServiceSpec) []operation.Operation {
|
||||
return []operation.Operation{
|
||||
&operation.UpdateContainerOperation{
|
||||
MachineName: "machine-1",
|
||||
Container: newContainer(spec("nginx:1.26", map[string]string{"team": "backend"}, nil)),
|
||||
},
|
||||
&operation.ReplaceContainerOperation{
|
||||
Spec: new,
|
||||
MachineName: "machine-2",
|
||||
OldContainer: newContainer(spec("nginx:1.25", map[string]string{"team": "backend"}, nil)),
|
||||
},
|
||||
}
|
||||
},
|
||||
expected: []string{
|
||||
"~ update service web",
|
||||
" │ ~ image: nginx:1.25 → 1.26",
|
||||
" │ ~ labels:",
|
||||
" │ ~ team=backend → platform",
|
||||
" │",
|
||||
" ├── ~ update container web/0f6df6593e1b on machine-1 (in place)",
|
||||
" ╰── +/- replace container web/0f6df6593e1b on machine-2",
|
||||
},
|
||||
},
|
||||
{
|
||||
name: "all labels removed",
|
||||
spec: spec("nginx:1.25", map[string]string{}, nil),
|
||||
ops: func(api.ServiceSpec) []operation.Operation {
|
||||
return []operation.Operation{&operation.UpdateContainerOperation{
|
||||
MachineName: "machine-1",
|
||||
Container: newContainer(spec("nginx:1.25", map[string]string{"a": "1", "b": "2"}, nil)),
|
||||
}}
|
||||
},
|
||||
expected: []string{
|
||||
"~ update service web",
|
||||
" │ image: nginx:1.25",
|
||||
" │ - labels:",
|
||||
" │ - a=1",
|
||||
" │ - b=2",
|
||||
" │",
|
||||
" ╰── ~ update container web/0f6df6593e1b on machine-1 (in place)",
|
||||
},
|
||||
},
|
||||
{
|
||||
name: "first labels added to existing service",
|
||||
spec: spec("nginx:1.25", map[string]string{"a": "1"}, nil),
|
||||
ops: func(api.ServiceSpec) []operation.Operation {
|
||||
return []operation.Operation{&operation.UpdateContainerOperation{
|
||||
MachineName: "machine-1",
|
||||
Container: newContainer(spec("nginx:1.25", nil, nil)),
|
||||
}}
|
||||
},
|
||||
expected: []string{
|
||||
"~ update service web",
|
||||
" │ image: nginx:1.25",
|
||||
" │ ~ labels:",
|
||||
" │ + a=1",
|
||||
" │",
|
||||
" ╰── ~ update container web/0f6df6593e1b on machine-1 (in place)",
|
||||
},
|
||||
},
|
||||
{
|
||||
name: "empty and non-printable label values are escaped on a single line",
|
||||
spec: spec("nginx:1.25", map[string]string{
|
||||
"added": "1\n2",
|
||||
"cleared": "",
|
||||
"json": `{"a":1}`,
|
||||
"multi": "a\nb\nc",
|
||||
"tab": "a\tb",
|
||||
"trailing": "hello\n",
|
||||
"unicode": "héllo wörld 🚀",
|
||||
}, nil),
|
||||
ops: func(api.ServiceSpec) []operation.Operation {
|
||||
return []operation.Operation{&operation.UpdateContainerOperation{
|
||||
MachineName: "machine-1",
|
||||
Container: newContainer(spec("nginx:1.25", map[string]string{
|
||||
"cleared": "x",
|
||||
"multi": "a\nb",
|
||||
"trailing": "hello",
|
||||
}, nil)),
|
||||
}}
|
||||
},
|
||||
expected: []string{
|
||||
"~ update service web",
|
||||
" │ image: nginx:1.25",
|
||||
" │ ~ labels:",
|
||||
` │ + added="1\n2"`,
|
||||
` │ ~ cleared=x → ""`,
|
||||
` │ + json={"a":1}`,
|
||||
` │ ~ multi="a\nb" → "a\nb\nc"`,
|
||||
` │ + tab="a\tb"`,
|
||||
` │ ~ trailing=hello → "hello\n"`,
|
||||
" │ + unicode=héllo wörld 🚀",
|
||||
" │",
|
||||
" ╰── ~ update container web/0f6df6593e1b on machine-1 (in place)",
|
||||
},
|
||||
},
|
||||
{
|
||||
name: "new service with labels",
|
||||
isNewService: true,
|
||||
spec: spec("nginx:1.25", map[string]string{"team": "platform"}, map[string]string{"proxy": "on"}),
|
||||
ops: func(new api.ServiceSpec) []operation.Operation {
|
||||
return []operation.Operation{&operation.RunContainerOperation{Spec: new, MachineName: "machine-1"}}
|
||||
},
|
||||
expected: []string{
|
||||
"+ create service web",
|
||||
" │ image: nginx:1.25",
|
||||
" │ labels:",
|
||||
" │ team=platform",
|
||||
" │ container labels:",
|
||||
" │ proxy=on",
|
||||
" │",
|
||||
" ╰── + run container web on machine-1",
|
||||
},
|
||||
},
|
||||
}
|
||||
|
||||
for _, tt := range tests {
|
||||
t.Run(tt.name, func(t *testing.T) {
|
||||
t.Parallel()
|
||||
|
||||
plan := ServicePlan{ServiceName: "web", IsNewService: tt.isNewService, Spec: tt.spec}
|
||||
plan.Operations = tt.ops(tt.spec)
|
||||
|
||||
// The table pads cells to the column width so ignore trailing whitespace.
|
||||
var lines []string
|
||||
for line := range strings.Lines(ansi.Strip(plan.Format())) {
|
||||
lines = append(lines, strings.TrimRight(line, " \n"))
|
||||
}
|
||||
assert.Equal(t, tt.expected, lines)
|
||||
})
|
||||
}
|
||||
}
|
||||
|
||||
Reference in New Issue
Block a user