URL: https://github.com/freeipa/freeipa/pull/4968
Author: rcritten
Title: #4968: [Backport][ipa-4-8] ipatests: verify that all services can be
detected by healthcheck
Action: opened
PR body:
"""
This PR was opened because PR #4944 was pushed to master and backport to
ipa-4-8 is required.
Manual PR but this was a clean cherry-pick so adding ack.
"""
To pull the PR as Git branch:
git remote add ghfreeipa https://github.com/freeipa/freeipa
git fetch ghfreeipa pull/4968/head:pr4968
git checkout pr4968
From c0130634b1123089d9c5a3ce862ac0c23b8c2025 Mon Sep 17 00:00:00 2001
From: Rob Crittenden <rcrit...@redhat.com>
Date: Wed, 22 Jul 2020 11:45:05 -0400
Subject: [PATCH] ipatests: verify that all services can be detected by
healthcheck
Add fixture to handle restarting services so that if something
goes wrong in the test the service(s) will all be restarted
so that subsequent tests can pass. Services are restarted in
reverse order.
Reviewed-By: Francois Cami <fc...@redhat.com>
Reviewed-By: Florence Blanc-Renaud <f...@redhat.com>
---
.../test_integration/test_ipahealthcheck.py | 120 ++++++++++++------
1 file changed, 79 insertions(+), 41 deletions(-)
diff --git a/ipatests/test_integration/test_ipahealthcheck.py b/ipatests/test_integration/test_ipahealthcheck.py
index dca8594cc2..db3274f5f7 100644
--- a/ipatests/test_integration/test_ipahealthcheck.py
+++ b/ipatests/test_integration/test_ipahealthcheck.py
@@ -14,7 +14,6 @@
import pytest
-from ipalib import api
from ipalib import x509
from ipapython.ipaldap import realm_to_serverid
from ipapython.certdb import NSS_SQL_FILES
@@ -161,6 +160,36 @@ def run_healthcheck(host, source=None, check=None, output_type="json",
return result.returncode, data
+@pytest.fixture
+def restart_service():
+ """Shut down and restart a service as a fixture"""
+
+ service = dict()
+
+ def _stop_service(host, service_name):
+ service_name = service_name.replace('_', '-')
+ if service_name == 'pki-tomcatd':
+ service_name = 'pki-tomcatd@pki-tomcat'
+ elif service_name == 'dirsrv':
+ serverid = (realm_to_serverid(host.domain.realm)).upper()
+ service_name = 'dirsrv@%s.service' % serverid
+ elif service_name == 'named':
+ service_name = 'named-pkcs11'
+ if 'host' not in service:
+ service['host'] = host
+ service['name'] = [service_name]
+ else:
+ service['name'].append(service_name)
+ host.run_command(["systemctl", "stop", service_name])
+
+ yield _stop_service
+
+ if service.get('name'):
+ service.get('name', []).reverse()
+ for name in service.get('name', []):
+ service.get('host').run_command(["systemctl", "start", name])
+
+
class TestIpaHealthCheck(IntegrationTest):
"""
Tier-1 test for ipa-healthcheck tool with IPA Master setup with
@@ -196,23 +225,21 @@ def test_run_ipahealthcheck_list_source(self):
for source in sources:
assert source in result.stdout_text
- def test_human_output(self):
+ def test_human_output(self, restart_service):
"""
Test that in human output the severity value is correct
Only the SUCCESS (0) value was being translated, otherwise
the numeric value was being shown (BZ 1752849)
"""
- self.master.run_command(["systemctl", "stop", "sssd"])
- try:
- returncode, output = run_healthcheck(
- self.master,
- "ipahealthcheck.meta.services",
- "sssd",
- "human",
- )
- finally:
- self.master.run_command(["systemctl", "start", "sssd"])
+ restart_service(self.master, "sssd")
+
+ returncode, output = run_healthcheck(
+ self.master,
+ "ipahealthcheck.meta.services",
+ "sssd",
+ "human",
+ )
assert returncode == 1
assert output == \
@@ -262,33 +289,46 @@ def test_ipa_trust_check_exists(self):
for check in ipatrust_checks:
assert check in result.stdout_text
- def test_source_ipahealthcheck_meta_services_check_sssd(self):
+ def test_source_ipahealthcheck_meta_services_check(self, restart_service):
"""
- Testcase checks behaviour of check sssd in
+ Testcase checks behaviour of check configured services in
ipahealthcheck.meta.services when service is stopped and started
respectively
"""
- self.master.run_command(["systemctl", "stop", "sssd"])
- returncode, data = run_healthcheck(
- self.master,
- "ipahealthcheck.meta.services",
- "sssd",
- )
- assert returncode == 1
- for check in data:
- assert check["result"] == "ERROR"
- assert check["kw"]["msg"] == "sssd: not running"
- assert check["kw"]["status"] is False
- self.master.run_command(["systemctl", "start", "sssd"])
- returncode, data = run_healthcheck(
- self.master,
- "ipahealthcheck.meta.services",
- "sssd",
- )
- assert returncode == 0
- assert data[0]["check"] == "sssd"
- assert data[0]["result"] == "SUCCESS"
- assert data[0]["kw"]["status"] is True
+ svc_list = ('certmonger', 'gssproxy', 'httpd', 'ipa_custodia',
+ 'ipa_dnskeysyncd', 'kadmin', 'krb5kdc',
+ 'named', 'pki_tomcatd', 'sssd', 'dirsrv')
+
+ for service in svc_list:
+ returncode, data = run_healthcheck(
+ self.master,
+ "ipahealthcheck.meta.services",
+ service,
+ )
+ assert returncode == 0
+ assert data[0]["check"] == service
+ assert data[0]["result"] == "SUCCESS"
+ assert data[0]["kw"]["status"] is True
+
+ for service in svc_list:
+ restart_service(self.master, service)
+ returncode, data = run_healthcheck(
+ self.master,
+ "ipahealthcheck.meta.services",
+ service,
+ )
+ assert returncode == 1
+ service_found = False
+ for check in data:
+ if check["check"] != service:
+ continue
+ if service != 'pki_tomcatd':
+ service = service.replace('_', '-')
+ assert check["result"] == "ERROR"
+ assert check["kw"]["msg"] == "%s: not running" % service
+ assert check["kw"]["status"] is False
+ service_found = True
+ assert service_found
def test_source_ipahealthcheck_dogtag_ca_dogtagcertsconfigcheck(self):
"""
@@ -369,7 +409,9 @@ def test_source_ipahealthcheck_meta_core_metacheck(self):
assert data[0]["kw"]["ipa_version"] in result.stdout_text
assert data[0]["kw"]["ipa_api_version"] in result.stdout_text
- def test_source_ipahealthcheck_ipa_host_check_ipahostkeytab(self):
+ def test_source_ipahealthcheck_ipa_host_check_ipahostkeytab(
+ self, restart_service
+ ):
"""
Testcase checks behaviour of check IPAHostKeytab in source
ipahealthcheck.ipa.host when dirsrv service is stopped and
@@ -381,11 +423,8 @@ def test_source_ipahealthcheck_ipa_host_check_ipahostkeytab(self):
"Minor code may provide more information, "
"Minor (2529638972): Generic error (see e-text)"
)
+ restart_service(self.master, "dirsrv")
dirsrv_ipactl_status = 'Directory Service: STOPPED'
- api.env.realm = self.master.domain.name
- serverid = (realm_to_serverid(api.env.realm)).upper()
- dirsrv_service = "dirsrv@%s.service" % serverid
- self.master.run_command(["systemctl", "stop", dirsrv_service])
result = self.master.run_command(
["ipactl", "status"])
returncode, data = run_healthcheck(
@@ -399,7 +438,6 @@ def test_source_ipahealthcheck_ipa_host_check_ipahostkeytab(self):
assert data[0]["kw"]["msg"] == msg
else:
assert data[0]["result"] == "SUCCESS"
- self.master.run_command(["systemctl", "start", dirsrv_service])
def test_source_ipahealthcheck_topology_IPATopologyDomainCheck(self):
"""
_______________________________________________
FreeIPA-devel mailing list -- freeipa-devel@lists.fedorahosted.org
To unsubscribe send an email to freeipa-devel-le...@lists.fedorahosted.org
Fedora Code of Conduct:
https://docs.fedoraproject.org/en-US/project/code-of-conduct/
List Guidelines: https://fedoraproject.org/wiki/Mailing_list_guidelines
List Archives:
https://lists.fedorahosted.org/archives/list/freeipa-devel@lists.fedorahosted.org
