Split ipa-client/ into ipaclient/ (Python library) and client/ (C, scripts)

Make ipaclient a Python library like ipapython, ipalib, etc.
Use setup.py instead of autotools for installing it.

Move C client tools, Python scripts, and man pages, to client/.

Remove old, empty or outdated, boilerplate files (NEWS, README, AUTHORS).
Remove /setup-client.py (ipalib/setup.py should be used instead).

Update Makefiles and the spec file accordingly.

https://fedorahosted.org/freeipa/ticket/5638

Reviewed-By: Jan Cholasta <jcholast@redhat.com>

.gitignore

@@ -60,13 +60,14 @@ freeipa2-dev-doc
 /install/ui/src/plugins
 !/install/ui/doc/Makefile
 
-/ipa-client/ipa-client.spec
+/client/ipa-getkeytab
-/ipa-client/ipa-getkeytab
+/client/ipa-join
-/ipa-client/ipa-join
+/client/ipa-rmkeytab
-/ipa-client/ipa-rmkeytab
 
 /ipatests/setup.py
 
+/ipaclient/setup.py
+
 /ipalib/setup.py
 !/ipalib/Makefile
 

Makefile

@@ -3,8 +3,9 @@
 
 include VERSION
 
-SUBDIRS=asn1 daemons install ipapython ipalib ipa-client
+SUBDIRS=asn1 daemons install ipapython ipalib
-CLIENTDIRS=ipapython ipa-client asn1
+CLIENTDIRS=ipapython client asn1
+CLIENTPYDIRS=ipaclient ipaplatform
 
 PRJ_PREFIX=freeipa
 
@@ -75,7 +76,9 @@ client: client-autogen
 	@for subdir in $(CLIENTDIRS); do \
 		(cd $$subdir && $(MAKE) all) || exit 1; \
 	done
-	cd ipaplatform && $(PYTHON) setup.py build
+	@for subdir in $(CLIENTPYDIRS); do \
+		(cd $$subdir && $(PYTHON) setup.py build); \
+	done
 
 check: bootstrap-autogen server tests
 	@for subdir in $(SUBDIRS); do \
@@ -90,13 +93,13 @@ bootstrap-autogen: version-update client-autogen
 
 client-autogen: version-update
 	cd asn1; if [ ! -e Makefile ]; then ../autogen.sh --prefix=/usr --sysconfdir=/etc --localstatedir=/var --libdir=$(LIBDIR); fi
-	cd ipa-client; if [ ! -e Makefile ]; then ../autogen.sh --prefix=/usr --sysconfdir=/etc --localstatedir=/var --libdir=$(LIBDIR); fi
+	cd client; if [ ! -e Makefile ]; then ../autogen.sh --prefix=/usr --sysconfdir=/etc --localstatedir=/var --libdir=$(LIBDIR); fi
 	cd install; if [ ! -e Makefile ]; then ../autogen.sh --prefix=/usr --sysconfdir=/etc --localstatedir=/var --libdir=$(LIBDIR); fi
 
 tests-man-autogen: version-update
 	cd ipatests/man; if [ ! -e Makefile ]; then ../../autogen.sh --prefix=/usr --sysconfdir=/etc --localstatedir=/var --libdir=$(LIBDIR); fi
 
-install: all server-install tests-install
+install: all server-install tests-install client-install
 	@for subdir in $(SUBDIRS); do \
 		(cd $$subdir && $(MAKE) $@) || exit 1; \
 	done
@@ -106,13 +109,13 @@ client-install: client client-dirs
 		(cd $$subdir && $(MAKE) install) || exit 1; \
 	done
 	cd install/po && $(MAKE) install || exit 1;
-	if [ "$(DESTDIR)" = "" ]; then \
+	@for subdir in $(CLIENTPYDIRS); do \
-		$(PYTHON) setup-client.py install; \
+		if [ "$(DESTDIR)" = "" ]; then \
-		(cd ipaplatform && $(PYTHON) setup.py install); \
+			(cd $$subdir && $(PYTHON) setup.py install); \
-	else \
+		else \
-		$(PYTHON) setup-client.py install --root $(DESTDIR); \
+			(cd $$subdir && $(PYTHON) setup.py install --root $(DESTDIR)); \
-		(cd ipaplatform && $(PYTHON) setup.py install --root $(DESTDIR)); \
+		fi \
-	fi
+	done
 
 client-dirs:
 	@if [ "$(DESTDIR)" != "" ] ; then \
