Skip to content

WIP: Add tests for basic backup operations #4

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
l00ptr wants to merge 2 commits into
base: main
Choose a base branch
from
Open

WIP: Add tests for basic backup operations #4

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
e179781
WIP: Add tests for basic backup operations
Apr 7, 2025
37e1d77
Share kubernetes client between e2e tests & setup()
Apr 9, 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
58 changes: 32 additions & 26 deletions test/e2e/e2e_test.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -10,6 +10,7 @@ import (
"os"
"reflect"
"testing"
"time"

"github.com/dalibo/cnpg-i-pgbackrest/test/e2e/internal/certmanager"
"github.com/dalibo/cnpg-i-pgbackrest/test/e2e/internal/cluster"
Expand All @@ -26,34 +27,37 @@ import (
"sigs.k8s.io/controller-runtime/pkg/log/zap"
)

var cl *kubernetes.K8sClient

// Deploy CNGP operator, certmanager, minio and our plugins
func setup() error {
k8sClient, err := kubernetes.Client()
var err error
cl, err = kubernetes.Client()
if err != nil {
panic("can't init kubernetes client")
}
s := kubernetes.InstallSpec{ManifestUrl: "https://raw.githubusercontent.com/cloudnative-pg/cloudnative-pg/release-1.25/releases/cnpg-1.25.1.yaml"}
if err := cnpg.Install(*k8sClient, s); err != nil {
if err := cnpg.Install(*cl, s); err != nil {
panic("can't install CNPG")
}
s = kubernetes.InstallSpec{ManifestUrl: "https://github.com/cert-manager/cert-manager/releases/download/v1.16.2/cert-manager.yaml"}
if err := certmanager.Install(*k8sClient, s); err != nil {
if err := certmanager.Install(*cl, s); err != nil {
panic("can't install certmanager")
}
if err = minio.Install(*k8sClient); err != nil {
if err = minio.Install(*cl); err != nil {
panic("can't install minio")
}
// install our pgbackrest plugin from kubernetes directory at the root
// of the repository
path, err := os.Getwd()
s = kubernetes.InstallSpec{ManifestUrl: path + "/../../kubernetes"}
if err := pgbackrest.Install(*k8sClient, s); err != nil {
if err := pgbackrest.Install(*cl, s); err != nil {
panic("can't deploy plugin")
}
return nil
}

func createSecret(ctx context.Context, k8sClient *kubernetes.K8sClient, namespace string) (*v1.Secret, error) {
func createSecret(ctx context.Context, cl *kubernetes.K8sClient, namespace string) (*v1.Secret, error) {
// TODO: move that ?
secret := &v1.Secret{
TypeMeta: metav1.TypeMeta{
Expand All @@ -70,7 +74,7 @@ func createSecret(ctx context.Context, k8sClient *kubernetes.K8sClient, namespac
"key-secret": minio.SECRET_KEY,
},
}
return secret, k8sClient.Create(ctx, secret)
return secret, cl.Create(ctx, secret)
}

func teardown() {
Expand All @@ -86,15 +90,9 @@ func TestMain(m *testing.M) {

func TestInstall(t *testing.T) {
logcr.SetLogger(zap.New(zap.WriteTo(os.Stdout), zap.UseDevMode(true)))
// basic verification to ensure our plugin is present
k8sClient, err := kubernetes.Client()
if k8sClient == nil || err != nil {
t.Errorf("error kubernetes client not initialized")
}
// basic check for deployment
fqdn := types.NamespacedName{Name: "pgbackrest-controller", Namespace: "cnpg-system"}
obj := &appsv1.Deployment{}
k8sClient.Get(context.TODO(), fqdn, obj)
cl.Get(context.TODO(), fqdn, obj)
var want int32 = 1
got := obj.Status.ReadyReplicas
if got != want {
Expand All @@ -104,7 +102,7 @@ func TestInstall(t *testing.T) {
// verify service creation
fqdn = types.NamespacedName{Name: "pgbackrest", Namespace: "cnpg-system"}
svc := &corev1.Service{}
err = k8sClient.Get(context.TODO(), fqdn, svc)
err := cl.Get(context.TODO(), fqdn, svc)
if err != nil {
t.Errorf("error no service for pgbackrest found %s", err.Error())
}
Expand All @@ -115,20 +113,16 @@ func TestInstall(t *testing.T) {
if !reflect.DeepEqual(svc.Labels, want_labels) {
t.Errorf("error labels not valid %v", svc.Labels)
}
k8sClient.Get(context.TODO(), fqdn, obj)
cl.Get(context.TODO(), fqdn, obj)
}

// basic verification to ensure we can use our plugin with a cluster
func TestDeployInstance(t *testing.T) {
logcr.SetLogger(zap.New(zap.WriteTo(os.Stdout), zap.UseDevMode(true)))
k8sClient, err := kubernetes.Client()
if k8sClient == nil || err != nil {
t.Errorf("error kubernetes client not initialized")
}
ns := "default"
ctx := context.TODO()
// first create a secret
secret, err := createSecret(ctx, k8sClient, ns)
secret, err := createSecret(ctx, cl, ns)
if err != nil {
t.Error(err.Error())
}
Expand All @@ -137,18 +131,30 @@ func TestDeployInstance(t *testing.T) {
clusterName := "cluster-demo"
p := maps.Clone(cluster.DefaultParamater)
p["s3-repo-path"] = "/" + clusterName
c, err := cluster.Create(k8sClient, ns, clusterName, 1, "100M", p)
c, err := cluster.Create(cl, ns, clusterName, 1, "100M", p)
if err != nil {
t.Error(err.Error())
}
if ready, err := k8sClient.PodsIsReady(ns, clusterName+"-1", 30, 2); err != nil {
if ready, err := cl.PodsIsReady(ns, clusterName+"-1", 30, 2); err != nil {
t.Errorf("error when requesting pod status, %s", err.Error())
} else if !ready {
t.Error("pod not ready")
}
// more verification can be done here (before deleting the cluster)

// Verify we can backup our cluster
backupName := types.NamespacedName{Name: "backup-01", Namespace: ns}
backup, err := cluster.Backup(cl, clusterName, backupName)
if err != nil {
t.Error(err)
}
ctxTimeout, cancel := context.WithTimeout(context.TODO(), time.Minute*2)
defer cancel()
if err := cluster.BackupCompleted(ctxTimeout, cl, backupName, time.Second*2); err != nil {
t.Error(err)
}

// delete created ressources
k8sClient.Delete(ctx, c)
k8sClient.Delete(ctx, secret)
cl.Delete(ctx, backup)
cl.Delete(ctx, c)
cl.Delete(ctx, secret)
}
50 changes: 50 additions & 0 deletions test/e2e/internal/cluster/cluster.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -6,12 +6,16 @@ package cluster

import (
"context"
"fmt"
"time"

cloudnativepgv1 "github.com/cloudnative-pg/api/pkg/api/v1"
"github.com/dalibo/cnpg-i-pgbackrest/test/e2e/internal/kubernetes"
"github.com/dalibo/cnpg-i-pgbackrest/test/e2e/internal/minio"
corev1 "k8s.io/api/core/v1"
metav1 "k8s.io/apimachinery/pkg/apis/meta/v1"
"k8s.io/apimachinery/pkg/types"
"k8s.io/apimachinery/pkg/util/wait"
)

var DefaultParamater map[string]string = map[string]string{
Expand Down Expand Up @@ -60,3 +64,49 @@ func Create(k8sClient *kubernetes.K8sClient, namespace string, name string, nbrI
}
return m, nil
}

func Backup(cl *kubernetes.K8sClient, cluster string, namespacedName types.NamespacedName) (*cloudnativepgv1.Backup, error) {
b := cloudnativepgv1.Backup{
TypeMeta: metav1.TypeMeta{
Kind: "Backup",
APIVersion: "postgresql.cnpg.io/v1",
},
ObjectMeta: metav1.ObjectMeta{
Name: namespacedName.Name,
Namespace: namespacedName.Namespace,
},
Spec: cloudnativepgv1.BackupSpec{
Cluster: cloudnativepgv1.LocalObjectReference{
Name: cluster,
},
Method: "plugin",
PluginConfiguration: &cloudnativepgv1.BackupPluginConfiguration{
Name: "pgbackrest.dalibo.com",
},
},
}
if err := cl.Create(context.TODO(), &b); err != nil {
return nil, err
}
return &b, nil
}

// TODO: Make it more generic
func BackupCompleted(ctx context.Context, cl *kubernetes.K8sClient, namespacedName types.NamespacedName, retryInterval time.Duration) error {
waitedRessource := &cloudnativepgv1.Backup{}
errMsg := "unable to check if %s is completed, error: %w"
if err := wait.PollUntilContextCancel(ctx, retryInterval, false,
func(ctx context.Context) (bool, error) {
if err := cl.Get(ctx, namespacedName, waitedRessource); err != nil {
return false, fmt.Errorf(errMsg, namespacedName, err)
}
if waitedRessource.Status.Phase == cloudnativepgv1.BackupPhaseCompleted {
return true, nil
}
return false, nil
},
); err != nil {
return fmt.Errorf(errMsg, namespacedName, err)
}
return nil
}
Loading