Merge pull request #38 from openweave/feature/add-distcheck-to-travis-ci

Add Distribution Sanity Check Target to Travis CI

Author: gerickson

.travis.yml

@@ -35,6 +35,10 @@ after_success:
 
 matrix:
   include:
+    - name: "Linux with Defaults against GCC Distribution Sanity Check"
+      env: BUILD_TARGET="linux-auto-gcc-distcheck" CC="gcc"
+      os: linux
+      compiler: gcc
     - name: "Linux with Defaults against GCC Coding Style Check"
       env: BUILD_TARGET="linux-auto-gcc-lint" CC="gcc"
       os: linux

.travis/script.sh

@@ -31,6 +31,10 @@ die()
 
 case "${BUILD_TARGET}" in
 
+    linux-auto-*-distcheck)
+        ./configure && make distcheck
+        ;;
+
     linux-auto-*-lint)
         ./configure && make pretty-check
         ;;

Makefile-bootstrap

@@ -0,0 +1,105 @@
+#
+#    Copyright 2017-2018 Nest Labs Inc. All Rights Reserved.
+#
+#    Licensed under the Apache License, Version 2.0 (the "License");
+#    you may not use this file except in compliance with the License.
+#    You may obtain a copy of the License at
+#
+#    http://www.apache.org/licenses/LICENSE-2.0
+#
+#    Unless required by applicable law or agreed to in writing, software
+#    distributed under the License is distributed on an "AS IS" BASIS,
+#    WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+#    See the License for the specific language governing permissions and
+#    limitations under the License.
+#
+
+#
+#    Description:
+#      This file is the makefile for inlining optional and required
+#      third-party packages as package-internal copies and for providing
+#      convenience targets for bootstrapping the GNU autotools-based build
+#      system used by this package.
+#
+#      If your package has dependent git repositories that you might
+#      otherwise be inclined to subtree in, you can define a
+#      "repos.conf" file at the top of your project that enumerates
+#      the repositories, the branch thereof, and where to put it in
+#      your project. An example is shown below:
+#
+#        [submodule "nlassert"]
+#            path = third_party/nlassert/repo
+#            url = [email protected]:nestlabs/nlassert.git
+#            branch = master
+#            update = none
+#        [submodule "nlunit-test"]
+#            path = third_party/nlunit-test/repo
+#            url = [email protected]:nestlabs/nlunit-test.git
+#            branch = master
+#            update = none
+#
+
+ThisMakefile                     := $(firstword $(MAKEFILE_LIST))
+
+builddir                         ?= .
+abs_builddir                     ?= $(realpath $(builddir))
+top_builddir                     ?= $(builddir)
+abs_top_builddir                 ?= $(realpath $(top_builddir))
+srcdir                           ?= $(dir $(realpath $(ThisMakefile)))
+abs_srcdir                       ?= $(realpath $(srcdir))
+top_srcdir                       ?= $(srcdir)
+abs_top_srcdir                   ?= $(realpath $(top_srcdir))
+
+nlbuild_autotools_stem           ?= third_party/nlbuild-autotools/repo
+abs_top_nlbuild_autotools_dir    ?= $(abs_top_srcdir)/$(nlbuild_autotools_stem)
+
+include $(abs_top_nlbuild_autotools_dir)/make/pre.mak
+include $(abs_top_nlbuild_autotools_dir)/make/host/tools/bootstrap.mak
+
+#
+# Add any project-specific bootstrap help commands to this
+# 'help-hook' target.
+#
+# These commands will be executed AFTER the core bootstrap 'help'
+# target commands.
+#
+help-hook:
+
+#
+# Add any project-specific bootstrap help commands to this
+# 'help-bootstrap-hook' target.
+#
+# These commands will be executed AFTER the core bootstrap 'help' and
+# 'help-bootstrap' target commands.
+#
+help-bootstrap-hook:
+
+#
+# Add any project-specific bootstrap help commands to this
+# 'help-repos-hook' target.
+#
+# These commands will be executed AFTER the core bootstrap 'help' and
+# 'help-repos' target commands.
+#
+help-repos-hook:
+
+#
+# Add any project-specific bootstrap repos commands to this
+# 'repos-hook' target.
+#
+# These commands will be executed AFTER the core bootstrap 'repos'
+# target commands.
+#
+repos-hook:
+
+#
+# Add any project-specific bootstrap repos commands to this
+# 'clean-repos-hook' target.
+#
+# These commands will be executed BEFORE the core bootstrap 'clean-repos'
+# target commands.
+#
+clean-repos-hook:
+
+include $(abs_top_nlbuild_autotools_dir)/make/post.mak
+include $(abs_top_nlbuild_autotools_dir)/make/post/rules/bootstrap.mak

