487 lines
19 KiB
Python
487 lines
19 KiB
Python
import unittest
|
|
import time
|
|
import timeout_decorator
|
|
import subprocess
|
|
import warnings
|
|
import os
|
|
import yaml
|
|
|
|
from kubernetes import client, config
|
|
|
|
|
|
class EndToEndTestCase(unittest.TestCase):
|
|
'''
|
|
Test interaction of the operator with multiple K8s components.
|
|
'''
|
|
|
|
# `kind` pods may stuck in the `Terminating` phase for a few minutes; hence high test timeout
|
|
TEST_TIMEOUT_SEC = 600
|
|
|
|
@classmethod
|
|
@timeout_decorator.timeout(TEST_TIMEOUT_SEC)
|
|
def setUpClass(cls):
|
|
'''
|
|
Deploy operator to a "kind" cluster created by run.sh using examples from /manifests.
|
|
This operator deployment is to be shared among all tests.
|
|
|
|
run.sh deletes the 'kind' cluster after successful run along with all operator-related entities.
|
|
In the case of test failure the cluster will stay to enable manual examination;
|
|
next invocation of "make test" will re-create it.
|
|
'''
|
|
|
|
# set a single K8s wrapper for all tests
|
|
k8s = cls.k8s = K8s()
|
|
|
|
# operator deploys pod service account there on start up
|
|
# needed for test_multi_namespace_support()
|
|
cls.namespace = "test"
|
|
v1_namespace = client.V1Namespace(metadata=client.V1ObjectMeta(name=cls.namespace))
|
|
k8s.api.core_v1.create_namespace(v1_namespace)
|
|
|
|
# submit the most recent operator image built on the Docker host
|
|
with open("manifests/postgres-operator.yaml", 'r+') as f:
|
|
operator_deployment = yaml.safe_load(f)
|
|
operator_deployment["spec"]["template"]["spec"]["containers"][0]["image"] = os.environ['OPERATOR_IMAGE']
|
|
yaml.dump(operator_deployment, f, Dumper=yaml.Dumper)
|
|
|
|
for filename in ["operator-service-account-rbac.yaml",
|
|
"configmap.yaml",
|
|
"postgres-operator.yaml"]:
|
|
k8s.create_with_kubectl("manifests/" + filename)
|
|
|
|
k8s.wait_for_operator_pod_start()
|
|
|
|
actual_operator_image = k8s.api.core_v1.list_namespaced_pod(
|
|
'default', label_selector='name=postgres-operator').items[0].spec.containers[0].image
|
|
print("Tested operator image: {}".format(actual_operator_image)) # shows up after tests finish
|
|
|
|
k8s.create_with_kubectl("manifests/minimal-postgres-manifest.yaml")
|
|
k8s.wait_for_pod_start('spilo-role=master')
|
|
|
|
@timeout_decorator.timeout(TEST_TIMEOUT_SEC)
|
|
def test_enable_load_balancer(self):
|
|
'''
|
|
Test if services are updated when enabling/disabling load balancers
|
|
'''
|
|
|
|
k8s = self.k8s
|
|
cluster_label = 'version=acid-minimal-cluster'
|
|
|
|
# enable load balancer services
|
|
pg_patch_enable_lbs = {
|
|
"spec": {
|
|
"enableMasterLoadBalancer": True,
|
|
"enableReplicaLoadBalancer": True
|
|
}
|
|
}
|
|
k8s.api.custom_objects_api.patch_namespaced_custom_object(
|
|
"acid.zalan.do", "v1", "default", "postgresqls", "acid-minimal-cluster", pg_patch_enable_lbs)
|
|
# wait for service recreation
|
|
time.sleep(60)
|
|
|
|
master_svc_type = k8s.get_service_type(cluster_label + ',spilo-role=master')
|
|
self.assertEqual(master_svc_type, 'LoadBalancer',
|
|
"Expected LoadBalancer service type for master, found {}".format(master_svc_type))
|
|
|
|
repl_svc_type = k8s.get_service_type(cluster_label + ',spilo-role=replica')
|
|
self.assertEqual(repl_svc_type, 'LoadBalancer',
|
|
"Expected LoadBalancer service type for replica, found {}".format(repl_svc_type))
|
|
|
|
# disable load balancer services again
|
|
pg_patch_disable_lbs = {
|
|
"spec": {
|
|
"enableMasterLoadBalancer": False,
|
|
"enableReplicaLoadBalancer": False
|
|
}
|
|
}
|
|
k8s.api.custom_objects_api.patch_namespaced_custom_object(
|
|
"acid.zalan.do", "v1", "default", "postgresqls", "acid-minimal-cluster", pg_patch_disable_lbs)
|
|
# wait for service recreation
|
|
time.sleep(60)
|
|
|
|
master_svc_type = k8s.get_service_type(cluster_label + ',spilo-role=master')
|
|
self.assertEqual(master_svc_type, 'ClusterIP',
|
|
"Expected ClusterIP service type for master, found {}".format(master_svc_type))
|
|
|
|
repl_svc_type = k8s.get_service_type(cluster_label + ',spilo-role=replica')
|
|
self.assertEqual(repl_svc_type, 'ClusterIP',
|
|
"Expected ClusterIP service type for replica, found {}".format(repl_svc_type))
|
|
|
|
@timeout_decorator.timeout(TEST_TIMEOUT_SEC)
|
|
def test_min_resource_limits(self):
|
|
'''
|
|
Lower resource limits below configured minimum and let operator fix it
|
|
'''
|
|
k8s = self.k8s
|
|
cluster_label = 'version=acid-minimal-cluster'
|
|
_, failover_targets = k8s.get_pg_nodes(cluster_label)
|
|
|
|
# configure minimum boundaries for CPU and memory limits
|
|
minCPULimit = '500m'
|
|
minMemoryLimit = '500Mi'
|
|
patch_min_resource_limits = {
|
|
"data": {
|
|
"min_cpu_limit": minCPULimit,
|
|
"min_memory_limit": minMemoryLimit
|
|
}
|
|
}
|
|
k8s.update_config(patch_min_resource_limits)
|
|
|
|
# lower resource limits below minimum
|
|
pg_patch_resources = {
|
|
"spec": {
|
|
"resources": {
|
|
"requests": {
|
|
"cpu": "10m",
|
|
"memory": "50Mi"
|
|
},
|
|
"limits": {
|
|
"cpu": "200m",
|
|
"memory": "200Mi"
|
|
}
|
|
}
|
|
}
|
|
}
|
|
k8s.api.custom_objects_api.patch_namespaced_custom_object(
|
|
"acid.zalan.do", "v1", "default", "postgresqls", "acid-minimal-cluster", pg_patch_resources)
|
|
k8s.wait_for_master_failover(failover_targets)
|
|
|
|
pods = k8s.api.core_v1.list_namespaced_pod(
|
|
'default', label_selector='spilo-role=master,' + cluster_label).items
|
|
self.assert_master_is_unique()
|
|
masterPod = pods[0]
|
|
|
|
self.assertEqual(masterPod.spec.containers[0].resources.limits['cpu'], minCPULimit,
|
|
"Expected CPU limit {}, found {}"
|
|
.format(minCPULimit, masterPod.spec.containers[0].resources.limits['cpu']))
|
|
self.assertEqual(masterPod.spec.containers[0].resources.limits['memory'], minMemoryLimit,
|
|
"Expected memory limit {}, found {}"
|
|
.format(minMemoryLimit, masterPod.spec.containers[0].resources.limits['memory']))
|
|
|
|
@timeout_decorator.timeout(TEST_TIMEOUT_SEC)
|
|
def test_multi_namespace_support(self):
|
|
'''
|
|
Create a customized Postgres cluster in a non-default namespace.
|
|
'''
|
|
k8s = self.k8s
|
|
|
|
with open("manifests/complete-postgres-manifest.yaml", 'r+') as f:
|
|
pg_manifest = yaml.safe_load(f)
|
|
pg_manifest["metadata"]["namespace"] = self.namespace
|
|
yaml.dump(pg_manifest, f, Dumper=yaml.Dumper)
|
|
|
|
k8s.create_with_kubectl("manifests/complete-postgres-manifest.yaml")
|
|
k8s.wait_for_pod_start("spilo-role=master", self.namespace)
|
|
self.assert_master_is_unique(self.namespace, version="acid-test-cluster")
|
|
|
|
@timeout_decorator.timeout(TEST_TIMEOUT_SEC)
|
|
def test_scaling(self):
|
|
'''
|
|
Scale up from 2 to 3 and back to 2 pods by updating the Postgres manifest at runtime.
|
|
'''
|
|
k8s = self.k8s
|
|
labels = "version=acid-minimal-cluster"
|
|
|
|
k8s.wait_for_pg_to_scale(3)
|
|
self.assertEqual(3, k8s.count_pods_with_label(labels))
|
|
self.assert_master_is_unique()
|
|
|
|
k8s.wait_for_pg_to_scale(2)
|
|
self.assertEqual(2, k8s.count_pods_with_label(labels))
|
|
self.assert_master_is_unique()
|
|
|
|
@timeout_decorator.timeout(TEST_TIMEOUT_SEC)
|
|
def test_taint_based_eviction(self):
|
|
'''
|
|
Add taint "postgres=:NoExecute" to node with master. This must cause a failover.
|
|
'''
|
|
k8s = self.k8s
|
|
cluster_label = 'version=acid-minimal-cluster'
|
|
|
|
# get nodes of master and replica(s) (expected target of new master)
|
|
current_master_node, failover_targets = k8s.get_pg_nodes(cluster_label)
|
|
num_replicas = len(failover_targets)
|
|
|
|
# if all pods live on the same node, failover will happen to other worker(s)
|
|
failover_targets = [x for x in failover_targets if x != current_master_node]
|
|
if len(failover_targets) == 0:
|
|
nodes = k8s.api.core_v1.list_node()
|
|
for n in nodes.items:
|
|
if "node-role.kubernetes.io/master" not in n.metadata.labels and n.metadata.name != current_master_node:
|
|
failover_targets.append(n.metadata.name)
|
|
|
|
# taint node with postgres=:NoExecute to force failover
|
|
body = {
|
|
"spec": {
|
|
"taints": [
|
|
{
|
|
"effect": "NoExecute",
|
|
"key": "postgres"
|
|
}
|
|
]
|
|
}
|
|
}
|
|
|
|
# patch node and test if master is failing over to one of the expected nodes
|
|
k8s.api.core_v1.patch_node(current_master_node, body)
|
|
k8s.wait_for_master_failover(failover_targets)
|
|
k8s.wait_for_pod_start('spilo-role=replica,' + cluster_label)
|
|
|
|
new_master_node, new_replica_nodes = k8s.get_pg_nodes(cluster_label)
|
|
self.assertNotEqual(current_master_node, new_master_node,
|
|
"Master on {} did not fail over to one of {}".format(current_master_node, failover_targets))
|
|
self.assertEqual(num_replicas, len(new_replica_nodes),
|
|
"Expected {} replicas, found {}".format(num_replicas, len(new_replica_nodes)))
|
|
self.assert_master_is_unique()
|
|
|
|
# undo the tainting
|
|
body = {
|
|
"spec": {
|
|
"taints": []
|
|
}
|
|
}
|
|
k8s.api.core_v1.patch_node(new_master_node, body)
|
|
|
|
@timeout_decorator.timeout(TEST_TIMEOUT_SEC)
|
|
def test_logical_backup_cron_job(self):
|
|
'''
|
|
Ensure we can (a) create the cron job at user request for a specific PG cluster
|
|
(b) update the cluster-wide image for the logical backup pod
|
|
(c) delete the job at user request
|
|
|
|
Limitations:
|
|
(a) Does not run the actual batch job because there is no S3 mock to upload backups to
|
|
(b) Assumes 'acid-minimal-cluster' exists as defined in setUp
|
|
'''
|
|
|
|
k8s = self.k8s
|
|
|
|
# create the cron job
|
|
schedule = "7 7 7 7 *"
|
|
pg_patch_enable_backup = {
|
|
"spec": {
|
|
"enableLogicalBackup": True,
|
|
"logicalBackupSchedule": schedule
|
|
}
|
|
}
|
|
k8s.api.custom_objects_api.patch_namespaced_custom_object(
|
|
"acid.zalan.do", "v1", "default", "postgresqls", "acid-minimal-cluster", pg_patch_enable_backup)
|
|
k8s.wait_for_logical_backup_job_creation()
|
|
|
|
jobs = k8s.get_logical_backup_job().items
|
|
self.assertEqual(1, len(jobs), "Expected 1 logical backup job, found {}".format(len(jobs)))
|
|
|
|
job = jobs[0]
|
|
self.assertEqual(job.metadata.name, "logical-backup-acid-minimal-cluster",
|
|
"Expected job name {}, found {}"
|
|
.format("logical-backup-acid-minimal-cluster", job.metadata.name))
|
|
self.assertEqual(job.spec.schedule, schedule,
|
|
"Expected {} schedule, found {}"
|
|
.format(schedule, job.spec.schedule))
|
|
|
|
# update the cluster-wide image of the logical backup pod
|
|
image = "test-image-name"
|
|
patch_logical_backup_image = {
|
|
"data": {
|
|
"logical_backup_docker_image": image,
|
|
}
|
|
}
|
|
k8s.update_config(patch_logical_backup_image)
|
|
|
|
jobs = k8s.get_logical_backup_job().items
|
|
actual_image = jobs[0].spec.job_template.spec.template.spec.containers[0].image
|
|
self.assertEqual(actual_image, image,
|
|
"Expected job image {}, found {}".format(image, actual_image))
|
|
|
|
# delete the logical backup cron job
|
|
pg_patch_disable_backup = {
|
|
"spec": {
|
|
"enableLogicalBackup": False,
|
|
}
|
|
}
|
|
k8s.api.custom_objects_api.patch_namespaced_custom_object(
|
|
"acid.zalan.do", "v1", "default", "postgresqls", "acid-minimal-cluster", pg_patch_disable_backup)
|
|
k8s.wait_for_logical_backup_job_deletion()
|
|
jobs = k8s.get_logical_backup_job().items
|
|
self.assertEqual(0, len(jobs),
|
|
"Expected 0 logical backup jobs, found {}".format(len(jobs)))
|
|
|
|
@timeout_decorator.timeout(TEST_TIMEOUT_SEC)
|
|
def test_service_annotations(self):
|
|
'''
|
|
Create a Postgres cluster with service annotations and check them.
|
|
'''
|
|
k8s = self.k8s
|
|
patch_custom_service_annotations = {
|
|
"data": {
|
|
"custom_service_annotations": "foo:bar",
|
|
}
|
|
}
|
|
k8s.update_config(patch_custom_service_annotations)
|
|
|
|
pg_patch_custom_annotations = {
|
|
"spec": {
|
|
"serviceAnnotations": {
|
|
"annotation.key": "value"
|
|
}
|
|
}
|
|
}
|
|
k8s.api.custom_objects_api.patch_namespaced_custom_object(
|
|
"acid.zalan.do", "v1", "default", "postgresqls", "acid-minimal-cluster", pg_patch_custom_annotations)
|
|
|
|
annotations = {
|
|
"annotation.key": "value",
|
|
"foo": "bar",
|
|
}
|
|
self.assertTrue(k8s.check_service_annotations(
|
|
"version=acid-service-annotations,spilo-role=master", annotations))
|
|
self.assertTrue(k8s.check_service_annotations(
|
|
"version=acid-service-annotations,spilo-role=replica", annotations))
|
|
|
|
# clean up
|
|
unpatch_custom_service_annotations = {
|
|
"data": {
|
|
"custom_service_annotations": "",
|
|
}
|
|
}
|
|
k8s.update_config(unpatch_custom_service_annotations)
|
|
|
|
def assert_master_is_unique(self, namespace='default', version="acid-minimal-cluster"):
|
|
'''
|
|
Check that there is a single pod in the k8s cluster with the label "spilo-role=master"
|
|
To be called manually after operations that affect pods
|
|
'''
|
|
|
|
k8s = self.k8s
|
|
labels = 'spilo-role=master,version=' + version
|
|
|
|
num_of_master_pods = k8s.count_pods_with_label(labels, namespace)
|
|
self.assertEqual(num_of_master_pods, 1, "Expected 1 master pod, found {}".format(num_of_master_pods))
|
|
|
|
|
|
class K8sApi:
|
|
|
|
def __init__(self):
|
|
|
|
# https://github.com/kubernetes-client/python/issues/309
|
|
warnings.simplefilter("ignore", ResourceWarning)
|
|
|
|
self.config = config.load_kube_config()
|
|
self.k8s_client = client.ApiClient()
|
|
|
|
self.core_v1 = client.CoreV1Api()
|
|
self.apps_v1 = client.AppsV1Api()
|
|
self.batch_v1_beta1 = client.BatchV1beta1Api()
|
|
self.custom_objects_api = client.CustomObjectsApi()
|
|
|
|
|
|
class K8s:
|
|
'''
|
|
Wraps around K8 api client and helper methods.
|
|
'''
|
|
|
|
RETRY_TIMEOUT_SEC = 5
|
|
|
|
def __init__(self):
|
|
self.api = K8sApi()
|
|
|
|
def get_pg_nodes(self, pg_cluster_name, namespace='default'):
|
|
master_pod_node = ''
|
|
replica_pod_nodes = []
|
|
podsList = self.api.core_v1.list_namespaced_pod(namespace, label_selector=pg_cluster_name)
|
|
for pod in podsList.items:
|
|
if pod.metadata.labels.get('spilo-role') == 'master':
|
|
master_pod_node = pod.spec.node_name
|
|
elif pod.metadata.labels.get('spilo-role') == 'replica':
|
|
replica_pod_nodes.append(pod.spec.node_name)
|
|
|
|
return master_pod_node, replica_pod_nodes
|
|
|
|
def wait_for_operator_pod_start(self):
|
|
self. wait_for_pod_start("name=postgres-operator")
|
|
# HACK operator must register CRD / add existing PG clusters after pod start up
|
|
# for local execution ~ 10 seconds suffices
|
|
time.sleep(60)
|
|
|
|
def wait_for_pod_start(self, pod_labels, namespace='default'):
|
|
pod_phase = 'No pod running'
|
|
while pod_phase != 'Running':
|
|
pods = self.api.core_v1.list_namespaced_pod(namespace, label_selector=pod_labels).items
|
|
if pods:
|
|
pod_phase = pods[0].status.phase
|
|
time.sleep(self.RETRY_TIMEOUT_SEC)
|
|
|
|
def get_service_type(self, svc_labels, namespace='default'):
|
|
svc_type = ''
|
|
svcs = self.api.core_v1.list_namespaced_service(namespace, label_selector=svc_labels, limit=1).items
|
|
for svc in svcs:
|
|
svc_type = svc.spec.type
|
|
return svc_type
|
|
|
|
def check_service_annotations(self, svc_labels, annotations, namespace='default'):
|
|
svcs = self.api.core_v1.list_namespaced_service(namespace, label_selector=svc_labels, limit=1).items
|
|
for svc in svcs:
|
|
if len(svc.metadata.annotations) != len(annotations):
|
|
return False
|
|
for key in svc.metadata.annotations:
|
|
if svc.metadata.annotations[key] != annotations[key]:
|
|
return False
|
|
return True
|
|
|
|
def wait_for_pg_to_scale(self, number_of_instances, namespace='default'):
|
|
|
|
body = {
|
|
"spec": {
|
|
"numberOfInstances": number_of_instances
|
|
}
|
|
}
|
|
_ = self.api.custom_objects_api.patch_namespaced_custom_object(
|
|
"acid.zalan.do", "v1", namespace, "postgresqls", "acid-minimal-cluster", body)
|
|
|
|
labels = 'version=acid-minimal-cluster'
|
|
while self.count_pods_with_label(labels) != number_of_instances:
|
|
time.sleep(self.RETRY_TIMEOUT_SEC)
|
|
|
|
def count_pods_with_label(self, labels, namespace='default'):
|
|
return len(self.api.core_v1.list_namespaced_pod(namespace, label_selector=labels).items)
|
|
|
|
def wait_for_master_failover(self, expected_master_nodes, namespace='default'):
|
|
pod_phase = 'Failing over'
|
|
new_master_node = ''
|
|
labels = 'spilo-role=master,version=acid-minimal-cluster'
|
|
|
|
while (pod_phase != 'Running') or (new_master_node not in expected_master_nodes):
|
|
pods = self.api.core_v1.list_namespaced_pod(namespace, label_selector=labels).items
|
|
if pods:
|
|
new_master_node = pods[0].spec.node_name
|
|
pod_phase = pods[0].status.phase
|
|
time.sleep(self.RETRY_TIMEOUT_SEC)
|
|
|
|
def get_logical_backup_job(self, namespace='default'):
|
|
return self.api.batch_v1_beta1.list_namespaced_cron_job(namespace, label_selector="application=spilo")
|
|
|
|
def wait_for_logical_backup_job(self, expected_num_of_jobs):
|
|
while (len(self.get_logical_backup_job().items) != expected_num_of_jobs):
|
|
time.sleep(self.RETRY_TIMEOUT_SEC)
|
|
|
|
def wait_for_logical_backup_job_deletion(self):
|
|
self.wait_for_logical_backup_job(expected_num_of_jobs=0)
|
|
|
|
def wait_for_logical_backup_job_creation(self):
|
|
self.wait_for_logical_backup_job(expected_num_of_jobs=1)
|
|
|
|
def update_config(self, config_map_patch):
|
|
self.api.core_v1.patch_namespaced_config_map("postgres-operator", "default", config_map_patch)
|
|
|
|
operator_pod = self.api.core_v1.list_namespaced_pod(
|
|
'default', label_selector="name=postgres-operator").items[0].metadata.name
|
|
self.api.core_v1.delete_namespaced_pod(operator_pod, "default") # restart reloads the conf
|
|
self.wait_for_operator_pod_start()
|
|
|
|
def create_with_kubectl(self, path):
|
|
subprocess.run(["kubectl", "create", "-f", path])
|
|
|
|
|
|
if __name__ == '__main__':
|
|
unittest.main()
|