Add template 2.3 design doc
[ganeti-local] / Makefile.am
index 5f369a6..f2ab9b6 100644 (file)
@@ -14,15 +14,21 @@ DOCBOOK_WRAPPER = $(top_srcdir)/autotools/docbook-wrapper
 BUILD_BASH_COMPLETION = $(top_srcdir)/autotools/build-bash-completion
 RUN_IN_TEMPDIR = $(top_srcdir)/autotools/run-in-tempdir
 CHECK_PYTHON_CODE = $(top_srcdir)/autotools/check-python-code
+CHECK_MAN = $(top_srcdir)/autotools/check-man
 REPLACE_VARS_SED = autotools/replace_vars.sed
 
 hypervisordir = $(pkgpythondir)/hypervisor
 httpdir = $(pkgpythondir)/http
+masterddir = $(pkgpythondir)/masterd
 confddir = $(pkgpythondir)/confd
 rapidir = $(pkgpythondir)/rapi
+impexpddir = $(pkgpythondir)/impexpd
 toolsdir = $(pkglibdir)/tools
 docdir = $(datadir)/doc/$(PACKAGE)
 
+# Delete output file if an error occurred while building it
+.DELETE_ON_ERROR:
+
 DIRS = \
        autotools \
        daemons \
@@ -30,12 +36,15 @@ DIRS = \
        doc \
        doc/examples \
        doc/examples/hooks \
+       doc/examples/gnt-debug \
        lib \
        lib/build \
+       lib/confd \
        lib/http \
        lib/hypervisor \
+       lib/impexpd \
+       lib/masterd \
        lib/rapi \
-       lib/confd \
        man \
        qa \
        scripts \
@@ -43,18 +52,31 @@ DIRS = \
        test/data \
        tools
 
+BUILDTIME_DIRS = \
+       doc/api \
+       doc/coverage \
+       doc/html
+
+DIRCHECK_EXCLUDE = \
+       $(BUILDTIME_DIRS) \
+       ganeti-[0-9]*.[0-9]*.[0-9]* \
+       doc/html/_*
+
 MAINTAINERCLEANFILES = \
        $(docpng) \
        $(maninput) \
        doc/install-quick.rst \
-       doc/news.rst
+       doc/news.rst \
+       vcs-version
 
 maintainer-clean-local:
-       rm -rf doc/api doc/html
+       rm -rf $(BUILDTIME_DIRS)
 
 CLEANFILES = \
