Skip to content

[module-sdk] Add testing framework #50

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
wants to merge 6 commits into
base: main
Choose a base branch
from
+857 −67
Open

[module-sdk] Add testing framework #50

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
6 commits
Select commit Hold shift + click to select a range
7577ab9
init
ldmonster Jun 11, 2025
f73dde4
add snapshots and patch helper
ldmonster Jun 24, 2025
455401b
add helpers
ldmonster Jun 24, 2025
0ba39d6
bump
ldmonster Jun 24, 2025
156fc03
proto
ldmonster Jun 25, 2025
d8784aa
lint
ldmonster Jun 25, 2025
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
90 changes: 90 additions & 0 deletions common-hooks/tls-certificate/internal_tls_test.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -32,6 +32,7 @@ import (
"github.com/deckhouse/module-sdk/pkg"
"github.com/deckhouse/module-sdk/pkg/certificate"
"github.com/deckhouse/module-sdk/pkg/jq"
"github.com/deckhouse/module-sdk/testing/helpers"
mock "github.com/deckhouse/module-sdk/testing/mock"
)

Expand Down Expand Up @@ -430,3 +431,92 @@ func Test_GenSelfSignedTLS(t *testing.T) {
assert.NoError(t, err)
})
}

func Test_GenSelfSignedTLS_NewFramework(t *testing.T) {
t.Run("outdated certificate in snapshot", func(t *testing.T) {
tlsConfig := tlscertificate.GenSelfSignedTLSHookConf{
CN: "cert-name",
TLSSecretName: "secret-webhook-cert",
Namespace: "some-namespace",
BeforeHookCheck: func(_ *pkg.HookInput) bool {
return true
},
SANs: tlscertificate.DefaultSANs([]string{
"example-webhook",
"example-webhook.d8-example-module",
"example-webhook.d8-example-module.svc",
"%CLUSTER_DOMAIN%://example-webhook.d8-example-module.svc",
"%PUBLIC_DOMAIN%://example-webhook.d8-example-module.svc",
}),
FullValuesPathPrefix: "d8-example-module.internal.webhookCert",
}

hookConfig := tlscertificate.GenSelfSignedTLSConfig(tlsConfig)

snaps := helpers.PrepareHookSnapshots(t, hookConfig, map[string][]string{
tlscertificate.InternalTLSSnapshotKey: {
`
apiVersion: v1
data:
ca.crt: LS0tLS1CRUdJTiBDRVJUSUZJQ0FURS0tLS0tCk1JSUJpRENDQVM2Z0F3SUJBZ0lVV3VXcVhMQ1ZnWXVSaVNmZVZvT3RHMG9vU3pZd0NnWUlLb1pJemowRUF3SXcKSWpFZ01CNEdBMVVFQXhNWFpHVmphMmh2ZFhObExtUTRMWE41YzNSbGJTNXpkbU13SGhjTk1qVXdOakU0TVRnMApOREF3V2hjTk16VXdOakUyTVRnME5EQXdXakFpTVNBd0hnWURWUVFERXhka1pXTnJhRzkxYzJVdVpEZ3RjM2x6CmRHVnRMbk4yWXpCWk1CTUdCeXFHU000OUFnRUdDQ3FHU000OUF3RUhBMElBQkM0N3h1WCs2VkhvVVVpaG9VSUsKbzY1QzR2OVU5UjV5dXZLQUN3SlJ3bFoxUGs1MGR2aXFFNHJjbXRsdTRsZkRPSW9qaFlJN3ZUS1piMVByVTY3MgpTSHVqUWpCQU1BNEdBMVVkRHdFQi93UUVBd0lCQmpBUEJnTlZIUk1CQWY4RUJUQURBUUgvTUIwR0ExVWREZ1FXCkJCVDF1U3JvYjNJeHpaNlJOc042dEFjTGlyUGt3REFLQmdncWhrak9QUVFEQWdOSUFEQkZBaUJ6YTVSS3p0RDYKRmJuT2NOTm5ncjhQazhrME4vcGtzTGNiemZXd3NCN0lVQUloQU5tMjNMSzczNVJ0c3F4TGhGNmtyTCtlZmJicgpBbU9jSmpWdGwvNWc5aEhhCi0tLS0tRU5EIENFUlRJRklDQVRFLS0tLS0K
tls.crt: LS0tLS1CRUdJTiBDRVJUSUZJQ0FURS0tLS0tCk1JSUIwakNDQVhpZ0F3SUJBZ0lVVk5uZTJHaE1vV2k2RUdSVlh3bW1Kak1OdU40d0NnWUlLb1pJemowRUF3SXcKSWpFZ01CNEdBMVVFQXhNWFpHVmphMmh2ZFhObExtUTRMWE41YzNSbGJTNXpkbU13SGhjTk1qVXdOakU0TVRnMApOREF3V2hjTk16VXdOakUyTVRnME5EQXdXakFpTVNBd0hnWURWUVFERXhka1pXTnJhRzkxYzJVdVpEZ3RjM2x6CmRHVnRMbk4yWXpCWk1CTUdCeXFHU000OUFnRUdDQ3FHU000OUF3RUhBMElBQlBSdWduRk1yMlFZM0lKSFhvNlAKSEN3ZnYxRVJyS0dQdXZMYVovNHI1QWNmUkhJT3AzYUNvR1pwT0JRbFRUejBSaTE3VDRVeStHdmZxRWg0MHVCNQowYldqZ1lzd2dZZ3dEZ1lEVlIwUEFRSC9CQVFEQWdXZ01Bd0dBMVVkRXdFQi93UUNNQUF3SFFZRFZSME9CQllFCkZPMmpYOXE5MDc0WHdkNU90RFVhOE9vaXJiNEtNRWtHQTFVZEVRUkNNRUNDRjJSbFkydG9iM1Z6WlM1a09DMXoKZVhOMFpXMHVjM1pqZ2lWa1pXTnJhRzkxYzJVdVpEZ3RjM2x6ZEdWdExuTjJZeTVqYkhWemRHVnlMbXh2WTJGcwpNQW9HQ0NxR1NNNDlCQU1DQTBnQU1FVUNJUUN6dEJGbEY2eEpueHYyS3hrNHNqam5mQjQ1YjRmdjNsTFJYVkp6CmZmL2lsZ0lnTXQvM3pHSXRqVndlV3B1eDdyZnN0RkxxalhtZmkwRk4xL3ZwWGtOTEljZz0KLS0tLS1FTkQgQ0VSVElGSUNBVEUtLS0tLQo=
tls.key: LS0tLS1CRUdJTiBFQyBQUklWQVRFIEtFWS0tLS0tCk1IY0NBUUVFSUdIUUdieWlDdlV2WDdiUUhBbmZ2YkExbVdBLy9ESjlUdC83WW94akMvZ2dvQW9HQ0NxR1NNNDkKQXdFSG9VUURRZ0FFOUc2Q2NVeXZaQmpjZ2tkZWpvOGNMQisvVVJHc29ZKzY4dHBuL2l2a0J4OUVjZzZuZG9LZwpabWs0RkNWTlBQUkdMWHRQaFRMNGE5K29TSGpTNEhuUnRRPT0KLS0tLS1FTkQgRUMgUFJJVkFURSBLRVktLS0tLQo=
kind: Secret
metadata:
creationTimestamp: "2025-06-18T18:48:49Z"
labels:
app: deckhouse
heritage: deckhouse
module: deckhouse
name: admission-webhook-certs
namespace: d8-system
---
apiVersion: v1
data:
ca.crt: LS0tLS1CRUdJTiBDRVJUSUZJQ0FURS0tLS0tCk1JSUJpRENDQVM2Z0F3SUJBZ0lVV3VXcVhMQ1ZnWXVSaVNmZVZvT3RHMG9vU3pZd0NnWUlLb1pJemowRUF3SXcKSWpFZ01CNEdBMVVFQXhNWFpHVmphMmh2ZFhObExtUTRMWE41YzNSbGJTNXpkbU13SGhjTk1qVXdOakU0TVRnMApOREF3V2hjTk16VXdOakUyTVRnME5EQXdXakFpTVNBd0hnWURWUVFERXhka1pXTnJhRzkxYzJVdVpEZ3RjM2x6CmRHVnRMbk4yWXpCWk1CTUdCeXFHU000OUFnRUdDQ3FHU000OUF3RUhBMElBQkM0N3h1WCs2VkhvVVVpaG9VSUsKbzY1QzR2OVU5UjV5dXZLQUN3SlJ3bFoxUGs1MGR2aXFFNHJjbXRsdTRsZkRPSW9qaFlJN3ZUS1piMVByVTY3MgpTSHVqUWpCQU1BNEdBMVVkRHdFQi93UUVBd0lCQmpBUEJnTlZIUk1CQWY4RUJUQURBUUgvTUIwR0ExVWREZ1FXCkJCVDF1U3JvYjNJeHpaNlJOc042dEFjTGlyUGt3REFLQmdncWhrak9QUVFEQWdOSUFEQkZBaUJ6YTVSS3p0RDYKRmJuT2NOTm5ncjhQazhrME4vcGtzTGNiemZXd3NCN0lVQUloQU5tMjNMSzczNVJ0c3F4TGhGNmtyTCtlZmJicgpBbU9jSmpWdGwvNWc5aEhhCi0tLS0tRU5EIENFUlRJRklDQVRFLS0tLS0K
tls.crt: LS0tLS1CRUdJTiBDRVJUSUZJQ0FURS0tLS0tCk1JSUIwakNDQVhpZ0F3SUJBZ0lVVk5uZTJHaE1vV2k2RUdSVlh3bW1Kak1OdU40d0NnWUlLb1pJemowRUF3SXcKSWpFZ01CNEdBMVVFQXhNWFpHVmphMmh2ZFhObExtUTRMWE41YzNSbGJTNXpkbU13SGhjTk1qVXdOakU0TVRnMApOREF3V2hjTk16VXdOakUyTVRnME5EQXdXakFpTVNBd0hnWURWUVFERXhka1pXTnJhRzkxYzJVdVpEZ3RjM2x6CmRHVnRMbk4yWXpCWk1CTUdCeXFHU000OUFnRUdDQ3FHU000OUF3RUhBMElBQlBSdWduRk1yMlFZM0lKSFhvNlAKSEN3ZnYxRVJyS0dQdXZMYVovNHI1QWNmUkhJT3AzYUNvR1pwT0JRbFRUejBSaTE3VDRVeStHdmZxRWg0MHVCNQowYldqZ1lzd2dZZ3dEZ1lEVlIwUEFRSC9CQVFEQWdXZ01Bd0dBMVVkRXdFQi93UUNNQUF3SFFZRFZSME9CQllFCkZPMmpYOXE5MDc0WHdkNU90RFVhOE9vaXJiNEtNRWtHQTFVZEVRUkNNRUNDRjJSbFkydG9iM1Z6WlM1a09DMXoKZVhOMFpXMHVjM1pqZ2lWa1pXTnJhRzkxYzJVdVpEZ3RjM2x6ZEdWdExuTjJZeTVqYkhWemRHVnlMbXh2WTJGcwpNQW9HQ0NxR1NNNDlCQU1DQTBnQU1FVUNJUUN6dEJGbEY2eEpueHYyS3hrNHNqam5mQjQ1YjRmdjNsTFJYVkp6CmZmL2lsZ0lnTXQvM3pHSXRqVndlV3B1eDdyZnN0RkxxalhtZmkwRk4xL3ZwWGtOTEljZz0KLS0tLS1FTkQgQ0VSVElGSUNBVEUtLS0tLQo=
tls.key: LS0tLS1CRUdJTiBFQyBQUklWQVRFIEtFWS0tLS0tCk1IY0NBUUVFSUdIUUdieWlDdlV2WDdiUUhBbmZ2YkExbVdBLy9ESjlUdC83WW94akMvZ2dvQW9HQ0NxR1NNNDkKQXdFSG9VUURRZ0FFOUc2Q2NVeXZaQmpjZ2tkZWpvOGNMQisvVVJHc29ZKzY4dHBuL2l2a0J4OUVjZzZuZG9LZwpabWs0RkNWTlBQUkdMWHRQaFRMNGE5K29TSGpTNEhuUnRRPT0KLS0tLS1FTkQgRUMgUFJJVkFURSBLRVktLS0tLQo=
kind: Secret
metadata:
creationTimestamp: "2025-06-18T18:48:49Z"
labels:
app: deckhouse
heritage: deckhouse
module: deckhouse
name: admission-webhook-certs
namespace: d8-system
`,
}})

values := mock.NewPatchableValuesCollectorMock(t)

values.GetMock.When("global.discovery.clusterDomain").Then(gjson.Result{Type: gjson.String, Str: "cluster.local"})
values.GetMock.When("global.modules.publicDomainTemplate").Then(gjson.Result{Type: gjson.String, Str: "%s.127.0.0.1.sslip.io"})

values.SetMock.Set(func(path string, value any) {
assert.Equal(t, "d8-example-module.internal.webhookCert", path)
assert.NotEmpty(t, value)
})

input := helpers.NewHookInput(t)
input.Snapshots = snaps
input.Values = values

config := tlscertificate.GenSelfSignedTLSHookConf{
CN: "cert-name",
TLSSecretName: "secret-webhook-cert",
Namespace: "some-namespace",
SANs: tlscertificate.DefaultSANs([]string{
"example-webhook",
"example-webhook.d8-example-module",
"example-webhook.d8-example-module.svc",
"%CLUSTER_DOMAIN%://example-webhook.d8-example-module.svc",
"%PUBLIC_DOMAIN%://example-webhook.d8-example-module.svc",
}),
FullValuesPathPrefix: "d8-example-module.internal.webhookCert",
}

err := tlscertificate.GenSelfSignedTLS(config)(context.Background(), input)
assert.NoError(t, err)
})
}
3 changes: 3 additions & 0 deletions examples/example-module/hooks/go.mod
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -41,6 +41,8 @@ require (
github.com/google/uuid v1.6.0 // indirect
github.com/imdario/mergo v0.3.16 // indirect
github.com/inconshreveable/mousetrap v1.1.0 // indirect
github.com/itchyny/gojq v0.12.17 // indirect
github.com/itchyny/timefmt-go v0.1.6 // indirect
github.com/jonboulle/clockwork v0.4.0 // indirect
github.com/josharian/intern v1.0.0 // indirect
github.com/json-iterator/go v1.1.12 // indirect
Expand All @@ -62,6 +64,7 @@ require (
github.com/sirupsen/logrus v1.9.3 // indirect
github.com/spf13/cobra v1.9.1 // indirect
github.com/spf13/pflag v1.0.6 // indirect
github.com/stretchr/testify v1.10.0 // indirect
github.com/sylabs/oci-tools v0.7.0 // indirect
github.com/tidwall/match v1.1.1 // indirect
github.com/tidwall/pretty v1.2.0 // indirect
Expand Down
4 changes: 4 additions & 0 deletions examples/example-module/hooks/go.sum
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -88,6 +88,10 @@ github.com/imdario/mergo v0.3.16 h1:wwQJbIsHYGMUyLSPrEq1CT16AhnhNJQ51+4fdHUnCl4=
github.com/imdario/mergo v0.3.16/go.mod h1:WBLT9ZmE3lPoWsEzCh9LPo3TiwVN+ZKEjmz+hD27ysY=
github.com/inconshreveable/mousetrap v1.1.0 h1:wN+x4NVGpMsO7ErUn/mUI3vEoE6Jt13X2s0bqwp9tc8=
github.com/inconshreveable/mousetrap v1.1.0/go.mod h1:vpF70FUmC8bwa3OWnCshd2FqLfsEA9PFc4w1p2J65bw=
github.com/itchyny/gojq v0.12.17 h1:8av8eGduDb5+rvEdaOO+zQUjA04MS0m3Ps8HiD+fceg=
github.com/itchyny/gojq v0.12.17/go.mod h1:WBrEMkgAfAGO1LUcGOckBl5O726KPp+OlkKug0I/FEY=
github.com/itchyny/timefmt-go v0.1.6 h1:ia3s54iciXDdzWzwaVKXZPbiXzxxnv1SPGFfM/myJ5Q=
github.com/itchyny/timefmt-go v0.1.6/go.mod h1:RRDZYC5s9ErkjQvTvvU7keJjxUYzIISJGxm9/mAERQg=
github.com/jonboulle/clockwork v0.4.0 h1:p4Cf1aMWXnXAUh8lVfewRBx1zaTSYKrKMF2g3ST4RZ4=
github.com/jonboulle/clockwork v0.4.0/go.mod h1:xgRqUGwRcjKCO1vbZUEtSLrqKoPSsUpK7fnezOII0kc=
github.com/josharian/intern v1.0.0 h1:vlS4z54oSdjm0bgjRigI+G1HpF+tI+9rE5LLzOg8HmY=
Expand Down
121 changes: 54 additions & 67 deletions examples/example-module/hooks/subfolder/patch_hook_test.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -4,30 +4,32 @@ import (
"bytes"
"context"
"strings"
"testing"
"time"

. "github.com/onsi/ginkgo"
. "github.com/onsi/gomega"
corev1 "k8s.io/api/core/v1"
metav1 "k8s.io/apimachinery/pkg/apis/meta/v1"

"github.com/deckhouse/deckhouse/pkg/log"

"github.com/deckhouse/module-sdk/pkg"
"github.com/deckhouse/module-sdk/testing/mock"
testinghelpers "github.com/deckhouse/module-sdk/testing/helpers"

subfolder "example-module/subfolder"
)

var _ = Describe("patch hook", func() {
Context("HandlerHookPatch function", func() {
var (
patchCollector *mock.PatchCollectorMock
buf *bytes.Buffer
input *pkg.HookInput
patchCollector pkg.OutputPatchCollector

buf *bytes.Buffer
input *pkg.HookInput
)

BeforeEach(func() {
patchCollector = mock.NewPatchCollectorMock(GinkgoT())
buf = bytes.NewBuffer([]byte{})

input = &pkg.HookInput{
Expand All @@ -45,68 +47,53 @@ var _ = Describe("patch hook", func() {
})

It("logs hello message and executes patch collector operations", func() {
// Set expectations for Create
patchCollector.CreateMock.Set(func(obj any) {
pod, ok := obj.(*corev1.Pod)
Expect(ok).To(BeTrue())
Expect(pod.Name).To(Equal("my-first-pod"))
Expect(pod.Namespace).To(Equal("default"))
Expect(pod.Status.Phase).To(Equal(corev1.PodRunning))
})

// Set expectations for CreateOrUpdate
patchCollector.CreateOrUpdateMock.Set(func(obj any) {
pod, ok := obj.(*corev1.Pod)
Expect(ok).To(BeTrue())
Expect(pod.Name).To(Equal("my-second-pod"))
Expect(pod.Namespace).To(Equal("default"))
Expect(pod.Status.Phase).To(Equal(corev1.PodRunning))
})

// Set expectations for CreateIfNotExists
patchCollector.CreateIfNotExistsMock.Set(func(obj any) {
pod, ok := obj.(*corev1.Pod)
Expect(ok).To(BeTrue())
Expect(pod.Name).To(Equal("my-third-pod"))
Expect(pod.Namespace).To(Equal("default"))
Expect(pod.Status.Phase).To(Equal(corev1.PodRunning))
})

// Set expectations for Delete
patchCollector.DeleteMock.Set(func(apiVersion, kind, namespace, name string) {
Expect(apiVersion).To(Equal("v1"))
Expect(kind).To(Equal("Pod"))
Expect(namespace).To(Equal("default"))
Expect(name).To(Equal("my-first-pod"))
})

// Set expectations for DeleteInBackground
patchCollector.DeleteInBackgroundMock.Set(func(apiVersion, kind, namespace, name string) {
Expect(apiVersion).To(Equal("v1"))
Expect(kind).To(Equal("Pod"))
Expect(namespace).To(Equal("default"))
Expect(name).To(Equal("my-second-pod"))
})

// Set expectations for DeleteNonCascading
patchCollector.DeleteNonCascadingMock.Set(func(apiVersion, kind, namespace, name string) {
Expect(apiVersion).To(Equal("v1"))
Expect(kind).To(Equal("Pod"))
Expect(namespace).To(Equal("default"))
Expect(name).To(Equal("my-third-pod"))
})

// Set expectations for PatchWithMerge
patchCollector.PatchWithMergeMock.Set(func(mergePatch any, apiVersion, kind, namespace, name string, opts ...pkg.PatchCollectorOption) {
patchMap, ok := mergePatch.(map[string]any)
Expect(ok).To(BeTrue())
Expect(patchMap).To(HaveKeyWithValue("/status", "newStatus"))
Expect(apiVersion).To(Equal("v1"))
Expect(kind).To(Equal("Pod"))
Expect(namespace).To(Equal("default"))
Expect(name).To(Equal("my-third-pod"))
Expect(len(opts)).To(Equal(2))
})
input.PatchCollector = testinghelpers.PreparePatchCollector(&testing.T{},
testinghelpers.NewCreate(
&corev1.Pod{
ObjectMeta: metav1.ObjectMeta{
Name: "my-first-pod",
Namespace: "default",
},
Status: corev1.PodStatus{
Phase: corev1.PodRunning,
},
}),
testinghelpers.NewCreateOrUpdate(
&corev1.Pod{
ObjectMeta: metav1.ObjectMeta{
Name: "my-second-pod",
Namespace: "default",
},
Status: corev1.PodStatus{
Phase: corev1.PodRunning,
},
},
),
testinghelpers.NewCreateIfNotExists(
&corev1.Pod{
ObjectMeta: metav1.ObjectMeta{
Name: "my-third-pod",
Namespace: "default",
},
Status: corev1.PodStatus{
Phase: corev1.PodRunning,
},
},
),
testinghelpers.NewDelete(
"v1", "Pod", "default", "my-first-pod",
),
testinghelpers.NewDeleteInBackground(
"v1", "Pod", "default", "my-second-pod",
),
testinghelpers.NewDeleteNonCascading(
"v1", "Pod", "default", "my-third-pod",
),
testinghelpers.NewPatchWithMerge(
map[string]any{"/status": "newStatus"},
"v1", "Pod", "default", "my-third-pod",
),
)

// Execute the handler function
err := subfolder.HandlerHookPatch(context.Background(), input)
Expand Down
Loading
Loading