@@ -149,6 +152,8 @@ version-update: release-update
 		> ipapython/version.py
 	sed -e s/__VERSION__/$(IPA_VERSION)/ ipatests/setup.py.in \
 		> ipatests/setup.py
+	sed -e s/__VERSION__/$(IPA_VERSION)/ ipaclient/setup.py.in \
+		> ipaclient/setup.py
 	sed -e s/__NUM_VERSION__/$(IPA_NUM_VERSION)/ install/ui/src/libs/loader.js.in \
 		> install/ui/src/libs/loader.js
 	perl -pi -e "s:__API_VERSION__:$(IPA_API_VERSION_MAJOR).$(IPA_API_VERSION_MINOR):" install/ui/src/libs/loader.js
@@ -161,10 +166,8 @@ version-update: release-update
 	perl -pi -e "s:__NUM_VERSION__:$(IPA_NUM_VERSION):" daemons/ipa-version.h
 	perl -pi -e "s:__DATA_VERSION__:$(IPA_DATA_VERSION):" daemons/ipa-version.h
 
-	sed -e s/__VERSION__/$(IPA_VERSION)/ -e s/__RELEASE__/$(IPA_RPM_RELEASE)/ \
+	sed -e s/__VERSION__/$(IPA_VERSION)/ client/version.m4.in \
-		ipa-client/ipa-client.spec.in > ipa-client/ipa-client.spec
+		> client/version.m4
-	sed -e s/__VERSION__/$(IPA_VERSION)/ ipa-client/version.m4.in \
-		> ipa-client/version.m4
 
 	if [ "$(SUPPORTED_PLATFORM)" != "" ]; then \
 		sed -e s/__PLATFORM__/$(SUPPORTED_PLATFORM)/ \
@@ -220,7 +223,7 @@ archive-cleanup:
 tarballs: local-archive
 	-mkdir -p dist/sources
 	# tar up clean sources
-	cd dist/$(TARBALL_PREFIX)/ipa-client; ../autogen.sh --prefix=/usr --sysconfdir=/etc --localstatedir=/var --libdir=$(LIBDIR); make distclean
+	cd dist/$(TARBALL_PREFIX)/client; ../autogen.sh --prefix=/usr --sysconfdir=/etc --localstatedir=/var --libdir=$(LIBDIR); make distclean
 	cd dist/$(TARBALL_PREFIX)/daemons; ../autogen.sh --prefix=/usr --sysconfdir=/etc --localstatedir=/var --libdir=$(LIBDIR); make distclean
 	cd dist/$(TARBALL_PREFIX)/install; ../autogen.sh --prefix=/usr --sysconfdir=/etc --localstatedir=/var --libdir=$(LIBDIR); make distclean
 	cd dist; tar cfz sources/$(TARBALL) $(TARBALL_PREFIX)
@@ -289,7 +292,7 @@ maintainer-clean: clean
 	rm -fr $(RPMBUILD) dist build
 	cd daemons && $(MAKE) maintainer-clean
 	cd install && $(MAKE) maintainer-clean
-	cd ipa-client && $(MAKE) maintainer-clean
+	cd client && $(MAKE) maintainer-clean
 	cd ipapython && $(MAKE) maintainer-clean
 	rm -f version.m4
 	rm -f freeipa.spec

client/Makefile.am

@@ -43,6 +43,12 @@ sbin_PROGRAMS =			\
 	ipa-join		\
 	$(NULL)
 
+sbin_SCRIPTS =			\
+	ipa-client-install	\
+	ipa-client-automount	\
+	ipa-certupdate		\
+	$(NULL)
+
 ipa_getkeytab_SOURCES =		\
 	ipa-getkeytab.c		\
 	ipa-client-common.c	\
@@ -88,19 +94,11 @@ ipa_join_LDADD = 		\
 
 SUBDIRS =			\
 	../asn1			\
-	ipaclient		\
-	ipa-install		\
 	man			\
 	$(NULL)
 
 EXTRA_DIST =			\
-	ipa-client.spec		\
+	$(sbin_SCRIPTS)		\
-	COPYING			\
-	AUTHORS			\
-	INSTALL			\
-	README			\
-	HACKING			\
-	NEWS			\
 	$(NULL)
 
 DISTCLEANFILES =		\
@@ -124,7 +122,5 @@ MAINTAINERCLEANFILES =		\
 	config.h.*		\
 	aclocal.m4		\
 	version.m4		\
-	ipa-client.spec		\
-	py-compile		\
 	$(NULL)
 

client/configure.ac