+       $(addsuffix /*.py[co],$(DIRS)) \
        autotools/replace_vars.sed \
        daemons/daemon-util \
+       daemons/ensure-dirs \
        daemons/ganeti-cleaner \
        devel/upload \
        doc/examples/bash_completion \
@@ -62,15 +84,8 @@ CLEANFILES = \
        doc/examples/ganeti.cron \
        doc/examples/gnt-config-backup \
        doc/examples/hooks/ipsec \
-       lib/*.py[co] \
-       lib/build/*.py[co] \
-       lib/http/*.py[co] \
-       lib/hypervisor/*.py[co] \
-       lib/rapi/*.py[co] \
        $(man_MANS) \
        $(manhtml) \
-       qa/*.py[co] \
-       test/*.py[co] \
        stamp-directories \
        stamp-srclinks \
        $(nodist_pkgpython_PYTHON)
@@ -95,6 +110,7 @@ pkgpython_PYTHON = \
        lib/bootstrap.py \
        lib/cli.py \
        lib/cmdlib.py \
+       lib/compat.py \
        lib/config.py \
        lib/constants.py \
        lib/daemon.py \
@@ -104,6 +120,7 @@ pkgpython_PYTHON = \
        lib/locking.py \
        lib/luxi.py \
        lib/mcpu.py \
+       lib/netutils.py \
        lib/objects.py \
        lib/opcodes.py \
        lib/rpc.py \
@@ -112,6 +129,7 @@ pkgpython_PYTHON = \
        lib/ssh.py \
        lib/storage.py \
        lib/utils.py \
+       lib/uidpool.py \
        lib/workerpool.py
 
 hypervisor_PYTHON = \
@@ -120,11 +138,14 @@ hypervisor_PYTHON = \
        lib/hypervisor/hv_chroot.py \
        lib/hypervisor/hv_fake.py \
        lib/hypervisor/hv_kvm.py \
+       lib/hypervisor/hv_lxc.py \
        lib/hypervisor/hv_xen.py
 
 rapi_PYTHON = \
        lib/rapi/__init__.py \
        lib/rapi/baserlib.py \
+       lib/rapi/client.py \
+       lib/rapi/client_utils.py \
        lib/rapi/connector.py \
        lib/rapi/rlib2.py
 
@@ -137,14 +158,23 @@ http_PYTHON = \
 confd_PYTHON = \
        lib/confd/__init__.py \
        lib/confd/client.py \
-       lib/confd/server.py \
-       lib/confd/querylib.py
+       lib/confd/querylib.py \
+       lib/confd/server.py
+
+masterd_PYTHON = \
+       lib/masterd/__init__.py \
+       lib/masterd/instance.py
+
+impexpd_PYTHON = \
+       lib/impexpd/__init__.py
 
 docrst = \
        doc/admin.rst \
        doc/design-2.0.rst \
        doc/design-2.1.rst \
        doc/design-2.2.rst \
+       doc/design-2.3.rst \
+       doc/cluster-merge.rst \
        doc/devnotes.rst \
        doc/glossary.rst \
        doc/hooks.rst \
@@ -153,6 +183,7 @@ docrst = \
        doc/install-quick.rst \
        doc/install.rst \
        doc/locking.rst \
+       doc/move-instance.rst \
        doc/news.rst \
        doc/rapi.rst \
        doc/security.rst \
@@ -230,20 +261,36 @@ dist_tools_SCRIPTS = \
        tools/burnin \
        tools/cfgshell \
        tools/cfgupgrade \
-       tools/lvmstrap
+       tools/cfgupgrade12 \
+       tools/cluster-merge \
+       tools/lvmstrap \
+       tools/move-instance \
+       tools/setup-ssh \
+       tools/sanitize-config
+
+pkglib_python_scripts = \
+       daemons/import-export \
+       tools/check-cert-expired
 
 pkglib_SCRIPTS = \
-       daemons/daemon-util
+       daemons/daemon-util \
+       daemons/ensure-dirs \
+       $(pkglib_python_scripts)
 
 EXTRA_DIST = \
        NEWS \
        pylintrc \
        autotools/build-bash-completion \
        autotools/check-python-code \
+       autotools/check-man \
        autotools/docbook-wrapper \
+       autotools/gen-coverage \
+       autotools/testrunner \
        $(RUN_IN_TEMPDIR) \
        daemons/daemon-util.in \
+       daemons/ensure-dirs.in \
        daemons/ganeti-cleaner.in \
+       $(pkglib_python_scripts) \
        devel/upload.in \
        $(docdot) \
        $(docpng) \
@@ -254,8 +301,13 @@ EXTRA_DIST = \
        doc/examples/ganeti.cron.in \
        doc/examples/gnt-config-backup.in \
        doc/examples/dumb-allocator \
+       doc/examples/ganeti.default \
+       doc/examples/ganeti.default-debug \
        doc/examples/hooks/ethers \
        doc/examples/hooks/ipsec.in \
+       doc/examples/gnt-debug/README \
+       doc/examples/gnt-debug/delay0.json \
+       doc/examples/gnt-debug/delay50.json \
        test/testutils.py \
        test/mocks.py \
        $(dist_TESTS) \
@@ -301,60 +353,112 @@ maninput = \
        $(patsubst %.html,%.html.in,$(manhtml))
 
 TEST_FILES = \
-       test/data/bdev-both.txt \
-       test/data/bdev-8.3-both.txt \
-       test/data/bdev-disk.txt \
-       test/data/bdev-net.txt \
+       test/data/bdev-drbd-8.0.txt \
+       test/data/bdev-drbd-8.3.txt \
+       test/data/bdev-drbd-disk.txt \
+       test/data/bdev-drbd-net-ip4.txt \
+       test/data/bdev-drbd-net-ip6.txt \
+       test/data/cert1.pem \
        test/data/proc_drbd8.txt \
        test/data/proc_drbd80-emptyline.txt \
-       test/data/proc_drbd83.txt
+       test/data/proc_drbd83.txt \
+       test/data/sys_drbd_usermode_helper.txt \
+       test/import-export_unittest-helper
 
-dist_TESTS = \
+python_tests = \
+       test/ganeti.asyncnotifier_unittest.py \
+       test/ganeti.backend_unittest.py \
        test/ganeti.bdev_unittest.py \
        test/ganeti.cli_unittest.py \
+       test/ganeti.daemon_unittest.py \
        test/ganeti.cmdlib_unittest.py \
-       test/ganeti.confd_client_unittest.py \
+       test/ganeti.compat_unittest.py \
+       test/ganeti.confd.client_unittest.py \
        test/ganeti.config_unittest.py \
        test/ganeti.constants_unittest.py \
+       test/ganeti.errors_unittest.py \
        test/ganeti.hooks_unittest.py \
        test/ganeti.http_unittest.py \
+       test/ganeti.hypervisor.hv_kvm_unittest.py \
+       test/ganeti.impexpd_unittest.py \
+       test/ganeti.jqueue_unittest.py \
        test/ganeti.locking_unittest.py \
+       test/ganeti.luxi_unittest.py \
+       test/ganeti.masterd.instance_unittest.py \
        test/ganeti.mcpu_unittest.py \
+       test/ganeti.netutils_unittest.py \
        test/ganeti.objects_unittest.py \
+       test/ganeti.opcodes_unittest.py \
+       test/ganeti.rapi.client_unittest.py \
        test/ganeti.rapi.resources_unittest.py \
+       test/ganeti.rapi.rlib2_unittest.py \
+       test/ganeti.rpc_unittest.py \
        test/ganeti.serializer_unittest.py \
        test/ganeti.ssh_unittest.py \
+       test/ganeti.uidpool_unittest.py \
        test/ganeti.utils_unittest.py \
+       test/ganeti.utils_mlockall_unittest.py \
        test/ganeti.workerpool_unittest.py \
-       test/docs_unittest.py
+       test/cfgupgrade_unittest.py \
+       test/docs_unittest.py \
+       test/tempfile_fork_unittest.py
+
+dist_TESTS = \
+       test/check-cert-expired_unittest.bash \
+       test/daemon-util_unittest.bash \
+       test/ganeti-cleaner_unittest.bash \
+       test/import-export_unittest.bash \
+       $(python_tests)
 
 nodist_TESTS =
 
 TESTS = $(dist_TESTS) $(nodist_TESTS)
 
+# Environment for all tests
+PLAIN_TESTS_ENVIRONMENT = \
+       PYTHONPATH=. TOP_SRCDIR=$(abs_top_srcdir) PYTHON=$(PYTHON) $(RUN_IN_TEMPDIR)
+
+# Environment for tests run by automake
 TESTS_ENVIRONMENT = \
-       PYTHONPATH=. TOP_SRCDIR=$(abs_top_srcdir) \
-       $(RUN_IN_TEMPDIR) $(PYTHON)
+       $(PLAIN_TESTS_ENVIRONMENT) $(abs_top_srcdir)/autotools/testrunner
 
 all_python_code = \
        $(dist_sbin_SCRIPTS) \
        $(dist_tools_SCRIPTS) \
-       $(dist_TESTS) \
+       $(pkglib_python_scripts) \
+       $(python_tests) \
        $(pkgpython_PYTHON) \
        $(hypervisor_PYTHON) \
        $(rapi_PYTHON) \
        $(http_PYTHON) \
        $(confd_PYTHON) \
+       $(masterd_PYTHON) \
+       $(impexpd_PYTHON) \
        $(noinst_PYTHON)
 
 srclink_files = \
        man/footer.sgml \
+       test/check-cert-expired_unittest.bash \
+       test/daemon-util_unittest.bash \
+       test/ganeti-cleaner_unittest.bash \
+       test/import-export_unittest.bash \
        $(all_python_code)
 
 check_python_code = \
-       autotools/build-bash-completion \
+       $(BUILD_BASH_COMPLETION) \
        $(all_python_code)
 
+lint_python_code = \
+       ganeti \
+       $(dist_sbin_SCRIPTS) \
+       $(dist_tools_SCRIPTS) \
+       $(pkglib_python_scripts) \
+       $(BUILD_BASH_COMPLETION)
+
+test/daemon-util_unittest.bash: daemons/daemon-util
+
+test/ganeti-cleaner_unittest.bash: daemons/ganeti-cleaner
+
 devel/upload: devel/upload.in $(REPLACE_VARS_SED)
        sed -f $(REPLACE_VARS_SED) < $< > $@
        chmod u+x $@
@@ -384,6 +488,7 @@ man/%.7.in man/%.8.in: man/%.sgml man/footer.sgml $(DOCBOOK_WRAPPER)
        @test -n "$(DOCBOOK2MAN)" || \
          { echo 'docbook2man' not found during configure; exit 1; }
        $(DOCBOOK_WRAPPER) "$(DOCBOOK2MAN)" $< $(notdir $(@:.in=)) $@
+       if test -n "$(MAN_HAS_WARNINGS)"; then $(CHECK_MAN) $@; fi
 
 man/%.html.in: man/%.sgml man/footer.sgml $(DOCBOOK_WRAPPER)
        @test -n "$(DOCBOOK2HTML)" || \
@@ -399,8 +504,25 @@ man/%.8: man/%.8.in $(REPLACE_VARS_SED)
 man/%.html: man/%.html.in $(REPLACE_VARS_SED)
        sed -f $(REPLACE_VARS_SED) < $< > $@
 
-lib/_autoconf.py: Makefile stamp-directories
+vcs-version:
+       if test -d .git; then \
+         git describe > $@; \
+       elif test ! -f $@ ; then \
+         echo "Cannot auto-generate $@ file"; exit 1; \
+       fi
+
+.PHONY: regen-vcs-version
+regen-vcs-version:
        set -e; \
+       cd $(srcdir); \
+       if test -d .git; then \
+         rm -f vcs-version; \
+         $(MAKE) vcs-version; \
+       fi
+
+lib/_autoconf.py: Makefile stamp-directories vcs-version
+       set -e; \
+       VCSVER=`cat $(abs_top_srcdir)/vcs-version`; \
        { echo '# This file is automatically generated, do not edit!'; \
          echo '#'; \
          echo ''; \
@@ -412,6 +534,10 @@ lib/_autoconf.py: Makefile stamp-directories
          echo ''; \
          echo '"""'; \
          echo ''; \
+         echo '# pylint: disable-msg=C0301,C0324'; \
+         echo '# because this is autogenerated, we do not want'; \
+         echo '# style warnings' ; \
+         echo ''; \
          echo "PACKAGE_VERSION = '$(PACKAGE_VERSION)'"; \
          echo "VERSION_MAJOR = '$(VERSION_MAJOR)'"; \
          echo "VERSION_MINOR = '$(VERSION_MINOR)'"; \
@@ -420,12 +546,14 @@ lib/_autoconf.py: Makefile stamp-directories
          echo "VERSION_FULL = '$(VERSION_FULL)'"; \
          echo "LOCALSTATEDIR = '$(localstatedir)'"; \
          echo "SYSCONFDIR = '$(sysconfdir)'"; \
+         echo "SSH_CONFIG_DIR = '$(SSH_CONFIG_DIR)'"; \
          echo "EXPORT_DIR = '$(EXPORT_DIR)'"; \
          echo "OS_SEARCH_PATH = [$(OS_SEARCH_PATH)]"; \
          echo "XEN_BOOTLOADER = '$(XEN_BOOTLOADER)'"; \
          echo "XEN_KERNEL = '$(XEN_KERNEL)'"; \
          echo "XEN_INITRD = '$(XEN_INITRD)'"; \
          echo "FILE_STORAGE_DIR = '$(FILE_STORAGE_DIR)'"; \
+         echo "ENABLE_FILE_STORAGE = $(ENABLE_FILE_STORAGE)"; \
          echo "IALLOCATOR_SEARCH_PATH = [$(IALLOCATOR_SEARCH_PATH)]"; \
          echo "KVM_PATH = '$(KVM_PATH)'"; \
          echo "SOCAT_PATH = '$(SOCAT)'"; \
@@ -434,6 +562,12 @@ lib/_autoconf.py: Makefile stamp-directories
          echo "TOOLSDIR = '$(toolsdir)'"; \
          echo "GNT_SCRIPTS = [$(foreach i,$(notdir $(gnt_scripts)),'$(i)',)]"; \
          echo "PKGLIBDIR = '$(pkglibdir)'"; \
+         echo "DRBD_BARRIERS = $(DRBD_BARRIERS)"; \
+         echo "SYSLOG_USAGE = '$(SYSLOG_USAGE)'"; \
+         echo "DAEMONS_GROUP = '$(DAEMONS_GROUP)'"; \
+         echo "MASTERD_USER = '$(MASTERD_USER)'"; \
+         echo "RAPI_USER = '$(RAPI_USER)'"; \
+         echo "VCS_VERSION = '$$VCSVER'"; \
        } > $@
 
 $(REPLACE_VARS_SED): Makefile
@@ -450,6 +584,15 @@ $(REPLACE_VARS_SED): Makefile
          echo 's#@RPL_FILE_STORAGE_DIR@#$(FILE_STORAGE_DIR)#g'; \
          echo 's#@RPL_SSH_INITD_SCRIPT@#$(SSH_INITD_SCRIPT)#g'; \
          echo 's#@PKGLIBDIR@#$(pkglibdir)#g'; \
+         echo 's#@GNTMASTERUSER@#$(MASTERD_USER)#g'; \
+         echo 's#@GNTRAPIUSER@#$(RAPI_USER)#g'; \
+         echo 's#@GNTCONFDUSER@#$(CONFD_USER)#g'; \
+         echo 's#@GNTNODEDUSER@#$(NODED_USER)#g'; \
+         echo 's#@GNTRAPIGROUP@#$(RAPI_GROUP)#g'; \
+         echo 's#@GNTADMINGROUP@#$(ADMIN_GROUP)#g'; \
+         echo 's#@GNTCONFDGROUP@#$(CONFD_GROUP)#g'; \
+         echo 's#@GNTMASTERDGROUP@#$(MASTERD_GROUP)#g'; \
+         echo 's#@GNTDAEMONSGROUP@#$(DAEMONS_GROUP)#g'; \
        } > $@
 
 # We need to create symlinks because "make distcheck" will not install Python
@@ -467,10 +610,45 @@ stamp-srclinks: Makefile stamp-directories
 ganeti:
        cd $(top_builddir) && test -h "$@" || { rm -f $@ && $(LN_S) lib $@; }
 
-check-local:
+.PHONY: check-dirs
+check-dirs: $(BUILT_SOURCES)
+       @set -e; \
+       find . -type d \( \( -name . \) -o \( \
+               -name .git -o \
+               -name autom4te.cache \
+               \) -prune -o -print \) | { \
+               error=; \
+               while read dir; do \
+                       case "$$dir" in \
+                               $(strip $(patsubst %,(./%) ;;,$(DIRCHECK_EXCLUDE) $(DIRS))) \
+                               *) error=1; echo "Directory $$dir not listed in Makefile" >&2 ;; \
+                       esac; \
+               done; \
+               for dir in $(DIRS); do \
+                       if ! test -d "$$dir"; then \
+                               echo "Directory $$dir listed in DIRS does not exist" >&2; \
+                               error=1; \
+                       fi \
+               done; \
+               if test -n "$$error"; then exit 1; else exit 0; fi; \
+       }
+
+check-local: check-dirs
        $(CHECK_PYTHON_CODE) $(check_python_code)
 
-# a dist hook rule for catching revision control directories
+.PHONY: lint
+lint: ganeti $(BUILT_SOURCES)
+       @test -n "$(PYLINT)" || { echo 'pylint' not found during configure; exit 1; }
+       $(PYLINT) $(LINT_OPTS) $(lint_python_code)
+
+# a dist hook rule for updating the vcs-version file; this is
+# hardcoded due to where it needs to build the file...
+dist-hook:
+       $(MAKE) regen-vcs-version && \
+       rm -f $(top_distdir)/vcs-version && \
+       cp -p $(srcdir)/vcs-version $(top_distdir)
+
+# a distcheck hook rule for catching revision control directories
 distcheck-hook:
        if find $(top_distdir) -name .svn -or -name .git | grep .; then \
                echo "Found revision control files in final archive." 1>&2; \
@@ -495,17 +673,32 @@ stamp-directories: Makefile
        touch $@
 
 .PHONY: apidoc
-apidoc: epydoc.conf $(RUN_IN_TEMPDIR)
+apidoc: epydoc.conf $(RUN_IN_TEMPDIR) $(BUILT_SOURCES)
        test -e doc/api || mkdir doc/api
        $(RUN_IN_TEMPDIR) epydoc -v \
                --conf $(CURDIR)/epydoc.conf \
                --output $(CURDIR)/doc/api
 
 .PHONY: TAGS
-TAGS:
+TAGS: $(BUILT_SOURCES)
        rm -f TAGS
-       find . -path './lib/*.py' -o -path 'scripts/gnt-*' -o \
-         -path 'daemons/ganeti-*' -o -path 'tools/*' | \
+       find . -path './lib/*.py' -o -path './scripts/gnt-*' -o \
+         -path './daemons/ganeti-*' -o -path './tools/*' -o \
+         -path './qa/*.py' | \
          etags -
 
+.PHONY: coverage
+coverage: $(BUILT_SOURCES) $(python_tests)
+       set -e; \
+       mkdir -p doc/coverage; \
+       COVERAGE_FILE=$(CURDIR)/doc/coverage/data \
+       TEXT_COVERAGE=$(CURDIR)/doc/coverage/report.txt \
+       HTML_COVERAGE=$(CURDIR)/doc/coverage \
+       $(PLAIN_TESTS_ENVIRONMENT) $(abs_top_srcdir)/autotools/gen-coverage \
+       $(python_tests)
+
+commit-check: distcheck lint apidoc
+
+-include ./Makefile.local
+
 # vim: set noet :