Makefile.am

@@ -45,6 +45,7 @@ EXTRA_DIST                               = \
     BUILDING.md                            \
     CONTRIBUTING.md                        \
     Makefile-Android                       \
+    Makefile-bootstrap                     \
     Makefile-iOS                           \
     Makefile-Standalone                    \
     README.md                              \
@@ -56,6 +57,7 @@ EXTRA_DIST                               = \
     .travis/script.sh                      \
     bootstrap                              \
     bootstrap-configure                    \
+    repos.conf                             \
     $(srcdir)/build/autoconf               \
     $(srcdir)/build/config                 \
     $(srcdir)/build/cstyle/cstyle.options  \
@@ -103,16 +105,29 @@ PRETTY_FILES                            := $(NULL)
 # .dist-version second, and the .default-version last.
 #
 
+# VERSION_FILE should be and is intentionally an immediate (:=) rather
+# than a deferred (=) variable to ensure the value binds once and only once
+# for a given MAKELEVEL even as .local-version and .dist-version are created
+# during makefile execution.
+
 VERSION_FILE                      := $(if $(wildcard $(builddir)/.local-version),$(builddir)/.local-version,$(if $(wildcard $(srcdir)/.dist-version),$(srcdir)/.dist-version,$(srcdir)/.default-version))
 
 #
 # Override autotool's default notion of the package version variables.
-# This ensures that when we create a source distribution that the
-# version is always the current version, not the version when the
-# package was bootstrapped.
+# This ensures that when we create a source distribution the
+# version is always the current version, not the package bootstrap
+# version.
+#
+# The two-level variables and the check against MAKELEVEL ensures that
+# not only can the package version be overridden from the command line
+# but also when the version is NOT overridden that we bind the version
+# once and only once across potential sub-makes to prevent the version
+# from flapping as VERSION_FILE changes.
 #
 
-WEAVE_VERSION                     ?= $(shell cat $(VERSION_FILE) 2> /dev/null)
+export MAYBE_WEAVE_VERSION        := $(if $(filter 0,$(MAKELEVEL)),$(shell cat $(VERSION_FILE) 2> /dev/null),$(MAYBE_WEAVE_VERSION))
+
+WEAVE_VERSION                     ?= $(MAYBE_WEAVE_VERSION)
 
 PACKAGE_VERSION                    = $(WEAVE_VERSION)
 VERSION                            = $(PACKAGE_VERSION)
@@ -171,10 +186,42 @@ $(distdir)/.dist-version: $(builddir)/.local-version force
 $(distdir)/.dist-version $(builddir)/.local-version:
 	$(call check-file,$(@F))
 
-dist distcheck install-headers: $(BUILT_SOURCES)
+#
+# When we run 'distcheck' and --with-<any of the third-party packages
+# listed in repos.conf>, default to 'internal', the nlbuild-autotools
+# infrastructure will attempt to create git paths to manage the
+# package repo. Two directories need to be writable to facilitate
+# this.
+#
+
+DISTCHECK_CONFIGURE_FLAGS = `chmod u+w .. ../third_party`
+
+#
+# BlueZ is not well set-up without patching to handle 'make distcheck';
+# disable it for that target.
+#
+# We also want a more cursory sanity check for 'distcheck'; consequently,
+# skip running the Happy-centric tests.
+#
+
+DISTCHECK_CONFIGURE_FLAGS += --without-bluez --without-happy
+
+dist distcheck distdir install-headers: $(BUILT_SOURCES)
 
 dist-hook: $(distdir)/.dist-version
 
+# If you are synchronizing a package on which yours depends using 'repos.conf',
+# to 'third_party', uncomment and adapt or delete this, as needed. If you choose
+# to use this, please also take a look at Makefile.am and third_party/Makefile.am
+# and uncomment the appropriate sections there.
+
+#
+# Ensure any locally synchronized repositories defined by 'repos.conf'
+# are cleaned up.
+#
+distclean-local:
+	$(MAKE) -C $(srcdir) -f Makefile-bootstrap clean-repos
+
 #
 # Top-level convenience target for making a documentation-only
 # distribution whose results appear at the top level of the build tree

