URL: https://github.com/freeipa/freeipa/pull/1538
Author: tiran
Title: #1538: Replace hard-coded paths with path constants
Action: opened
PR body:
"""
Several run() calls used hard-coded paths rather than pre-defined paths
from ipaplatform.paths. The patch fixes all places that I was able to
find with a simple search.
Signed-off-by: Christian Heimes <chei...@redhat.com>
"""
To pull the PR as Git branch:
git remote add ghfreeipa https://github.com/freeipa/freeipa
git fetch ghfreeipa pull/1538/head:pr1538
git checkout pr1538
From f63e2dc563f836fb856cbf39842968ee9f443785 Mon Sep 17 00:00:00 2001
From: Christian Heimes <chei...@redhat.com>
Date: Wed, 7 Feb 2018 17:18:07 +0100
Subject: [PATCH] Replace hard-coded paths with path constants
Several run() calls used hard-coded paths rather than pre-defined paths
from ipaplatform.paths. The patch fixes all places that I was able to
find with a simple search.
Signed-off-by: Christian Heimes <chei...@redhat.com>
---
client/ipa-client-automount | 2 +-
install/tools/ipa-adtrust-install | 2 +-
install/tools/ipa-ca-install | 2 +-
install/tools/ipa-dns-install | 2 +-
ipaclient/install/client.py | 6 +++---
ipaplatform/base/paths.py | 4 ++++
ipapython/kernel_keyring.py | 24 +++++++++++++++-------
ipaserver/install/adtrustinstance.py | 6 ++++--
ipaserver/install/installutils.py | 17 ++++++++++-----
ipaserver/install/ipa_backup.py | 4 ++--
ipaserver/install/ipa_restore.py | 4 ++--
ipatests/pytest_plugins/integration/__init__.py | 3 ++-
ipatests/test_integration/test_caless.py | 2 +-
.../test_xmlrpc/test_caacl_profile_enforcement.py | 3 ++-
ipatests/test_xmlrpc/test_cert_plugin.py | 2 +-
15 files changed, 54 insertions(+), 29 deletions(-)
diff --git a/client/ipa-client-automount b/client/ipa-client-automount
index ee55d655c9..6c2816c410 100755
--- a/client/ipa-client-automount
+++ b/client/ipa-client-automount
@@ -92,7 +92,7 @@ def wait_for_sssd():
time.sleep(1)
while n < 10 and not found:
try:
- ipautil.run(["getent", "passwd", "admin@%s" % api.env.realm])
+ ipautil.run([paths.GETENT, "passwd", "admin@%s" % api.env.realm])
found = True
except Exception:
time.sleep(1)
diff --git a/install/tools/ipa-adtrust-install b/install/tools/ipa-adtrust-install
index d4e5d4c09c..6e0c60a042 100755
--- a/install/tools/ipa-adtrust-install
+++ b/install/tools/ipa-adtrust-install
@@ -110,7 +110,7 @@ def read_admin_password(admin_name):
def ensure_admin_kinit(admin_name, admin_password):
try:
- ipautil.run(['kinit', admin_name], stdin=admin_password+'\n')
+ ipautil.run([paths.KINIT, admin_name], stdin=admin_password+'\n')
except ipautil.CalledProcessError:
print("There was error to automatically re-kinit your admin user "
"ticket.")
diff --git a/install/tools/ipa-ca-install b/install/tools/ipa-ca-install
index 812dcb235e..212c432a1d 100755
--- a/install/tools/ipa-ca-install
+++ b/install/tools/ipa-ca-install
@@ -341,7 +341,7 @@ def main():
install(safe_options, options, filename)
# execute ipactl to refresh services status
- ipautil.run(['ipactl', 'start', '--ignore-service-failures'],
+ ipautil.run([paths.IPACTL, 'start', '--ignore-service-failures'],
raiseonerr=False)
api.Backend.ldap2.disconnect()
diff --git a/install/tools/ipa-dns-install b/install/tools/ipa-dns-install
index a7f136b16a..0e527b2e83 100755
--- a/install/tools/ipa-dns-install
+++ b/install/tools/ipa-dns-install
@@ -150,7 +150,7 @@ def main():
dns_installer.install(True, False, options)
# execute ipactl to refresh services status
- ipautil.run(['ipactl', 'start', '--ignore-service-failures'],
+ ipautil.run([paths.IPACTL, 'start', '--ignore-service-failures'],
raiseonerr=False)
api.Backend.ldap2.disconnect()
diff --git a/ipaclient/install/client.py b/ipaclient/install/client.py
index 5173d90bfe..2c7f2d3163 100644
--- a/ipaclient/install/client.py
+++ b/ipaclient/install/client.py
@@ -2576,7 +2576,7 @@ def _install(options):
subject_base = DN(subject_base)
if options.principal is not None:
- run(["kdestroy"], raiseonerr=False, env=env)
+ run([paths.KDESTROY], raiseonerr=False, env=env)
# Obtain the TGT. We do it with the temporary krb5.conf, so that
# only the KDC we're installing under is contacted.
@@ -2911,7 +2911,7 @@ def _install(options):
# Particulary, SSSD might take longer than 6-8 seconds.
while n < 10 and not found:
try:
- ipautil.run(["getent", "passwd", user])
+ ipautil.run([paths.GETENT, "passwd", user])
found = True
except Exception as e:
time.sleep(1)
@@ -2993,7 +2993,7 @@ def uninstall(options):
statestore = sysrestore.StateFile(paths.IPA_CLIENT_SYSRESTORE)
try:
- run(["ipa-client-automount", "--uninstall", "--debug"])
+ run([paths.IPA_CLIENT_AUTOMOUNT, "--uninstall", "--debug"])
except Exception as e:
logger.error(
"Unconfigured automount client failed: %s", str(e))
diff --git a/ipaplatform/base/paths.py b/ipaplatform/base/paths.py
index 3bb32416d6..58fc6bc7fd 100644
--- a/ipaplatform/base/paths.py
+++ b/ipaplatform/base/paths.py
@@ -159,6 +159,7 @@ class BasePathNamespace(object):
GPG = "/usr/bin/gpg"
GPG_AGENT = "/usr/bin/gpg-agent"
IPA_GETCERT = "/usr/bin/ipa-getcert"
+ KADMIN_LOCAL = '/usr/sbin/kadmin.local'
KDESTROY = "/usr/bin/kdestroy"
KINIT = "/usr/bin/kinit"
BIN_KVNO = "/usr/bin/kvno"
@@ -206,6 +207,7 @@ class BasePathNamespace(object):
GROUPADD = "/usr/sbin/groupadd"
USERMOD = "/usr/sbin/usermod"
HTTPD = "/usr/sbin/httpd"
+ IPA_CLIENT_AUTOMOUNT = "/usr/sbin/ipa-client-automount"
IPA_CLIENT_INSTALL = "/usr/sbin/ipa-client-install"
IPA_DNS_INSTALL = "/usr/sbin/ipa-dns-install"
SBIN_IPA_JOIN = "/usr/sbin/ipa-join"
@@ -360,6 +362,8 @@ class BasePathNamespace(object):
IF_INET6 = '/proc/net/if_inet6'
AUTHCONFIG = None
IPA_SERVER_UPGRADE = '/usr/sbin/ipa-server-upgrade'
+ KEYCTL = '/usr/bin/keyctl'
+ GETENT = '/usr/bin/getent'
paths = BasePathNamespace()
diff --git a/ipapython/kernel_keyring.py b/ipapython/kernel_keyring.py
index 651fd70866..5b64dd6609 100644
--- a/ipapython/kernel_keyring.py
+++ b/ipapython/kernel_keyring.py
@@ -21,6 +21,7 @@
import six
from ipapython.ipautil import run
+from ipaplatform.paths import paths
# NOTE: Absolute path not required for keyctl since we reset the environment
# in ipautil.run.
@@ -33,34 +34,38 @@
KEYRING = '@s'
KEYTYPE = 'user'
+
def dump_keys():
"""
Dump all keys
"""
- result = run(['keyctl', 'list', KEYRING], raiseonerr=False,
+ result = run([paths.KEYCTL, 'list', KEYRING], raiseonerr=False,
capture_output=True)
return result.output
+
def get_real_key(key):
"""
One cannot request a key based on the description it was created with
so find the one we're looking for.
"""
assert isinstance(key, six.string_types)
- result = run(['keyctl', 'search', KEYRING, KEYTYPE, key],
+ result = run([paths.KEYCTL, 'search', KEYRING, KEYTYPE, key],
raiseonerr=False, capture_output=True)
if result.returncode:
raise ValueError('key %s not found' % key)
return result.raw_output.rstrip()
+
def get_persistent_key(key):
assert isinstance(key, six.string_types)
- result = run(['keyctl', 'get_persistent', KEYRING, key],
+ result = run([paths.KEYCTL, 'get_persistent', KEYRING, key],
raiseonerr=False, capture_output=True)
if result.returncode:
raise ValueError('persistent key %s not found' % key)
return result.raw_output.rstrip()
+
def is_persistent_keyring_supported():
uid = os.geteuid()
try:
@@ -70,6 +75,7 @@ def is_persistent_keyring_supported():
return True
+
def has_key(key):
"""
Returns True/False whether the key exists in the keyring.
@@ -81,6 +87,7 @@ def has_key(key):
except ValueError:
return False
+
def read_key(key):
"""
Read the keyring and return the value for key.
@@ -89,13 +96,14 @@ def read_key(key):
"""
assert isinstance(key, six.string_types)
real_key = get_real_key(key)
- result = run(['keyctl', 'pipe', real_key], raiseonerr=False,
+ result = run([paths.KEYCTL, 'pipe', real_key], raiseonerr=False,
capture_output=True)
if result.returncode:
raise ValueError('keyctl pipe failed: %s' % result.error_log)
return result.raw_output
+
def update_key(key, value):
"""
Update the keyring data. If they key doesn't exist it is created.
@@ -104,13 +112,14 @@ def update_key(key, value):
assert isinstance(value, bytes)
if has_key(key):
real_key = get_real_key(key)
- result = run(['keyctl', 'pupdate', real_key], stdin=value,
+ result = run([paths.KEYCTL, 'pupdate', real_key], stdin=value,
raiseonerr=False)
if result.returncode:
raise ValueError('keyctl pupdate failed: %s' % result.error_log)
else:
add_key(key, value)
+
def add_key(key, value):
"""
Add a key to the kernel keyring.
@@ -119,18 +128,19 @@ def add_key(key, value):
assert isinstance(value, bytes)
if has_key(key):
raise ValueError('key %s already exists' % key)
- result = run(['keyctl', 'padd', KEYTYPE, key, KEYRING],
+ result = run([paths.KEYCTL, 'padd', KEYTYPE, key, KEYRING],
stdin=value, raiseonerr=False)
if result.returncode:
raise ValueError('keyctl padd failed: %s' % result.error_log)
+
def del_key(key):
"""
Remove a key from the keyring
"""
assert isinstance(key, six.string_types)
real_key = get_real_key(key)
- result = run(['keyctl', 'unlink', real_key, KEYRING],
+ result = run([paths.KEYCTL, 'unlink', real_key, KEYRING],
raiseonerr=False)
if result.returncode:
raise ValueError('keyctl unlink failed: %s' % result.error_log)
diff --git a/ipaserver/install/adtrustinstance.py b/ipaserver/install/adtrustinstance.py
index 14c255ba82..e951f3db0a 100644
--- a/ipaserver/install/adtrustinstance.py
+++ b/ipaserver/install/adtrustinstance.py
@@ -547,8 +547,10 @@ def set_keytab_owner(self, keytab=None, owner=None):
def clean_samba_keytab(self):
if os.path.exists(self.keytab):
try:
- ipautil.run(["ipa-rmkeytab", "--principal", self.principal,
- "-k", self.keytab])
+ ipautil.run([
+ paths.IPA_RMKEYTAB, "--principal", self.principal,
+ "-k", self.keytab
+ ])
except ipautil.CalledProcessError as e:
if e.returncode != 5:
logger.critical("Failed to remove old key for %s",
diff --git a/ipaserver/install/installutils.py b/ipaserver/install/installutils.py
index 897ad985c8..cbf6ad3921 100644
--- a/ipaserver/install/installutils.py
+++ b/ipaserver/install/installutils.py
@@ -599,19 +599,26 @@ def get_directive(filename, directive, separator=' '):
fd.close()
return None
+
def kadmin(command):
- return ipautil.run(["kadmin.local", "-q", command,
- "-x", "ipa-setup-override-restrictions"],
- capture_output=True,
- capture_error=True)
+ return ipautil.run(
+ [
+ paths.KADMIN_LOCAL, "-q", command,
+ "-x", "ipa-setup-override-restrictions"
+ ],
+ capture_output=True,
+ capture_error=True
+ )
def kadmin_addprinc(principal):
return kadmin("addprinc -randkey " + principal)
+
def kadmin_modprinc(principal, options):
return kadmin("modprinc " + options + " " + principal)
+
def create_keytab(path, principal):
try:
if os.path.isfile(path):
@@ -832,7 +839,7 @@ def expand_replica_info(filename, password):
tarfile = top_dir+"/files.tar"
dir_path = top_dir + "/realm_info"
decrypt_file(filename, tarfile, password, top_dir)
- ipautil.run(["tar", "xf", tarfile, "-C", top_dir])
+ ipautil.run([paths.TAR, "xf", tarfile, "-C", top_dir])
os.remove(tarfile)
return top_dir, dir_path
diff --git a/ipaserver/install/ipa_backup.py b/ipaserver/install/ipa_backup.py
index 475d846e6e..4a313c1cab 100644
--- a/ipaserver/install/ipa_backup.py
+++ b/ipaserver/install/ipa_backup.py
@@ -310,7 +310,7 @@ def run(self):
dirsrv.stop(capture_output=False)
else:
logger.info('Stopping IPA services')
- run(['ipactl', 'stop'])
+ run([paths.IPACTL, 'stop'])
instance = installutils.realm_to_serverid(api.env.realm)
if os.path.exists(paths.VAR_LIB_SLAPD_INSTANCE_DIR_TEMPLATE %
@@ -333,7 +333,7 @@ def run(self):
dirsrv.start(capture_output=False)
else:
logger.info('Starting IPA service')
- run(['ipactl', 'start'])
+ run([paths.IPACTL, 'start'])
finally:
try:
diff --git a/ipaserver/install/ipa_restore.py b/ipaserver/install/ipa_restore.py
index 99e6297b62..86b6327283 100644
--- a/ipaserver/install/ipa_restore.py
+++ b/ipaserver/install/ipa_restore.py
@@ -379,7 +379,7 @@ def run(self):
dirsrv.start(capture_output=False)
else:
logger.info('Stopping IPA services')
- result = run(['ipactl', 'stop'], raiseonerr=False)
+ result = run([paths.IPACTL, 'stop'], raiseonerr=False)
if result.returncode not in [0, 6]:
logger.warning('Stopping IPA failed: %s', result.error_log)
@@ -419,7 +419,7 @@ def run(self):
gssproxy = services.service('gssproxy', api)
gssproxy.reload_or_restart()
logger.info('Starting IPA services')
- run(['ipactl', 'start'])
+ run([paths.IPACTL, 'start'])
logger.info('Restarting SSSD')
sssd = services.service('sssd', api)
sssd.restart()
diff --git a/ipatests/pytest_plugins/integration/__init__.py b/ipatests/pytest_plugins/integration/__init__.py
index 2c107b926b..88fbd08010 100644
--- a/ipatests/pytest_plugins/integration/__init__.py
+++ b/ipatests/pytest_plugins/integration/__init__.py
@@ -31,6 +31,7 @@
from pytest_multihost import make_multihost_fixture
from ipapython import ipautil
+from ipaplatform.paths import paths
from ipatests.test_util import yield_fixture
from .config import Config
from .env_config import get_global_config
@@ -150,7 +151,7 @@ def collect_logs(name, logs_dict, logfile_dir=None, beakerlib_plugin=None):
# delete from remote
host.run_command(['rm', '-f', tmpname])
# Unpack on the local side
- ipautil.run(['tar', 'xJvf', 'logs.tar.xz'], cwd=dirname,
+ ipautil.run([paths.TAR, 'xJvf', 'logs.tar.xz'], cwd=dirname,
raiseonerr=False)
os.unlink(tarname)
diff --git a/ipatests/test_integration/test_caless.py b/ipatests/test_integration/test_caless.py
index 184d19870a..6b07fd0ca4 100644
--- a/ipatests/test_integration/test_caless.py
+++ b/ipatests/test_integration/test_caless.py
@@ -335,7 +335,7 @@ def create_pkcs12(cls, nickname, filename='server.p12', password=None):
with open(cert_fname) as cert:
chain.write(cert.read())
- ipautil.run(["openssl", "pkcs12", "-export", "-out", filename,
+ ipautil.run([paths.OPENSSL, "pkcs12", "-export", "-out", filename,
"-inkey", key_fname, "-in", certchain_fname, "-passin",
"pass:" + cls.cert_password, "-passout", "pass:" +
password, "-name", nickname], cwd=cls.cert_dir)
diff --git a/ipatests/test_xmlrpc/test_caacl_profile_enforcement.py b/ipatests/test_xmlrpc/test_caacl_profile_enforcement.py
index fa474c64ae..ad3b061b52 100644
--- a/ipatests/test_xmlrpc/test_caacl_profile_enforcement.py
+++ b/ipatests/test_xmlrpc/test_caacl_profile_enforcement.py
@@ -16,6 +16,7 @@
from cryptography.hazmat.primitives.asymmetric import rsa
from ipalib import api, errors
+from ipaplatform.paths import paths
from ipatests.util import (
prepare_config, unlock_principal_password, change_principal,
host_keytab)
@@ -48,7 +49,7 @@ def generate_user_csr(username, domain=None):
username=username)
with tempfile.NamedTemporaryFile(mode='w') as csr_file:
- run(['openssl', 'req', '-new', '-key', CERT_RSA_PRIVATE_KEY_PATH,
+ run([paths.OPENSSL, 'req', '-new', '-key', CERT_RSA_PRIVATE_KEY_PATH,
'-out', csr_file.name,
'-config', prepare_config(
CERT_OPENSSL_CONFIG_TEMPLATE, csr_values)])
diff --git a/ipatests/test_xmlrpc/test_cert_plugin.py b/ipatests/test_xmlrpc/test_cert_plugin.py
index 24a1801c32..178dea14a9 100644
--- a/ipatests/test_xmlrpc/test_cert_plugin.py
+++ b/ipatests/test_xmlrpc/test_cert_plugin.py
@@ -176,7 +176,7 @@ def test_0005_cert_uris(self):
result = api.Command.cert_show(sn, out=unicode(self.certfile))
with open(self.certfile, "rb") as f:
pem_cert = f.read().decode('ascii')
- result = run(['openssl', 'x509', '-text'],
+ result = run([paths.OPENSSL, 'x509', '-text'],
stdin=pem_cert, capture_output=True)
assert _EXP_CRL_URI in result.output
assert _EXP_OCSP_URI in result.output
_______________________________________________
FreeIPA-devel mailing list -- freeipa-devel@lists.fedorahosted.org
To unsubscribe send an email to freeipa-devel-le...@lists.fedorahosted.org