@@ -6,7 +6,6 @@ AC_INIT([ipa-client],
 LT_INIT()
 AC_PROG_LIBTOOL
 
-AC_CONFIG_SRCDIR([ipaclient/__init__.py])
 AC_CONFIG_HEADERS([config.h])
 AC_CONFIG_SUBDIRS([../asn1])
 
@@ -140,18 +139,6 @@ AC_CHECK_HEADER(sasl/sasl.h, [], [AC_MSG_ERROR([sasl/sasl.h not found])])
 AC_CHECK_LIB(sasl2, sasl_client_init, [SASL_LIBS="-lsasl2"])
 AC_SUBST(SASL_LIBS)
 
-dnl ---------------------------------------------------------------------------
-dnl - Check for Python
-dnl ---------------------------------------------------------------------------
-
-AC_MSG_NOTICE([Checking for Python])
-have_python=no
-AM_PATH_PYTHON(2.3)
-
-if test "x$PYTHON" = "x" ; then
-  AC_MSG_ERROR([Python not found])
-fi
-
 dnl ---------------------------------------------------------------------------
 dnl - Check for CURL
 dnl ---------------------------------------------------------------------------
@@ -235,8 +222,6 @@ dnl ---------------------------------------------------------------------------
 AC_CONFIG_FILES([
     Makefile
     ../asn1/Makefile
-    ipaclient/Makefile
-    ipa-install/Makefile
     man/Makefile
 ])
 

freeipa.spec.in

@@ -631,7 +631,7 @@ rm -f ipaplatform/tasks.py
 rm -f ipaplatform/paths.py
 rm -f ipaplatform/constants.py
 make version-update
-cd ipa-client; ../autogen.sh --prefix=%{_usr} --sysconfdir=%{_sysconfdir} --localstatedir=%{_localstatedir} --libdir=%{_libdir} --mandir=%{_mandir}; cd ..
+cd client; ../autogen.sh --prefix=%{_usr} --sysconfdir=%{_sysconfdir} --localstatedir=%{_localstatedir} --libdir=%{_libdir} --mandir=%{_mandir}; cd ..
 %if ! %{ONLY_CLIENT}
 cd daemons; ../autogen.sh --prefix=%{_usr} --sysconfdir=%{_sysconfdir} --localstatedir=%{_localstatedir} --libdir=%{_libdir} --mandir=%{_mandir} --with-openldap; cd ..
 cd install; ../autogen.sh --prefix=%{_usr} --sysconfdir=%{_sysconfdir} --localstatedir=%{_localstatedir} --libdir=%{_libdir} --mandir=%{_mandir}; cd ..
@@ -1253,6 +1253,7 @@ fi
 %license COPYING
 %dir %{python_sitelib}/ipaclient
 %{python_sitelib}/ipaclient/*.py*
+%{python_sitelib}/ipaclient-*.egg-info
 
 
 %files client-common

install/po/Makefile.in

@@ -35,12 +35,15 @@ po_files = $(patsubst %, %.po, $(languages))
 mo_files = $(patsubst %.po, %.mo, $(po_files))
 po_count=$(words $(po_files))
 
-PY_FILES = $(shell cd ../..; git ls-files | grep -v -e "^ipatests/" -e "^doc/" -e "^install/po/" -e "^ipapython/test/" -e "setup.py" -e "setup-client.py" | grep "\.py$$" | tr '\n' ' '; cd install/po)
+PY_FILES = $(shell cd ../..; git ls-files | grep -v -e "^ipatests/" -e "^doc/" -e "^install/po/" -e "^ipapython/test/" -e "setup.py" | grep "\.py$$" | tr '\n' ' '; cd install/po)
 C_FILES = $(shell cd ../..; git ls-files | grep "\.c$$" | tr '\n' ' '; cd install/po)
 H_FILES = $(shell cd ../..; git ls-files | grep "\.h$$" | tr '\n' ' '; cd install/po)
 
 # Please keep this list sorted!
 PY_EXPLICIT_FILES = \
+     client/ipa-client-install \
+     client/ipa-client-automount \
+     client/ipa-certupdate \
      install/tools/ipa-adtrust-install \
      install/tools/ipa-advise \
      install/tools/ipa-backup \
@@ -64,8 +67,7 @@ PY_EXPLICIT_FILES = \
      install/tools/ipa-server-install \
      install/tools/ipa-server-upgrade \
      install/tools/ipa-upgradeconfig \
-     ipa \
+     ipa
-     ipa-client/ipa-install/ipa-client-install
 
 
 PYTHON_POTFILES = $(PY_FILES) $(PY_EXPLICIT_FILES)

ipa-client/README

@@ -1,24 +0,0 @@
-Code to be installed on any client that wants to be in an IPA domain.
-
-Mostly consists of a tool for Linux systems that will help configure the
-client so it will work properly in a kerberized environment.
-
-It also includes several ways to configure Firefox to do single sign-on.
-
-The two methods on the client side are:
-
-1. globalsetup.sh. This modifies the global Firefox installation so that
-   any profiles created will be pre-configured.
-
-2. usersetup.sh. This will update a user's existing profile.
-
-The downside of #1 is that an rpm -V will return a failure. It will also
-need to be run with every update of Firefox.
-
-One a profile contains the proper preferences it will be unaffected by
-upgrades to Firefox. 
-
-The downside of #2 is that every user would need to run this each time they
-create a new profile.
-
-There is a third, server-side method. See ipa-server/README for details.

ipa-client/ipa-client.spec.in

@@ -1,86 +0,0 @@
-Name:           ipa-client
-Version:        __VERSION__
-Release:        __RELEASE__%{?dist}
-Summary:        IPA client
-
-Group:          System Environment/Base
-License:        GPLv2
-URL:            http://www.freeipa.org
-Source0:        %{name}-%{version}.tgz
-BuildRoot:      %{_tmppath}/%{name}-%{version}-%{release}-root-%(%{__id_u} -n)
-
-Requires: python python-ldap python-gssapi ipa-python cyrus-sasl-gssapi
-
-%{!?python_sitelib: %define python_sitelib %(%{__python} -c "from distutils.sysconfig import get_python_lib; print get_python_lib()")}
-
-%description
-IPA is a server for identity, policy, and audit.
-The client package provide install and configuration scripts for clients.
-
-%prep
-%setup -q
-./configure --prefix=%{buildroot}/usr --libdir=%{buildroot}/%{_libdir} --sysconfdir=%{buildroot}/etc --mandir=%{buildroot}/%{_mandir}
-
-%build
-
-make
-
-%install
-rm -rf %{buildroot}
-
-make install
-
-mkdir -p %{buildroot}/%{_localstatedir}/lib/ipa-client/sysrestore
-
-
-%clean
-rm -rf %{buildroot}
-
-
-%files
-%defattr(-,root,root,-)
-%{_sbindir}/ipa-client-install
-%{_sbindir}/ipa-getkeytab
-
-%dir %{_usr}/share/ipa
-%{_usr}/share/ipa/*
-
-%dir %{python_sitelib}/ipaclient
-%{python_sitelib}/ipaclient/*.py*
-
-%dir %{_localstatedir}/lib/ipa-client
-%dir %{_localstatedir}/lib/ipa-client/sysrestore
-
-%{_mandir}/man1/*
-
-%changelog
-* Thu Apr  3 2008 Rob Crittenden <rcritten@redhat.com> - 1.0.0-1
-- Version bump for release
-
-* Mon Feb 25 2008 Rob Crittenden <rcritten@redhat.com> - 0.99.0-2
-- Add ipa-getkeytab man page
-
-* Thu Feb 21 2008 Rob Crittenden <rcritten@redhat.com> - 0.99.0-1
-- Version bump for release
-
-* Thu Jan 31 2008 Rob Crittenden <rcritten@redhat.com> - 0.6.0-3
-- Marked with wrong license. IPA is GPLv2.
-
-* Thu Jan 17 2008 Rob Crittenden <rcritten@redhat.com> - 0.6.0-2
-- Fixed License in specfile
-- Move client python files to /usr/lib*/python*/site-packages
-
-* Fri Dec 21 2007 Karl MacMillan <kmacmill@redhat.com> - 0.6.0-1
-- Version bump for release
-
-* Wed Nov 21 2007 Karl MacMillan <kmacmill@redhat.com> - 0.5.0-1
-- Version bump for release and rpm name change
-
-* Thu Nov 1 2007 Karl MacMillan <kmacmill@redhat.com> - 0.3.1-1
-- Version bump for release
-
-* Thu Oct 18 2007 Karl MacMillan <kmacmill@redhat.com> - 0.3.0-2
-- Convert to autotools-based build
-
-* Thu Aug 16 2007 Simo Sorce <ssorce@redhat.com> - 0.1.0-1
-- Initial rpm version

ipa-client/ipa-install/Makefile.am

@@ -1,15 +0,0 @@
-NULL =
-
-sbin_SCRIPTS =			\
-	ipa-client-install	\
-	ipa-client-automount	\
-	ipa-certupdate		\
-	$(NULL)
-
-EXTRA_DIST =			\
-	$(sbin_SCRIPTS)		\
-	$(NULL)
-
-MAINTAINERCLEANFILES =		\
-	*~			\
-	Makefile.in

ipa-client/ipaclient/Makefile.am

@@ -1,17 +0,0 @@
-NULL =
-
-appdir = $(pythondir)/ipaclient
-app_PYTHON = 			\
-	__init__.py		\
-	ipachangeconf.py	\
-	ipadiscovery.py		\
-	ntpconf.py		\
-	ipa_certupdate.py	\
-	$(NULL)
-
-EXTRA_DIST =			\
-	$(NULL)
-
-MAINTAINERCLEANFILES =		\
-	*~			\
-	Makefile.in

ipaclient/setup.py.in

@@ -0,0 +1,71 @@
+#!/usr/bin/python2
+# Copyright (C) 2007  Red Hat
+# see file 'COPYING' for use and warranty information
+#
+# This program is free software; you can redistribute it and/or modify
+# it under the terms of the GNU General Public License as published by
+# the Free Software Foundation, either version 3 of the License, or
+# (at your option) any later version.
+#
+# This program is distributed in the hope that it will be useful,
+# but WITHOUT ANY WARRANTY; without even the implied warranty of
+# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+# GNU General Public License for more details.
+#
+# You should have received a copy of the GNU General Public License
+# along with this program.  If not, see <http://www.gnu.org/licenses/>.
+#
+
+"""FreeIPA client library
+
+FreeIPA is a server for identity, policy, and audit.
+"""
+
+DOCLINES = __doc__.split("\n")
+
+import os
+import sys
+
+CLASSIFIERS = """\
+Intended Audience :: System Environment/Base
+License :: GPL
+Programming Language :: Python
+Operating System :: POSIX
+Operating System :: Unix
+"""
+
+# BEFORE importing distutils, remove MANIFEST. distutils doesn't properly
+# update it when the contents of directories change.
+if os.path.exists('MANIFEST'): os.remove('MANIFEST')
+
+def setup_package():
+
+    from distutils.core import setup
+
+    old_path = os.getcwd()
+    local_path = os.path.dirname(os.path.abspath(sys.argv[0]))
+    os.chdir(local_path)
+    sys.path.insert(0,local_path)
+
+    try:
+        setup(
+            name = "ipaclient",
+            version = "__VERSION__",
+            license = "GPL",
+            url = "http://www.freeipa.org/",
+            description = DOCLINES[0],
+            long_description = "\n".join(DOCLINES[2:]),
+            download_url = "http://www.freeipa.org/page/Downloads",
+            classifiers=[line for line in CLASSIFIERS.split('\n') if line],
+            platforms = ["Linux", "Solaris", "Unix"],
+            package_dir = {'ipaclient': ''},
+            packages = ["ipaclient",
+                       ],
+        )
+    finally:
+        del sys.path[0]
+        os.chdir(old_path)
+    return
+
+if __name__ == '__main__':
+    setup_package()

ipatests/pytest.ini

@@ -15,7 +15,6 @@ addopts = --doctest-modules
             # Ignore files for doc tests.
             # TODO: ideally, these should all use __name__=='__main__' guards
           --ignore=setup.py
-          --ignore=setup-client.py
           --ignore=checks/check-ra.py
           --ignore=daemons/ipa-otpd/test.py
           --ignore=doc/examples/python-api.py

setup-client.py

@@ -1,40 +0,0 @@
-#!/usr/bin/python2
-
-# Authors:
-#   Jason Gerard DeRose <jderose@redhat.com>
-#
-# Copyright (C) 2008  Red Hat
-# see file 'COPYING' for use and warranty information
-#
-# This program is free software; you can redistribute it and/or modify
-# it under the terms of the GNU General Public License as published by
-# the Free Software Foundation, either version 3 of the License, or
-# (at your option) any later version.
-#
-# This program is distributed in the hope that it will be useful,
-# but WITHOUT ANY WARRANTY; without even the implied warranty of
-# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
-# GNU General Public License for more details.
-#
-# You should have received a copy of the GNU General Public License
-# along with this program.  If not, see <http://www.gnu.org/licenses/>.
-
-"""
-Python-level packaging using distutils for the client pieces only.
-"""
-
-from setuptools import setup
-import ipalib
-
-setup(
-    name='freeipa',
-    version=ipalib.__version__,
-    license='GPLv3+',
-    url='http://freeipa.org/',
-    packages=[
-        'ipalib',
-        'ipalib.plugins',
-    ],
-    scripts=['ipa'],
-    data_files = [('share/man/man1', ["ipa.1"])],
-)