Makefile.in

@@ -295,10 +295,10 @@ AUTOCONF = @AUTOCONF@
 AUTOHEADER = @AUTOHEADER@
 AUTOMAKE = @AUTOMAKE@
 AWK = @AWK@
-BLUEZ_BUILD_DIRECTORY = @BLUEZ_BUILD_DIRECTORY@
 BLUEZ_CPPFLAGS = @BLUEZ_CPPFLAGS@
 BLUEZ_LDFLAGS = @BLUEZ_LDFLAGS@
 BLUEZ_LIBS = @BLUEZ_LIBS@
+BLUEZ_SUBDIRS = @BLUEZ_SUBDIRS@
 CC = @CC@
 CCDEPMODE = @CCDEPMODE@
 CFLAGS = @CFLAGS@
@@ -385,15 +385,19 @@ MKDIR_P = @MKDIR_P@
 NLASSERT_CPPFLAGS = @NLASSERT_CPPFLAGS@
 NLASSERT_LDFLAGS = @NLASSERT_LDFLAGS@
 NLASSERT_LIBS = @NLASSERT_LIBS@
+NLASSERT_SUBDIRS = @NLASSERT_SUBDIRS@
 NLFAULTINJECTION_CPPFLAGS = @NLFAULTINJECTION_CPPFLAGS@
 NLFAULTINJECTION_LDFLAGS = @NLFAULTINJECTION_LDFLAGS@
 NLFAULTINJECTION_LIBS = @NLFAULTINJECTION_LIBS@
+NLFAULTINJECTION_SUBDIRS = @NLFAULTINJECTION_SUBDIRS@
 NLIO_CPPFLAGS = @NLIO_CPPFLAGS@
 NLIO_LDFLAGS = @NLIO_LDFLAGS@
 NLIO_LIBS = @NLIO_LIBS@
-NLUNITTEST_CPPFLAGS = @NLUNITTEST_CPPFLAGS@
-NLUNITTEST_LDFLAGS = @NLUNITTEST_LDFLAGS@
-NLUNITTEST_LIBS = @NLUNITTEST_LIBS@
+NLIO_SUBDIRS = @NLIO_SUBDIRS@
+NLUNIT_TEST_CPPFLAGS = @NLUNIT_TEST_CPPFLAGS@
+NLUNIT_TEST_LDFLAGS = @NLUNIT_TEST_LDFLAGS@
+NLUNIT_TEST_LIBS = @NLUNIT_TEST_LIBS@
+NLUNIT_TEST_SUBDIRS = @NLUNIT_TEST_SUBDIRS@
 NL_PROJECT_CONFIG_INCLUDES = @NL_PROJECT_CONFIG_INCLUDES@
 NM = @NM@
 NMEDIT = @NMEDIT@
@@ -546,6 +550,7 @@ EXTRA_DIST = \
     BUILDING.md                            \
     CONTRIBUTING.md                        \
     Makefile-Android                       \
+    Makefile-bootstrap                     \
     Makefile-iOS                           \
     Makefile-Standalone                    \
     README.md                              \
@@ -557,6 +562,7 @@ EXTRA_DIST = \
     .travis/script.sh                      \
     bootstrap                              \
     bootstrap-configure                    \
+    repos.conf                             \
     $(srcdir)/build/autoconf               \
     $(srcdir)/build/config                 \
     $(srcdir)/build/cstyle/cstyle.options  \
@@ -603,7 +609,30 @@ PRETTY_FILES := $(NULL)
 # When present, the .local-version file is preferred first, the
 # .dist-version second, and the .default-version last.
 #
+
+# VERSION_FILE should be and is intentionally an immediate (:=) rather
+# than a deferred (=) variable to ensure the value binds once and only once
+# for a given MAKELEVEL even as .local-version and .dist-version are created
+# during makefile execution.
 VERSION_FILE := $(if $(wildcard $(builddir)/.local-version),$(builddir)/.local-version,$(if $(wildcard $(srcdir)/.dist-version),$(srcdir)/.dist-version,$(srcdir)/.default-version))
+
+#
+# When we run 'distcheck' and --with-<any of the third-party packages
+# listed in repos.conf>, default to 'internal', the nlbuild-autotools
+# infrastructure will attempt to create git paths to manage the
+# package repo. Two directories need to be writable to facilitate
+# this.
+#
+
+#
+# BlueZ is not well set-up without patching to handle 'make distcheck';
+# disable it for that target.
+#
+# We also want a more cursory sanity check for 'distcheck'; consequently,
+# skip running the Happy-centric tests.
+#
+DISTCHECK_CONFIGURE_FLAGS = `chmod u+w .. ../third_party` \
+	--without-bluez --without-happy
 weave_tooldist_alias = \
     $(PACKAGE_TARNAME)-tools
 
@@ -1034,7 +1063,7 @@ distclean: distclean-recursive
 	-rm -f $(am__CONFIG_DISTCLEAN_FILES)
 	-rm -f Makefile
 distclean-am: clean-am distclean-generic distclean-libtool \
-	distclean-tags
+	distclean-local distclean-tags
 
 dvi: dvi-recursive
 
@@ -1104,10 +1133,10 @@ uninstall-am: uninstall-dist_docDATA
 	clean-libtool cscope cscopelist-am ctags ctags-am dist \
 	dist-all dist-bzip2 dist-gzip dist-hook dist-lzip dist-shar \
 	dist-tarZ dist-xz dist-zip distcheck distclean \
-	distclean-generic distclean-libtool distclean-tags \
-	distcleancheck distdir distuninstallcheck dvi dvi-am html \
-	html-am info info-am install install-am install-data \
-	install-data-am install-dist_docDATA install-dvi \
+	distclean-generic distclean-libtool distclean-local \
+	distclean-tags distcleancheck distdir distuninstallcheck dvi \
+	dvi-am html html-am info info-am install install-am \
+	install-data install-data-am install-dist_docDATA install-dvi \
 	install-dvi-am install-exec install-exec-am install-html \
 	install-html-am install-info install-info-am install-man \
 	install-pdf install-pdf-am install-ps install-ps-am \
@@ -1127,12 +1156,20 @@ include $(abs_top_nlbuild_autotools_dir)/automake/pre.am
 
 #
 # Override autotool's default notion of the package version variables.
-# This ensures that when we create a source distribution that the
-# version is always the current version, not the version when the
-# package was bootstrapped.
+# This ensures that when we create a source distribution the
+# version is always the current version, not the package bootstrap
+# version.
+#
+# The two-level variables and the check against MAKELEVEL ensures that
+# not only can the package version be overridden from the command line
+# but also when the version is NOT overridden that we bind the version
+# once and only once across potential sub-makes to prevent the version
+# from flapping as VERSION_FILE changes.
 #
 
-WEAVE_VERSION                     ?= $(shell cat $(VERSION_FILE) 2> /dev/null)
+export MAYBE_WEAVE_VERSION        := $(if $(filter 0,$(MAKELEVEL)),$(shell cat $(VERSION_FILE) 2> /dev/null),$(MAYBE_WEAVE_VERSION))
+
+WEAVE_VERSION                     ?= $(MAYBE_WEAVE_VERSION)
 
 #
 # check-file-.local-version
@@ -1188,10 +1225,22 @@ $(distdir)/.dist-version: $(builddir)/.local-version force
 $(distdir)/.dist-version $(builddir)/.local-version:
 	$(call check-file,$(@F))
 
-dist distcheck install-headers: $(BUILT_SOURCES)
+dist distcheck distdir install-headers: $(BUILT_SOURCES)
 
 dist-hook: $(distdir)/.dist-version
 
+# If you are synchronizing a package on which yours depends using 'repos.conf',
+# to 'third_party', uncomment and adapt or delete this, as needed. If you choose
+# to use this, please also take a look at Makefile.am and third_party/Makefile.am
+# and uncomment the appropriate sections there.
+
+#
+# Ensure any locally synchronized repositories defined by 'repos.conf'
+# are cleaned up.
+#
+distclean-local:
+	$(MAKE) -C $(srcdir) -f Makefile-bootstrap clean-repos
+
 #
 # Top-level convenience target for making a documentation-only
 # distribution whose results appear at the top level of the build tree